 |
|
Content Owner: Roman Macek | ||||
Summary
REST API, Python CLI, Hooks, SDK
Details
RHV exposes several interfaces for interacting with the virtualization environment. These interfaces are in addition to the user interfaces provided by the
Red Hat Virtualization Manager Administration, User, and Reports Portals. Some of the interfaces are supported only for read access or only when it has been explicitly requested by Red Hat Support.
Supported Interfaces (Read and Write Access):
- Representational State Transfer (REST) API: With the release of RHV-3 Red Hat introduced a new Representational State Transfer (REST) API. The REST API is useful for developers and administrators who aim to integrate the functionality of a Red Hat Virtualization environment with custom scripts or external applications that access the API via standard HTTP. The REST API exposed by the Red Hat Virtualization Manager is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Python Software Development Kit (SDK): This SDK provides Python libraries for interacting with the REST API. The Python SDK provided by the RHVm-sdk-python package is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Java Software Development Kit (SDK): This SDK provides Java libraries for interacting with the REST API. The Java SDK provided by the RHVm-sdk-java package is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Linux Command Line Shell: The command line shell provided by the RHVm-cli package is a fully supported interface for interacting with the Red Hat Virtualization Manager.
- VDSM Hooks: The creation and use of VDSM hooks to trigger modification of virtual machines based on custom properties specified in the Administration Portal is supported on Red Hat Enterprise Linux virtualization hosts. The use of VDSM Hooks on virtualization hosts running Red Hat Virtualization Hypervisor is not currently supported.
Additional Supported Interfaces (Read Access)
Use of these interfaces for write access is not supported unless explicitly requested by Red Hat Support:
- Red Hat Virtualization Manager History Database
- Libvirt on Virtualization Hosts
Unsupported Interfaces
Direct interaction with these interfaces is not supported unless your use of them is explicitly requested by Red Hat Support:
- The vdsClient Command
- Red Hat Virtualization Hypervisor Console
- Red Hat Virtualization Manager Database
Red Hat Virtualization Manager Administration, User, and Reports Portals. Some of the interfaces are supported only for read access or only when it has been explicitly requested by Red Hat Support.
Supported Interfaces (Read and Write Access):
- Representational State Transfer (REST) API: With the release of RHV-3 Red Hat introduced a new Representational State Transfer (REST) API. The REST API is useful for developers and administrators who aim to integrate the functionality of a Red Hat Virtualization environment with custom scripts or external applications that access the API via standard HTTP. The REST API exposed by the Red Hat Virtualization Manager is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Python Software Development Kit (SDK): This SDK provides Python libraries for interacting with the REST API. The Python SDK provided by the RHVm-sdk-python package is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Java Software Development Kit (SDK): This SDK provides Java libraries for interacting with the REST API. The Java SDK provided by the RHVm-sdk-java package is a fully supported interface for interacting with Red Hat Virtualization Manager.
- Linux Command Line Shell: The command line shell provided by the RHVm-cli package is a fully supported interface for interacting with the Red Hat Virtualization Manager.
- VDSM Hooks: The creation and use of VDSM hooks to trigger modification of virtual machines based on custom properties specified in the Administration Portal is supported on Red Hat Enterprise Linux virtualization hosts. The use of VDSM Hooks on virtualization hosts running Red Hat Virtualization Hypervisor is not currently supported.
Additional Supported Interfaces (Read Access)
Use of these interfaces for write access is not supported unless explicitly requested by Red Hat Support:
- Red Hat Virtualization Manager History Database
- Libvirt on Virtualization Hosts
Unsupported Interfaces
Direct interaction with these interfaces is not supported unless your use of them is explicitly requested by Red Hat Support:
- The vdsClient Command
- Red Hat Virtualization Hypervisor Console
- Red Hat Virtualization Manager Database
