check_point.mgmt.cp_mgmt_resource_smtp 模块 – 通过 Web Services API 管理 Checkpoint 上的 resource-smtp 对象

注意

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

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

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

要在剧本中使用它，请指定：check_point.mgmt.cp_mgmt_resource_smtp。

check_point.mgmt 6.0.0 中的新增功能

概要

• 管理 Checkpoint 设备上的 resource-smtp 对象，包括创建、更新和删除对象。

• 所有操作都通过 Web Services API 执行。

参数

参数	注释
action_1 字典	使用重写规则重写电子邮件中的发件人和收件人标头，您还可以使用自定义标头字段重写其他电子邮件标头。
custom_field 字典	标头名称。
field 字符串	标头名称。
original 字符串	原始字段。
rewritten 字符串	替换字段。
recipient 字典	重写收件人标头。
original 字符串	原始字段。
rewritten 字符串	替换字段。
sender 字典	重写发件人标头。
original 字符串	原始字段。
rewritten 字符串	替换字段。
action_2 字典	使用此窗口为 SMTP 资源配置邮件检查。
allowed_characters 字符串	MIME 电子邮件标头可以包含 8 位或 7 位字符（7 个 ASCII 字符和 8 个用于发送二进制字符），以便编码邮件数据。 选项 "8_bit" "7_bit"
mail_capacity 整数	限制传入电子邮件附件的大小（以 kb 为单位）。
strip_activex_tags 布尔值	去除 ActiveX 标签。 选项 false true
strip_applet_tags 布尔值	去除 JAVA 小程序。 选项 false true
strip_file_by_name 字符串	从邮件中去除指定名称的文件附件。
strip_ftp_links 布尔值	去除 ftp 链接。 选项 false true
strip_mime_of_type 字符串	指定要从邮件中去除的 MIME 类型。
strip_port_strings 布尔值	去除端口号。 选项 false true
strip_script_tags 布尔值	去除 JAVA 脚本。 选项 false true
auto_publish_session 布尔值	如果任务完成后进行了更改，则发布当前会话。 选项 false ← (默认) true
check_rulebase_with_new_destination 布尔值	将使用新的解析后的 IP 地址重新检查规则库以进行邮件传递。 选项 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 字符串	注释字符串。
cvp 字典	在邮件消息上配置 CVP 检查。
allowed_to_modify_content 布尔值	配置 CVP 服务器以检查但不修改内容。 选项 false true
enable_cvp 布尔值	选择以启用内容矢量协议。 选项 false true
reply_order 字符串	指定 CVP 服务器何时将数据返回给安全网关安全服务器。 选项 "return_data_after_content_is_approved" "return_data_before_content_is_approved"
server 字符串	CVP 服务器的 UID 或名称，请确保 CVP 服务器已被定义为 OPSEC 应用程序。
deliver_messages_using_dns_mx_records 布尔值	使用 MX 记录解析来设置连接的目标 IP 地址。 选项 false true
details_level 字符串	响应中某些字段的详细程度可能会有所不同，从仅显示对象的 UID 值到对象的完整详细表示。 选项 "uid" "standard" "full"
error_check_rulebase_with_new_destination 布尔值	将使用新的解析后的 IP 地址重新检查规则库以进行错误邮件传递。 选项 false true
error_deliver_messages_using_dns_mx_records 布尔值	MX 记录解析将用于设置用于发送错误消息的连接的源 IP 地址。 选项 false true
error_mail_delivery_server 字符串	如果 SMTP 安全服务器无法在放弃时间内传递邮件，并且选中了“错误时通知发件人”，则会发生错误邮件传递。
exception_track 字符串	确定是否记录由于资源定义而采取的“操作 2”和“CVP”类别中指定的动作。 选项 "none" "exception log" "exception alert"
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被省略，警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
mail_delivery_server 字符串	指定转发邮件的服务器。
match 字典	设置 SMTP 资源的匹配属性。
recipient 字符串	设置 SMTP 资源的匹配收件人属性。
sender 字符串	设置 SMTP 资源的匹配发件人属性。
name 字符串 / 必需	对象名称。
notify_sender_on_error 布尔值	启用错误邮件传递。 选项 false true
state 字符串	访问规则的状态（存在或不存在）。 选项 "present" ← (默认) "absent"
tags 列表 / 元素=字符串	标签标识符的集合。
version 字符串	Checkpoint 的版本。如果没有给出版本，则使用最新版本。
wait_for_task 布尔值	等待任务结束。例如发布任务。 选项 false true ← (默认)
wait_for_task_timeout 整数	等待多长时间（分钟）后抛出超时错误。 默认值： 30

示例

- name: add-resource-smtp
  cp_mgmt_resource_smtp:
    deliver_messages_using_dns_mx_records: 'true'
    exception_track: exception log
    mail_delivery_server: deliverServer
    match:
      recipient: recipientName
      sender: senderName
    name: newSmtpResource
    state: present

- name: set-resource-smtp
  cp_mgmt_resource_smtp:
    mail_delivery_server: newServer
    name: newSmtpResource
    state: present

- name: delete-resource-smtp
  cp_mgmt_resource_smtp:
    name: newSmtpResource
    state: absent

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段。

键	描述
cp_mgmt_resource_smtp 字典	已创建或更新的Checkpoint对象。 返回值： 始终返回，除非删除对象。

作者

• Eden Brillant (@chkp-edenbr)

资源链接

• 问题追踪器
• 代码仓库