zscaler.zpacloud.zpa_pra_portal_controller module – Create a PRA Portal 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_portal_controller.

New in zscaler.zpacloud 1.1.0

Synopsis

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

Requirements

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

Parameters

Parameter

Comments

certificate_id

string

The unique identifier of the certificate

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 portal

domain

string

The domain of the privileged portal

enabled

boolean

Whether or not the privileged portal is enabled

Choices:

  • false

  • true ← (default)

id

string

The unique identifier of the privileged portal

name

string / required

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.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

user_notification

string

The notification message displayed in the banner of the privileged portallink, if enabled

user_notification_enabled

boolean

Indicates if the Notification Banner is enabled (true) or disabled (false)

Choices:

  • false

  • true ← (default)

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: Create/Update/Delete PRA Portal
  zscaler.zpacloud.zpa_pra_portal_controller:
    provider: '{{ zpa_cloud }}'
    name: 'portal.acme.com'
    description: 'Created with Ansible'
    enabled: true
    domain: 'portal.acme.com'
    certificate_id: "{{ cert_name.data[0].id }}"
    user_notification: 'Created with Ansible'
    user_notification_enabled: true
  register: result

Authors

  • William Guilherme (@willguibr)