fortinet.fortimanager.fmgr_log_customfield – Настройка пользовательских полей логов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_log_customfield.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |
| log_customfield словарь | настройка параметров верхнего уровня | ||
| id строка | идентификатор поля <строка>. | ||
| name строка | Имя поля (максимум 15 символов). | ||
| value строка | Значение поля (максимум 15 символов). | ||
| 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: Configure custom log fields.
fmgr_log_customfield:
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>
state: <value in [present, absent]>
log_customfield:
id: <value of string>
name: <value of string>
value: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, ниже представлены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_log_customfield_module.html
