zscaler.ziacloud.zia_activation_status_info module – Gets the activation status

Note

This module is part of the zscaler.ziacloud 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.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_activation_status_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets the activation status for the saved configuration changes

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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

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

sandbox_token

string

A string that contains the Sandbox API Key.

status

string

Organization Policy Edit/Update Activation status

username

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Gets the activation status for the saved configuration changes
  zscaler.ziacloud.zia_activation_status_info:
    provider: '{{ provider }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

current_activation_status

string

Current activation status of the ZIA configuration.

Returned: always

Sample: "ACTIVE"

msg

string

Provides a message if the provided status does not match the current activation status.

Returned: when ‘status’ parameter is provided and does not match current activation status

Sample: "Provided status 'PENDING' does not match the current activation status 'ACTIVE'."

status_matches

boolean

Boolean flag indicating whether the provided status matches the current activation status.

Returned: when ‘status’ parameter is provided

Sample: true

Authors

  • William Guilherme (@willguibr)