Managed Object - ClusterEVCManager(vim.cluster.EVCManager)

Returned by: EvcManager
Extends: ExtensibleManagedObject
See also: ClusterComputeResource, ClusterEVCManagerCheckResult, ClusterEVCManagerEVCState, HostConnectSpec
Since: vSphere API 6.0

Managed Object Description

Controls Enhanced vMotion Compatibility mode for a particular cluster given by ManagedCluster. VMware Enhanced vMotion Compatibility (EVC) facilitates vMotion between different CPU generations through the use of Intel Flex Migration and AMD-V Extended Migration technologies. When enabled for a cluster, EVC ensures that all VMs are vMotion-compatible with the CPUs of all hosts in the cluster.
See EVCMode

Properties

Name	Type	Description
evcState	ClusterEVCManagerEVCState	EVC-related state of the managed cluster.
managedCluster	ManagedObjectReference to a ClusterComputeResource	Cluster associated with this manager object.
Properties inherited from ExtensibleManagedObject
availableField, value

Methods

Methods defined in this Managed Object
CheckAddHostEvc_Task, CheckConfigureEvcMode_Task, ConfigureEvcMode_Task, DisableEvcMode_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

CheckAddHostEvc_Task(checkAddHostEvc)

Test the validity of adding a host into the managed cluster. Note that this method only tests EVC admission control; host-add may fail for other reasons.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterEVCManager used to make the method call.

cnxSpec P

HostConnectSpec

The spec that will be used to add the host.

Since vSphere API 6.0

P Required privilege: cnxSpec

Return Value

Type	Description
pbm.Task	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
HostConnectFault	Thrown if an error occurred when attempting to connect to the host. Typically, a more specific subclass is thrown.
InvalidLogin	Thrown if authentication with the host fails.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

CheckConfigureEvcMode_Task(checkConfigureEvc)

Test the validity of configuring an EVC mode on the managed cluster.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterEVCManager used to make the method call.

evcModeKey P

xsd:string

A key referencing the desired EVC mode.

Since vSphere API 6.0

evcGraphicsModeKey* P

xsd:string

A key referencing the desired EVC Graphics mode supportedEVCGraphicsMode.

Since vSphere API 6.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
pbm.Task	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

ConfigureEvcMode_Task(configureEvc)

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 EVCState to determine what conditions are blocking EVC.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the ClusterEVCManager used to make the method call.

evcModeKey P

xsd:string

A key referencing the desired EVC mode.

Since vSphere API 6.0

evcGraphicsModeKey* P

xsd:string

A key referencing the desired EVC Graphics mode supportedEVCGraphicsMode.

Since vSphere API 6.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
pbm.Task

Faults

Type	Description
EVCConfigFault	Thrown if configuring EVC failed. Typically, a more specific subclass is thrown.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

DisableEvcMode_Task(disableEvc)

Disable EVC. EVC may be disabled at any time.

Required Privileges: Host.Inventory.EditCluster

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ClusterEVCManager used to make the method call.

Return Value

Type	Description
pbm.Task

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None