fortinet.fortimanager.fmgr_wanopt_peer — Настройка узлов оптимизации WAN.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_wanopt_peer.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить, прежде чем использовать их из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, по которым условия завершения с ошибкой будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, по которым условия успешного завершения будут переопределены | ||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | |
| wanopt_peer словарь | установленные параметры верхнего уровня | ||
| ip строка | IP-адрес узла. | ||
| peer-host-id строка | Идентификатор узла-партнёра. | ||
| 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: Configure WAN optimization peers.
fmgr_wanopt_peer:
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>
state: <value in [present, absent]>
wanopt_peer:
ip: <value of string>
peer-host-id: <value of string>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_wanopt_peer_module.html
