Модуль fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members_dynamicmapping — Интерфейсы FortiGate, добавленные к виртуальному WAN-соединению.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members_dynamicmapping.

Новое в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
dynamic_virtualwanlink_members_dynamicmapping dictionary	Набор параметров верхнего уровня.
_scope list / elements=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
comment string	Комментарий.
cost integer	Стоимость.
detect-failtime integer	Устарело, пожалуйста, переименуйте его в detect_failtime. Время обнаружения сбоя.
detect-http-get string	Устарело, пожалуйста, переименуйте его в detect_http_get. Обнаружение HTTP GET.
detect-http-match string	Устарело, пожалуйста, переименуйте его в detect_http_match. Сопоставление HTTP.
detect-http-port integer	Устарело, пожалуйста, переименуйте его в detect_http_port. Порт HTTP.
detect-interval integer	Устарело, пожалуйста, переименуйте его в detect_interval. Интервал обнаружения.
detect-protocol string	Устарело, пожалуйста, переименуйте его в detect_protocol. Протокол обнаружения. Варианты: `"ping"` `"tcp-echo"` `"udp-echo"` `"http"`
detect-recoverytime integer	Устарело, пожалуйста, переименуйте его в detect_recoverytime. Время восстановления обнаружения.
detect-server string	Устарело, пожалуйста, переименуйте его в detect_server. Сервер обнаружения.
detect-timeout integer	Устарело, пожалуйста, переименуйте его в detect_timeout. Время ожидания обнаружения.
gateway string	Шлюз.
gateway6 string	Шлюз6.
ingress-spillover-threshold integer	Устарело, пожалуйста, переименуйте его в ingress_spillover_threshold. Порог переполнения входящего трафика.
interface string	Интерфейс.

приоритет целое число	Приоритет.
источник строка	Источник.
источник6 строка	Источник6.
порог-переполнения целое число	Устарело, пожалуйста, переименуйте на spillover_threshold. Порог переполнения.
статус строка	Статус. Варианты: `"disable"` `"enable"`
соотношение-объема целое число	Устарело, пожалуйста, переименуйте на volume_ratio. Соотношение объёма.
вес целое число	Вес.
включить_лог булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
токен_доступа_forticloud строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
члены строка / обязательно	Параметр (члены) в запрошенном URL.
предложенный_метод строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_неудачные список / элементы=целое число	Список кодов rc, при которых условия будут нарушены.
rc_успешные список / элементы=целое число	Список кодов rc, при которых условия будут выполнены.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочей_области_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корень.
тайм-аут_блокировки_рабочей_области целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: FortiGate interfaces added to the virtual-wan-link.
      fortinet.fortimanager.fmgr_dynamic_virtualwanlink_members_dynamicmapping:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        members: <your own value>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_members_dynamicmapping:
          _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>

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_dynamic_virtualwanlink_members_dynamicmapping_module.html