connectors

The following methods allow for interaction with the ZCON Connectors API endpoints.

Methods are accessible via zcon.connectors

class ZCONConnectorsAPI

delete_vm(group_id, vm_id)

Delete the specified connector VM.

Parameters:

• group_id (str) – The ID of the connector group.

• vm_id (str) – The ID of the connector VM.

Returns:

The status of the operation.

Return type:

Box

Examples

Delete a specific connector VM:

zcon.connectors.delete_vm("123456789", "987654321")

get_group(group_id)

Get details for a specific connector group.

Parameters:

group_id (str) – The ID of the connector group.

Returns:

The connector group details.

Return type:

Box

Examples

Get details of a specific connector group:

print(zcon.connectors.get_group("123456789"))

get_vm(group_id, vm_id)

Get details for a specific connector VM.

Parameters:

• group_id (str) – The ID of the connector group.

• vm_id (str) – The ID of the connector VM.

Returns:

The connector VM details.

Return type:

Box

Examples

Get details of a specific connector VM:

print(zcon.connectors.get_vm("123456789", "987654321"))

list_groups(**kwargs)

List all existing connector groups.

Keyword Arguments:

• page (int) – The page number to return.

• page_size (int) – The number of items to return per page.

Returns:

The list of cloud and branch connector groups.

Return type:

BoxList

Examples

List all connector groups:

for group in zcon.connectors.list_groups():
    print(group)

List first page of connector groups with 10 items per page:

for group in zcon.connectors.list_groups(page=1, page_size=10):
    print(group)