Skip to main content

ServerGroup

Server Group resource for Zscaler Private Access.

Resource operations

This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.

Quick Start​

import zssdk
import logging

# Enable debug logging for ServerGroup
logging.getLogger('zssdk.zpa').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)

session = zssdk.Session(
    vanity_domain="your-vanity-domain",
    client_id="your-client-id",
    client_secret="your-client-secret",
)

# Get a specific ServerGroup
resource = session.zpa.ServerGroup(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

create()​

Creates a new ServerGroup. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

NameTypeRequiredDescription
customer_idlongNo-
microtenant_idlongNo-
microtenant_namestringNo-
restriction_typestringNo-
enabledbooleanNo-
namestringYes-
dynamic_discoverybooleanNo-
descriptionstringNo-
app_connector_groupsAppConnectorGroupWrapperCollectionNo-
applicationsNameIdWrapperCollectionNo-
ip_anchoredbooleanNo-
config_spacestringYes-
inconsistent_config_detailsInconsistentConfigDetailsNo-
extranet_DTOExtranetNo-
extranet_enabledbooleanNo-
serversApplicationServerWrapperCollectionNo-
read_onlybooleanNo-
zscaler_managedbooleanNo-

Example:

resource = session.zpa.ServerGroup()
resource.name = "example-name"
resource.config_space = "value"
resource.create()
print(f"Created with ID: {resource.id}")

delete()​

Deletes a ServerGroup by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zpa.ServerGroup(id="your-resource-id")
resource.delete()

load()​

Fetches an existing ServerGroup by id. Only the id identifier is required; load() takes no other arguments.

Returns: ServerGroup

Example:

resource = session.zpa.ServerGroup(id="your-resource-id")
resource.load()
print(resource.name)

update()​

Updates an existing ServerGroup. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

NameTypeRequiredDescription
customer_idlongNo-
microtenant_idlongNo-
microtenant_namestringNo-
restriction_typestringNo-
enabledbooleanNo-
namestringYes-
dynamic_discoverybooleanNo-
descriptionstringNo-
app_connector_groupsAppConnectorGroupWrapperCollectionNo-
applicationsNameIdWrapperCollectionNo-
ip_anchoredbooleanNo-
config_spacestringYes-
inconsistent_config_detailsInconsistentConfigDetailsNo-
extranet_DTOExtranetNo-
extranet_enabledbooleanNo-
serversApplicationServerWrapperCollectionNo-
read_onlybooleanNo-
zscaler_managedbooleanNo-

Example:

resource = session.zpa.ServerGroup(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
modified_timeintegerNo-
creation_timeintegerNo-
modified_bystringNo-
idstringNo-
microtenant_idlongNo-
microtenant_namestringNo-
restriction_typestringNo-
enabledbooleanNo-
namestringYes-
dynamic_discoverybooleanNo-
descriptionstringNo-
app_connector_groupsAppConnectorGroupWrapperCollectionNo-
applicationsNameIdWrapperCollectionNo-
ip_anchoredbooleanNo-
config_spacestringYes-
inconsistent_config_detailsInconsistentConfigDetailsNo-
extranet_DTOExtranetNo-
extranet_enabledbooleanNo-
serversApplicationServerWrapperCollectionNo-
read_onlybooleanNo-
zscaler_managedbooleanNo-