fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service – Создать правила SD-WAN или правила приоритета (также называемые службами) для управления распределением сеансов по физическим интерфейсам в SD-WAN.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service.

В версии 2.10: добавлен в fortinet.fortimanager

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

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

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation булево			Варианты: нет ← да	устанавливается только в случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых условия отказа будут переопределены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия успеха будут переопределены
state строка / обязательно			Варианты: present absent	направление создания, обновления или удаления объекта
wanprof строка / обязательно				параметр (wanprof) в запрошенном URL
wanprof_system_virtualwanlink_service словарь				установленные параметры верхнего уровня
	addr-mode строка		Варианты: ipv4 ipv6	Режим адреса (IPv4 или IPv6).
	bandwidth-weight целое число			Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1.
	default строка		Варианты: disable enable	Включить/выключить использование SD-WAN в качестве службы по умолчанию.
	dscp-forward строка		Варианты: disable enable	Включить/выключить тег DSCP для передаваемого трафика.
	dscp-forward-tag строка			Тег DSCP для передаваемого трафика.
	dscp-reverse строка		Варианты: disable enable	Включить/выключить тег DSCP для обратного трафика.
	dscp-reverse-tag строка			Тег DSCP для обратного трафика.
	dst строка			Имя адреса назначения.
	dst-negate строка		Варианты: disable enable	Включить/выключить отрицание соответствия адреса назначения.
	dst6 строка			Имя адреса назначения IPv6.
	end-port целое число			Номер конечного порта назначения.
	gateway строка		Варианты: disable enable	Включить/выключить шлюз службы SD-WAN.
	groups строка			Пользовательские группы.
	health-check строка			Проверка работоспособности.
	hold-down-time целое число			Период ожидания в секундах при переключении от резервного члена к основному члену (0 - 10000000, по умолчанию = 0).
	id целое число			Идентификатор правила приоритета (1 - 4000).
	internet-service строка		Варианты: disable enable	Включить/выключить использование Интернет-службы для балансировки нагрузки на основе приложений.
	internet-service-ctrl целое число			нет описания
	internet-service-ctrl-group строка			Список групп служб Интернет на основе управления.
	internet-service-custom строка			Список пользовательских имен служб Интернет.
	internet-service-custom-group строка			Список пользовательских групп служб Интернет.
	internet-service-group строка			Список групп служб Интернет.
	internet-service-id строка			Список идентификаторов служб Интернет.
	jitter-weight целое число			Коэффициент джиттера в формуле custom-profile-1.
	latency-weight целое число			Коэффициент задержки в формуле custom-profile-1.
	link-cost-factor строка		Варианты: latency jitter packet-loss inbandwidth outbandwidth bibandwidth custom-profile-1	Фактор стоимости канала.
	link-cost-threshold целое число			Процентный порог изменения значений стоимости канала, который приведет к перегенерации правил маршрутизации политики (0 - 10000000, по умолчанию = 10).
	member строка			Порядковый номер члена.
	mode строка		Варианты: auto manual priority sla load-balance	Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN.
	name строка			Имя правила приоритета.
	packet-loss-weight целое число			Коэффициент потерь пакетов в формуле custom-profile-1.
	priority-members строка			Список порядковых номеров членов.
	protocol целое число			Номер протокола.
	quality-link целое число			Оценка качества.
	route-tag целое число			Тег маршрута IPv4.
	sla список / элементы=строка			нет описания
		health-check строка		Проверка работоспособности виртуального WAN-канала.
		id целое число		Идентификатор SLA.
	src строка			Имя исходного адреса.
	src-negate строка		Варианты: disable enable	Включить/выключить отрицание соответствия исходного адреса.
	src6 строка			Имя исходного адреса IPv6.
	start-port целое число			Начальный номер порта назначения.
	status строка		Варианты: disable enable	Включить/выключить службу SD-WAN.
	tos строка			Битовая маска типа обслуживания.
	tos-mask строка			Биты типа обслуживания для оценки.
	users строка			Имя пользователя.
workspace_locking_adom строка				adom для блокировки в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая root
workspace_locking_timeout целое число			По умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Также можно переопределить условия завершения успешно или с ошибкой с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Create SD-WAN rules or priority rules (also called services) to control how sessions are distributed to physical interfaces in the SD-WAN.
     fmgr_wanprof_system_virtualwanlink_service:
        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: <value in [present, absent]>
        wanprof_system_virtualwanlink_service:
           addr-mode: <value in [ipv4, ipv6]>
           bandwidth-weight: <value of integer>
           default: <value in [disable, enable]>
           dscp-forward: <value in [disable, enable]>
           dscp-forward-tag: <value of string>
           dscp-reverse: <value in [disable, enable]>
           dscp-reverse-tag: <value of string>
           dst: <value of string>
           dst-negate: <value in [disable, enable]>
           dst6: <value of string>
           end-port: <value of integer>
           gateway: <value in [disable, enable]>
           groups: <value of string>
           health-check: <value of string>
           hold-down-time: <value of integer>
           id: <value of integer>
           internet-service: <value in [disable, enable]>
           internet-service-ctrl: <value of integer>
           internet-service-ctrl-group: <value of string>
           internet-service-custom: <value of string>
           internet-service-custom-group: <value of string>
           internet-service-group: <value of string>
           internet-service-id: <value of string>
           jitter-weight: <value of integer>
           latency-weight: <value of integer>
           link-cost-factor: <value in [latency, jitter, packet-loss, ...]>
           link-cost-threshold: <value of integer>
           member: <value of string>
           mode: <value in [auto, manual, priority, ...]>
           name: <value of string>
           packet-loss-weight: <value of integer>
           priority-members: <value of string>
           protocol: <value of integer>
           quality-link: <value of integer>
           route-tag: <value of integer>
           sla:
             -
                 health-check: <value of string>
                 id: <value of integer>
           src: <value of string>
           src-negate: <value in [disable, enable]>
           src6: <value of string>
           start-port: <value of integer>
           status: <value in [disable, enable]>
           tos: <value of string>
           tos-mask: <value of string>
           users: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_service_module.html