VMware VC-SRM4-A - vCenter Site Recovery Manager Instruction Manual

Site Recovery Manager API
Developer’s Guide
VMware vCenter Site Recovery Manager 5.0
EN-000739-01

VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2VMware, Inc.
Site Recovery Manager API Developer’s Guide
You can find the most up-to-date technical documentation on the VMware Web site at:
http://www.vmware.com/support/
The VMware Web site also provides the latest product updates.
If you have comments about this documentation, submit your feedback to:
[e-mail]
Copyright © 2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. VMware products are covered by one or more patents listed at
http://www.vmware.com/go/patents.
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks
and names mentioned herein may be trademarks of their respective companies.

VMware, Inc. 3
Contents
AboutThisBook 5
1TheSiteRecoveryManagerAPI 7
IntroductiontotheAPI 7
Terminology 7
vSphereAPIDocumentation 7
ListofAPIOperations 8
ManagedObjectHierarchy 9
WSDLProgrammingEnvironments 10
SRMObjectsasWSDL 10
C#andVisualStudio 12
JavaJAX‐WSFramework 12
JavaAxisClient 12
AccessingvCenterSiteRecoveryManager 12
LocationoftheAPI 12
AssociatedvCenterServer 12
2SDKInstallationandSetup 13
ContentsoftheSDKPackage 13
SDKDirectoryStructure 13
DownloadandSetupProcedure 14
AbouttheC# .NETSamples 15
AbouttheJavaJAX‐WSSamples 16
AbouttheJavaAxisSamples 17
3LogicalOrderAPIUsage 19
ProtectionandRecoveryPlans 19
ConnectingtoanSRMServer 19
ManagedObjectReference 19
SrmLoginLocale 20
SrmLoginSites 20
SrmLogoutLocale 21
GetApiVersion 21
ProtectionGroupsandReplication 22
ListInventoryMappings 22
ListProtectionGroups 22
ListReplicatedDatastores 22
ProtectVms 22
UnprotectVms 23
GetTasks 23
IsComplete 23
GetResult 24
GetProtectionStatus 24
GetInfo 24
GetPeer 24
GetProtectionState 25
ListProtectedDatastores 25

Site Recovery Manager API Developer’s Guide
4VMware, Inc.
ListProtectedVms 25
ProtectionGroupQueryVmProtection 26
ProtectionGroupListRecoveryPlans 26
RecoveryPlansandReprotection 26
ListPlans 27
GetHistory 27
RecoveryPlanGetInfo 27
RecoveryPlanGetPeer 28
Start 28
Cancel 29
ListPrompts 29
AnswerPrompt 29
GetHistory 29
GetRecoveryResult 30
GetResultCount 30
GetResultLength 31
RetrieveStatus 31
vSphereReplicationMethods 31
ListAssociatedVms 31
AssociateVms 32
UnassociateVms 32
ASSLCertificatesandSNMPTraps 33
SSLCertificates 33
ServerCertificateRequirements 33
ExportingCachedCertificatestoaLocalDirectory 34
AbouttheVirtualMachineKeystore 34
SNMPTraps 35
MIBNamesforSNMPTraps 35
SNMPTrapsandObjectIDs 35
Index 37

VMware, Inc. 5
TheSiteRecoveryManagerAPIDeveloper’s Guideprovidesinformationaboutprogrammingapplicationswith
theWebservicesinterfacestoVMwarevSphereSiteRecoveryManager(SRM).
ThismanualprovidesinformationaboutboththeoldinterfacesandthenewinterfacesintheSRM5.0release,
fordeveloperswhoareinterestedinautomatingsiterecoverytasks.
Revision History
Thisbookisrevisedwitheachproductreleaseorwhennecessary.Table 1summarizeschangesineachrelease.
Intended Audience
Thisbookisintendedfordeveloperswhoneedtosetuptheirenvironmenttoprogramapplicationswiththe
SiteRecoveryManagerAPI.SRMdeveloperstypicallyincludeprogrammersusingtheJavaorC#language
andlibrariestoperformreplication,failover,andreprotectionofvirtualmachinesinVMwarevSphere.
SRMdevelopersshouldhavesomefamiliaritywiththeWebServicesDescriptionLanguage(WSDL)andthe
SimpleObjectAccessProtocol(SOAP)fortransmittingXMLacrossthenetwork.Howevertheimportant
interfacesarecompletelyvisibleinJavaorC#code.
VMware Developer Publications
ToviewthecurrentversionofthisbookaswellasotherVMwareAPIandSDKpublicdocumentation,goto
http://www.vmware.com/support/pubs/sdk_pubs.html.
VMware Technical Publications Glossary
VMwareTechnicalPublicationsprovidesaglossaryoftermsthatmightbeunfamiliartoyou.Fordefinitions
oftermsastheyareusedinVMwaretechnicaldocumentationgotohttp://www.vmware.com/support/pubs.
Document Feedback
VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Sendyourfeedbackto
[email protected].
About This Book
Table 1. Revision History
Revision Date Description
27January2012 AddedAssociatedvCenterServeronpage12,correctedarraybasedreplicationonpages22‐23.
17November2011 UpdatedSiteRecoveryManagerAPIDeveloper’s GuidepublishedaftertheSRM5.0release.
16June2008 TechnicalnoteentitledSiteRecoveryManagerAPIpublishedwiththeSRM1.0release.

Site Recovery Manager API Developer’s Guide
6VMware, Inc.
Technical Support and Education Resources
Thefollowingsectionsdescribethetechnicalsupportresourcesavailabletoyou.Toaccessthecurrentversions
ofotherVMwarebooks,gotohttp://www.vmware.com/support/pubs.
Online and Telephone Support
Touseonlinesupporttosubmittechnicalsupportrequests,viewyourproductandcontractinformation,and
registeryourproducts,gotohttp://www.vmware.com/support.
Support Offerings
TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto
http://www.vmware.com/support/services.
VMware Professional Services
VMwareEducationServicescoursesofferextensivehands‐onlabs,casestudyexamples,andcoursematerials
designedtobeusedason‐the‐jobreferencetools.Coursesareavailableonsite,intheclassroom,andlive
online.Foronsitepilotprograms andimplementationbestpractices,VMwareConsultingServicesprovides
offeringsto helpyouassess,plan,build,andmanageyourvirtualenvironment.Toaccessinformationabout
educationclasses,certificationprograms,andconsultingservices,gotohttp://www.vmware.com/services.

VMware, Inc. 7
1
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
“A c c e s s i n g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.
The Site Recovery Manager API 1

Site Recovery Manager API Developer’s Guide
8VMware, 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.

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

Site Recovery Manager API Developer’s Guide
10 VMware, Inc.
Table 1‐2showsthesamemanagedobjecthierarchywitheachmanagedobject’smethods,inalphabeticorder.
WSDL Programming Environments
YoucanprogramWebservicesandreadWSDLfilesusingtheC#languagewithVisualStudio .NET,orusing
theJavalanguagewiththeAxisframeworkortheJAX‐WSframework.YoucanprogramWebservicesusing
manyotherlanguagesandframeworks,buttheyarebeyondthescopeofthismanual.
Figure 1-2. WSDL programming components
SRM Objects as WSDL
Figure 1‐3,“SRMmanagedobjects,”onpage 11showsSRMmanagedentitiesandclassrelationshipsasthey
fitintotheVMwareWSDLscheme.ClasseswithdashedlinesarevSpheremanagedobjects;forinformation
aboutthem,seethevSphereAPIReferencemanual.
Table 1-2. Managed object hierarchy
Managed Object Remarks Local Methods
SrmApi Oldversion1.0API,
stillprovidedfor
backward
compatibility
GetApiVersion,GetFinalStatus,ListRecoveryPlans,
RecoveryPlanAnswerPrompt,RecoveryPlanCancel,
RecoveryPlanPause,RecoveryPlanResume,RecoveryPlanSettings,
RecoveryPlanStart,SrmLogin,SrmLogout
SrmProtection Listinventory
mappings,query
protectiongroups
ListInventoryMappings,ListProtectionGroups,
ListReplicatedDatastores
SrmProtectionGroup Addvirtualmachines
toaprotectiongroup,
getpeer,query
protecteddatastores
AssociateVms,GetInfo,GetPeer,GetProtectionState,
ListAssociatedVms,ListProtectedDatastores,ListProtectedVms,
ProtectionGroupListRecoveryPlans,
ProtectionGroupQueryVmProtection,ProtectVms,UnassociateVms,
UnprotectVms
SrmProtectionTask Gettaskstatusfor
protectiongroups
GetProtectionStatus,GetResult,GetTasks,IsComplete
SrmRecovery Queryrecoveryplans GetHistory,ListPlans
SrmRecoveryHistory Recoveryplanstatus GetRecoveryResult,GetResultCount,GetResultLength,
RetrieveStatus
SrmRecoveryPlan Runarecoveryplan AnswerPrompt,Cancel,ListPrompts,RecoveryPlanGetInfo,
RecoveryPlanGetPeer,Start
SrmServiceInstance Openandclosesession RetrieveContent,SrmLoginLocale,SrmLoginSites,SrmLogoutLocale
client application SRM server
method
execution
method
invocation
SOAP-encoded WSDL
network
connection
WSDL2Java,
wsdl.exe, or
other tool
WSDL
files
client
proxy
interface
(Java, C#,
or other)

VMware, Inc. 11
Chapter 1 The Site Recovery Manager API
Figure 1-3. SRM managed objects

Site Recovery Manager API Developer’s Guide
12 VMware, Inc.
C# and Visual Studio
TheSRMSDKprovidessampleC# .NETcodepreparedforusewithVisualStudio2008,whichyoucanconvert
forusewithVisualStudio2010andperhapslaterversionsaswell.
Java JAX-WS Framework
TheSDKprovidessamplecodethatusestheJavaDevelopmentKit(JDK)1.6withtheJAX‐WSframework
bundledwiththeJDK1.6.ThebuildscriptsgenerateJavastubsfromtheSRMspecificWSDL.
Java Axis Client
TheSRMSDKprovideslegacysamplecodethatrequiresJavaSE1.5orlaterandApacheAxis1.4.Samplesare
setupforstubgenerationonWindowsoronLinux.
Accessing vCenter Site Recovery Manager
TheSRMAPIprovideslanguage‐neutralinterfacestotheVMwarevCenterSiteRecoveryManager(SRM)
servermanagementframework.Interfacesareprovidedformanagingprotectiongroupsandrecoveryplans.
BotharraybasedreplicationandvSpherereplication(VR)aresupported.
Location of the API
TheAPIislocatedinthefollowingdirectory:
<installdir>\www
TheAPIusesthefollowingdefaultlistenerport:
SOAP–9007
YoucanobtaintheWSDLfortheSRMAPIbyrequestingthefile/srm.wsdlfromtheWSDLport.
TheAPIisimplementedasanindustry‐standardWebservicerunningontheSRMserver.TheAPIcomplies
withtheWebServicesInteroperabilityOrganization(WS‐I)BasicProfile1.0,whichincludesXMLSchema1.0,
SOAP1.1,andWSDL1.1.FordetailsabouttheWS‐IBasicProfile1.0,seethehttp://www.ws‐i.orgWebsite.
Associated vCenter Server
TheSiteRecoveryManagerAPIcurrentlydoesnotallowyoutogetthelocationofitsassociatedvCenter
Server,howeveryoucanfindtheSRMlocationfromthevCenterServerusingthevim.extensionManager–
lookforthecom.vmware.vcDrextension.
InthereturnedextensionListURL,usethehttpsaddressfollowingtheverticalbar,probablyonport8095,
endingin/dr.Port8095istheSOAPportfortheSRMserver’sinternalAPI,whileport9007istheSOAPport
fortheSRMserver’sexternalAPI.Port8095servesinternalAPIsusedbySRMclient,andisproxiedfrom
vCenterServerwithhttponport80orhttpsonport8095.SRMclientscancreateatunneledSSLconnection
througheitherport.Port9007servesAPIsusedbyexternalcustomerssoithasnoproxyfromvCenterServer.
ExternalclientsmustcreateanSSLconnectiondirectlytoport9007.
YoulogintoSRMusingthesamecredentialsasforvCenterServer.BothSOAPports9007and8095verify
againstthesecredentials.

VMware, Inc. 13
2
ThischapterdescribeshowtounpackandusetheSDK,andincludesthefollowingsections:
“ContentsoftheSDKPackage”onpage 13
“SDKDirectoryStructure”onpage 13
“DownloadandSetupProcedure”onpage 14
“A b o u t theC# .NETSamples”onpage 15
“A b o u t theJavaJAX‐WSSamples”onpage 16
“A b o u t theJavaAxisSamples”onpage 17
Contents of the SDK Package
YoucanobtaintheSDKpackagebynavigatingtohttp://www.vmware.com/support/developer/srm‐apiand
clickingtheDownloadSDKlink.
Youwillneedtoprovideanemailaddressorcustomernumber,withvalidpassword,forauthenticationon
theSRMdownloadsite.
TheSRMSDKisdeliveredasaZIParchive(VMware-srm-sdk-<version>-<build>.zip)containingthe
followingitems:
TheWSDLandXMLschemafilesthatdefinetheAPIavailableforSRMservermanagement.
SampleC#codefor .NETandJavacodeforJAX‐WSdemonstratinghowtodealwitharecoveryplan.
Batchfilesandshellscriptstoautomatetheprocessofgeneratingclient‐sidestubs,andforrebuildingthe
sampleapplications.ForC#developers,VisualStudioprojectandsolutionfilesareincluded.
Documentation,includingtheVMwareInfrastructureSDKReferenceGuide(thepreviousnameforthe
vSphereAPIReference)withlanguage‐neutraldescriptiveinformationaboutobjecttypedefinitions,
properties,andmethodsignaturesfortheSRMAPI.
SDK Directory Structure
AfteryouunziptheSiteRecoveryManagerSDK,thefollowingdirectoriesandsub‐directoriesappear.Many
ofthesub‐directoriescontainhelpfulreadmefiles.
SDK Installation and Setup 2
Table 2-1. SDK directory structure
Directory or File Description
\doc ContainsSDK‐READMEfilesandreferencedocumentationfortheSDK.
\doc\ReferenceGuide APIReferencefortheVMwarevCenterSiteRecoveryManagerAPI.
\doc\ReferenceGuide\index.html ToviewtheAPIReference,openindex.htmlwithaWebbrowser.
\doc\SDK_Terms_and_Conditions.* EnduserlicenseagreementfortheSiteRecoveryManagerSDK.

Site Recovery Manager API Developer’s Guide
14 VMware, Inc.
Download and Setup Procedure
SettingupyourenvironmenttodevelopclientapplicationswiththeSDKinvolvesthefollowingsteps.Ifyou
arealreadydevelopingvSphereapplications,someofthestepsareunnecessary.
1 Chooseadevelopmentlanguage(C#orJava)forWebservicesclientapplicationdevelopment.
2IdentifythetargetvCenterSiteRecoveryManagerserver(orservers)tousefordevelopment.
A“targetserver”isavCenterSiteRecoveryManagerserverthatyourclientapplicationwillmanage.
3Install,orverifypresenceof,thedevelopmentenvironmentappropriateforyourprogramminglanguage.
ForC#,youneedoneoftheMicrosoftdevelopmentenvironments,suchasVisualStudio2008or
MicrosoftVisualC#.VMwarerecommendsusingMicrosoftVisualStudio2008,whichincludesthe
required .NETFramework.Formoreinformation,visittheMSDNWebsite.
ForJava,youneedtheJava2PlatformStandardEdition(J2SE)5.0or6.0.VMwarerecommendsthe
JavaDevelopmentKit(JDK)1.6.0_22orlater.Formoreinformation,visittheOracleJavaWebsite.
4 ObtaintheappropriateWebservicesclienttools(XMLparser,WSDL‐to‐proxy‐codegenerationtools,and
runtime)foryourprogramminglanguage.
ForC#,youneedMicrosoft .NETFramework2.0or1.1.IfyoualreadyuseMicrosoftdevelopment
tools,itislikelyyoualreadyhavethis.Youcanobtainthe .NETFramework2.0fromMSDN.
Youalsoneedthe .NET2.0SoftwareDevelopmentKit,whichincludestheWSDL‐to‐stubgeneration
tool(wsdl.exe)andthecommand‐lineC#compiler(csc.exe),bothofwhichgetcalledfromthe
gensrmstubs.cmdscript.Youcangetthe .NET2.0SoftwareDevelopmentKitfromMicrosoft:
http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=19988
ForJavawithJAX‐WS,youcanusetheJAX‐WSframeworkthatcomeswiththeJDK.
ForJavaAxis,youneedtheApacheAxis1.4client‐sideWebservicelibraries.Fordocumentationand
downloads,visittheAxisApacheWebsite.
5TheSDKincludessamplecodetolistandpreparetotestarecoveryplan.Tobuildandrunthesamples:
ForC# .NET,see“A b o u t theC# .NETSamples”onpage 15.
ForJAX‐WS,see“A b o u t theJavaJAX‐WSSamples”onpage 16.
ForJavaAxis,see“Ab o u t theJavaAxisSamples”onpage 17.
\samples Top‐leveldirectoryforlanguage‐specificversionsofsampleclientapplications.
\samples\Axis\DirectorycontainingbatchfilesandJavasourcecodefortheAxisframework.
\samples\DotNet\cs Directorycontainingcommandscriptstogeneratethe .NETproxyclassesand
Webservicestubs.TheGeneratingStubs.txtfilegiveshelpfulnotesabout
howtogeneratestubswithyourownnamespaceforVisualStudio2008.
\samples\DotNet\cs DirectorycontainingVisualStudio2008solution(.sln)fileandsub‐directories
withC#AppUtilsupportcodeandRecoveryPlan.cssampleapplicationwith
project(.csproj)file.
\samples\JAXWS\DirectorycontainingJavasourcecodefortheJAX‐WSframework.Samplecode
RecoveryPlan.javaisinthecom\vmware\recoverysub‐directory.Batchfiles
areprovidedtobuildandrunthesampleprogram.
\wsdl\srm\srm.wsdlTheWebservicesdescriptionlanguage(WSDL)filecontainingdefinitionsfor
theVMwarevCenterSiteRecoveryManagerAPI.
\wsdl\srm\srm‐Service.wsdlTheWSDLfiledefiningtheWebservicesendpointatwhichtheAPIisavailable.
Thisfilereferencessrm.wsdlwithanimportstatement,soyoushouldusethe
appropriategenerationtoolwithsrm-Service.wsdl(notsrm.wsdldirectly).
\wsdl\srm\*.xsdXMLschemadefinitionfiles(six).
Table 2-1. SDK directory structure
Directory or File Description

VMware, Inc. 15
Chapter 2 SDK Installation and Setup
About the C# .NET Samples
CurrentlytheSDKincludesrecovery‐plansamplecodethatyoucanbuildon .NET.YoucanbuildC# .NET
samplesusingMicrosoftVisualC#2008ExpressorMicrosoftVisualStudio2008.AnearlierversionoftheSDK
supportedVisualStudio2005.VisualStudio2003wasneversupportedbecauseofperformanceissues(.NET
tookalongtimetoinstantiatetheVimServiceclass).
To build sample code with Visual Studio 2008
1OpenaVisualStudio2008commandpromptfromtheWindowsStartMenuasfollows:
Start>Programs>VisualStudio2008>VisualStudioTools>CommandPrompt
2StarttheWindowscommandprompt.
On64‐bitWindowssystems,runC:\Windows\SysWOW64\cmd.exesothesampleprogramsexecute
underWindows32‐bitonWindows64‐bit(WOW64).
3 NavigatetotheSDK\samples\DotNetsub‐directory.
4Atthecommandprompt,typeBuild2008.cmdtoexecutethebuildcommands.
To build sample code with Visual C# 2008 Express
1 Selectthedefault(Full)MicrosoftVisualC#2008Expressinstallation.
2IfyouinstalledVisualC#2008Expressinthedefaultlocation,skipthisstep.Otherwise:
a CreatetheSystemenvironmentvariableVSINSTALLDIR.
bSettheVSINSTALLDIRenvironmentvariabletothelocationoftheMicrosoftVisualStudiotools,in
theCommon7sub‐directoryoftheMicrosoftVisualC#2008Expressinstallation.Defaultlocationsare
shownbelow.Usequotationmarksarounddirectorynamesthatcontainspaces,asthesedo.
“C:\Program Files\Microsoft Visual Studio 9.0\Common7”
“C:\apps\Microsoft Visual Studio 9.0\Common7”
IfVisualC#ExpressisinstalledinitsdefaultfolderC:\ProgramFiles\MicrosoftVisualStudio 9.0,
youdonotneedtocreateorsettheVSINSTALLDIRenvironmentvariable.
3OpenaVisualStudio2008commandpromptfromtheWindowsStartMenuasfollows:
Start>Programs>VisualStudio2008>VisualStudioTools>CommandPrompt
4 NavigatetotheSDK\samples\DotNetsub‐directory.
5Atthecommandprompt,typeBuild2008.cmdtoexecutethebuildcommands.
ThebuildprocessgeneratestheRecoveryPlansampleprogram,whichlistsallrecoveryplansandoptionally
getsstateforthespecifiedrecoveryplan.
Asamplebuildcanbeexecutedfromthe\binor\debugdirectoryofaproject.Youcanalsorunsamplesfrom
withinVisualStudio,atthe .NETcommandprompt.
Todisplayhelptextforanyapplication,youcanruntheapplicationwithoutanyparameters.
To run the sample code from Visual Studio
1StartVisualStudio.
2OpentheSample2008.slnsolutionfile.
3 ChangetheProjectPropertiestospecifythecommandlinearguments:
aFromtheProjectmenu,selectPropertiestodisplaythePropertyPagesdialog.
bIntheProject_NamePropertyPagesdialog,selectConfigurationProperties—Debuggingontheleft.
cIntheright‐handpane(underStartOptions),selectCommandLineArguments.
dClickOKtosaveyourchanges.

Site Recovery Manager API Developer’s Guide
16 VMware, Inc.
4Runthesamplecodeatthecommandprompt.
To run the C# sample code
1Afteryougeneratethesampleprogram,youcanrunitasfollows:
RecoveryPlan --url <webserviceurl> --username <user> --password <passwd> --planname <plan>
TheRecoveryPlanprogramlistsallrecoveryplansandoptionallygetsthestatefortheplanspecified
afterthe--plannameoption.
2Youcanremovebuildfilesbyrunningtheclean.batbatchscript.
About the Java JAX-WS Samples
ThissectiondescribeshowtobuildandrunthesamplecodethatusestheJAX‐WSbindingsfortheSRMAPI.
SamplecodehasbeendevelopedtoworkwiththeJAX‐WSframeworkthatisbundledwiththeJDK1.6.Source
codeislocatedinasub‐directoryofsdk\samples\JAXWS\com\vmwareasextractedfromtheZIParchive.
TheJAX‐WSframeworkisincludedwithrecentJDKreleases.
To build the JAX-WS sample code
1SetyourJAVAHOMEenvironmentvariabletothebasedirectoryofaninstalledJDK1.6update22orlater,
C:\Program Files\Java\jdk1.6.0_29forexample.
2 Changedirectorytosdk\samples\JAXWSandrunthebuild.batscripttogeneratetheSRMAPIJava
stubsfromthesrm-Service.wsdldefinitions,generateJavastubs,andcompilethesamplecode.
WSDLfiledependency:JAX‐WSrequiresaWSDLfileforstubgenerationandcompilation.Tomanage
thisdependency,thebuildscriptperformsthefollowingoperations:
ItcallsthewsimportJDKtooltogenerateJavastubsfromthesrm-Service.wsdlSRMWSDLfile.
Itspecifiesthewsimport-wsdlLocationcommandlineoptiontoidentifytheWSDLfilelocation.
ItcopiestheWSDLfileandrelatedschemafilesintothesrm.jarfile.
TocompileJavacodethatimportsthegeneratedstubsandusesthesrm.jarbuiltbythebuild.bat
script,theWSDLfilemustbeinthesamelocationthatwasspecifiedbythe-wsdlLocationcommand
lineoption.Toestablishthislocation,thebuildscriptmodifiestheSrmServiceclasstoreferencetheWSDL
locationinsidetheJARfile.Youonlyneedtoaddthesrm.jarfiletoyourclasspath.
To run the JAX-WS sample code
1 Changedirectorytosdk\samples\JAXWS(theJARfilesarelocated)andsetCLASSPATH.Forexample:
set CLASSPATH=C:\sdk\samples\JAXWS\srm.jar;C:\sdk\samples\JAXWS\samples.jar;%CLASSPATH%
Sometimes%CLASSPATH%hasalreadybeensettoinclude%JAVAHOME%\liborelsewhere.
2Runtheprogram.Anysampleprogramshouldprintitsusagesummaryifyoudonotspecifyanoptions,
orifyouspecify--helponthecommandline.
java com\vmware\recovery\RecoveryPlan --help
or
run.bat com.vmware.recovery.RecoveryPlan --help
3Therun.batscriptacceptsargumentstorunaspecifiedsampleprogramandusestheVMKEYSTORE
environmentvariabletosecurelyaccessanSRMserver.
FormoreinformationaboutVMKEYSTORE,see“SSLCertificates”onpage 33.
To clean up JAX-WS sample code
1 Changedirectorytosdk\samples\JAXWSwherethebuild.batscriptislocated.
2Runtheclean.batscript.

VMware, Inc. 17
Chapter 2 SDK Installation and Setup
About the Java Axis Samples
TheSDKincludesJavasamplecode,batchfilesforWindows,andashellscriptforLinux.Thebatchfiles
requiresettingseveralenvironmentvariables.
To build the Java Axis sample code
1MakesuretheJavadevelopmentkitandApacheAxisareinstalledandfunctioning.
2SettheenvironmentvariablesasshowninTable 2‐2.
3StarttheWindowscommandprompt(orLinuxshell).
On64‐bitWindowssystems,runC:\Windows\SysWOW64\cmd.exesothesampleprogramsexecute
underWindows32‐bitonWindows64‐bit(WOW64).
4 NavigatetotheSDK\samples\Axissub‐directory.
5Atthecommandprompt,typebuild.battorunthebuildbatchfile.
ThebuildprocessgeneratestheRecoveryPlansampleprogram,whichlistsallrecoveryplansandoptionally
getsstateforthespecifiedrecoveryplan.
To run the Java Axis sample code
1Afteryougeneratethesampleprogram,youcanrunthebatchscriptasfollows:
run.bat com.vmware.samples.recovery.RecoveryPlan --url <webserviceurl> --username <user>
--password <passwd> --planname <planname>
Ifyouincludethe--ignorecertoption,thesamplecoderunsthefollowingtogetaroundanuntrusted
servercertificate:
System.setProperty("org.apache.axis.components.net.SecureSocketFactory",
"org.apache.axis.components.net.SunFakeTrustSocketFactory");
2Youcanremovebuildfilesbyrunningtheclean.batbatchscript.
Table 2-2. Java and Axis environment variables
Environment Variable Description and Usage Notes Sample Setting
AXISHOMECompletepathtothetop‐levelAxisinstallationdirectory.
Mustbesetbeforeusingthebuild.batscript.
C:\Apache\axis1.4
JAVAHOMEPathtothebinarydirectoryfortheJavaJDK. C:\Java\jdk1.5.0_08

Site Recovery Manager API Developer’s Guide
18 VMware, Inc.

VMware, Inc. 19
3
Thischaptercontainsthefollowingmajorsections:
“ConnectingtoanSRMServer”onpage 19
“ProtectionGroupsandReplication”onpage 22
“RecoveryPlansandReprotection”onpage 26
“vSphereReplicationMethods”onpage 31
Protection and Recovery Plans
YouusetheUItocreateprotectiongroupsandsetupreplication,ortocreaterecoveryplansandreprotection.
TheAPIdoesnotcontainmethodsforthese.FordetailsabouttheUI,seetheSRMAdministrationGuide.
Connecting to an SRM Server
ProgramsconnecttoanSRMserverusingtheSrmLoginLocaleAPI,ortoSRMserversatboththeprotected
siteandtherecoverysiteusingtheSrmLoginSitesAPI.
Managed Object Reference
SRMmethodstakeamanagedobjectreference_this,whichreferencestheSessionManagerusedformaking
methodcalls.Programsobtain_thisbyretrievingcontentoftheServiceInstance,whichisaccomplishedby
creatinganewmanagedobjectreferenceoftypeSrmServiceInstance.
Example 3-1. C# code to create SrmServiceInstance
public SvcConnection(string svcRefVal)
{
...
_svcRef = new ManagedObjectReference();
_svcRef.type = "SrmServiceInstance";
_svcRef.Value = svcRefVal;
}
TheJavacodeissimilartotheC#code.
Example 3-2. Java code to create SrmServiceInstance
private static final String SVC_INST_NAME = "SrmServiceInstance";
private static ManagedObjectReference SVC_INST_REF = new ManagedObjectReference();
...
SVC_INST_REF.setType(SVC_INST_NAME);
SVC_INST_REF.setValue(SVC_INST_NAME);
srmService = new SrmService();
Logical Order API Usage 3

Site Recovery Manager API Developer’s Guide
20 VMware, Inc.
SrmLoginLocale
ThismethodlogsintotheSRMserver.TheConnectpublicmethodrequirestheURLofanSRMserverand
authenticationcredentials.TheSrmLoginLocalemethodtakesthe_srcRefmanagedobjectreferencefrom
SrmServiceInstance,andfailsiftheusernameandpasswordcombinationisinvalid,oriftheuserisalready
loggedin.Intheseexamples,alocalestringcouldbeprovidedinsteadofthenullparameter.
Example 3-3. C# code for SRM login
protected SrmService _service;
protected SrmServiceInstanceContent _sic;
protected ManagedObjectReference _svcRef;
...
public void Connect(string url, string username, string password)
{
_service = new SrmService();
_service.Url = url;
_service.Timeout = 600000;
_service.CookieContainer = new System.Net.CookieContainer();
_sic = _service.RetrieveContent(_svcRef);
_service.SrmLoginLocale(_svcRef, username, password, null);
...
}
TheJavacodeissimilartotheC#codebutusesaservicelocator.
Example 3-4. Java code for SRM login
private static SrmPortType srmPort;
private static SrmServiceInstanceContent serviceContent;
private static boolean isConnected = false;
...
srmPort = srmService.getSrmPort();
Map<String, Object> ctxt =
((BindingProvider) srmPort).getRequestContext();
ctxt.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, url);
ctxt.put(BindingProvider.SESSION_MAINTAIN_PROPERTY, true);
serviceContent = srmPort.retrieveContent(SVC_INST_REF);
srmPort.srmLoginLocale(SVC_INST_REF, userName, password, null);
isConnected = true;
SubsequentSRMmethodsarecalledasasubclassof_service,forexample_service.ListPlans()inC#or
srmport.listPlans()inJava.
SrmLoginSites
TheSrmLoginSitesAPIisverysimilartoSrmLoginLocale,exceptittakesanadditionalusernameand
passwordcombinationfortheremote(usuallyrecovery)site.TheSrmServiceInstance_thisisobtainedfrom
thelocal(usuallyprotected)site.
Example 3-5. C# and Java for double SRM login
/// C#
_service.SrmLoginSites(_svcRef, username, password, remoteuser, remotepass, locale);
// Java
_service.srmLoginSites(_svcRef, username, password, remoteuser, remotepass, locale);
Parametersareasfollows
_svcRef–managedobjectreferencetoSrmServiceInstance
username–usernameauthorizedforaccesstothelocalvCenterServer
password–passwordforthatuseronthelocalvCenterServer
remoteuser–usernameauthorizedforaccesstotheremotevCenterServer