Модуль fortinet.fortios.fortios_extender_controller_dataplan – Настройка FortiExtender dataplan в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в playbook, укажите: fortinet.fortios.fortios_extender_controller_dataplan.
Добавлена в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию extender_controller и категорию dataplan. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерирована в интерфейсе Fortigate. |
enable_log булево | Включить/отключить логирование для задачи. Варианты:
|
extender_controller_dataplan словарь | Настройка FortiExtender dataplan. |
|
apn строка |
Настройка APN. |
|
auth_type строка |
Тип аутентификации. Варианты:
|
|
billing_date целое число |
День выставления счета (от 1 до 31). |
|
capacity целое число |
Ёмкость в МБ (0 - 102400000). |
|
carrier строка |
Настройка оператора связи. |
|
iccid строка |
Настройка ICCID. |
|
modem_id строка |
Характеристики модема dataplan, если есть. Варианты:
|
|
monthly_fee целое число |
Ежемесячная плата за тарифный план (от 0 до 100000, в местной валюте). |
|
name строка / обязательно |
Название тарифного плана FortiExtender. |
|
overage строка |
Включить/выключить обнаружение перерасхода по тарифному плану. Варианты:
|
|
password строка |
Пароль. |
|
pdn строка |
Тип PDN. Варианты:
|
|
preferred_subnet целое число |
Предпочтительная маска подсети (0 - 32). |
|
private_network строка |
Включить/выключить поддержку частной сети для тарифного плана. Варианты:
|
|
signal_period целое число |
Период сигнализации (от 600 до 18000 секунд). |
|
signal_threshold целое число |
Пороговое значение сигнала. Укажите диапазон от 50 до 100, где 50/100 означает -50/-100 дБм. |
|
slot строка |
Настройка слота SIM. Варианты:
|
|
type строка |
Настройка параметров типа. Варианты:
|
|
username строка |
Имя пользователя. |
member_path string | Путь к атрибуту элемента, с которым нужно работать. Разделяется символом слеша, если атрибутов больше одного. Параметр, помеченный как member_path, является допустимым для выполнения операций с элементами. |
member_state string | Добавить или удалить элемент под указанным путем к атрибуту. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / required | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен, среди тех, которые были определены ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Значение по умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает check_mode.
Примеры
- name: FortiExtender dataplan configuration.
fortinet.fortios.fortios_extender_controller_dataplan:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extender_controller_dataplan:
apn: "<your_own_value>"
auth_type: "none"
billing_date: "1"
capacity: "0"
carrier: "<your_own_value>"
iccid: "<your_own_value>"
modem_id: "modem1"
monthly_fee: "0"
name: "default_name_11"
overage: "disable"
password: "<your_own_value>"
pdn: "ipv4-only"
preferred_subnet: "32"
private_network: "disable"
signal_period: "3600"
signal_threshold: "100"
slot: "sim1"
type: "carrier"
username: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), используемый в последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_extender_controller_dataplan_module.html
