модуль check_point.mgmt.cp_mgmt_smart_task — управление объектами SmartTask на Checkpoint через 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_smart_task.

Добавлено в check_point.mgmt 5.0.0

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

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

Управляет объектами SmartTask на устройствах Checkpoint, включая создание, обновление и удаление объектов.
Все операции выполняются через API веб-служб.
Доступно начиная с версии системы управления R80.40.

Параметры

Параметр	Описание
action dictionary	Действие, которое будет выполнено при срабатывании триггера.
run_script dictionary	При срабатывании триггера выполняет настроенный скрипт репозитория на указанных целевых объектах.<br>Данные триггера передаются скрипту в качестве первого параметра. Параметр кодируется в формате JSON и Base64.
repository_script string	Скрипт репозитория, выполняемый при срабатывании триггера; указывается по имени или UID.
targets list / elements=string	Целевые объекты, на которых выполняется скрипт.
time_out integer	Время ожидания выполнения скрипта в секундах.
send_mail dictionary	При срабатывании триггера отправляет настроенное электронное письмо указанным получателям.
mail_settings dictionary	Необходимые настройки для отправки письма.
attachment string	Файл, который нужно прикрепить к письму. Варианты: `"no attachment"` `"changes report"` `"policy installation report"`
bcc_recipients string	Список адресов электронной почты получателей скрытой копии, разделенных запятыми.
body string	Текст письма.
cc_recipients string	Список адресов электронной почты получателей копии, разделенных запятыми.
recipients string	Список адресов электронной почты получателей, разделенных запятыми.
sender_email string	Адрес электронной почты отправителя письма.
subject string	Тема письма.
smtp_server string	UID или имя предварительно настроенного объекта SMTP-сервера.
send_web_request dictionary	При срабатывании триггера отправляет HTTPS POST-запрос к настроенному URL.<br>Данные триггера вместе с пользовательскими данными SmartTask передаются в полезной нагрузке запроса.
fingerprint string	Отпечаток SHA1 SSL-сертификата URL. Используется для доверия серверам с самоподписанными SSL-сертификатами.
override_proxy boolean	Параметр, определяющий, следует ли отправлять веб-запрос через прокси, отличный от прокси сервера управления (если он задан). Варианты: `false` `true`
proxy_url string	URL прокси, используемого для отправки запроса.
shared_secret string	Общий секрет, который целевой сервер может использовать для идентификации сервера управления.<br>Значение будет отправлено в составе запроса в заголовке «X-chkp-shared-secret».
time_out integer	Время ожидания веб-запроса в секундах.
url string	URL, используемый для веб-запроса.
auto_publish_session boolean	Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты: `false` ← (по умолчанию) `true`
color string	Цвет объекта. Должен быть одним из существующих цветов. Варианты: `"aquamarine"` `"black"` `"blue"` `"crete blue"` `"burlywood"` `"cyan"` `"dark green"` `"khaki"` `"orchid"` `"dark orange"` `"dark sea green"` `"pink"` `"turquoise"` `"dark blue"` `"firebrick"` `"brown"` `"forest green"` `"gold"` `"dark gold"` `"gray"` `"dark gray"` `"light green"` `"lemon chiffon"` `"coral"` `"sea green"` `"sky blue"` `"magenta"` `"purple"` `"slate blue"` `"violet red"` `"navy blue"` `"olive"` `"orange"` `"red"` `"sienna"` `"yellow"`
comments string	Строка комментариев.
custom_data string	Пользовательские данные для SmartTask в формате JSON.<br>При срабатывании триггера его данные преобразуются в JSON. Затем пользовательские данные добавляются к JSON с данными триггера.
description string	Описание функциональности и параметров SmartTask.
details_level string	Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до его полного подробного представления. Варианты: `"uid"` `"standard"` `"full"`
enabled boolean	Указывает, включена ли SmartTask и будет ли она выполняться при срабатывании триггера. Варианты: `false` `true`
fail_open boolean	Определяет, следует ли считать ошибку выполнения действия ошибкой или продолжить работу. Варианты: `false` `true`
ignore_errors boolean	Применить изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
name string / обязательный	Имя объекта.
state string	Состояние правила доступа (present или absent). Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / elements=string	Набор идентификаторов тегов.
trigger string	Тип триггера, связанного с SmartTask.
version string	Версия Checkpoint. Если не указана, используется последняя версия.
wait_for_task boolean	Дождаться завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Время ожидания в минутах до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-smart-task
  cp_mgmt_smart_task:
    action:
      run_script:
        repository_script: Session Name Validation Script
        time_out: 30
    custom_data: '{"session-name-format": "CR"}'
    description: Run a validation script that ensures that the a session name matches the expected name format as described in the Custom Data field.
    enabled: true
    name: Validate Session Name Before Publish
    state: present
    trigger: Before Publish

- name: set-smart-task
  cp_mgmt_smart_task:
    action:
      send_web_request:
        fingerprint: 3FDD902286DBF130EF4CEC7939EF81060AB0FEB6
        url: https://demo.example.com/policy-installation-reports
    custom_data: '{"mail-address": "example-admin@example-corp.com"}'
    description: Send policy installation results to the mail address specified in the Custom Data field using the corporate's dedicated web server.
    enabled: true
    name: Send Policy Installation Reports
    state: present
    trigger: After Install Policy

- name: delete-smart-task
  cp_mgmt_smart_task:
    name: Validate Session Name Before Publish
    state: absent

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

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

Ключ	Описание
cp_mgmt_smart_task dictionary	Объект Checkpoint, созданный или обновленный. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

Eden Brillant (@chkp-edenbr)

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

© 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_smart_task_module.html