check_point.mgmt.cp_mgmt_simple_cluster 模块 – 通过 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_simple_cluster
。
check_point.mgmt 3.0.0 中的新增功能
概要
管理 Checkpoint 设备上的简单集群对象,包括创建、更新和删除对象。
所有操作都通过 Web 服务 API 执行。
参数
参数 |
注释 |
---|---|
启用 Anti-Bot 刀片。 选项
|
|
启用 Anti-Virus 刀片。 选项
|
|
启用应用程序控制刀片。 选项
|
|
如果任务完成后执行了更改,则发布当前会话。 选项
|
|
集群模式。 选项
|
|
集群平台版本。 |
|
对象的颜色。应为现有颜色之一。 选项
|
|
注释字符串。 |
|
启用内容感知刀片。 选项
|
|
响应中某些字段的详细程度可能会有所不同,从仅显示对象的 UID 值到对象的完整详细表示。 选项
|
|
启用防火墙刀片。 选项
|
|
不适用 |
|
不适用 选项
|
|
不适用 选项
|
|
不适用 |
|
不适用 |
|
不适用 |
|
不适用 |
|
组标识符的集合。 |
|
集群平台硬件。 |
|
应用更改时忽略错误。您将无法发布此类更改。如果省略 ignore-warnings 标志,则也会忽略警告。 选项
|
|
应用更改时忽略警告。 选项
|
|
不适用 |
|
不适用 选项
|
|
不适用 |
|
是否拒绝数据包(“阻止”选项)或是否监视数据包(“检测”选项)。 选项
|
|
不检查来自排除网络的数据包。 选项
|
|
排除的网络名称。 |
|
排除的网络 UID。 |
|
欺骗跟踪。 选项
|
|
对象的颜色。应为现有颜色之一。 选项
|
|
注释字符串。 |
|
响应中某些字段的详细程度可能会有所不同,从仅显示对象的 UID 值到对象的完整详细表示。 选项
|
|
应用更改时忽略错误。您将无法发布此类更改。如果省略 ignore-warnings 标志,则也会忽略警告。 选项
|
|
应用更改时忽略警告。 选项
|
|
集群接口类型。 选项
|
|
IPv4 或 IPv6 地址。如果需要两个地址,请显式使用 ipv4-address 和 ipv6-address 字段。 |
|
IPv4 地址。 |
|
IPv4 网络掩码长度。 |
|
IPv4 网络地址。 |
|
IPv6 地址。 |
|
IPv6 网络掩码长度。 |
|
IPv6 网络地址。 |
|
IPv4 或 IPv6 网络掩码长度。 |
|
多播 IP 地址。 |
|
多播地址类型。 选项
|
|
对象名称。 |
|
IPv4 或 IPv6 网络掩码。如果需要两个掩码,请显式使用 ipv4-network-mask 和 ipv6-network-mask 字段。除了提供掩码本身之外,还可以在 mask-length 字段中指定 IPv4 或 IPv6 掩码长度。如果需要两个掩码长度,请显式使用 ipv4-mask-length 和 ipv6-mask-length 字段。 |
|
不适用 选项
|
|
不适用 |
|
安全区域根据接口通向的位置计算。 选项
|
|
手动指定的安全区域。 |
|
标签标识符的集合。 |
|
不适用 选项
|
|
不适用 |
|
此接口是否通向非军事区(周边网络)。 选项
|
|
此接口后面的网络设置。 选项
|
|
此接口后面的网络。 |
|
IPv4 或 IPv6 地址。如果需要两个地址,请显式使用 ipv4-address 和 ipv6-address 字段。 |
|
启用入侵防御系统刀片。 选项
|
|
IPv4 地址。 |
|
IPv6 地址。 |
|
集群成员列表。只能添加新的集群成员。不支持添加现有网关。 |
|
对象的颜色。应为现有颜色之一。 选项
|
|
注释字符串。 |
|
响应中某些字段的详细程度可能会有所不同,从仅显示对象的 UID 值到对象的完整详细表示。 选项
|
|
应用更改时忽略错误。您将无法发布此类更改。如果省略 ignore-warnings 标志,则也会忽略警告。 选项
|
|
应用更改时忽略警告。 选项
|
|
集群成员网络接口。 |
|
不适用 选项
|
|
不适用 |
|
是否拒绝数据包(“阻止”选项)或是否监视数据包(“检测”选项)。 选项
|
|
不检查来自排除网络的数据包。 选项
|
|
排除的网络名称。 |
|
排除的网络 UID。 |
|
欺骗跟踪。 选项
|
|
对象的颜色。应为现有颜色之一。 选项
|
|
注释字符串。 |
|
响应中某些字段的详细程度可能会有所不同,从仅显示对象的 UID 值到对象的完整详细表示。 选项
|
|
应用更改时忽略错误。您将无法发布此类更改。如果省略 ignore-warnings 标志,则也会忽略警告。 选项
|
|
应用更改时忽略警告。 选项
|
|
IPv4 或 IPv6 地址。如果需要两个地址,请显式使用 ipv4-address 和 ipv6-address 字段。 |
|
IPv4 地址。 |
|
IPv4 网络掩码长度。 |
|
IPv4 网络地址。 |
|
IPv6 地址。 |
|
IPv6 网络掩码长度。 |
|
IPv6 网络地址。 |
|
IPv4 或 IPv6 网络掩码长度。 |
|
对象名称。 |
|
IPv4 或 IPv6 网络掩码。如果需要两个掩码,请显式使用 ipv4-network-mask 和 ipv6-network-mask 字段。除了提供掩码本身之外,还可以在 mask-length 字段中指定 IPv4 或 IPv6 掩码长度。如果需要两个掩码长度,请显式使用 ipv4-mask-length 和 ipv6-mask-length 字段。 |
|
不适用 选项
|
|
不适用 |
|
安全区域根据接口通向的位置计算。 选项
|
|
手动指定的安全区域。 |
|
标签标识符的集合。 |
|
不适用 选项
|
|
不适用 |
|
此接口是否通向非军事区(周边网络)。 选项
|
|
此接口后面的网络设置。 选项
|
|
此接口后面的网络。 |
|
IPv4 或 IPv6 地址。如果需要两个地址,请显式使用 ipv4-address 和 ipv6-address 字段。 |
|
IPv4 地址。 |
|
IPv6 地址。 |
|
对象名称。 |
|
不适用 |
|
标签标识符的集合。 |
|
对象名称。 |
|
集群平台操作系统。 |
|
平台门户设置。 |
|
门户访问设置的配置。 |
|
允许访问 Web 门户(基于接口或安全策略)。 选项
|
|
仅针对内部接口的其他门户访问设置的配置。 |
|
控制拓扑设置为“DMZ”的内部接口的门户访问设置。 选项
|
|
控制拓扑设置为“未定义”的内部接口的门户访问设置。 选项
|
|
控制属于 VPN 加密域的接口的门户访问设置。 选项
|
|
门户证书设置的配置。 |
|
以 Base64 编码且带有填充的证书文件。此文件必须是 *.p12 格式。 |
|
证书文件的密码(以 Base64 编码且带有填充)。 |
|
门户 Web 设置的配置。 |
|
重定向到主门户 URL 的 URL 别名列表。 |
|
可选,如果您的 DNS 服务器无法解析主门户 URL,则 Web 门户使用的 IP 地址。注意:如果您的 DNS 服务器解析主门户 URL,则此 IP 地址将被忽略。 |
|
Web 门户的主 URL。 |
|
要将警报发送到的服务器。 |
|
要将日志发送到的备份服务器。 |
|
要将日志发送到的服务器。 |
|
指示是否在答复中显示门户证书值。 选项
|
|
访问规则的状态(存在或不存在)。 选项
|
|
标签标识符的集合。 |
|
启用威胁模拟刀片。 选项
|
|
启用威胁提取刀片。 选项
|
|
要使用的威胁防御模式。使用自主威胁防御时,不允许禁用威胁防御刀片。 选项
|
|
启用 URL 过滤刀片。 选项
|
|
UserCheck 门户设置。 |
|
门户访问设置的配置。 |
|
允许访问 Web 门户(基于接口或安全策略)。 选项
|
|
仅针对内部接口的其他门户访问设置的配置。 |
|
控制拓扑设置为“DMZ”的内部接口的门户访问设置。 选项
|
|
控制拓扑设置为“未定义”的内部接口的门户访问设置。 选项
|
|
控制属于 VPN 加密域的接口的门户访问设置。 选项
|
|
门户证书设置的配置。 |
|
以 Base64 编码且带有填充的证书文件。此文件必须是 *.p12 格式。 |
|
证书文件的密码(以 Base64 编码且带有填充)。 |
|
Web 门户的状态(启用或禁用)。支持的刀片有:{“应用程序控制”、“URL 过滤”、“数据丢失防护”、“防病毒”、“防僵尸”、“威胁模拟”、“威胁提取”、“数据感知”}。 选项
|
|
门户 Web 设置的配置。 |
|
重定向到主门户 URL 的 URL 别名列表。 |
|
可选,如果您的 DNS 服务器无法解析主门户 URL,则 Web 门户使用的 IP 地址。注意:如果您的 DNS 服务器解析主门户 URL,则此 IP 地址将被忽略。 |
|
Web 门户的主 URL。 |
|
检查点版本。如果未给出版本,则采用最新版本。 |
|
已启用 VPN 刀片。 选项
|
|
网关 VPN 设置。 |
|
身份验证。 |
|
通过名称或 UID 标识的 VPN 身份验证客户端的集合。 |
|
链路选择。 |
|
DNS 解析主机名。当选择 “ip-selection” 为 “dns-resolving-from-hostname” 时,必须设置此项。 |
|
IP 地址。当选择 “ip-selection” 为 “use-selected-address-from-topology” 或 “use-statically-nated-ip” 时,必须设置此项。 |
|
不适用 选项
|
|
不适用 |
|
不适用 |
|
办公模式。表示广泛影响 - 办公模式适用于 IPSec VPN 软件刀片客户端和移动访问软件刀片客户端。 |
|
分配 IP 地址方法。通过依次尝试给定的方法分配 IP 地址,直到成功。 |
|
使用手动(IP 池)或自动(DHCP)。当 “use-allocate-method” 为 true 时,必须设置此项。 选项
|
|
用于 DHCP 分配的计算 MAC 地址。当选择 “allocate-method” 为 “automatic” 时,必须设置此项。 选项
|
|
DHCP 服务器。通过名称或 UID 标识。当选择 “allocate-method” 为 “automatic” 时,必须设置此项。 |
|
手动网络。通过名称或 UID 标识。当选择 “allocate-method” 为 “manual” 时,必须设置此项。 |
|
此配置适用于除自动(使用 DHCP)和包含此数据的 ipassignment.conf 条目之外的所有办公模式方法。 |
|
DNS 后缀。 |
|
第一个备份 DNS 服务器。通过名称或 UID 标识。当 “use-first-backup-dns-server” 为 true 时,必须设置此项,当 “use-first-backup-dns-server” 为 false 时,不能设置此项。 |
|
第一个备份 WINS 服务器。通过名称或 UID 标识。当 “use-first-backup-wins-server” 为 true 时,必须设置此项,当 “use-first-backup-wins-server” 为 false 时,不能设置此项。 |
|
IP 租约持续时间(分钟)。该值必须在 2-32767 的范围内。 |
|
主 DNS 服务器。通过名称或 UID 标识。当 “use-primary-dns-server” 为 true 时,必须设置此项,当 “use-primary-dns-server” 为 false 时,不能设置此项。 |
|
主 WINS 服务器。通过名称或 UID 标识。当 “use-primary-wins-server” 为 true 时,必须设置此项,当 “use-primary-wins-server” 为 false 时,不能设置此项。 |
|
第二个备份 DNS 服务器。通过名称或 UID 标识。当 “use-second-backup-dns-server” 为 true 时,必须设置此项,当 “use-second-backup-dns-server” 为 false 时,不能设置此项。 |
|
第二个备份 WINS 服务器。通过名称或 UID 标识。当 “use-second-backup-wins-server” 为 true 时,必须设置此项,当 “use-second-backup-wins-server” 为 false 时,不能设置此项。 |
|
使用第一个备份 DNS 服务器。 选项
|
|
使用第一个备份 WINS 服务器。 选项
|
|
使用主 DNS 服务器。 选项
|
|
使用主 WINS 服务器。 选项
|
|
使用第二个备份 DNS 服务器。 选项
|
|
使用第二个备份 WINS 服务器。 选项
|
|
用于验证用户的 Radius 服务器。 选项
|
|
使用分配方法。 选项
|
|
用于 DHCP 服务器回复的虚拟 IPV4 地址。当选择 “allocate-method” 为 “automatic” 时,必须设置此项。 |
|
用于防欺骗的附加 IP 地址。通过名称或 UID 标识。当 “perform-anti-spoofings” 为 true 时,必须设置此项。 |
|
组。通过名称或 UID 标识。当选择 “office-mode-permissions” 为 “group” 时,必须设置此项。 |
|
办公模式权限。当选择为“off”时,所有其他定义都不相关。 选项
|
|
对办公模式地址执行防欺骗。 选项
|
|
支持具有多个外部接口的网关的连接增强。 选项
|
|
远程访问。 |
|
允许 VPN 客户端路由流量。 选项
|
|
L2TP 身份验证方法。当 “support-l2tp” 为 true 时,必须设置此项。 选项
|
|
L2TP 证书。当选择 “l2tp-auth-method” 为 “certificate” 时,必须设置此项。如果要使用默认证书,请插入 “defaultCert”。 |
|
已分配的 NAT 遍历 UDP 服务。通过名称或 UID 标识。当 “support-nat-traversal-mechanism” 为 true 时,必须设置此项。 |
|
支持 L2TP(仅在办公模式处于活动状态时相关)。 选项
|
|
支持 NAT 遍历机制(UDP 封装)。 选项
|
|
支持访客模式。 选项
|
|
访客模式的接口。当 “support-visitor-mode” 为 true 时,必须设置此项。如果要所有接口,请插入现有接口的 IPV4 地址或“所有 IP”。 |
|
访客模式的 TCP 服务。通过名称或 UID 标识。当 “support-visitor-mode” 为 true 时,必须设置此项。 |
|
通过名称或 UID 标识的网关 VPN 域。 |
|
网关 VPN 域类型。 选项
|
|
等待任务结束。例如发布任务。 选项
|
|
等待多少分钟,直到抛出超时错误。 默认值: |
示例
- name: add-simple-cluster
cp_mgmt_simple_cluster:
cluster_mode: cluster-xl-ha
color: yellow
firewall: true
interfaces:
- anti_spoofing: true
interface_type: cluster
ip_address: 17.23.5.1
name: eth0
network_mask: 255.255.255.0
topology: EXTERNAL
- interface_type: sync
name: eth1
topology: INTERNAL
topology_settings:
interface_leads_to_dmz: false
ip_address_behind_this_interface: network defined by the interface ip and net
mask
- anti_spoofing: true
interface_type: cluster
ip_address: 192.168.1.1
name: eth2
network_mask: 255.255.255.0
topology: INTERNAL
topology_settings:
interface_leads_to_dmz: false
ip_address_behind_this_interface: network defined by the interface ip and net
mask
ip_address: 17.23.5.1
members:
- interfaces:
- ip_address: 17.23.5.2
name: eth0
network_mask: 255.255.255.0
- ip_address: 1.1.2.4
name: eth1
network_mask: 255.255.255.0
- ip_address: 192.168.1.2
name: eth2
network_mask: 255.255.255.0
ip_address: 17.23.5.2
name: member1
one_time_password: abcd
- interfaces:
- ip_address: 17.23.5.3
name: eth0
network_mask: 255.255.255.0
- ip_address: 1.1.2.5
name: eth1
network_mask: 255.255.255.0
- ip_address: 192.168.1.3
name: eth2
network_mask: 255.255.255.0
ip_address: 17.23.5.3
name: member2
one_time_password: abcd
name: cluster1
os_name: Gaia
state: present
cluster_version: R80.30
- name: set-simple-cluster
cp_mgmt_simple_cluster:
name: cluster1
state: present
- name: delete-simple-cluster
cp_mgmt_simple_cluster:
name: cluster1
state: absent
返回值
常见返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
创建或更新的检查点对象。 返回:始终返回,除非删除对象。 |