cp_mgmt_simple_cluster

Manages simple-cluster objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_simple_cluster

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages simple-cluster objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
anti_bot	bool			Anti-Bot blade enabled.
anti_virus	bool			Anti-Virus blade enabled.
application_control	bool			Application Control blade enabled.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
cluster_mode	str			Cluster mode.
cluster_version	str			Cluster platform version.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
content_awareness	bool			Content Awareness blade enabled.
details_level	str			The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.
enable_https_inspection	bool			Enable HTTPS Inspection after defining an outbound inspection certificate. To define the outbound certificate use outbound inspection certificate API.
firewall	bool			Firewall blade enabled.
firewall_settings	dict			N/A
groups	list			Collection of group identifiers.
hardware	str			Cluster platform hardware.
ignore_errors	bool			Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.
ignore_warnings	bool			Apply changes ignoring warnings.
interfaces	list			N/A
ip_address	str			IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
ips	bool			Intrusion Prevention System blade enabled.
ips_settings	dict			Cluster IPS settings. Available from R82 JHF management version.
ipv4_address	str			IPv4 address.
ipv6_address	str			IPv6 address.
members	list			Cluster members list. Only new cluster member can be added. Adding existing gateway is not supported.
name	str	yes		Object name.
os_name	str			Cluster platform operating system.
platform_portal_settings	dict			Platform portal settings. Available from R81 JHF management version.
send_alerts_to_server	list			Server(s) to send alerts to.
send_logs_to_backup_server	list			Backup server(s) to send logs to.
send_logs_to_server	list			Server(s) to send logs to.
show_portals_certificate	bool			Indicates whether to show the portals certificate value in the reply. Available from R81 JHF management version.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
threat_emulation	bool			Threat Emulation blade enabled.
threat_extraction	bool			Threat Extraction blade enabled. Available from R81.10 management version.
threat_prevention_mode	str			The mode of Threat Prevention to use. When using Autonomous Threat Prevention, disabling the Threat Prevention blades is not allowed. Available from R81.10 management version.
url_filtering	bool			URL Filtering blade enabled.
usercheck_portal_settings	dict			UserCheck portal settings. Available from R81 JHF management version.
version	str			Management API version path; omitted uses the default API version.
vpn	bool			VPN blade enabled.
vpn_settings	dict			Gateway VPN settings.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: add-simple-cluster
  check_point.mgmt.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
  check_point.mgmt.cp_mgmt_simple_cluster:
    name: cluster1
    state: present

- name: delete-simple-cluster
  check_point.mgmt.cp_mgmt_simple_cluster:
    name: cluster1
    state: absent