XenServer.NET
=============

Version 7.2.0

XenServer.NET is a complete SDK for Citrix XenServer,
exposing the XenServer API as .NET classes. It is written in C#.

It is available in the XenServer-SDK-7.2.0.zip, which can be downloaded
from http://www.citrix.com/downloads/xenserver/.

For XenServer documentation, see http://docs.citrix.com.
XenServer.NET includes a class for every XenServer class, and a method for
each XenServer API call, so API documentation and examples written for
for other languages will apply equally well to .NET.
In particular, the SDK Guide and API Documentation are ideal for developers
wishing to use XenServer.NET.

For community content, blogs, and downloads, visit
http://xenserver.org/partners/developing-products-for-xenserver.html.

XenServer.NET is free sofware. You can redistribute and modify it under the
terms of the BSD license. See LICENSE.txt for details.

This library is accompanied by pedagogical examples. These do not form
part of this library, and are licensed for redistribution and modification
under the BSD license.


Prerequisites
-------------

This library requires .NET 4.5 or greater.


Dependencies
------------

XenServer.NET is dependent upon XML-RPC.NET by Charles Cook (see http://www.xml-rpc.net).
XML-RPC.NET is licensed under the MIT X11 license; see
LICENSE.CookComputing.XmlRpcV2.txt for details. The library
(CookComputing.XmlRpcV2.dll) is shipped with XenServer.NET.


Downloads
---------

The XenServer-SDK-7.2.0.zip contains the following folders that are
relevant to .NET programmers:
- XenServer.NET\bin: contains the ready compiled binaries
- XenServer.NET\src: contains the source code shipped as a Visual Studio project.
- XenServer.NET\samples: contains the examples shipped as a Visual studio solution.


Getting Started
---------------

Download and unzip the XenServer-SDK-7.2.0.zip.

A. To use the compiled binaries in your code:
  1.  Copy both XenServer.dll and CookComputing.XmlRpcV2.dll from the bin folder
      into your own workspace.
  2.  In Visual Studio, add references to both DLLs from your own program.
      Project > Add Reference > Browse.
  3.  You should now be ready to compile against XenServer.NET.

B. To build the source code:
  1. Copy CookComputing.XmlRpcV2.dll from the bin folder into the source code
     folder at the same level as the XenServer.csproj file.
  2. Open the project XenServer.csproj in Visual Studio.
  3. You should now be ready to build the source code.

C. To run the examples:
  1. Copy CookComputing.XmlRpcV2.dll from the bin folder into the samples folder
     at the same level as the XenSdkSample.sln file.
  2. Open XenSdkSample.sln inside Visual Studio (2013 or greater).
  3. You should now be ready to compile the solution and run the examples.
     Each of the solution projects is a console application expecting the parameters
     <host> <username> <password> to be passed to its Main method.
