Validate Vrslcm

Validate Vrslcm

Triggers VMware Aria Suite Lifecycle deployment specification validation workflow

Request
URI
POST
https://{api_host}/v1/vrslcms/validations
COPY
Request Body
VrslcmDeploymentSpec of type(s) application/json
Required 
{
    "fqdn": "vrslcm.vrack.vsphere.local",
    "sshPassword": "string",
    "apiPassword": "string",
    "nsxtStandaloneTier1Ip": "string"
}
string
fqdn
Required

Fully Qualified Domain Name

string
sshPassword
Required

The password for a root user of VMware Aria Suite Lifecycle appliance

string
apiPassword
Required

The password for an admin API/UI user of VMware Aria Suite Lifecycle

string
nsxtStandaloneTier1Ip
Required

The IP to use for deploying a new standalone Tier-1 router in NSX. This router will be used subsequently for VMware Aria load balancers.

Responses
202

Accepted

Returns Validation of type(s) application/json 
{
    "id": "string",
    "description": "string",
    "executionStatus": "COMPLETED",
    "resultStatus": "SUCCEEDED",
    "validationChecks": [
        {
            "description": "string",
            "severity": "One among: WARNING, ERROR, INFO",
            "resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS",
            "errorResponse": {
                "errorCode": "string",
                "errorType": "string",
                "arguments": [
                    "string"
                ],
                "context": {
                    "context": "string"
                },
                "message": "string",
                "remediationMessage": "string",
                "causes": [
                    {
                        "type": "string",
                        "message": "string"
                    }
                ],
                "nestedErrors": [
                    "Error Object"
                ],
                "referenceToken": "string"
            }
        }
    ],
    "additionalProperties": {
        "additionalProperties": "string"
    }
}
string
id
Required

ID of the validation

string
description
Required

Description of the validation

string
executionStatus
Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string
resultStatus
Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of ValidationCheck
validationChecks
Optional

List of one or more validation checks that are performed as part of the validation

object
additionalProperties
Optional

additionalProperties


400

Bad Request

Returns Error of type(s) application/json 
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
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 ErrorCause
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.


On This Page
Suite Lifecycle Operations
POST
Deploy Vrslcm
GET
Get Vrslcm
GET
Get Vrslcms
GET
Get Vrslcm Status
GET
Get Vrslcm Validation
DELETE
Rollback Vrslcm
PUT
Update Vrslcm Version By Id In Inventory
PUT
Update Vrslcm Version In Inventory
POST
Validate Vrslcm