zscaler.zpacloud.zpa_ba_certificate module – Create certificate in the ZPA Cloud.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module creates/delete a certificate in the ZPA Cloud.

  • The Certificate API do not provide a Update Method.

Requirements

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

Parameters

Parameter

Comments

cert_blob

string / required

The content of the certificate.

The cert_blob field must be in string format and must include the certificate and the private key (in PEM format).

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 certificate

id

string

The unique identifier of the certificate.

name

string / required

The name of the certificate.

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: Onboard ZPA BA Certificate
  zscaler.zpacloud.zpa_ba_certificate:
    provider: "{{ zpa_cloud }}"
    name: server1.securitygeek.io
    description: server1.securitygeek.io
    cert_blob: "{{ lookup('file', 'server1.pem') }}"

Authors

  • William Guilherme (@willguibr)