Модуль fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members – Физические интерфейсы FortiGate, добавленные к виртуальному 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_members.

Новая функция в 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_members словарь	Настройка параметров верхнего уровня.
_dynamic-member строка	Устарело, пожалуйста, переименуйте на _dynamic_member. Динамический член.
comment строка	Комментарии.
cost целое число	Стоимость этого интерфейса для служб в режиме SLA.
gateway строка	Шлюз по умолчанию для этого интерфейса.
gateway6 строка	IPv6 шлюз.
ingress_spillover_threshold целое число	Порог переполнения входящих данных для данного интерфейса.
interface строка	Имя интерфейса.
priority целое число	Приоритет интерфейса.
seq_num целое число / обязательно	Порядковый номер.
source строка	IP-адрес источника, используемый в пакетах проверки работоспособности сервера.
source6 строка	IPv6-адрес источника, используемый в пакетах проверки работоспособности сервера.

END_OF_DOCUMENT_MARKER

spillover-threshold целое число	Устаревшее, пожалуйста, переименуйте на spillover_threshold. Пороговое значение переполнения для исходящего трафика этого интерфейса
status строка	Включить/выключить этот интерфейс в SD-WAN. Выбор: `"disable"` `"enable"`
volume-ratio целое число	Устаревшее, пожалуйста, переименуйте на volume_ratio. Измеренное соотношение объёмов
weight целое число	Вес этого интерфейса для взвешенного балансирования нагрузки.
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным или другим, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `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: Physical FortiGate interfaces added to the virtual-wan-link.
      fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members:
        # 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_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>

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

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

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