zscaler.zpacloud.zpa_pra_credential_controller module – Create a PRA Credential.

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

New in zscaler.zpacloud 1.1.0

Synopsis

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

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"

credential_type

string

The protocol type that was designated for that particular privileged credential.

The protocol type options are SSH, RDP, and VNC.

Each protocol type has its own credential requirements

Choices:

  • "USERNAME_PASSWORD"

  • "SSH_KEY"

  • "PASSWORD"

customer_id

string

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

description

string

The description of the privileged credential

id

string

The unique identifier of the privileged credential

name

string / required

The name of the privileged credential

passphrase

string

The password that is used to protect the SSH private key

This field is optional

password

string

The password associated with the username for the login you want to use for the privileged credential

private_key

string

The SSH private key associated with the username for the login you want to use for the privileged credential

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_domain

string

The domain name associated with the username

You can also include the domain name as part of the username

The domain name only needs to be specified with logging in to an RDP console that is connected to an Active Directory Domain

username

string

The username for the login you want to use for the privileged credential

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete PRA Credentials
  zscaler.zpacloud.zpa_pra_credential_controller:
    provider: "{{ zpa_cloud }}"
    name: John Doe
    description: Created with Ansible
    credential_type: USERNAME_PASSWORD
    user_domain: acme.com
    username: jdoe
    password: ''
  register: result

Authors

  • William Guilherme (@willguibr)