Модуль check_point.mgmt.cp_mgmt_log_exporter – управление объектами экспорта журналов на Check Point через API веб-служб
Примечание
Этот модуль входит в коллекцию check_point.mgmt (версия 6.9.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install check_point.mgmt.
Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_log_exporter.
Добавлено в check_point.mgmt 6.5.0
Краткое описание
- Управляет объектами экспорта журналов на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
- Доступно начиная с версии управления R82 JHF.
Параметры
Параметр | Комментарии |
|---|---|
attachments dictionary | Вложения экспортера журналов. |
|
add_link_to_log_attachment boolean |
Указывает, следует ли добавлять ссылку на вложение журнала в SmartView. Варианты:
|
|
add_link_to_log_details boolean |
Указывает, следует ли добавлять ссылку на подробные сведения о журнале в SmartView. Варианты:
|
|
add_log_attachment_id boolean |
Указывает, следует ли добавлять идентификатор вложения журнала. Варианты:
|
auto_publish_session boolean | Опубликовать текущий сеанс после завершения задачи, если в нём были внесены изменения. Варианты:
|
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментария. |
data_manipulation dictionary | Обработка данных экспортера журналов. |
|
aggregate_log_updates boolean |
Указывает, следует ли агрегировать обновления журналов. Варианты:
|
|
format string |
Формат журналов. Варианты:
|
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
domains_to_process list / элементы=string | Указывает, в каких доменах выполнять команды. Параметр нельзя использовать с уровнем детализации full; его можно запускать только из системного домена и при значении ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. |
enabled boolean | Указывает, включён ли экспорт. Варианты:
|
ignore_errors boolean | Применять изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применять изменения, игнорируя предупреждения. Варианты:
|
name string / обязательный | Имя объекта. |
protocol string | Протокол, используемый для отправки журналов на целевой сервер. Варианты:
|
state string | Состояние правила доступа (present или absent). Варианты:
|
tags list / элементы=string | Список идентификаторов тегов. |
target_port integer | Номер порта целевого сервера. |
target_server string | Порт целевого сервера, на который экспортируются журналы. |
version string | Версия Check Point. Если не указана, используется последняя версия. |
wait_for_task boolean | Ожидать завершения задачи, например задачи публикации. Варианты:
|
wait_for_task_timeout integer | Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: |
Примеры
- name: add-log-exporter
cp_mgmt_log_exporter:
attachments:
add_link_to_log_attachment: true
name: newLogExporter
protocol: tcp
state: present
target_port: 1234
target_server: 1.2.3.4
- name: set-log-exporter
cp_mgmt_log_exporter:
data_manipulation:
format: json
name: newLogExporter
state: present
target_port: 999
- name: delete-log-exporter
cp_mgmt_log_exporter:
name: newLogExporter
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_log_exporter dictionary | Созданный или обновлённый объект Check Point. Возвращается: всегда, кроме случаев удаления объекта. |
Ссылки на коллекцию
© 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/check_point/mgmt/cp_mgmt_log_exporter_module.html