fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink – Настройка резервных интернет-соединений с помощью SD-WAN (ранее виртуальная WAN-линк).

Примечание

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

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink.

В версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно					параметр (adom) в запрошенном URL
bypass_validation логический тип				Варианты: нет ← да	устанавливать в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка					список кодов rc, с которыми будут перезаписаны условия для отказа
rc_succeeded список / элементы=строка					список кодов rc, с которыми будут перезаписаны условия для успеха
state строка / обязательно				Варианты: present absent	директива для создания, обновления или удаления объекта
wanprof строка / обязательно					параметр (wanprof) в запрошенном URL
wanprof_system_virtualwanlink словарь					установленные параметры верхнего уровня
	fail-detect строка			Варианты: выключить включить	Включение/выключение проверки состояния интернет-соединения SD-WAN (обнаружение сбоев).
	health-check список / элементы=строка				нет описания
		_dynamic-server строка			нет описания
		addr-mode строка		Варианты: ipv4 ipv6	Режим адресации (IPv4 или IPv6).
		failtime целое число			Количество неудач до того, как сервер будет считаться потерянным (1 - 3600, по умолчанию = 5).
		http-agent строка			Строка в поле http-agent в заголовке HTTP.
		http-get строка			URL, используемый для связи с сервером, если протокол HTTP.
		http-match строка			Ожидаемая строка ответа от сервера, если протокол HTTP.
		interval целое число			Интервал проверки статуса или время между попытками подключения к серверу (1 - 3600 сек, по умолчанию = 5).
		members строка			Список номеров последовательности участников.
		name строка			Имя проверки состояния или проверки работоспособности.
		packet-size целое число			Размер пакета сессии теста twamp,
		password строка			нет описания
		port целое число			Номер порта, используемый для связи с сервером через выбранный протокол.
		protocol строка		Варианты: ping tcp-echo udp-echo http twamp ping6	Протокол, используемый для определения возможности связи FortiGate с сервером.
		recoverytime целое число			Количество полученных успешных ответов до того, как сервер будет считаться восстановленным (1 - 3600, по умолчанию = 5).
		security-mode строка		Варианты: нет аутентификация	Режим безопасности контроллера Twamp.
		server строка			нет описания
		sla список / элементы=строка			нет описания
			id целое число		Идентификатор SLA.
			jitter-threshold целое число		Джиттер для SLA для принятия решения в миллисекундах. (0 - 10000000, по умолчанию = 5).
			latency-threshold целое число		Задержка для SLA для принятия решения в миллисекундах. (0 - 10000000, по умолчанию = 5).
			link-cost-factor список / элементы=строка	Варианты: задержка джиттер потеря пакетов	нет описания
			packetloss-threshold целое число		Потеря пакетов для SLA для принятия решения в процентах. (0 - 100, по умолчанию = 0).
		threshold-alert-jitter целое число			Пороговое значение для оповещения о джиттере (мс, по умолчанию = 0).
		threshold-alert-latency целое число			Пороговое значение для оповещения о задержке (мс, по умолчанию = 0).
		threshold-alert-packetloss целое число			Пороговое значение для оповещения о потере пакетов (в процентах, по умолчанию = 0).
		threshold-warning-jitter целое число			Пороговое значение предупреждения о джиттере (мс, по умолчанию = 0).
		threshold-warning-latency целое число			Пороговое значение предупреждения о задержке (мс, по умолчанию = 0).
		threshold-warning-packetloss целое число			Пороговое значение предупреждения о потере пакетов (в процентах, по умолчанию = 0).
		update-cascade-interface строка		Варианты: выключить включить	Включение/выключение обновления каскадного интерфейса.
		update-static-route строка		Варианты: выключить включить	Включение/выключение обновления статического маршрута.
	load-balance-mode строка			Варианты: на основе исходного IP-адреса на основе весов на основе использования на основе исходного и конечного IP-адресов на основе измеренного объема	Алгоритм или режим использования для балансировки нагрузки интернет-трафика на участников SD-WAN.
	members список / элементы=строка				нет описания
		_dynamic-member строка			нет описания
		comment строка			Комментарии.
		gateway строка			Основной шлюз для этого интерфейса. Обычно основной шлюз интернет-провайдера, к которому подключен этот...
		gateway6 строка			IPv6 шлюз.

	пороговое значение переполнения входящего трафика целое число		Пороговое значение переполнения входящего трафика для этого интерфейса (0 – 16776000 кбит/с). Когда этот порог объема трафика достигнут, n...
	интерфейс строка		Имя интерфейса.
	приоритет целое число		Приоритет интерфейса (0 – 4294967295). Используется для правил SD-WAN или правил приоритета.
	номер последовательности целое число		Номер последовательности (1-255).
	источник строка		Используемый IP-адрес источника в пакете проверки работоспособности сервера.
	источник6 строка		Используемый IPv6-адрес источника в пакете проверки работоспособности сервера.
	пороговое значение переполнения исходящего трафика целое число		Пороговое значение переполнения исходящего трафика для этого интерфейса (0 – 16776000 кбит/с). Когда этот порог объема трафика достигнут, ne...
	статус строка	Варианты: disable enable	Включить/выключить этот интерфейс в SD-WAN.
	отношение объемов целое число		Измеренное отношение объемов (это значение / сумма всех значений = процент от объема канала, 0 – 255).
	вес целое число		Вес этого интерфейса для взвешенного балансирования нагрузки. (0 – 255) Больше трафика направляется на интерфейсы с большим весом...
сервис список / элементы=строка			нет описания
	режим адресации строка	Варианты: ipv4 ipv6	Режим адресации (IPv4 или IPv6).
	вес пропускной способности целое число		Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1.
	по умолчанию строка	Варианты: disable enable	Включить/выключить использование SD-WAN в качестве сервиса по умолчанию.
	передача DSCP тега строка	Варианты: disable enable	Включить/выключить передачу тега DSCP трафика.
	тег DSCP для передачи строка		Тег DSCP трафика для передачи.
	обратная передача DSCP тега строка	Варианты: disable enable	Включить/выключить передачу тега DSCP обратного трафика.
	тег DSCP для обратной передачи строка		Тег DSCP трафика для обратной передачи.
	назначение строка		Имя адреса назначения.
	отрицание назначения строка	Варианты: disable enable	Включить/выключить отрицание соответствия адреса назначения.
	назначение6 строка		Имя адреса назначения 6.
	порт-конец целое число		Номер конечного порта назначения.
	шлюз строка	Варианты: disable enable	Включить/выключить шлюз сервиса SD-WAN.
	группы строка		Пользовательские группы.
	проверка работоспособности строка		Проверка работоспособности.
	время удержания целое число		Период ожидания в секундах при переключении с резервного члена на основной (0 – 10000000, по умолчанию = 0).
	идентификатор целое число		Идентификатор правила приоритета (1 – 4000).
	сервис интернета строка	Варианты: disable enable	Включить/выключить использование интернет-сервиса для балансирования нагрузки на основе приложений.
	контроль интернет-сервиса целое число		нет описания
	группа управления интернет-сервисом строка		Список групп управления интернет-сервисом.
	настраиваемый интернет-сервис строка		Список имен настраиваемых интернет-сервисов.
	группа настраиваемых интернет-сервисов строка		Список групп настраиваемых интернет-сервисов.
	группа интернет-сервисов строка		Список групп интернет-сервисов.
	идентификатор интернет-сервиса строка		Список идентификаторов интернет-сервисов.
	вес джиттера целое число		Коэффициент джиттера в формуле custom-profile-1.
	вес задержки целое число		Коэффициент задержки в формуле custom-profile-1.
	коэффициент стоимости канала строка	Варианты: задержка джиттер потеря пакетов входящая пропускная способность исходящая пропускная способность двунаправленная пропускная способность custom-profile-1	Коэффициент стоимости канала.
	пороговое значение стоимости канала целое число		Процентное пороговое значение изменения значений стоимости канала, которое приведет к регенерации маршрутов политики (0 – 10000000, по умолчанию =...
	член строка		Номер последовательности члена.
	режим строка	Варианты: авто ручной приоритет SLA балансировка нагрузки	Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN.
	имя строка		Имя правила приоритета.
	вес потерь пакетов целое число		Коэффициент потери пакетов в формуле custom-profile-1.
	члены приоритета строка		Список номеров последовательности членов.
	протокол целое число		Номер протокола.
	качество канала целое число		Класс качества.
	тег маршрута целое число		Тег маршрута карты маршрутов IPv4.

		sla list / elements=string			без описания
			health-check string		Проверка работоспособности канала виртуальной WAN.
			id integer		Идентификатор SLA.
		src string			Имя адреса источника.
		src-negate string		Варианты: disable enable	Включить/выключить инверсию совпадения адреса источника.
		src6 string			Имя адреса источника версии 6.
		start-port integer			Номер начального порта назначения.
		status string		Варианты: disable enable	Включить/выключить SD-WAN услугу.
		tos string			Шаблон битов типа обслуживания.
		tos-mask string			Биты типа обслуживания, подлежащие оценке.
		users string			Имя пользователя.
	status string			Варианты: disable enable	Включить/выключить SD-WAN.
workspace_locking_adom string					adom, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer				Значение по умолчанию: 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: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
     fmgr_wanprof_system_virtualwanlink:
        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>
        wanprof_system_virtualwanlink:
           fail-detect: <value in [disable, enable]>
           health-check:
             -
                 _dynamic-server: <value of string>
                 addr-mode: <value in [ipv4, ipv6]>
                 failtime: <value of integer>
                 http-agent: <value of string>
                 http-get: <value of string>
                 http-match: <value of string>
                 interval: <value of integer>
                 members: <value of string>
                 name: <value of string>
                 packet-size: <value of integer>
                 password: <value of string>
                 port: <value of integer>
                 protocol: <value in [ping, tcp-echo, udp-echo, ...]>
                 recoverytime: <value of integer>
                 security-mode: <value in [none, authentication]>
                 server: <value of string>
                 sla:
                   -
                       id: <value of integer>
                       jitter-threshold: <value of integer>
                       latency-threshold: <value of integer>
                       link-cost-factor:
                         - latency
                         - jitter
                         - packet-loss
                       packetloss-threshold: <value of integer>
                 threshold-alert-jitter: <value of integer>
                 threshold-alert-latency: <value of integer>
                 threshold-alert-packetloss: <value of integer>
                 threshold-warning-jitter: <value of integer>
                 threshold-warning-latency: <value of integer>
                 threshold-warning-packetloss: <value of integer>
                 update-cascade-interface: <value in [disable, enable]>
                 update-static-route: <value in [disable, enable]>
           load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]>
           members:
             -
                 _dynamic-member: <value of string>
                 comment: <value of string>
                 gateway: <value of string>
                 gateway6: <value of string>
                 ingress-spillover-threshold: <value of integer>
                 interface: <value of string>
                 priority: <value of integer>
                 seq-num: <value of integer>
                 source: <value of string>
                 source6: <value of string>
                 spillover-threshold: <value of integer>
                 status: <value in [disable, enable]>
                 volume-ratio: <value of integer>
                 weight: <value of integer>
           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>
           status: <value in [disable, enable]>

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

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

Ключ	Возвращается	Описание
request_url string	всегда	Полный запрашиваемый URL. Пример: /sys/login/user
response_code integer	всегда	Статус запроса API.
response_message string	всегда	Описание ответа 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_module.html