Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_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_sdwan_service.

Добавлено в fortinet.fortimanager 2.1.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_sdwan_service

dictionary

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

addr_mode

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

string

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

Варианты:

  • "ipv4"
  • "ipv6"

agent_exclusive

псевдонимы: agent-exclusive

string

Назначить или отменить исключительное использование службы агентом.

Варианты:

  • "disable"
  • "enable"

bandwidth_weight

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

integer

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

comment

string

Комментарии.

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

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

end_src_port

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

integer

Конечный номер порта источника.

fib_best_match_force

псевдонимы: fib-best-match-force

string

Включить/отключить принудительное использование fib-best-match oif в качестве исходящего интерфейса.

Варианты:

  • "disable"
  • "enable"

gateway

string

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

Варианты:

  • "disable"
  • "enable"

groups

any

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

hash_mode

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

string

Алгоритм хеширования для выбранных участников с заданным приоритетом в режиме балансировки нагрузки.

Варианты:

  • "round-robin"
  • "source-ip-based"
  • "source-dest-ip-based"
  • "inbandwidth"
  • "outbandwidth"
  • "bibandwidth"

health_check

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

any

(список или строка) Список проверок работоспособности.

hold_down_time

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

integer

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

id

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

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

input_device

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

any

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

input_device_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

input_zone

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

any

(список) Имя исходной зоны ввода.

internet_service

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

string

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

Варианты:

  • "disable"
  • "enable"

internet_service_app_ctrl

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

any

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

internet_service_app_ctrl_category

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

any

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

internet_service_app_ctrl_group

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

any

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

internet_service_custom

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

any

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

internet_service_custom_group

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

any

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

internet_service_fortiguard

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

any

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

internet_service_group

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

any

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

internet_service_name

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

any

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

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

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

load_balance

псевдонимы: load-balance

string

Включить/отключить балансировку нагрузки.

Варианты:

  • "disable"
  • "enable"

minimum_sla_meet_members

псевдонимы: minimum-sla-meet-members

integer

Минимальное количество участников, соответствующих SLA.

mode

string

Управление приоритетом интерфейсов в SD-WAN, задаваемым правилом SD-WAN.

Варианты:

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

name

string

Имя правила SD-WAN.

packet_loss_weight

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

integer

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

passive_measurement

псевдонимы: passive-measurement

string

Включение или отключение пассивного измерения на основе критериев службы.

Варианты:

  • "disable"
  • "enable"

priority_members

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

any

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

priority_zone

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

any

(список или строка) Список имен зон приоритета.

protocol

integer

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

quality_link

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

integer

Оценка качества.

role

string

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

Варианты:

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

route_tag

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

integer

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

shortcut

string

Включение или отключение shortcut для этой службы.

Варианты:

  • "disable"
  • "enable"

shortcut_priority

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

string

Высокий приоритет shortcut ADVPN для этой службы.

Варианты:

  • "disable"
  • "enable"
  • "auto"

shortcut_stickiness

псевдонимы: shortcut-stickiness

string

Включение или отключение закрепления shortcut ADVPN.

Варианты:

  • "disable"
  • "enable"

sla

list / elements=dictionary

SLA.

health_check

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

string

Проверка состояния SD-WAN.

id

integer

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

sla_compare_method

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

string

Метод сравнения значения SLA в режиме SLA.

Варианты:

  • "order"
  • "number"

sla_stickiness

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

string

Включение или отключение закрепления SLA.

Варианты:

  • "disable"
  • "enable"

src

any

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

src6

any

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

src_negate

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

string

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

Варианты:

  • "disable"
  • "enable"

standalone_action

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

string

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

Варианты:

  • "disable"
  • "enable"

start_port

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

integer

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

start_src_port

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

integer

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

status

string

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

Варианты:

  • "disable"
  • "enable"

tie_break

псевдонимы: tie-break

string

Метод выбора участника, если требованиям SLA соответствуют несколько участников.

Варианты:

  • "zone"
  • "cfg-order"
  • "fib-best-match"
  • "input-device"
  • "priority"

tos

string

Битовая маска типа обслуживания.

tos_mask

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

string

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

use_shortcut_sla

псевдонимы: use-shortcut-sla

string

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

Варианты:

  • "disable"
  • "enable"

users

any

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

zone_mode

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

string

Включение или отключение режима зон.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие ADOM, включая root.

workspace_locking_timeout

integer

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

По умолчанию: 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
      fortinet.fortimanager.fmgr_wanprof_system_sdwan_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_sdwan_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>
          # hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
          # health_check: <list or string>
          # hold_down_time: <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>
          # fib_best_match_force: <value in [disable, enable]>
          # internet_service_fortiguard: <list or string>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией 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_sdwan_service_module.html

Spec-Zone.ru

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