check_point.mgmt.cp_mgmt_smart_task 模块 – 通过 Web 服务 API 管理 Checkpoint 上的智能任务对象

注意

此模块是 check_point.mgmt 集合 (版本 6.2.1) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install check_point.mgmt。

要在 playbook 中使用它，请指定：check_point.mgmt.cp_mgmt_smart_task。

check_point.mgmt 5.0.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的智能任务对象，包括创建、更新和删除对象。

  • 所有操作均通过 Web 服务 API 执行。

参数

参数

注释

action

字典

触发器触发时要运行的操作。

run_script

字典

触发器触发时，在定义的目标上运行已配置的存储库脚本。
然后将触发器数据作为第一个参数传递给脚本。参数以 Base64 格式进行 JSON 编码。

repository_script

字符串

触发器触发时执行的存储库脚本，由名称或 UID 标识。

targets

列表 / 元素=字符串

执行脚本的目标。

time_out

整数

脚本执行超时时间（秒）。

send_mail

字典

触发器触发时，将配置的电子邮件发送给定义的收件人。

mail_settings

字典

发送邮件所需的设置。

attachment

字符串

应附加到邮件的文件。

选项

  • "no attachment"

  • "changes report"

  • "policy installation report"

bcc_recipients

字符串

以逗号分隔的密件抄送收件人邮件地址列表。

body

字符串

电子邮件正文。

cc_recipients

字符串

以逗号分隔的抄送收件人邮件地址列表。

recipients

字符串

以逗号分隔的收件人邮件地址列表。

sender_email

字符串

用于发送邮件的电子邮件地址。

subject

字符串

电子邮件主题。

smtp_server

字符串

预配置的 SMTP 服务器对象的 UID 或名称。

send_web_request

字典

触发器触发时，向配置的 URL 发送 HTTPS POST 网络请求。
触发器数据将与智能任务的自定义数据一起在请求的有效负载中传递。

fingerprint

字符串

URL 的 SSL 证书的 SHA1 指纹。用于信任具有自签名 SSL 证书的服务器。

override_proxy

布尔值

选项：是否通过管理服务器代理（如果已定义）以外的代理发送网络请求。

选项

  • false

  • true

proxy_url

字符串

用于发送请求的代理的 URL。

shared_secret

字符串

目标服务器可用于识别管理服务器的共享密钥。
该值将作为请求的一部分在“X-chkp-shared-secret”标头中发送。

time_out

整数

网络请求超时时间（秒）。

url

字符串

用于网络请求的 URL。

auto_publish_session

布尔值

如果任务完成后已进行更改，则发布当前会话。

选项

  • false ← (默认)

  • true

color

字符串

对象的颜色。应为现有颜色之一。

选项

  • "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

字符串

注释字符串。

custom_data

字符串

以 JSON 格式表示的每个智能任务自定义数据。
触发器触发时，触发器数据将转换为 JSON。然后将自定义数据连接到触发器数据 JSON。

description

字符串

智能任务的功能和选项的描述。

details_level

字符串

响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式。

选项

  • "uid"

  • "standard"

  • "full"

enabled

布尔值

智能任务是否启用以及在触发时是否运行。

选项

  • false

  • true

fail_open

布尔值

如果操作执行失败，是否将执行失败视为错误或继续。

选项

  • false

  • true

ignore_errors

布尔值

忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被忽略，则警告也将被忽略。

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

state

字符串

访问规则的状态（存在或不存在）。

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

trigger

字符串

与智能任务关联的触发器类型。

version

字符串

Checkpoint 版本。如果未指定，则采用最新版本。

wait_for_task

布尔值

等待任务结束。例如发布任务。

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间（分钟）后抛出超时错误。

默认值： 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": "[email protected]"}'
    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

字典

已创建或更新的检查点对象。

返回值： 始终返回，除非删除对象。

作者

  • Eden Brillant (@chkp-edenbr)