Vcenter EvcModes partition

Vcenter EvcModes partition

Partition the EvcMode object into its constituent CPU and graphics EvcMode objects.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires System.View.
Request
URI
POST
https://{api_host}/api/vcenter/evc-modes?action=partition
COPY
Request Body

The EvcMode object to partition.

Vcenter EvcMode EvcMode of type(s) application/json
Required 
{
    "key": "string",
    "masks": [
        {
            "key": "string",
            "name": "string",
            "value": "string"
        }
    ]
}
string
key
Required

The system generated unique identifier for the EvcMode.

This property was added in vSphere API 9.0.0.0.

array of object
masks
Required

The masks (modifications to a host's feature capabilities) that limit a host's capabilities to that of the EVC mode baseline.

This property was added in vSphere API 9.0.0.0.

Authentication
This operation uses the following authentication methods.
Responses
200

Partitioned CPU and graphics mode information for the given EvcMode.

Returns Vcenter EvcModes PartitionResult of type(s) application/json 
"Vcenter EvcModes PartitionResult Object"
cpu_evc_mode
Optional

CPU specific EVC mode created from an EVC mode partitioning operation.

This property was added in vSphere API 9.0.0.0.

if missing or null, then no CPU EVC mode details were found in Vcenter EvcMode EvcMode object being partitioned.

graphics_evc_mode
Optional

Graphics specific EVC mode created from an EVC mode partitioning operation.

This property was added in vSphere API 9.0.0.0.

if missing or null, then no Graphics EVC mode details were found in Vcenter EvcMode EvcMode object being partitioned.


500

if there is any error in partitioning the EvcMode.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"key:"string","masks":["object"]}' https://{api_host}/api/vcenter/evc-modes?action=partition
On This Page
Vcenter Operations
POST
Vcenter EvcModes partition
POST
Vcenter EvcModes create$Task