fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members – Физические интерфейсы FortiGate, добавленные в виртуальный канал WAN.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink_members.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, с которыми условия завершения работы будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми условия успешного завершения работы будут переопределены | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| wanprof строка / обязательно | параметр (wanprof) в запрошенном URL | ||
| wanprof_system_virtualwanlink_members словарь | установленные параметры верхнего уровня | ||
| _dynamic-member строка | нет описания | ||
| comment строка | Комментарии. | ||
| gateway строка | Основной шлюз для этого интерфейса. Обычно основной шлюз интернет-провайдера, к которому подключен этот интерфейс... | ||
| gateway6 строка | Шлюз IPv6. | ||
| ingress-spillover-threshold целое число | Пороговое значение переполнения входного трафика для этого интерфейса (0 – 16776000 кбит/с). Когда этот объем трафика дости... | ||
| interface строка | Имя интерфейса. | ||
| priority целое число | Приоритет интерфейса (0 – 4294967295). Используется для правил SD-WAN или правил приоритета. | ||
| seq-num целое число | Номер последовательности (1–255). | ||
| source строка | Используемый IP-адрес источника в пакетах проверки работоспособности сервера. | ||
| source6 строка | Используемый IPv6-адрес источника в пакетах проверки работоспособности сервера. | ||
| spillover-threshold целое число | Пороговое значение переполнения выходного трафика для этого интерфейса (0 – 16776000 кбит/с). Когда этот объем трафика ... | ||
| status строка |
| Включить/выключить этот интерфейс в SD-WAN. | |
| volume-ratio целое число | Измеренное отношение объемов (это значение / сумма всех значений = процент объема канала, 0 – 255). | ||
| weight целое число | Вес этого интерфейса для взвешенного балансирования нагрузки (0 – 255). Больше трафика направляется на интерфейсы с более высокими весами. | ||
| workspace_locking_adom строка | адрес домена (adom) для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой. | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- В нормальном режиме выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Также можно переопределить условия завершения работы с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
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.
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: <value in [present, absent]>
wanprof_system_virtualwanlink_members:
_dynamic-member: <value of string>
comment: <value of string>
gateway: <value of string>
gateway6: <value of string>
ingress-spillover-threshold: <value of integer>
interface: <value of string>
priority: <value of integer>
seq-num: <value of integer>
source: <value of string>
source6: <value of string>
spillover-threshold: <value of integer>
status: <value in [disable, enable]>
volume-ratio: <value of integer>
weight: <value of integer>
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_wanprof_system_virtualwanlink_members_module.html
