tenant

Operation: GET /dataservice/tenant

Lists all the tenants on the vManage Note: In a multitenant vManage system, this API is only available in the Provider view.

def get_all_tenants(device_id: Optional[str] = None) -> List[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.tenant.get_all_tenants()

Operation: PUT /dataservice/tenant

Update tenants in Multi-Tenant vManage Note: In a multitenant vManage system, this API is only available in the Provider view.

def update_tenant_bulk(payload: Optional[Any] = 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.tenant.update_tenant_bulk()

Operation: POST /dataservice/tenant

Deprecated!!!

Create a new tenant in Multi-Tenant vManage Note: In a multitenant vManage system, this API is only available in the Provider view.

def create_tenant(payload: Optional[Any] = 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.tenant.create_tenant()

Operation: GET /dataservice/tenant/{tenantId}

Get a tenant by Id Note: In a multitenant vManage system, this API is only available in the Provider view.

def get_tenant(tenant_id: str) -> 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.tenant.get_tenant()

Operation: PUT /dataservice/tenant/{tenantId}

Update a tenant in Multi-Tenant vManage Note: In a multitenant vManage system, this API is only available in the Provider view.

def update_tenant(
    tenant_id: str, payload: Optional[Any] = 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.tenant.update_tenant()