fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields – Настраиваемые поля datamask.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_admin_profile_datamaskcustomfields.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливать в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| profile строка / обязательно | параметр (profile) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых выполнение будет прервано | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых выполнение будет завершено успешно | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| system_admin_profile_datamaskcustomfields словарь | настройка параметров верхнего уровня | ||
| field-category список / элементы=строка |
| нет описания | |
| field-name строка | Имя поля. | ||
| field-status строка |
| Статус поля. disable - Отключить поле. enable - Включить поле. | |
| field-type строка |
| Тип поля. строка - Строка. ip - IP. mac - MAC-адрес. email - Электронный адрес. unknown - Неизвестно. | |
| 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: Customized datamask fields.
fmgr_system_admin_profile_datamaskcustomfields:
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, ...]
profile: <your own value>
state: <value in [present, absent]>
system_admin_profile_datamaskcustomfields:
field-category:
- log
- fortiview
- alert
- ueba
- all
field-name: <value of string>
field-status: <value in [disable, enable]>
field-type: <value in [string, ip, mac, ...]>
Значения возврата
Общие значения возврата описаны в документации, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_profile_datamaskcustomfields_module.html
