Create Cluster Profile

Create Cluster Profile

Create a cluster profile. The resource_type is required.

Request
URI
POST
https://nsxmanager.your.domain/api/v1/cluster-profiles
COPY
Request Body
ClusterProfile of type(s) application/json
Optional 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string"
}
SelfResourceLink
_self
Optional

_self

boolean
_system_owned
Optional

Indicates system owned resource

string
display_name
Optional

Defaults to ID if not set

string
description
Optional

description

array of Tag
tags
Optional

tags

integer As int64 As int64
_revision
Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

string
_create_user
Optional

ID of the user who created this resource

string
_schema
Optional

_schema

integer As int64 As int64
_create_time
Optional

Timestamp of resource creation

array of ResourceLink
_links
Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

integer As int64 As int64
_last_modified_time
Optional

Timestamp of last modification

string
_last_modified_user
Optional

ID of the user who last modified this resource

string
id
Optional

id

string
resource_type
Required

Supported cluster profiles.

Possible values are : EdgeHighAvailabilityProfile, BridgeHighAvailabilityClusterProfile,
Authentication
This operation uses the following authentication methods.
Responses
201

Resource created successfully

Returns ClusterProfile of type(s) application/json 
{
    "_self": {
        "rel": "string"
    },
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "_revision": 0,
    "_create_user": "string",
    "_schema": "string",
    "_create_time": 0,
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string"
}
SelfResourceLink
_self
Optional

_self

boolean
_system_owned
Optional

Indicates system owned resource

string
display_name
Optional

Defaults to ID if not set

string
description
Optional

description

array of Tag
tags
Optional

tags

integer As int64 As int64
_revision
Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

string
_create_user
Optional

ID of the user who created this resource

string
_schema
Optional

_schema

integer As int64 As int64
_create_time
Optional

Timestamp of resource creation

array of ResourceLink
_links
Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

integer As int64 As int64
_last_modified_time
Optional

Timestamp of last modification

string
_last_modified_user
Optional

ID of the user who last modified this resource

string
id
Optional

id

string
resource_type
Required

Supported cluster profiles.

Possible values are : EdgeHighAvailabilityProfile, BridgeHighAvailabilityClusterProfile,

default

Unexpected error

Returns ApiError of type(s) application/json 
{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}
string
module_name
Optional

module_name

string
error_message
Optional

error_message

integer As int64 As int64
error_code
Optional

error_code


On This Page
Network Transport Operations
POST
Create Bridge Cluster
POST
Create Bridge Endpoint
POST
Create Cluster Profile
POST
Create Edge Cluster
POST
Create Host Switch Profile
POST
Create Transport Node
POST
Create Transport Zone
POST
Create Transport Zone Profile
DELETE
Delete Bridge Cluster
DELETE
Delete Bridge Endpoint
DELETE
Delete Cluster Profile
DELETE
Delete Edge Cluster
DELETE
Delete Host Switch Profile
DELETE
Delete Transport Node
DELETE
Delete Transport Zone
DELETE
Delete Transport Zone Profile
GET
Get Bridge Cluster
GET
Get Bridge Cluster Status
GET
Get Bridge Endpoint
GET
Get Bridge Endpoint Statistics
GET
Get Bridge Endpoint Status
GET
Get Cluster Profile
GET
Get Host Switch Profile
GET
Get Transport Node
GET
Get Transport Node State
GET
Get Transport Zone
GET
Get Transport Zone Profile
GET
Get Transport Zone Status
GET
List Bridge Clusters
GET
List Bridge Endpoints
GET
List Cluster Profiles
GET
List Edge Clusters
GET
List Host Switch Profiles
GET
List Neighbor Properties
GET
List Transport Nodes
GET
List Transport Nodes By State
GET
List Transport Zone Profiles
GET
List Transport Zones
GET
Read Edge Cluster
GET
Read Neighbor Properties
POST
Replace Edge Cluster Member Transport Node
POST
Resync Transport Node
PUT
Update Bridge Cluster
PUT
Update Bridge Endpoint
PUT
Update Cluster Profile
PUT
Update Edge Cluster
PUT
Update Host Switch Profile
PUT
Update Transport Node
PUT
Update Transport Zone
PUT
Update Transport Zone Profile