# Managed Object - SrmRecoveryHistory

Returned by
  GetHistory
See also
  SrmRecoveryResult
Since
  SRM API 2.0

## Managed Object Description

Interface for the retrieval of historical runs of a given Recovery Plan.

Properties

Name | Type | Description
--- | --- | ---
None

Methods

Methods defined in this Managed Object
GetRecoveryResult, GetResultCount, GetResultLength, RetrieveStatus

# GetRecoveryResult

Retrieve the recovery result for a given run of a plan.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SrmRecoveryHistory used to make the method call.
length P | xsd:int | The maximum number of results to retrieve. Since SRM API 2.0

P Required privilege: length

Return Value

Type | Description
--- | ---
SrmRecoveryResult[] | An Array of recovery results for this plan and/or its peer.

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

# GetResultCount

Retrieve the total number of stored results. This will include historical results from both the plan and its peer plan if the sites are connected.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SrmRecoveryHistory used to make the method call.

Return Value

Type | Description
--- | ---
xsd:int | The total number of history entries for this plan (and potentially its peer)

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

# GetResultLength

Retrieve the length of the XML result document for the requested RecoveryResult.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SrmRecoveryHistory used to make the method call.
key P | xsd:long | The key for this result document. Since SRM API 2.0

P Required privilege: key

Return Value

Type | Description
--- | ---
xsd:int | The length in lines of the recovery result document.

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.
SrmFaultRecoveryResultNotFound | Thrown if no results with that key exists.

Events

Type
None

# RetrieveStatus

Retrieve an XML representation of the specified historical run of the referenced recovery plan. This XML document will be returned in chunks limited by the maximum length of a string in the transport layer.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the SrmRecoveryHistory used to make the method call.
key P | xsd:long | The key for this result document. Since SRM API 2.0
offset P | xsd:int | The line number (starting with 0) of from the beginning of the document. Since SRM API 2.0
maxLines P | xsd:int | The maximum number of lines to retrieve. Since SRM API 2.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
xsd:string[] | A string array containing an XML represenation of all the recovery steps and their results.

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.
SrmFaultRecoveryResultNotFound | Thrown if no results with that key exists.

Events

Type
None