fortinet.fortimanager.fmgr_system_metadata_admins – Настройка администраторов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_metadata_admins.
Добавлена в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для данных источников перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в значение True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение будет завершено с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение будет завершено успешно | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| system_metadata_admins словарь | параметры верхнего уровня | ||
| fieldlength строка |
| Длина поля. 20 - Длина поля 20. 50 - Длина поля 50. 255 - Длина поля 255. | |
| fieldname строка | Имя поля. | ||
| importance строка |
| Важность поля. optional - Это необязательное поле. required - Это обязательное поле. | |
| status строка |
| Статус поля. disabled - Это поле отключено. enabled - Это поле включено. | |
| workspace_locking_adom строка | область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть global и другими, включая root | ||
| 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 admins.
fmgr_system_metadata_admins:
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, ...]
state: <value in [present, absent]>
system_metadata_admins:
fieldlength: <value in [20, 50, 255]>
fieldname: <value of string>
importance: <value in [optional, required]>
status: <value in [disabled, enabled]>
Возвращаемые значения
Общие значения возврата описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_system_metadata_admins_module.html
