List Of Api Operations - VMware VC-SRM4-A - vCenter Site Recovery Manager Developer's Manual

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