zscaler.zpacloud.zpa_pra_portal_controller_info module – Retrieves information about a PRA Portal.

Note

This module is part of the zscaler.zpacloud collection (version 1.4.2).

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

To use it in a playbook, specify: zscaler.zpacloud.zpa_pra_portal_controller_info.

New in zscaler.zpacloud 1.1.0

Synopsis

  • This module will allow the retrieval of information about a PRA Portal.

Requirements

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

Parameters

Parameter

Comments

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

id

string

The unique identifier of the privileged portal

name

string

The name of the privileged portal

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Detail Information of All PRA Portal
  zscaler.zpacloud.zpa_pra_portal_controller_info:
    provider: '{{ zpa_cloud }}'

- name: Get Details of a PRA Portal by Name
  zscaler.zpacloud.zpa_pra_portal_controller_info:
    provider: '{{ zpa_cloud }}'
    name: "Example"

- name: Get Details of a PRA Portal by ID
  zscaler.zpacloud.zpa_pra_portal_controller_info:
    provider: '{{ zpa_cloud }}'
    id: "216196257331291969"

Return Values

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

Key

Description

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

portals

list / elements=dictionary

Information about the PRA Portals.

Returned: always

c_name

string

The canonical name of the portal.

Returned: success

Sample: "216199618143442004.********.pra.p.zpa-app.net"

certificate_id

string

The ID of the certificate associated with the portal.

Returned: success

Sample: "216199618143247243"

certificate_name

string

The name of the certificate associated with the portal.

Returned: success

Sample: "jenkins.bd-hashicorp.com"

creation_time

string

The timestamp when the portal was created.

Returned: success

Sample: "1724115556"

description

string

A description of the portal.

Returned: success

Sample: "portal.acme.com"

domain

string

The domain associated with the portal.

Returned: success

Sample: "portal.acme.com"

enabled

boolean

Indicates whether the portal is enabled.

Returned: success

Sample: true

id

string

The unique identifier of the portal.

Returned: success

Sample: "216199618143442004"

microtenant_name

string

The name of the microtenant associated with the portal.

Returned: success

Sample: "Default"

modified_by

string

The ID of the user who last modified the portal.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the portal was last modified.

Returned: success

Sample: "1724115556"

name

string

The name of the portal.

Returned: success

Sample: "portal.acme.com"

user_notification

string

The user notification associated with the portal.

Returned: success

Sample: "portal.acme.com"

user_notification_enabled

boolean

Indicates whether user notifications are enabled for the portal.

Returned: success

Sample: true

Authors

  • William Guilherme (@willguibr)