cp_mgmt_network

Manages network objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_network

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

Synopsis

Manages network objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
broadcast	str			Allow broadcast address inclusion.
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.
groups	list			Collection of group identifiers.
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.
mask_length	int			IPv4 or IPv6 network mask length. If both masks are required use mask-length4 and mask-length6 fields explicitly. Instead of IPv4 mask length it is possible to specify IPv4 mask itself in subnet-mask field.
mask_length4	int			IPv4 network mask length.
mask_length6	int			IPv6 network mask length.
name	str	yes		Object name.
nat_settings	dict			NAT settings.
state	str		`present`	Desired object presence.
subnet	str			IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.
subnet4	str			IPv4 network address.
subnet6	str			IPv6 network address.
subnet_mask	str			IPv4 network mask.
tags	list			Collection of tag identifiers.
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-network
  check_point.mgmt.cp_mgmt_network:
    name: New Network 1
    state: present
    subnet: 192.0.2.0
    subnet_mask: 255.255.255.0

- name: set-network
  check_point.mgmt.cp_mgmt_network:
    color: dark green
    mask_length: 16
    name: New Network 1
    state: present
    subnet: 192.0.0.0

- name: delete-network
  check_point.mgmt.cp_mgmt_network:
    name: New Network 2
    state: absent