Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service — создание правил SD-WAN или правил приоритета

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / элементы=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

wanprof

string / обязательный

Параметр (wanprof) в запрошенном URL.

wanprof_system_virtualwanlink_service

dictionary

Набор параметров верхнего уровня.

addr_mode

псевдонимы: addr-mode

string

Режим адресации

Варианты:

  • "ipv4"
  • "ipv6"

bandwidth_weight

псевдонимы: bandwidth-weight

integer

Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1.

default

string

Включить/отключить использование SD-WAN в качестве службы по умолчанию.

Варианты:

  • "disable"
  • "enable"

dscp_forward

псевдонимы: dscp-forward

string

Включить/отключить тег DSCP для исходящего трафика.

Варианты:

  • "disable"
  • "enable"

dscp_forward_tag

псевдонимы: dscp-forward-tag

string

Тег DSCP для исходящего трафика.

dscp_reverse

псевдонимы: dscp-reverse

string

Включить/отключить тег DSCP для обратного трафика.

Варианты:

  • "disable"
  • "enable"

dscp_reverse_tag

псевдонимы: dscp-reverse-tag

string

Тег DSCP для обратного трафика.

dst

any

(список или строка) Имя адреса назначения.

dst6

any

(список или строка) Имя адреса назначения IPv6.

dst_negate

псевдонимы: dst-negate

string

Включить/отключить инвертирование условия совпадения адреса назначения.

Варианты:

  • "disable"
  • "enable"

end_port

псевдонимы: end-port

integer

Конечный номер порта назначения.

gateway

string

Включить/отключить шлюз службы SD-WAN.

Варианты:

  • "disable"
  • "enable"

groups

any

(список или строка) Группы пользователей.

health_check

псевдонимы: health-check

string

Проверка работоспособности.

hold_down_time

псевдонимы: hold-down-time

integer

Время ожидания в секундах при переключении с резервного участника на основной

id

integer / обязательный

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

input_device

псевдонимы: input-device

any

(список или строка) Имя исходного интерфейса.

input_device_negate

псевдонимы: input-device-negate

string

Включить/отключить инвертирование условия совпадения входного устройства.

Варианты:

  • "disable"
  • "enable"

internet_service

псевдонимы: internet-service

string

Включить/отключить использование интернет-службы для балансировки нагрузки на основе приложений.

Варианты:

  • "disable"
  • "enable"

internet_service_app_ctrl

псевдонимы: internet-service-app-ctrl

any

(список) Список идентификаторов интернет-служб на основе контроля приложений.

internet_service_app_ctrl_group

псевдонимы: internet-service-app-ctrl-group

any

(список или строка) Список групп интернет-служб на основе контроля приложений.

internet_service_ctrl

псевдонимы: internet-service-ctrl

any

(список) Список идентификаторов интернет-служб на основе управления.

internet_service_ctrl_group

псевдонимы: internet-service-ctrl-group

any

(список или строка) Список групп интернет-служб на основе управления.

internet_service_custom

псевдонимы: internet-service-custom

any

(список или строка) Список имён пользовательских интернет-служб.

internet_service_custom_group

псевдонимы: internet-service-custom-group

any

(список или строка) Список групп пользовательских интернет-служб.

internet_service_group

псевдонимы: internet-service-group

any

(список или строка) Список групп интернет-служб.

internet_service_id

псевдонимы: internet-service-id

any

(список или строка) Список идентификаторов интернет-служб.

internet_service_name

псевдонимы: internet-service-name

string

Список имён интернет-служб.

jitter_weight

псевдонимы: jitter-weight

integer

Коэффициент джиттера в формуле custom-profile-1.

latency_weight

псевдонимы: latency-weight

integer

Коэффициент задержки в формуле custom-profile-1.

link_cost_factor

псевдонимы: link-cost-factor

string

Фактор стоимости канала.

Варианты:

  • "latency"
  • "jitter"
  • "packet-loss"
  • "inbandwidth"
  • "outbandwidth"
  • "bibandwidth"
  • "custom-profile-1"

link_cost_threshold

псевдонимы: link-cost-threshold

integer

Пороговое процентное изменение значений стоимости канала, приводящее к повторному формированию маршрута на основе политики.

member

string

Порядковый номер участника.

mode

string

Определяет, как правило приоритета задаёт приоритет интерфейсов в SD-WAN.

Варианты:

  • "auto"
  • "manual"
  • "priority"
  • "sla"
  • "load-balance"

name

string

Имя правила приоритета.

packet_loss_weight

псевдонимы: packet-loss-weight

integer

Коэффициент потери пакетов в формуле custom-profile-1.

priority_members

псевдонимы: priority-members

any

(список или строка) Список порядковых номеров участников.

protocol

integer

Номер протокола.

quality_link

псевдонимы: quality-link

integer

role

string

Роль службы для взаимодействия с соседним узлом.

Варианты:

  • "primary"
  • "secondary"
  • "standalone"

route_tag

псевдонимы: route-tag

целое число

Тег карты маршрутов IPv4.

sla

список / элементы=словарь

SLA.

health_check

псевдонимы: health-check

строка

Проверка работоспособности Virtual WAN Link.

id

целое число

Идентификатор SLA.

sla_compare_method

псевдонимы: sla-compare-method

строка

Метод сравнения значения SLA для режимов SLA и балансировки нагрузки.

Варианты:

  • "order"
  • "number"

src

любой

(список или строка) Имя исходного адреса.

src6

любой

(список или строка) Имя исходного адреса IPv6.

src_negate

псевдонимы: src-negate

строка

Включить или отключить инверсию сопоставления исходного адреса.

Варианты:

  • "disable"
  • "enable"

standalone_action

псевдонимы: standalone-action

строка

Включить или отключить службу, если выбранная роль соседнего устройства — standalone, а роль службы — нет.

Варианты:

  • "disable"
  • "enable"

start_port

псевдонимы: start-port

целое число

Начальный номер порта назначения.

status

строка

Включить или отключить службу SD-WAN.

Варианты:

  • "disable"
  • "enable"

tos

строка

Шаблон битов типа обслуживания.

tos_mask

псевдонимы: tos-mask

строка

Биты типа обслуживания, подлежащие проверке.

users

любой

(список или строка) Имя пользователя.

workspace_locking_adom

строка

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
  • Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Вы также можете переопределить условия ошибки или успешного выполнения с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Create SD-WAN rules or priority rules
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        state: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_service:
          id: 0 # Required variable, integer
          # addr_mode: <value in [ipv4, ipv6]>
          # bandwidth_weight: <integer>
          # default: <value in [disable, enable]>
          # dscp_forward: <value in [disable, enable]>
          # dscp_forward_tag: <string>
          # dscp_reverse: <value in [disable, enable]>
          # dscp_reverse_tag: <string>
          # dst: <list or string>
          # dst_negate: <value in [disable, enable]>
          # dst6: <list or string>
          # end_port: <integer>
          # gateway: <value in [disable, enable]>
          # groups: <list or string>
          # health_check: <string>
          # hold_down_time: <integer>
          # internet_service: <value in [disable, enable]>
          # internet_service_ctrl: <list or integer>
          # internet_service_ctrl_group: <list or string>
          # internet_service_custom: <list or string>
          # internet_service_custom_group: <list or string>
          # internet_service_group: <list or string>
          # internet_service_id: <list or string>
          # jitter_weight: <integer>
          # latency_weight: <integer>
          # link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
          # link_cost_threshold: <integer>
          # member: <string>
          # mode: <value in [auto, manual, priority, ...]>
          # name: <string>
          # packet_loss_weight: <integer>
          # priority_members: <list or string>
          # protocol: <integer>
          # quality_link: <integer>
          # route_tag: <integer>
          # sla:
          #   - health_check: <string>
          #     id: <integer>
          # src: <list or string>
          # src_negate: <value in [disable, enable]>
          # src6: <list or string>
          # start_port: <integer>
          # status: <value in [disable, enable]>
          # tos: <string>
          # tos_mask: <string>
          # users: <list or string>
          # internet_service_app_ctrl: <list or integer>
          # internet_service_app_ctrl_group: <list or string>
          # role: <value in [primary, secondary, standalone]>
          # sla_compare_method: <value in [order, number]>
          # standalone_action: <value in [disable, enable]>
          # input_device: <list or string>
          # internet_service_name: <string>
          # input_device_negate: <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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_service_module.html

Spec-Zone.ru

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