Deploy Vcf Management Components
Triggers VCF Management Components deployment workflow
Triggers 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
COPY
Request Body
VcfManagementComponentsSpec
of type(s)
application/json
Required
{
"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.24597083"
},
"vcfOperationsCollectorSpec": {
"hostname": "vcf-operations-collector.rainpole.io",
"rootUserPassword": "string",
"applianceSize": "small",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"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",
"platformFqdn": "vsp-platform.rainpole.io",
"adminUserPassword": "string",
"ipPool": [
"['10.0.0.80', '10.0.0.81', '10.0.0.82', '10.0.0.83', '10.0.0.84', '10.0.0.85']"
],
"internalClusterCidr": "string",
"nodePrefix": "node-123",
"size": "small",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"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"
},
"licenseServerSpec": {
"hostname": "license-server.rainpole.io",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"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",
"ipv6Gateway": "string",
"ipv6Prefix": 0
},
"xRegionNetwork": {
"networkName": "string",
"subnetMask": "255.255.255.0",
"gateway": "10.0.0.250",
"ipv6Gateway": "string",
"ipv6Prefix": 0
}
},
"vcfManagementComponentsInfrastructureSpec": {
"localRegionNetwork": {
"networkName": "string",
"subnetMask": "255.255.255.0",
"gateway": "10.0.0.250",
"ipv6Gateway": "string",
"ipv6Prefix": 0
},
"xRegionNetwork": {
"networkName": "string",
"subnetMask": "255.255.255.0",
"gateway": "10.0.0.250",
"ipv6Gateway": "string",
"ipv6Prefix": 0
}
},
"vcfInstanceName": "string",
"existingDataStore": "string",
"workflowType": "One among: VCF, VCF_EXTEND",
"vspClusterSpec": {
"platformFqdn": "vsp-cluster.rainpole.io",
"systemUserPassword": "Broadcom1@!#$%?^*",
"ipv4Pool": {
"cidr": "10.0.0.0/24",
"ipRange": {
"startIpAddress": "192.168.0.123",
"endIpAddress": "192.168.0.128"
},
"addresses": [
"[\"10.0.0.80\", \"10.0.0.81\", \"10.0.0.82\", ...]"
],
"excludedAddresses": [
"[\"10.0.0.81\", ...]"
]
},
"ipv6Pool": {
"cidr": "2001:db8::00/112",
"ipRange": {
"startIpAddress": "::",
"endIpAddress": "2001:0db8:0000:0000:0000:ff00:0042:8329"
},
"addresses": [
"[\"2001:db8::80\", \"2001:db8::81\", \"2001:db8::82\", ...]"
],
"excludedAddresses": [
"[\"2001:db8::81\", ...]"
]
},
"size": "Small",
"internalClusterCidrIpv4": "198.18.0.0/15",
"internalClusterCidrIpv6": "fd00::/111",
"instanceFqdn": "instance.rainpole.io",
"fleetFqdn": "instance.rainpole.io",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"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"
},
"fleetLcmSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"sddcLcmSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"fleetDepotSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"telemetryAcceptorSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"vidbSpec": {
"hostname": "vidb.vcf.local",
"version": "9.0.0.0.24597083",
"size": "small"
},
"saltSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"saltRaasSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"skipGatewayPingValidation": false
}
object
vcfOperationsSpec
Optional
Specification for VCF Operations
object
vcfOperationsCollectorSpec
Optional
Specification for VCF Operations collector
object
vcfAutomationSpec
Optional
Specification for VCF Automation
object
licenseServerSpec
Optional
Specification for License Server
object
vcfMangementComponentsInfrastructureSpec
Optional
Specification for infrastructure to be used for VCF Management Components deployment
object
vcfManagementComponentsInfrastructureSpec
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
string
As (VCF|VCF_EXTEND|VCF_COMPLETE)
workflowType
Optional
Type of workflow to initiate creation and/or validation
object
vspClusterSpec
Optional
Specification VSP cluster deployment
object
fleetLcmSpec
Optional
Specification for deploy/configure of Fleet LCM service
object
sddcLcmSpec
Optional
Specification for deploy/configure of a SDDC LCM service
object
fleetDepotSpec
Optional
Specification for deploy/configure of Software Depot
object
telemetryAcceptorSpec
Optional
Specification for deploy/configure of Telemetry acceptor service
object
vidbSpec
Optional
Specification for VIDB
object
saltSpec
Optional
Specification for Salt services
object
saltRaasSpec
Optional
Specification for Salt services
boolean
skipGatewayPingValidation
Optional
Skip networks gateway connectivity validation
Responses
202
Accepted
Returns
Task
of type(s)
application/json
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}
string
id
Required
Task ID
string
name
Required
Task name
object
localizableDescriptionPack
Optional
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
type
Optional
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
string
status
Required
Task status
string
creationTimestamp
Required
Task creation timestamp
string
completionTimestamp
Optional
Task completion timestamp
array of
object
subTasks
Optional
List of sub-tasks of the task
array of
object
errors
Optional
List of errors in case of a failure
array of
object
resources
Optional
List of resources associated with task
string
resolutionStatus
Optional
Resolution state
boolean
isCancellable
Optional
Represents task can be cancellable or not.
boolean
isRetryable
Optional
Indicates whether a task is eligible for retry or not.
403
Forbidden
Returns
Task
of type(s)
application/json
{
"id": "string",
"name": "string",
"localizableDescriptionPack": {
"component": "string",
"messageKey": "string",
"arguments": [
"string"
],
"message": "string",
"bundle": "string"
},
"type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION",
"status": "One among: PENDING, Pending, IN_PROGRESS, In Progress, SUCCESSFUL, Successful, FAILED, Failed, CANCELLED, Cancelled, COMPLETED_WITH_WARNING, SKIPPED, QUEUED, TIMED_OUT, Queued, Timed Out",
"creationTimestamp": "string",
"completionTimestamp": "string",
"subTasks": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, SKIPPED, NOT_APPLICABLE",
"creationTimestamp": "string",
"completionTimestamp": "string",
"stages": [
{
"name": "string",
"type": "string",
"description": "string",
"status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
"creationTimestamp": "string",
"completionTimestamp": "string",
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
]
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"subTasks": [
"SubTask Object"
],
"documentationLink": {
"url": "string",
"label": "string"
}
}
],
"errors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"resources": [
{
"resourceId": "BE8A5E04-92A0-43F6-A166-AA041F4327CC",
"fqdn": "sfo-vc01.rainpole.io",
"type": "One among: SDDC_MANAGER, PSC, VCENTER, NSXT_MANAGER, NSX_ALB, ESXI, HCX_MANAGER, VSP",
"name": "string",
"sans": [
"sfo-vc01.rainpole.io"
]
}
],
"resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
"isCancellable": false,
"isRetryable": false
}
string
id
Required
Task ID
string
name
Required
Task name
object
localizableDescriptionPack
Optional
A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.
string
type
Optional
Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is
string
status
Required
Task status
string
creationTimestamp
Required
Task creation timestamp
string
completionTimestamp
Optional
Task completion timestamp
array of
object
subTasks
Optional
List of sub-tasks of the task
array of
object
errors
Optional
List of errors in case of a failure
array of
object
resources
Optional
List of resources associated with task
string
resolutionStatus
Optional
Resolution state
boolean
isCancellable
Optional
Represents task can be cancellable or not.
boolean
isRetryable
Optional
Indicates whether a task is eligible for retry or not.
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/v1/vcf-management-components
Vcf Management Components Operations
GET
Get Vcf Management Components
POST
Deploy Vcf Management Components
POST
Discover Vcf Ops
POST
Validate Vcf Management Components
POST
Resources Calculation
POST
Generate Password
GET
Get Vcf Management Components Validations By Id
GET
Get Vcf Management Components Tasks
GET
Get Vcf Management Components Task By ID
GET
Get Vcf Management Components Task Spec
GET
Get Vcf Management Components Latest Task