Scripting Object - VcHostFaultToleranceManager

Scripting-object corresponding to
HostFaultToleranceManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

Managed object that is responsible for performing operations related to fault tolerance protection for virtual machines. This is a private interface between Host Agent and Virtual Center.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, fTManagerDisableSecondaryVM_Task, fTManagerEnableSecondaryVM_Task, fTManagerGetPeerVMCompHealth, fTManagerGoLivePeerVM, fTManagerMakePrimaryVM_Task, fTManagerRegisterSecondaryVM_Task, fTManagerSetLocalVMCompHealth, fTManagerStartSecondaryOnRemoteHost_Task, fTManagerTerminateFaultTolerantVM_Task, fTManagerUnregisterSecondaryVM_Task, fTManagerUnregisterVM

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

fTManagerDisableSecondaryVM_Task

Disables the specified secondary virtual machine in this fault tolerant group. The specified secondary will not be automatically started on a subsequent power-on of the primary virtual machine. This operation can leave the primary virtual machine in a non-fault tolerant state. This operation can be invoked on a secondary virtual machine that is currently powered off. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

fTManagerUnregisterSecondaryVM_Task

Unregisters the specified secondary virtual machine from the primary virtual machine of the fault tolerant group. If no secondary instance UUID is specified, it unregisters all secondary virtual machines associated with this primary. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

fTManagerEnableSecondaryVM_Task

Enables the specified secondary virtual machine in this fault tolerant group. This operation is used to enable a secondary virtual machine that was previously disabled by the {@link vim.VirtualMachine#disableSecondary} call. The specified secondary will be automatically started whenever the primary is powered on. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

fTManagerStartSecondaryOnRemoteHost_Task

Registers the specified secondary virtual machine on a remote host and migrates execution state from the primary virtual machine to the new secondary. This operation is used to start up a secondary virtual machine on a new host in the event of a failure that leaves the primary virtual machine unprotected. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String

arg2String

arg3Number

arg4String


Return Value

Type Description
VcTask

fTManagerTerminateFaultTolerantVM_Task

Terminates the specified virtual machine in a fault tolerant group. The operation is invoked on the primary virtual machine. If the instanceUuid of the primary is specified as the parameter to this method, then the primary virtual machine will be terminated, resulting in a failover to an active secondary, if any. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

fTManagerMakePrimaryVM_Task

Makes the specified secondary virtual machine from this fault tolerant group the primary virtual machine. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

fTManagerRegisterSecondaryVM_Task

Registers the specified secondary virtual machine with the primary virtual machine of the fault tolerant group. This method is invoked by Virtual Center as part of the {@link vim.VirtualMachine#createSecondary} operation once a secondary virtual machine has been created on the specified host. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String

arg2String

arg3String


Return Value

Type Description
VcTask

fTManagerGetPeerVMCompHealth

Get component health information of FT peer of the specified local virtual machine. Both primary and secondary vm can invoke this API. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcHostFaultToleranceManagerComponentHealthInfo

fTManagerSetLocalVMCompHealth

Push component health information of the specified local virtual machine down to the kernel, which will be sent over to its peer vm. Both primary and secondary vm can invoke this API. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcHostFaultToleranceManagerComponentHealthInfo


Return Value

Type Description
None

fTManagerGoLivePeerVM

Golive the peer vm in the fault tolerance group. Both primary and secondary can invoke this API. It makes the peer vm primary and terminates the local virtual machine. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
None

fTManagerUnregisterVM

Removes a virtual machine belonging to a fault tolerant group from the inventory without removing any of the virtual machine's files on disk. Fault tolerant virtual machines cannot be removed from the inventory except if requested by Virtual Center through this API. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
None