Managed Object - DrConfigConfigurationTask

Property of: DrConfigConfigurationManager, DrConfigDiagnosticManager, DrConfigFaultServiceBusy, DrConfigSraSraManager, DrConfigUpdateManager
Returned by: ClearSrmConfiguration, ConfigureSrm, DrConfigCheckForUpdates, DrConfigConfigurationManager_GetRunningTask, DrConfigDiagnosticManager_GetRunningTask, DrConfigFileIntegrityManager_GetRunningTask, DrConfigMigrationManager_GetRunningTask, DrConfigSraSraManager_GetRunningTask, DrConfigUpdateManager_GetRunningTask, ExportMigrationData, FileIntegrityBaseline, FileIntegrityCheck, GenerateSystemLogBundle, GetSraImages, InstallUpdate, Migrate
See also: DrConfigConfigurationTaskInfo
Since: DrConfig API 1.0

Managed Object Description

This managed object provides operations to configure SRM server.

Properties

Name	Type	Description
info	DrConfigConfigurationTaskInfo	Deprecated. The current configuration task status.

Methods

Methods defined in this Managed Object
CancelSrmConfiguration, GetTaskInfo

CancelSrmConfiguration

Cancels a running configuration task. Multiple cancel requests will be treated as a single cancellation request. Canceling a completed or already canceled task will throw an ServiceIdle exception. If successfully canceled, the StateInfo.error property will be set to RequestCanceled. A cancel operation is asynchronous. The operation may return before the task is canceled. After invoking it, the configuration task remains working and can still succeed. In that case the StateInfo.cancelled property will be set.

Required Privileges: DrConfig.Admin

Parameters

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

Return Value

Type	Description
None

Faults

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

Events

Type
None

GetTaskInfo

The current configuration task status.

Required Privileges: None
Since: DrConfig API 3.1

Parameters

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

Return Value

Type	Description
DrConfigConfigurationTaskInfo

Faults

Type	Description
vmodl.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