Note: The SOAP-based Site Recovery Manager APIs are deprecated. For the latest features and functionality, use the Site Recovery Manager Configuration REST API Gateway and the Site Recovery Manager REST API Gateway.

The Site Recovery Manager 5.0 release extended the API with new methods to list and modify protection groups, and revised methods to list, modify, and run recovery plans.

The Site Recovery Manager 5.8 release introduced 30 methods and 4 new managed objects, adding several requested features to the API :
  • Ability to add folder, network, and resource pool mappings
  • Support for planned migrations
  • Navigation capabilities for protection group folders and recovery plan folders
  • Ability to create protection groups, and to modify selected fields in a virtual machine’s recovery settings

The Site Recovery Manager 6.0 release introduced new methods to support authentication by tokens:

  • New concept of the Site Recovery Manager solution user for vCenter Single Sign-On authentication
  • Functions to get the Site Recovery Manager solution user name for the local and remote sites
  • Functions to log in to local or remote sites using security assertion markup language (SAML) token
  • Ability to use lookup service URL and vCenter Server instance ID
  • Although DisasterRecoveryApi is deprecated, it gains forward compatibility with LoginByToken

In release 6.1, VMware Site Recovery Manager introduced Storage Profile Protection Groups (SPPG). However, the Site Recovery Manager API does not support SPPG related objects.

Site Recovery Manager API 6.5 introduced methods that expand the operations on the inventory mappings, recovery plans, and protection groups.

The Site Recovery Manager 8.1 release introduces new methods that provide ability to:
  • Add replicated datastores (that are newly provisioned) to an existing protection group.
  • Remove datastores from the protection group.
  • Configure the IP address and corresponding DNS, WINS of the virtual machine, after the migration is complete.
The Site Recovery Manager 8.2 release introduces new methods that provide ability to:
  • Read information specific to an ArrayManager instance and list all the array pairs in the array manager.
  • Get information about all the replicated RDMs in a replicated array pair.
  • Get a list all the available array managers.
The Site Recovery Manager 8.3 release introduces the following:
  • Site Recovery Manager Virtual Appliance Management APIs for configuring Site Recovery Manager Virtual Appliance or OS-specific settings.
  • APIs for vVOL management.
  • APIs for automatic protection.
  • APIs for managing IP Subnet Mapping between protection and recovery site networks, defining the rules used for translating VM's IP settings between protection and recovery sites, and customizing the IP information for a specific network adapter.
The Site Recovery Manager 8.4 release introduces the following:
  • Site Recovery Manager APIs for pairing, manual per VM protection, array manager management, and folders operations.
  • Site Recovery Manager Virtual Appliance Management APIs can be used for configuring VRMS vSphere replication management server (VRMS-HMS) and VRS vSphere replication server (VRS-HBR).
The Site Recovery Manager 8.5 release introduces the following:
  • APIs to start and monitor a recovery plan execution, additional options to ignore errors during Test cleanup or Reprotect.
  • APIs to get specific details for an ABR Protection Group.
  • The Appliance Management API is extended with new APIs, which allow more custom configuration of the appliance.

Terminology

This document uses the following terms.

SOAP
Client applications invoke operations by sending SOAP formatted messages. When passing data objects between client and server, programs build or parse XML messages representing data structures described by the WSDL. Standardized by W3C as Simple Object Access Protocol (SOAP) 1.1.
Web service operations
Client interfaces that perform server‐side management and monitoring tasks. Standardized as Web Services Interoperability Organization (WS‐I) Basic Profile 1.0.
WSDL
The Web services API is defined in a WSDL file, which is used by client‐side Web services to create proxy code (stubs) that client applications use to interact with the server. Standardized as Web Services Description Language (WSDL) 1.1.
XML
A text representation scheme similar to HTML but with more stringent, regularized syntax. Standardized by W3C as Extensible Markup Language (XML) 1.0.

The Site Recovery Manager Appliance Management API and the Site Recovery Manager API are similar to and derived from the vSphere API. For information about the vSphere API, see the vSphere Web Services SDK Programming Guide and the vSphere API Reference at the VMware website.