cloud_connector_groups¶

The following methods allow for interaction with the ZPA Cloud Connector Groups API endpoints.

Methods are accessible via zpa.cloud_connector_groups

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 CloudConnectorGroupsAPI¶

Bases: APIClient

A Client object for the Cloud Connector Groups resource.

get_cloud_connector_groups(group_id)¶

Returns information on the specified cloud connector group.

Parameters:

group_id (str) – The unique identifier for the cloud connector group.
query_params (dict) – Optional query parameters.

Returns:

The cloud connector group object.

Return type:

dict

Examples

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

list_cloud_connector_group_summary(query_params=None)¶

Retrieves all configured cloud connector groups Name and IDs

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

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

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

[query_params.search] {str}: The search string used to support search by features and fields for the API.

Returns:

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

Return type:

Tuple

Examples

>>> group_list, _, err = client.zpa.cloud_connector_groups.list_cloud_connector_group_summary(
... query_params={'search': 'Group01', 'page': '1', 'page_size': '100'})
... if err:
...     print(f"Error listing cloud connector groups: {err}")
...     return
... print(f"Total cloud connector groups found: {len(group_list)}")
... for group in group_list:
...     print(group.as_dict())

list_cloud_connector_groups(query_params=None)¶

Returns a list of all configured cloud connector groups.

Keyword Arguments:

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

Returns:

A list of CloudConnectorGroup instances.

Return type:

list

Examples

>>> group_list, _, err = client.zpa.cloud_connector_groups.list_cloud_connector_groups(
... query_params={'search': 'CloudConnectorGroup01', 'page': '1', 'page_size': '100'})
... if err:
...     print(f"Error listing connector groups: {err}")
...     return
... print(f"Total connector groups found: {len(group_list)}")
... for group in group_list:
...     print(group.as_dict())