zscaler.zpacloud.zpa_server_group module – Create a Server Group

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module create/update/delete a Server Group resource in the ZPA Cloud.

Requirements

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

Parameters

Parameter

Comments

app_connector_group_ids

list / elements=string

List of server_group-connector ID objects.

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

This field is the description of the server group.

dynamic_discovery

boolean

This field controls dynamic discovery of the servers.

Choices:

  • false

  • true ← (default)

enabled

boolean

This field defines if the server group is enabled or disabled.

Choices:

  • false

  • true ← (default)

id

string

name

string / required

This field defines the 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.

server_ids

list / elements=string

This field is a list of servers objects that are applicable only when dynamic discovery is disabled.

Server name is required only in cases where the new servers need to be created in this API. For existing servers, pass only the serverId.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete a Server Group - Dynamic Discovery On
  zscaler.zpacloud.zpa_server_group:
    provider: "{{ zpa_cloud }}"
    name: "Example"
    description: "Example"
    enabled: true
    dynamic_discovery: true
    app_connector_group_ids:
      - id: "216196257331291921"

- name: Create/Update/Delete a Server Group - Dynamic Discovery Off
  zscaler.zpacloud.zpa_server_group:
    provider: "{{ zpa_cloud }}"
    name: "Example"
    description: "Example"
    enabled: true
    dynamic_discovery: false
    app_connector_group_ids:
      - id: "216196257331291921"
    server_ids:
      - id: "216196257331291921"

Authors

  • William Guilherme (@willguibr)