cp_mgmt_group – Manages group objects on Check Point over Web Services API

New in version 2.9.

Synopsis

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

• All operations are performed over Web Services API.

Parameters

Parameter	Choices/Defaults	Comments
auto_publish_session boolean	Choices: no yes	Publish the current session if changes have been performed after task completes.
color string	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	Color of the object. Should be one of existing colors.
comments string		Comments string.
details_level string	Choices: uid standard full	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.
groups list		Collection of group identifiers.
ignore_errors boolean	Choices: no yes	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 boolean	Choices: no yes	Apply changes ignoring warnings.
members list		Collection of Network objects identified by the name or UID.
name string / required		Object name.
state string	Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
tags list		Collection of tag identifiers.
version string		Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean	Choices: no yes ←	Wait for the task to end. Such as publish task.

Examples

- name: add-group
  cp_mgmt_group:
    members:
    - New Host 1
    - My Test Host 3
    name: New Group 5
    state: present

- name: set-group
  cp_mgmt_group:
    name: New Group 1
    state: present

- name: delete-group
  cp_mgmt_group:
    name: New Group 1
    state: absent

Return Values

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

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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]

• This module is maintained by the Ansible Community. [community]

Authors

• Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.