Cluster EVC Manager Configure Evc Mode Task

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://{api_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.2.0 APIs.

Request Body
ConfigureEvcModeRequestType of type(s) application/json
Required 
"ConfigureEvcModeRequestType Object"
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.
Responses
200

OK

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

500

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

Returns EVCConfigFault of type(s) application/json 
"EVCConfigFault Object"
array of object
faults
Optional

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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/ClusterEVCManager/{moId}/ConfigureEvcMode_Task
On This Page
Cluster Evcmanager Operations
POST
Cluster EVC Manager Check Add Host Evc Task
POST
Cluster EVC Manager Check Configure Evc Mode Task
POST
Cluster EVC Manager Configure Evc Mode Task
POST
Cluster EVC Manager Disable Evc Mode Task
POST
Cluster EVC Manager Set Custom Value
GET
Cluster EVC Manager Get Available Field
GET
Cluster EVC Manager Get Evc State
GET
Cluster EVC Manager Get Managed Cluster
GET
Cluster EVC Manager Get Value