machine_groups#

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

Methods are accessible via zpa.machine_groups

class MachineGroupsAPI#
get_group(group_id)#

Returns information on the specified machine group.

Parameters:

group_id (str) – The unique identifier for the machine group.

Returns:

The resource record for the machine group.

Return type:

Box

Examples

>>> pprint(zpa.machine_groups.get_group('99999'))
list_groups(**kwargs)#

Returns a list of all configured machine groups.

Keyword Arguments:

  • **max_items (int) – The maximum number of items to request before stopping iteration.

  • **max_pages (int) – The maximum number of pages to request before stopping iteration.

  • **pagesize (int) – Specifies the page size. The default size is 20, but the maximum size is 500.

  • **search (str, optional) – The search string used to match against features and fields.

Returns:

A list of all configured machine groups.

Return type:

list

Examples

>>> for machine_group in zpa.machine_groups.list_groups():
...    pprint(machine_group)