fortinet.fortimanager.fmgr_wtpprofile_platform – Платформа WTP, FortiAP или AP.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_wtpprofile_platform
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логический тип |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия завершения работы по неудаче будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия завершения работы по успеху будут переопределены | ||
| state строка / обязательно |
| указание на создание, обновление или удаление объекта | |
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корневой | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время ожидания в секундах, пока другой пользователь не освободит блокировку рабочей области | |
| wtp-profile строка / обязательно | параметр (wtp-profile) в запрошенном URL | ||
| wtpprofile_platform словарь | настроены параметры верхнего уровня | ||
| type строка |
| Тип платформы WTP, FortiAP или AP. Для всех поддерживаемых моделей FortiAP существуют встроенные профили WTP. Вы можете выбрать встроенный … | |
Примечания
Примечание
- Поддерживается работа в режиме блокировки рабочей области в этом модуле 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: WTP, FortiAP, or AP platform.
fmgr_wtpprofile_platform:
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>
wtp-profile: <your own value>
wtpprofile_platform:
type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_wtpprofile_platform_module.html