You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

check_point.mgmt.cp_mgmt_package module – Manages package objects on Check Point over Web Services API

Note

This module is part of the check_point.mgmt collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_package.

New in version 2.9: of check_point.mgmt

Synopsis

• Manages package objects on Check Point devices including creating, updating and removing objects.

• All operations are performed over Web Services API.

Parameters

Parameter	Comments
access boolean	True - enables, False - disables access & NAT policies, empty - nothing is changed. Choices: no yes
access_layers dictionary	Access policy layers.
add list / elements=string	Collection of Access layer objects to be added identified by the name or UID.
name string	Layer name or UID.
position integer	Layer position.
remove list / elements=string	Collection of Access layer objects to be removed identified by the name or UID.
value list / elements=string	Collection of Access layer objects to be set identified by the name or UID. Replaces existing Access layers.
auto_publish_session boolean	Publish the current session if changes have been performed after task completes. Choices: no yes
color string	Color of the object. Should be one of existing colors. 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
comments string	Comments string.
desktop_security boolean	True - enables, False - disables Desktop security policy, empty - nothing is changed. Choices: no yes
details_level string	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. Choices: uid standard full
ignore_errors boolean	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. Choices: no yes
ignore_warnings boolean	Apply changes ignoring warnings. Choices: no yes
installation_targets list / elements=string	Which Gateways identified by the name or UID to install the policy on.
name string / required	Object name.
qos boolean	True - enables, False - disables QoS policy, empty - nothing is changed. Choices: no yes
qos_policy_type string	QoS policy type. Choices: recommended express
state string	State of the access rule (present or absent). Defaults to present. Choices: present ← (default) absent
tags list / elements=string	Collection of tag identifiers.
threat_layers dictionary	Threat policy layers.
add list / elements=string	Collection of Threat layer objects to be added identified by the name or UID.
name string	Layer name or UID.
position integer	Layer position.
remove list / elements=string	Collection of Threat layer objects to be removed identified by the name or UID.
value list / elements=string	Collection of Threat layer objects to be set identified by the name or UID. Replaces existing Threat layers.
threat_prevention boolean	True - enables, False - disables Threat policy, empty - nothing is changed. Choices: no yes
version string	Version of checkpoint. If not given one, the latest version taken.
vpn_traditional_mode boolean	True - enables, False - disables VPN traditional mode, empty - nothing is changed. Choices: no yes
wait_for_task boolean	Wait for the task to end. Such as publish task. Choices: no yes ← (default)
wait_for_task_timeout integer	How many minutes to wait until throwing a timeout error. Default: 30

Examples

- name: add-package
  cp_mgmt_package:
    access: true
    color: green
    comments: My Comments
    name: New_Standard_Package_1
    state: present
    threat_prevention: false

- name: set-package
  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
  cp_mgmt_package:
    name: New Standard Package 1
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
cp_mgmt_package dictionary	The checkpoint object created or updated. Returned: always, except when deleting the object.

Authors

• Or Soffer (@chkp-orso)

Collection links

Issue Tracker Repository (Sources)