Модуль fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_service – Создание правил SD-WAN или правил приоритета

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Добавлена в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только в случае расхождений схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия неудачи.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
wanprof строка / обязательно	Параметр (wanprof) в запрошенном URL.
wanprof_system_virtualwanlink_service словарь	Настройки верхнего уровня.
addr_mode строка	Устарело, пожалуйста, переименуйте на addr_mode. Режим адреса. Варианты: `"ipv4"` `"ipv6"`
bandwidth_weight целое число	Устарело, пожалуйста, переименуйте на bandwidth_weight. Коэффициент обратной величины доступной двунаправленной полосы пропускания в ...
default строка	Включить/выключить использование SD-WAN в качестве службы по умолчанию. Варианты: `"disable"` `"enable"`
dscp_forward строка	Устарело, пожалуйста, переименуйте на dscp_forward. Включить/выключить передачу тега DSCP. Варианты: `"disable"` `"enable"`
dscp_forward_tag строка	Устарело, пожалуйста, переименуйте на dscp_forward_tag. Тег DSCP для передачи.
dscp_reverse строка	Устарело, пожалуйста, переименуйте на dscp_reverse. Включить/выключить передачу тега DSCP для обратного трафика. Варианты: `"disable"` `"enable"`
dscp_reverse_tag строка	Устарело, пожалуйста, переименуйте на dscp_reverse_tag. Тег DSCP для обратного трафика.
dst любой	(список или строка) Название адреса назначения.

END_OF_DOCUMENT_MARKER

dst-negate string	Устарело, переименуйте в dst_negate. Включить/выключить отрицание соответствия адреса назначения. Choices: `"disable"` `"enable"`
dst6 any	(list or str) Имя адреса назначения6.
end-port integer	Устарело, переименуйте в end_port. Конечный номер порта назначения.
gateway string	Включить/выключить шлюз сервиса SD-WAN. Choices: `"disable"` `"enable"`
groups any	(list or str) Группы пользователей.
health-check string	Устарело, переименуйте в health_check. Проверка работоспособности.
hold-down-time integer	Устарело, переименуйте в hold_down_time. Период ожидания в секундах при переключении с резервного участника на осн…
id integer / required	ID правила приоритета
input-device any	(list or str) Устарело, переименуйте в input_device. Имя исходного интерфейса.
input-device-negate string	Устарело, переименуйте в input_device_negate. Включить/выключить отрицание соответствия входного устройства. Choices: `"disable"` `"enable"`
internet-service string	Устарело, переименуйте в internet_service. Включить/выключить использование интернет-сервиса для балансировки нагрузки на основе приложений. Choices: `"disable"` `"enable"`
internet-service-app-ctrl any	(list) Устарело, переименуйте в internet_service_app_ctrl. Список ID интернет-сервиса на основе управления приложениями.
internet-service-app-ctrl-group any	(list or str) Устарело, переименуйте в internet_service_app_ctrl_group. Список групп интернет-сервиса на основе управления приложениями…
internet-service-ctrl any	(list) Устарело, переименуйте в internet_service_ctrl. Список ID интернет-сервиса на основе управления.
internet-service-ctrl-group any	(list or str) Устарело, переименуйте в 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. Коэффициент стоимости канала. Варианты: `"latency"` `"jitter"` `"packet-loss"` `"inbandwidth"` `"outbandwidth"` `"bibandwidth"` `"custom-profile-1"`
link-cost-threshold integer	Устарело, переименуйте в link_cost_threshold. Процентный порог изменения значений стоимости канала, который приведет к…
member string	Номер последовательности члена.
mode string	Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN. Варианты: `"auto"` `"manual"` `"priority"` `"sla"` `"load-balance"`
name string	Имя правила приоритета.
packet-loss-weight integer	Устарело, переименуйте в packet_loss_weight. Коэффициент потери пакетов в формуле custom-profile-1.
priority-members any	(список или строка) Устарело, переименуйте в priority_members. Список номеров последовательности членов.
protocol integer	Номер протокола.
quality-link integer	Устарело, переименуйте в quality_link. Класс качества.
role string	Роль сервиса для работы с соседом. Варианты: `"primary"` `"secondary"` `"standalone"`
route-tag integer	Устарело, переименуйте в route_tag. IPv4 карта маршрутов route-tag.
sla list / elements=dictionary	SLA.
health-check string	Устарело, переименуйте в health_check. Проверка работоспособности виртуального WAN-канала.
id integer	ИД SLA.
sla-compare-method string	Устарело, переименуйте в sla_compare_method. Метод сравнения значения SLA для режима sla и балансировки нагрузки. Варианты: `"order"` `"number"`
src any	(список или строка) Имя исходного адреса.
src-negate string	Устарело, переименуйте в src_negate. Включить/выключить отрицание соответствия исходного адреса. Варианты: `"disable"` `"enable"`
src6 any	(список или строка) Имя исходного адреса6.

standalone-action string	Устаревшее, переименуйте на standalone_action. Включить/отключить службу, когда выбранная роль соседа является автономной, в то время как … Варианты: `"disable"` `"enable"`
start-port integer	Устаревшее, переименуйте на start_port. Номер начального порта назначения.
status string	Включить/отключить службу SD-WAN. Варианты: `"disable"` `"enable"`
tos string	Шаблон бита типа обслуживания.
tos-mask string	Устаревшее, переименуйте на tos_mask. Биты типа обслуживания для оценки.
users any	(список или строка) Имя пользователя.
workspace_locking_adom string	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве, значение может быть глобальным и другими, включая 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 помогают в этой работе.
Для создания или обновления объекта используйте директиву 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 or priority rules
      fortinet.fortimanager.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: present # <value in [present, absent]>
        wanprof_system_virtualwanlink_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]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–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_service_module.html