fortinet.fortimanager.fmgr_wanprof_system_sdwan_service модуль — Создание правил 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_service.
Новая функция в fortinet.fortimanager 2.1.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-кодов, при которых условия будут переопределены для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
wanprof строка / обязательно | Параметр (wanprof) в запрошенном URL. |
wanprof_system_sdwan_service словарь | Настройка параметров верхнего уровня. |
|
addr_mode строка |
Устаревшее, пожалуйста, переименуйте в addr_mode. Режим адресации Варианты:
|
|
agent_exclusive строка |
Устаревшее, пожалуйста, переименуйте в agent_exclusive. Установить/снять службу в качестве исключительного использования агента. Варианты:
|
|
bandwidth_weight целое |
Устаревшее, пожалуйста, переименуйте в bandwidth_weight. Коэффициент обратной величины доступной двунаправленной пропускной способности в ... |
|
comment строка |
Комментарии. |
|
default строка |
Включить/выключить использование SD-WAN в качестве службы по умолчанию. Варианты:
|
|
dscp_forward строка |
Устаревшее, пожалуйста, переименуйте в dscp_forward. Включить/выключить передачу тега DSCP трафика. Варианты:
|
|
dscp_forward_tag строка |
Устаревшее, пожалуйста, переименуйте в dscp_forward_tag. Тег DSCP передаваемого трафика. |
|
dscp_reverse строка |
Устаревшее, пожалуйста, переименуйте в dscp_reverse. Включить/выключить передачу тега DSCP обратного трафика. Варианты:
|
|
dscp_reverse_tag строка |
Устаревшее, пожалуйста, переименуйте в dscp_reverse_tag. Тег DSCP обратного трафика. |
|
dst any |
(list or str) Имя адреса назначения. |
|
dst-negate string |
Устарело, переименуйте в dst_negate. Включить/выключить отрицание соответствия адреса назначения. Choices:
|
|
dst6 any |
(list or str) Имя адреса назначения6. |
|
end-port integer |
Устарело, переименуйте в end_port. Конечный номер порта назначения. |
|
end-src-port integer |
Устарело, переименуйте в end_src_port. Конечный номер порта источника. |
|
gateway string |
Включить/выключить шлюз сервиса SD-WAN. Choices:
|
|
groups any |
(list or str) Группы пользователей. |
|
hash-mode string |
Устарело, переименуйте в hash_mode. Алгоритм хэширования для выбранных приоритетных участников в режиме балансировки нагрузки. Choices:
|
|
health-check any |
(list or str) Устарело, переименуйте в health_check. Список проверок работоспособности. |
|
hold-down-time integer |
Устарело, переименуйте в hold_down_time. Период ожидания в секундах при переключении с резервного участника на пр… |
|
id integer / required |
ID правила SD-WAN |
|
input-device any |
(list or str) Устарело, переименуйте в input_device. Имя исходного интерфейса. |
|
input-device-negate string |
Устарело, переименуйте в input_device_negate. Включить/выключить отрицание соответствия входного устройства. Choices:
|
|
input-zone any |
(list) Устарело, переименуйте в input_zone. Имя исходной входной зоны. |
|
internet-service string |
Устарело, переименуйте в internet_service. Включить/выключить использование интернет-сервиса для балансировки нагрузки на основе приложений. Choices:
|
|
internet-service-app-ctrl any |
(list) Устарело, переименуйте в internet_service_app_ctrl. Список ID интернет-сервиса на основе контроля приложений. |
|
internet-service-app-ctrl-category any |
(list) Устарело, переименуйте в internet_service_app_ctrl_category. ID одной или нескольких категорий контроля приложений. |
|
internet-service-app-ctrl-group any |
(list or str) Устарело, переименуйте в internet_service_app_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-name any |
(list or str) Устарело, переименуйте в 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. Коэффициент стоимости канала. Choices:
|
|
link-cost-threshold integer |
Устарело, переименуйте в link_cost_threshold. Процентный порог изменения значений стоимости канала, который приведет к p… |
|
load-balance string |
Устарело, переименуйте в load_balance. Включить/выключить балансировку нагрузки. Choices:
|
|
minimum-sla-meet-members integer |
Устарело, переименуйте в minimum_sla_meet_members. Минимальное количество участников, которые соответствуют SLA. |
|
mode string |
Управление тем, как правило SD-WAN устанавливает приоритет интерфейсов в SD-WAN. Choices:
|
|
name string |
Имя правила SD-WAN. |
|
packet-loss-weight integer |
Устарело, переименуйте в packet_loss_weight. Коэффициент потери пакетов в формуле custom-profile-1. |
|
passive-measurement string |
Устарело, переименуйте в passive_measurement. Включить/выключить пассивное измерение на основе критериев сервиса. Choices:
|
|
priority-members any |
(list or str) Устарело, переименуйте в priority_members. Список номеров последовательности участников. |
|
priority-zone any |
(list or str) Устарело, переименуйте в priority_zone. Список имен приоритетных зон. |
|
protocol integer |
Номер протокола. |
|
quality-link integer |
Устарело, переименуйте в quality_link. Класс качества. |
|
role string |
Роль сервиса для работы с соседом. Choices:
|
|
route-tag integer |
Устарело, переименуйте в route_tag. IPv4 route map route-tag. |
|
shortcut string |
Включить/выключить ярлык для этого сервиса. Choices:
|
|
shortcut-priority string |
Устарело, переименуйте в shortcut_priority. Высокий приоритет ярлыка ADVPN для этого сервиса. Choices:
|
|
shortcut-stickiness string |
Устарело, пожалуйста, переименуйте на shortcut_stickiness. Включить/выключить кратчайший путь-stickiness ADVPN. Варианты:
|
|
sla list / elements=dictionary |
SLA. |
|
health-check string |
Устарело, пожалуйста, переименуйте на health_check. SD-WAN проверка работоспособности. |
|
id integer |
ID SLA. |
|
sla-compare-method string |
Устарело, пожалуйста, переименуйте на sla_compare_method. Способ сравнения значения SLA для режима SLA. Варианты:
|
|
sla-stickiness string |
Устарело, пожалуйста, переименуйте на sla_stickiness. Включить/выключить SLA stickiness. Варианты:
|
|
src any |
(список или строка) Имя источника адреса. |
|
src-negate string |
Устарело, пожалуйста, переименуйте на src_negate. Включить/выключить инверсию совпадения адреса источника. Варианты:
|
|
src6 any |
(список или строка) Имя адреса источника6. |
|
standalone-action string |
Устарело, пожалуйста, переименуйте на standalone_action. Включить/выключить службу, когда выбранная роль соседа является автономной, в то время как … Варианты:
|
|
start-port integer |
Устарело, пожалуйста, переименуйте на start_port. Начальный номер порта назначения. |
|
start-src-port integer |
Устарело, пожалуйста, переименуйте на start_src_port. Начальный номер порта источника. |
|
status string |
Включить/выключить SD-WAN службу. Варианты:
|
|
tie-break string |
Устарело, пожалуйста, переименуйте на tie_break. Метод выбора участника, если несколько удовлетворяют SLA. Варианты:
|
|
tos string |
Тип шаблона бита сервиса. |
|
tos-mask string |
Устарело, пожалуйста, переименуйте на tos_mask. Биты типа сервиса, которые оцениваются. |
|
use-shortcut-sla string |
Устарело, пожалуйста, переименуйте на use_shortcut_sla. Включить/выключить использование ADVPN shortcut для сравнения качества. Варианты:
|
|
users any |
(список или строка) Имя пользователя. |
|
zone-mode string |
Устарело, пожалуйста, переименуйте на zone_mode. Включить/выключить режим зоны. Варианты:
|
workspace_locking_adom string | ADOM для блокировки при работе FortiManager в режиме рабочей области. Значение может быть глобальным и другими, включая корневой. |
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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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 rules
fortinet.fortimanager.fmgr_wanprof_system_sdwan_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: present # <value in [present, absent]>
wanprof_system_sdwan_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>
hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
health_check: <list or string>
hold_down_time: <integer>
id: <integer>
input_device: <list or string>
input_device_negate: <value in [disable, enable]>
internet_service: <value in [disable, enable]>
internet_service_app_ctrl: <list or integer>
internet_service_app_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_name: <list or string>
jitter_weight: <integer>
latency_weight: <integer>
link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
link_cost_threshold: <integer>
minimum_sla_meet_members: <integer>
mode: <value in [auto, manual, priority, ...]>
name: <string>
packet_loss_weight: <integer>
priority_members: <list or string>
protocol: <integer>
quality_link: <integer>
role: <value in [primary, secondary, standalone]>
route_tag: <integer>
sla:
-
health_check: <string>
id: <integer>
sla_compare_method: <value in [order, number]>
src: <list or string>
src_negate: <value in [disable, enable]>
src6: <list or string>
standalone_action: <value in [disable, enable]>
start_port: <integer>
status: <value in [disable, enable]>
tos: <string>
tos_mask: <string>
users: <list or string>
tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
use_shortcut_sla: <value in [disable, enable]>
input_zone: <list or string>
internet_service_app_ctrl_category: <list or integer>
passive_measurement: <value in [disable, enable]>
priority_zone: <list or string>
agent_exclusive: <value in [disable, enable]>
shortcut: <value in [disable, enable]>
shortcut_stickiness: <value in [disable, enable]>
end_src_port: <integer>
load_balance: <value in [disable, enable]>
sla_stickiness: <value in [disable, enable]>
start_src_port: <integer>
zone_mode: <value in [disable, enable]>
shortcut_priority: <value in [disable, enable, auto]>
comment: <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_sdwan_service_module.html