модуль fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension — конфигурация расширения LAN FortiExtender.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension.

Добавлено в fortinet.fortimanager 2.2.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
В примерах приведены все параметры и значения, которые необходимо настроить с учётом источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
extender-profile string	Устарел, используйте “extender_profile”
extender_profile string	Параметр (extender-profile) в запрошенном URL.
extensioncontroller_extenderprofile_lanextension dictionary	Параметры верхнего уровня.
backhaul list / elements=dictionary	Обратный канал.
health_check_fail_cnt псевдонимы: health-check-fail-cnt integer	Количество сбоев, после которого канал считается недоступным
health_check_interval псевдонимы: health-check-interval integer	Интервал мониторинга работоспособности в секундах
health_check_probe_cnt псевдонимы: health-check-probe-cnt integer	Количество проб мониторинга работоспособности, отправляемых за один интервал
health_check_probe_tm псевдонимы: health-check-probe-tm integer	Время ожидания ответа на пробу мониторинга работоспособности в секундах
health_check_recovery_cnt псевдонимы: health-check-recovery-cnt integer	Количество успешных проверок, после которого канал считается доступным
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 псевдонимы: backhaul-interface string	Интерфейс фазы 1 IPsec.
backhaul_ip псевдонимы: backhaul-ip string	IPv4-адрес/FQDN фазы 1 IPsec.
downlinks list / elements=dictionary	Нисходящие каналы.
name string	Имя записи конфигурации нисходящего канала расширения LAN FortiExtender.
port string	Порт нисходящего канала расширения LAN FortiExtender. Варианты: `"port1"` `"port2"` `"port3"` `"port4"` `"port5"` `"lan1"` `"lan2"` `"lan"`
pvid integer	PVID нисходящего канала расширения LAN FortiExtender.
type string	Тип нисходящего канала расширения LAN FortiExtender [порт/VAP]. Варианты: `"port"` `"vap"`
vap any	(список) VAP нисходящего канала расширения LAN FortiExtender.
vids any	(список) VID нисходящего канала расширения LAN FortiExtender.
ipsec_tunnel псевдонимы: ipsec-tunnel string	Имя туннеля IPsec.
link_loadbalance псевдонимы: link-loadbalance string	Стратегия распределения нагрузки между каналами расширения LAN. Варианты: `"activebackup"` `"loadbalance"`
traffic_split_services псевдонимы: traffic-split-services list / elements=dictionary	Службы разделения трафика.
address any	(список) Выбор адреса.
name string	Имя записи разделения туннеля расширения LAN FortiExtender.
service any	(список) Выбор службы.
vsdb string	Выбрать значение vsdb [включить/отключить]. Варианты: `"disable"` `"enable"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, для которых переопределяются условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть global или другим значением, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются по соглашению с подчёркиваниями (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему поддерживаются, но будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой при возврате ненулевого значения rc. Условия сбоя или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiExtender lan extension configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        extensioncontroller_extenderprofile_lanextension:
          # backhaul:
          #   - name: <string>
          #     port: <value in [wan, lte1, lte2, ...]>
          #     role: <value in [primary, secondary]>
          #     weight: <integer>
          #     health_check_fail_cnt: <integer>
          #     health_check_interval: <integer>
          #     health_check_probe_cnt: <integer>
          #     health_check_probe_tm: <integer>
          #     health_check_recovery_cnt: <integer>
          # backhaul_interface: <string>
          # backhaul_ip: <string>
          # ipsec_tunnel: <string>
          # link_loadbalance: <value in [activebackup, loadbalance]>
          # downlinks:
          #   - name: <string>
          #     port: <value in [port1, port2, port3, ...]>
          #     pvid: <integer>
          #     type: <value in [port, vap]>
          #     vap: <list or string>
          #     vids: <list or integer>
          # traffic_split_services:
          #   - address: <list or string>
          #     name: <string>
          #     service: <list or string>
          #     vsdb: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

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

© 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/fortimanager/fmgr_extensioncontroller_extenderprofile_lanextension_module.html