Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_extender_controller_extender_profile — настройка профиля FortiExtender в 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_profile.

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

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

Обзор

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

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

extender_controller_extender_profile

dictionary

Конфигурация профиля FortiExtender.

allowaccess

list / elements=string

Управление доступом к управлению устройством FortiExtender. Разделяйте записи пробелами.

Варианты:

  • "ping"
  • "telnet"
  • "http"
  • "https"
  • "ssh"
  • "snmp"

bandwidth_limit

integer

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

cellular

dictionary

Настройки сотовой связи FortiExtender.

controller_report

dictionary

Настройки отчета контроллера FortiExtender.

interval

integer

Интервал отправки отчета контроллера.

signal_threshold

integer

Порог уровня сигнала для отчета контроллера.

status

string

Состояние отчета контроллера FortiExtender.

Варианты:

  • "disable"
  • "enable"

dataplan

list / elements=dictionary

Названия тарифных планов.

name

string / required

Название тарифного плана. Источник: extender-controller.dataplan.name.

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"

preferred_carrier

string

Предпочтительный оператор связи.

redundant_intf

string

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

redundant_mode

string

Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1_pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim1_pin_code

string

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

sim2_pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim2_pin_code

string

PIN-код 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"

preferred_carrier

string

Предпочтительный оператор связи.

redundant_intf

string

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

redundant_mode

string

Режим FortiExtender.

Варианты:

  • "disable"
  • "enable"

sim1_pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim1_pin_code

string

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

sim2_pin

string

SIM-карта

Варианты:

  • "disable"
  • "enable"

sim2_pin_code

string

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

sms_notification

dictionary

Настройки SMS-уведомлений сотовой связи FortiExtender.

alert

dictionary

Список SMS-оповещений.

data_exhausted

string

Строка, отображаемая при исчерпании лимита данных.

fgt_backup_mode_switch

string

Строка для отображения при переключении режима резервного копирования FortiGate.

low_signal_strength

string

Строка для отображения при низком уровне сигнала.

mode_switch

string

Строка для отображения при переключении режима.

os_image_fallback

string

Строка для отображения при возврате к предыдущему образу ОС.

session_disconnect

string

Строка для отображения при отключении сеанса.

system_reboot

string

Строка для отображения при перезагрузке системы.

receiver

list / elements=dictionary

Список получателей SMS-уведомлений.

alert

list / elements=string

Несколько параметров оповещения.

Варианты:

  • "system-reboot"
  • "data-exhausted"
  • "session-disconnect"
  • "low-signal-strength"
  • "mode-switch"
  • "os-image-fallback"
  • "fgt-backup-mode-switch"

name

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

Имя получателя SMS-уведомлений FortiExtender.

phone_number

string

Номер телефона получателя. Формат: [+][код страны][код города][местный номер телефона]. Например, +16501234567.

status

string

Статус получателя SMS-уведомлений.

Варианты:

  • "disable"
  • "enable"

status

string

Статус SMS-уведомлений FortiExtender.

Варианты:

  • "disable"
  • "enable"

enforce_bandwidth

string

Включить или отключить ограничение пропускной способности интерфейса расширения LAN.

Варианты:

  • "enable"
  • "disable"

extension

string

Параметр расширения.

Варианты:

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

id

integer

Идентификатор.

lan_extension

dictionary

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

backhaul

list / elements=dictionary

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

name

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

Имя транзитного канала расширения LAN FortiExtender.

port

string

Порт восходящего канала FortiExtender.

Варианты:

  • "wan"
  • "lte1"
  • "lte2"
  • "port1"
  • "port2"
  • "port3"
  • "port4"
  • "port5"
  • "sfp"

role

string

Порт восходящего канала FortiExtender.

Варианты:

  • "primary"
  • "secondary"

weight

integer

Параметр веса WRR.

backhaul_interface

string

Интерфейс фазы 1 IPsec. Источник — system.interface.name.

backhaul_ip

string

IPv4-адрес/FQDN фазы 1 IPsec. Используется для указания внешнего IP-адреса/FQDN, если устройство FortiGate находится за устройством NAT.

ipsec_tunnel

string

Имя туннеля IPsec.

link_loadbalance

string

Стратегия балансировки нагрузки каналов расширения LAN.

Варианты:

  • "activebackup"
  • "loadbalance"

login_password

string

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

login_password_change

string

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

Варианты:

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

model

string

Модель.

Варианты:

  • "FX201E"
  • "FX211E"
  • "FX200F"
  • "FXA11F"
  • "FXE11F"
  • "FXA21F"
  • "FXE21F"
  • "FXA22F"
  • "FXE22F"
  • "FX212F"
  • "FX311F"
  • "FX312F"
  • "FX511F"
  • "FVG21F"
  • "FVA21F"
  • "FVG22F"
  • "FVA22F"
  • "FX04DA"
  • "FX04DN"
  • "FX04DI"

name

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

Имя профиля FortiExtender.

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: FortiExtender extender profile configuration.
  fortinet.fortios.fortios_extender_controller_extender_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender_profile:
          allowaccess: "ping"
          bandwidth_limit: "1024"
          cellular:
              controller_report:
                  interval: "300"
                  signal_threshold: "10"
                  status: "disable"
              dataplan:
                  -
                      name: "default_name_11 (source extender-controller.dataplan.name)"
              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"
                  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"
                  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>"
              sms_notification:
                  alert:
                      data_exhausted: "<your_own_value>"
                      fgt_backup_mode_switch: "<your_own_value>"
                      low_signal_strength: "<your_own_value>"
                      mode_switch: "<your_own_value>"
                      os_image_fallback: "<your_own_value>"
                      session_disconnect: "<your_own_value>"
                      system_reboot: "<your_own_value>"
                  receiver:
                      -
                          alert: "system-reboot"
                          name: "default_name_63"
                          phone_number: "<your_own_value>"
                          status: "disable"
                  status: "disable"
          enforce_bandwidth: "enable"
          extension: "wan-extension"
          id: "69"
          lan_extension:
              backhaul:
                  -
                      name: "default_name_72"
                      port: "wan"
                      role: "primary"
                      weight: "1"
              backhaul_interface: "<your_own_value> (source system.interface.name)"
              backhaul_ip: "<your_own_value>"
              ipsec_tunnel: "<your_own_value>"
              link_loadbalance: "activebackup"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          model: "FX201E"
          name: "default_name_83"

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

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

Ключ

Описание

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–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_profile_module.html

Spec-Zone.ru

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