check_point.mgmt.cp_mgmt_simple_cluster 模块 – 通过 Web Services API 管理 Checkpoint 上的简单集群对象

注意

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

check_point.mgmt 3.0.0 中的新增功能

概要

• 管理 Checkpoint 设备上的简单集群对象，包括创建、更新和删除对象。

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

参数

参数	注释
anti_bot 布尔值	启用反机器人刀片。 选项 false true
anti_virus 布尔值	启用反病毒刀片。 选项 false true
application_control 布尔值	启用应用程序控制刀片。 选项 false true
auto_publish_session 布尔值	如果任务完成后已执行更改，则发布当前会话。 选项 false ← (默认) true
cluster_mode 字符串	集群模式。 选项 "cluster-xl-ha" "cluster-ls-multicast" "cluster-ls-unicast" "opsec-ha" "opsec-ls"
cluster_version 字符串	集群平台版本。
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 字符串	注释字符串。
content_awareness 布尔值	启用内容感知刀片。 选项 false true
details_level 字符串	响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式。 选项 "uid" "standard" "full"
firewall 布尔值	启用防火墙刀片。 选项 false true
firewall_settings 字典	N/A
auto_calculate_connections_hash_table_size_and_memory_pool 布尔值	N/A 选项 false true
auto_maximum_limit_for_concurrent_connections 布尔值	N/A 选项 false true
connections_hash_size 整数	N/A
maximum_limit_for_concurrent_connections 整数	N/A
maximum_memory_pool_size 整数	N/A
memory_pool_size 整数	N/A
groups 列表 / 元素=字符串	组标识符集合。
hardware 字符串	集群平台硬件。
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被省略 - 警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
interfaces 列表 / 元素=字典	N/A
anti_spoofing 布尔值	N/A 选项 false true
anti_spoofing_settings 字典	N/A
action 字符串	如果数据包将被拒绝（“阻止”选项）或者数据包将被监控（“检测”选项）。 选项 "prevent" "detect"
exclude_packets 布尔值	不要检查来自排除网络的数据包。 选项 false true
excluded_network_name 字符串	排除的网络名称。
excluded_network_uid 字符串	排除的网络UID。
spoof_tracking 字符串	欺骗跟踪。 选项 "none" "log" "alert"
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 字符串	注释字符串。
details_level 字符串	响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式。 选项 "uid" "standard" "full"
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被省略 - 警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
interface_type 字符串	集群接口类型。 选项 "cluster" "sync" "cluster + sync" "private"
ip_address 字符串	IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。
ipv4_address 字符串	IPv4 地址。
ipv4_mask_length 字符串	IPv4 网络掩码长度。
ipv4_network_mask 字符串	IPv4 网络地址。
ipv6_address 字符串	IPv6 地址。
ipv6_mask_length 字符串	IPv6 网络掩码长度。
ipv6_network_mask 字符串	IPv6 网络地址。
mask_length 字符串	IPv4 或 IPv6 网络掩码长度。
multicast_address 字符串	组播 IP 地址。
multicast_address_type 字符串	组播地址类型。 选项 "manual" "default"
name 字符串	对象名称。
network_mask 字符串	IPv4 或 IPv6 网络掩码。如果需要两个掩码，请显式使用 ipv4-network-mask 和 ipv6-network-mask 字段。无需提供掩码本身，可以在 mask-length 字段中指定 IPv4 或 IPv6 掩码长度。如果需要两个掩码长度，请显式使用 ipv4-mask-length 和 ipv6-mask-length 字段。
security_zone 布尔值	N/A 选项 false true
security_zone_settings 字典	N/A
auto_calculated 布尔值	安全区域根据接口连接的位置进行计算。 选项 false true
specific_zone 字符串	手动指定的安全区域。
tags 列表 / 元素=字符串	标签标识符集合。
topology 字符串	N/A 选项 "automatic" "external" "internal"
topology_settings 字典	N/A
interface_leads_to_dmz 布尔值	此接口是否连接到非军事区（外围网络）。 选项 false true
ip_address_behind_this_interface 字符串	此接口后面的网络设置。 选项 "not defined" "network defined by the interface ip and net mask" "network defined by routing" "specific"
specific_network 字符串	此接口后面的网络。
ip_address 字符串	IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。
ips 布尔值	启用入侵防御系统刀片。 选项 false true
ipv4_address 字符串	IPv4 地址。
ipv6_address 字符串	IPv6 地址。
members 列表 / 元素=字典	集群成员列表。只能添加新的集群成员。不支持添加现有网关。
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 字符串	注释字符串。
details_level 字符串	响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式。 选项 "uid" "standard" "full"
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被省略 - 警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
interfaces 列表 / 元素=字典	集群成员网络接口。
anti_spoofing 布尔值	N/A 选项 false true
anti_spoofing_settings 字典	N/A
action 字符串	如果数据包将被拒绝（“阻止”选项）或者数据包将被监控（“检测”选项）。 选项 "prevent" "detect"
exclude_packets 布尔值	不要检查来自排除网络的数据包。 选项 false true
excluded_network_name 字符串	排除的网络名称。
excluded_network_uid 字符串	排除的网络UID。
spoof_tracking 字符串	欺骗跟踪。 选项 "none" "log" "alert"
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 字符串	注释字符串。
details_level 字符串	响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式。 选项 "uid" "standard" "full"
ignore_errors 布尔值	忽略错误应用更改。您将无法发布此类更改。如果忽略警告标志被省略 - 警告也将被忽略。 选项 false true
ignore_warnings 布尔值	忽略警告应用更改。 选项 false true
ip_address 字符串	IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。
ipv4_address 字符串	IPv4 地址。
ipv4_mask_length 字符串	IPv4 网络掩码长度。
ipv4_network_mask 字符串	IPv4 网络地址。
ipv6_address 字符串	IPv6 地址。
ipv6_mask_length 字符串	IPv6 网络掩码长度。
ipv6_network_mask 字符串	IPv6 网络地址。
mask_length 字符串	IPv4 或 IPv6 网络掩码长度。
name 字符串	对象名称。
network_mask 字符串	IPv4 或 IPv6 网络掩码。如果需要两个掩码，请显式使用 ipv4-network-mask 和 ipv6-network-mask 字段。无需提供掩码本身，可以在 mask-length 字段中指定 IPv4 或 IPv6 掩码长度。如果需要两个掩码长度，请显式使用 ipv4-mask-length 和 ipv6-mask-length 字段。
security_zone 布尔值	N/A 选项 false true
security_zone_settings 字典	N/A
auto_calculated 布尔值	安全区域根据接口连接的位置进行计算。 选项 false true
specific_zone 字符串	手动指定的安全区域。
tags 列表 / 元素=字符串	标签标识符集合。
topology 字符串	N/A 选项 "automatic" "external" "internal"
topology_settings 字典	N/A
interface_leads_to_dmz 布尔值	此接口是否连接到非军事区（外围网络）。 选项 false true
ip_address_behind_this_interface 字符串	此接口后面的网络设置。 选项 "not defined" "network defined by the interface ip and net mask" "network defined by routing" "specific"
specific_network 字符串	此接口后面的网络。
ip_address 字符串	IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。
ipv4_address 字符串	IPv4 地址。
ipv6_address 字符串	IPv6 地址。
name 字符串	对象名称。
one_time_password 字符串	N/A
tags 列表 / 元素=字符串	标签标识符集合。
name 字符串 / 必需	对象名称。
os_name 字符串	集群平台操作系统。
platform_portal_settings 字典	平台门户设置。
accessibility 字典	门户访问设置配置。
allow_access_from 字符串	允许访问Web门户（基于接口或安全策略）。 选项 “rule_base” “internal_interfaces” “all_interfaces”
internal_access_settings 字典	仅针对内部接口配置附加的门户访问设置。
dmz 布尔值	控制拓扑设置为“DMZ”的内部接口的门户访问设置。 选项 false true
undefined 布尔值	控制拓扑设置为“Undefined”的内部接口的门户访问设置。 选项 false true
vpn 布尔值	控制属于VPN加密域的接口的门户访问设置。 选项 false true
certificate_settings 字典	门户证书设置配置。
base64_certificate 字符串	使用填充的Base64编码的证书文件。此文件必须为*.p12格式。
base64_password 字符串	证书文件的密码（使用填充的Base64编码）。
portal_web_settings 字典	门户Web设置配置。
aliases 列表 / 元素=字符串	重定向到主门户URL的URL别名列表。
ip_address 字符串	可选，如果您的DNS服务器无法解析主门户URL，则Web门户使用的IP地址。注意，如果您的DNS服务器解析了主门户URL，则会忽略此IP地址。
main_url 字符串	Web门户的主URL。
send_alerts_to_server 列表 / 元素=字符串	发送警报到的服务器。
send_logs_to_backup_server 列表 / 元素=字符串	发送日志到的备份服务器。
send_logs_to_server 列表 / 元素=字符串	发送日志到的服务器。
show_portals_certificate 布尔值	指示是否在回复中显示门户证书值。 选项 false true
state 字符串	访问规则的状态（存在或不存在）。 选项 "present" ← (默认) “absent”
tags 列表 / 元素=字符串	标签标识符集合。
threat_emulation 布尔值	启用威胁模拟刀片。 选项 false true
threat_extraction 布尔值	启用威胁提取刀片。 选项 false true
threat_prevention_mode 字符串	要使用的威胁防护模式。使用自主威胁防护时，不允许禁用威胁防护刀片。 选项 “autonomous” “custom”
url_filtering 布尔值	启用URL过滤刀片。 选项 false true
usercheck_portal_settings 字典	UserCheck门户设置。
accessibility 字典	门户访问设置配置。
allow_access_from 字符串	允许访问Web门户（基于接口或安全策略）。 选项 “rule_base” “internal_interfaces” “all_interfaces”
internal_access_settings 字典	仅针对内部接口配置附加的门户访问设置。
dmz 布尔值	控制拓扑设置为“DMZ”的内部接口的门户访问设置。 选项 false true
undefined 布尔值	控制拓扑设置为“Undefined”的内部接口的门户访问设置。 选项 false true
vpn 布尔值	控制属于VPN加密域的接口的门户访问设置。 选项 false true
certificate_settings 字典	门户证书设置配置。
base64_certificate 字符串	使用填充的Base64编码的证书文件。此文件必须为*.p12格式。
base64_password 字符串	证书文件的密码（使用填充的Base64编码）。
enabled 布尔值	Web门户的状态（启用或禁用）。支持的刀片包括：{‘应用程序控制’，‘URL过滤’，‘数据丢失防护’，‘反病毒’，‘反机器人’，‘威胁模拟’，‘威胁提取’，‘数据感知’}。 选项 false true
portal_web_settings 字典	门户Web设置配置。
aliases 列表 / 元素=字符串	重定向到主门户URL的URL别名列表。
ip_address 字符串	可选，如果您的DNS服务器无法解析主门户URL，则Web门户使用的IP地址。注意，如果您的DNS服务器解析了主门户URL，则会忽略此IP地址。
main_url 字符串	Web门户的主URL。
version 字符串	Checkpoint的版本。如果未指定，则采用最新版本。
vpn 布尔值	启用VPN刀片。 选项 false true
vpn_settings 字典	网关VPN设置。
authentication 字典	身份验证。
authentication_clients 列表 / 元素=字符串	按名称或UID标识的VPN身份验证客户端集合。
link_selection 字典	链路选择。
dns_resolving_hostname 字符串	DNS解析主机名。“ip-selection”选择为“dns-resolving-from-hostname”时必须设置。
ip_address 字符串	IP地址。“ip-selection”选择为“use-selected-address-from-topology”或“use-statically-nated-ip”时必须设置。
ip_selection 字符串	N/A 选项 “use-main-address” “use-selected-address-from-topology” “use-statically-nated-ip” “calculated-ip-based-on-topology” “dns-resolving-from-hostname” “dns-resolving-from-gateway-and-domain-name” “use-probing-with-high-availability” “use-probing-with-load-sharing” “use-one-time-probing”
maximum_concurrent_ike_negotiations 整数	N/A
maximum_concurrent_tunnels 整数	N/A
office_mode 字典	办公模式。注释广泛影响 - 办公模式适用于IPSec VPN软件刀片客户端和移动访问软件刀片客户端。
allocate_ip_address_from 字典	分配IP地址方法。按顺序尝试给定的方法直到成功分配IP地址。
allocate_method 字符串	使用手动（IP池）或自动（DHCP）。当“use-allocate-method”为true时必须设置。 选项 "manual" "automatic"
dhcp_mac_address 字符串	DHCP分配的计算MAC地址。“allocate-method”选择为“automatic”时必须设置。 选项 “per-machine” “per-user”
dhcp_server 字符串	DHCP服务器。按名称或UID标识。“allocate-method”选择为“automatic”时必须设置。
manual_network 字符串	手动网络。按名称或UID标识。“allocate-method”选择为“manual”时必须设置。
optional_parameters 字典	此配置适用于所有办公模式方法，但自动（使用DHCP）和包含此数据的ipassignment.conf条目除外。
dns_suffixes 字符串	DNS后缀。
first_backup_dns_server 字符串	第一个备份DNS服务器。按名称或UID标识。“use-first-backup-dns-server”为true时必须设置，而“use-first-backup-dns-server”为false时则不能设置。
first_backup_wins_server 字符串	第一个备份WINS服务器。按名称或UID标识。“use-first-backup-wins-server”为true时必须设置，而“use-first-backup-wins-server”为false时则不能设置。
ip_lease_duration 整数	IP租用期限（分钟）。值必须在2-32767范围内。
primary_dns_server 字符串	主DNS服务器。按名称或UID标识。“use-primary-dns-server”为true时必须设置，而“use-primary-dns-server”为false时则不能设置。
primary_wins_server 字符串	主WINS服务器。按名称或UID标识。“use-primary-wins-server”为true时必须设置，而“use-primary-wins-server”为false时则不能设置。
second_backup_dns_server 字符串	第二个备份DNS服务器。按名称或UID标识。“use-second-backup-dns-server”为true时必须设置，而“use-second-backup-dns-server”为false时则不能设置。
second_backup_wins_server 字符串	第二个备份WINS服务器。按名称或UID标识。“use-second-backup-wins-server”为true时必须设置，而“use-second-backup-wins-server”为false时则不能设置。
use_first_backup_dns_server 布尔值	使用第一个备份DNS服务器。 选项 false true
use_first_backup_wins_server 布尔值	使用第一个备份WINS服务器。 选项 false true
use_primary_dns_server 布尔值	使用主DNS服务器。 选项 false true
use_primary_wins_server 布尔值	使用主WINS服务器。 选项 false true
use_second_backup_dns_server 布尔值	使用第二个备份DNS服务器。 选项 false true
use_second_backup_wins_server 布尔值	使用第二个备份WINS服务器。 选项 false true
radius_server 布尔值	用于验证用户的Radius服务器。 选项 false true
use_allocate_method 布尔值	使用分配方法。 选项 false true
virtual_ip_address 字符串	DHCP服务器回复的虚拟IPV4地址。“allocate-method”选择为“automatic”时必须设置。
anti_spoofing_additional_addresses 字符串	反欺骗的附加IP地址。按名称或UID标识。“perform-anti-spoofings”为true时必须设置。
group 字符串	组。按名称或UID标识。“office-mode-permissions”选择为“group”时必须设置。
mode 字符串	办公模式权限。选择为“off”时，所有其他定义都无关紧要。 选项 “off” “specific-group” “all-users”
perform_anti_spoofing 布尔值	对办公模式地址执行反欺骗。 选项 false true
support_multiple_interfaces 布尔值	支持具有多个外部接口的网关的连接增强功能。 选项 false true
remote_access 字典	远程访问。
allow_vpn_clients_to_route_traffic 布尔值	允许VPN客户端路由流量。 选项 false true
l2tp_auth_method 字符串	L2TP身份验证方法。“support-l2tp”为true时必须设置。 选项 “certificate” “md5”
l2tp_certificate 字符串	L2TP证书。“l2tp-auth-method”选择为“certificate”时必须设置。当您要使用默认证书时，插入“defaultCert”。
nat_traversal_service 字符串	分配的NAT遍历UDP服务。按名称或UID标识。“support-nat-traversal-mechanism”为true时必须设置。
support_l2tp 布尔值	支持L2TP（仅在办公模式处于活动状态时相关）。 选项 false true
support_nat_traversal_mechanism 布尔值	支持NAT遍历机制（UDP封装）。 选项 false true
support_visitor_mode 布尔值	支持访客模式。 选项 false true
visitor_mode_interface 字符串	访客模式接口。“support-visitor-mode”为true时必须设置。当您想要所有接口时，插入现有接口的IPV4地址或“所有IP”。
visitor_mode_service 字符串	访客模式的TCP服务。按名称或UID标识。“support-visitor-mode”为true时必须设置。
vpn_domain 字符串	按名称或UID标识的网关VPN域。
vpn_domain_type 字符串	网关VPN域类型。 选项 "manual" “addresses_behind_gw”
wait_for_task 布尔值	等待任务结束。例如发布任务。 选项 false true ← (默认)
wait_for_task_timeout 整数	在抛出超时错误之前等待多少分钟。 默认： 30

示例

- 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

返回值

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

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

作者

• Eden Brillant (@chkp-edenbr)

集合链接

• 问题跟踪器
• 存储库（源代码）