Initiate Quick Start

Initiate Quick Start

Initiates quick start. This can only be run once, if something fails, no rollback is attempted. The following prerequisites are required.

  1. A supervisor and its associated NSX manager are present in Tenant Manager
  2. No region or organization exists in Tenant Manager

Quick start will do the following with sensible defaults.

  1. Create a region
  2. Rename the provider default org to the specified name
  3. Configure regional networking settings
  4. Create a default Virtual Data Center
  5. Create a default Namespace
Request
URI
POST
https://{api_host}/cloudapi/vcf/systemOverview/quickStart
COPY
Query Parameters
boolean
force
Optional

Indicate if quick start should be forced, which allows quick start to be run regardless of system state


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

Show optional properties

{
    "regionName": "string",
    "supervisorRef": {},
    "storagePolicyNames": [
        {}
    ]
}
{
    "orgName": "string",
    "regionName": "string",
    "supervisorRef": {
        "name": "string",
        "id": "string"
    },
    "storagePolicyNames": [
        "string"
    ]
}
string
orgName
Optional
Constraints: maxLength: 128

If specified, quick start will rename the default provider tenant organization. It must follow RFC 1123 Label Names to conform with Kubernetes standards.

string
regionName
Required
Constraints: maxLength: 63

The name of the initial region to create. It must follow RFC 1123 Label Names to conform with Kubernetes standards.

object
supervisorRef
Required

Entity reference used to describe VCD entities

array of string
storagePolicyNames
Required

A list of distinct vCenter storage policy names from the vCenters taking part in this region. A storage policy with the given name must exist in all the vCenters of this region otherwise it will not be accepted. Only the storage policies added to a region can be published to the tenant Virtual Datacenters.

Authentication
This operation uses the following authentication methods.
Responses
202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"regionName:"string","storagePolicyNames":["string"],"supervisorRef:"object"}' https://{api_host}/cloudapi/vcf/systemOverview/quickStart