zscaler.zpacloud.zpa_application_server_info module – Retrieve an application server information.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about an application server.

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"

customer_id

string

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

id

string

ID of the server group.

name

string

Name of the server group.

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.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information Details of All Application Servers
  zscaler.zpacloud.zpa_application_server_facts:
    provider: "{{ zpa_cloud }}"

- name: Gather Information Details of an Application Server by Name
  zscaler.zpacloud.zpa_application_server_facts:
    provider: "{{ zpa_cloud }}"
    name: server1.acme.com

- name: Gather Information Details of an Application Server by ID
  zscaler.zpacloud.zpa_application_server_facts:
    provider: "{{ zpa_cloud }}"
    id: "216196257331291921"

Return Values

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

Key

Description

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

servers

list / elements=dictionary

A list of dictionaries containing details about the specified Application Server(s).

Returned: always

address

string

The address of the Application Server.

Returned: success

Sample: "server1.acme.com"

config_space

string

The configuration space of the Application Server.

Returned: success

Sample: "DEFAULT"

creation_time

string

The timestamp when the Application Server was created.

Returned: success

Sample: "1724114751"

description

string

A description of the Application Server.

Returned: success

Sample: "server1.acme.com"

enabled

boolean

Indicates whether the Application Server is enabled.

Returned: success

Sample: true

id

string

The unique identifier of the Application Server.

Returned: success

Sample: "216199618143442003"

modified_by

string

The ID of the user who last modified the Application Server.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the Application Server was last modified.

Returned: success

Sample: "1724114751"

name

string

The name of the Application Server.

Returned: success

Sample: "server1.acme.com"

Authors

  • William Guilherme (@willguibr)