VRA TENANT Commands


DescriptionCommand
Add New Tenant     vra tenant add
List Tenant/Infrastructure Admins     vra tenant admin list
Update Tenant/Infrastructure Admins     vra tenant admin update
Add New Tenant Identity store. Requires vRA system administrator login and supports only Active Directory (AD).     vra tenant identitystore add
List Tenant Identity store     vra tenant identitystore list
Remove Tenant Identity store     vra tenant identitystore remove
List Tenants     vra tenant list
Vra tenant remove     vra tenant remove


Add New Tenant

vra tenant add

Parameter--name (Enter Name of the Tenant to add)
Mandatorytrue

Parameter--url (Enter Tenant Url)
Mandatorytrue

Parameter--description (Enter Description)
Mandatoryfalse

Parameter--email (Enter Email Address)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


List Tenant/Infrastructure Admins

vra tenant admin list

Parameter--tenantname (Enter a valid Tenant Name)
Mandatoryfalse

Parameter--role (Enter a valid Admin Role. Select from [ALL, APPROVAL_ADMIN, IAAS_ADMIN, SERVICE_ARCHITECT, TENANT_ADMIN]. If unspecified, default will be considered ALL)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Update Tenant/Infrastructure Admins

vra tenant admin update

Parameter--tenantname (Provide a valid Tenant Name to be updated)
Mandatorytrue

Parameter--role (Provide a valid role. Select from [ALL, APPROVAL_ADMIN, IAAS_ADMIN, SERVICE_ARCHITECT, TENANT_ADMIN])
Mandatorytrue

Parameter--action (Action to be performed - ADD / REMOVE)
Mandatorytrue

Parameter--users (Comma separated list of users)
Mandatorytrue


Add New Tenant Identity store. Requires vRA system administrator login and supports only Active Directory (AD).

vra tenant identitystore add

Parameter--tenantname (Enter Tenant Name)
Mandatoryfalse

Parameter--name (Enter Identity store Name)
Mandatorytrue

Parameter--url (Enter AD or LDAP Server Url and port number)
Mandatorytrue

Parameter--groupbasedn (Enter a Group Search Base DN)
Mandatorytrue

Parameter--domain (Enter Domain)
Mandatorytrue

Parameter--userdn (Enter User DN)
Mandatorytrue

Parameter--password (Enter Password)
Mandatorytrue

Parameter--type (Enter IdentityStoreType LDAP/AD. Only AD is suported.)
Mandatorytrue

Parameter--userbasedn (Enter User Search Base DN)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


List Tenant Identity store

vra tenant identitystore list

Parameter--tenantname (Provide a valid Tenant Name)
Mandatoryfalse

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25))
Mandatoryfalse


Remove Tenant Identity store

vra tenant identitystore remove

Parameter--tenantname (Enter a valid Tenant Name to be deleted)
Mandatorytrue

Parameter--identitystore (Enter a valid relevant Identity Store Name)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


List Tenants

vra tenant list

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse

Parameter--columns (Customized columns to include in TABLE or CSV rendering. Regex allowed. Eg: p1,p2,collectionA:c3,collectionA:c4)
Mandatoryfalse

Parameter--page (Enter page number to display in pagination (default 1))
Mandatoryfalse

Parameter--pageSize (Enter page size to display in pagination (default 25))
Mandatoryfalse


Vra tenant remove

vra tenant remove

Parameter--tenantname (Provide a valid Tenant urlName or id to be removed)
Mandatorytrue

Parameter--export (Provide a file to export all results)
Mandatoryfalse

Parameter--format (Supported formats include: TABLE, JSON, CSV)
Mandatoryfalse


Copyright 2016 VMware, Inc. All rights reserved.