VRA ENDPOINT Commands


DescriptionCommand
Add vCloud endpoint     vra endpoint add vcloud
Add vsphere endpoint     vra endpoint add vsphere
Start datacollection on the specified endpoint     vra endpoint datacollection start
Get endpoints detail     vra endpoint detail
List endpoints optionally filtered by type     vra endpoint list
Remove endpoint     vra endpoint remove
Update endpoint     vra endpoint update


Add vCloud endpoint

vra endpoint add vcloud

Parameter--name (Enter endpoint name)
Mandatorytrue

Parameter--credential (Enter name or ID of Credential)
Mandatorytrue

Parameter--address (Enter address of vCloud endpoint)
Mandatorytrue

Parameter--organization (Enter organization of vCloud endpoint)
Mandatorytrue

Parameter--properties (Enter properties [name=value,name1=value1])
Mandatoryfalse

Parameter--description (Enter description)
Mandatoryfalse

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

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


Add vsphere endpoint

vra endpoint add vsphere

Parameter--name (Enter endpoint name)
Mandatorytrue

Parameter--credential (Enter name or ID of Credential)
Mandatorytrue

Parameter--address (Enter address of vSphere endpoint)
Mandatorytrue

Parameter--properties (Enter properties [name=value,name1=value1])
Mandatoryfalse

Parameter--vcnsaddress (Enter address of vCNS applicance)
Mandatoryfalse

Parameter--vcnscredentials (Enter credentials for vCNS applicance - Name or ID)
Mandatoryfalse

Parameter--description (Enter description)
Mandatoryfalse

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

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


Start datacollection on the specified endpoint

vra endpoint datacollection start

Parameter--endpointname (Provide a valid ID or name of a Cluster or Host)
Mandatorytrue

Parameter--waitforcompletion (Wait till datacollection is complete? [Yes or No])
Mandatorytrue

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

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


Get endpoints detail

vra endpoint detail

Parameter--id (Enter a valid Endpoint ID or name)
Mandatorytrue

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


List endpoints optionally filtered by type

vra endpoint list

Parameter--type (Type of endpoints to display, vSphere or vCloud. If option not provided displays all Endpoints)
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 endpoint

vra endpoint remove

Parameter--id (Enter an Endpoint ID or name to remove)
Mandatorytrue


Update endpoint

vra endpoint update

Parameter--id (Enter a valid Endpoint ID or name to be updated)
Mandatorytrue

Parameter--address (Enter new address for endpoint)
Mandatorytrue

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

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