zscaler.ziacloud.zia_cloud_application_instances module – Add a new cloud application instance

Note

This module is part of the zscaler.ziacloud collection (version 2.0.3).

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

To use it in a playbook, specify: zscaler.ziacloud.zia_cloud_application_instances.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Add a new cloud application instance

Requirements

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

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

client_id

string

The client ID for OAuth2 authentication.

client_secret

string

The client secret for OAuth2 authentication.

cloud

string

The Zscaler cloud name provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

instance_id

integer

The unique identifier for the cloud application instance.

instance_identifiers

list / elements=dictionary / required

List of cloud application instance identifiers

identifier_type

string / required

Type of identifier.

Choices:

  • "URL"

  • "REFURL"

  • "KEYWORD"

instance_identifier

string / required

The URL, IP address, or keyword for the cloud app instance.

instance_identifier_name

string / required

The name assigned to the instance identifier.

instance_name

string / required

Name of the cloud application instance.

instance_type

string / required

Type of the cloud application instance.

Choices:

  • "SHAREPOINTONLINE"

  • "ONEDRIVE"

  • "BOXNET"

  • "OKTA"

  • "APPSPACE"

  • "BITBUCKET"

  • "GITHUB"

  • "SLACK"

  • "QUICK_BASE"

  • "ZEPLIN"

  • "SOURCEFORGE"

  • "ZOOM"

  • "WORKDAY"

  • "GDRIVE"

  • "GOOGLE_WEBMAIL"

  • "WINDOWS_LIVE_HOTMAIL"

  • "MSTEAM"

password

string

A string that contains the password for the API admin.

private_key

string

The private key for JWT-based OAuth2 authentication.

provider

dictionary

A dict containing authentication credentials.

api_key

string

Obfuscated API key.

client_id

string

OAuth2 client ID.

client_secret

string

OAuth2 client secret.

cloud

string

Zscaler cloud name.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

password

string

Password for the API admin.

private_key

string

Private key for OAuth2 JWT.

sandbox_cloud

string

Sandbox Cloud environment.

sandbox_token

string

Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

Email ID of the API admin.

vanity_domain

string

Vanity domain for OAuth2.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

A string that contains the email ID of the API admin.

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Notes

Note

  • Check mode is supported.

Examples

- name: Configure cloud application instance
  zscaler.ziacloud.zia_cloud_application_instances:
    state: present
    instance_name: "Instance01_Ansible"
    instance_type: "SHAREPOINTONLINE"
    instance_identifiers:
      - instance_identifier_name: sharepoint01
        instance_identifier: sharepoint01.sharepoint.com
        identifier_type: URL

      - instance_identifier_name: "sharepoint02"
        instance_identifier: "sharepoint02.sharepoint.com"
        identifier_type: "URL"

Authors

  • William Guilherme (@willguibr)