Red Hat Enterprise Virtualization 3.0
Using the Red Hat Enterprise Virtualization Representational State Transfer Application Programming Interface
Edition 1
Legal Notice
Copyright © 2011 Red Hat, Inc.
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack Logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Abstract
This document describes the Representational State Transfer (REST) API for Red Hat Enterprise Virtualization.
- Preface
- 1. Introduction
- 2. Authentication and Security
- 3. Beginner Example
- 3.1. Access API Entry Point
- 3.2. List Data Center Collection
- 3.3. List Host Cluster Collection
- 3.4. List Logical Networks Collection
- 3.5. List Host Collection
- 3.6. Approve Host
- 3.7. Create NFS Data Storage
- 3.8. Create NFS ISO Storage
- 3.9. Attach Storage Domains to Data Center
- 3.10. Activate Storage Domains
- 3.11. Create Virtual Machine
- 3.12. Create Virtual Machine NIC
- 3.13. Create Virtual Machine Storage Disk
- 3.14. Attach ISO Image to Virtual Machine
- 3.15. Start Virtual Machine
- 3.16. Check System Events
- 3.17. Example Completion
- 4. Entry Point
- 5. Compatibility Level Versions
- 6. Capabilities
- 6.1. Version-Dependent Capabilities
- 6.1.1. Current Version
- 6.1.2. Features
- 6.1.3. CPUs
- 6.1.4. Power Managers
- 6.1.5. Fence Types
- 6.1.6. Storage Types
- 6.1.7. Storage Domain Types
- 6.1.8. Virtual Machine Types
- 6.1.9. Boot Devices
- 6.1.10. Display Types
- 6.1.11. NIC Interface Types
- 6.1.12. Disk Types
- 6.1.13. OS Types
- 6.1.14. Disk Formats
- 6.1.15. Disk Interfaces
- 6.1.16. Virtual Machine Affinities
- 6.1.17. Custom Properties
- 6.1.18. Boot Protocols
- 6.1.19. Error Handling
- 6.1.20. Storage Formats
- 6.1.21. Resource Status States
- 6.2. Permits
- 6.3. Scheduling Policies
- 6.4. Capabilities Example
- 7. Common Features
- 8. Data Centers
- 9. Host Clusters
- 10. Networks
- 11. Storage Domains
- 12. Hosts
- 13. Virtual Machines
- 14. Templates
- 15. Virtual Machine Pools
- 16. Domains
- 17. Groups
- 18. Roles
- 19. Users
- 20. Tags
- 21. Events
- A. API Usage with cURL
- B. Java Keystores
- C. Event Codes
- D. Timezones
- E. Revision History