Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_wanprof_system_sdwan_duplication модуль — Создание правила дублирования SD-WAN.

Примечание

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

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

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

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

Добавлен в 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_duplication

словарь

Установленные параметры верхнего уровня.

dstaddr

любой тип

(список или строка) Адрес назначения или имена групп адресов.

dstaddr6

любой тип

(список или строка) Адрес6 назначения или имена групп адресов6.

dstintf

любой тип

(список или строка) Исходящий

id

целое число / обязательно

Идентификатор правила дублирования

packet_de_duplication

строка

Устарело, пожалуйста, переименуйте его в packet_de_duplication. Включить/выключить отбрасывание пакетов, которые были дублированы.

Варианты:

  • "disable"
  • "enable"

packet_duplication

строка

Устарело, пожалуйста, переименуйте его в packet_duplication. Настройка метода дублирования пакетов.

Варианты:

  • "disable"
  • "force"
  • "on-demand"

service

любой тип

(список или строка) Имя службы и группы служб.

service_id

любой тип

(список или строка) Устарело, пожалуйста, переименуйте его в service_id. Список идентификаторов правил службы SD-WAN.

sla_match_service

строка

Устарело, пожалуйста, переименуйте его в sla_match_service. Включить/выключить сопоставление дублирования пакетов с проверками состояния SLAs в службе…

Варианты:

  • "disable"
  • "enable"

srcaddr

any

(список или строка) Адрес источника или имена групп адресов.

srcaddr6

any

(список или строка) Адрес источника IPv6 или имена групп адресов IPv6.

srcintf

any

(список или строка) Входящие

workspace_locking_adom

строка

ADOM для блокировки при работе FortiManager в режиме рабочей области. Значение может быть глобальным и другими, включая 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: Create SD-WAN duplication rule.
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_duplication:
        # 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_duplication:
          dstaddr: <list or string>
          dstaddr6: <list or string>
          dstintf: <list or string>
          id: <integer>
          packet_de_duplication: <value in [disable, enable]>
          packet_duplication: <value in [disable, force, on-demand]>
          service: <list or string>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          srcintf: <list or string>
          service_id: <list or string>
          sla_match_service: <value in [disable, enable]>

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

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

Ключ

Описание

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_duplication_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API