zscaler.zpacloud.zpa_service_edge_controller module – Manages Service Edge Controllers 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_service_edge_controller.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module Update/delete an Service Edge Controller in the ZPA Cloud.

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.

description

string

The description of the Service Edge Controller

enabled

boolean

Whether this Service Edge Controller is enabled or not.

Choices:

  • false

  • true

id

string

The unique identifier of the Service Edge Controller.

ids

list / elements=string

The unique identifiers of the bulk delete resources.

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.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Check mode is supported.

Examples

- name: Gather information about all Service Edges
  zscaler.zpacloud.zpa_service_edge_controller_info:
  register: result

- name: Extract Service Edge Controller IDs
  set_fact:
    service_edge_ids: "{{ result.pses | map(attribute='id') | list }}"

- name: Bulk delete Service Edge Controllers
  zscaler.zpacloud.zpa_service_edge_controller:
    ids: "{{ service_edge_ids }}"

- name: Update Service Edge Controller Description
  zscaler.zpacloud.zpa_service_edge_controller:
    name: 'ServiceEdgeController01'
    description: 'Update Service Edge Controller 01'
  register: result

Authors

  • William Guilherme (@willguibr)