check_point.mgmt.cp_mgmt_show_azure_ad_content (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

Retrieve AzureAD Objects from Azure AD Server.

All operations are performed over Web Services API.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: show-azure-ad-content
  cp_mgmt_show_azure_ad_content:
    name: my_azureAD

Inputs

    
limit:
    description:
    - The maximal number of returned results.
    type: int

order:
    description:
    - Sorts the results by search criteria. Automatically sorts the results by Name, in
      the ascending order.
    elements: dict
    suboptions:
      ASC:
        choices:
        - name
        description:
        - Sorts results by the given field in ascending order.
        type: str
      DESC:
        choices:
        - name
        description:
        - Sorts results by the given field in descending order.
        type: str
    type: list

filter:
    description:
    - Return results matching the specified filter.
    suboptions:
      parent_uid_in_data_center:
        description:
        - Return results under the specified Data Center Object (identified by UID).
        type: str
      text:
        description:
        - Return results containing the specified text value.
        type: str
      uri:
        description:
        - Return results under the specified Data Center Object (identified by URI).
        type: str
    type: dict

offset:
    description:
    - Number of the results to initially skip.
    type: int

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

azure_ad_uid:
    description:
    - Unique identifier of the Azure AD Server where to search for objects.
    type: str

azure_ad_name:
    description:
    - Name of the Azure AD Server where to search for objects.
    type: str

details_level:
    choices:
    - uid
    - standard
    - full
    description:
    - Standard and Full description are the same.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

uid_in_azure_ad:
    description:
    - Return result matching the unique identifier of the object on the Azure AD Server.
    type: str

domains_to_process:
    description:
    - 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.
    elements: str
    type: list

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_show_azure_ad_content:
  description: The checkpoint show-azure-ad-content output.
  returned: always.
  type: dict