check_point.mgmt.cp_mgmt_show_ad_content module – Retrieves Active Directory users, groups, and machines for an Account Unit.

Note

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

New in check_point.mgmt 7.0.0

Synopsis

  • Retrieves Active Directory users, groups, and machines for an Account Unit.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

account_unit

string / required

Name or UID of the Active Directory Account Unit to query.

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

cursor

string

Opaque pagination cursor from a previous response’s ‘next-cursor’. Omit on the first call of a cursor walk. Requires ‘use-cursor’ to be true.

fetch_direct_groups

boolean

When true, returns the direct (first-level) groups each entity belongs to in ‘member-of’.

Choices:

  • false

  • true

filter

dictionary

Filters the returned entities.

exact_match

boolean

When true, uses equality match on attributes. When false, uses substring match. Not applicable when ‘search-in’ is ‘anr’.

Choices:

  • false

  • true

fetch_groups

boolean

When true, includes group entities in the results.

Choices:

  • false

  • true

fetch_machines

boolean

When true, includes machine entities in the results.

Choices:

  • false

  • true

fetch_users

boolean

When true, includes user entities in the results.

Choices:

  • false

  • true

search_in

list / elements=string

AD attributes to search in. An entity is returned if text matches in any of the specified attributes. Set to ‘anr’ to use Ambiguous Name Resolution - an AD server-side feature that searches across multiple indexed attributes simultaneously. ‘anr’ cannot be combined with other attributes.

text

list / elements=string

Search text. entities matching any of the values are returned.

limit

integer

The maximal number of returned results.

offset

integer

Number of the results to initially skip. Cannot be combined with ‘use-cursor’ set to true.

use_cursor

boolean

When true, enables cursor pagination using LDAP Simple Paged Results. The response carries ‘next-cursor’, which the caller passes back as ‘cursor’ on subsequent requests to fetch the next batch. Cannot be combined with ‘offset’. When ‘use-cursor’ is true, ‘total’ is not returned in the response.

Choices:

  • false

  • true

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: show-ad-content
  cp_mgmt_show_ad_content:
    account_unit: MyActiveDirectory
    limit: 4

Return Values

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

Key

Description

cp_mgmt_show_ad_content

dictionary

The checkpoint show-ad-content output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)