cp_mgmt_package
Manages package 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_package
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages package objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| access | bool | True - enables, False - disables access & NAT policies, empty - nothing is changed. | ||
| access_layers | dict | Access policy layers. | ||
| 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. | ||
| desktop_security | bool | True - enables, False - disables Desktop security policy, empty - nothing is changed. | ||
| 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. | ||
| 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. | ||
| installation_targets | list | Which Gateways identified by the name or UID to install the policy on. | ||
| name | str | yes | Object name. | |
| qos | bool | True - enables, False - disables QoS policy, empty - nothing is changed. | ||
| qos_policy_type | str | QoS policy type. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| threat_layers | dict | Threat policy layers. | ||
| threat_prevention | bool | True - enables, False - disables Threat policy, empty - nothing is changed. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| vpn_traditional_mode | bool | True - enables, False - disables VPN traditional mode, empty - nothing is changed. | ||
| 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-package
check_point.mgmt.cp_mgmt_package:
access: true
color: dark green
comments: My Comments
name: New_Standard_Package_1
state: present
threat_prevention: false
- name: set-package
check_point.mgmt.cp_mgmt_package:
access_layers:
add:
- name: New Access Layer 1
position: 1
name: Standard
state: present
threat_layers:
add:
- name: New Layer 1
position: 2
- name: delete-package
check_point.mgmt.cp_mgmt_package:
name: New Standard Package 1
state: absent