system.device

Operation: POST /dataservice/system/device

Create new device<br><br><br>Note: In a multitenant vManage system, this API is only available in the Provider view 123.

def create_device(payload: Optional[Any] = None) -> None: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.system.device.create_device()

Operation: GET /dataservice/system/device/{deviceCategory}

Get devices details. When {deviceCategory = controllers}, it returns vEdge sync status, vBond, vManage and vSmart. When {deviceCategory = vedges}, it returns all available vEdge routers

def get_devices_details(
    device_category: str,
    model: Optional[ModelParam] = None,
    state: Optional[List[CertificateStates]] = None,
    uuid: Optional[List[DeviceUuid]] = None,
    device_ip: Optional[List[DeviceIp]] = None,
    validity: Optional[List[CertificateValidity]] = None,
    family: Optional[FamilyParam] = None,
    site_id: Optional[int] = None,
    topology: Optional[TopologyParam] = None,
    tag: Optional[str] = None,
) -> Any: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.system.device.get_devices_details()

Operation: PUT /dataservice/system/device/{uuid}

Edit device

def edit_device(uuid: str, payload: Optional[Any] = None) -> None: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.system.device.edit_device()

Operation: DELETE /dataservice/system/device/{uuid}

Delete vEdges

def delete_device_1(uuid: str) -> DeleteDevice: ...

Example:

from catalyswan.core import create_client

url = "example.com"
username = "admin"
password = "password123"

with create_client(
    url=url, username=username, password=password
) as client:
    client.system.device.delete_device_1()