fortinet.fortimanager.fmgr_system_logfetch_clientprofile – Настройки профиля клиента для извлечения логов.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_logfetch_clientprofile.

Новое в версии 2.10: fortinet.fortimanager

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: no ← yes	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
rc_failed list / elements=string				список rc-кодов, при которых условия будут нарушены
rc_succeeded list / elements=string				список rc-кодов, при которых условия будут выполнены
state string / required			Варианты: present absent	инструкция по созданию, обновлению или удалению объекта
system_logfetch_clientprofile dictionary				настройка верхнего уровня
	client-adom string			Имя adom клиента для извлечения логов.
	data-range string		Варианты: custom ←	Диапазон данных для извлечённых логов. custom - Укажите другой диапазон дат и времени.
	data-range-value integer		По умолчанию: 10	Последние n дней или часов.
	device-filter list / elements=string			без описания
		adom string	По умолчанию: "*"	Имя adom.
		device string	По умолчанию: "*"	Имя устройства или серийный номер.
		id integer	По умолчанию: 0	Добавить или изменить фильтр устройств.
		vdom string	По умолчанию: "*"	Фильтры Vdom.
	end-time string			без описания
	id integer		По умолчанию: 0	Идентификатор профиля клиента для извлечения логов.
	index-fetch-logs string		Варианты: disable enable ←	Включить/выключить автоматическое индексирование логов после извлечения логов. disable - Выключить функцию атрибута. enable - Включить функцию атрибута.
	log-filter list / elements=string			без описания
		field string		Имя поля.
		id integer	По умолчанию: 0	Идентификатор фильтра логов.
		oper string	Варианты: = ← != < > <= >= contain not-contain match	Оператор фильтра поля. < - <= Меньше или равно > - >= Больше или равно contain - Содержит not-contain - Не содержит match - Соответствие (выражение)
		value string		Операнд фильтра поля или выражение для поиска по свободному тексту.
	log-filter-logic string		Варианты: and or ←	Логика AND/OR для фильтров логов. and - Логическое И. or - Логическое ИЛИ.
	log-filter-status string		Варианты: disable ← enable	Включить/выключить фильтр логов. disable - Выключить функцию атрибута. enable - Включить функцию атрибута.
	name string			Имя профиля клиента для извлечения логов.
	password string			без описания
	secure-connection string		Варианты: disable enable ←	Включить/выключить защиту соединения для извлечения логов с помощью TLS/SSL. disable - Выключить функцию атрибута. enable - Включить функцию атрибута.
	server-adom string			Имя adom сервера для извлечения логов.
	server-ip string		По умолчанию: "0.0.0.0"	IP-адрес сервера для извлечения логов.
	start-time string			без описания
	sync-adom-config string		Варианты: disable ← enable	Включить/выключить синхронизацию конфигурации adom. disable - Выключить функцию атрибута. enable - Включить функцию атрибута.
	user string			Имя пользователя для входа на сервер для извлечения логов.
workspace_locking_adom string				adom для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer			По умолчанию: 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: Log-fetch client profile settings.
     fmgr_system_logfetch_clientprofile:
        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_logfetch_clientprofile:
           client-adom: <value of string>
           data-range: <value in [custom]>
           data-range-value: <value of integer>
           device-filter:
             -
                 adom: <value of string>
                 device: <value of string>
                 id: <value of integer>
                 vdom: <value of string>
           end-time: <value of string>
           id: <value of integer>
           index-fetch-logs: <value in [disable, enable]>
           log-filter:
             -
                 field: <value of string>
                 id: <value of integer>
                 oper: <value in [=, !=, <, ...]>
                 value: <value of string>
           log-filter-logic: <value in [and, or]>
           log-filter-status: <value in [disable, enable]>
           name: <value of string>
           password: <value of string>
           secure-connection: <value in [disable, enable]>
           server-adom: <value of string>
           server-ip: <value of string>
           start-time: <value of string>
           sync-adom-config: <value in [disable, enable]>
           user: <value of string>

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Описание сообщения ответа 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_logfetch_clientprofile_module.html