VMware VC-SRM4-A Developer's Guide - Page 9

Managed Object Hierarchy, Table 1-1.

Page 9 highlights

Chapter 1 The Site Recovery Manager API Table 1-1. List of API operations by function Method Description of Operation Cancel Cancel the specified recovery plan. ListPrompts List the current prompts that are waiting for input. When a prompt step is reached, the plan goes into waiting state until AnswerPrompt is received. Prompts are given in the same order in which VMs are scheduled to start up. AnswerPrompt Answer the current prompt displayed by a Recovery Plan. Requires the Run privilege for test, or the Failover privilege for the other modes. Recovery History GetRecoveryResult Retrieve the recovery result for a given run of a Recovery Plan. GetResultCount Retrieve total number of stored results, including both Recovery and peer plans. GetResultLength Get length of XML result document for the requested recovery result. RetrieveStatus Retrieve XML document for an historical run of the specified recovery plan. Old 1.0 Methods SrmLogin, SrmLogout Log in to and out of the SRM server. GetApiVersion Obtain the API version. ListRecoveryPlans Get a list of recovery plans at the SRM site. RecoveryPlanSettings Get the settings of a specific recovery plan at the SRM site. RecoveryPlanStart Start a specific recovery plan in recovery or test mode. RecoveryPlanPause Pause a running recovery plan. RecoveryPlanResume Restart a paused recovery plan. RecoveryPlanAnswerPrompt Answer a prompt. RecoveryPlanCancel Cancel a recovery plan. GetFinalStatus Get the final status of a recovery plan. Managed Object Hierarchy Figure 1‐1 shows the SRM managed object class hierarchy with each managed object's methods. Figure 1-1. SRM Object Hierarchy VMware, Inc. 9

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38

VMware, Inc.
9
Chapter 1
The Site Recovery Manager API
Managed Object Hierarchy
Figure 1
1
shows the SRM managed object class hierarchy with each managed object’s methods.
Figure 1-1.
SRM Object Hierarchy
Cancel
Cancel the specified recovery plan.
ListPrompts
List the current prompts that are waiting for input. When a prompt step is
reached, the plan goes into waiting state until AnswerPrompt is received.
Prompts are given in the same order in which VMs are scheduled to start up.
AnswerPrompt
Answer the current prompt displayed by a Recovery Plan. Requires the Run
privilege for test, or the Failover privilege for the other modes.
Recovery History
GetRecoveryResult
Retrieve the recovery result for a given run of a Recovery Plan.
GetResultCount
Retrieve total number of stored results, including both Recovery and peer plans.
GetResultLength
Get length of XML result document for the requested recovery result.
RetrieveStatus
Retrieve XML document for an historical run of the specified recovery plan.
Old 1.0 Methods
SrmLogin, SrmLogout
Log in to and out of the SRM server.
GetApiVersion
Obtain the API version.
ListRecoveryPlans
Get a list of recovery plans at the SRM site.
RecoveryPlanSettings
Get the settings of a specific recovery plan at the SRM site.
RecoveryPlanStart
Start a specific recovery plan in recovery or test mode.
RecoveryPlanPause
Pause a running recovery plan.
RecoveryPlanResume
Restart a paused recovery plan.
RecoveryPlanAnswerPrompt
Answer a prompt.
RecoveryPlanCancel
Cancel a recovery plan.
GetFinalStatus
Get the final status of a recovery plan.
Table 1-1.
List of API operations by function
Method
Description of Operation