Get Vrslcm Status

Get Vrslcm Status

Get status on the VMware Aria Suite Lifecycle product and availability of different actions.

Request
URI
GET
https://{api_host}/v1/vrslcm/status
COPY
Responses
200

Ok

Returns VrslcmStatus of type(s) application/json 
{
    "state": "One among: NOT_DEPLOYED, ACTIVE, ERROR",
    "operations": [
        {
            "name": "string",
            "operationState": "One among: IN_PROGRESS, AVAILABLE, NOT_AVAILABLE, ERROR",
            "errorCode": "One among: VRSLCM_NOT_DEPLOYED, VRSLCM_UPGRADE_FAILED, VRSLCM_FAILED, AVN_NOT_CREATED, NSXT_MANAGER_NOT_AVAILABLE, BUNDLE_DOWNLOAD",
            "message": "string"
        }
    ]
}
string
state
Required

The overall status of the VMware Aria Suite Lifecycle deployment

array of object
operations
Optional

A list that represent the states of the executable operations in SDDC Manager (i.e. 'deploy' and 'rollback').


404

Not Found

Returns Error of type(s) application/json 
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/vrslcm/status
On This Page
Suite Lifecycle Operations
PUT
Update Vrslcm Version By Id In Inventory
GET
Get Vrslcm
PUT
Update Vrslcm Version In Inventory
DELETE
Rollback Vrslcm
GET
Get Vrslcms
POST
Deploy Vrslcm
POST
Validate Vrslcm
GET
Get Vrslcm Validation
GET
Get Vrslcm Status