Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_members — интерфейсы FortiGate, добавленные в SD-WAN.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
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"`
wanprof строка / обязательно	Параметр (wanprof) в запрошенном URL.
wanprof_system_sdwan_members словарь	Настройки верхнего уровня.
_dynamic_member строка	Устарело, переименуйте на _dynamic_member. Динамический член.
comment строка	Комментарии.
cost целое	Стоимость этого интерфейса для служб в режиме SLA.
gateway строка	Основной шлюз для этого интерфейса.
gateway6 строка	IPv6 шлюз.
ingress_spillover_threshold целое	Порог переполнения входящего трафика для этого интерфейса.
interface строка	Имя интерфейса.
preferred_source строка	Предпочтительный источник маршрута для этого члена.
priority целое	Приоритет интерфейса.
priority_in_sla целое	Предпочтительный приоритет маршрутов к этому члену, когда этот член находится в SLA.
priority_out_sla целое	Предпочтительный приоритет маршрутов к этому члену, когда этот член не находится в SLA.

END_OF_DOCUMENT_MARKER

priority6 целое число	Приоритет интерфейса для IPv6
seq-num целое число / обязательно	Устаревшее, пожалуйста, переименуйте на seq_num. Последовательный номер
source строка	IP-адрес источника, используемый в пакете проверки работоспособности на сервер.
source6 строка	IPv6-адрес источника, используемый в пакете проверки работоспособности на сервер.
spillover-threshold целое число	Устаревшее, пожалуйста, переименуйте на spillover_threshold. Пороговое значение переполнения для данного интерфейса
status строка	Включить/выключить данный интерфейс в SD-WAN. Варианты: `"disable"` `"enable"`
transport-group целое число	Устаревшее, пожалуйста, переименуйте на transport_group. Измеренная группа транспорта
volume-ratio целое число	Устаревшее, пожалуйста, переименуйте на volume_ratio. Измеренное соотношение объёмов
weight целое число	Вес этого интерфейса для взвешенного балансирования нагрузки.
zone строка	Название зоны.
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 SD-WAN.
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_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>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_sdwan_members:
          _dynamic_member: <string>
          comment: <string>
          cost: <integer>
          gateway: <string>
          gateway6: <string>
          ingress_spillover_threshold: <integer>
          interface: <string>
          priority: <integer>
          seq_num: <integer>
          source: <string>
          source6: <string>
          spillover_threshold: <integer>
          status: <value in [disable, enable]>
          volume_ratio: <integer>
          weight: <integer>
          zone: <string>
          priority6: <integer>
          preferred_source: <string>
          transport_group: <integer>
          priority_in_sla: <integer>
          priority_out_sla: <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_wanprof_system_sdwan_members_module.html