HP BL680c XenServer Software Development Kit Guide 4.1.0 - Page 24

Using the API

18

Dependencies:

•

XML-RPC library (libxml2.so on GNU Linux)

•

Curl library (libcurl2.so)

One simple example is included within the SDK called

test_vm_ops

. The example demonstrates how to

query the capabilities of a host, create a VM, attach a fresh blank disk image to the VM and then perform

various powercycle operations.

4.2.2. C#

The C# bindings are contained within the directory

/SDK/client-examples/csharp/XenSdk.net

and

include project files suitable for building under Microsoft Visual Studio. Every API object is associated with

one C# file; for example the functions implementing the VM operations are contained within the file

VM.cs

.

C# binding dependencies

Platform

supported:

Windows with .NET version 2.0

Library:

The language binding is generated as a Dynamic Link Library Xenapi.dll that is linked by

C# programs

Dependencies:

CookComputing.XMLRpcV2.dll is needed for the xenapi.dll to be able to communicate

with the xml-rpc server.

Two simple examples are included with the C# bindings in the directory

/SDK/client-exam-

ples/csharp/XenSdk.net

:

•

VM-Lifecycle

: logs into a XenServer Host, lists all the VM records, filters out the templates, clones a

VM from one template, configures the name and description of the VM before finally power-cycling the

VM; and

•

Monitor

: logs into a XenServer Host, queries properties of a host, lists all Storage Repositories, lists all

VMs and prints various attributes.

4.2.3. Python

The python bindings are contained within a single file:

/SDK/client-examples/python/XenAPI.py

.

Python binding dependencies

Platform

supported:

Linux

Library:

XenAPI.py

Dependencies:

None

The SDK includes 7 python examples:

•

fixpbds.py

: reconfigures the settings used to access shared storage;

•

install.py

: installs a Debian VM, connects it to a network, starts it up and waits for it to report its IP address;

•

license.py

: uploads a fresh license to a XenServer Host;

Section	Page
XenServer Software Development Kit Guide	1
Table of Contents	4
Chapter 1. Introduction	7
Chapter 2. Getting Started	8
2.1. System Requirements and Preparation	8
2.2. Downloading	8
2.3. Installation	8
2.4. What's new	8
2.5. Content Map	8
2.6. Building Samples for the Linux Platform	9
2.7. Building Samples for the Windows Platform	9
2.8. Running the CLI	9
2.8.1. Tab Completion	9
2.9. Accessing SDK reference	9
Chapter 3. Overview of the XenServer API	11
3.1. Getting Started with the API	11
3.1.1. Authentication: acquiring a session reference	11
3.1.2. Acquiring a list of templates to base a new VM installation on	11
3.1.3. Installing the VM based on a template	12
3.1.4. Taking the VM through a start/suspend/resume/stop cycle	12
3.1.5. Logging out	12
3.1.6. \	13
3.2. Object Model Overview	13
3.3. Working with VIFs and VBDs	15
3.3.1. Creating disks and attaching them to VMs	15
3.3.1.1. Creating a new blank disk image	16
3.3.1.2. Attaching the disk image to a VM	16
3.3.1.3. Hotplugging the VBD	17
3.3.2. Creating and attaching Network Devices to VMs	17
3.3.3. Host configuration for networking and storage	17
3.3.3.1. Host storage configuration: PBDs	18
3.3.3.2. Host networking configuration: PIFs	18
3.4. Exporting and Importing VMs	18
3.5. Where to look next	19
Chapter 4. Using the API	20
4.1. Anatomy of a typical application	20
4.1.1. Choosing a low-level transport	20
4.1.2. Authentication and session handling	20
4.1.3. Finding references to useful objects	21
4.1.4. Invoking synchronous operations on objects	21
4.1.5. Using Tasks to manage asynchronous operations	22
4.1.6. Subscribing to and listening for events	22
4.2. Language bindings	23
4.2.1. C	23
4.2.2. C#	24
4.2.3. Python	24
4.2.4. Command Line Interface (CLI)	25
4.3. Complete application examples	25
4.3.1. Simultaneously migrating VMs using XenMotion	25
4.3.2. Cloning a VM via the XE CLI	28
Chapter 5. XenServer API extensions	30
5.1. VM console forwarding	30
5.1.1. Retrieving VNC consoles via the API	30
5.1.2. Disabling VNC forwarding for Linux VM	31
5.2. Paravirtual Linux installation	32
5.2.1. Red Hat Enterprise Linux 4.1/4.4	32
5.2.2. Red Hat Enterprise Linux 4.5/5.0	32
5.2.3. SUSE Enterprise Linux 10 SP1	33
5.2.4. CentOS 4.5/5.0	33
5.3. Adding Xenstore entries to VMs	33
5.4. Security enhancements	33
5.5. Advanced settings for network interfaces	34
5.5.1. ethtool settings	34
5.5.2. Miscellaneous settings	35
5.6. Internationalization for SR names	35
5.7. Hiding objects from XenCenter	36

HP BL680c XenServer Software Development Kit Guide 4.1.0 - Page 24

C#, 4.2.3. Python, C# binding dependencies

Page 24 highlights