fortinet.fortimanager.fmgr_system_admin_user_metadata – Настройка метаданных.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_system_admin_user_metadata.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение будет остановлено | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение будет успешно завершено | ||
| state строка / обязательный |
| Директива для создания, обновления или удаления объекта | |
| system_admin_user_metadata словарь | Параметры верхнего уровня | ||
| fieldlength целое число | Значение по умолчанию: 0 | Длина поля. | |
| fieldname строка | Имя поля. | ||
| fieldvalue строка | Значение поля. | ||
| importance строка |
| Важность. необязательный - Это поле необязательно. обязательный - Это поле обязательно. | |
| status строка |
| Статус. disabled - Это поле отключено. enabled - Это поле включено. | |
| user строка / обязательный | Параметр (user) в запрошенном URL | ||
| workspace_locking_adom строка | Область, которую следует заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая 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 meta data.
fmgr_system_admin_user_metadata:
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, ...]
user: <your own value>
state: <value in [present, absent]>
system_admin_user_metadata:
fieldlength: <value of integer>
fieldname: <value of string>
fieldvalue: <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_admin_user_metadata_module.html
