Try SpotterManages host objects on Check Point over Web Services API
| "added in version" 2.9 of ansible.builtin"
Authors: Or Soffer (@chkp-orso)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Manages host objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.
- 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
name:
description:
- Object name.
required: true
type: str
tags:
description:
- Collection of tag identifiers.
type: list
color:
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
description:
- Color of the object. Should be one of existing colors.
type: str
state:
choices:
- present
- absent
default: present
description:
- State of the access rule (present or absent).
type: str
groups:
description:
- Collection of group identifiers.
type: list
version:
description:
- Version of checkpoint. If not given one, the latest version taken.
type: str
comments:
description:
- Comments string.
type: str
interfaces:
description:
- Host interfaces.
suboptions:
color:
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
description:
- Color of the object. Should be one of existing colors.
type: str
comments:
description:
- Comments string.
type: str
details_level:
choices:
- uid
- standard
- full
description:
- 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.
type: str
ignore_errors:
description:
- 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.
type: bool
ignore_warnings:
description:
- Apply changes ignoring warnings.
type: bool
mask_length:
description:
- 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.
type: int
mask_length4:
description:
- IPv4 network mask length.
type: int
mask_length6:
description:
- IPv6 network mask length.
type: int
name:
description:
- Interface name.
type: str
subnet:
description:
- IPv4 or IPv6 network address. If both addresses are required use subnet4 and
subnet6 fields explicitly.
type: str
subnet4:
description:
- IPv4 network address.
type: str
subnet6:
description:
- IPv6 network address.
type: str
subnet_mask:
description:
- IPv4 network mask.
type: str
type: list
ip_address:
description:
- IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address
fields explicitly.
type: str
host_servers:
description:
- Servers Configuration.
suboptions:
dns_server:
description:
- Gets True if this server is a DNS Server.
type: bool
mail_server:
description:
- Gets True if this server is a Mail Server.
type: bool
web_server:
description:
- Gets True if this server is a Web Server.
type: bool
web_server_config:
description:
- Web Server configuration.
suboptions:
additional_ports:
description:
- Server additional ports.
type: list
application_engines:
description:
- Application engines of this web server.
type: list
listen_standard_port:
description:
- Whether server listens to standard port.
type: bool
operating_system:
choices:
- sparc linux
- windows
- other
- x86 linux
- sparc solaris
description:
- Operating System.
type: str
protected_by:
description:
- Network object which protects this server identified by the name or UID.
type: str
type: dict
type: dict
ipv4_address:
description:
- IPv4 address.
type: str
ipv6_address:
description:
- IPv6 address.
type: str
nat_settings:
description:
- NAT settings.
suboptions:
auto_rule:
description:
- Whether to add automatic address translation rules.
type: bool
hide_behind:
choices:
- gateway
- ip-address
description:
- Hide behind method. This parameter is not required in case "method" parameter
is "static".
type: str
install_on:
description:
- Which gateway should apply the NAT translation.
type: str
ip_address:
description:
- 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".
type: str
ipv4_address:
description:
- IPv4 address.
type: str
ipv6_address:
description:
- IPv6 address.
type: str
method:
choices:
- hide
- static
description:
- NAT translation method.
type: str
type: dict
details_level:
choices:
- uid
- standard
- full
description:
- 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.
type: str
ignore_errors:
description:
- 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.
type: bool
wait_for_task:
default: true
description:
- Wait for the task to end. Such as publish task.
type: bool
ignore_warnings:
description:
- Apply changes ignoring warnings.
type: bool
auto_publish_session:
default: false
description:
- Publish the current session if changes have been performed after task completes.
type: bool
wait_for_task_timeout:
default: 30
description:
- How many minutes to wait until throwing a timeout error.
type: int
cp_mgmt_host: description: The checkpoint object created or updated. returned: always, except when deleting the object. type: dict