Develop for XenServer

Management API reference

This section provides the API reference information for all supported versions of XenServer and Citrix Hypervisor:

API overview

The API has the following key features:

  • Management of all aspects of the XenServer host.

    The API allows you to manage VMs, storage, networking, host configuration, and pools. Performance and status metrics can also be queried from the API.

  • Persistent Object Model.

    The results of all side-effecting operations (for example: object creation, deletion, and parameter changes) are persisted in a server-side database that is managed by XenServer.

  • An event mechanism.

    Through the API, clients can register to be notified when persistent (server-side) objects are changed. This enables applications to track datamodel changes performed by concurrently running clients.

  • Synchronous and asynchronous invocation.

    All API calls can be invoked synchronously (that is, block until completion). Any API call that might be long-running can also be invoked asynchronously. Asynchronous calls return immediately with a reference to a task object. This task object can be queried (through the API) for progress and status information. When an asynchronously invoked operation completes, the result (or errorcode) is available from the task object.

  • Remotable and Cross-Platform.

    The client issuing the API calls doesn’t have to be resident on the host being managed. The client also does not have to be connected to the host over SSH to run the API. API calls use the RPC protocol to transmit requests and responses over the network.

  • Secure and Authenticated Access.

    The RPC API backend running on the host accepts secure socket connections. This allows a client to run the APIs over the HTTPS protocol. Further, all the API calls run in the context of a login session generated through user name and password validation at the server. This provides secure and authenticated access to the XenServer installation.

XenServer Management API Deprecation Policy

Items that will be removed in a future release are marked as deprecated.

By default, deprecated APIs and product functionality continue to be supported up to and including the next XenServer Long Term Service Release (LTSR). Deprecated items are usually removed in releases following that LTSR.

In exceptional cases, an item might be deprecated and removed before the next LTSR. For example, a change might be required to improve security. If this happens, customers are made aware of the change to the API or the product functionality.

This deprecation policy applies only to APIs and functionality that are documented at the following locations:

Management API reference