fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink модуль — Настройка резервных интернет-соединений с использованием 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_virtualwanlink.
Впервые в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, для которых будут переопределены условия неудачи. |
rc_succeeded список / элементы=целое число | Список кодов rc, для которых будут переопределены условия успеха. |
wanprof строка / обязательно | Параметр (wanprof) в запрошенном URL. |
wanprof_system_virtualwanlink словарь | Установленные параметры верхнего уровня. |
|
fail-alert-interfaces любой |
(список) Устарело, пожалуйста, переименуйте в fail_alert_interfaces. Физические интерфейсы, которые будут оповещены. |
|
fail-detect строка |
Устарело, пожалуйста, переименуйте в fail_detect. Включение/выключение проверки состояния подключения SD-WAN к Интернету Варианты:
|
|
health-check список / элементы=словарь |
Устарело, пожалуйста, переименуйте в health_check. Проверка работоспособности. |
|
_dynamic-server строка |
Устарело, пожалуйста, переименуйте в _dynamic_server. Динамический сервер. |
|
addr-mode строка |
Устарело, пожалуйста, переименуйте в addr_mode. Режим адреса Варианты:
|
|
diffservcode строка |
Код точки дифференцированных служб |
|
dns-request-domain строка |
Устарело, пожалуйста, переименуйте в dns_request_domain. Полное доменное имя для разрешения DNS-зонда. |
|
failtime целое число |
Количество неудач перед тем, как сервер будет считаться потерянным |
|
ha-priority целое число |
Устарело, пожалуйста, переименуйте в ha_priority. Приоритет выбора HA |
|
http-agent строка |
Устарело, пожалуйста, переименуйте в http_agent. Строка в поле http-agent в HTTP-заголовке. |
|
http-get строка |
Устарело, пожалуйста, переименуйте в http_get. URL, используемый для связи с сервером, если протокол … |
|
http-match string |
Устарело, переименуйте в http_match. Ожидаемая строка ответа от сервера, если протокол HTTP. |
|
internet-service-id string |
Устарело, переименуйте в internet_service_id. Идентификатор интернет-сервиса. |
|
interval integer |
Интервал проверки состояния или время между попытками подключения к серверу |
|
members any |
(список или строка) Список номеров последовательности участников. |
|
name string |
Имя проверки состояния или проверки работоспособности. |
|
packet-size integer |
Устарело, переименуйте в packet_size. Размер пакета сеанса теста TWAMP, |
|
password any |
(список) Пароль контроллера TWAMP в режиме аутентификации |
|
port integer |
Номер порта, используемый для связи с сервером по выбранному протоколу. |
|
probe-count integer |
Устарело, переименуйте в probe_count. Количество последних проб, которые должны использоваться для вычисления задержки… |
|
probe-packets string |
Устарело, переименуйте в probe_packets. Включить/выключить передачу пробных пакетов. Варианты:
|
|
probe-timeout integer |
Устарело, переименуйте в probe_timeout. Время ожидания, прежде чем пробный пакет будет считаться потерянным |
|
protocol string |
Протокол, используемый для определения того, может ли FortiGate общаться с сервером. Варианты:
|
|
recoverytime integer |
Количество полученных успешных ответов, прежде чем сервер будет считаться восстановленным |
|
security-mode string |
Устарело, переименуйте в security_mode. Режим безопасности контроллера TWAMP. Варианты:
|
|
server any |
(список) IP-адрес или полное доменное имя сервера. |
|
sla list / elements=dictionary |
SLA. |
|
id integer |
Идентификатор SLA. |
|
jitter-threshold integer |
Устарело, переименуйте в jitter_threshold. Джиттер для SLA для принятия решения в миллисекундах. |
|
latency-threshold integer |
Устарело, переименуйте в latency_threshold. Задержка для SLA для принятия решения в миллисекундах. |
|
link-cost-factor list / elements=string |
Устарело, переименуйте в link_cost_factor. Критерии, на основе которых следует выбирать ссылку. Варианты:
|
|
packetloss-threshold integer |
Устарело, переименуйте в packetloss_threshold. Потеря пакетов для SLA для принятия решения в процентах. |
|
sla-fail-log-period integer |
Устаревшее, пожалуйста, переименуйте его в sla_fail_log_period. Интервал времени в секундах, в течение которого будут регистрироваться сообщения об ошибках SLA… |
|
sla-pass-log-period integer |
Устаревшее, пожалуйста, переименуйте его в sla_pass_log_period. Интервал времени в секундах, в течение которого будут регистрироваться сообщения об успешных проверках SLA… |
|
system-dns string |
Устаревшее, пожалуйста, переименуйте его в system_dns. Включить/выключить системный DNS в качестве сервера проверки. Варианты:
|
|
threshold-alert-jitter integer |
Устаревшее, пожалуйста, переименуйте его в threshold_alert_jitter. Пороговое значение для оповещения о джиттере |
|
threshold-alert-latency integer |
Устаревшее, пожалуйста, переименуйте его в threshold_alert_latency. Пороговое значение для оповещения о задержке |
|
threshold-alert-packetloss integer |
Устаревшее, пожалуйста, переименуйте его в threshold_alert_packetloss. Пороговое значение для оповещения о потерях пакетов |
|
threshold-warning-jitter integer |
Устаревшее, пожалуйста, переименуйте его в threshold_warning_jitter. Пороговое значение для предупреждения о джиттере |
|
threshold-warning-latency integer |
Устаревшее, пожалуйста, переименуйте его в threshold_warning_latency. Пороговое значение для предупреждения о задержке |
|
threshold-warning-packetloss integer |
Устаревшее, пожалуйста, переименуйте его в threshold_warning_packetloss. Пороговое значение для предупреждения о потерях пакетов |
|
timeout integer |
Сколько времени ждать ответа от сервера, чтобы считать попытку подключения неудачной |
|
update-cascade-interface string |
Устаревшее, пожалуйста, переименуйте его в update_cascade_interface. Включить/выключить обновление интерфейса каскада. Варианты:
|
|
update-static-route string |
Устаревшее, пожалуйста, переименуйте его в update_static_route. Включить/выключить обновление статического маршрута. Варианты:
|
|
load-balance-mode string |
Устаревшее, пожалуйста, переименуйте его в load_balance_mode. Алгоритм или режим для использования при распределении интернет-трафика для SD-WAN… Варианты:
|
|
members list / elements=dictionary |
Члены. |
|
_dynamic-member string |
Устаревшее, пожалуйста, переименуйте его в _dynamic_member. Динамический член. |
|
comment string |
Комментарии. |
|
cost integer |
Стоимость этого интерфейса для услуг в режиме SLA |
|
gateway string |
Основной шлюз для этого интерфейса. |
|
gateway6 string |
Шлюз IPv6. |
|
ingress-spillover-threshold integer |
Устаревшее, пожалуйста, переименуйте его в ingress_spillover_threshold. Пороговое значение для переполнения входящего трафика для этого интерфейса |
|
interface string |
Имя интерфейса. |
|
priority integer |
Приоритет интерфейса |
|
seq-num integer |
Устарело, переименуйте в seq_num. Номер последовательности |
|
source string |
Исходный IP-адрес, используемый в пакете проверки работоспособности для сервера. |
|
source6 string |
Исходный IPv6-адрес, используемый в пакете проверки работоспособности для сервера. |
|
spillover-threshold integer |
Устарело, переименуйте в spillover_threshold. Порог переполнения исходящего трафика для этого интерфейса |
|
status string |
Включить/выключить этот интерфейс в SD-WAN. Варианты:
|
|
volume-ratio integer |
Устарело, переименуйте в volume_ratio. Измеренное соотношение объемов |
|
weight integer |
Вес этого интерфейса для балансировки нагрузки с учетом веса. |
|
neighbor list / elements=dictionary |
Сосед. |
|
health-check string |
Устарело, переименуйте в health_check. Имя проверки работоспособности SD-WAN. |
|
ip string |
IP-адрес соседа. |
|
member string |
Номер последовательности участника. |
|
role string |
Роль соседа. Варианты:
|
|
sla-id integer |
Устарело, переименуйте в sla_id. Идентификатор SLA. |
|
neighbor-hold-boot-time integer |
Устарело, переименуйте в neighbor_hold_boot_time. Время ожидания в секундах при переключении с основного соседа… |
|
neighbor-hold-down string |
Устарело, переименуйте в neighbor_hold_down. Включить/выключить удержание при переключении со вторичного соседа на осн… Варианты:
|
|
neighbor-hold-down-time integer |
Устарело, переименуйте в neighbor_hold_down_time. Время ожидания в секундах при переключении со вторичного соседа… |
|
service list / elements=dictionary |
Сервис. |
|
addr-mode string |
Устарело, переименуйте в addr_mode. Режим адресации Варианты:
|
|
bandwidth-weight integer |
Устарело, переименуйте в bandwidth_weight. Коэффициент обратной величины доступной двунаправленной пропускной спос… |
|
default string |
Включить/выключить использование SD-WAN в качестве сервиса по умолчанию. Варианты:
|
|
dscp-forward string |
Устарело, переименуйте в dscp_forward. Включить/выключить тег DSCP для переадресации трафика. Варианты:
|
|
dscp-forward-tag string |
Устарело, переименуйте в dscp_forward_tag. Тег DSCP для переадресации трафика. |
|
dscp-reverse string |
Устарело, переименуйте в dscp_reverse. Включить/выключить тег DSCP для обратного трафика. Варианты:
|
|
dscp-reverse-tag string |
Устарело, переименуйте в dscp_reverse_tag. Тег DSCP для обратного трафика. |
|
dst any |
(список или строка) Имя целевого адреса. |
|
dst-negate string |
Устарело, переименуйте в dst_negate. Включить/выключить отрицание соответствия целевого адреса. Варианты:
|
|
dst6 any |
(список или строка) Имя целевого адреса IPv6. |
|
end-port integer |
Устарело, переименуйте в end_port. Конечный номер порта назначения. |
|
gateway string |
Включить/выключить шлюз сервиса SD-WAN. Варианты:
|
|
groups any |
(список или строка) Группы пользователей. |
|
health-check string |
Устарело, переименуйте в health_check. Проверка состояния. |
|
hold-down-time integer |
Устарело, переименуйте в hold_down_time. Время ожидания в секундах при переключении с резервного члена t… |
|
id integer |
Приоритетный ID правила |
|
input-device any |
(список или строка) Устарело, переименуйте в input_device. Имя исходного интерфейса. |
|
input-device-negate string |
Устарело, переименуйте в input_device_negate. Включить/выключить отрицание соответствия входного устройства. Варианты:
|
|
internet-service string |
Устарело, переименуйте в internet_service. Включить/выключить использование интернет-сервиса для приложений на основе loa… Варианты:
|
|
internet-service-app-ctrl any |
(список) Устарело, переименуйте в internet_service_app_ctrl. Список ID интернет-сервисов на основе управления приложениями. |
|
internet-service-app-ctrl-group any |
(список или строка) Устарело, переименуйте в internet_service_app_ctrl_group. Интернет-сервис на основе управления приложениями … |
|
internet-service-ctrl any |
(список) Устарело, переименуйте в internet_service_ctrl. Список ID интернет-сервисов на основе управления. |
|
internet-service-ctrl-group any |
(список или строка) Устарело, переименуйте в internet_service_ctrl_group. Список групп интернет-сервисов на основе управления. |
|
internet-service-custom any |
(list or str) Устарело, переименуйте в internet_service_custom. Список имен пользовательских интернет-сервисов. |
|
internet-service-custom-group any |
(list or str) Устарело, переименуйте в internet_service_custom_group. Список групп пользовательских интернет-сервисов. |
|
internet-service-group any |
(list or str) Устарело, переименуйте в internet_service_group. Список групп интернет-сервисов. |
|
internet-service-id any |
(list or str) Устарело, переименуйте в internet_service_id. Список ID интернет-сервисов. |
|
internet-service-name string |
Устарело, переименуйте в internet_service_name. Список имен интернет-сервисов. |
|
jitter-weight integer |
Устарело, переименуйте в jitter_weight. Коэффициент джиттера в формуле custom-profile-1. |
|
latency-weight integer |
Устарело, переименуйте в latency_weight. Коэффициент задержки в формуле custom-profile-1. |
|
link-cost-factor string |
Устарело, переименуйте в link_cost_factor. Коэффициент стоимости канала. Варианты:
|
|
link-cost-threshold integer |
Устарело, переименуйте в link_cost_threshold. Процентный порог изменения значений стоимости канала, который будет… |
|
member string |
Порядковый номер участника. |
|
mode string |
Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN. Варианты:
|
|
name string |
Имя правила приоритета. |
|
packet-loss-weight integer |
Устарело, переименуйте в packet_loss_weight. Коэффициент потери пакетов в формуле custom-profile-1. |
|
priority-members any |
(list or str) Устарело, переименуйте в priority_members. Список порядковых номеров участников. |
|
protocol integer |
Номер протокола. |
|
quality-link integer |
Устарело, переименуйте в quality_link. Класс качества. |
|
role string |
Роль сервиса для работы с соседом. Варианты:
|
|
route-tag integer |
Устарело, переименуйте в route_tag. IPv4 метка маршрута карты маршрутов. |
|
sla list / elements=dictionary |
SLA. |
|
health-check string |
Устарело, переименуйте в health_check. Проверка работоспособности виртуального WAN-канала. |
|
id integer |
ID SLA. |
|
sla-compare-method string |
Устаревший параметр, пожалуйста, переименуйте его в sla_compare_method. Метод сравнения значения SLA для режима sla и балансировки нагрузки. Варианты:
|
|
src any |
(список или строка) Имя источника адреса. |
|
src-negate string |
Устаревший параметр, пожалуйста, переименуйте его в src_negate. Включить/выключить инвертирование соответствия источника адреса. Варианты:
|
|
src6 any |
(список или строка) Имя источника адреса 6. |
|
standalone-action string |
Устаревший параметр, пожалуйста, переименуйте его в standalone_action. Включить/выключить службу, когда выбранная роль соседа — автономная… Варианты:
|
|
start-port integer |
Устаревший параметр, пожалуйста, переименуйте его в start_port. Начальный номер порта назначения. |
|
status string |
Включить/выключить службу SD-WAN. Варианты:
|
|
tos string |
Битовое поле типа обслуживания. |
|
tos-mask string |
Устаревший параметр, пожалуйста, переименуйте его в tos_mask. Биты типа обслуживания, которые учитываются. |
|
users any |
(список или строка) Имя пользователя. |
|
status string |
Включить/выключить SD-WAN. Варианты:
|
workspace_locking_adom string | ADOM для блокировки в режиме работы в рабочей области FortiManager. Значение может быть глобальным и другими, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
Примеры
- 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: Configure redundant internet connections using SD-WAN
fortinet.fortimanager.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: <string>
addr_mode: <value in [ipv4, ipv6]>
failtime: <integer>
http_agent: <string>
http_get: <string>
http_match: <string>
interval: <integer>
members: <list or string>
name: <string>
packet_size: <integer>
password: <list or string>
port: <integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
recoverytime: <integer>
security_mode: <value in [none, authentication]>
server: <list or string>
sla:
-
id: <integer>
jitter_threshold: <integer>
latency_threshold: <integer>
link_cost_factor:
- latency
- jitter
- packet-loss
packetloss_threshold: <integer>
threshold_alert_jitter: <integer>
threshold_alert_latency: <integer>
threshold_alert_packetloss: <integer>
threshold_warning_jitter: <integer>
threshold_warning_latency: <integer>
threshold_warning_packetloss: <integer>
update_cascade_interface: <value in [disable, enable]>
update_static_route: <value in [disable, enable]>
internet_service_id: <string>
probe_packets: <value in [disable, enable]>
sla_fail_log_period: <integer>
sla_pass_log_period: <integer>
timeout: <integer>
ha_priority: <integer>
diffservcode: <string>
probe_timeout: <integer>
dns_request_domain: <string>
probe_count: <integer>
system_dns: <value in [disable, enable]>
load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
members:
-
_dynamic_member: <string>
comment: <string>
gateway: <string>
gateway6: <string>
ingress_spillover_threshold: <integer>
interface: <string>
priority: <integer>
seq_num: <integer>
source: <string>
source6: <string>
spillover_threshold: <integer>
status: <value in [disable, enable]>
volume_ratio: <integer>
weight: <integer>
cost: <integer>
service:
-
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>
id: <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]>
status: <value in [disable, enable]>
neighbor:
-
health_check: <string>
ip: <string>
member: <string>
role: <value in [primary, secondary, standalone]>
sla_id: <integer>
neighbor_hold_boot_time: <integer>
neighbor_hold_down: <value in [disable, enable]>
neighbor_hold_down_time: <integer>
fail_alert_interfaces: <list or string>
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборник
© 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_virtualwanlink_module.html