zscaler.zpacloud.zpa_service_edge_controller_info module – Retrieves a service edge controller information

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a service edge controller.

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 Service Edge Controller.

name

string

Name of the Service Edge Controller.

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: Retrieve All App Service Edge Controlles
  zscaler.zpacloud.zpa_service_edge_controller_info:
    provider: "{{ zpa_cloud }}"

- name: Retrieve Service Edge Controlle By Name
  zscaler.zpacloud.zpa_service_edge_controller_info:
    provider: "{{ zpa_cloud }}"
    name: 'SJC037_App_Connector'

- name: Retrieve Service Edge Controlle By ID
  zscaler.zpacloud.zpa_service_edge_controller_info:
    provider: "{{ zpa_cloud }}"
    name: '123456789'

Authors

  • William Guilherme (@willguibr)