fortinet.fortimanager.fmgr_dvmdb_metafields_device – нет описания
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_metafields_device.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| установить в значение True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжит выполнение без проверки параметров | |
| dvmdb_metafields_device словарь | установленные параметры верхнего уровня | ||
| importance строка |
| нет описания | |
| length целое число | нет описания | ||
| name строка | нет описания | ||
| status строка |
| нет описания | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут игнорироваться условия завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут игнорироваться условия успешного завершения | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| 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: no description
fmgr_dvmdb_metafields_device:
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, ...]
dvmdb_metafields_device:
importance: <value in [optional, required]>
length: <value of integer>
name: <value of string>
status: <value in [disable, enable]>
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_dvmdb_metafields_device_module.html
