check_point.mgmt.cp_mgmt_access_rule 模块 – 通过 Web Services API 管理 Check Point 上的访问规则对象

注意

此模块是 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_access_rule。

check_point.mgmt 1.0.0 中的新增功能

概要

• 管理 Check Point 设备上的访问规则对象，包括创建、更新和删除对象。

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

参数

参数	注释
action 字符串	“接受”、“丢弃”、“询问”、“通知”、“拒绝”、“用户认证”、“客户端认证”、“应用层”。
action_settings 字典	操作设置。
enable_identity_captive_portal 布尔值	N/A 选项 false true
limit 字符串	N/A
auto_publish_session 布尔值	如果任务完成后已执行更改，则发布当前会话。 选项 false ← (默认) true
comments 字符串	注释字符串。
content 列表 / 元素=字典	此规则应用于的已处理文件类型的列表。
content_direction 字符串	应用文件类型处理的方向。 选项 "any" "up" "down"
content_negate 布尔值	如果为数据设置了否定，则为 True。 选项 false true
custom_fields 字典	自定义字段。
field_1 字符串	第一个自定义字段。
field_2 字符串	第二个自定义字段。
field_3 字符串	第三个自定义字段。
destination 列表 / 元素=字符串	由名称或 UID 标识的网络对象集合。
destination_negate 布尔值	如果为目标设置了否定，则为 True。 选项 false true
details_level 字符串	响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式不等。 选项 "uid" "standard" "full"
enabled 布尔值	启用/禁用规则。 选项 false true
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被忽略，则警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
inline_layer 字符串	由名称或 UID 标识的内联层。仅当“操作”设置为“应用层”时才相关。
install_on 列表 / 元素=字符串	要在其上安装策略的网关（由名称或 UID 标识）。
layer 字符串	规则所属的层（由名称或 UID 标识）。
name 字符串 / 必需	对象名称。
position 字符串	规则库中的位置。“顶部”和“底部”的值可能不是幂等的。
relative_position 字典	规则库中的位置。 此字段的使用可能不是幂等的。
above 字符串	在由名称标识的特定规则/部分上方添加规则（如果 search_entire_rulebase 为 False，则限制为 50 条规则）。
below 字符串	在由名称标识的特定规则/部分下方添加规则（如果 search_entire_rulebase 为 False，则限制为 50 条规则）。
bottom 字符串	将规则添加到由名称标识的特定部分的底部（如果 search_entire_rulebase 为 False，则限制为 50 条规则）。
top 字符串	将规则添加到由名称标识的特定部分的顶部（如果 search_entire_rulebase 为 False，则限制为 50 条规则）。
search_entire_rulebase 布尔值	是否搜索整个规则库中其 relative_position 字段已编辑的规则，以确保其位置或其所在部分确实发生了变化。 选项 false ← (默认) true
service 列表 / 元素=字符串	由名称或 UID 标识的网络对象集合。
service_negate 布尔值	如果为服务设置了否定，则为 True。 选项 false true
source 列表 / 元素=字符串	由名称或 UID 标识的网络对象集合。
source_negate 布尔值	如果为源设置了否定，则为 True。 选项 false true
state 字符串	访问规则的状态（存在或不存在）。 选项 "present" ← (默认) "absent"
time 列表 / 元素=字符串	时间对象的列表。例如，“周末”、“下班时间”、“每天”。
track 字典	跟踪设置。
accounting 布尔值	打开和关闭跟踪的会计功能。 选项 false true
alert 字符串	跟踪的警报类型。 选项 "none" "alert" "snmp" "mail" "user alert 1" "user alert 2" "user alert 3"
enable_firewall_session 布尔值	确定是否仅为防火墙连接生成会话日志。 选项 false true
per_connection 布尔值	确定是否对每个连接执行日志记录。 选项 false true
per_session 布尔值	确定是否对每个会话执行日志记录。 选项 false true
type 字符串	“日志”、“扩展日志”、“详细日志”、“无”。
user_check 字典	用户检查设置。
confirm 字符串	N/A 选项 "per rule" "per category" "per application/site" "per data type"
custom_frequency 字典	N/A
every 整数	N/A
unit 字符串	N/A 选项 "hours" "days" "weeks" "months"
frequency 字符串	N/A 选项 "once a day" "once a week" "once a month" "custom frequency..."
interaction 字符串	N/A
version 字符串	Check Point 版本。如果未指定，则采用最新版本。
vpn 字符串	Any 或 All_GwToGw。 选项 "Any" "All_GwToGw"
vpn_list 列表 / 元素=字典	社区或定向。
community 列表 / 元素=字符串	社区名称或 UID 列表。
directional 列表 / 元素=字典	社区定向匹配条件。
from 字符串	来自社区名称或 UID。
to 字符串	到社区名称或 UID。
wait_for_task 布尔值	等待任务结束。例如发布任务。 选项 false true ← (默认)
wait_for_task_timeout 整数	在抛出超时错误之前等待多少分钟。 默认值： 30

示例

- name: add-access-rule
  cp_mgmt_access_rule:
    layer: Network
    name: Rule 1
    position: 1
    service:
    - SMTP
    - AOL
    vpn: All_GwToGw
    state: present

- name: set-access-rule
  cp_mgmt_access_rule:
    action: Ask
    action_settings:
      enable_identity_captive_portal: true
      limit: Upload_1Gbps
    layer: Network
    name: Rule 1
    state: present

- name: delete-access-rule
  cp_mgmt_access_rule:
    layer: Network
    name: Rule 2
    state: absent

返回值

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

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

作者

• Or Soffer (@chkp-orso)

资源链接

• 问题跟踪器
• 代码库 (源代码)