check_point.mgmt.cp_mgmt_show_azure_ad_content module – Retrieve AzureAD Objects from Azure AD Server.

Note

This module is part of the check_point.mgmt collection (version 5.2.2).

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_azure_ad_content.

New in check_point.mgmt 5.0.0

Synopsis

  • Retrieve AzureAD Objects from Azure AD Server.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

azure_ad_name

string

Name of the Azure AD Server where to search for objects.

azure_ad_uid

string

Unique identifier of the Azure AD Server where to search for objects.

details_level

string

Standard and Full description are the same.

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.

filter

dictionary

Return results matching the specified filter.

parent_uid_in_data_center

string

Return results under the specified Data Center Object (identified by UID).

text

string

Return results containing the specified text value.

uri

string

Return results under the specified Data Center Object (identified by URI).

limit

integer

The maximal number of returned results.

offset

integer

Number of the results to initially skip.

order

list / elements=dictionary

Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order.

ASC

string

Sorts results by the given field in ascending order.

Choices:

  • "name"

DESC

string

Sorts results by the given field in descending order.

Choices:

  • "name"

uid_in_azure_ad

string

Return result matching the unique identifier of the object on the Azure AD Server.

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-azure-ad-content
  cp_mgmt_show_azure_ad_content:
    name: my_azureAD

Return Values

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

Key

Description

cp_mgmt_show_azure_ad_content

dictionary

The checkpoint show-azure-ad-content output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)