1.3. Red Hat Enterprise Virtualization REST API Prerequisites
This guide requires the following:
- A networked installation of Red Hat Enterprise Virtualization Manager, which includes the REST API;
- A client or programming library that initiates and receives HTTP requests from the REST API. For example:
- Red Hat Enterprise Virtualization 3.1 and higher provides a Python software development kit (SDK) that interacts with the REST API. This guide includes a Python Beginner Example to help developers get started with using the SDK.
- This guide includes basic instructions on use with cURL.
- Knowledge of Hypertext Transfer Protocol (HTTP), which is the protocol used for REST API interactions. The Internet Engineering Task Force provides a Request for Comments (RFC) explaining the Hypertext Transfer Protocol at http://www.ietf.org/rfc/rfc2616.txt; and,
- Knowledge of Extensible Markup Language (XML), which the API uses to construct resource representations. The W3C provides a full specification on XML at http://www.w3.org/TR/xml/.
Note
Each version of Red Hat Enterprise Virtualization has a unique SDK associated with it. Please ensure that you are using the correct SDK for your current environment. For example, if you are using Red Hat enterprise Virtualization 3.2, you should be using the SDK developed for 3.2.
Additionally, to use the Python SDK you will need to download and install the rhevm-sdk package. This package is available to systems subscribed to a
Red Hat Enterprise Virtualization entitlement pool if using certificate-based Red Hat Network, or the Red Hat Enterprise Virtualization Manager channel if using Red Hat Network classic. See the Red Hat Enterprise Virtualization Installation Guide for more information on subscribing your system(s) to download software from these locations.
Note
Refer to the Red Hat Enterprise Virtualization Manager Release Notes for specific channel names current to your system.