cp_mgmt_host – Manages host objects on Check Point over Web Services API

New in version 2.9.

Synopsis

• Manages host 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.
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				Collection of group identifiers.
host_servers dictionary				Servers Configuration.
	dns_server boolean		Choices: no yes	Gets True if this server is a DNS Server.
	mail_server boolean		Choices: no yes	Gets True if this server is a Mail Server.
	web_server boolean		Choices: no yes	Gets True if this server is a Web Server.
	web_server_config dictionary			Web Server configuration.
		additional_ports list		Server additional ports.
		application_engines list		Application engines of this web server.
		listen_standard_port boolean	Choices: no yes	Whether server listens to standard port.
		operating_system string	Choices: sparc linux windows other x86 linux sparc solaris	Operating System.
		protected_by string		Network object which protects this server identified by the name or UID.
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.
interfaces list				Host interfaces.
	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.
	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			Interface name.
	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.
ip_address string				IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
ipv4_address string				IPv4 address.
ipv6_address string				IPv6 address.
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.
tags list				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.

Examples

- name: add-host
  cp_mgmt_host:
    ip_address: 192.0.2.1
    name: New Host 1
    state: present

- name: set-host
  cp_mgmt_host:
    color: green
    ipv4_address: 192.0.2.2
    name: New Host 1
    state: present

- name: delete-host
  cp_mgmt_host:
    name: New Host 1
    state: absent

Return Values

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

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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.