zscaler.zpacloud.zpa_service_edge_groups module – Create an Service Edge Group 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_groups.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module creates/update/delete an Service Edge Group in the ZPA Cloud.

Requirements

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

Parameters

Parameter

Comments

city_country

string

City Country of the Service Edge Group.

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"

country_code

string

Country code of the Service Edge Group.

customer_id

string

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

description

string

Description of the Service Edge Group.

enabled

boolean

Whether this Service Edge Group is enabled or not.

Choices:

  • false

  • true

grace_distance_enabled

boolean

If enabled, allows ZPA Private Service Edge Groups within the specified distance to be prioritized over a closer ZPA Public Service Edge.

Choices:

  • false ← (default)

  • true

grace_distance_value

string

Indicates the maximum distance in miles or kilometers to ZPA Private Service Edge groups that would override a ZPA Public Service Edge.

grace_distance_value_unit

string

Indicates the grace distance unit of measure in miles or kilometers.

This value is only required if graceDistanceEnabled is set to true.

Choices:

  • "MILES"

  • "KMS"

id

string

The unique identifier of the ZPA Private Service Edge Group.

is_public

boolean

Whether or not the ZPA Private Service Edge Group is public.

Choices:

  • false

  • true

latitude

string

Latitude of the Service Edge Group. Integer or decimal. With values in the range of -90 to 90.

location

string

Location of the Service Edge Group.

longitude

string

Longitude of the Service Edge Group. Integer or decimal. With values in the range of -180 to 180.

name

string / required

Name of the Service Edge Group.

override_version_profile

boolean

Service Edge Group in this group will attempt to update to a newer version of the software during this specified time.

Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals.

Choices:

  • false

  • true

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"

trusted_networks_ids

list / elements=string

The list of trusted networks in the ZPA Private Service Edge Group.

upgrade_day

string

Service Edge Group in this group will attempt to update to a newer version of the software during this specified day.

List of valid days (i.e., Sunday, Monday).

Choices:

  • "MONDAY"

  • "TUESDAY"

  • "WEDNESDAY"

  • "THURSDAY"

  • "FRIDAY"

  • "SATURDAY"

  • "SUNDAY" ← (default)

upgrade_time_in_secs

string

Service Edge Group in this group will attempt to update to a newer version of the software during this specified time.

Integer in seconds (i.e., -66600). The integer should be greater than or equal to 0 and less than 86400, in 15 minute intervals.

Default: "66600"

use_in_dr_mode

boolean

Whether or not the Service Edge Group is designated for disaster recovery.

Choices:

  • false

  • true

version_profile_id

string

ID of the version profile. To learn more, see Version Profile Use Cases.

This value is required, if the value for overrideVersionProfile is set to true.

Choices:

  • "0" ← (default)

  • "1"

  • "2"

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete an Service Edge Group
  zscaler.zpacloud.zpa_service_edge_groups:
    provider: "{{ zpa_cloud }}"
    name: "Example"
    description: "Example2"
    enabled: true
    is_public: true
    city_country: "California, US"
    country_code: "US"
    latitude: "37.3382082"
    longitude: "-121.8863286"
    location: "San Jose, CA, USA"
    upgrade_day: "SUNDAY"
    upgrade_time_in_secs: "66600"
    override_version_profile: true
    version_profile_id: "0"

Authors

  • William Guilherme (@willguibr)