check_point.mgmt.cp_mgmt_smart_task модуль — Управляет объектами smart-task на Checkpoint через API веб-служб

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).

Возможно, эта коллекция уже установлена, если вы используете пакет 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

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

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
действие словарь	Действие, которое должно быть выполнено при срабатывании триггера.
выполнить_скрипт словарь	При срабатывании триггера выполняет настроенный скрипт репозитория на определённых целевых объектах.<br>Данные триггера передаются в скрипт в качестве первого параметра. Параметр кодируется в формате JSON в Base64.
скрипт_репозитория строка	Скрипт репозитория, который выполняется при срабатывании триггера, определяется по имени или UID.
цели список / элементы=строка	Целевые объекты для выполнения скрипта.
таймаут целое число	Таймаут выполнения скрипта в секундах.
отправить_почту словарь	При срабатывании триггера отправляет настроенное электронное письмо определённым получателям.
настройки_почты словарь	Требуемые настройки для отправки письма.
вложение строка	Какой файл должен быть приложен к письму. Варианты: `"no attachment"` `"changes report"` `"policy installation report"`
получатели_bcc строка	Список получателей bcc через запятую.
тело строка	Тело электронного письма.
получатели_cc строка	Список получателей cc через запятую.
получатели строка	Список получателей через запятую.
адрес_отправителя строка	Адрес электронной почты отправителя.
тема строка	Тема электронного письма.
smtp_сервер строка	UID или имя настроенного объекта SMTP-сервера.
отправить_веб_запрос словарь	При срабатывании триггера отправляет HTTPS POST веб-запрос на указанный URL.<br>Данные триггера будут переданы вместе с пользовательскими данными SmartTask в полезной нагрузке запроса.
отпечаток строка	SHA1-отпечаток SSL-сертификата URL. Используется для доверия к серверам с самоподписанными SSL-сертификатами.
переопределить_прокси логическое	Опция для отправки веб-запроса через прокси, отличный от прокси сервера управления (если определён). Варианты: `false` `true`
url_прокси строка	URL прокси, используемый для отправки запроса.
общий_секрет строка	Общий секрет, который может быть использован целевым сервером для идентификации сервера управления.<br>Значение будет отправлено в составе запроса в заголовке “X-chkp-shared-secret”.
таймаут_запроса целое число	Таймаут веб-запроса в секундах.
url строка	URL, используемый для веб-запроса.
автоматически_опубликовать_сессию логическое	Опубликовать текущую сессию, если после завершения задачи были внесены изменения. Варианты: `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 / required	Имя объекта.
state string	Состояние правила доступа (present или absent). Варианты: `"present"` ← (default) `"absent"`
tags list / elements=string	Коллекция идентификаторов тегов.
trigger string	Тип триггера, связанный с SmartTask.
version string	Версия checkpoint. Если не указана, используется последняя версия.
wait_for_task boolean	Ожидать завершения задачи. Например, задачи публикации. Варианты: `false` `true` ← (default)
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 словарь	Объект Checkpoint, созданный или обновленный. Возвращаемое значение: всегда, кроме случаев удаления объекта.

Авторы

Eden Brillant (@chkp-edenbr)

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

© 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/check_point/mgmt/cp_mgmt_smart_task_module.html