Deploy Vcf Management Components

Deploy Vcf Management Components

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

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
202

Accepted

Returns Task of type(s) application/json
"Task Object"
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
"Task Object"
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 '{"vcfOperationsCollectorSpec:"object"}' https://{api_host}/v1/vcf-management-components