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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_logfetch_clientprofile.

Новое в fortinet.fortimanager 2.0.0

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Выбор: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включение/выключение ведения журнала для задачи. Выбор: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Выбор: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия успешного завершения.
state строка / обязательно	Направление для создания, обновления или удаления объекта. Выбор: `"present"` `"absent"`
system_logfetch_clientprofile словарь	Настройка параметров верхнего уровня.
client-adom строка	Устарело, пожалуйста, переименуйте на client_adom. Имя домена стороны клиента для получения логов.
data-range строка	Устарело, пожалуйста, переименуйте на data_range. Диапазон дат для полученных логов. custom - Укажите другой диапазон дат и времени. Выбор: `"custom"`
data-range-value целое число	Устарело, пожалуйста, переименуйте на data_range_value. Последние n дней или часов.
device-filter список / элементы=словарь	Устарело, пожалуйста, переименуйте на device_filter. Фильтр устройств.
adom строка	Имя домена.
device строка	Имя устройства или серийный номер.
id целое число	Добавление или редактирование фильтра устройств.
vdom строка	Фильтры vdom.
end-time любой	(список) Устарело, пожалуйста, переименуйте на end_time. Конечная дата и время диапазона дат.
id целое число / обязательно	ID профиля клиента для получения логов.
index-fetch-logs строка	Устарело, пожалуйста, переименуйте на index_fetch_logs. Включение/выключение автоматического индексирования логов после получения логов. disable - Отключить функцию атрибута. enable - Включить функцию атрибута. Выбор: `"disable"` `"enable"`
log-filter список / элементы=словарь	Устарело, пожалуйста, переименуйте на log_filter. Фильтр логов.

END_OF_DOCUMENT_MARKER

field string	Имя поля.
id integer	ID фильтра логов.
oper string	Оператор фильтра поля. Нет описания Нет описания содержит - Содержит не содержит - Не содержит совпадает - Совпадает Выбор: `"="` `"!="` `"<"` `">"` `"<="` `">="` `"contain"` `"not-contain"` `"match"`
value string	Операнд фильтра поля или выражение для поиска по свободному тексту.
log-filter-logic string	Устарело, пожалуйста, переименуйте его в log_filter_logic. Логика И/ИЛИ для фильтров логов. и - Логика И. или - Логика ИЛИ. Выбор: `"and"` `"or"`
log-filter-status string	Устарело, пожалуйста, переименуйте его в log_filter_status. Включить/выключить фильтр логов. выключено - Выключить функцию атрибута. включено - Включить функцию атрибута. Выбор: `"disable"` `"enable"`
name string	Имя профиля клиента для получения логов.
password any	(список) Пароль для входа на сервер получения логов.
peer-cert-cn string	Устарело, пожалуйста, переименуйте его в peer_cert_cn. Имя общего сертификата сервера получения логов.
secure-connection string	Устарело, пожалуйста, переименуйте его в secure_connection. Включить/выключить защиту соединения для получения логов с помощью TLS/SSL. выключено - Выключить функцию атрибута. включено - Включить функцию атрибута. Выбор: `"disable"` `"enable"`
server-adom string	Устарело, пожалуйста, переименуйте его в server_adom. Имя домена сторон сервера получения логов.
server-ip string	Устарело, пожалуйста, переименуйте его в server_ip. IP-адрес сервера получения логов.
start-time any	(список) Устарело, пожалуйста, переименуйте его в start_time. Дата и время начала диапазона данных
sync-adom-config string	Устарело, пожалуйста, переименуйте его в sync_adom_config. Включить/выключить синхронизацию конфигурации связанных домена. выключено - Выключить функцию атрибута. включено - Включить функцию атрибута. Выбор: `"disable"` `"enable"`
user string	Имя пользователя для входа на сервер получения логов.
workspace_locking_adom string	Домен, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют обозначение с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в выполнении этой задачи.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Log-fetch client profile settings.
      fortinet.fortimanager.fmgr_system_logfetch_clientprofile:
        bypass_validation: false
        state: present
        system_logfetch_clientprofile:
          client-adom: ansible
          data-range: custom # <value in [custom]>
          id: 1
          index-fetch-logs: enable
          name: ansible-test-clientprofile
          password: fortinet
          server-ip: "222.222.22.25"
          user: ansible

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the Log-fetch client profile settings
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_logfetch_clientprofile"
          params:
            client-profile: "your_value"

Значения возврата

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_logfetch_clientprofile_module.html