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

From Get docs
Ansible/docs/2.11/collections/check point/mgmt/cp mgmt group module


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

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

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

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


New in version 2.9: of check_point.mgmt


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

  • no
  • yes

Publish the current session if changes have been performed after task completes.

color

string

  • 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

  • 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 / elements=string

Collection of group identifiers.

ignore_errors

boolean

  • 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

  • no
  • yes

Apply changes ignoring warnings.

members

list / elements=string

Collection of Network objects identified by the name or UID.

name

string / required

Object name.

state

string

  • present

  • absent

State of the access rule (present or absent). Defaults to present.

tags

list / elements=string

Collection of tag identifiers.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

  • no
  • yes

Wait for the task to end. Such as publish task.

wait_for_task_timeout

integer

Default:

30

How many minutes to wait until throwing a timeout error.



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.





Authors

  • Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_group_module.html