Cluster Profile Update Cluster Profile

Update the ClusterProfile with the specified config.

Required privileges: Profile.Edit

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ClusterProfile/{moId}/UpdateClusterProfile

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 ClusterProfile/{moId}.

string

release

Required

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

Request Body

UpdateClusterProfileRequestType of type(s) application/json

Required

Show optional properties

{
    "config": {}
}

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

config

Required

Specification which describes the changes.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

DuplicateName: If the profile with the new name already exists.

Returns DuplicateName of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "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.

object

Required

Managed object that already holds the name.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"config":"{}"}' https://{api_host}/sdk/vim25/{release}/ClusterProfile/{moId}/UpdateClusterProfile

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Cluster Profile Associate Profile