cp_mgmt_https_rule

Manages https-rule objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_https_rule

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

Synopsis

Manages https-rule objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
action	str			Rule inspect level. “Bypass” or “Inspect”.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
blade	list			Blades for HTTPS Inspection. Identified by Name or UID of the blade.
certificate	str			Internal Server Certificate identified by Name or UID, otherwise, “Outbound Certificate” is a default value.
comments	str			Comments string.
destination	list			Collection of Network objects identified by Name or UID that represents connection destination.
destination_negate	bool			TRUE if “negate” value is set for Destination.
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.
enabled	bool			Enable/Disable the rule.
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.
install_on	list			Which Gateways identified by the name or UID to install the policy on.
layer	str			Layer that holds the Object. Identified by the Name or UID.
name	str	yes		Rule name.
position	str			Position in the rulebase.
service	list			Collection of Network objects identified by Name or UID that represents connection service.
service_negate	bool			TRUE if “negate” value is set for Service.
site_category	list			Collection of Site Categories objects identified by the name or UID.
site_category_negate	bool			TRUE if “negate” value is set for Site Category.
source	list			Collection of Network objects identified by Name or UID that represents connection source.
source_negate	bool			TRUE if “negate” value is set for Source.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers. Available from R81.20 JHF management version.
track	str			a “None”,“Log”,“Alert”,“Mail”,“SNMP trap”,“Mail”,“User Alert 1”, “User Alert 2”, “User Alert 3”.
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-https-rule
  check_point.mgmt.cp_mgmt_https_rule:
    layer: Default Outbound Layer
    name: FirstRule
    position: 1
    state: present

- name: set-https-rule
  check_point.mgmt.cp_mgmt_https_rule:
    name: FirstRule
    position: 2
    layer: Default Outbound Layer
    state: present

- name: delete-https-rule
  check_point.mgmt.cp_mgmt_https_rule:
    name: FirstRule
    layer: Default Outbound Layer
    state: absent