Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_neighbor — Создание узла SD-WAN из таблицы соседей BGP для управления рекламой маршрутов в соответствии со статусом SLA.

Примечание

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

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

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

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

Новое в 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_neighbor словарь	Установленные параметры верхнего уровня.
health_check строка	Устаревшее значение, пожалуйста, переименуйте на health_check. Название проверки состояния SD-WAN.
ip строка	IP/IPv6 адрес соседа.
member любой тип	(список или строка) Номер последовательности участника.
minimum_sla_meet_members целое число	Устаревшее значение, пожалуйста, переименуйте на minimum_sla_meet_members. Минимальное количество участников, удовлетворяющих SLA, когда сосед pr…
mode строка	Какой метрике выбрать соседа. Выбираемые значения: `"sla"` `"speedtest"`
role строка	Роль соседа. Выбираемые значения: `"primary"` `"secondary"` `"standalone"`
service_id строка	Устаревшее значение, пожалуйста, переименуйте на service_id. Идентификатор службы SD-WAN для работы с соседом.
sla_id целое число	Устаревшее значение, пожалуйста, переименуйте на sla_id. Идентификатор SLA.
workspace_locking_adom строка	Область, которая будет заблокирована для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

END_OF_DOCUMENT_MARKER

Примечания

Примечание

Начиная с версии 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: Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_neighbor:
        # 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_neighbor:
          health_check: <string>
          ip: <string>
          member: <list or string>
          role: <value in [primary, secondary, standalone]>
          sla_id: <integer>
          minimum_sla_meet_members: <integer>
          mode: <value in [sla, speedtest]>
          service_id: <string>

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

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_neighbor_module.html