Scripting Object - VcVirtualMachineBackupAgent

Scripting-object corresponding to
VirtualMachineBackupAgent
Returned by
retrieveBackupAgent

Scripting Object Description

A BackupAgent manages the lifecycle of a backup operation inside a running virtual machine. This object requires functionality provided by the VMware Tools running in the guest. The operations performed in the guest are aimed at quiescing any running applications so that the backed up data is in an "application consistent" state (in lieu of the "file system consistent" state offered by the sync driver). For example, on a Windows guest, this would start a VSS backup request initiated by the tools service.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
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
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, abortBackup, backupProtocolEvent, createTrigger, notifySnapshotCompletion, setCustomValue, startBackup

startBackup

Requests the start of a backup operation inside the guest. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0Boolean

arg1String []


Return Value

Type Description
None

_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

backupProtocolEvent

Waits for an event delivered from the guest. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
VcVirtualMachineBackupEventInfo

abortBackup

Requests that a running backup operation be aborted. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

notifySnapshotCompletion

Tells the VM that the snapshot operation has finished and regular operation can continue. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None