Cluster Profile Manager Create Profile

Create a profile from the specified CreateSpec.

Required privileges: Profile.Create

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ClusterProfileManager/{moId}/CreateProfile

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ClusterProfileManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

CreateProfileRequestType of type(s) application/json

Required

{
    "createSpec": {
        "_typeName": "string",
        "name": "string",
        "annotation": "string",
        "enabled": false
    }
}

ProfileCreateSpec

createSpec

Required

Specification describing the parameters during Profile creation

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Profile created from the specified createSpec.

Returns MoRefProfile of type(s) application/json

This response body class contains all of the following: ManagedObjectReference

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

DuplicateName: If a profile with the specified name already exists.

InvalidProfileReferenceHost: if the specified reference host is incompatible or no reference host has been specified.

Returns DuplicateName of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string",
    "object": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

string

name

Required

The name that is already bound in the name space.

ManagedObjectReference

object

Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Cluster Profile Manager Operations

POST

Cluster Profile Manager Create Profile