zscaler.ziacloud.zia_admin_role_management_info module – Gets a list of admin roles

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of admin roles

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"

id

integer

Admin role ID.

name

string

Name of the admin role.

password

string

A string that contains the password for the API admin.

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 a list of all admin roles
  zscaler.ziacloud.zia_admin_role_management_info:
  provider: '{{ provider }}'

- name: Gets a list of an admin roles
  zscaler.ziacloud.zia_admin_role_management_info:
    provider: '{{ provider }}'
    name: "Engineering"

Return Values

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

Key

Description

roles

list / elements=dictionary

List of roles returned from Zscaler ZIA based on the provided criteria. Each element in the list is a dictionary that describes a role.

Returned: always

id

integer

The unique identifier for the admin role.

Returned: always

Sample: 26270

name

string

The name of the admin role.

Returned: always

Sample: "Engineering_Role"

rank

integer

The rank associated with the admin role.

Returned: when available

Sample: 7

report_time_duration

integer

The time duration for reporting, represented in minutes. A value of -1 may indicate unlimited or not applicable.

Returned: when available

Sample: -1

role_type

string

The type of the admin role, indicating the role’s scope and permissions.

Returned: always

Sample: "EXEC_INSIGHT_AND_ORG_ADMIN"

Authors

  • William Guilherme (@willguibr)