Getting Started with C #

September 6, 2024

Contributed by:

X X

The XenServer-SDK directory contains the following folders that are relevant to C# programmers:

XenServer.NET: The XenServer SDK for C#.NET.
- XenServer.NET.x.y.z.nupkg: The compiled library shipped as a NuGet package.
- src: XenServer.NET source code shipped as a Microsoft Visual Studio project. Every API object is associated with one C# file. For example, the functions implementing the VM operations are contained within the file VM.cs.

RPC protocol

The C# SDK supports the JSON-RPC v2.0 protocol.

Platform supported

Windows
Linux

The compiled library targets .NET Framework version 4.5 and .NET Standard 2.0.

Library

The library is generated as a Dynamic Link Library XenServer.dll that C# programs can reference.

The C# SDK is backwards compatible and can be used to interact with hosts running all versions of XenServer or Citrix Hypervisor (from XenServer 7.3 and Citrix Hypervisor 8.0 onwards).

Dependencies

Newtonsoft JSON.NET by James Newton-King.

Installation

To use the NuGet package in your code, add its location as a NuGet source:

nuget sources Add -Name "Offline Package" -Source "/full/path/to/package/directory"

Then install the package:

nuget install XenServer.NET

Building the source code

Open the project XenServer.csproj in Visual Studio 2022. You should now be ready to build the source code.

Examples

Examples on the usage of the C# SDK can be found at XenServer.NET usage examples on GitHub.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Getting Started with C #

September 6, 2024

Contributed by:

X X

September 6, 2024

Contributed by:

X X

Getting Started with C #

RPC protocol

Platform supported

Library

Dependencies

Installation

Building the source code

Examples

In this article