Validate Vcf Management Components

Validate Vcf Management Components

Validates the input spec to VCF Management Components deployment workflow from SDDC Manager and returns a URL in the headers to track the operation status

Request
URI
POST
https://{api_host}/v1/vcf-management-components/validations
COPY
Query Parameters
boolean
redo
Optional
Constraints: default: true

redo


Request Body
VcfManagementComponentsSpec of type(s) application/json
Required

Show optional properties

{
    "vcfOperationsCollectorSpec": {
        "hostname": "vcf-operations-collector.rainpole.io"
    }
}
{
    "vcfOperationsFleetManagementSpec": {
        "hostname": "vcf-operations-fleet-management.rainpole.io",
        "rootUserPassword": "string",
        "adminUserPassword": "string",
        "useExistingDeployment": true,
        "version": "9.0.0.0",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfOperationsSpec": {
        "nodes": [
            {
                "hostname": "vcfoperations-master.rainpole.io",
                "rootUserPassword": "string",
                "type": "master",
                "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
            }
        ],
        "adminUserPassword": "string",
        "applianceSize": "medium",
        "loadBalancerFqdn": "string",
        "useExistingDeployment": true,
        "version": "9.0.0.0"
    },
    "vcfOperationsCollectorSpec": {
        "hostname": "vcf-operations-collector.rainpole.io",
        "rootUserPassword": "string",
        "applianceSize": "small",
        "useExistingDeployment": true,
        "version": "9.0.0.0",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfAutomationSpec": {
        "hostname": "vcfautomation.rainpole.io",
        "adminUserPassword": "string",
        "ipPool": [
            "['10.0.0.80', '10.0.0.81']"
        ],
        "internalClusterCidr": "100.64.0.0/15",
        "nodePrefix": "node-123",
        "useExistingDeployment": true,
        "version": "9.0.0.0",
        "sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
    },
    "vcfMangementComponentsInfrastructureSpec": {
        "localRegionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        },
        "xRegionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        },
        "xregionNetwork": {
            "networkName": "string",
            "subnetMask": "255.255.255.0",
            "gateway": "10.0.0.250"
        }
    },
    "vcfInstanceName": "string",
    "existingDataStore": "string"
}
object
vcfOperationsFleetManagementSpec
Optional

Specification for VCF Operations fleet management

object
vcfOperationsSpec
Optional

Specification for VCF Operations

object
vcfOperationsCollectorSpec
Required

Specification for VCF Operations collector

object
vcfAutomationSpec
Optional

Specification for VCF Automation

object
vcfMangementComponentsInfrastructureSpec
Optional

Specification for infrastructure to be used for VCF Management Components deployment

string
vcfInstanceName
Optional

Specification for VCF Instance Name

string
existingDataStore
Optional

Existing data store for VCF Operations Fleet management deployment

Responses
200

Success

Returns Validation of type(s) application/json
"Validation Object"
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 object
validationChecks
Optional

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

object
additionalProperties
Optional

additionalProperties


202

Accepted

Returns Validation of type(s) application/json
"Validation Object"
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 object
validationChecks
Optional

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

object
additionalProperties
Optional

additionalProperties


403

Forbidden

Returns Validation of type(s) application/json
"Validation Object"
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 object
validationChecks
Optional

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

object
additionalProperties
Optional

additionalProperties


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.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


500

Internal Server Error

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.

string
label
Optional

The localized label message

string
remediationUrl
Optional

The URL string for remediation documentation link


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"vcfOperationsCollectorSpec:"object"}' https://{api_host}/v1/vcf-management-components/validations