HP BL680c XenServer Software Development Kit Guide 4.1.0 - Page 9

Getting Started

3

Directory

Description

/SDK/docs/html/

Contains index.html, the HTML version of the

reference for the API

/SDK/windows-cli

a Windows version of the CLI xe.exe

/SDK/client-examples/c

C examples and a Makefile to build them

/SDK/client-examples/c/src

C source for the language bindings

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

Microsoft Visual Studio 2005 solution which

includes the C# language bindings (which compile

to a .dll) and several example projects

/SDK/client-examples/bash-cli

Simple bash scripts which use the xe CLI

/SDK/client-examples/python

Several example python programs

2.6. Building Samples for the Linux Platform

The SDK VM comes complete with the tools necessary to build the C samples. Looking at the content

map, the directory

/SDK/client-examples/c

has a Makefile at the top level which builds the language

bindings, as well as the C language samples that are included as part of the SDK VM.

2.7. Building Samples for the Windows Platform

The C# examples in

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

must first be copied to a Windows

machine with Visual Studio and .NET 2.0 installed. The C# bindings and the samples directories each have

the appropriate solution (

.sln

) files generated by Microsoft Visual Studio 2005. Launching them via the

Windows Explorer and rebuilding at the top level will build the language bindings as well as the applications.

The IP address of the host is passed in as a parameter to each of the sample applications. This needs to

be set/changed to ensure that the applications work against the right XenServer Host.

2.8. Running the CLI

The CLI for Linux is called

xe

, and for Windows is called

xe.exe

. The Windows version is under

/SDK/

windows-cli

. This needs to be copied onto a PC running Windows XP or higher, and must have .Net 2.0

installed. When running in the SDK VM, the Linux CLI is already installed and in the default path. Typing

xe

in the SDK VM console launches the CLI.

2.8.1. Tab Completion

The CLI has comprehensive tab completion that allows discovery of the commands and parameters. On

launching xe, hitting tab twice shows all the commands that the CLI has.

2.9. Accessing SDK reference

The SDK VM has a built-in web server that allows access to the samples and the complete reference

documentation.

Procedure 2.1. To access this information

1.

From the command prompt type

ifconfig

and hit ENTER.

2.

Note down the IP address for the

eth0

interface for this VM. If there is no eth0 interface, please add

a virtual NIC.

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 9

Building Samples for the Linux Platform, 2.8. Running the CLI, 2.8.1. Tab Completion

Page 9 highlights