VRA REST Commands


DescriptionCommand
Invoke a DELETE http request     vra rest delete
Invoke a GET http request     vra rest get
Invoke a POST http request     vra rest post
Invoke a PUT http request     vra rest put


Invoke a DELETE http request

vra rest delete

Parameter--** default **
Parameter--service (Name of the Service hosting the URI. e.g. catalog-service)
Mandatorytrue

Parameter--uri (URI of resource. e.g. consumer/requests/{id})
Mandatorytrue

Parameter--headers (Show request and response headers)
Mandatoryfalse

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


Invoke a GET http request

vra rest get

Parameter--** default **
Parameter--service (Name of the Service hosting the URI. e.g. catalog-service)
Mandatorytrue

Parameter--uri (URI of resource. e.g. consumer/catalogItems)
Mandatorytrue

Parameter--headers (Show request and response headers)
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


Invoke a POST http request

vra rest post

Parameter--** default **
Parameter--service (Name of the Service hosting the URI. e.g. catalog-service)
Mandatorytrue

Parameter--uri (URI of resource. e.g. consumer/catalogItems)
Mandatorytrue

Parameter--headers (Show request and response headers)
Mandatoryfalse

Parameter--data (json data string or @filename)
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


Invoke a PUT http request

vra rest put

Parameter--** default **
Parameter--service (Name of the Service hosting the URI. e.g. catalog-service)
Mandatorytrue

Parameter--uri (URI of resource. e.g. consumer/catalogItems)
Mandatorytrue

Parameter--headers (Show request and response headers)
Mandatoryfalse

Parameter--data (json data string or @filename)
Mandatoryfalse

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


Copyright 2016 VMware, Inc. All rights reserved.