модуль fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members – интерфейсы FortiGate, добавленные в virtual-wan-link.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в случае расхождения схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dynamic_virtualwanlink_members dictionary	Набор параметров верхнего уровня.
comment string	Комментарий.
cost integer	Стоимость.
detect_failtime псевдонимы: detect-failtime integer	Время обнаружения сбоя.
detect_http_get псевдонимы: detect-http-get string	Путь HTTP GET для обнаружения.
detect_http_match псевдонимы: detect-http-match string	Строка сопоставления HTTP для обнаружения.
detect_http_port псевдонимы: detect-http-port integer	Порт HTTP для обнаружения.
detect_interval псевдонимы: detect-interval integer	Интервал обнаружения.
detect_protocol псевдонимы: detect-protocol string	Протокол обнаружения. Варианты: `"ping"` `"tcp-echo"` `"udp-echo"` `"http"`
detect_recoverytime псевдонимы: detect-recoverytime integer	Время обнаружения восстановления.
detect_server псевдонимы: detect-server string	Сервер обнаружения.
detect_timeout псевдонимы: detect-timeout integer	Тайм-аут обнаружения.
dynamic_mapping list / elements=dictionary	Динамическое сопоставление.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	VDOM.
comment string	Комментарий.
cost integer	Стоимость.
detect_failtime псевдонимы: detect-failtime integer	Время обнаружения сбоя.
detect_http_get псевдонимы: detect-http-get string	Путь HTTP GET для обнаружения.
detect_http_match псевдонимы: detect-http-match string	Строка сопоставления HTTP для обнаружения.
detect_http_port псевдонимы: detect-http-port integer	Порт HTTP для обнаружения.
detect_interval псевдонимы: detect-interval integer	Интервал обнаружения.
detect_protocol псевдонимы: detect-protocol string	Протокол обнаружения. Варианты: `"ping"` `"tcp-echo"` `"udp-echo"` `"http"`
detect_recoverytime псевдонимы: detect-recoverytime integer	Время обнаружения восстановления.
detect_server псевдонимы: detect-server string	Сервер обнаружения.
detect_timeout псевдонимы: detect-timeout integer	Тайм-аут обнаружения.
gateway string	Шлюз.
gateway6 string	Шлюз IPv6.
ingress_spillover_threshold псевдонимы: ingress-spillover-threshold integer	Порог входящего перелива трафика.
interface string	Интерфейс.
priority integer	Приоритет.
source string	Источник.
source6 string	Источник IPv6.
spillover_threshold псевдонимы: spillover-threshold integer	Порог перелива трафика.
status string	Статус. Варианты: `"disable"` `"enable"`
volume_ratio псевдонимы: volume-ratio integer	Коэффициент объёма.
weight integer	Вес.
gateway string	Шлюз.
gateway6 string	Шлюз IPv6.
ingress_spillover_threshold псевдонимы: ingress-spillover-threshold integer	Порог входящего перелива трафика.
interface string	Интерфейс.
name string / обязательный	Имя.
priority integer	Приоритет.
source string	Источник.
source6 string	Источник IPv6.
spillover_threshold псевдонимы: spillover-threshold integer	Порог перелива трафика.
status string	Статус. Варианты: `"disable"` `"enable"`
volume_ratio псевдонимы: volume-ratio integer	Коэффициент объёма.
weight integer	Вес.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
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	Примечание об изменении, которое можно указать при создании или обновлении объекта.

state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: FortiGate interfaces added to the virtual-wan-link.
      fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_members:
          name: "your value" # Required variable, string
          # comment: <string>
          # cost: <integer>
          # detect_failtime: <integer>
          # detect_http_get: <string>
          # detect_http_match: <string>
          # detect_http_port: <integer>
          # detect_interval: <integer>
          # detect_protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          # detect_recoverytime: <integer>
          # detect_server: <string>
          # detect_timeout: <integer>
          # dynamic_mapping:
          #   - _scope:
          #       - name: <string>
          #         vdom: <string>
          #     comment: <string>
          #     cost: <integer>
          #     detect_failtime: <integer>
          #     detect_http_get: <string>
          #     detect_http_match: <string>
          #     detect_http_port: <integer>
          #     detect_interval: <integer>
          #     detect_protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          #     detect_recoverytime: <integer>
          #     detect_server: <string>
          #     detect_timeout: <integer>
          #     gateway: <string>
          #     gateway6: <string>
          #     ingress_spillover_threshold: <integer>
          #     interface: <string>
          #     priority: <integer>
          #     source: <string>
          #     source6: <string>
          #     spillover_threshold: <integer>
          #     status: <value in [disable, enable]>
          #     volume_ratio: <integer>
          #     weight: <integer>
          # gateway: <string>
          # gateway6: <string>
          # ingress_spillover_threshold: <integer>
          # interface: <string>
          # priority: <integer>
          # source: <string>
          # source6: <string>
          # spillover_threshold: <integer>
          # status: <value in [disable, enable]>
          # volume_ratio: <integer>
          # weight: <integer>

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

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

Ключ	Описание
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_dynamic_virtualwanlink_members_module.html