The Site Recovery Manager Api; Introduction To The Api; Terminology; Vsphere Api Documentation - VMware VC-SRM4-A - vCenter Site Recovery Manager Developer's Manual

1

The Site Recovery Manager API

This manual describes a Web services programming interface to protection groups and recovery plans in
VMware vCenter Site Recovery Manager (SRM). This chapter discusses the following topics.

"Introduction to the API" on page 7

"List of API Operations" on page 8

"Managed Object Hierarchy" on page 9

"WSDL Programming Environments" on page 10

"Accessing vCenter Site Recovery Manager" on page 12
The SRM 5.0 release provides an extended API with a new set of methods to list and modify protection groups,
and a set of revised methods to list, modify, and run recovery plans.

Introduction to the API

The SRM API provides an interface similar to the vSphere API, which is a object‐oriented Web service that
provides access to vSphere and virtual machine management on vCenter Server and ESXi hosts. You program
the vSphere API in Java, C#, or any language that supports Web services definition language (WDSL).
The SRM API offers a way for third party systems to initiate test, failover, reprotect, or revert operations and
collect the results. Protection groups and recovery plans are usually set up from the user interface (UI).

Terminology

This document defines and uses the following terms:

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.

SOAP – Client applications invoke operations by sending SOAP formatted messages. When passing data
objects between client and server, you need to build or parse a SOAP message that contains the data object
properties as XML elements corresponding to the message structures described in the WSDL.
Standardized by W3C as Simple Object Access Protocol (SOAP) 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.

vSphere API Documentation

For information about the vSphere API from which the SRM API is derived, see the vSphere API Reference and
the [Web Services SDK] Programming Guide, both available on the VMware Web site.
VMware, Inc.
1
7