cp_mgmt_simple_gateway

Manages simple-gateway 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_simple_gateway

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

Synopsis

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

Parameters

Name	Type	Required	Default	Description
anti_bot	bool			Anti-Bot blade enabled.
anti_virus	bool			Anti-Virus blade enabled.
application_control	bool			Application Control blade enabled.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
content_awareness	bool			Content Awareness blade enabled. Available from R80.10 management version.
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.
enable_https_inspection	bool			Enable HTTPS Inspection after defining an outbound inspection certificate. To define the outbound certificate use outbound inspection certificate API.
firewall	bool			Firewall blade enabled.
firewall_settings	dict			N/A
gateway_version	str			Gateway platform version.
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.
interfaces	list			Network interfaces. When a gateway is updated with a new interfaces, the existing interfaces are removed.
ip_address	str			IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly.
ips	bool			Intrusion Prevention System blade enabled.
ips_settings	dict			Gateway IPS settings. Available from R82 JHF management version.
ipv4_address	str			IPv4 address.
ipv6_address	str			IPv6 address.
logs_settings	dict			N/A
name	str	yes		Object name.
one_time_password	str			N/A
os_name	str			Gateway platform operating system.
save_logs_locally	bool			Save logs locally on the gateway.
send_alerts_to_server	list			Server(s) to send alerts to.
send_logs_to_backup_server	list			Backup server(s) to send logs to.
send_logs_to_server	list			Server(s) to send logs to.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
threat_emulation	bool			Threat Emulation blade enabled.
threat_extraction	bool			Threat Extraction blade enabled. Available from R80.20.M2 management version.
url_filtering	bool			URL Filtering blade enabled.
version	str			Management API version path; omitted uses the default API version.
vpn	bool			VPN blade enabled.
vpn_settings	dict			Gateway VPN settings.
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-simple-gateway
  check_point.mgmt.cp_mgmt_simple_gateway:
    ip_address: 192.0.2.1
    name: gw1
    state: present

- name: set-simple-gateway
  check_point.mgmt.cp_mgmt_simple_gateway:
    anti_bot: true
    anti_virus: true
    application_control: true
    ips: true
    name: test_gateway
    state: present
    threat_emulation: true
    url_filtering: true

- name: delete-simple-gateway
  check_point.mgmt.cp_mgmt_simple_gateway:
    name: gw1
    state: absent