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

List of API Operations, Method, Description of Operation, Authentication, Service Instance, Protection

Page 8 highlights

Site Recovery Manager API Developer's Guide List of API Operations Table 1‐1 provides a list of SRM APIs organized by approximate order of use. Table 1-1. List of API operations by function Method Description of Operation Authentication SrmLoginLocale Begin a session with the SRM server. SrmLoginSites Log in to both the local and remote vCenter Servers. SrmLogoutLocale Log out sites and terminate the current session. Service Instance RetrieveContent Retrieve the properties of a service instance. Protection ListProtectionGroups Get a list of the protection groups that are currently configured. ListInventoryMappings Get a list of the configured inventory mappings on the protection site. ListReplicatedDatastores Get a list of the replicated datastores (not in Release Notes). Protection Group GetInfo Retrieve basic information about this protection group. GetPeer Retrieve the peer protection group. ListProtectedVms List VMs protected in this group with information about their protection state. ListProtectedDatastores Retrieve a list of the Datastores protected by this protection group. ListAssociatedVms Retrieve the list of VMs currently associated with this group. VR only. GetProtectionState Get the current state of the protection group. ProtectionGroupListRecoveryPlans Retrieve a list of all recovery plans this protection group is a member of. ProtectionGroupQueryVmProtection Determine whether the specified VMs can be or currently are protected, which must be mapped to recovery site as per ListInventoryMappings. ProtectVms Protect the specified VMs. Each virtual machine's folder, resource pool, and network must be mapped to the recovery site. UnprotectVms Unprotect the specified VMs. AssociateVms Associate the specified VMs with a group. VR only, a prerequisite for protection. UnassociateVms Unassociate the specified VMs with this group. VR only. Protection Task GetProtectionStatus Get the results of ProtectVms or UnprotectVms. GetTasks Get Task information from the vCenter Server for each virtual machine that was requested to be protected or unprotected. IsComplete Check if this Task has finished. GetResult Get the results of this Task (not in Release Notes). Recovery ListPlans Retrieve all the Recovery Plans for this SRM Server. GetHistory Retrieve the history for a given Recovery Plan. Recovery Plan RecoveryPlanGetInfo Retrieve basic information about the specified Recovery Plan. RecoveryPlanGetPeer Get the peer plan for this Recovery Plan. The returned object refers to a plan at the paired site, not the local site. Start Start the Recovery Plan in a selected mode: failover, reprotect, revert, or test. Requires Run privilege for test, Failover privilege for the others. 8 VMware, Inc.

  • 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

Site Recovery Manager API Developer’s Guide
8
VMware, Inc.
List of API Operations
Table 1
1
provides a list of SRM APIs organized by approximate order of use.
Table 1-1.
List of API operations by function
Method
Description of Operation
Authentication
SrmLoginLocale
Begin a session with the SRM server.
SrmLoginSites
Log in to both the local and remote vCenter Servers.
SrmLogoutLocale
Log out sites and terminate the current session.
Service Instance
RetrieveContent
Retrieve the properties of a service instance.
Protection
ListProtectionGroups
Get a list of the protection groups that are currently configured.
ListInventoryMappings
Get a list of the configured inventory mappings on the protection site.
ListReplicatedDatastores
Get a list of the replicated datastores (not in Release Notes).
Protection Group
GetInfo
Retrieve basic information about this protection group.
GetPeer
Retrieve the peer protection group.
ListProtectedVms
List VMs protected in this group with information about their protection state.
ListProtectedDatastores
Retrieve a list of the Datastores protected by this protection group.
ListAssociatedVms
Retrieve the list of VMs currently associated with this group. VR only.
GetProtectionState
Get the current state of the protection group.
ProtectionGroupListRecoveryPlans
Retrieve a list of all recovery plans this protection group is a member of.
ProtectionGroupQueryVmProtection
Determine whether the specified VMs can be or currently are protected, which
must be mapped to recovery site as per ListInventoryMappings.
ProtectVms
Protect the specified VMs. Each virtual machine’s folder, resource pool, and
network must be mapped to the recovery site.
UnprotectVms
Unprotect the specified VMs.
AssociateVms
Associate the specified VMs with a group. VR only, a prerequisite for protection.
UnassociateVms
Unassociate the specified VMs with this group. VR only.
Protection Task
GetProtectionStatus
Get the results of ProtectVms or UnprotectVms.
GetTasks
Get Task information from the vCenter Server for each virtual machine that was
requested to be protected or unprotected.
IsComplete
Check if this Task has finished.
GetResult
Get the results of this Task (not in Release Notes).
Recovery
ListPlans
Retrieve all the Recovery Plans for this SRM Server.
GetHistory
Retrieve the history for a given Recovery Plan.
Recovery Plan
RecoveryPlanGetInfo
Retrieve basic information about the specified Recovery Plan.
RecoveryPlanGetPeer
Get the peer plan for this Recovery Plan. The returned object refers to a plan at
the paired site, not the local site.
Start
Start the Recovery Plan in a selected mode: failover, reprotect, revert, or test.
Requires Run privilege for test, Failover privilege for the others.