check_point.mgmt.cp_mgmt_network – Manages network objects on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

To install it use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_network.

New in version 2.9: of check_point.mgmt

Synopsis

• Manages network objects on Check Point devices including creating, updating and removing objects.

• All operations are performed over Web Services API.

Parameters

Parameter		Choices/Defaults	Comments
auto_publish_session boolean		Choices: no yes	Publish the current session if changes have been performed after task completes.
broadcast string		Choices: disallow allow	Allow broadcast address inclusion.
color string		Choices: 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	Color of the object. Should be one of existing colors.
comments string			Comments string.
details_level string		Choices: uid standard full	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 / elements=string			Collection of group identifiers.
ignore_errors boolean		Choices: no yes	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 boolean		Choices: no yes	Apply changes ignoring warnings.
mask_length integer			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 integer			IPv4 network mask length.
mask_length6 integer			IPv6 network mask length.
name string / required			Object name.
nat_settings dictionary			NAT settings.
	auto_rule boolean	Choices: no yes	Whether to add automatic address translation rules.
	hide_behind string	Choices: gateway ip-address	Hide behind method. This parameter is not required in case "method" parameter is "static".
	install_on string		Which gateway should apply the NAT translation.
	ip_address string		IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly. This parameter is not required in case "method" parameter is "hide" and "hide-behind" parameter is "gateway".
	ipv4_address string		IPv4 address.
	ipv6_address string		IPv6 address.
	method string	Choices: hide static	NAT translation method.
state string		Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
subnet string			IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly.
subnet4 string			IPv4 network address.
subnet6 string			IPv6 network address.
subnet_mask string			IPv4 network mask.
tags list / elements=string			Collection of tag identifiers.
version string			Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean		Choices: no yes ←	Wait for the task to end. Such as publish task.
wait_for_task_timeout integer		Default: 30	How many minutes to wait until throwing a timeout error.

Examples

- name: add-network
  cp_mgmt_network:
    name: New Network 1
    state: present
    subnet: 192.0.2.0
    subnet_mask: 255.255.255.0

- name: set-network
  cp_mgmt_network:
    color: green
    mask_length: 16
    name: New Network 1
    new_name: New Network 2
    state: present
    subnet: 192.0.0.0

- name: delete-network
  cp_mgmt_network:
    name: New Network 2
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
cp_mgmt_network dictionary	always, except when deleting the object.	The checkpoint object created or updated.

Authors

• Or Soffer (@chkp-orso)