cp_mgmt_ldap_group

Manages ldap-group objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_ldap_group

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages ldap-group objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
account_unit	str			LDAP account unit of the group. Identified by name or UID.
account_unit_branch	str			Branch of the selected LDAP Account Unit.
apply_filter_for_dynamic_group	bool			Indicate whether to apply LDAP filter for dynamic group. Relevant only when ‘scope’ is not set to ‘only_group_in_branch’.
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.
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.
domains_to_process	list			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	str			Group name in the selected branch. Required only when ‘scope’ is set to ‘only_group_in_branch’. Must be in DN syntax.
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.
ldap_filter	str			LDAP filter for the dynamic group. Relevant only when ‘apply-filter-for-dynamic-group’ is set to ’true’.
name	str	yes		Object name.
scope	str			Group’s scope. There are three possible ways of defining a group, based on the users defined on the Account Unit.
state	str		`present`	Desired object presence.
sub_tree_prefix	str			Sub tree prefix of the selected branch. Relevant only when ‘scope’ is set to ‘only_sub_prefix’. Must be in DN syntax.
tags	list			Collection of tag identifiers.
version	str			Management API version path; omitted uses the default API version.
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-ldap-group
  check_point.mgmt.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
  check_point.mgmt.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
  check_point.mgmt.cp_mgmt_ldap_group:
    name: TestLdapGroup
    state: absent