Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_extender_controller_extender — настройка контроллера расширителей в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_extender_controller_extender.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

extender_controller_extender

dictionary

Конфигурация контроллера расширителей.

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

Ограничение пропускной способности расширения LAN FortiExtender (Мбит/с).

billing_start_day

integer

День начала расчетного периода.

cdma_aaa_spi

string

SPI AAA для CDMA.

cdma_ha_spi

string

SPI HA для CDMA.

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.

Варианты:

  • "enable"
  • "disable"

ext_name

string

Имя FortiExtender.

extension_type

string

Тип расширения для этого FortiExtender.

Варианты:

  • "wan-extension"
  • "lan-extension"

ha_shared_secret

string

Общий секрет HA.

id

string

Серийный номер FortiExtender.

ifname

string

Имя интерфейса FortiExtender. Источник: system.interface.name.

initiated_update

string

Разрешить/запретить обновления модема, инициируемые сетью.

Варианты:

  • "enable"
  • "disable"

login_password

string

Задать пароль администратора контролируемого расширителя.

login_password_change

string

Изменить или сбросить пароль администратора контролируемого расширителя (yes, default или no).

Варианты:

  • "yes"
  • "default"
  • "no"

mode

string

Режим FortiExtender.

Варианты:

  • "standalone"
  • "redundant"

modem1

dictionary

Параметры конфигурации модема 1.

auto_switch

dictionary

Конфигурация автоматического переключения FortiExtender.

dataplan

string

Автоматическое переключение на основе использования данных.

Варианты:

  • "disable"
  • "enable"

disconnect

string

Автоматическое переключение при отключении.

Варианты:

  • "disable"
  • "enable"

disconnect_period

integer

Автоматическое переключение на основе периода отключения.

disconnect_threshold

integer

Автоматическое переключение на основе порогового значения отключений.

signal

string

Автоматическое переключение на основе уровня сигнала.

Варианты:

  • "disable"
  • "enable"

switch_back

list / elements=string

Автоматическое переключение с несколькими вариантами возврата.

Варианты:

  • "time"
  • "timer"

switch_back_time

string

Автоматически переключиться на предпочтительную SIM-карту/оператора в заданное время по UTC (HH:MM).

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. Источник: system.interface.name.

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-карта

modem2

dictionary

Параметры конфигурации модема 2.

auto_switch

dictionary

Конфигурация автоматического переключения FortiExtender.

dataplan

string

Автоматическое переключение на основе использования данных.

Варианты:

  • "disable"
  • "enable"

disconnect

string

Автоматическое переключение при отключении.

Варианты:

  • "disable"
  • "enable"

disconnect_period

integer

Автоматическое переключение на основе периода отключения.

disconnect_threshold

integer

Автоматическое переключение на основе порогового значения отключения.

signal

string

Автоматическое переключение на основе уровня сигнала.

Варианты:

  • "disable"
  • "enable"

switch_back

list / elements=string

Автоматическое переключение с несколькими параметрами возврата.

Варианты:

  • "time"
  • "timer"

switch_back_time

string

Автоматическое переключение на предпочтительную SIM-карту/оператора в указанное время UTC (HH:MM).

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. Источник: system.interface.name.

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.

modem_type

string

Тип MODEM (CDMA, GSM/LTE или WIMAX).

Варианты:

  • "cdma"
  • "gsm/lte"
  • "wimax"

multi_mode

string

Режим работы MODEM (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"

ppp_password

string

Пароль PPP.

ppp_username

string

Имя пользователя PPP.

primary_ha

string

Основной HA.

profile

string

Конфигурация профиля FortiExtender. Источник: extender-controller.extender-profile.name.

quota_limit_mb

integer

Месячный лимит квоты (МБ).

redial

string

Количество повторных наборов, разрешённых при неудачных попытках.

Варианты:

  • "none"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"
  • "7"
  • "8"
  • "9"
  • "10"

redundant_intf

string

Резервный интерфейс.

roaming

string

Включение/отключение роуминга MODEM.

Варианты:

  • "enable"
  • "disable"

role

string

Рабочая роль FortiExtender (основной, вторичный, отсутствует).

Варианты:

  • "none"
  • "primary"
  • "secondary"

secondary_ha

string

Вторичный HA.

sim_pin

string

PIN-код SIM-карты.

vdom

integer

VDOM.

wan_extension

dictionary

Конфигурация расширения WAN FortiExtender.

modem1_extension

string

Имя интерфейса FortiExtender. Источник: system.interface.name.

modem2_extension

string

Имя интерфейса FortiExtender. Источник: system.interface.name.

wimax_auth_protocol

string

Протокол аутентификации WiMax (TLS или TTLS).

Варианты:

  • "tls"
  • "ttls"

wimax_carrier

string

Оператор WiMax.

wimax_realm

string

Область WiMax.

member_path

string

Путь к атрибуту элемента, с которым выполняется операция.

Если атрибутов несколько, они разделяются косой чертой.

Параметр с указанием member_path поддерживает выполнение операций над элементами.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi больше не поддерживается; предпочтительный способ запуска плейбуков — httpapi.
  • Модуль поддерживает 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

Главный ключ (идентификатор), использованный при последнем обращении к 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_extender_controller_extender_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API