branch_connector_group¶

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

Methods are accessible via zpa.branch_connector_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 BranchConnectorGroupAPI¶

Bases: APIClient

A Client object for the Branch Connector Groups resource.

list_branch_connector_group_summary(query_params=None)¶

Retrieves all configured branch 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.

[query_params.microtenant_id] {str}: The unique identifier of the microtenant of ZPA tenant.

Returns:

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

Return type:

Tuple

Examples

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

list_branch_connector_groups(query_params=None)¶

Retrieves all configured branch connector groups