zscaler.ziacloud.zia_dlp_idm_profile_info module – Get IDM template information

Note

This module is part of the zscaler.ziacloud collection (version 1.3.0).

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 zscaler.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_dlp_idm_profile_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Get IDM template information for the specified ID or Name

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

profile_id

integer

The identifier (1-64) for the IDM template (i.e., IDM profile) that is unique within the organization

profile_name

string

The IDM template name, which is unique per Index Tool.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gets all list of DLP IDM Profiles
  zscaler.ziacloud.zia_dlp_idm_profile_info:
    provider: '{{ provider }}'

- name: Gets a list of  DLP IDM Profiles by name
  zscaler.ziacloud.zia_dlp_idm_profile_info:
    provider: '{{ provider }}'
    name: "IDM_PROFILE_TEMPLATE"

Return Values

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

Key

Description

idm_profiles

list / elements=dictionary

List of DLP IDM profiles retrieved from the Zscaler system.

Returned: always

idm_client

dictionary

Object containing the IDM client details.

Returned: always

id

integer

Unique identifier for the IDM client.

Returned: always

Sample: 38316

name

string

Name of the IDM client.

Returned: always

Sample: "ZS_DLP_IDX01"

last_modified_time

integer

The UNIX timestamp when the profile was last modified.

Returned: always

Sample: 1702106392

modified_by

dictionary

Object containing details about the user who last modified the profile.

Returned: always

id

integer

Unique identifier of the user.

Returned: always

Sample: 44772836

name

string

Name of the user.

Returned: always

Sample: "admin@44772833.zscalertwo.net"

num_documents

integer

Number of documents associated with the profile.

Returned: always

Sample: 1

port

integer

The network port used by the IDM client.

Returned: always

Sample: 0

profile_id

integer

Unique identifier for the IDM profile.

Returned: always

Sample: 1

profile_name

string

Name of the IDM profile.

Returned: always

Sample: "BD_IDM_TEMPLATE01"

profile_type

string

Type of the IDM profile.

Returned: always

Sample: "LOCAL"

schedule_day

integer

The day of the week when the profile is scheduled to run.

Returned: always

Sample: 0

schedule_disabled

boolean

Boolean flag indicating whether the schedule is disabled.

Returned: always

Sample: false

schedule_time

integer

The time of day when the profile is scheduled to run.

Returned: always

Sample: 0

schedule_type

string

The type of scheduling used for the IDM profile.

Returned: always

Sample: "NONE"

upload_status

string

Status of the IDM profile upload.

Returned: always

Sample: "IDM_PROF_UPLOAD_COMPLETED"

version

integer

Version number of the IDM profile.

Returned: always

Sample: 1

volume_of_documents

integer

The volume of documents associated with the profile.

Returned: always

Sample: 153025

Authors

  • William Guilherme (@willguibr)