machine_groups¶

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

Methods are accessible via zpa.machine_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 MachineGroupsAPI¶

Bases: APIClient

A Client object for the Machine Groups resource.

get_group(group_id, query_params=None)¶

Fetches information on the specified machine group.

Parameters:

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

Returns:

The machine group object.

Return type:

dict

Examples

>>> fetched_group, _, err = client.zpa.machine_groups.get_group('999999')
... if err:
...     print(f"Error fetching machine group by ID: {err}")
...     return
... print(fetched_group.id)

list_machine_group_summary(query_params=None)¶

Retrieves all configured machine 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 MachineGroup instances, Response, error)

Return type:

Tuple

Examples

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

list_machine_groups(query_params=None)¶

Enumerates machine groups in your organization with pagination. A subset of machine 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] {int}: Page size for pagination. [query_params.search] {str}: Search string for filtering results. [query_params.microtenant_id] {str}: ID of the microtenant, if applicable.
Returns:: A tuple containing (list of MachineGroup instances, Response, error)
Return type:: tuple

Examples

Retrieve machine groups with pagination parameters:

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