XAPI: Difference between revisions
From Xen
Jump to navigationJump to search
Rcpavlicek (talk | contribs) |
Rcpavlicek (talk | contribs) |
||
| (15 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Needs_Additions|This page needs to be created. We need a proper definition of XAPI, examples, links on how to use it, etc.}} |
|||
== What is the XAPI Project? == |
== What is the XAPI Project? == |
||
| Line 12: | Line 10: | ||
* A Xen Project Toolstack that exposes the XAPI interface. When we refer to XAPI as a toolstack, we typically include all dependencies and components that are needed for XAPI to operate (e.g. xenopsd). |
* A Xen Project Toolstack that exposes the XAPI interface. When we refer to XAPI as a toolstack, we typically include all dependencies and components that are needed for XAPI to operate (e.g. xenopsd). |
||
* An interface for remotely configuring and controlling virtualised guests running on a Xen-enabled host. XAPI is the core component of XenServer and XCP. |
* An interface for remotely configuring and controlling virtualised guests running on a Xen-enabled host. XAPI is the core component of [[XenServer]] and [[XCP]]. |
||
XAPI adds additional functionality compared to other Xen Project toolstacks, including: |
XAPI adds additional functionality compared to other Xen Project toolstacks, including: |
||
| Line 26: | Line 24: | ||
* Built-in support and templates for Windows and Linux guests |
* Built-in support and templates for Windows and Linux guests |
||
== |
== How Do I Use XAPI? == |
||
The "xe" syntax is fairly straightforward. |
|||
An "xe" command executed from Domain 0 would look like: |
|||
<pre>xe <command-name> <argument=values...></pre> |
|||
From a user domain, the syntax will look like: |
|||
<pre>xe -s <host> -u <username> -pw <password> <command-name> <argument=values...></pre> |
|||
So if you wanted to see a list of VMs on a host from Domain 0, you would use the command: |
|||
<pre>xe vm-list </pre> |
|||
* Information about the "xe" commands can be found on the [[Command_Line_Interface]] page |
|||
XAPI is the core component of [[XenServer]] (and, therefore, the former XenServer offshoot known as [[:Category:XCP|XCP]]). XAPI adds |
|||
* Read details on the [[XAPI_Management_Tools]] page |
|||
additional functionality compared to other Xen toolstacks, for example (but not limited to) |
|||
* Extends Xen to cover multiple hosts |
|||
* VM lifecycle: live snapshots, checkpoint, migration |
|||
* Resource pools: live migration, auto configuration, disaster recovery |
|||
* Flexible storage and networking |
|||
* Event tracking: progress, notification |
|||
* Upgrade and patching capabilities |
|||
* Real-time performance monitoring and alerting |
|||
== Further Information == |
== Further Information == |
||
* See [[:Category:XCP|Category:XCP]] |
* See [[:Category:XAPI|Category:XAPI]] and [[:Category:XCP|Category:XCP]] |
||
== 3rd party Integrations and tools == |
== 3rd party Integrations and tools == |
||
Latest revision as of 19:51, 2 June 2014
What is the XAPI Project?
The XAPI project is a sub-project (or team) of the Xen Project effort that develops the enterprise ready XAPI toolstack. The hypervisor used with the XAPI toolstack consolidates server workloads, enables savings in power, cooling, and management costs and thus contributing to environmentally sustainable computing, an increased ability to adapt to ever-changing IT environments, an optimized use of existing hardware, and an improved level of IT reliability.
The XAPI team also develops tooling, agents and libraries that are needed to operate a XAPI based system.
What is XAPI?
The Xen Project Management API (XAPI) is:
- A Xen Project Toolstack that exposes the XAPI interface. When we refer to XAPI as a toolstack, we typically include all dependencies and components that are needed for XAPI to operate (e.g. xenopsd).
- An interface for remotely configuring and controlling virtualised guests running on a Xen-enabled host. XAPI is the core component of XenServer and XCP.
XAPI adds additional functionality compared to other Xen Project toolstacks, including:
- Extending the software to cover multiple hosts
- Enhancing the VM lifecycle, including live snapshots, VM checkpointing, and VM migration
- Enabling resource pools to include live migration, auto configuration, and disaster recovery
- Allowing flexible storage and networking including integrated Open vSwitch support and storage XenMotion® live Migration (cross-pool migration, VDI migration)
- Enabling event tracking, with progress and notification
- Creating upgrade and patching capabilities
- Facilitating real-time performance monitoring and alerting
- Integrations with cloud orchestration stacks
- Built-in support and templates for Windows and Linux guests
How Do I Use XAPI?
The "xe" syntax is fairly straightforward.
An "xe" command executed from Domain 0 would look like:
xe <command-name> <argument=values...>
From a user domain, the syntax will look like:
xe -s <host> -u <username> -pw <password> <command-name> <argument=values...>
So if you wanted to see a list of VMs on a host from Domain 0, you would use the command:
xe vm-list
- Information about the "xe" commands can be found on the Command_Line_Interface page
- Read details on the XAPI_Management_Tools page
Further Information
- See Category:XAPI and Category:XCP
