Модуль fortinet.fortios.fortios_extender_controller_extender – Настройка контроллера расширителя в 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_extender.

Добавлен в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры extender_controller и категорию extender. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировано с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ansible>=2.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в GUI Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `true`
extender_controller_extender dictionary	Конфигурация контроллера Extender.
aaa_shared_secret string	Секретный ключ AAA.
access_point_name string	Имя точки доступа (APN).
admin string	Администрирование FortiExtender (включить или выключить). Варианты: `"disable"` `"discovered"` `"enable"`
allowaccess list / elements=string	Управление доступом к управляемому расширителю. Разделяйте записи пробелом. Варианты: `"ping"` `"telnet"` `"http"` `"https"` `"ssh"` `"snmp"`
at_dial_script string	Команды инициализации AT, специфичные для модема.
authorized string	Администрирование FortiExtender (включить или выключить). Варианты: `"disable"` `"enable"`
bandwidth_limit integer	Лимит пропускной способности расширения локальной сети FortiExtender (Мбит/с).
billing_start_day integer	День начала биллинга.
cdma_aaa_spi string	CDMA AAA SPI.
cdma_ha_spi string	CDMA HA SPI.
cdma_nai string	NAI для CDMA модемов.
conn_status integer	Состояние соединения.
controller_report dictionary	Конфигурация отчета контроллера FortiExtender.
interval integer	Интервал отчета контроллера.
signal_threshold integer	Пороговое значение сигнала в отчете контроллера.
status string	Статус отчета контроллера FortiExtender. Варианты: `"disable"` `"enable"`
description string	Описание.
device_id integer	Идентификатор устройства.
dial_mode string	Режим набора (по требованию или постоянное соединение). Варианты: `"dial-on-demand"` `"always-connect"`

dial_status integer	Статус набора номера.
enforce_bandwidth string	Включить/отключить принудительное ограничение полосы пропускания на интерфейсе расширения LAN. Choices: `"enable"` `"disable"`
ext_name string	Имя FortiExtender.
extension_type string	Тип расширения для этого FortiExtender. Choices: `"wan-extension"` `"lan-extension"`
ha_shared_secret string	Секретный ключ HA.
id string	Серийный номер FortiExtender.
ifname string	Имя интерфейса FortiExtender. Source system.interface.name.
initiated_update string	Разрешить/запретить обновления модема, инициированные сетью. Choices: `"enable"` `"disable"`
login_password string	Установить пароль администратора для управляемого расширителя.
login_password_change string	Изменить или сбросить пароль администратора управляемого расширителя (yes, default или no). Choices: `"yes"` `"default"` `"no"`
mode string	Режим FortiExtender. Choices: `"standalone"` `"redundant"`
modem1 dictionary	Параметры конфигурации модема 1.
auto_switch dictionary	Конфигурация автоматического переключения FortiExtender.
dataplan string	Автоматическое переключение на основе использования данных. Choices: `"disable"` `"enable"`
disconnect string	Автоматическое переключение при отключении. Choices: `"disable"` `"enable"`
disconnect_period integer	Автоматическое переключение на основе периода отключения.
disconnect_threshold integer	Автоматическое переключение на основе порогового значения отключения.
signal string	Автоматическое переключение на основе уровня сигнала. Choices: `"disable"` `"enable"`
switch_back list / elements=string	Автоматическое переключение с несколькими параметрами обратного переключения. Choices: `"time"` `"timer"`
switch_back_time string	Автоматически переключиться на предпочтительную SIM-карту/оператора в указанное время в формате UTC (ЧЧ:ММ).
switch_back_timer integer	Автоматически переключиться на предпочтительную SIM-карту/оператора через заданное время (3600 - 2147483647 сек).

conn_status integer	Статус соединения.
default_sim string	Выбор SIM-карты по умолчанию. Choices: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps string	Включение/отключение GPS FortiExtender. Choices: `"disable"` `"enable"`
ifname string	Имя интерфейса FortiExtender. Источник system.interface.name.
preferred_carrier string	Предпочтительный оператор связи.
redundant_intf string	Резервный интерфейс.
redundant_mode string	Режим FortiExtender. Choices: `"disable"` `"enable"`
sim1_pin string	SIM Choices: `"disable"` `"enable"`
sim1_pin_code string	SIM
sim2_pin string	SIM Choices: `"disable"` `"enable"`
sim2_pin_code string	SIM
modem2 dictionary	Параметры конфигурации для модема 2.
auto_switch dictionary	Конфигурация автоматического переключения FortiExtender.
dataplan string	Автоматическое переключение на основе использования данных. Choices: `"disable"` `"enable"`
disconnect string	Автоматическое переключение при отключении. Choices: `"disable"` `"enable"`
disconnect_period integer	Автоматическое переключение на основе периода отключения.
disconnect_threshold integer	Автоматическое переключение на основе порога отключения.
signal string	Автоматическое переключение на основе уровня сигнала. Choices: `"disable"` `"enable"`
switch_back list / elements=string	Автоматическое переключение с несколькими вариантами обратного переключения. Choices: `"time"` `"timer"`
switch_back_time string	Автоматическое переключение на предпочтительную SIM-карту/оператора связи в указанное время по UTC (ЧЧ:ММ).
switch_back_timer integer	Автоматическое переключение на предпочтительную SIM-карту/оператора связи после указанного времени (3600 - 2147483647 сек).

conn_status integer	Состояние подключения.
default_sim string	Выбрать SIM по умолчанию. Варианты: `"sim1"` `"sim2"` `"carrier"` `"cost"`
gps string	Включение/выключение GPS FortiExtender. Варианты: `"disable"` `"enable"`
ifname string	Имя интерфейса FortiExtender. Имя интерфейса исходной системы.
preferred_carrier string	Предпочтительный оператор.
redundant_intf string	Резервный интерфейс.
redundant_mode string	Режим FortiExtender. Варианты: `"disable"` `"enable"`
sim1_pin string	SIM Варианты: `"disable"` `"enable"`
sim1_pin_code string	SIM
sim2_pin string	SIM Варианты: `"disable"` `"enable"`
sim2_pin_code string	SIM
modem_passwd string	Пароль модема.
modem_type string	Тип модема (CDMA, GSM/LTE или WIMAX). Варианты: `"cdma"` `"gsm/lte"` `"wimax"`
multi_mode string	Режим работы модема (3G, LTE и т.д.). Варианты: `"auto"` `"auto-3g"` `"force-lte"` `"force-3g"` `"force-2g"`
name string / обязательно	Имя записи FortiExtender.
override_allowaccess string	Включить переопределение конфигурации доступа к управлению профилем расширителя. Варианты: `"enable"` `"disable"`
override_enforce_bandwidth string	Включить переопределение параметра принудительного ограничения пропускной способности профиля расширителя. Варианты: `"enable"` `"disable"`
override_login_password_change string	Включить переопределение параметра изменения пароля входа в профиль расширителя. Варианты: `"enable"` `"disable"`
ppp_auth_protocol string	Протокол аутентификации PPP (PAP, CHAP или auto). Варианты: `"auto"` `"pap"` `"chap"`
ppp_echo_request string	Включение/выключение запроса эха PPP. Варианты: `"enable"` `"disable"`

END_OF_DOCUMENT_MARKER

ppp_password строка	Пароль PPP.
ppp_username строка	Имя пользователя PPP.
primary_ha строка	Основной HA.
profile строка	Настройка профиля FortiExtender. Источник extender-controller.extender-profile.name.
quota_limit_mb целое число	Ежемесячный лимит квоты (МБ).
redial строка	Количество разрешённых повторных попыток по результатам неудачных попыток. Варианты: `"none"` `"1"` `"2"` `"3"` `"4"` `"5"` `"6"` `"7"` `"8"` `"9"` `"10"`
redundant_intf строка	Резервный интерфейс.
roaming строка	Включение/выключение роуминга MODEM. Варианты: `"enable"` `"disable"`
role строка	Роль работы FortiExtender (Основной, Вторичный, Нет). Варианты: `"none"` `"primary"` `"secondary"`
secondary_ha строка	Вторичный HA.
sim_pin строка	PIN SIM.
vdom целое число	VDOM.
wan_extension словарь	Настройка расширения wan FortiExtender.
modem1_extension строка	Имя интерфейса FortiExtender. Источник system.interface.name.
modem2_extension строка	Имя интерфейса FortiExtender. Источник system.interface.name.
wimax_auth_protocol строка	Протокол аутентификации WiMax (TLS или TTLS). Варианты: `"tls"` `"ttls"`
wimax_carrier строка	Оператор WiMax.
wimax_realm строка	Сфера WiMax.
member_path строка	Путь к атрибуту члена для обработки. Разделяется символом «/» если атрибутов более одного. Параметр, помеченный member_path, подходит для операций с членами.
member_state строка	Добавление или удаление члена по указанному пути атрибута. Когда member_state указан, опция state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из тех, что определены ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство. По умолчанию: `"root"`

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Устаревшее fortiosapi было снято с поддержки, httpapi — предпочтительный способ запуска playbook'ов
Модуль поддерживает check_mode.

Примеры

- name: Extender controller configuration.
  fortinet.fortios.fortios_extender_controller_extender:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender:
          aaa_shared_secret: "<your_own_value>"
          access_point_name: "<your_own_value>"
          admin: "disable"
          allowaccess: "ping"
          at_dial_script: "<your_own_value>"
          authorized: "disable"
          bandwidth_limit: "1024"
          billing_start_day: "14"
          cdma_aaa_spi: "<your_own_value>"
          cdma_ha_spi: "<your_own_value>"
          cdma_nai: "<your_own_value>"
          conn_status: "2147483647"
          controller_report:
              interval: "300"
              signal_threshold: "10"
              status: "disable"
          description: "<your_own_value>"
          device_id: "1024"
          dial_mode: "dial-on-demand"
          dial_status: "2147483647"
          enforce_bandwidth: "enable"
          ext_name: "<your_own_value>"
          extension_type: "wan-extension"
          ha_shared_secret: "<your_own_value>"
          id: "27"
          ifname: "<your_own_value> (source system.interface.name)"
          initiated_update: "enable"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          mode: "standalone"
          modem_passwd: "<your_own_value>"
          modem_type: "cdma"
          modem1:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          modem2:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          multi_mode: "auto"
          name: "default_name_78"
          override_allowaccess: "enable"
          override_enforce_bandwidth: "enable"
          override_login_password_change: "enable"
          ppp_auth_protocol: "auto"
          ppp_echo_request: "enable"
          ppp_password: "<your_own_value>"
          ppp_username: "<your_own_value>"
          primary_ha: "<your_own_value>"
          profile: "<your_own_value> (source extender-controller.extender-profile.name)"
          quota_limit_mb: "5242880"
          redial: "none"
          redundant_intf: "<your_own_value>"
          roaming: "enable"
          role: "none"
          secondary_ha: "<your_own_value>"
          sim_pin: "<your_own_value>"
          vdom: "0"
          wan_extension:
              modem1_extension: "<your_own_value> (source system.interface.name)"
              modem2_extension: "<your_own_value> (source system.interface.name)"
          wimax_auth_protocol: "tls"
          wimax_carrier: "<your_own_value>"
          wimax_realm: "<your_own_value>"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
build string	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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_extender_module.html