Product Documentation

tenant

Jun 02, 2016

Tenant on SDX Platform

show tenant

Use this operation to get tenants.

Synopsys

show tenant [id=<string>]

Parameters

id

Id is system generated key for all the Tenants

delete tenant

Use this operation to delete a tenant.

Synopsys

delete tenant id=<string>

Parameters

id

Id is system generated key for all the Tenants

This is a mandatory parameter.

set tenant

Use this operation to modify a tenant.

Synopsys

set tenant id=<string> [user_name=<string>] [system_resource=<tenant_system_resource>] [auth_servers=<tenant_auth_server...>] [name=<string>] [company_info=<tenant_company_info>] [password=<stringx>] [network_pools=<tenant_network_pool...>] [parent_id=<string>]

Parameters

id

Id is system generated key for all the Tenants

This is a mandatory parameter.

user_name

User Name for tenant

system_resource

Tenant System Resource

auth_servers

Tenant Authentication Servers

name

Name of the Tenant

company_info

Tenant Company Information

password

Password

network_pools

Tenant Network Pools

parent_id

Tenant ID of the parent Tenant.

add tenant

Use this operation to add a tenant.

Synopsys

add tenant user_name=<string> password=<stringx> parent_id=<string> [system_resource=<tenant_system_resource>] [auth_servers=<tenant_auth_server...>] [name=<string>] [company_info=<tenant_company_info>] [network_pools=<tenant_network_pool...>]

Parameters

user_name

User Name for tenant

This is a mandatory parameter.

password

Password

This is a mandatory parameter.

parent_id

Tenant ID of the parent Tenant.

This is a mandatory parameter.

system_resource

Tenant System Resource

auth_servers

Tenant Authentication Servers

name

Name of the Tenant

company_info

Tenant Company Information

network_pools

Tenant Network Pools