VMware Site Recovery Manager SDK Readme

 Readme for Java (JAXWS) Samples for the Site Recovery Manager API
 Readme for Java (Axis) Samples for the Site Recovery Manager API
 Readme for C# (.NET) Samples for the Site Recovery Manager API
 Readme for Java (JAXWS) Samples for the Site Recovery Manager Appliance Management API
 Readme for Java (Axis) Samples for the Site Recovery Manager Appliance Management API
 Readme for C# (.NET) Samples for the Site Recovery Manager Appliance Management API

What’s in the SDK Package?

The Site Recovery Manager SDK is a ZIP file that provides:

• Sample code demonstrating common use cases for programmatically managing Site Recovery Manager server. The sample code includes Java and C# source code files. See the respective Readme file (readme_jaxws.htm, readme_dotnet.htm) for information about building and using the samples.
• Sample code demonstrating common use cases for programmatically configuring Site Recovery Manager Virtual Appliance. The sample code includes Java and C# source code files. See the respective Readme file (readme_jaxws.htm, readme_dotnet.htm) for information about building and using the samples.
• The WSDL files that define the Site Recovery Manager API and Site Recovery Manager Appliance Management API.
• Batch files and shell scripts to automate the process of generating client-side stubs, and for re-building the sample applications. For C# developers, the Microsoft Visual Studio project files (.sln) have been included.
• Reference documentation (VMware Site Recovery Manager API Reference Guide and VMware Site Recovery Manager Appliance Management API Reference Guide) that provides language-neutral descriptive information (object type definitions, properties, and method signatures, for example) for the VMware Site Recovery Manager API 8.3.

The Site Recovery Manager SDK zipfile package, as unpacked, contains these top-level directories and sub-directories. For more information about the content within each sub-directory (in particular, the Java samples sub-directory and the C# samples sub-directory), see the appropriate readme file.

Directory structure (under /SDK):

What is the VMware Site Recovery Manager API?

The VMware Site Recovery Manager API provides language-neutral interfaces to the Site Recovery Manager server management framework.

The API is implemented as industry-standard Web service, running on VMware Site Recovery Manager server. The Site Recovery Manager API complies with the Web Services Interoperability Organization (WS-I) Basic Profile 1.0, which includes XML Schema 1.0, SOAP 1.1, WSDL 1.1. For more information about the WS-I Basic Profile 1.0, see:

http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html

Accessing the Site Recovery Manager Web Service

For Windows, by default, the Site Recovery Manager Web service listens on port 9086, which uses SSL (secure sockets layer) to encrypt communications between client application and server. To access the Web service programmatically, you use the URL from a web-services client application, as in:

https://FQDN_Server_or_IP_Address:9086/vcdr/extapi/sdk

For Virtual Appliance, by default, the Site Recovery Manager Web service listens on port 443, which uses SSL (secure sockets layer) to encrypt communications between client application and server. To access the Web service programmatically, you use the URL from a web-services client application, as in:

https://FQDN_Server_or_IP_Address:443/drserver/vcdr/extapi/sdk

The certificate of the target server must reside on the client machine.

What is the VMware Site Recovery Manager Appliance Management API?

The VMware Site Recovery Manager Appliance Management API provides language-neutral interfaces to the Site Recovery Manager Virtual Appliance management framework for configuring Site Recovery Manager Server or OS specific settings.

The API is implemented as industry-standard Web service, running on VMware Site Recovery Manager Virtual Appliance. The Site Recovery Manager Appliance Management API complies with the Web Services Interoperability Organization (WS-I) Basic Profile 1.0, which includes XML Schema 1.0, SOAP 1.1, WSDL 1.1. For more information about the WS-I Basic Profile 1.0, see:

http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html

Accessing the Site Recovery Manager Virtual Appliance Web Service

By default, the Site Recovery Manager Appliance Management Web service listens on port 5480, which uses SSL (secure sockets layer) to encrypt communications between client application and server. To access the Web service programmatically, you use the URL from a web-services client application, as in:

https://FQDN_Server_or_IP_Address:5480/configureserver/sdk

The certificate of the target server must reside on the client machine.

Samples Listing

Currently, the Site Recovery Manager SDK includes the following samples that can build on both Java and Microsoft .NET (C#).

Documentation

Reference Guide for the Site Recovery Manager API and Reference Guide for the Site Recovery Manager Appliance Management API are included in the Site Recovery Manager SDK package. The Release Notes are located online only.

• For beta and other pre-release product information and documentation, visit the VMware Communities portal.
• For released product information, including known issues, see the vSphere SDK page.

Be sure to read the Release Notes for late-breaking and updated information.

Checklist of Setup Tasks

Setting up your workstation for developing client applications using the Site Recovery Manager SDK involves several steps. Assuming you are already developing applications of one kind or another, some of the steps below may be unnecessary. Modify the details of the process as appropriate for the specifics of your system. See the appropriate readme for your development platform (readme_jaxws.html, readme_dotnet.html).

To get started with the Site Recovery Manager SDK:

1. Choose a development language (Java or C#) to use for Web-services client application development.
2. Identify the target Site Recovery Manager server (or servers) that you want to use during development. (“Target servers” refers to the Site Recovery Manager servers that will be the targets of the client applications that you develop.)
3. Install the development environment appropriate for your programming language.
   • For C#, you’ll need one of the Microsoft development environments, such as Microsoft Visual Studio 2008 or Microsoft Visual C#. (VMware recommends using Microsoft Visual Studio 2008, which includes the required .NET Framework.) For more information, visit:
     http://msdn2.microsoft.com
   • For Java, you’ll need the Java 2 Platform, Standard Edition (J2SE) 6.0 or 5.0 (JDK 1.6.0_22 or later recommended). For more information, visit:
     http://java.sun.com/javase/downloads/previous.jsp
4. Obtain the appropriate Web-services client tools (XML parser, WSDL-to-proxy-code generation tools, runtime) for your programming language:
   • For C#, you’ll need Microsoft .NET Framework 2.0 or Microsoft .NET Framework 1.1. If you have been using Microsoft development tools for any length of time, it’s likely you already have what’s needed. You can obtain Microsoft .NET Framework from Microsoft, at:
     http://msdn2.microsoft.com/en-us/netframework/default.aspx
     You will also need the Microsoft .NET 2.0 Software Development Kit, which includes the WSDL-to-stub-generation tool (wsdl.exe) and the command-line version of the C# compiler (csc.exe). You can obtain the Microsoft .NET 2.0 Sofware Development Kit from:
     http://www.microsoft.com/downloads/details.aspx?FamilyID=FE6F2099-B7B4-4F47-A244-C96D69C35DEC&displaylang=en
   • For Java, you need the JAX-WS that comes with the JDK.
5. Configure environment and other settings on the workstation (as detailed in the appropriate language-specific sections in the Developer’s Setup Guide), or in the respective readme files (readme_jaxws.htm, readme_java.htm readme_dotnet.htm) for the samples.

To get started with the Site Recovery Manager Appliance Management API:

1. Choose a development language (Java or C#) to use for Web-services client application development.
2. Identify the target Site Recovery Manager Virtual Appliance(s) that you want to use during development. (“Target appliance(s)” refers to the Site Recovery Manager Virtual Appliance(s) that will be the target(s) of the client applications that you develop.)
3. Install the development environment appropriate for your programming language.
   • For C#, you’ll need Microsoft Visual Studio 2017 or later. (VMware recommends using Microsoft Visual Studio 2017, which includes the required .NET Framework.) For more information, visit:
     http://msdn2.microsoft.com
   • For Java, you’ll need the Java Platform Standard Edition (Java SE) 8 (JDK 1.8.0_202 or later recommended). For more information, visit:
     http://java.sun.com/javase/downloads/previous.jsp
4. Obtain the appropriate Web-services client tools (XML parser, WSDL-to-proxy-code generation tools, runtime) for your programming language:
   • For C#, you’ll need Microsoft .NET Framework 4.8. If you have been using Microsoft development tools for any length of time, it’s likely you already have what’s needed. You can obtain Microsoft .NET Framework from Microsoft, at:
     http://msdn2.microsoft.com/en-us/netframework/default.aspx
     You will also need the Microsoft .NET 4.8 Software Development Kit, which includes the WSDL-to-stub-generation tool (wsdl.exe).
   • For Java, you need the JAX-WS that comes with the JDK.
5. Configure environment and other settings on the workstation (as detailed in the appropriate language-specific sections in the Developer’s Setup Guide), or in the respective readme files (readme_jaxws.htm, readme_java.htm, readme_dotnet.htm) for the samples.

VMware Resources

• Developer Center
• Knowledge Base
• User Groups
• VMware Communities

Copyright © 1998–2020 VMware, Inc. All rights reserved. This product is protected by copyright and intellectual property laws in the United States and other countries as well as by international treaties. 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 other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

Last updated: 27-Jan-2020 5:00 pm  |  VMware Site Recovery Manager SDK