The Oracle VM Web Services API Developer's Guide is your reference for the Oracle VM Application Programmer's Interface (API). This guide provides information about the Oracle VM Web Services API (WSAPI) for developers and system administrators who are interested in implementing scripts and programs to manage and automate Oracle VM.

This document is intended to be used alongside the API documentation included in the SDK that is packaged with the Oracle VM Manager installation ISO. This document does not provide comprehensive coverage of the API, but is intended to assist developers to create proof of concept client applications.


This document is intended for experienced developers who are building applications for managing and automating Oracle VM. This guide assumes that you have an in depth knowledge of Oracle VM (see the Oracle VM Manager User's Guide and the Oracle VM Manager Command Line Interface User's Guide), and that you have knowledge of programming against web services APIs exported via REST and SOAP interfaces.

Command Syntax

Oracle Linux command syntax appears in monospace font. The dollar character ($), number sign (#), or percent character (%) are Oracle Linux command prompts. Do not enter them as part of the command. The following command syntax conventions are used in this guide:



backslash \

A backslash is the Oracle Linux command continuation character. It is used in command examples that are too long to fit on a single line. Enter the command as displayed (with a backslash) or enter it on a single line without a backslash:

dd if=/dev/rdsk/c0t1d0s6 of=/dev/rst0 bs=10b \

braces { }

Braces indicate required items:

.DEFINE {macro1}

brackets [ ]

Brackets indicate optional items:

cvtcrt termname [outfile]

ellipses ...

Ellipses indicate an arbitrary number of similar items:

CHKVAL fieldname value1 value2 ... valueN


Italic type indicates a variable. Substitute a value for the variable:


vertical line |

A vertical line indicates a choice within braces or brackets:

FILE filesize [K|M]

forward slash /

A forward slash is used to escape special characters within single or double quotes in the Oracle VM Manager Command Line Interface, for example:

create Tag name=MyTag description="HR/'s VMs"


The following text conventions are used in this document:




Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.


Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.


Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit

Diversity and Inclusion

Oracle is fully committed to diversity and inclusion. Oracle recognizes the influence of ethnic and cultural values and is working to remove language from our products and documentation that might be considered insensitive. While doing so, we are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve. Because of these technical constraints, our effort to remove insensitive terms is an ongoing, long-term process.