cp_mgmt_interface

Manages interface 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_interface

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

Synopsis

Manages interface objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
anti_spoofing	bool			Enable anti-spoofing.
anti_spoofing_settings	dict			Anti Spoofing Settings.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
cluster_members	list			Network interface settings for cluster members.
cluster_network_type	str			Cluster interface type.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
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.
domains_to_process	list			Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
dynamic_ip	bool			Enable dynamic interface.
gateway_uid	str	yes		Gateway or cluster object uid that the interface belongs to.
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.
ipv4_address	str			IPv4 network address.
ipv4_mask_length	int			IPv4 mask length.
ipv4_network_mask	str			IPv4 network mask.
ipv6_address	str			IPv6 address.
ipv6_mask_length	int			IPv6 mask length.
ipv6_network_mask	str			IPv6 network mask.
monitored_by_cluster	bool			When Private is selected as the Cluster interface type, cluster can monitor or not monitor the interface.
name	str	yes		Network interface name.
network_interface_type	str			Network Interface Type.
security_zone_settings	dict			Security Zone Settings.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
topology	str			Topology configuration.
topology_settings	dict			Topology Settings.
version	str			Management API version path; omitted uses the default API version.
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-interface
  check_point.mgmt.cp_mgmt_interface:
    anti_spoofing: true
    anti_spoofing_settings:
      action: detect
      exclude_packets: false
      spoof_tracking: log
    cluster_members:
      - ipv4_address: 2.2.2.1
        ipv4_mask_length: 24
        ipv4_network_mask: 255.255.255.0
        member_name: member1
        name: eth4
      - ipv4_address: 2.2.2.2
        ipv4_mask_length: 24
        ipv4_network_mask: 255.255.255.0
        member_name: member2
        name: eth4
    cluster_network_type: cluster
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17
    ignore_warnings: false
    ipv4_address: 1.1.1.111
    ipv4_mask_length: 24
    name: eth0
    security_zone_settings:
      auto_calculated: false
      specific_zone: InternalZone
    state: present
    topology: internal
    topology_settings:
      interface_leads_to_dmz: false
      ip_address_behind_this_interface: network defined by routing

- name: set-interface
  check_point.mgmt.cp_mgmt_interface:
    cluster_members:
      - ipv4_address: 4.4.4.1
        ipv4_mask_length: 22
        member_name: memberReal1
      - ipv4_address: 4.4.4.2
        ipv4_mask_length: 22
        member_name: memberReal2
    cluster_network_type: cluster + sync
    ipv4_address: 4.4.4.111
    ipv4_mask_length: 22
    state: present
    topology: internal
    topology_settings:
      ip_address_behind_this_interface: network defined by routing
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17

- name: delete-interface
  check_point.mgmt.cp_mgmt_interface:
    state: absent
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17