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

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

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

priority целое число	Приоритет.
source строка	Источник.
source6 строка	Источник6.
spillover-threshold целое число	Устаревшее, пожалуйста, переименуйте на spillover_threshold. Пороговое значение переполнения.
status строка	Статус. Варианты: `"disable"` `"enable"`
volume-ratio целое число	Устаревшее, пожалуйста, переименуйте на volume_ratio. Коэффициент объема.
weight целое число	Вес.
enable_log логический тип	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентифицировать Ansible-клиента с токеном доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых выполнение будет остановлено.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых выполнение будет успешным.
state строка / обязательное	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы с рабочей областью FortiManager. Значение может быть global и другими, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания (в секундах) для освобождения блокировки рабочей области другим пользователем. По умолчанию: `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:
        # 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>
        state: present # <value in [present, absent]>
        dynamic_virtualwanlink_members:
          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>
          name: <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_module.html