cp_mgmt_install_policy
install policy 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_install_policy
Controller module — runs on the local controller, not on remote hosts.
Synopsis
install policy on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access | bool | Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| desktop_security | bool | Set to be true in order to install the Desktop Security policy. By default, the value is true if desktop security policy is enabled on the input policy package, otherwise false. Available from R80.20.M1 management version. | ||
| install_on_all_cluster_members_or_fail | bool | Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don’t install on that cluster. Available from R80.10 management version. | ||
| policy_package | str | The name of the Policy Package to be installed. | ||
| prepare_only | bool | If true, prepares the policy for the installation, but doesn’t install it on an installation target. Available from R80.10 management version. | ||
| qos | bool | Set to be true in order to install the QoS policy. By default, the value is true if Quality-of-Service policy is enabled on the input policy package, otherwise false. Available from R80.20.M1 management version. | ||
| revision | str | The UID of the revision of the policy to install. Available from R80.10 management version. | ||
| targets | list | On what targets to execute this command. Targets may be identified by their name, or object unique identifier. | ||
| threat_prevention | bool | Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false. | ||
| 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: install-policy
check_point.mgmt.cp_mgmt_install_policy:
access: true
policy_package: standard
targets:
- corporate-gateway
threat_prevention: true