Cluster EVC Manager Configure Evc Mode Task

Set the EVC mode.

If EVC is currently disabled, then this will enable EVC. The parameter must specify a key to one of the EVC modes listed in the supportedEVCMode array property. If there are no modes listed there, then EVC may not currently be enabled; reference the other properties in ClusterEVCManagerEVCState to determine what conditions are blocking EVC.

Required privileges: Host.Inventory.EditCluster

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ClusterEVCManager/{moId}/ConfigureEvcMode_Task

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

string

release

Required

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

Request Body

ConfigureEvcModeRequestType of type(s) application/json

Required

Show optional properties

{
    "evcModeKey": "string"
}

{
    "evcModeKey": "string",
    "evcGraphicsModeKey": "string"
}

string

evcModeKey

Required

A key referencing the desired EVC mode.

string

evcGraphicsModeKey

Optional

A key referencing the desired EVC Graphics mode Capability.supportedEVCGraphicsMode.

Since: vSphere API Release 7.0.1.0

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

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

500

EVCConfigFault: if configuring EVC failed. Typically, a more specific subclass is thrown.

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

array of MethodFault

faults

Optional

The faults that caused this EVC test to fail, such as FeatureRequirementsNotMet faults.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body