Getting Started with Go

September 6, 2024

Contributed by:

X X

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

XenServerGo: The XenServer SDK for Go.
- src: XenServerGo shipped as source files which can be used as a local module for other Go projects. Every API object is associated with one Go file. For example, the functions implementing the VM operations are contained within the file vm.go.

RPC protocol

The Go SDK supports the JSON-RPC v2.0 protocol.

Platform supported

Windows
Linux

This library requires Go 1.22 or greater.

Note:

This module is backwards compatible by using different names for API functions that have changed throughout different XenServer or Citrix Hypervisor versions. To communicate with hosts running different versions of Citrix Hypervisor or XenServer, it is advisable to check the versions supported by each function first. For example, Host.Evacuate3 can only be used for servers running XAPI version 1.297.0 or above and Host.Evacuate4 for servers running XAPI version 23.27.0 or above.

Installation

Extract the contents of the SDK ZIP file.
Navigate to the extracted XenServer-SDK\XenServerGo directory and copy the whole folder src into your Go project directory.

To use XenServerGo SDK as a local Go module, include the following line into the go.mod file under your Go project:
```
replace xenapi => ./src

```
You can then import the XenServer module with the following command:
```
import "xenapi"

```
Before building your project, run the following Go commands.
```
go get -u all
go mod tidy

```

Examples

Examples on the usage of the XenServer SDK for Go can be found at XenServerGo 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 Go

September 6, 2024

Contributed by:

X X

September 6, 2024

Contributed by:

X X

Getting Started with Go

RPC protocol

Platform supported

Installation

Examples

In this article