check_point.mgmt.cp_mgmt_ldap_group module – Manages ldap-group objects on Checkpoint over Web Services API

Note

This module is part of the check_point.mgmt collection (version 6.5.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_ldap_group.

New in check_point.mgmt 6.5.0

Synopsis

  • Manages ldap-group objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R82 JHF management version.

Parameters

Parameter

Comments

account_unit

string

LDAP account unit of the group. Identified by name or UID.

account_unit_branch

string

Branch of the selected LDAP Account Unit.

apply_filter_for_dynamic_group

boolean

Indicate whether to apply LDAP filter for dynamic group. <font color=”red”>Relevant only when</font> ‘scope’ is not set to ‘only_group_in_branch’.

Choices:

  • false

  • true

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

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.

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"

domains_to_process

list / elements=string

Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

group_prefix

string

Group name in the selected branch. <font color=”red”>Required only when</font> ‘scope’ is set to ‘only_group_in_branch’. Must be in DN syntax.

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:

  • false

  • true

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • false

  • true

ldap_filter

string

LDAP filter for the dynamic group. <font color=”red”>Relevant only when</font> ‘apply-filter-for-dynamic-group’ is set to ‘true’.

name

string / required

Object name.

scope

string

Group’s scope. There are three possible ways of defining a group, based on the users defined on the Account Unit.

Choices:

  • "all_account_unit_users"

  • "only_sub_tree"

  • "only_group_in_branch"

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

sub_tree_prefix

string

Sub tree prefix of the selected branch. <font color=”red”>Relevant only when</font> ‘scope’ is set to ‘only_sub_prefix’. Must be in DN syntax.

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

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

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: add-ldap-group
  cp_mgmt_ldap_group:
    account_unit: TestLdapAccountUnit
    account_unit_branch: OU=Test
    apply_filter_for_dynamic_group: true
    group_prefix: N=TestGroup
    ldap_filter: N=AnotherGroup
    name: TestLdapGroup
    scope: only_sub_tree
    state: present
    sub_tree_prefix: CA=AC

- name: set-ldap-group
  cp_mgmt_ldap_group:
    account_unit_branch: A=B
    group_prefix: N=TestGroup2
    ldap_filter: N=none
    name: TestLdapGroup
    state: present
    sub_tree_prefix: X=Y

- name: delete-ldap-group
  cp_mgmt_ldap_group:
    name: TestLdapGroup
    state: absent

Return Values

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

Key

Description

cp_mgmt_ldap_group

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Dor Berenstein (@chkp-dorbe)