Managed Object - DrConfigUpdateManager

Property of
DrConfigServiceInstanceContent
See also
DrConfigConfigurationTask, DrConfigUpdateInfo, DrConfigUpdateRepoInfo
Since
DrConfig API 3.0


Managed Object Description

This managed object provides operations to update the SRM appliance.

Properties

Name Type Description
currentTask* PManagedObjectReference
to a DrConfigConfigurationTask
Deprecated.

The currently active retrieve update task or null.
*May not be presentP Required privilege: System.Read

Methods

Methods defined in this Managed Object
DrConfigCheckForUpdates, DrConfigUpdateManager_GetRunningTask, GetRepositories, InstallUpdate, UpdateRepository

DrConfigCheckForUpdates

Check for updates.
Required Privileges
DrConfig.Admin

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigUpdateManager used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a DrConfigConfigurationTask
A task object used to monitor the operation.

Faults

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

Events

Type
None



DrConfigUpdateManager_GetRunningTask

The currently active retrieve update task or null.
Required Privileges
System.Read
Since
DrConfig API 3.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigUpdateManager used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a DrConfigConfigurationTask

Faults

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

Events

Type
None



GetRepositories

Get update repos.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigUpdateManager used to make the method call.

Return Value

Type Description
DrConfigUpdateRepoInfo[]A DrConfigUpdateRepoInfo objects representing the current repository and the default repository.

Faults

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

Events

Type
None



InstallUpdate

Install the update.
Required Privileges
DrConfig.Admin

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigUpdateManager used to make the method call.
info* PDrConfigUpdateInfo

A DrConfigUpdateInfo object that will contain information for the update to be installed. If null will install latest update.

Since DrConfig API 3.0
*Need not be set P Required privilege: info

Return Value

Type Description
ManagedObjectReference
to a DrConfigConfigurationTask
A task object used to monitor the operation.

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.InvalidArgumentThrown if the provided UpdateInfo is invalid.
DrConfigFaultUpdateNotAvailableFaultThrown if there is no avaivable update.

Events

Type
None



UpdateRepository

Change the update repository location.
Required Privileges
DrConfig.Admin

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the DrConfigUpdateManager used to make the method call.
info PDrConfigUpdateRepoInfo

A DrConfigUpdateRepoInfo object containing information about the update repository location.

Since DrConfig API 3.0
P Required privilege: info

Return Value

Type Description
None

Faults

Type Description
vmodl.RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
vmodl.fault.InvalidArgumentThrown if SRM is running.
vmodl.fault.SystemErrorThrown if the operation fails.

Events

Type
None