REST API - create

vcenter cluster: create

Create a new cluster in the vCenter inventory. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/cluster

Request Body Structure:

{
    "spec"{
        "parent""obj-103",
        "name""string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec create_spec Specification for the new cluster to be created.
spec.name string The name of the cluster to be created. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

spec.parent string Identifier of the folder in which the new cluster is to be created. The folder must support vSphere compute resource as child entity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

Response:

HTTP Status Code: 200

Representation:

{
    "value""obj-103"
}

Response Type:

Name Type Description
bold = required
value string The identifier of the newly created cluster.

Errors:

HTTP Status Code Type Description
400 already_exists if the cluster with the same name is already present.
400 invalid_argument if the cluster name is empty or invalid as per the underlying implementation.
400 invalid_element_type if the parent folder does not support vSphere compute resource as its children type.
401 unauthenticated if the session id is missing from the request or the corresponding session object cannot be found.
403 unauthorized if the user doesn't not have the required privileges.