Scripting Object - VcHbrManager

Scripting-object corresponding to
HbrManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

HbrManager is the interface of the host-based replication plugin. It is used for configuration and monitoring of the replication of virtual machines.

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, hbrCreateInstance_Task, hbrDisableReplication_Task, hbrEnableReplication_Task, hbrFullSync_Task, hbrPauseReplication_Task, hbrQueryReplicationCapabilities, hbrQueryReplicationState, hbrReconfigureReplication_Task, hbrResumeReplication_Task, hbrRetrieveReplicationConfig, hbrStartOfflineInstance_Task, hbrStopOfflineInstance

hbrReconfigureReplication_Task

Reconfigure replication for the specified virtual machine. Replication must be enabled for the virtual machine.

This method invokes {@link vim.VirtualMachine#reconfigure} and can throw the faults specified for that method in addition to those described here. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcReplicationConfigSpec


Return Value

Type Description
VcTask

_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

hbrResumeReplication_Task

Resume replication for the specified {@link vim.VirtualMachine} which was paused via {@link vim.HbrManager#pauseReplication}.

This operation is a no-op if the virtual machine is not currently paused.

This method invokes {@link vim.VirtualMachine#reconfigure} and can throw the faults specified for that method in addition to those described here. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcTask

hbrFullSync_Task

Force a full-sync of the virtual machine.

The replication state of the virtual machine must not be "none", "syncing", or "paused". @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcTask

hbrEnableReplication_Task

Enable replication for the specified virtual machine. Replication must not be already enabled for the virtual machine.

This method invokes {@link vim.VirtualMachine#reconfigure} and can throw the faults specified for that method in addition to those described here. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcReplicationConfigSpec


Return Value

Type Description
VcTask

hbrStopOfflineInstance

Stop the creation of an offline instance.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
None

hbrCreateInstance_Task

Creating a consistent replica for the specified virtual machine.

The replication state of the virtual machine must be "idle". @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

hbrDisableReplication_Task

Disables replication for the specified virtual machine. Replication must be enabled for the virtual machine.

This method invokes {@link vim.VirtualMachine#reconfigure} and can throw the faults specified for that method in addition to those described here. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcTask

hbrQueryReplicationCapabilities

Query capabilities of a {@link vim.VirtualMachine}.

Get capabilities for the specified virtual machines. If we are unable to find a virtual machine, we would set the fault and values for other capabilities would be undefined. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcVirtualMachine []


Return Value

Type Description
VcHbrManagerVmReplicationCapability []

hbrPauseReplication_Task

Pause replication for the specified {@link vim.VirtualMachine}. This will abort any consistent operation that is currently in progress and prevent any new updates from being sent to the remote site. If the remote site is not also paused this will result in RPO violations.

This operation is a no-op if the virtual machine is already paused.

This method invokes {@link vim.VirtualMachine#reconfigure} and can throw the faults specified for that method in addition to those described here. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcTask

hbrRetrieveReplicationConfig

Retrieve the {@link vim.vm.ReplicationConfigSpec} for the specified virtual machine

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcReplicationConfigSpec

hbrStartOfflineInstance_Task

Start the process of creating a consistent instance for the specified powered-off virtual machine.

Note that this operation will lock the disks of the virtual machine. The operation can stopped via a call to {@link vim.HbrManager#stopOfflineInstance}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcTask

hbrQueryReplicationState

Query the current state of a replicated {@link vim.VirtualMachine}. Note that a virtual machine that is configured for replication, but is powered off (and not undergoing offline replication) is in the "none" state.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
VcHbrManagerReplicationVmInfo