private_cloud_group¶

The following methods allow for interaction with the Private Cloud Controller Groups API endpoints.

Methods are accessible via zpa.private_cloud_group

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class PrivateCloudGroupAPI¶

Bases: APIClient

A Client object for the Private Cloud Group resource.

add_cloud_group(**kwargs)¶

Adds a new ZPA App Private Cloud Group.

Parameters:

name (str) – The name of the App Private Cloud Group.
latitude (int) – The latitude representing the App Connector’s physical location.
location (str) – The name of the location that the App Private Cloud Group represents.
longitude (int) – The longitude representing the App Connector’s physical location.

Keyword Arguments:

**city_country (str) –
The City and Country for where the App Connectors are located. Format is:

<City>, <Country Code> e.g. Sydney, AU
**country_code (str) – The ISO<std> Country Code that represents the country where the App Connectors are located.
**description (str) – Additional information about the App Private Cloud Group.
**enabled (bool) – Is the App Private Cloud Group enabled? Defaults to True.
**override_version_profile (bool) – Override the local App Connector version according to version_profile_id. Defaults to False.
**upgrade_day (str) – The day of the week that upgrades will be pushed to the App Connector.
**upgrade_time_in_secs (str) – The time of the day that upgrades will be pushed to the App Connector.
**version_profile_id (str) – The version profile ID to use. This will automatically set override_version_profile to True.
**microtenant_id (str) – The unique identifier of the microtenant of ZPA tenant.
**site (list) – List of site configurations associated with this Private Cloud Group.
**site_id (str) – The unique identifier of the site associated with this Private Cloud Group.

Returns:

A tuple containing (PrivateCloudGroup, Response, error)

Return type:

Tuple

Examples

>>> added_group, _, err = client.zpa.private_cloud_group.add_cloud_group(
...     name=f"NewPrivateCloudGroup_{random.randint(1000, 10000)}",
...     description=f"NewPrivateCloudGroup_{random.randint(1000, 10000)}",
...     enabled=True,
...     city_country="San Jose, US",
...     country_code="US",
...     latitude="37.3382082",
...     longitude="-121.8863286",
...     location="San Jose, CA, USA",
...     upgrade_day="SUNDAY",
...     site_id="72058304855088543",
...     site=[
...         {
...             "id": "72058304855088543",
...             "privateBrokerGroupIds": [
...                 {
...                     "id": "72058304855063609"
...                 }
...             ],
...         }
...     ]
... )
... if err:
...     print(f"Error adding private cloud group: {err}")
...     return
... print(f"private cloud group added successfully: {added_group.as_dict()}")

delete_cloud_group(group_id, microtenant_id=None)¶

Deletes the specified App Private Cloud Group from ZPA.

Parameters:

group_id (str) – The unique identifier for the App Private Cloud Group.
microtenant_id (str, optional) – The optional ID of the microtenant if applicable.

Returns:

A tuple containing the response and error (if any).

Return type:

tuple

Examples

>>> _, _, err = client.zpa.private_cloud_group.delete_cloud_group(
...     group_id='999999'
... )
... if err:
...     print(f"Error deleting app Private Cloud Group: {err}")
...     return
... print(f"app Private Cloud Group with ID {'999999'} deleted successfully.")

get_cloud_group(group_id, query_params=None)¶

Fetches a specific Private Cloud Group by ID.

Parameters:

group_id (str) – The unique identifier for the Private Cloud Group.
query_params (dict, optional) – Map of query parameters for the request. [query_params.microtenant_id] {str}: The microtenant ID, if applicable.

Returns:

A tuple containing (AppConnectorGroup instance, Response, error).

Return type:

Tuple

Examples

>>> fetched_group, _, err = client.zpa.private_cloud_group.get_cloud_group('999999')
... if err:
...     print(f"Error fetching group by ID: {err}")
...     return
... print(f"Fetched group by ID: {fetched_group.as_dict()}")

list_cloud_groups(query_params=None)¶

Enumerates Private Cloud Groups in your organization with pagination. A subset of Private Cloud Groups can be returned that match a supported filter expression or query.

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.page] {str}: Specifies the page number.

[query_params.page_size] {str}: Specifies the page size.: If not provided, the default page size is 20. The max page size is 500.

[query_params.search] {str}: Search string for filtering results. [query_params.microtenant_id] {str}: The unique identifier of the microtenant of ZPA tenant.

Returns:

A tuple containing (list of AppConnectorGroup instances, Response, error)

Return type:

Tuple

Examples

>>> group_list, _, err = client.zpa.private_cloud_group.list_cloud_groups(
... query_params={'search': 'ConnectorGRP01', 'page': '1', 'page_size': '100'})
... if err:
...     print(f"Error listing app Private Cloud Group: {err}")
...     return
... print(f"Total app Private Cloud Groups found: {len(group_list)}")
... for group in groups:
...     print(group.as_dict())

list_private_cloud_group_summary(query_params=None)¶

Returns the name and ID of the configured Private Cloud Group.

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.page] {str}: Specifies the page number.

[query_params.page_size] {str}: Specifies the page size.: If not provided, the default page size is 20. The max page size is 500.

[query_params.search] {str}: Search string for filtering results. [query_params.microtenant_id] {str}: The unique identifier of the microtenant of ZPA tenant.

Returns:

PrivateCloudGroup: The resource record for the microtenant.

Return type:

Tuple

Examples

>>> group_list, err = client.zpa.private_cloud_group.get_private_cloud_group_summary()
... if err:
...     print(f"Error listing groups: {err}")
...     return
... print(f"Total groups found: {len(group_list)}")
... for group in group_list:
...     print(group.as_dict())

update_cloud_group(group_id, **kwargs)¶

Updates an existing ZPA App Private Cloud Group.

Parameters:

group_id (str) – The unique id for the App Private Cloud Group in ZPA.

Keyword Arguments:

**city_country (str) –
The City and Country for where the App Connectors are located. Format is:

<City>, <Country Code> e.g. Sydney, AU
**country_code (str) – The ISO<std> Country Code that represents the country where the App Connectors are located.
**description (str) – Additional information about the App Private Cloud Group.
**enabled (bool) – Is the App Private Cloud Group enabled? Defaults to True.
**name (str) – The name of the App Private Cloud Group.
**latitude (int) – The latitude representing the App Connector’s physical location.
**location (str) – The name of the location that the App Private Cloud Group represents.
**longitude (int) – The longitude representing the App Connector’s physical location.
**override_version_profile (bool) – Override the local App Connector version according to version_profile_id. Defaults to False.
**upgrade_day (str) – The day of the week that upgrades will be pushed to the App Connector.
**upgrade_time_in_secs (str) – The time of the day that upgrades will be pushed to the App Connector.
**version_profile_id (str) – The version profile ID to use. This will automatically set override_version_profile to True.
**microtenant_id (str) – The unique identifier of the microtenant of ZPA tenant.
**site (list) – List of site configurations associated with this Private Cloud Group.
**site_id (str) – The unique identifier of the site associated with this Private Cloud Group.

Returns:

A tuple containing (PrivateCloudGroup, Response, error)

Return type:

tuple

Examples

>>> update_group, _, err = client.zpa.private_cloud_group.update_cloud_group(
...     group_id="999999",
...     name=f"UpdatePrivateCloudGroup_{random.randint(1000, 10000)}",
...     description=f"UpdatePrivateCloudGroup_{random.randint(1000, 10000)}",
...     enabled=True,
...     city_country="San Jose, US",
...     country_code="US",
...     latitude="37.3382082",
...     longitude="-121.8863286",
...     location="San Jose, CA, USA",
...     upgrade_day="SUNDAY",
...     site_id="72058304855088543",
...     site=[
...         {
...             "id": "72058304855088543",
...             "privateBrokerGroupIds": [
...                 {
...                     "id": "72058304855063609"
...                 }
...             ],
...         }
...     ]
... )
... if err:
...     print(f"Error updating private cloud group: {err}")
...     return
... print(f"private cloud group updated successfully: {update_group.as_dict()}")