zscaler.zpacloud.zpa_pra_console_controller module – Create a PRA Console Controller.

Note

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

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

New in zscaler.zpacloud 1.1.0

Synopsis

  • This module will create/update/delete Privileged Remote Access Console.

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.

description

string

The description of the privileged console

enabled

boolean

Whether or not the privileged console is enabled

Choices:

  • false

  • true ← (default)

icon_text

string

The privileged console icon. The icon image is converted to base64 encoded text format

id

string

The unique identifier of the privileged console

name

string / required

The name of the privileged console

pra_application_id

string

The unique identifier of the Privileged Remote Access-enabled application.

pra_portal_ids

list / elements=string

The unique identifier 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.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Check mode is supported.

Examples

- name: Gather Details of a Specific Browser Certificates by Name
  zscaler.zpacloud.zpa_ba_certificate_info:
    provider: "{{ zpa_cloud }}"
    name: 'portal.acme.com'
    register: cert_name

- name: Get details of a specific SECURE_REMOTE_ACCESS application segment by name
  zscaler.zpacloud.zpa_application_segment_by_type_info:
    provider: "{{ zpa_cloud }}"
    application_type: SECURE_REMOTE_ACCESS
    name: pra_app_segment01
    register: pra_app_segment01

- name: Create/Update/Delete PRA Portal
  zscaler.zpacloud.zpa_pra_portal_controller:
    provider: "{{ zpa_cloud }}"
    name: 'portal.acme.com'
    description: 'PRA Portal'
    enabled: true
    domain: 'portal.acme.com'
    certificate_id: "{{ cert_name.certificates[0].id }}"
    user_notification: 'PRA Portal'
    user_notification_enabled: true
    register: portal

- name: Create PRA Console
  zscaler.zpacloud.zpa_pra_console_controller:
    provider: "{{ zpa_cloud }}"
    name: 'PRA Console'
    description: 'PRA Console'
    enabled: true
    pra_application_id: "{{ pra_app_segment01.apps[0].id }}"
    pra_portal_ids:
      - "{{ portal.data.id }}"
    register: result

Authors

  • William Guilherme (@willguibr)