fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension_backhaul module – настройка туннеля обратного канала расширения LAN.

Примечание

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

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

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

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

Добавлено в 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_backhaul 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.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых операция считается неудачной.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых операция считается успешной.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: LAN extension backhaul tunnel configuration.
      fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension_backhaul:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        extender_profile: <your own value>
        state: present # <value in [present, absent]>
        extensioncontroller_extenderprofile_lanextension_backhaul:
          name: "your value" # Required variable, 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>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_backhaul_module.html