Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

system_logfetch_clientprofile

dictionary

Набор параметров верхнего уровня.

client_adom

псевдонимы: client-adom

string

Имя ADOM на стороне клиента получения журналов.

data_range

псевдонимы: data-range

string

Диапазон данных для полученных журналов.

custom — указать другой диапазон даты и времени.

Варианты:

  • "custom"

data_range_value

псевдонимы: data-range-value

integer

Последние n дней или часов.

device_filter

псевдонимы: device-filter

list / elements=dictionary

Фильтр устройств.

adom

string

Имя ADOM.

device

string

Имя устройства или серийный номер.

id

integer

Добавить или изменить фильтр устройства.

vdom

string

Фильтры VDOM.

end_time

псевдонимы: end-time

any

(список) Дата и время окончания диапазона данных

id

integer / обязательный

Идентификатор профиля клиента получения журналов.

index_fetch_logs

псевдонимы: index-fetch-logs

string

Включить или отключить автоматическую индексацию журналов после их получения.

disable — отключить функцию атрибута.

enable — включить функцию атрибута.

Варианты:

  • "disable"
  • "enable"

log_filter

псевдонимы: log-filter

list / elements=dictionary

Фильтр журналов.

field

string

Имя поля.

id

integer

Идентификатор фильтра журналов.

oper

string

Оператор фильтрации поля.

описание отсутствует

описание отсутствует

contain — содержит

not-contain — не содержит

match — соответствует

Варианты:

  • "="
  • "!="
  • "<"
  • ">"
  • "<="
  • ">="
  • "contain"
  • "not-contain"
  • "match"

value

string

Операнд фильтрации поля или выражение для поиска по произвольному тексту.

log_filter_logic

псевдонимы: log-filter-logic

string

Логика And/Or для фильтров журналов.

and — логическое И.

or — логическое ИЛИ.

Варианты:

  • "and"
  • "or"

log_filter_status

псевдонимы: log-filter-status

string

Включить или отключить фильтр журналов.

disable — отключить функцию атрибута.

enable — включить функцию атрибута.

Варианты:

  • "disable"
  • "enable"

name

string

Имя профиля клиента получения журналов.

password

any

(список) Пароль для входа на сервер получения журналов.

peer_cert_cn

псевдонимы: peer-cert-cn

string

Общее имя сертификата сервера получения журналов.

secure_connection

псевдонимы: secure-connection

string

Включить или отключить защиту соединения для получения журналов с помощью TLS/SSL.

disable — отключить функцию атрибута.

enable — включить функцию атрибута.

Варианты:

  • "disable"
  • "enable"

server_adom

псевдонимы: server-adom

string

Имя ADOM на стороне сервера получения журналов.

server_ip

псевдонимы: server-ip

string

IP-адрес сервера получения журналов.

start_time

псевдонимы: start-time

any

(список) Дата и время начала диапазона данных

sync_adom_config

псевдонимы: sync-adom-config

string

Включить или отключить синхронизацию конфигурации, связанной с ADOM.

disable — отключить функцию атрибута.

enable — включить функцию атрибута.

Варианты:

  • "disable"
  • "enable"

user

string

Имя пользователя для входа на сервер получения журналов.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие ADOM, включая 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 позволяют выполнять эту задачу.
  • Обычно выполнение модуля завершается с ошибкой, если возвращается ненулевой код rc. Условия сбоя или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  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

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Текстовое описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_system_logfetch_clientprofile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API