Red Hat Summitこのコンテンツは選択した言語では利用できません。
REST API Guide
Using the Red Hat Virtualization REST Application Programming Interface
Abstract
ovirt-engine-api-model code, and is currently partially complete. Updated versions of this documentation will be published as new content becomes available.
Chapter 1. Introduction
The Red Hat Virtualization Manager provides a Representational State Transfer (REST) API. The API provides software developers and system administrators with control over their Red Hat Virtualization environment outside of the standard web interface. The API is useful for developers and administrators to integrate the functionality of a Red Hat Virtualization environment with custom scripts or external applications that access the API via the standard Hypertext Transfer Protocol (HTTP).
The benefits of the API are:
- Broad client support - Any programming language, framework, or system with support for HTTP protocol can use the API.
- Self descriptive - Client applications require minimal knowledge of the virtualization infrastructure, as many details are discovered at runtime.
- Resource-based model - The resource-based REST model provides a natural way to manage a virtualization platform.
This provides developers and administrators with the ability to:
- Integrate with enterprise IT systems.
- Integrate with third-party virtualization software.
- Perform automated maintenance or error-checking tasks.
- Automate repetitive tasks in a Red Hat Virtualization environment with scripts.
This documentation acts as a reference for the Red Hat Virtualization API. It aims to provide developers and administrators with instructions and examples to help harness the functionality of their Red Hat Virtualization environment through the API, either directly or using the provided SDKs.
1.1. Representational State Transfer
Representational State Transfer (REST) is a design architecture that focuses on resources for a specific service and their representations. A resource representation is a key abstraction of information that corresponds to one specific managed element on a server. A client sends a request to a server element located at a Uniform Resource Identifier (URI) and performs operations with standard HTTP methods, such as GET, POST, PUT, and DELETE. This provides a stateless communication between the client and server where each request acts independently of any other request, and contains all the information necessary to complete the request.
1.2. API Prerequisites
Prerequisites for using the Red Hat Virtualization API:
- A networked installation of Red Hat Virtualization Manager, which includes the API.
A client or programming library that initiates and receives HTTP requests from the API server. For example:
- The oVirt Python SDK.
- The oVirt Ruby SDK.
- The oVirt Java SDK.
- The cURL command line tool.
- RESTClient, a debugger for RESTful web services.
- Knowledge of Hypertext Transfer Protocol (HTTP), 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.
- Knowledge of Extensible Markup Language (XML) or JavaScript Object Notation (JSON), which the API uses to construct resource representations. The W3C provides a full specification on XML at http://www.w3.org/TR/xml. ECMA International provide a free publication on JSON at http://www.ecma-international.org.
Chapter 2. Authentication and Security
2.1. TLS/SSL Certification
The Red Hat Virtualization API requires Hypertext Transfer Protocol Secure (HTTPS) [1] for secure interaction with client software, such as the SDK and CLI components. This involves obtaining the CA certificate used by the server, and importing it into the certificate store of your client.
2.1.1. Obtaining the CA Certificate
You can obtain the CA certificate from the Red Hat Virtualization Manager and transfer it to the client machine using one of these methods:
- Method 1
The preferred method for obtaining the CA certificate is to use the
openssl s_clientcommand line tool to perform a real TLS handshake with the server, and then extract the certificates that it presents. Run a command like this:openssl s_client \ -connect myengine.example.com:443 \ -showcerts \ < /dev/null
$ openssl s_client \ -connect myengine.example.com:443 \ -showcerts \ < /dev/nullCopy to Clipboard Copied! Toggle word wrap Toggle overflow This command will connect to the server and display output similar to the following:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The text between the
-----BEGIN CERTIFICATE-----and-----END CERTIFICATE-----marks shows the certificates presented by the server. The first one is the certificate of the server itself, and the last one is the certificate of the CA. Copy the CA certificate, including the marks, to theca.crtfile. The result should look like this:-----BEGIN CERTIFICATE----- MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs Pkyg1rQHR6ebGQ== -----END CERTIFICATE-----
-----BEGIN CERTIFICATE----- MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs Pkyg1rQHR6ebGQ== -----END CERTIFICATE-----Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantThis is the most reliable method to obtain the CA certificate used by the server. The rest of the methods described here will work in most cases, but they will not obtain the correct CA certificate if it has been manually replaced by the administrator of the server.
- Method 2
If you cannot use the
openssl s_clientmethod described above, you can instead use a command line tool to download the CA certificate from the Red Hat Virtualization Manager.Examples of command line tools include
curlandwget, both of which are available on multiple platforms.If using
curl:curl \ --output ca.crt \ 'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'
$ curl \ --output ca.crt \ 'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'Copy to Clipboard Copied! Toggle word wrap Toggle overflow If using
wget:wget \ --output-document ca.crt \ 'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'
$ wget \ --output-document ca.crt \ 'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Method 3
Use a web browser to navigate to the certificate located at:
https://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA
https://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CACopy to Clipboard Copied! Toggle word wrap Toggle overflow Depending on the chosen browser, the certificate either downloads or imports into the browser’s keystore.
-
If the browser downloads the certificate: save the file as
ca.crt. -
If the browser imports the certificate: export it from the browser’s certification options and save it as
ca.crt.
-
If the browser downloads the certificate: save the file as
- Method 4
Log in to the Red Hat Virtualization Manager, export the certificate from the truststore, and copy it to your client machine.
-
Log in to the Red Hat Virtualization Manager machine as
root. Export the certificate from the truststore using the Java
keytoolmanagement utility:Copy to Clipboard Copied! Toggle word wrap Toggle overflow This creates a certificate file called
ca.crt.Copy the certificate to the client machine using the
scpcommand:scp ca.crt myuser@myclient.example.com:/home/myuser/.
$ scp ca.crt myuser@myclient.example.com:/home/myuser/.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
-
Log in to the Red Hat Virtualization Manager machine as
Each of these methods results in a certificate file named ca.crt on your client machine. You must then import this file into the certificate store of the client.
2.1.2. Importing a Certificate to a Client
Importing a certificate to a client relies on how the client stores and interprets certificates. See your client documentation for more information on importing a certificate.
2.2. Authentication
Any user with a Red Hat Virtualization Manager account has access to the API. All requests must be authenticated using either OAuth or basic authentication, as described below.
2.2.1. OAuth Authentication
Since version 4.0 of Red Hat Virtualization the preferred authentication mechanism is OAuth 2.0, as described in RFC 6749.
OAuth is a sophisticated protocol, with several mechanisms for obtaining authorization and access tokens. For use with the Red Hat Virtualization API, the only supported one is the Resource Owner Password Credentials Grant, as described in section 4.3 of RFC 6749.
You must first obtain a token, sending the user name and password to the Red Hat Virtualization Manager single sign-on service:
POST /ovirt-engine/sso/oauth/token HTTP/1.1 Host: myengine.example.com Content-Type: application/x-www-form-urlencoded Accept: application/json
POST /ovirt-engine/sso/oauth/token HTTP/1.1
Host: myengine.example.com
Content-Type: application/x-www-form-urlencoded
Accept: application/json
The request body must contain the grant_type, scope, username, and password parameters:
| Name | Value |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
These parameters must be URL-encoded. For example, the @ character in the user name needs to be encoded as %40. The resulting request body will be something like this:
grant_type=password&scope=ovirt-app-api&username=admin%40internal&password=mypassword
grant_type=password&scope=ovirt-app-api&username=admin%40internal&password=mypassword
The scope parameter is described as optional in the OAuth RFC, but when using it with the Red Hat Virtualization API it is mandatory, and its value must be ovirt-app-api.
If the user name and password are valid, the Red Hat Virtualization Manager single sign-on service will respond with a JSON document similar to this one:
For API authentication purposes, the only relevant name/value pair is the access_token. Do not manipulate this in any way; use it exactly as provided by the SSO service.
Once the token has been obtained, it can be used to perform requests to the API by including it in the HTTP Authorization header, and using the Bearer scheme. For example, to get the list of virtual machines, send a request like this:
GET /ovirt-engine/api/vms HTTP/1.1 Host: myengine.example.com Accept: application/xml Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
GET /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Accept: application/xml
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=The token can be used multiple times, for multiple requests, but it will eventually expire. When it expires, the server will reject the request with the 401 HTTP response code:
HTTP/1.1 401 Unauthorized
HTTP/1.1 401 UnauthorizedWhen this happens, a new token is needed, as the Red Hat Virtualization Manager single sign-on service does not currently support refreshing tokens. A new token can be requested using the same method described above.
2.2.2. Basic Authentication
Basic authentication is supported only for backwards compatibility; it is deprecated since version 4.0 of Red Hat Virtualization, and will be removed in the future.
Each request uses HTTP Basic Authentication [2] to encode the credentials. If a request does not include an appropriate Authorization header, the server sends a 401 Authorization Required response:
HEAD /ovirt-engine/api HTTP/1.1 Host: myengine.example.com HTTP/1.1 401 Authorization Required
HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
HTTP/1.1 401 Authorization Required
Request are issued with an Authorization header for the specified realm. Encode an appropriate Red Hat Virtualization Manager domain and user in the supplied credentials with the username@domain:password convention.
The following table shows the process for encoding credentials in Base64.
| Item | Value |
|---|---|
| User name |
|
| Domain |
|
| Password |
|
| Unencoded credentials |
|
| Base64 encoded credentials |
|
Provide the Base64-encoded credentials as shown:
HEAD /ovirt-engine/api HTTP/1.1 Host: myengine.example.com Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA== HTTP/1.1 200 OK
HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
HTTP/1.1 200 OKBasic authentication involves potentially sensitive information, such as passwords, sent as plain text. The API requires Hypertext Transfer Protocol Secure (HTTPS) for transport-level encryption of plain-text requests.
Some Base64 libraries break the result into multiple lines and terminate each line with a newline character. This breaks the header and causes a faulty request. The Authorization header requires the encoded credentials on a single line within the header.
2.2.3. Authentication Sessions
The API also provides authentication session support. Send an initial request with authentication details, then send all subsequent requests using a session cookie to authenticate.
2.2.3.1. Requesting an Authenticated Session
Send a request with the
AuthorizationandPrefer: persistent-authheaders:Copy to Clipboard Copied! Toggle word wrap Toggle overflow This returns a response with the following header:
Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure
Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; SecureCopy to Clipboard Copied! Toggle word wrap Toggle overflow Take note of the
JSESSIONID=value. In this example the value is5dQja5ubr4yvI2MM2z+LZxrK.Send all subsequent requests with the
Prefer: persistent-authandCookieheaders with theJSESSIONID=value. TheAuthorizationheader is no longer needed when using an authenticated session.Copy to Clipboard Copied! Toggle word wrap Toggle overflow When the session is no longer required, perform a request to the sever without the
Prefer: persistent-authheader.Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 3. Common concepts
3.1. Types
The API uses the type concept to describe the different kinds of objects accepted and returned.
There are three relevant kinds of types:
3.2. Identified types
Many of the types used by the API represent identified objects, objects that have an unique identifier and exist independently of other objects. The types used to describe those objects extend the Identified type, which contains the following set of common attributes:
| Attribute | Type | Description |
|---|---|---|
|
|
Each object in the virtualization infrastructure contains an | |
|
| The canonical location of the object as an absolute path. | |
|
|
A user-supplied human readable name for the object. The | |
|
| A free-form user-supplied human readable description of the object. |
Currently for most types of objects the id attribute is actually a randomly generated UUID, but this is an implementation detail, and users should not rely on that, as it may change in the future. Instead users should assume that these identifiers are just strings.
3.3. Objects
Objects are the individual instances of the types supported by the API. For example, the virtual machine with identifier 123 is an object of the Vm type.
3.4. Collections
A collection is a set of objects of the same type.
3.5. Representations
The state of objects needs to be represented when it is transferred beetween the client and the server. The API supports XML and JSON as the representation of the state of objects, both for input and output.
3.5.1. XML representation
The XML representation of an object consists of an XML element corresponding to the type of the object, XML attributes for the id and href attributes, and nested XML elements for the rest of the attributes. For example, the XML representation for a virtual machine appears as follows:
The XML representation of a collection of objects consists of an XML element, named after the type of the objects, in plural. This contains the representations of the objects of the collection. For example, the XML respresentation for a collection of virtual machines appears as follows:
In the XML representation of objects the id and href attributes are the only ones that are represented as XML attributes, the rest are represented as nested XML elements.
3.5.2. JSON representation
The JSON representation of an object consists of a JSON document containing a name/value pair for each attribute (including id and href). For example, the JSON representation of a virtual machine appears as follows:
The JSON representation of a collection of objects consists of a JSON document containg a name/value pair (named ater the type of the objects, in singular) which in turn contains an array with the representations of the objects of the collection. For example, the JSON respresentation for a collection of virtual machines appears as follows:
3.6. Services
Services are the parts of the server responsible for retrieving, adding updating, removing and executing actions on the objects supported by the API.
There are two relevant kinds of services:
- Services that manage a collection of objects
- These services are reponsible for listing existing objects and adding new objects. For example, the Vms service is responsible for managing the collection of virtual machines available in the system.
- Services that manage a specific object
- These services are responsible for retrieving, updating, deleting and executing actions in specific objects. For example, the Vm service is responsible for managing a specific virtual machine.
Each service is accessible via a particular path within the server. For example, the service that manages the collection of virtual machines available in the system is available in the via the path /vms, and the service that manages the virtual machine 123 is available via the path /vms/123.
All kinds of services have a set of methods that represent the operations that they can perform. The services that manage collections of objects usually have the list and add methods. The services that manage specific objects usually have the get, update and remove methods. In addition, services may also have action methods, that represent less common operations. For example, the Vm service has a start method that is used to start a virtual machine.
For the more usual methods there is a direct mapping between the name of the method and the name of the HTTP method:
| Method name | HTTP method |
|---|---|
|
| POST |
|
| GET |
|
| GET |
|
| PUT |
|
| DELETE |
The path used in the HTTP request is the path of the service, with the /ovirt-engine/api prefix.
For example, the request to list the virtual machines should be like this, using the HTTP GET method and the path /vms:
GET /ovirt-engine/api/vms
GET /ovirt-engine/api/vms
For action methods the HTTP method is always POST, and the name of the method is added as a suffix to the path. For example, the request to start virtual machine 123 should look like this, using the HTTP POST method and the path /vms/123/start:
POST /ovirt-engine/api/vms/123/start
POST /ovirt-engine/api/vms/123/startEach method has a set of parameters.
Parameters are classified into two categories:
- Main parameter
-
The main parameter corresponds the object or collection that is retrieved, added or updated. This only applies to the
add,get,listandupdatemethods, and there will be exactly one such main parameter per method. - Secondary parameters
- The rest of the parameters.
For example, the operation that adds a virtual machine (see here) has three parameters: vm, clone and clone_permissions. The main parameter is vm, as it describes the object that is added. The clone and clone_permissions parameters are secondary parameters.
The main parameter, when used for input, must be included in the body of the HTTP request. For example, when adding a virtual machine, the vm parameter, of type Vm, must be included in the request body. So the complete request to add a virtual machine, including all the HTTP details, must look like this:
When used for output, the main parameters are included in the response body. For example, when adding a virtual machine, the vm parameter will be included in the response body. So the complete response body will look like this:
Secondary parameters are only allowed for input (except for action methods, which are described later), and they must be included as query parameters. For example, when adding a virtual machine with the clone parameter set to true, the complete request must look like this:
Action methods only have secondary parameters. They can be used for input and output, and they should be included in the request body, wrapped with an action element. For example, the action method used to start a virtual machine (see here) has a vm parameter to describe how the virtual machine should be started, and a use_cloud_init parameter to specify if cloud-init should be used to configure the guest operating system. So the complete request to start virtual machine 123 using cloud-init will look like this when using XML:
3.7. Searching
The list method of some services has a search parameter that can be used to specify search criteria. When used, the server will only return objects within the collection that satisfy those criteria. For example, the following request will return only the virtual machine named myvm:
GET /ovirt-engine/api/vms?search=name%3Dmyvm
GET /ovirt-engine/api/vms?search=name%3Dmyvm3.7.1. Maximum results parameter
Use the max parameter to limit the number of objects returned. For example, the following request will only return one virtual machine, regardless of how many are available in the system:
GET /ovirt-engine/api/vms?max=1
GET /ovirt-engine/api/vms?max=1
A search request without the max parameter will return all the objects. Specifying the max parameter is recommended to reduce the impact of requests in the overall performance of the system.
3.7.2. Case sensitivity
By default queries are not case sensitive. For example, the following request will return the virtual machines named myvm, MyVM and MYVM:
GET /ovirt-engine/api/vms?search=name%3Dmyvm
GET /ovirt-engine/api/vms?search=name%3Dmyvm
The optional case_sensitive boolean parameter can be used to change this behaviour. For example, to get exactly the virtual machine named myhost, and not MyHost or MYHOST, send a request like this:
GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true
GET /ovirt-engine/api/vms?search=name%3D=myvm&case_sensitive=true3.7.3. Search syntax
The search parameters use the same syntax as the Red Hat Virtualization query language:
(criteria) [sortby (element) asc|desc]
(criteria) [sortby (element) asc|desc]
The sortby clause is optional and only needed when ordering results.
Example search queries:
| Collection | Criteria | Result |
|---|---|---|
|
|
|
Returns a list of all hosts running virtual machines that are |
|
|
| Returns a list of all virtual machines running on the specified domain. |
|
|
|
Returns a list of all virtual machines belonging to users with the user name |
|
|
|
Returns a list of all events with severity higher than |
|
|
|
Returns a list of all events with severity higher than |
The value of the search parameter must be URL-encoded to translate reserved characters, such as operators and spaces. For example, the equal sign should be encoded as %3D:
GET /ovirt-engine/api/vms?search=name%3Dmyvm
GET /ovirt-engine/api/vms?search=name%3Dmyvm3.7.4. Wildcards
The asterisk can be used as part of a value, to indicate that any string matches, including the emtpy string. For example, the following request will return all the virtual machines with names beginning with myvm, such as myvm, myvm2, myvma or myvm-webserver:
GET /ovirt-engine/api/vms?search=name%3Dmyvm*
GET /ovirt-engine/api/vms?search=name%3Dmyvm*3.7.5. Pagination
Some Red Hat Virtualization environments contain large collections of objects. Retrieving all of them with one request isn’t practical, and hurts performace. To allow retrieving them page by page the search parameter supports an optional page clause. This, combined with the max parameter, is the basis for paging. For example, to get the first page of virtual machines, with a page size of 10 virtual machines, send request like this:
GET /ovirt-engine/api/vms?search=page%201&max=10
GET /ovirt-engine/api/vms?search=page%201&max=10
The search parameter is URL-encoded, the actual value of the search parameter, before encoding, is page 1, so this is actually requesting the first page.
Increase the page value to retrieve the next page:
GET /ovirt-engine/api/vms?search=page%202&max=10
GET /ovirt-engine/api/vms?search=page%202&max=10
The page clause can be used in conjunction with other clauses inside the search parameter. For example, the following request will return the second page of virtual machines, but sorting by name:
GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10
GET /ovirt-engine/api/vms?search=sortby%20name%20page%202&max=10The API is stateless; it is not possible to retain a state between different requests since all requests are independent from each other. As a result, if a status change occurs between your requests, then the page results may be inconsistent.
For example, if you request a specific page from a list of virtual machines, and virtual machines are created or removed before you request the next page, then your results may be missing some of them, or contain duplicates.
3.8. Following links
The API returns references to related objects as links. For example, when a virtual machine is retrieved it contains links to its disk attachments and network interface cards:
The complete description of those linked objects can be retrieved by sending separate requests:
GET /ovirt-engine/api/vms/123/diskattachments GET /ovirt-engine/api/vms/123/nics
GET /ovirt-engine/api/vms/123/diskattachments
GET /ovirt-engine/api/vms/123/nics
However, in some situations it is more convenient for the application using the API to retrieve the linked information in the same request. This is useful, for example, when the additional network round trips introduce an unacceptable overhead, or when the multiple requests complicate the code of the application in an unacceptable way. For those use cases the API provides a follow parameter that allows the application to retrieve the linked information using only one request.
The value of the follow parameter is a list of strings, separated by commas. Each of those strings is the path of the linked object. For example, to retrieve the disk attachments and the NICs in the example above the request should be like this:
GET /ovirt-engine/api/vms/123?follow=disk_attachments,nics
GET /ovirt-engine/api/vms/123?follow=disk_attachments,nicsThat will return an response like this:
The path to the linked object can be a single word, as in the previous example, or it can be a sequence of words, separated by dots, to request nested data. For example, the previous example used disk_attachments in order to retrieve the complete description of the disk attachments, but each disk attachment contains a link to the disk, which wasn’t followed. In order to also follow the links to the disks, the following request can be used:
POST /ovirt-engine/api/vms/123?follow=disk_attachments.disk
POST /ovirt-engine/api/vms/123?follow=disk_attachments.diskThat will result in the following response:
The path can be made as deep as needed. For example, to also get the statistics of the disks:
POST /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics
POST /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statisticsMultiple path elements and multiple paths can be combined. For example, to get the disk attachments and the network interface cards, both with their statistics:
POST /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics,nics.statistics
POST /ovirt-engine/api/vms/123?follow=disk_attachments.disk.statistics,nics.statistics
Almost all the operations that retrieve objects support the follow parameter, but make sure to explicitly check the reference documentation, as some operations may not support it, or may provide advice on how to use it to get the best performance.
Using the follow parameter moves the overhead from the client side to the server side. When you request additional data, the server must fetch and merge it with the basic data. That consumes CPU and memory in the server side, and will in most cases require additional database queries. That may adversely affect the performance of the server, especially in large scale environments. Make sure to test your application in a realistic environment, and use the follow parameter only when justified.
3.9. Permissions
Many of the services that manage a single object provide a reference to a permissions service that manages the permissions assigned to that object. Each permission contains links to the user or group, the role and the object. For example, the permissions assigned to a specific virtual machine can be retrieved sending a request like this:
GET /ovirt-engine/api/vms/123/permissions
GET /ovirt-engine/api/vms/123/permissionsThe response body will look like this:
A permission is added to an object sending a POST request with a permission representation to this service. Each new permission requires a role and a user.
3.10. Handling errors
Some errors require further explanation beyond a standard HTTP status code. For example, the API reports an unsuccessful object state update or action with a fault in the response body. The fault contains the reason and detail attributes. For example, when the server receives a request to create a virtual machine without the mandatory name attribute it will respond with the following HTTP response line:
HTTP/1.1 400 Bad Request
HTTP/1.1 400 Bad RequestAnd the following response body:
<fault> <reason>Incomplete parameters</reason> <detail>Vm [name] required for add</detail> </fault>
<fault>
<reason>Incomplete parameters</reason>
<detail>Vm [name] required for add</detail>
</fault>Chapter 4. Quick Start Examples
The examples in this section show you how to use the REST API to set up a basic Red Hat Virtualization environment and to create a virtual machine. In addition to the standard prerequisites, these examples require the following:
- A networked and configured Red Hat Virtualization installation.
- An ISO file containing the virtual machine operating system you want to install. This chapter uses CentOS 7 for the installation ISO example.
The API examples use curl to demonstrate API requests with a client application. You can use any application that sends HTTP requests.
The HTTP request headers in this example omit the Host and Authorization headers. However, these fields are mandatory and require data specific to your installation of Red Hat Virtualization.
The curl examples use admin@internal for the user name, mypassword for the password, /etc/pki/ovirt-engine/ca.pem for the certificate location, and myengine.example.com for the host name. You must replace them with the correct values for your environment.
Red Hat Virtualization generates a unique identifier for the id attribute for each resource. Identifier codes in this example will differ from the identifier codes in your Red Hat Virtualization environment.
In many examples, some attributes of the results returned by the API have been omitted, for brevity. See, for example, the Cluster reference for a complete list of attributes.
4.1. Access API entry point
The following request retrieves a representation of the main entry point for version 4 of the API:
GET /ovirt-engine/api HTTP/1.1 Version: 4 Accept: application/xml
GET /ovirt-engine/api HTTP/1.1
Version: 4
Accept: application/xml
The same request, but using the /v4 URL prefix instead of the Version header:
GET /ovirt-engine/api/v4 HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/v4 HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The result is an object of type Api:
When neither the header nor the URL prefix are used, the server will automatically select a version. The default is version 4. You can change the default version using the ENGINE_API_DEFAULT_VERSION configuration parameter:
echo "ENGINE_API_DEFAULT_VERSION=3" > \ /etc/ovirt-engine/engine.conf.d/99-set-default-version.conf systemctl restart ovirt-engine
# echo "ENGINE_API_DEFAULT_VERSION=3" > \
/etc/ovirt-engine/engine.conf.d/99-set-default-version.conf
# systemctl restart ovirt-engineChanging this parameter affects all users of the API that don’t specify the version explicitly.
The entry point provides a user with links to the collections in a virtualization environment. The rel attribute of each collection link provides a reference point for each link. The next step in this example examines the data center collection, which is available through the datacenters link.
The entry point also contains other data such as product_info, special_objects and summary. This data is covered in chapters outside this example.
4.2. List data centers
Red Hat Virtualization creates a Default data center on installation. This example uses the Default data center as the basis for the virtual environment.
The following request retrieves a representation of the data centers:
GET /ovirt-engine/api/datacenters HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/datacenters HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The result will be a list of objects of type DataCenter:
Note the id of your Default data center. It identifies this data center in relation to other resources of your virtual environment.
The data center also contains a link to the service that manages the storage domains attached to the data center:
<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
<link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
That service is used to attach storage domains from the main storagedomains collection, which this example covers later.
4.3. List host clusters
Red Hat Virtualization creates a Default hosts cluster on installation. This example uses the Default cluster to group resources in your Red Hat Virtualization environment.
The following request retrieves a representation of the cluster collection:
GET /ovirt-engine/api/clusters HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/clusters HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The result will be a list of objects of type Cluster:
Note the id of your Default host cluster. It identifies this host cluster in relation to other resources of your virtual environment.
The Default cluster is associated with the Default data center through a relationship using the id and href attributes of the data_center link:
<data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
<data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
The networks link is a reference to the service that manages the networks associated to this cluster. The next section examines the networks collection in more detail.
4.4. List logical networks
Red Hat Virtualization creates a default ovirtmgmt network on installation. This network acts as the management network for Red Hat Virtualization Manager to access hosts.
This network is associated with the Default cluster and is a member of the Default data center. This example uses the ovirtmgmt network to connect the virtual machines.
The following request retrieves the list of logical networks:
GET /ovirt-engine/api/networks HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/networks HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The result will be a list of objects of type Network:
The ovirtmgmt network is attached to the Default data center through a relationship using the data center’s id.
The ovirtmgmt network is also attached to the Default cluster through a relationship in the cluster’s network sub-collection.
4.5. List hosts
This example retrieves the list of hosts and shows a host named myhost registered with the virtualization environment:
GET /ovirt-engine/api/hosts HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/hosts HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The result will be a list of objects of type Host:
Note the id of your host. It identifies this host in relation to other resources of your virtual environment.
This host is a member of the Default cluster and accessing the nics sub-collection shows this host has a connection to the ovirtmgmt network.
4.6. Create NFS data storage
An NFS data storage domain is an exported NFS share attached to a data center and provides storage for virtualized guest images. Creation of a new storage domain requires a POST request, with the storage domain representation included, sent to the URL of the storage domain collection.
You can enable the wipe after delete option by default on the storage domain. To configure this specify wipe_after_delete in the POST request. This option can be edited after the domain is created, but doing so will not change the wipe after delete property of disks that already exist.
The request should be like this:
POST /ovirt-engine/api/storagedomains HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xmlAnd the request body should be like this:
The same request, using the curl command:
The server uses host myhost to create a NFS data storage domain called mydata with an export path of mynfs.example.com:/exports/mydata. The API also returns the following representation of the newly created storage domain resource (of type StorageDomain):
4.7. Create NFS ISO storage
An NFS ISO storage domain is a mounted NFS share attached to a data center and provides storage for DVD/CD-ROM ISO and virtual floppy disk (VFD) image files. Creation of a new storage domain requires a POST request, with the storage domain representation included, sent to the URL of the storage domain collection:
The request should be like this:
POST /ovirt-engine/api/storagedomains HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xmlAnd the request body should be like this:
The same request, using the curl command:
The server uses host myhost to create a NFS ISO storage domain called myisos with an export path of mynfs.example.com:/exports/myisos. The API also returns the following representation of the newly created storage domain resource (of type StorageDomain):
4.8. Attach storage domains to data center
The following example attaches the mydata and myisos storage domains to the Default data center.
To attach the mydata storage domain, send a request like this:
POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xmlWith a request body like this:
<storage_domain> <name>mydata</name> </storage_domain>
<storage_domain>
<name>mydata</name>
</storage_domain>
The same request, using the curl command:
To attach the myisos storage domain, send a request like this:
POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/datacenters/001/storagedomains HTTP/1.1
Accept: application/xml
Content-type: application/xmlWith a request body like this:
<storage_domain> <name>myisos</name> </storage_domain>
<storage_domain>
<name>myisos</name>
</storage_domain>
The same request, using the curl command:
4.9. Create virtual machine
The following example creates a virtual machine called myvm on the Default cluster using the virtualization environment’s Blank template as a basis. The request also defines the virtual machine’s memory as 512 MiB and sets the boot device to a virtual hard disk.
The request should be contain an object of type Vm describing the virtual machine to create:
POST /ovirt-engine/api/vms HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/vms HTTP/1.1
Accept: application/xml
Content-type: application/xmlAnd the request body should be like this:
The same request, using the curl command:
The response body will be an object of the Vm type:
4.10. Create a virtual machine NIC
The following example creates a virtual network interface to connect the example virtual machine to the ovirtmgmt network.
The request should be like this:
POST /ovirt-engine/api/vms/007/nics HTTP/1.1 Content-Type: application/xml Accept: application/xml
POST /ovirt-engine/api/vms/007/nics HTTP/1.1
Content-Type: application/xml
Accept: application/xmlThe request body should contain an object of type Nic describing the NIC to be created:
<nic> <name>mynic</name> <description>My network interface card</description> </nic>
<nic>
<name>mynic</name>
<description>My network interface card</description>
</nic>
The same request, using the curl command:
4.11. Create virtual machine disk
The following example creates an 8 GiB copy-on-write disk for the example virtual machine.
The request should be like this:
POST /ovirt-engine/api/vms/007/diskattachments HTTP/1.1 Content-Type: application/xml Accept: application/xml
POST /ovirt-engine/api/vms/007/diskattachments HTTP/1.1
Content-Type: application/xml
Accept: application/xmlThe request body should be an object of type DiskAttachment describing the disk and how it will be attached to the virtual machine:
The same request, using the curl command:
The storage_domains attribute tells the API to store the disk on the mydata storage domain.
4.12. Attach ISO image to virtual machine
The boot media for the following virtual machine example requires a CD-ROM or DVD ISO image for an operating system installation. This example uses a CentOS 7 image.
ISO images must be available in the myisos ISO domain for the virtual machines to use. You can use Section 6.114, “ImageTransfers” to create an image transfer and Section 6.113, “ImageTransfer” to upload the ISO image.
Once the ISO image is uploaded, an API can be used to request the list of files from the ISO storage domain:
GET /ovirt-engine/api/storagedomains/006/files HTTP/1.1 Accept: application/xml
GET /ovirt-engine/api/storagedomains/006/files HTTP/1.1
Accept: application/xml
The same request, using the curl command:
The server returns the following list of objects of type File, one for each available ISO (or floppy) image:
An API user attaches the CentOS-7-x86_64-Minimal.iso to the example virtual machine. Attaching an ISO image is equivalent to using the Change CD button in the administration or user portal applications.
The request should be like this:
PUT /ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1 Accept: application/xml Content-type: application/xml
PUT /ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000 HTTP/1.1
Accept: application/xml
Content-type: application/xml
The request body should be an object of type Cdrom containing an inner file attribute to indicate the identifier of the ISO (or floppy) image:
<cdrom> <file id="CentOS-7-x86_64-Minimal.iso"/> </cdrom>
<cdrom>
<file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>
The same request, using the curl command:
For more details see the documentation of the service that manages virtual machine CD-ROMS.
4.13. Start the virtual machine
The virtual environment is complete and the virtual machine contains all necessary components to function. This example starts the virtual machine using the start method.
The request should be like this:
POST /ovirt-engine/api/vms/007/start HTTP/1.1 Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/vms/007/start HTTP/1.1
Accept: application/xml
Content-type: application/xmlThe request body should be like this:
The same request, using the curl command:
The additional request body sets the virtual machine’s boot device to CD-ROM for this boot only. This enables the virtual machine to install the operating system from the attached ISO image. The boot device reverts back to disk for all future boots.
Chapter 5. Requests
This section enumerates all the requests that are available in the API.
- POST /affinitylabels
- GET /affinitylabels
- GET /affinitylabels/{label:id}
- PUT /affinitylabels/{label:id}
- DELETE /affinitylabels/{label:id}
- POST /affinitylabels/{label:id}/hosts
- GET /affinitylabels/{label:id}/hosts
- DELETE /affinitylabels/{label:id}/hosts/{host:id}
- GET /affinitylabels/{label:id}/hosts/{host:id}
- POST /affinitylabels/{label:id}/vms
- GET /affinitylabels/{label:id}/vms
- DELETE /affinitylabels/{label:id}/vms/{vm:id}
- GET /affinitylabels/{label:id}/vms/{vm:id}
- POST /bookmarks
- GET /bookmarks
- GET /bookmarks/{bookmark:id}
- PUT /bookmarks/{bookmark:id}
- DELETE /bookmarks/{bookmark:id}
- GET /clusterlevels
- GET /clusterlevels/{level:id}
- GET /clusterlevels/{level:id}/clusterfeatures
- GET /clusterlevels/{level:id}/clusterfeatures/{feature:id}
- POST /clusters
- GET /clusters
- GET /clusters/{cluster:id}
- PUT /clusters/{cluster:id}
- DELETE /clusters/{cluster:id}
- POST /clusters/{cluster:id}/affinitygroups
- GET /clusters/{cluster:id}/affinitygroups
- GET /clusters/{cluster:id}/affinitygroups/{group:id}
- PUT /clusters/{cluster:id}/affinitygroups/{group:id}
- DELETE /clusters/{cluster:id}/affinitygroups/{group:id}
- POST /clusters/{cluster:id}/affinitygroups/{group:id}/vms
- GET /clusters/{cluster:id}/affinitygroups/{group:id}/vms
- DELETE /clusters/{cluster:id}/affinitygroups/{group:id}/vms/{vm:id}
- POST /clusters/{cluster:id}/cpuprofiles
- GET /clusters/{cluster:id}/cpuprofiles
- GET /clusters/{cluster:id}/cpuprofiles/{profile:id}
- DELETE /clusters/{cluster:id}/cpuprofiles/{profile:id}
- GET /clusters/{cluster:id}/enabledfeatures
- POST /clusters/{cluster:id}/enabledfeatures
- GET /clusters/{cluster:id}/enabledfeatures/{feature:id}
- DELETE /clusters/{cluster:id}/enabledfeatures/{feature:id}
- GET /clusters/{cluster:id}/externalnetworkproviders
- GET /clusters/{cluster:id}/glusterhooks
- GET /clusters/{cluster:id}/glusterhooks/{hook:id}
- DELETE /clusters/{cluster:id}/glusterhooks/{hook:id}
- POST /clusters/{cluster:id}/glusterhooks/{hook:id}/disable
- POST /clusters/{cluster:id}/glusterhooks/{hook:id}/enable
- POST /clusters/{cluster:id}/glusterhooks/{hook:id}/resolve
- POST /clusters/{cluster:id}/glustervolumes
- GET /clusters/{cluster:id}/glustervolumes
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}
- DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/getprofilestatistics
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/activate
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/migrate
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/stopmigrate
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
- DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/replace
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics/{statistic:id}
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/rebalance
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/resetalloptions
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/resetoption
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/setoption
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/start
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/startprofile
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/statistics
- GET /clusters/{cluster:id}/glustervolumes/{volume:id}/statistics/{statistic:id}
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stop
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stopprofile
- POST /clusters/{cluster:id}/glustervolumes/{volume:id}/stoprebalance
- GET /clusters/{cluster:id}/networkfilters
- GET /clusters/{cluster:id}/networkfilters/{networkfilter:id}
- POST /clusters/{cluster:id}/networks
- GET /clusters/{cluster:id}/networks
- GET /clusters/{cluster:id}/networks/{network:id}
- DELETE /clusters/{cluster:id}/networks/{network:id}
- PUT /clusters/{cluster:id}/networks/{network:id}
- POST /clusters/{cluster:id}/permissions
- GET /clusters/{cluster:id}/permissions
- GET /clusters/{cluster:id}/permissions/{permission:id}
- DELETE /clusters/{cluster:id}/permissions/{permission:id}
- POST /clusters/{cluster:id}/resetemulatedmachine
- POST /clusters/{cluster:id}/syncallnetworks
- POST /cpuprofiles
- GET /cpuprofiles
- GET /cpuprofiles/{profile:id}
- PUT /cpuprofiles/{profile:id}
- DELETE /cpuprofiles/{profile:id}
- POST /cpuprofiles/{profile:id}/permissions
- GET /cpuprofiles/{profile:id}/permissions
- GET /cpuprofiles/{profile:id}/permissions/{permission:id}
- DELETE /cpuprofiles/{profile:id}/permissions/{permission:id}
- POST /datacenters
- GET /datacenters
- GET /datacenters/{datacenter:id}
- PUT /datacenters/{datacenter:id}
- DELETE /datacenters/{datacenter:id}
- POST /datacenters/{datacenter:id}/clusters
- GET /datacenters/{datacenter:id}/clusters
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}
- PUT /datacenters/{datacenter:id}/clusters/{cluster:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
- PUT /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/affinitygroups/{group:id}/vms/{vm:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles/{profile:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/cpuprofiles/{profile:id}
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures/{feature:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/enabledfeatures/{feature:id}
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/externalnetworkproviders
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/disable
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/enable
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glusterhooks/{hook:id}/resolve
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/getprofilestatistics
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/activate
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/migrate
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/stopmigrate
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/replace
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/glusterbricks/{brick:id}/statistics/{statistic:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/rebalance
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/resetalloptions
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/resetoption
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/setoption
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/start
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/startprofile
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/statistics
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/statistics/{statistic:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stop
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stopprofile
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/glustervolumes/{volume:id}/stoprebalance
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networkfilters
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networkfilters/{networkfilter:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/networks
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networks
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
- PUT /datacenters/{datacenter:id}/clusters/{cluster:id}/networks/{network:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions
- GET /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/clusters/{cluster:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/resetemulatedmachine
- POST /datacenters/{datacenter:id}/clusters/{cluster:id}/syncallnetworks
- POST /datacenters/{datacenter:id}/iscsibonds
- GET /datacenters/{datacenter:id}/iscsibonds
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
- PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
- PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels/{label:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/networklabels/{label:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections
- GET /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
- PUT /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
- DELETE /datacenters/{datacenter:id}/iscsibonds/{iscsibond:id}/storageserverconnections/{storageconnection:id}
- POST /datacenters/{datacenter:id}/networks
- GET /datacenters/{datacenter:id}/networks
- GET /datacenters/{datacenter:id}/networks/{network:id}
- DELETE /datacenters/{datacenter:id}/networks/{network:id}
- PUT /datacenters/{datacenter:id}/networks/{network:id}
- POST /datacenters/{datacenter:id}/permissions
- GET /datacenters/{datacenter:id}/permissions
- GET /datacenters/{datacenter:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/qoss
- GET /datacenters/{datacenter:id}/qoss
- GET /datacenters/{datacenter:id}/qoss/{qos:id}
- PUT /datacenters/{datacenter:id}/qoss/{qos:id}
- DELETE /datacenters/{datacenter:id}/qoss/{qos:id}
- POST /datacenters/{datacenter:id}/quotas
- GET /datacenters/{datacenter:id}/quotas
- GET /datacenters/{datacenter:id}/quotas/{quota:id}
- PUT /datacenters/{datacenter:id}/quotas/{quota:id}
- DELETE /datacenters/{datacenter:id}/quotas/{quota:id}
- POST /datacenters/{datacenter:id}/quotas/{quota:id}/permissions
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/permissions
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits/{limit:id}
- DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/quotaclusterlimits/{limit:id}
- POST /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits
- GET /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits/{limit:id}
- DELETE /datacenters/{datacenter:id}/quotas/{quota:id}/quotastoragelimits/{limit:id}
- POST /datacenters/{datacenter:id}/storagedomains
- GET /datacenters/{datacenter:id}/storagedomains
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}
- DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/activate
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/deactivate
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks
- PUT /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
- DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/copy
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/export
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/move
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
- DELETE /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/register
- POST /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/sparsify
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/statistics
- GET /datacenters/{datacenter:id}/storagedomains/{storagedomain:id}/disks/{disk:id}/statistics/{statistic:id}
- POST /diskprofiles
- GET /diskprofiles
- GET /diskprofiles/{diskprofile:id}
- PUT /diskprofiles/{diskprofile:id}
- DELETE /diskprofiles/{diskprofile:id}
- POST /diskprofiles/{diskprofile:id}/permissions
- GET /diskprofiles/{diskprofile:id}/permissions
- GET /diskprofiles/{diskprofile:id}/permissions/{permission:id}
- DELETE /diskprofiles/{diskprofile:id}/permissions/{permission:id}
- POST /disks
- GET /disks
- PUT /disks/{disk:id}
- GET /disks/{disk:id}
- DELETE /disks/{disk:id}
- POST /disks/{disk:id}/copy
- POST /disks/{disk:id}/export
- POST /disks/{disk:id}/move
- POST /disks/{disk:id}/permissions
- GET /disks/{disk:id}/permissions
- GET /disks/{disk:id}/permissions/{permission:id}
- DELETE /disks/{disk:id}/permissions/{permission:id}
- POST /disks/{disk:id}/reduce
- POST /disks/{disk:id}/refreshlun
- POST /disks/{disk:id}/sparsify
- GET /disks/{disk:id}/statistics
- GET /disks/{disk:id}/statistics/{statistic:id}
- GET /domains
- GET /domains/{domain:id}
- GET /domains/{domain:id}/groups
- GET /domains/{domain:id}/groups/{group:id}
- GET /domains/{domain:id}/users
- GET /domains/{domain:id}/users/{user:id}
- POST /events
- GET /events
- POST /events/undelete
- GET /events/{event:id}
- DELETE /events/{event:id}
- POST /externalhostproviders
- GET /externalhostproviders
- GET /externalhostproviders/{provider:id}
- PUT /externalhostproviders/{provider:id}
- DELETE /externalhostproviders/{provider:id}
- GET /externalhostproviders/{provider:id}/certificates
- GET /externalhostproviders/{provider:id}/certificates/{certificate:id}
- GET /externalhostproviders/{provider:id}/computeresources
- GET /externalhostproviders/{provider:id}/computeresources/{resource:id}
- GET /externalhostproviders/{provider:id}/discoveredhosts
- GET /externalhostproviders/{provider:id}/discoveredhosts/{host:id}
- GET /externalhostproviders/{provider:id}/hostgroups
- GET /externalhostproviders/{provider:id}/hostgroups/{group:id}
- GET /externalhostproviders/{provider:id}/hosts
- GET /externalhostproviders/{provider:id}/hosts/{host:id}
- POST /externalhostproviders/{provider:id}/importcertificates
- POST /externalhostproviders/{provider:id}/testconnectivity
- POST /externalvmimports
- POST /groups
- GET /groups
- GET /groups/{group:id}
- DELETE /groups/{group:id}
- POST /groups/{group:id}/permissions
- GET /groups/{group:id}/permissions
- GET /groups/{group:id}/permissions/{permission:id}
- DELETE /groups/{group:id}/permissions/{permission:id}
- GET /groups/{group:id}/roles
- GET /groups/{group:id}/roles/{role:id}
- DELETE /groups/{group:id}/roles/{role:id}
- PUT /groups/{group:id}/roles/{role:id}
- POST /groups/{group:id}/roles/{role:id}/permits
- GET /groups/{group:id}/roles/{role:id}/permits
- GET /groups/{group:id}/roles/{role:id}/permits/{permit:id}
- DELETE /groups/{group:id}/roles/{role:id}/permits/{permit:id}
- POST /groups/{group:id}/tags
- GET /groups/{group:id}/tags
- GET /groups/{group:id}/tags/{tag:id}
- DELETE /groups/{group:id}/tags/{tag:id}
- POST /hosts
- GET /hosts
- GET /hosts/{host:id}
- PUT /hosts/{host:id}
- DELETE /hosts/{host:id}
- POST /hosts/{host:id}/activate
- POST /hosts/{host:id}/affinitylabels
- GET /hosts/{host:id}/affinitylabels
- GET /hosts/{host:id}/affinitylabels/{label:id}
- DELETE /hosts/{host:id}/affinitylabels/{label:id}
- POST /hosts/{host:id}/approve
- POST /hosts/{host:id}/commitnetconfig
- POST /hosts/{host:id}/deactivate
- GET /hosts/{host:id}/devices
- GET /hosts/{host:id}/devices/{device:id}
- POST /hosts/{host:id}/enrollcertificate
- GET /hosts/{host:id}/externalnetworkproviderconfigurations
- GET /hosts/{host:id}/externalnetworkproviderconfigurations/{configuration:id}
- POST /hosts/{host:id}/fence
- POST /hosts/{host:id}/fenceagents
- GET /hosts/{host:id}/fenceagents
- GET /hosts/{host:id}/fenceagents/{agent:id}
- PUT /hosts/{host:id}/fenceagents/{agent:id}
- DELETE /hosts/{host:id}/fenceagents/{agent:id}
- POST /hosts/{host:id}/forceselectspm
- GET /hosts/{host:id}/hooks
- GET /hosts/{host:id}/hooks/{hook:id}
- POST /hosts/{host:id}/install
- POST /hosts/{host:id}/iscsidiscover
- POST /hosts/{host:id}/iscsilogin
- GET /hosts/{host:id}/katelloerrata
- GET /hosts/{host:id}/katelloerrata/{katelloerratum:id}
- POST /hosts/{host:id}/networkattachments
- GET /hosts/{host:id}/networkattachments
- GET /hosts/{host:id}/networkattachments/{attachment:id}
- PUT /hosts/{host:id}/networkattachments/{attachment:id}
- DELETE /hosts/{host:id}/networkattachments/{attachment:id}
- GET /hosts/{host:id}/nics
- GET /hosts/{host:id}/nics/{nic:id}
- GET /hosts/{host:id}/nics/{nic:id}/linklayerdiscoveryprotocolelements
- POST /hosts/{host:id}/nics/{nic:id}/networkattachments
- GET /hosts/{host:id}/nics/{nic:id}/networkattachments
- GET /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
- PUT /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
- DELETE /hosts/{host:id}/nics/{nic:id}/networkattachments/{attachment:id}
- POST /hosts/{host:id}/nics/{nic:id}/networklabels
- GET /hosts/{host:id}/nics/{nic:id}/networklabels
- GET /hosts/{host:id}/nics/{nic:id}/networklabels/{label:id}
- DELETE /hosts/{host:id}/nics/{nic:id}/networklabels/{label:id}
- GET /hosts/{host:id}/nics/{nic:id}/statistics
- GET /hosts/{host:id}/nics/{nic:id}/statistics/{statistic:id}
- POST /hosts/{host:id}/nics/{nic:id}/updatevirtualfunctionsconfiguration
- POST /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels
- GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels
- GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels/{label:id}
- DELETE /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowedlabels/{label:id}
- POST /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks
- GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks
- GET /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks/{network:id}
- DELETE /hosts/{host:id}/nics/{nic:id}/virtualfunctionallowednetworks/{network:id}
- GET /hosts/{host:id}/numanodes
- GET /hosts/{host:id}/numanodes/{node:id}
- GET /hosts/{host:id}/numanodes/{node:id}/statistics
- GET /hosts/{host:id}/numanodes/{node:id}/statistics/{statistic:id}
- POST /hosts/{host:id}/permissions
- GET /hosts/{host:id}/permissions
- GET /hosts/{host:id}/permissions/{permission:id}
- DELETE /hosts/{host:id}/permissions/{permission:id}
- POST /hosts/{host:id}/refresh
- POST /hosts/{host:id}/setupnetworks
- GET /hosts/{host:id}/statistics
- GET /hosts/{host:id}/statistics/{statistic:id}
- GET /hosts/{host:id}/storage
- GET /hosts/{host:id}/storage/{storage:id}
- POST /hosts/{host:id}/storageconnectionextensions
- GET /hosts/{host:id}/storageconnectionextensions
- GET /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
- PUT /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
- DELETE /hosts/{host:id}/storageconnectionextensions/{storageconnectionextension:id}
- POST /hosts/{host:id}/syncallnetworks
- POST /hosts/{host:id}/tags
- GET /hosts/{host:id}/tags
- GET /hosts/{host:id}/tags/{tag:id}
- DELETE /hosts/{host:id}/tags/{tag:id}
- GET /hosts/{host:id}/unmanagednetworks
- GET /hosts/{host:id}/unmanagednetworks/{unmanagednetwork:id}
- DELETE /hosts/{host:id}/unmanagednetworks/{unmanagednetwork:id}
- POST /hosts/{host:id}/unregisteredstoragedomainsdiscover
- POST /hosts/{host:id}/upgrade
- POST /hosts/{host:id}/upgradecheck
- GET /icons
- GET /icons/{icon:id}
- POST /imagetransfers
- GET /imagetransfers
- GET /imagetransfers/{imagetransfer:id}
- POST /imagetransfers/{imagetransfer:id}/cancel
- POST /imagetransfers/{imagetransfer:id}/extend
- POST /imagetransfers/{imagetransfer:id}/finalize
- POST /imagetransfers/{imagetransfer:id}/pause
- POST /imagetransfers/{imagetransfer:id}/resume
- POST /instancetypes
- GET /instancetypes
- GET /instancetypes/{instancetype:id}
- PUT /instancetypes/{instancetype:id}
- DELETE /instancetypes/{instancetype:id}
- POST /instancetypes/{instancetype:id}/graphicsconsoles
- GET /instancetypes/{instancetype:id}/graphicsconsoles
- GET /instancetypes/{instancetype:id}/graphicsconsoles/{console:id}
- DELETE /instancetypes/{instancetype:id}/graphicsconsoles/{console:id}
- POST /instancetypes/{instancetype:id}/nics
- GET /instancetypes/{instancetype:id}/nics
- GET /instancetypes/{instancetype:id}/nics/{nic:id}
- PUT /instancetypes/{instancetype:id}/nics/{nic:id}
- DELETE /instancetypes/{instancetype:id}/nics/{nic:id}
- POST /instancetypes/{instancetype:id}/watchdogs
- GET /instancetypes/{instancetype:id}/watchdogs
- GET /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
- PUT /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
- DELETE /instancetypes/{instancetype:id}/watchdogs/{watchdog:id}
- POST /jobs
- GET /jobs
- GET /jobs/{job:id}
- POST /jobs/{job:id}/clear
- POST /jobs/{job:id}/end
- POST /jobs/{job:id}/steps
- GET /jobs/{job:id}/steps
- GET /jobs/{job:id}/steps/{step:id}
- POST /jobs/{job:id}/steps/{step:id}/end
- GET /jobs/{job:id}/steps/{step:id}/statistics
- GET /jobs/{job:id}/steps/{step:id}/statistics/{statistic:id}
- GET /katelloerrata
- GET /katelloerrata/{katelloerratum:id}
- POST /macpools
- GET /macpools
- GET /macpools/{macpool:id}
- PUT /macpools/{macpool:id}
- DELETE /macpools/{macpool:id}
- GET /networkfilters
- GET /networkfilters/{networkfilter:id}
- POST /networks
- GET /networks
- GET /networks/{network:id}
- PUT /networks/{network:id}
- DELETE /networks/{network:id}
- POST /networks/{network:id}/networklabels
- GET /networks/{network:id}/networklabels
- GET /networks/{network:id}/networklabels/{label:id}
- DELETE /networks/{network:id}/networklabels/{label:id}
- POST /networks/{network:id}/permissions
- GET /networks/{network:id}/permissions
- GET /networks/{network:id}/permissions/{permission:id}
- DELETE /networks/{network:id}/permissions/{permission:id}
- POST /networks/{network:id}/vnicprofiles
- GET /networks/{network:id}/vnicprofiles
- GET /networks/{network:id}/vnicprofiles/{profile:id}
- DELETE /networks/{network:id}/vnicprofiles/{profile:id}
- POST /networks/{network:id}/vnicprofiles/{profile:id}/permissions
- GET /networks/{network:id}/vnicprofiles/{profile:id}/permissions
- GET /networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
- DELETE /networks/{network:id}/vnicprofiles/{profile:id}/permissions/{permission:id}
- POST /openstackimageproviders
- GET /openstackimageproviders
- GET /openstackimageproviders/{provider:id}
- PUT /openstackimageproviders/{provider:id}
- DELETE /openstackimageproviders/{provider:id}
- GET /openstackimageproviders/{provider:id}/certificates
- GET /openstackimageproviders/{provider:id}/certificates/{certificate:id}
- GET /openstackimageproviders/{provider:id}/images
- GET /openstackimageproviders/{provider:id}/images/{image:id}
- POST /openstackimageproviders/{provider:id}/images/{image:id}/import
- POST /openstackimageproviders/{provider:id}/importcertificates
- POST /openstackimageproviders/{provider:id}/testconnectivity
- POST /openstacknetworkproviders
- GET /openstacknetworkproviders
- GET /openstacknetworkproviders/{provider:id}
- PUT /openstacknetworkproviders/{provider:id}
- DELETE /openstacknetworkproviders/{provider:id}
- GET /openstacknetworkproviders/{provider:id}/certificates
- GET /openstacknetworkproviders/{provider:id}/certificates/{certificate:id}
- POST /openstacknetworkproviders/{provider:id}/importcertificates
- GET /openstacknetworkproviders/{provider:id}/networks
- GET /openstacknetworkproviders/{provider:id}/networks/{network:id}
- POST /openstacknetworkproviders/{provider:id}/networks/{network:id}/import
- POST /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets
- GET /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets
- GET /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets/{subnet:id}
- DELETE /openstacknetworkproviders/{provider:id}/networks/{network:id}/subnets/{subnet:id}
- POST /openstacknetworkproviders/{provider:id}/testconnectivity
- POST /openstackvolumeproviders
- GET /openstackvolumeproviders
- GET /openstackvolumeproviders/{provider:id}
- PUT /openstackvolumeproviders/{provider:id}
- DELETE /openstackvolumeproviders/{provider:id}
- POST /openstackvolumeproviders/{provider:id}/authenticationkeys
- GET /openstackvolumeproviders/{provider:id}/authenticationkeys
- GET /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
- PUT /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
- DELETE /openstackvolumeproviders/{provider:id}/authenticationkeys/{key:id}
- GET /openstackvolumeproviders/{provider:id}/certificates
- GET /openstackvolumeproviders/{provider:id}/certificates/{certificate:id}
- POST /openstackvolumeproviders/{provider:id}/importcertificates
- POST /openstackvolumeproviders/{provider:id}/testconnectivity
- GET /openstackvolumeproviders/{provider:id}/volumetypes
- GET /openstackvolumeproviders/{provider:id}/volumetypes/{type:id}
- GET /operatingsystems
- GET /operatingsystems/{operatingsystem:id}
- GET /options/{option:id}
- POST /permissions
- GET /permissions
- GET /permissions/{permission:id}
- DELETE /permissions/{permission:id}
- POST /roles
- GET /roles
- GET /roles/{role:id}
- DELETE /roles/{role:id}
- PUT /roles/{role:id}
- POST /roles/{role:id}/permits
- GET /roles/{role:id}/permits
- GET /roles/{role:id}/permits/{permit:id}
- DELETE /roles/{role:id}/permits/{permit:id}
- POST /schedulingpolicies
- GET /schedulingpolicies
- GET /schedulingpolicies/{policy:id}
- PUT /schedulingpolicies/{policy:id}
- DELETE /schedulingpolicies/{policy:id}
- POST /schedulingpolicies/{policy:id}/balances
- GET /schedulingpolicies/{policy:id}/balances
- GET /schedulingpolicies/{policy:id}/balances/{balance:id}
- DELETE /schedulingpolicies/{policy:id}/balances/{balance:id}
- POST /schedulingpolicies/{policy:id}/filters
- GET /schedulingpolicies/{policy:id}/filters
- GET /schedulingpolicies/{policy:id}/filters/{filter:id}
- DELETE /schedulingpolicies/{policy:id}/filters/{filter:id}
- POST /schedulingpolicies/{policy:id}/weights
- GET /schedulingpolicies/{policy:id}/weights
- GET /schedulingpolicies/{policy:id}/weights/{weight:id}
- DELETE /schedulingpolicies/{policy:id}/weights/{weight:id}
- GET /schedulingpolicyunits
- GET /schedulingpolicyunits/{unit:id}
- DELETE /schedulingpolicyunits/{unit:id}
- POST /storageconnections
- GET /storageconnections
- GET /storageconnections/{storageconnection:id}
- PUT /storageconnections/{storageconnection:id}
- DELETE /storageconnections/{storageconnection:id}
- POST /storagedomains
- GET /storagedomains
- GET /storagedomains/{storagedomain:id}
- PUT /storagedomains/{storagedomain:id}
- DELETE /storagedomains/{storagedomain:id}
- POST /storagedomains/{storagedomain:id}/diskprofiles
- GET /storagedomains/{storagedomain:id}/diskprofiles
- GET /storagedomains/{storagedomain:id}/diskprofiles/{profile:id}
- DELETE /storagedomains/{storagedomain:id}/diskprofiles/{profile:id}
- POST /storagedomains/{storagedomain:id}/disks
- GET /storagedomains/{storagedomain:id}/disks
- PUT /storagedomains/{storagedomain:id}/disks/{disk:id}
- GET /storagedomains/{storagedomain:id}/disks/{disk:id}
- DELETE /storagedomains/{storagedomain:id}/disks/{disk:id}
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/copy
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/export
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/move
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
- GET /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions
- GET /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
- DELETE /storagedomains/{storagedomain:id}/disks/{disk:id}/permissions/{permission:id}
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/reduce
- POST /storagedomains/{storagedomain:id}/disks/{disk:id}/sparsify
- GET /storagedomains/{storagedomain:id}/disks/{disk:id}/statistics
- GET /storagedomains/{storagedomain:id}/disks/{disk:id}/statistics/{statistic:id}
- GET /storagedomains/{storagedomain:id}/disksnapshots
- GET /storagedomains/{storagedomain:id}/disksnapshots/{snapshot:id}
- DELETE /storagedomains/{storagedomain:id}/disksnapshots/{snapshot:id}
- GET /storagedomains/{storagedomain:id}/files
- GET /storagedomains/{storagedomain:id}/files/{file:id}
- GET /storagedomains/{storagedomain:id}/images
- GET /storagedomains/{storagedomain:id}/images/{image:id}
- POST /storagedomains/{storagedomain:id}/images/{image:id}/import
- POST /storagedomains/{storagedomain:id}/isattached
- POST /storagedomains/{storagedomain:id}/permissions
- GET /storagedomains/{storagedomain:id}/permissions
- GET /storagedomains/{storagedomain:id}/permissions/{permission:id}
- DELETE /storagedomains/{storagedomain:id}/permissions/{permission:id}
- POST /storagedomains/{storagedomain:id}/reduceluns
- POST /storagedomains/{storagedomain:id}/refreshluns
- POST /storagedomains/{storagedomain:id}/storageconnections
- GET /storagedomains/{storagedomain:id}/storageconnections
- GET /storagedomains/{storagedomain:id}/storageconnections/{connection:id}
- DELETE /storagedomains/{storagedomain:id}/storageconnections/{connection:id}
- GET /storagedomains/{storagedomain:id}/templates
- GET /storagedomains/{storagedomain:id}/templates/{template:id}
- DELETE /storagedomains/{storagedomain:id}/templates/{template:id}
- GET /storagedomains/{storagedomain:id}/templates/{template:id}/disks
- GET /storagedomains/{storagedomain:id}/templates/{template:id}/disks/{disk:id}
- POST /storagedomains/{storagedomain:id}/templates/{template:id}/import
- POST /storagedomains/{storagedomain:id}/templates/{template:id}/register
- POST /storagedomains/{storagedomain:id}/updateovfstore
- GET /storagedomains/{storagedomain:id}/vms
- GET /storagedomains/{storagedomain:id}/vms/{vm:id}
- DELETE /storagedomains/{storagedomain:id}/vms/{vm:id}
- GET /storagedomains/{storagedomain:id}/vms/{vm:id}/diskattachments
- GET /storagedomains/{storagedomain:id}/vms/{vm:id}/diskattachments/{attachment:id}
- GET /storagedomains/{storagedomain:id}/vms/{vm:id}/disks
- GET /storagedomains/{storagedomain:id}/vms/{vm:id}/disks/{disk:id}
- POST /storagedomains/{storagedomain:id}/vms/{vm:id}/import
- POST /storagedomains/{storagedomain:id}/vms/{vm:id}/register
- POST /tags
- GET /tags
- GET /tags/{tag:id}
- PUT /tags/{tag:id}
- DELETE /tags/{tag:id}
- POST /templates
- GET /templates
- GET /templates/{template:id}
- PUT /templates/{template:id}
- DELETE /templates/{template:id}
- GET /templates/{template:id}/cdroms
- GET /templates/{template:id}/cdroms/{cdrom:id}
- GET /templates/{template:id}/diskattachments
- GET /templates/{template:id}/diskattachments/{attachment:id}
- DELETE /templates/{template:id}/diskattachments/{attachment:id}
- POST /templates/{template:id}/export
- POST /templates/{template:id}/graphicsconsoles
- GET /templates/{template:id}/graphicsconsoles
- GET /templates/{template:id}/graphicsconsoles/{console:id}
- DELETE /templates/{template:id}/graphicsconsoles/{console:id}
- POST /templates/{template:id}/nics
- GET /templates/{template:id}/nics
- GET /templates/{template:id}/nics/{nic:id}
- PUT /templates/{template:id}/nics/{nic:id}
- DELETE /templates/{template:id}/nics/{nic:id}
- POST /templates/{template:id}/permissions
- GET /templates/{template:id}/permissions
- GET /templates/{template:id}/permissions/{permission:id}
- DELETE /templates/{template:id}/permissions/{permission:id}
- POST /templates/{template:id}/tags
- GET /templates/{template:id}/tags
- GET /templates/{template:id}/tags/{tag:id}
- DELETE /templates/{template:id}/tags/{tag:id}
- POST /templates/{template:id}/watchdogs
- GET /templates/{template:id}/watchdogs
- GET /templates/{template:id}/watchdogs/{watchdog:id}
- PUT /templates/{template:id}/watchdogs/{watchdog:id}
- DELETE /templates/{template:id}/watchdogs/{watchdog:id}
- POST /users
- GET /users
- GET /users/{user:id}
- DELETE /users/{user:id}
- GET /users/{user:id}/groups
- POST /users/{user:id}/permissions
- GET /users/{user:id}/permissions
- GET /users/{user:id}/permissions/{permission:id}
- DELETE /users/{user:id}/permissions/{permission:id}
- GET /users/{user:id}/roles
- GET /users/{user:id}/roles/{role:id}
- DELETE /users/{user:id}/roles/{role:id}
- PUT /users/{user:id}/roles/{role:id}
- POST /users/{user:id}/roles/{role:id}/permits
- GET /users/{user:id}/roles/{role:id}/permits
- GET /users/{user:id}/roles/{role:id}/permits/{permit:id}
- DELETE /users/{user:id}/roles/{role:id}/permits/{permit:id}
- POST /users/{user:id}/sshpublickeys
- GET /users/{user:id}/sshpublickeys
- GET /users/{user:id}/sshpublickeys/{key:id}
- PUT /users/{user:id}/sshpublickeys/{key:id}
- DELETE /users/{user:id}/sshpublickeys/{key:id}
- POST /users/{user:id}/tags
- GET /users/{user:id}/tags
- GET /users/{user:id}/tags/{tag:id}
- DELETE /users/{user:id}/tags/{tag:id}
- POST /vmpools
- GET /vmpools
- GET /vmpools/{pool:id}
- PUT /vmpools/{pool:id}
- DELETE /vmpools/{pool:id}
- POST /vmpools/{pool:id}/allocatevm
- POST /vmpools/{pool:id}/permissions
- GET /vmpools/{pool:id}/permissions
- GET /vmpools/{pool:id}/permissions/{permission:id}
- DELETE /vmpools/{pool:id}/permissions/{permission:id}
- POST /vms
- GET /vms
- GET /vms/{vm:id}
- PUT /vms/{vm:id}
- DELETE /vms/{vm:id}
- POST /vms/{vm:id}/affinitylabels
- GET /vms/{vm:id}/affinitylabels
- GET /vms/{vm:id}/affinitylabels/{label:id}
- DELETE /vms/{vm:id}/affinitylabels/{label:id}
- GET /vms/{vm:id}/applications
- GET /vms/{vm:id}/applications/{application:id}
- POST /vms/{vm:id}/cancelmigration
- POST /vms/{vm:id}/cdroms
- GET /vms/{vm:id}/cdroms
- GET /vms/{vm:id}/cdroms/{cdrom:id}
- PUT /vms/{vm:id}/cdroms/{cdrom:id}
- POST /vms/{vm:id}/clone
- POST /vms/{vm:id}/commitsnapshot
- POST /vms/{vm:id}/detach
- POST /vms/{vm:id}/diskattachments
- GET /vms/{vm:id}/diskattachments
- GET /vms/{vm:id}/diskattachments/{attachment:id}
- DELETE /vms/{vm:id}/diskattachments/{attachment:id}
- PUT /vms/{vm:id}/diskattachments/{attachment:id}
- POST /vms/{vm:id}/export
- POST /vms/{vm:id}/freezefilesystems
- POST /vms/{vm:id}/graphicsconsoles
- GET /vms/{vm:id}/graphicsconsoles
- GET /vms/{vm:id}/graphicsconsoles/{console:id}
- DELETE /vms/{vm:id}/graphicsconsoles/{console:id}
- POST /vms/{vm:id}/graphicsconsoles/{console:id}/proxyticket
- POST /vms/{vm:id}/graphicsconsoles/{console:id}/remoteviewerconnectionfile
- POST /vms/{vm:id}/graphicsconsoles/{console:id}/ticket
- POST /vms/{vm:id}/hostdevices
- GET /vms/{vm:id}/hostdevices
- GET /vms/{vm:id}/hostdevices/{device:id}
- DELETE /vms/{vm:id}/hostdevices/{device:id}
- GET /vms/{vm:id}/katelloerrata
- GET /vms/{vm:id}/katelloerrata/{katelloerratum:id}
- POST /vms/{vm:id}/logon
- POST /vms/{vm:id}/maintenance
- POST /vms/{vm:id}/migrate
- POST /vms/{vm:id}/nics
- GET /vms/{vm:id}/nics
- GET /vms/{vm:id}/nics/{nic:id}
- PUT /vms/{vm:id}/nics/{nic:id}
- DELETE /vms/{vm:id}/nics/{nic:id}
- POST /vms/{vm:id}/nics/{nic:id}/activate
- POST /vms/{vm:id}/nics/{nic:id}/deactivate
- GET /vms/{vm:id}/nics/{nic:id}/networkfilterparameters
- POST /vms/{vm:id}/nics/{nic:id}/networkfilterparameters
- GET /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
- PUT /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
- DELETE /vms/{vm:id}/nics/{nic:id}/networkfilterparameters/{parameter:id}
- GET /vms/{vm:id}/nics/{nic:id}/reporteddevices
- GET /vms/{vm:id}/nics/{nic:id}/reporteddevices/{reporteddevice:id}
- GET /vms/{vm:id}/nics/{nic:id}/statistics
- GET /vms/{vm:id}/nics/{nic:id}/statistics/{statistic:id}
- POST /vms/{vm:id}/numanodes
- GET /vms/{vm:id}/numanodes
- GET /vms/{vm:id}/numanodes/{node:id}
- PUT /vms/{vm:id}/numanodes/{node:id}
- DELETE /vms/{vm:id}/numanodes/{node:id}
- POST /vms/{vm:id}/permissions
- GET /vms/{vm:id}/permissions
- GET /vms/{vm:id}/permissions/{permission:id}
- DELETE /vms/{vm:id}/permissions/{permission:id}
- POST /vms/{vm:id}/previewsnapshot
- POST /vms/{vm:id}/reboot
- POST /vms/{vm:id}/reordermacaddresses
- GET /vms/{vm:id}/reporteddevices
- GET /vms/{vm:id}/reporteddevices/{reporteddevice:id}
- GET /vms/{vm:id}/sessions
- GET /vms/{vm:id}/sessions/{session:id}
- POST /vms/{vm:id}/shutdown
- POST /vms/{vm:id}/snapshots
- GET /vms/{vm:id}/snapshots
- GET /vms/{vm:id}/snapshots/{snapshot:id}
- DELETE /vms/{vm:id}/snapshots/{snapshot:id}
- GET /vms/{vm:id}/snapshots/{snapshot:id}/cdroms
- GET /vms/{vm:id}/snapshots/{snapshot:id}/cdroms/{cdrom:id}
- GET /vms/{vm:id}/snapshots/{snapshot:id}/disks
- GET /vms/{vm:id}/snapshots/{snapshot:id}/disks/{disk:id}
- GET /vms/{vm:id}/snapshots/{snapshot:id}/nics
- GET /vms/{vm:id}/snapshots/{snapshot:id}/nics/{nic:id}
- POST /vms/{vm:id}/snapshots/{snapshot:id}/restore
- POST /vms/{vm:id}/start
- GET /vms/{vm:id}/statistics
- GET /vms/{vm:id}/statistics/{statistic:id}
- POST /vms/{vm:id}/stop
- POST /vms/{vm:id}/suspend
- POST /vms/{vm:id}/tags
- GET /vms/{vm:id}/tags
- GET /vms/{vm:id}/tags/{tag:id}
- DELETE /vms/{vm:id}/tags/{tag:id}
- POST /vms/{vm:id}/thawfilesystems
- POST /vms/{vm:id}/ticket
- POST /vms/{vm:id}/undosnapshot
- POST /vms/{vm:id}/watchdogs
- GET /vms/{vm:id}/watchdogs
- GET /vms/{vm:id}/watchdogs/{watchdog:id}
- PUT /vms/{vm:id}/watchdogs/{watchdog:id}
- DELETE /vms/{vm:id}/watchdogs/{watchdog:id}
- POST /vnicprofiles
- GET /vnicprofiles
- GET /vnicprofiles/{profile:id}
- PUT /vnicprofiles/{profile:id}
- DELETE /vnicprofiles/{profile:id}
- POST /vnicprofiles/{profile:id}/permissions
- GET /vnicprofiles/{profile:id}/permissions
- GET /vnicprofiles/{profile:id}/permissions/{permission:id}
- DELETE /vnicprofiles/{profile:id}/permissions/{permission:id}
Chapter 6. Services
This section enumerates all the services that are available in the API.
6.1. AffinityGroup
This service manages a single affinity group.
| Name | Summary |
|---|---|
|
| Retrieve the affinity group details. |
|
| Remove the affinity group. |
|
| Update the affinity group. |
6.1.1. get GET
Retrieve the affinity group details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The affinity group. |
6.1.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.1.2. remove DELETE
Remove the affinity group.
DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456
DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.1.3. update PUT
Update the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The affinity group. |
6.2. AffinityGroupVm
This service manages a single virtual machine to affinity group assignment.
| Name | Summary |
|---|---|
|
| Remove this virtual machine from the affinity group. |
6.2.1. remove DELETE
Remove this virtual machine from the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.3. AffinityGroupVms
This service manages a collection of all the virtual machines assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Adds a virtual machine to the affinity group. |
|
| List all virtual machines assigned to this affinity group. |
6.3.1. add POST
Adds a virtual machine to the affinity group.
For example, to add the virtual machine 789 to the affinity group 456 of cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmsWith the following body:
<vm id="789"/>
<vm id="789"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.3.2. list GET
List all virtual machines assigned to this affinity group.
The order of the returned virtual machines isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of virtual machines to return. | |
|
| Out |
6.3.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.3.2.2. max
Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are returned.
6.4. AffinityGroups
The affinity groups service manages virtual machine relationships and dependencies.
| Name | Summary |
|---|---|
|
| Create a new affinity group. |
|
| List existing affinity groups. |
6.4.1. add POST
Create a new affinity group.
Post a request like in the example below to create a new affinity group:
POST /ovirt-engine/api/clusters/000-000/affinitygroups
POST /ovirt-engine/api/clusters/000-000/affinitygroupsAnd use the following example in its body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The affinity group object to create. |
6.4.2. list GET
List existing affinity groups.
The order of the affinity groups results isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of existing affinity groups. | |
|
| In | Sets the maximum number of affinity groups to return. |
6.4.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.4.2.2. max
Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned.
6.5. AffinityLabel
The details of a single affinity label.
| Name | Summary |
|---|---|
|
| Retrieves the details of a label. |
|
| Removes a label from the system and clears all assignments of the removed label. |
|
| Updates a label. |
6.5.1. get GET
Retrieves the details of a label.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.5.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.5.2. remove DELETE
Removes a label from the system and clears all assignments of the removed label.
6.5.3. update PUT
Updates a label. This call will update all metadata, such as the name or description.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.6. AffinityLabelHost
This service represents a host that has a specific label when accessed through the affinitylabels/hosts subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about a host that has this label assigned. |
|
| Remove a label from a host. |
6.6.1. get GET
Retrieves details about a host that has this label assigned.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.6.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.6.2. remove DELETE
Remove a label from a host.
6.7. AffinityLabelHosts
This service represents list of hosts that have a specific label when accessed through the affinitylabels/hosts subcollection.
| Name | Summary |
|---|---|
|
| Add a label to a host. |
|
| List all hosts with the label. |
6.7.1. add POST
Add a label to a host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.7.2. list GET
List all hosts with the label.
The order of the returned hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.7.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.8. AffinityLabelVm
This service represents a vm that has a specific label when accessed through the affinitylabels/vms subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about a vm that has this label assigned. |
|
| Remove a label from a vm. |
6.8.1. get GET
Retrieves details about a vm that has this label assigned.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.8.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.8.2. remove DELETE
Remove a label from a vm.
6.9. AffinityLabelVms
This service represents list of vms that have a specific label when accessed through the affinitylabels/vms subcollection.
| Name | Summary |
|---|---|
|
| Add a label to a vm. |
|
| List all virtual machines with the label. |
6.9.1. add POST
Add a label to a vm.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.9.2. list GET
List all virtual machines with the label.
The order of the returned virtual machines isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.9.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.10. AffinityLabels
Manages the affinity labels available in the system.
| Name | Summary |
|---|---|
|
| Creates a new label. |
|
| Lists all labels present in the system. |
6.10.1. add POST
Creates a new label. The label is automatically attached to all entities mentioned in the vms or hosts lists.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.10.2. list GET
Lists all labels present in the system.
The order of the returned labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of labels to return. |
6.10.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.10.2.2. max
Sets the maximum number of labels to return. If not specified all the labels are returned.
6.11. Area
This annotation is intended to specify what oVirt area is the annotated concept related to. Currently the following areas are in use, and they are closely related to the oVirt teams, but not necessarily the same:
- Infrastructure
- Network
- SLA
- Storage
- Virtualization
A concept may be associated to more than one area, or to no area.
The value of this annotation is intended for reporting only, and it doesn’t affect at all the generated code or the validity of the model
6.12. AssignedAffinityLabel
This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about the attached label. |
|
| Removes the label from an entity. |
6.12.1. get GET
Retrieves details about the attached label.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.12.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.12.2. remove DELETE
Removes the label from an entity. Does not touch the label itself.
6.13. AssignedAffinityLabels
This service is used to list and manipulate affinity labels that are assigned to supported entities when accessed using entities/affinitylabels.
| Name | Summary |
|---|---|
|
| Attaches a label to an entity. |
|
| Lists all labels that are attached to an entity. |
6.13.1. add POST
Attaches a label to an entity.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.13.2. list GET
Lists all labels that are attached to an entity.
The order of the returned entities isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.13.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.14. AssignedCpuProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.14.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.14.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.14.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.15. AssignedCpuProfiles
| Name | Summary |
|---|---|
|
| Add a new cpu profile for the cluster. |
|
| List the CPU profiles assigned to the cluster. |
6.15.1. add POST
Add a new cpu profile for the cluster.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.15.2. list GET
List the CPU profiles assigned to the cluster.
The order of the returned CPU profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.15.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.15.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.16. AssignedDiskProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.16.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.16.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.16.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.17. AssignedDiskProfiles
| Name | Summary |
|---|---|
|
| Add a new disk profile for the storage domain. |
|
| Returns the list of disk profiles assigned to the storage domain. |
6.17.1. add POST
Add a new disk profile for the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.17.2. list GET
Returns the list of disk profiles assigned to the storage domain.
The order of the returned disk profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.17.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.17.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.18. AssignedPermissions
Represents a permission sub-collection, scoped by user, group or some entity type.
| Name | Summary |
|---|---|
|
| Assign a new permission to a user or group for specific entity. |
|
| List all the permissions of the specific entity. |
6.18.1. add POST
Assign a new permission to a user or group for specific entity.
For example, to assign the UserVmManager role to the virtual machine with id 123 to the user with id 456 send a request like this:
POST /ovirt-engine/api/vms/123/permissions
POST /ovirt-engine/api/vms/123/permissionsWith a request body like this:
To assign the SuperUser role to the system to the user with id 456 send a request like this:
POST /ovirt-engine/api/permissions
POST /ovirt-engine/api/permissionsWith a request body like this:
If you want to assign permission to the group instead of the user please replace the user element with the group element with proper id of the group. For example to assign the UserRole role to the cluster with id 123 to the group with id 789 send a request like this:
POST /ovirt-engine/api/clusters/123/permissions
POST /ovirt-engine/api/clusters/123/permissionsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The permission. |
6.18.2. list GET
List all the permissions of the specific entity.
For example to list all the permissions of the cluster with id 123 send a request like this:
GET /ovirt-engine/api/clusters/123/permissions
GET /ovirt-engine/api/clusters/123/permissionsThe order of the returned permissions isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of permissions. |
6.18.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.19. AssignedRoles
Represents a roles sub-collection, for example scoped by user.
| Name | Summary |
|---|---|
|
| Returns the roles assigned to the permission. |
6.19.1. list GET
Returns the roles assigned to the permission.
The order of the returned roles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of roles to return. | |
|
| Out |
6.19.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.19.1.2. max
Sets the maximum number of roles to return. If not specified all the roles are returned.
6.20. AssignedTag
A service to manage assignment of specific tag to specific entities in system.
| Name | Summary |
|---|---|
|
| Gets the information about the assigned tag. |
|
| Unassign tag from specific entity in the system. |
6.20.1. get GET
Gets the information about the assigned tag.
For example to retrieve the information about the tag with the id 456 which is assigned to virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/tags/456
GET /ovirt-engine/api/vms/123/tags/456<tag href="/ovirt-engine/api/tags/456" id="456"> <name>root</name> <description>root</description> <vm href="/ovirt-engine/api/vms/123" id="123"/> </tag>
<tag href="/ovirt-engine/api/tags/456" id="456">
<name>root</name>
<description>root</description>
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</tag>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The assigned tag. |
6.20.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.20.2. remove DELETE
Unassign tag from specific entity in the system.
For example to unassign the tag with id 456 from virtual machine with id 123 send a request like this:
DELETE /ovirt-engine/api/vms/123/tags/456
DELETE /ovirt-engine/api/vms/123/tags/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.21. AssignedTags
A service to manage collection of assignment of tags to specific entities in system.
| Name | Summary |
|---|---|
|
| Assign tag to specific entity in the system. |
|
| List all tags assigned to the specific entity. |
6.21.1. add POST
Assign tag to specific entity in the system.
For example to assign tag mytag to virtual machine with the id 123 send a request like this:
POST /ovirt-engine/api/vms/123/tags
POST /ovirt-engine/api/vms/123/tagsWith a request body like this:
<tag> <name>mytag</name> </tag>
<tag>
<name>mytag</name>
</tag>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The assigned tag. |
6.21.2. list GET
List all tags assigned to the specific entity.
For example to list all the tags of the virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/tags
GET /ovirt-engine/api/vms/123/tagsThe order of the returned tags isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of tags to return. | |
|
| Out | The list of assigned tags. |
6.21.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.21.2.2. max
Sets the maximum number of tags to return. If not specified all the tags are returned.
6.22. AssignedVnicProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.22.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.22.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.22.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.23. AssignedVnicProfiles
| Name | Summary |
|---|---|
|
| Add a new virtual network interface card profile for the network. |
|
| Returns the list of VNIC profiles assifned to the network. |
6.23.1. add POST
Add a new virtual network interface card profile for the network.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.23.2. list GET
Returns the list of VNIC profiles assifned to the network.
The order of the returned VNIC profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.23.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.23.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.24. AttachedStorageDomain
| Name | Summary |
|---|---|
|
| This operation activates an attached storage domain. |
|
| This operation deactivates an attached storage domain. |
|
| |
|
|
6.24.1. activate POST
This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center.
POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate
The activate action does not take any action specific parameters, so the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.24.2. deactivate POST
This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center. For example, to deactivate storage domain 456, send the following request:
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivateWith a request body like this:
<action/>
<action/>
If the force parameter is true then the operation will succeed, even if the OVF update which takes place before the deactivation of the storage domain failed. If the force parameter is false and the OVF update failed, the deactivation of the storage domain will also fail.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if the OVF update for the storage domain failed. |
6.24.2.1. force
Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if the OVF update for the storage domain failed. For example, to deactivate storage domain 456 using force flag, send the following request:
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivateWith a request body like this:
<action> <force>true</force> <action>
<action>
<force>true</force>
<action>
This parameter is optional, and the default value is false.
6.24.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.24.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.24.4. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.25. AttachedStorageDomainDisk
Manages a single disk available in a storage domain attached to a data center.
Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations use the service that manages all the disks of the system, or the service that manages an specific disk.
| Name | Summary |
|---|---|
|
| Copies a disk to the specified storage domain. |
|
| Exports a disk to an export storage domain. |
|
| Retrieves the description of the disk. |
|
| Moves a disk to another storage domain. |
|
| Registers an unregistered disk. |
|
| Removes a disk. |
|
| Sparsify the disk. |
|
| Updates the disk. |
6.25.1. copy POST
Copies a disk to the specified storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To copy a disk use the copy operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Description of the resulting disk. | |
|
| In | The storage domain where the new disk will be created. |
6.25.2. export POST
Exports a disk to an export storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To export a disk use the export operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The export storage domain where the disk should be exported to. |
6.25.3. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.25.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.25.4. move POST
Moves a disk to another storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To move a disk use the move operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | The storage domain where the disk will be moved to. |
6.25.5. register POST
Registers an unregistered disk.
6.25.6. remove DELETE
Removes a disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.25.7. sparsify POST
Sparsify the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.25.8. update PUT
Updates the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To update a disk use the update operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The update to apply to the disk. |
6.26. AttachedStorageDomainDisks
Manages the collection of disks available inside an storage domain that is attached to a data center.
| Name | Summary |
|---|---|
|
| Adds or registers a disk. |
|
| Retrieve the list of disks that are available in the storage domain. |
6.26.1. add POST
Adds or registers a disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To add a new disk use the add operation of the service that manages the disks of the system. To register an unregistered disk use the register operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk to add or register. | |
|
| In | Indicates if a new disk should be added or if an existing unregistered disk should be registered. |
6.26.1.1. unregistered
Indicates if a new disk should be added or if an existing unregistered disk should be registered. If the value is true then the identifier of the disk to register needs to be provided. For example, to register the disk with id 456 send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=trueWith a request body like this:
<disk id="456"/>
<disk id="456"/>
If the value is false then a new disk will be created in the storage domain. In that case the provisioned_size, format and name attributes are mandatory. For example, to create a new copy on write disk of 1 GiB, send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks
POST /ovirt-engine/api/storagedomains/123/disksWith a request body like this:
<disk> <name>mydisk</name> <format>cow</format> <provisioned_size>1073741824</provisioned_size> </disk>
<disk>
<name>mydisk</name>
<format>cow</format>
<provisioned_size>1073741824</provisioned_size>
</disk>
The default value is false.
6.26.2. list GET
Retrieve the list of disks that are available in the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.26.2.1. disks
List of retrieved disks.
The order of the returned disks isn’t guaranteed.
6.26.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.26.2.3. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.27. AttachedStorageDomains
Manages the storage domains attached to a data center.
| Name | Summary |
|---|---|
|
| Attaches an existing storage domain to the data center. |
|
| Returns the list of storage domains attached to the data center. |
6.27.1. add POST
Attaches an existing storage domain to the data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The storage domain to attach to the data center. |
6.27.2. list GET
Returns the list of storage domains attached to the data center.
The order of the returned storage domains isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of storage domains to return. | |
|
| Out | A list of storage domains that are attached to the data center. |
6.27.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.27.2.2. max
Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.
6.28. Balance
| Name | Summary |
|---|---|
|
| |
|
|
6.28.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.28.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.28.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.29. Balances
| Name | Summary |
|---|---|
|
| Add a balance module to a specified user defined scheduling policy. |
|
| Returns the list of balance modules used by the scheduling policy. |
6.29.1. add POST
Add a balance module to a specified user defined scheduling policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.29.2. list GET
Returns the list of balance modules used by the scheduling policy.
The order of the returned balance modules isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of balances to return. |
6.29.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.29.2.2. max
Sets the maximum number of balances to return. If not specified all the balances are returned.
6.30. Bookmark
A service to manage a bookmark.
| Name | Summary |
|---|---|
|
| Get a bookmark. |
|
| Remove a bookmark. |
|
| Update a bookmark. |
6.30.1. get GET
Get a bookmark.
An example for getting a bookmark:
GET /ovirt-engine/api/bookmarks/123
GET /ovirt-engine/api/bookmarks/123<bookmark href="/ovirt-engine/api/bookmarks/123" id="123"> <name>example_vm</name> <value>vm: name=example*</value> </bookmark>
<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
<name>example_vm</name>
<value>vm: name=example*</value>
</bookmark>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The requested bookmark. | |
|
| In | Indicates which inner links should be followed. |
6.30.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.30.2. remove DELETE
Remove a bookmark.
An example for removing a bookmark:
DELETE /ovirt-engine/api/bookmarks/123
DELETE /ovirt-engine/api/bookmarks/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.30.3. update PUT
Update a bookmark.
An example for updating a bookmark:
PUT /ovirt-engine/api/bookmarks/123
PUT /ovirt-engine/api/bookmarks/123With the request body:
<bookmark> <name>new_example_vm</name> <value>vm: name=new_example*</value> </bookmark>
<bookmark>
<name>new_example_vm</name>
<value>vm: name=new_example*</value>
</bookmark>6.31. Bookmarks
A service to manage bookmarks.
| Name | Summary |
|---|---|
|
| Adding a new bookmark. |
|
| Listing all the available bookmarks. |
6.31.1. add POST
Adding a new bookmark.
Example of adding a bookmark:
POST /ovirt-engine/api/bookmarks
POST /ovirt-engine/api/bookmarks<bookmark> <name>new_example_vm</name> <value>vm: name=new_example*</value> </bookmark>
<bookmark>
<name>new_example_vm</name>
<value>vm: name=new_example*</value>
</bookmark>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The added bookmark. |
6.31.2. list GET
Listing all the available bookmarks.
Example of listing bookmarks:
GET /ovirt-engine/api/bookmarks
GET /ovirt-engine/api/bookmarksThe order of the returned bookmarks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of available bookmarks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bookmarks to return. |
6.31.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.31.2.2. max
Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.
6.32. Cluster
A service to manage a specific cluster.
| Name | Summary |
|---|---|
|
| Gets information about the cluster. |
|
| Removes the cluster from the system. |
|
| |
|
| Synchronizes all networks on the cluster. |
|
| Updates information about the cluster. |
6.32.1. get GET
Gets information about the cluster.
An example of getting a cluster:
GET /ovirt-engine/api/clusters/123
GET /ovirt-engine/api/clusters/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.32.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.32.2. remove DELETE
Removes the cluster from the system.
DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.32.3. resetemulatedmachine POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reset should be performed asynchronously. |
6.32.4. syncallnetworks POST
Synchronizes all networks on the cluster.
POST /ovirt-engine/api/clusters/123/syncallnetworks
POST /ovirt-engine/api/clusters/123/syncallnetworksWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.32.5. update PUT
Updates information about the cluster.
Only the specified fields are updated; others remain unchanged.
For example, to update the cluster’s CPU:
PUT /ovirt-engine/api/clusters/123
PUT /ovirt-engine/api/clusters/123With a request body like this:
<cluster>
<cpu>
<type>Intel Haswell-noTSX Family</type>
</cpu>
</cluster>
<cluster>
<cpu>
<type>Intel Haswell-noTSX Family</type>
</cpu>
</cluster>6.33. ClusterEnabledFeature
Represents a feature enabled for the cluster.
| Name | Summary |
|---|---|
|
| Provides the information about the cluster feature enabled. |
|
| Disables a cluster feature. |
6.33.1. get GET
Provides the information about the cluster feature enabled.
For example, to find details of the enabled feature 456 for cluster 123, send a request like this:
GET /ovirt-engine/api/clusters/123/enabledfeatures/456
GET /ovirt-engine/api/clusters/123/enabledfeatures/456That will return a ClusterFeature object containing the name:
<cluster_feature id="456"> <name>libgfapi_supported</name> </cluster_feature>
<cluster_feature id="456">
<name>libgfapi_supported</name>
</cluster_feature>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved cluster feature that’s enabled. | |
|
| In | Indicates which inner links should be followed. |
6.33.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.33.2. remove DELETE
Disables a cluster feature.
For example, to disable the feature 456 of cluster 123 send a request like this:
DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456
DELETE /ovirt-engine/api/clusters/123/enabledfeatures/4566.34. ClusterEnabledFeatures
Provides information about the additional features that are enabled for this cluster. The features that are enabled are the available features for the cluster level
| Name | Summary |
|---|---|
|
| Enable an additional feature for a cluster. |
|
| Lists the additional features enabled for the cluster. |
6.34.1. add POST
Enable an additional feature for a cluster.
For example, to enable a feature 456 on cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/enabledfeatures
POST /ovirt-engine/api/clusters/123/enabledfeaturesThe request body should look like this:
<cluster_feature id="456"/>
<cluster_feature id="456"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.34.2. list GET
Lists the additional features enabled for the cluster.
For example, to get the features enabled for cluster 123 send a request like this:
GET /ovirt-engine/api/clusters/123/enabledfeatures
GET /ovirt-engine/api/clusters/123/enabledfeaturesThis will return a list of features:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved features. | |
|
| In | Indicates which inner links should be followed. |
6.34.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.35. ClusterExternalProviders
This service lists external providers.
| Name | Summary |
|---|---|
|
| Returns the list of external providers. |
6.35.1. list GET
Returns the list of external providers.
The order of the returned list of providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.35.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.36. ClusterFeature
Represents a feature enabled for the cluster level
| Name | Summary |
|---|---|
|
| Provides the information about the a cluster feature supported by a cluster level. |
6.36.1. get GET
Provides the information about the a cluster feature supported by a cluster level.
For example, to find details of the cluster feature 456 for cluster level 4.1, send a request like this:
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456That will return a ClusterFeature object containing the name:
<cluster_feature id="456"> <name>libgfapi_supported</name> </cluster_feature>
<cluster_feature id="456">
<name>libgfapi_supported</name>
</cluster_feature>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved cluster feature. | |
|
| In | Indicates which inner links should be followed. |
6.36.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.37. ClusterFeatures
Provides information about the cluster features that are supported by a cluster level.
| Name | Summary |
|---|---|
|
| Lists the cluster features supported by the cluster level. |
6.37.1. list GET
Lists the cluster features supported by the cluster level.
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeaturesThis will return a list of cluster features supported by the cluster level:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved features. | |
|
| In | Indicates which inner links should be followed. |
6.37.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.38. ClusterLevel
Provides information about a specific cluster level. See the ClusterLevels service for more information.
| Name | Summary |
|---|---|
|
| Provides the information about the capabilities of the specific cluster level managed by this service. |
6.38.1. get GET
Provides the information about the capabilities of the specific cluster level managed by this service.
For example, to find what CPU types are supported by level 3.6 you can send a request like this:
GET /ovirt-engine/api/clusterlevels/3.6
GET /ovirt-engine/api/clusterlevels/3.6That will return a ClusterLevel object containing the supported CPU types, and other information which describes the cluster level:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retreived cluster level. |
6.38.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.39. ClusterLevels
Provides information about the capabilities of different cluster levels supported by the engine. Version 4.0 of the engine supports levels 4.0 and 3.6. Each of these levels support different sets of CPU types, for example. This service provides that information.
| Name | Summary |
|---|---|
|
| Lists the cluster levels supported by the system. |
6.39.1. list GET
Lists the cluster levels supported by the system.
GET /ovirt-engine/api/clusterlevels
GET /ovirt-engine/api/clusterlevelsThis will return a list of available cluster levels.
The order of the returned cluster levels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved cluster levels. |
6.39.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.40. ClusterNetwork
A service to manage a specific cluster network.
| Name | Summary |
|---|---|
|
| Retrieves the cluster network details. |
|
| Unassigns the network from a cluster. |
|
| Updates the network in the cluster. |
6.40.1. get GET
Retrieves the cluster network details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The cluster network. |
6.40.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.40.2. remove DELETE
Unassigns the network from a cluster.
6.40.3. update PUT
Updates the network in the cluster.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The cluster network. |
6.41. ClusterNetworks
A service to manage cluster networks.
| Name | Summary |
|---|---|
|
| Assigns the network to a cluster. |
|
| Lists the networks that are assigned to the cluster. |
6.41.1. add POST
Assigns the network to a cluster.
Post a request like in the example below to assign the network to a cluster:
POST /ovirt-engine/api/clusters/123/networks
POST /ovirt-engine/api/clusters/123/networksUse the following example in its body:
<network id="123" />
<network id="123" />| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network object to be assigned to the cluster. |
6.41.2. list GET
Lists the networks that are assigned to the cluster.
The order of the returned clusters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | The list of networks that are assigned to the cluster. |
6.41.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.41.2.2. max
Sets the maximum number of networks to return. If not specified, all the networks are returned.
6.42. Clusters
A service to manage clusters.
| Name | Summary |
|---|---|
|
| Creates a new cluster. |
|
| Returns the list of clusters of the system. |
6.42.1. add POST
Creates a new cluster.
This requires the name, cpu.type, and data_center attributes. Identify the data center with either the id or name attribute.
POST /ovirt-engine/api/clusters
POST /ovirt-engine/api/clustersWith a request body like this:
To create a cluster with an external network provider to be deployed on every host that is added to the cluster, send a request like this:
POST /ovirt-engine/api/clusters
POST /ovirt-engine/api/clustersWith a request body containing a reference to the desired provider:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.42.2. list GET
Returns the list of clusters of the system.
The order of the returned clusters is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the search should be performed taking case into account. | |
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of clusters to return. | |
|
| In | A query string used to restrict the returned clusters. |
6.42.2.1. case_sensitive
Indicates if the search should be performed taking case into account. The default value is true, which means that case is taken into account. To search ignoring case, set it to false.
6.42.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.42.2.3. max
Sets the maximum number of clusters to return. If not specified, all the clusters are returned.
6.43. Copyable
| Name | Summary |
|---|---|
|
|
6.43.1. copy POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the copy should be performed asynchronously. |
6.44. CpuProfile
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified cpu profile in the system. |
6.44.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.44.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.44.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.44.3. update PUT
Update the specified cpu profile in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.45. CpuProfiles
| Name | Summary |
|---|---|
|
| Add a new cpu profile to the system. |
|
| Returns the list of CPU profiles of the system. |
6.45.1. add POST
Add a new cpu profile to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.45.2. list GET
Returns the list of CPU profiles of the system.
The order of the returned list of CPU profiles isn’t guranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.45.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.45.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.46. DataCenter
A service to manage a data center.
| Name | Summary |
|---|---|
|
| Get a data center. |
|
| Removes the data center. |
|
| Updates the data center. |
6.46.1. get GET
Get a data center.
An example of getting a data center:
GET /ovirt-engine/api/datacenters/123
GET /ovirt-engine/api/datacenters/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.46.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.46.2. remove DELETE
Removes the data center.
DELETE /ovirt-engine/api/datacenters/123
DELETE /ovirt-engine/api/datacenters/123Without any special parameters, the storage domains attached to the data center are detached and then removed from the storage. If something fails when performing this operation, for example if there is no host available to remove the storage domains from the storage, the complete operation will fail.
If the force parameter is true then the operation will always succeed, even if something fails while removing one storage domain, for example. The failure is just ignored and the data center is removed from the database anyway.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation. |
6.46.2.1. force
Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation.
This parameter is optional, and the default value is false.
6.46.3. update PUT
Updates the data center.
The name, description, storage_type, version, storage_format and mac_pool elements are updatable post-creation. For example, to change the name and description of data center 123 send a request like this:
PUT /ovirt-engine/api/datacenters/123
PUT /ovirt-engine/api/datacenters/123With a request body like this:
<data_center> <name>myupdatedname</name> <description>An updated description for the data center</description> </data_center>
<data_center>
<name>myupdatedname</name>
<description>An updated description for the data center</description>
</data_center>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The data center that is being updated. |
6.47. DataCenterNetwork
A service to manage a specific data center network.
| Name | Summary |
|---|---|
|
| Retrieves the data center network details. |
|
| Removes the network. |
|
| Updates the network in the data center. |
6.47.1. get GET
Retrieves the data center network details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The data center network. |
6.47.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.47.2. remove DELETE
Removes the network.
6.47.3. update PUT
Updates the network in the data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The data center network. |
6.48. DataCenterNetworks
A service to manage data center networks.
| Name | Summary |
|---|---|
|
| Create a new network in a data center. |
|
| Lists networks in the data center. |
6.48.1. add POST
Create a new network in a data center.
Post a request like in the example below to create a new network in a data center with an ID of 123.
POST /ovirt-engine/api/datacenters/123/networks
POST /ovirt-engine/api/datacenters/123/networksUse the following example in its body:
<network> <name>mynetwork</name> </network>
<network>
<name>mynetwork</name>
</network>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network object to be created in the data center. |
6.48.2. list GET
Lists networks in the data center.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | The list of networks which are in the data center. |
6.48.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.48.2.2. max
Sets the maximum number of networks to return. If not specified, all the networks are returned.
6.49. DataCenters
A service to manage data centers.
| Name | Summary |
|---|---|
|
| Creates a new data center. |
|
| Lists the data centers. |
6.49.1. add POST
Creates a new data center.
Creation of a new data center requires the name and local elements. For example, to create a data center named mydc that uses shared storage (NFS, iSCSI or Fibre Channel) send a request like this:
POST /ovirt-engine/api/datacenters
POST /ovirt-engine/api/datacentersWith a request body like this:
<data_center> <name>mydc</name> <local>false</local> </data_center>
<data_center>
<name>mydc</name>
<local>false</local>
</data_center>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The data center that is being added. |
For more information, see Data Center Properties and Changing the Data Center Storage Type in the Administration Guide.
6.49.2. list GET
Lists the data centers.
The following request retrieves a representation of the data centers:
GET /ovirt-engine/api/datacenters
GET /ovirt-engine/api/datacenters
The above request performed with curl:
This is what an example response could look like:
Note the id code of your Default data center. This code identifies this data center in relation to other resources of your virtual environment.
The data center also contains a link to the storage domains collection. The data center uses this collection to attach storage domains from the storage domains main collection.
The order of the returned list of data centers is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of data centers to return. | |
|
| In | A query string used to restrict the returned data centers. |
6.49.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.49.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.49.2.3. max
Sets the maximum number of data centers to return. If not specified all the data centers are returned.
6.50. Disk
Manages a single disk.
| Name | Summary |
|---|---|
|
| This operation copies a disk to the specified storage domain. |
|
| Exports a disk to an export storage domain. |
|
| Retrieves the description of the disk. |
|
| Moves a disk to another storage domain. |
|
| Reduces the size of the disk image. |
|
| Refreshes a direct LUN disk with up-to-date information from the storage. |
|
| Removes a disk. |
|
| Sparsify the disk. |
|
| This operation updates the disk with the appropriate parameters. |
6.50.1. copy POST
This operation copies a disk to the specified storage domain.
For example, copy of a disk can be facilitated using the following request:
POST /ovirt-engine/api/disks/123/copy
POST /ovirt-engine/api/disks/123/copyWith a request body like this:
If the disk profile or the quota used currently by the disk aren’t defined for the new storage domain, then they can be explicitly specified. If they aren’t then the first available disk profile and the default quota are used.
For example, to explicitly use disk profile 987 and quota 753 send a request body like this:
<action> <storage_domain id="456"/> <disk_profile id="987"/> <quota id="753"/> </action>
<action>
<storage_domain id="456"/>
<disk_profile id="987"/>
<quota id="753"/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the copy should be performed asynchronously. | |
|
| In | ||
|
| In | Disk profile for the disk in the new storage domain. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Quota for the disk in the new storage domain. | |
|
| In | The storage domain where the new disk will be created. |
6.50.1.1. disk_profile
Disk profile for the disk in the new storage domain.
Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
6.50.1.2. quota
Quota for the disk in the new storage domain.
This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
6.50.1.3. storage_domain
The storage domain where the new disk will be created. Can be specified using the id or name attributes. For example, to copy a disk to the storage domain named mydata send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks/789
POST /ovirt-engine/api/storagedomains/123/disks/789With a request body like this:
<action>
<storage_domain>
<name>mydata</name>
</storage_domain>
</action>
<action>
<storage_domain>
<name>mydata</name>
</storage_domain>
</action>6.50.2. export POST
Exports a disk to an export storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the export should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In |
6.50.3. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the disk should be included in the response. | |
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.50.3.1. all_content
Indicates if all of the attributes of the disk should be included in the response.
By default the following disk attributes are excluded:
-
vms
For example, to retrieve the complete representation of disk '123':
GET /ovirt-engine/api/disks/123?all_content=true
GET /ovirt-engine/api/disks/123?all_content=true6.50.3.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.50.4. move POST
Moves a disk to another storage domain.
For example, to move the disk with identifier 123 to a storage domain with identifier 456 send the following request:
POST /ovirt-engine/api/disks/123/move
POST /ovirt-engine/api/disks/123/moveWith the following request body:
<action> <storage_domain id="456"/> </action>
<action>
<storage_domain id="456"/>
</action>If the disk profile or the quota used currently by the disk aren’t defined for the new storage domain, then they can be explicitly specified. If they aren’t then the first available disk profile and the default quota are used.
For example, to explicitly use disk profile 987 and quota 753 send a request body like this:
<action> <storage_domain id="456"/> <disk_profile id="987"/> <quota id="753"/> </action>
<action>
<storage_domain id="456"/>
<disk_profile id="987"/>
<quota id="753"/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. | |
|
| In | Disk profile for the disk in the new storage domain. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Quota for the disk in the new storage domain. | |
|
| In |
6.50.4.1. disk_profile
Disk profile for the disk in the new storage domain.
Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
6.50.4.2. quota
Quota for the disk in the new storage domain.
This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
6.50.5. reduce POST
Reduces the size of the disk image.
Invokes reduce on the logical volume (i.e. this is only applicable for block storage domains). This is applicable for floating disks and disks attached to non-running virtual machines. There is no need to specify the size as the optimal size is calculated automatically.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.50.6. refreshlun POST
Refreshes a direct LUN disk with up-to-date information from the storage.
Refreshing a direct LUN disk is useful when:
- The LUN was added using the API without the host parameter, and therefore does not contain any information from the storage (see DisksService::add).
- New information about the LUN is available on the storage and you want to update the LUN with it.
To refresh direct LUN disk 123 using host 456, send the following request:
POST /ovirt-engine/api/disks/123/refreshlun
POST /ovirt-engine/api/disks/123/refreshlunWith the following request body:
<action> <host id='456'/> </action>
<action>
<host id='456'/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The host that will be used to refresh the direct LUN disk. |
6.50.7. remove DELETE
Removes a disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.50.8. sparsify POST
Sparsify the disk.
Sparsification frees space in the disk image that is not used by its filesystem. As a result, the image will occupy less space on the storage.
Currently sparsification works only on disks without snapshots. Disks having derived disks are also not allowed.
6.50.9. update PUT
This operation updates the disk with the appropriate parameters. The only field that can be updated is qcow_version.
For example, update disk can be facilitated using the following request:
PUT /ovirt-engine/api/disks/123
PUT /ovirt-engine/api/disks/123With a request body like this:
<disk> <qcow_version>qcow2_v3</qcow_version> </disk>
<disk>
<qcow_version>qcow2_v3</qcow_version>
</disk>Since the backend operation is asynchronous the disk element which will be returned to the user might not be synced with the changed properties.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The update to apply to the disk. |
6.51. DiskAttachment
This service manages the attachment of a disk to a virtual machine.
| Name | Summary |
|---|---|
|
| Returns the details of the attachment, including the bootable flag and link to the disk. |
|
| Removes the disk attachment. |
|
| Update the disk attachment and the disk properties within it. |
6.51.1. get GET
Returns the details of the attachment, including the bootable flag and link to the disk.
An example of getting a disk attachment:
GET /ovirt-engine/api/vms/123/diskattachments/456
GET /ovirt-engine/api/vms/123/diskattachments/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.51.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.51.2. remove DELETE
Removes the disk attachment.
This will only detach the disk from the virtual machine, but won’t remove it from the system, unless the detach_only parameter is false.
An example of removing a disk attachment:
DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the disk should only be detached from the virtual machine, but not removed from the system. |
6.51.2.1. detach_only
Indicates if the disk should only be detached from the virtual machine, but not removed from the system. The default value is true, which won’t remove the disk from the system.
6.51.3. update PUT
Update the disk attachment and the disk properties within it.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.52. DiskAttachments
This service manages the set of disks attached to a virtual machine. Each attached disk is represented by a DiskAttachment, containing the bootable flag, the disk interface and the reference to the disk.
| Name | Summary |
|---|---|
|
| Adds a new disk attachment to the virtual machine. |
|
| List the disk that are attached to the virtual machine. |
6.52.1. add POST
Adds a new disk attachment to the virtual machine. The attachment parameter can contain just a reference, if the disk already exists:
Or it can contain the complete representation of the disk, if the disk doesn’t exist yet:
In this case the disk will be created and then attached to the virtual machine.
In both cases, use the following URL for a virtual machine with an id 345:
POST /ovirt-engine/api/vms/345/diskattachments
POST /ovirt-engine/api/vms/345/diskattachments
The server accepts requests that don’t contain the active attribute, but the effect is undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the active attribute with the desired value.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk attachment to add to the virtual machine. |
6.52.2. list GET
List the disk that are attached to the virtual machine.
The order of the returned list of disks attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A list of disk attachments that are attached to the virtual machine. | |
|
| In | Indicates which inner links should be followed. |
6.52.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.53. DiskProfile
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified disk profile in the system. |
6.53.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.53.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.53.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.53.3. update PUT
Update the specified disk profile in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.54. DiskProfiles
| Name | Summary |
|---|---|
|
| Add a new disk profile to the system. |
|
| Returns the list of disk profiles of the system. |
6.54.1. add POST
Add a new disk profile to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.54.2. list GET
Returns the list of disk profiles of the system.
The order of the returned list of disk profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.54.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.54.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.55. DiskSnapshot
| Name | Summary |
|---|---|
|
| |
|
|
6.55.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.55.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.55.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.56. DiskSnapshots
Manages the collection of disk snapshots available in an storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of disk snapshots of the storage domain. |
6.56.1. list GET
Returns the list of disk snapshots of the storage domain.
The order of the returned list of disk snapshots isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of snapshots to return. | |
|
| Out |
6.56.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.56.1.2. max
Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.
6.57. Disks
Manages the collection of disks available in the system.
| Name | Summary |
|---|---|
|
| Adds a new floating disk. |
|
| Get list of disks. |
6.57.1. add POST
Adds a new floating disk.
There are three types of disks that can be added - disk image, direct LUN and Cinder disk.
Adding a new image disk:
When creating a new floating image Disk, the API requires the storage_domain, provisioned_size and format attributes.
Note that block storage domains (i.e., storage domains with the storage type of iSCSI or FCP) don’t support the combination of the raw format with sparse=true, so sparse=false must be stated explicitly.
To create a new floating image disk with specified provisioned_size, format and name on a storage domain with an id 123, send a request as follows:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
Adding a new direct LUN disk:
When adding a new floating direct LUN via the API, there are two flavors that can be used:
-
With a
hostelement - in this case, the host is used for sanity checks (e.g., that the LUN is visible) and to retrieve basic information about the LUN (e.g., size and serial). -
Without a
hostelement - in this case, the operation is a database-only operation, and the storage is never accessed.
To create a new floating direct LUN disk with a host element with an id 123, specified alias, type and logical_unit with an id 456 (that has the attributes address, port and target), send a request as follows:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
To create a new floating direct LUN disk without using a host, remove the host element.
Adding a new Cinder disk:
To create a new floating Cinder disk, send a request as follows:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
Adding a floating disks in order to upload disk snapshots:
Since version 4.2 of the engine it is possible to upload disks with snapshots. This request should be used to create the base image of the images chain (The consecutive disk snapshots (images), should be created using disk-attachments element when creating a snapshot).
The disk has to be created with the same disk identifier and image identifier of the uploaded image. I.e. the identifiers should be saved as part of the backup process. The image identifier can be also fetched using the qemu-img info command. For example, if the disk image is stored into a file named b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img:
To create a disk with with the disk identifier and image identifier obtained with the qemu-img info command shown above, send a request like this:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk. |
6.57.2. list GET
Get list of disks.
GET /ovirt-engine/api/disks
GET /ovirt-engine/api/disksYou will get a XML response which will look like this one:
The order of the returned list of disks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | List of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. | |
|
| In | A query string used to restrict the returned disks. |
6.57.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.57.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.57.2.3. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.58. Domain
A service to view details of an authentication domain in the system.
| Name | Summary |
|---|---|
|
| Gets the authentication domain information. |
6.58.1. get GET
Gets the authentication domain information.
Usage:
GET /ovirt-engine/api/domains/5678
GET /ovirt-engine/api/domains/5678Will return the domain information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The authentication domain. | |
|
| In | Indicates which inner links should be followed. |
6.58.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.59. DomainGroup
| Name | Summary |
|---|---|
|
|
6.59.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.59.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.60. DomainGroups
| Name | Summary |
|---|---|
|
| Returns the list of groups. |
6.60.1. list GET
Returns the list of groups.
The order of the returned list of groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of groups to return. | |
|
| In | A query string used to restrict the returned groups. |
6.60.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.60.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.60.1.3. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.61. DomainUser
A service to view a domain user in the system.
| Name | Summary |
|---|---|
|
| Gets the domain user information. |
6.61.1. get GET
Gets the domain user information.
Usage:
GET /ovirt-engine/api/domains/5678/users/1234
GET /ovirt-engine/api/domains/5678/users/1234Will return the domain user information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The domain user. |
6.61.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.62. DomainUserGroups
A service that shows a user’s group membership in the AAA extension.
| Name | Summary |
|---|---|
|
| Returns the list of groups that the user is a member of. |
6.62.1. list GET
Returns the list of groups that the user is a member of.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of groups that the user is a member of. |
6.62.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.63. DomainUsers
A service to list all domain users in the system.
| Name | Summary |
|---|---|
|
| List all the users in the domain. |
6.63.1. list GET
List all the users in the domain.
Usage:
GET /ovirt-engine/api/domains/5678/users
GET /ovirt-engine/api/domains/5678/usersWill return the list of users in the domain:
The order of the returned list of users isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of users to return. | |
|
| In | A query string used to restrict the returned users. | |
|
| Out | The list of users in the domain. |
6.63.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.63.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.63.1.3. max
Sets the maximum number of users to return. If not specified all the users are returned.
6.64. Domains
A service to list all authentication domains in the system.
| Name | Summary |
|---|---|
|
| List all the authentication domains in the system. |
6.64.1. list GET
List all the authentication domains in the system.
Usage:
GET /ovirt-engine/api/domains
GET /ovirt-engine/api/domainsWill return the list of domains:
The order of the returned list of domains isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of domains. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of domains to return. |
6.64.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.64.1.2. max
Sets the maximum number of domains to return. If not specified all the domains are returned.
6.65. EngineKatelloErrata
A service to manage Katello errata assigned to the engine. The information is retrieved from Katello.
| Name | Summary |
|---|---|
|
| Retrieves the representation of the Katello errata. |
6.65.1. list GET
Retrieves the representation of the Katello errata.
GET /ovirt-engine/api/katelloerrata
GET /ovirt-engine/api/katelloerrataYou will receive response in XML like this one:
The order of the returned list of erratum isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A representation of Katello errata. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of errata to return. |
6.65.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.65.1.2. max
Sets the maximum number of errata to return. If not specified all the errata are returned.
6.66. Event
A service to manage an event in the system.
| Name | Summary |
|---|---|
|
| Get an event. |
|
| Removes an event from internal audit log. |
6.66.1. get GET
Get an event.
An example of getting an event:
GET /ovirt-engine/api/events/123
GET /ovirt-engine/api/events/123Note that the number of fields changes according to the information that resides on the event. For example, for storage domain related events you will get the storage domain reference, as well as the reference for the data center this storage domain resides in.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.66.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.66.2. remove DELETE
Removes an event from internal audit log.
An event can be removed by sending following request
DELETE /ovirt-engine/api/events/123
DELETE /ovirt-engine/api/events/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.67. Events
A service to manage events in the system.
| Name | Summary |
|---|---|
|
| Adds an external event to the internal audit log. |
|
| Get list of events. |
|
|
6.67.1. add POST
Adds an external event to the internal audit log.
This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this:
Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the vm link:
When using links, like the vm in the previous example, only the id attribute is accepted. The name attribute, if provided, is simply ignored.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.67.2. list GET
Get list of events.
GET /ovirt-engine/api/events
GET /ovirt-engine/api/eventsTo the above request we get following response:
The following events occur:
- id="1" - The API logs in the admin user account.
- id="2" - The API logs out of the admin user account.
The order of the returned list of events is always garanteed. If the sortby clause is included in the search parameter, then the events will be ordered according to that clause. If the sortby clause isn’t included, then the events will be sorted by the numeric value of the id attribute, starting with the highest value. This, combined with the max parameter, simplifies obtaining the most recent event:
GET /ovirt-engine/api/events?max=1
GET /ovirt-engine/api/events?max=1| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates the event index after which events should be returned. | |
|
| In | Sets the maximum number of events to return. | |
|
| In | The events service provides search queries similar to other resource services. |
6.67.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.67.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.67.2.3. from
Indicates the event index after which events should be returned. The indexes of events are strictly increasing, so when this parameter is used only the events with greater indexes will be returned. For example, the following request will return only the events with indexes greater than 123:
GET /ovirt-engine/api/events?from=123
GET /ovirt-engine/api/events?from=123This parameter is optional, and if not specified then the first event returned will be most recently generated.
6.67.2.4. max
Sets the maximum number of events to return. If not specified all the events are returned.
6.67.2.5. search
The events service provides search queries similar to other resource services.
We can search by providing specific severity.
GET /ovirt-engine/api/events?search=severity%3Dnormal
GET /ovirt-engine/api/events?search=severity%3Dnormal
To the above request we get a list of events which severity is equal to normal:
A virtualization environment generates a large amount of events after a period of time. However, the API only displays a default number of events for one search query. To display more than the default, the API separates results into pages with the page command in a search query. The following search query tells the API to paginate results using a page value in combination with the sortby clause:
sortby time asc page 1
sortby time asc page 1Below example paginates event resources. The URL-encoded request is:
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201Increase the page value to view the next page of results.
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%2026.67.3. undelete POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the un-delete should be performed asynchronously. |
6.68. ExternalComputeResource
Manages a single external compute resource.
Compute resource is a term of host external provider. The external provider also needs to know to where the provisioned host needs to register. The login details of the engine are saved as a compute resource in the external provider side.
| Name | Summary |
|---|---|
|
| Retrieves external compute resource details. |
6.68.1. get GET
Retrieves external compute resource details.
For example, to get the details of compute resource 234 of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/computeresources/234
GET /ovirt-engine/api/externalhostproviders/123/computeresources/234It will return a response like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | External compute resource information |
6.68.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.69. ExternalComputeResources
Manages a collection of external compute resources.
Compute resource is a term of host external provider. The external provider also needs to know to where the provisioned host needs to register. The login details of the engine is saved as a compute resource in the external provider side.
| Name | Summary |
|---|---|
|
| Retrieves a list of external compute resources. |
6.69.1. list GET
Retrieves a list of external compute resources.
For example, to retrieve the compute resources of external host provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/computeresources
GET /ovirt-engine/api/externalhostproviders/123/computeresourcesIt will return a response like this:
The order of the returned list of compute resources isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of resources to return. | |
|
| Out | List of external computer resources. |
6.69.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.69.1.2. max
Sets the maximum number of resources to return. If not specified all the resources are returned.
6.70. ExternalDiscoveredHost
This service manages a single discovered host.
| Name | Summary |
|---|---|
|
| Get discovered host info. |
6.70.1. get GET
Get discovered host info.
Retrieves information about an host that is managed in external provider management system, such as Foreman. The information includes hostname, address, subnet, base image and more.
For example, to get the details of host 234 from provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234
GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234The result will be like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Host’s hardware and config information. |
6.70.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.71. ExternalDiscoveredHosts
This service manages external discovered hosts.
| Name | Summary |
|---|---|
|
| Get list of discovered hosts' information. |
6.71.1. list GET
Get list of discovered hosts' information.
Discovered hosts are fetched from third-party providers such as Foreman.
To list all discovered hosts for provider 123 send the following:
GET /ovirt-engine/api/externalhostproviders/123/discoveredhost
GET /ovirt-engine/api/externalhostproviders/123/discoveredhostThe order of the returned list of hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | List of discovered hosts | |
|
| In | Sets the maximum number of hosts to return. |
6.71.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.71.1.2. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.72. ExternalHost
| Name | Summary |
|---|---|
|
|
6.72.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.72.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.73. ExternalHostGroup
This service manages a single host group information.
Host group is a term of host provider - the host group includes provision details that are applied to new discovered host. Information such as subnet, operating system, domain, etc.
| Name | Summary |
|---|---|
|
| Get host group information. |
6.73.1. get GET
Get host group information.
For example, to get the details of hostgroup 234 of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234It will return a response like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Host group information. |
6.73.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.74. ExternalHostGroups
This service manages hostgroups.
| Name | Summary |
|---|---|
|
| Get host groups list from external host provider. |
6.74.1. list GET
Get host groups list from external host provider.
Host group is a term of host providers - the host group includes provision details. This API returns all possible hostgroups exposed by the external provider.
For example, to get the details of all host groups of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/hostgroups
GET /ovirt-engine/api/externalhostproviders/123/hostgroupsThe response will be like this:
The order of the returned list of host groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | List of all hostgroups available for external host provider | |
|
| In | Sets the maximum number of groups to return. |
6.74.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.74.1.2. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.75. ExternalHostProvider
Represents an external host provider, such as Foreman or Satellite.
See https://www.theforeman.org/ for more details on Foreman. See https://access.redhat.com/products/red-hat-satellite for more details on Red Hat Satellite.
| Name | Summary |
|---|---|
|
| Get external host provider information Host provider, Foreman or Satellite, can be set as an external provider in ovirt. |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified external host provider in the system. |
6.75.1. get GET
Get external host provider information
Host provider, Foreman or Satellite, can be set as an external provider in ovirt. To see details about specific host providers attached to ovirt use this API.
For example, to get the details of host provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123
GET /ovirt-engine/api/externalhostproviders/123The response will be like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.75.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.75.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.75.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.75.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.75.5. update PUT
Update the specified external host provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.76. ExternalHostProviders
| Name | Summary |
|---|---|
|
| Adds a new external host provider to the system. |
|
| Returns the list of external host providers. |
6.76.1. add POST
Adds a new external host provider to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.76.2. list GET
Returns the list of external host providers.
The order of the returned list of host providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned external host providers. |
6.76.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.76.2.2. max
Sets the maximum number of providers to return. If not specified, all the providers are returned.
6.77. ExternalHosts
| Name | Summary |
|---|---|
|
| Return the list of external hosts. |
6.77.1. list GET
Return the list of external hosts.
The order of the returned list of hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hosts to return. |
6.77.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.77.1.2. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.78. ExternalNetworkProviderConfiguration
Describes how an external network provider is provisioned by the system on the host.
| Name | Summary |
|---|---|
|
| Returns the information about an external network provider on the host. |
6.78.1. get GET
Returns the information about an external network provider on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.78.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.79. ExternalNetworkProviderConfigurations
A service to list all external network providers provisioned by the system on the host.
| Name | Summary |
|---|---|
|
| Returns the list of all external network providers on the host. |
6.79.1. list GET
Returns the list of all external network providers on the host.
The order of the returned list of networks is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.79.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.80. ExternalProvider
Provides capability to manage external providers.
| Name | Summary |
|---|---|
|
| Import the SSL certificates of the external host provider. |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
6.80.1. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.80.2. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.81. ExternalProviderCertificate
A service to view specific certificate for external provider.
| Name | Summary |
|---|---|
|
| Get specific certificate. |
6.81.1. get GET
Get specific certificate.
GET /ovirt-engine/api/externalhostproviders/123/certificate/0
GET /ovirt-engine/api/externalhostproviders/123/certificate/0And here is sample response:
<certificate id="0"> <organization>provider.example.com</organization> <subject>CN=provider.example.com</subject> <content>...</content> </certificate>
<certificate id="0">
<organization>provider.example.com</organization>
<subject>CN=provider.example.com</subject>
<content>...</content>
</certificate>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The details of the certificate. | |
|
| In | Indicates which inner links should be followed. |
6.81.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.82. ExternalProviderCertificates
A service to view certificates for external provider.
| Name | Summary |
|---|---|
|
| Returns the chain of certificates presented by the external provider. |
6.82.1. list GET
Returns the chain of certificates presented by the external provider.
GET /ovirt-engine/api/externalhostproviders/123/certificates
GET /ovirt-engine/api/externalhostproviders/123/certificatesAnd here is sample response:
<certificates> <certificate id="789">...</certificate> ... </certificates>
<certificates>
<certificate id="789">...</certificate>
...
</certificates>The order of the returned certificates is always guaranteed to be the sign order: the first is the certificate of the server itself, the second the certificate of the CA that signs the first, so on.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List containing certificate details. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of certificates to return. |
6.82.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.82.1.2. max
Sets the maximum number of certificates to return. If not specified all the certificates are returned.
6.83. ExternalVmImports
Provides capability to import external virtual machines.
| Name | Summary |
|---|---|
|
| This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware. |
6.83.1. add POST
This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware.
For example import of a virtual machine from VMware can be facilitated using the following request:
POST /externalvmimports
POST /externalvmimportsWith request body of type ExternalVmImport, for example:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.84. FenceAgent
A service to manage fence agent for a specific host.
| Name | Summary |
|---|---|
|
| Gets details of this fence agent. |
|
| Removes a fence agent for a specific host. |
|
| Update a fencing-agent. |
6.84.1. get GET
Gets details of this fence agent.
GET /ovirt-engine/api/hosts/123/fenceagents/0
GET /ovirt-engine/api/hosts/123/fenceagents/0And here is sample response:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Fence agent details. | |
|
| In | Indicates which inner links should be followed. |
6.84.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.84.2. remove DELETE
Removes a fence agent for a specific host.
DELETE /ovirt-engine/api/hosts/123/fenceagents/0
DELETE /ovirt-engine/api/hosts/123/fenceagents/0| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.84.3. update PUT
Update a fencing-agent.
6.85. FenceAgents
A service to manage fence agents for a specific host.
| Name | Summary |
|---|---|
|
| Add a new fencing-agent to the host. |
|
| Returns the list of fencing agents configured for the host. |
6.85.1. add POST
Add a new fencing-agent to the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.85.2. list GET
Returns the list of fencing agents configured for the host.
GET /ovirt-engine/api/hosts/123/fenceagents
GET /ovirt-engine/api/hosts/123/fenceagentsAnd here is sample response:
The order of the returned list of fencing agents isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List of fence agent details. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of agents to return. |
6.85.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.85.2.2. max
Sets the maximum number of agents to return. If not specified all the agents are returned.
6.86. File
| Name | Summary |
|---|---|
|
|
6.86.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.86.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.87. Files
Provides a way for clients to list available files.
This service is specifically targeted to ISO storage domains, which contain ISO images and virtual floppy disks (VFDs) that an administrator uploads.
The addition of a CD-ROM device to a virtual machine requires an ISO image from the files of an ISO storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of ISO images and virtual floppy disks available in the storage domain. |
6.87.1. list GET
Returns the list of ISO images and virtual floppy disks available in the storage domain. The order of the returned list is not guaranteed.
If the refresh parameter is false, the returned list may not reflect recent changes to the storage domain; for example, it may not contain a new ISO file that was recently added. This is because the server caches the list of files to improve performance. To get the very latest results, set the refresh parameter to true.
The default value of the refresh parameter is true, but it can be changed using the configuration value ForceRefreshDomainFilesByDefault:
engine-config -s ForceRefreshDomainFilesByDefault=false
# engine-config -s ForceRefreshDomainFilesByDefault=false
Setting the value of the refresh parameter to true has an impact on the performance of the server. Use it only if necessary.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of files to return. | |
|
| In | Indicates whether the list of files should be refreshed from the storage domain, rather than showing cached results that are updated at certain intervals. | |
|
| In | A query string used to restrict the returned files. |
6.87.1.1. case_sensitive
Indicates if the search performed using the search parameter should take case into account. The default value is true.
6.87.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.87.1.3. max
Sets the maximum number of files to return. If not specified, all the files are returned.
6.88. Filter
| Name | Summary |
|---|---|
|
| |
|
|
6.88.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.88.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.88.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.89. Filters
Manages the filters used by an scheduling policy.
| Name | Summary |
|---|---|
|
| Add a filter to a specified user defined scheduling policy. |
|
| Returns the list of filters used by the scheduling policy. |
6.89.1. add POST
Add a filter to a specified user defined scheduling policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.89.2. list GET
Returns the list of filters used by the scheduling policy.
The order of the returned list of filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of filters to return. |
6.89.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.89.2.2. max
Sets the maximum number of filters to return. If not specified all the filters are returned.
6.90. Follow
6.91. GlusterBrick
This service manages a single gluster brick.
| Name | Summary |
|---|---|
|
| Get details of a brick. |
|
| Removes a brick. |
|
| Replaces this brick with a new one. |
6.91.1. get GET
Get details of a brick.
Retrieves status details of brick from underlying gluster volume with header All-Content set to true. This is the equivalent of running gluster volume status <volumename> <brickname> detail.
For example, to get the details of brick 234 of gluster volume 123, send a request like this:
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234Which will return a response body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.91.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.91.2. remove DELETE
Removes a brick.
Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when removing a single brick without data migration. To remove multiple bricks and with data migration, use migrate instead.
For example, to delete brick 234 from gluster volume 123, send a request like this:
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.91.3. replace POST
Replaces this brick with a new one.
This operation has been deprecated since version 3.5 of the engine and will be removed in the future. Use add brick(s) and migrate brick(s) instead.
6.92. GlusterBricks
This service manages the gluster bricks in a gluster volume
| Name | Summary |
|---|---|
|
| Activate the bricks post data migration of remove brick operation. |
|
| Adds a list of bricks to gluster volume. |
|
| Lists the bricks of a gluster volume. |
|
| Start migration of data prior to removing bricks. |
|
| Removes bricks from gluster volume. |
|
| Stops migration of data from bricks for a remove brick operation. |
6.92.1. activate POST
Activate the bricks post data migration of remove brick operation.
Used to activate brick(s) once the data migration from bricks is complete but user no longer wishes to remove bricks. The bricks that were previously marked for removal will now be used as normal bricks.
For example, to retain the bricks that on glustervolume 123 from which data was migrated, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activateWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. | |
|
| In | The list of bricks that need to be re-activated. |
6.92.2. add POST
Adds a list of bricks to gluster volume.
Used to expand a gluster volume by adding bricks. For replicated volume types, the parameter replica_count needs to be passed. In case the replica count is being increased, then the number of bricks needs to be equivalent to the number of replica sets.
For example, to add bricks to gluster volume 123, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The list of bricks to be added to the volume | |
|
| In | Replica count of volume post add operation. | |
|
| In | Stripe count of volume post add operation. |
6.92.3. list GET
Lists the bricks of a gluster volume.
For example, to list bricks of gluster volume 123, send a request like this:
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksProvides an output as below:
The order of the returned list is based on the brick order provided at gluster volume creation.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bricks to return. |
6.92.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.92.3.2. max
Sets the maximum number of bricks to return. If not specified all the bricks are returned.
6.92.4. migrate POST
Start migration of data prior to removing bricks.
Removing bricks is a two-step process, where the data on bricks to be removed, is first migrated to remaining bricks. Once migration is completed the removal of bricks is confirmed via the API remove. If at any point, the action needs to be cancelled stopmigrate has to be called.
For instance, to delete a brick from a gluster volume with id 123, send a request:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrateWith a request body like this:
The migration process can be tracked from the job id returned from the API using job and steps in job using step
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the migration should be performed asynchronously. | |
|
| In | List of bricks for which data migration needs to be started. |
6.92.5. remove DELETE
Removes bricks from gluster volume.
The recommended way to remove bricks without data loss is to first migrate the data using stopmigrate and then removing them. If migrate was not called on bricks prior to remove, the bricks are removed without data migration which may lead to data loss.
For example, to delete the bricks from gluster volume 123, send a request like this:
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksWith a request body like this:
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | The list of bricks to be removed | |
|
| In | Replica count of volume post add operation. |
6.92.6. stopmigrate POST
Stops migration of data from bricks for a remove brick operation.
To cancel data migration that was started as part of the 2-step remove brick process in case the user wishes to continue using the bricks. The bricks that were marked for removal will function as normal bricks post this operation.
For example, to stop migration of data from the bricks of gluster volume 123, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrateWith a request body like this:
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | List of bricks for which data migration needs to be stopped. |
6.92.6.1. bricks
List of bricks for which data migration needs to be stopped. This list should match the arguments passed to migrate.
6.93. GlusterHook
| Name | Summary |
|---|---|
|
| Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. |
|
| Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. |
|
| |
|
| Removes the this Gluster hook from all servers in cluster and deletes it from the database. |
|
| Resolves missing hook conflict depending on the resolution type. |
6.93.1. disable POST
Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. This updates the hook status to DISABLED in database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.93.2. enable POST
Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. This updates the hook status to DISABLED in database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.93.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.93.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.93.4. remove DELETE
Removes the this Gluster hook from all servers in cluster and deletes it from the database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.93.5. resolve POST
Resolves missing hook conflict depending on the resolution type.
For ADD resolves by copying hook stored in engine database to all servers where the hook is missing. The engine maintains a list of all servers where hook is missing.
For COPY resolves conflict in hook content by copying hook stored in engine database to all servers where the hook is missing. The engine maintains a list of all servers where the content is conflicting. If a host id is passed as parameter, the hook content from the server is used as the master to copy to other servers in cluster.
6.94. GlusterHooks
| Name | Summary |
|---|---|
|
| Returns the list of hooks. |
6.94.1. list GET
Returns the list of hooks.
The order of the returned list of hooks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hooks to return. |
6.94.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.94.1.2. max
Sets the maximum number of hooks to return. If not specified all the hooks are returned.
6.95. GlusterVolume
This service manages a single gluster volume.
| Name | Summary |
|---|---|
|
| Get the gluster volume details. |
|
| Get gluster volume profile statistics. |
|
| Rebalance the gluster volume. |
|
| Removes the gluster volume. |
|
| Resets all the options set in the gluster volume. |
|
| Resets a particular option in the gluster volume. |
|
| Sets a particular option in the gluster volume. |
|
| Starts the gluster volume. |
|
| Start profiling the gluster volume. |
|
| Stops the gluster volume. |
|
| Stop profiling the gluster volume. |
|
| Stop rebalancing the gluster volume. |
6.95.1. get GET
Get the gluster volume details.
For example, to get details of a gluster volume with identifier 123 in cluster 456, send a request like this:
GET /ovirt-engine/api/clusters/456/glustervolumes/123
GET /ovirt-engine/api/clusters/456/glustervolumes/123This GET request will return the following output:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Representation of the gluster volume. |
6.95.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.95.2. getprofilestatistics POST
Get gluster volume profile statistics.
For example, to get profile statistics for a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Gluster volume profiling information returned from the action. |
6.95.3. rebalance POST
Rebalance the gluster volume.
Rebalancing a gluster volume helps to distribute the data evenly across all the bricks. After expanding or shrinking a gluster volume (without migrating data), we need to rebalance the data among the bricks. In a non-replicated volume, all bricks should be online to perform the rebalance operation. In a replicated volume, at least one of the bricks in the replica should be online.
For example, to rebalance a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the rebalance should be performed asynchronously. | |
|
| In | If set to true, rebalance will only fix the layout so that new data added to the volume is distributed across all the hosts. | |
|
| In | Indicates if the rebalance should be force started. |
6.95.3.1. fix_layout
If set to true, rebalance will only fix the layout so that new data added to the volume is distributed across all the hosts. But it will not migrate/rebalance the existing data. Default is false.
6.95.3.2. force
Indicates if the rebalance should be force started. The rebalance command can be executed with the force option even when the older clients are connected to the cluster. However, this could lead to a data loss situation. Default is false.
6.95.4. remove DELETE
Removes the gluster volume.
For example, to remove a volume with identifier 123 in cluster 456, send a request like this:
DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
DELETE /ovirt-engine/api/clusters/456/glustervolumes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.95.5. resetalloptions POST
Resets all the options set in the gluster volume.
For example, to reset all options in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reset should be performed asynchronously. |
6.95.6. resetoption POST
Resets a particular option in the gluster volume.
For example, to reset a particular option option1 in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoptionWith the following request body:
<action> <option name="option1"/> </action>
<action>
<option name="option1"/>
</action>6.95.7. setoption POST
Sets a particular option in the gluster volume.
For example, to set option1 with value value1 in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption
POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoptionWith the following request body:
<action> <option name="option1" value="value1"/> </action>
<action>
<option name="option1" value="value1"/>
</action>6.95.8. start POST
Starts the gluster volume.
A Gluster Volume should be started to read/write data. For example, to start a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
POST /ovirt-engine/api/clusters/456/glustervolumes/123/start| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the volume should be force started. |
6.95.8.1. force
Indicates if the volume should be force started. If a gluster volume is started already but few/all bricks are down then force start can be used to bring all the bricks up. Default is false.
6.95.9. startprofile POST
Start profiling the gluster volume.
For example, to start profiling a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.95.10. stop POST
Stops the gluster volume.
Stopping a volume will make its data inaccessible.
For example, to stop a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop6.95.11. stopprofile POST
Stop profiling the gluster volume.
For example, to stop profiling a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.95.12. stoprebalance POST
Stop rebalancing the gluster volume.
For example, to stop rebalancing a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.96. GlusterVolumes
This service manages a collection of gluster volumes available in a cluster.
| Name | Summary |
|---|---|
|
| Creates a new gluster volume. |
|
| Lists all gluster volumes in the cluster. |
6.96.1. add POST
Creates a new gluster volume.
The volume is created based on properties of the volume parameter. The properties name, volume_type and bricks are required.
For example, to add a volume with name myvolume to the cluster 123, send the following request:
POST /ovirt-engine/api/clusters/123/glustervolumes
POST /ovirt-engine/api/clusters/123/glustervolumesWith the following request body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The gluster volume definition from which to create the volume is passed as input and the newly created volume is returned. |
6.96.2. list GET
Lists all gluster volumes in the cluster.
For example, to list all Gluster Volumes in cluster 456, send a request like this:
GET /ovirt-engine/api/clusters/456/glustervolumes
GET /ovirt-engine/api/clusters/456/glustervolumesThe order of the returned list of volumes isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of volumes to return. | |
|
| In | A query string used to restrict the returned volumes. | |
|
| Out |
6.96.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.96.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.96.2.3. max
Sets the maximum number of volumes to return. If not specified all the volumes are returned.
6.97. Group
Manages a group of users. Use this service to either get groups details or remove groups. In order to add new groups please use service that manages the collection of groups.
| Name | Summary |
|---|---|
|
| Gets the system group information. |
|
| Removes the system group. |
6.97.1. get GET
Gets the system group information.
Usage:
GET /ovirt-engine/api/groups/123
GET /ovirt-engine/api/groups/123Will return the group information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The system group. |
6.97.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.97.2. remove DELETE
Removes the system group.
Usage:
DELETE /ovirt-engine/api/groups/123
DELETE /ovirt-engine/api/groups/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.98. Groups
Manages the collection of groups of users.
| Name | Summary |
|---|---|
|
| Add group from a directory service. |
|
| List all the groups in the system. |
6.98.1. add POST
Add group from a directory service. Please note that domain name is name of the authorization provider.
For example, to add the Developers group from the internal-authz authorization provider send a request like this:
POST /ovirt-engine/api/groups
POST /ovirt-engine/api/groupsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The group to be added. |
6.98.2. list GET
List all the groups in the system.
Usage:
GET /ovirt-engine/api/groups
GET /ovirt-engine/api/groupsWill return the list of groups:
The order of the returned list of groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of groups. | |
|
| In | Sets the maximum number of groups to return. | |
|
| In | A query string used to restrict the returned groups. |
6.98.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.98.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.98.2.3. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.99. Host
A service to manage a host.
| Name | Summary |
|---|---|
|
| Activates the host for use, for example to run virtual machines. |
|
| Approve a pre-installed Hypervisor host for usage in the virtualization environment. |
|
| Marks the network configuration as good and persists it inside the host. |
|
| Deactivates the host to perform maintenance tasks. |
|
| Enrolls the certificate of the host. |
|
| Controls the host’s power management device. |
|
| To manually set a host as the storage pool manager (SPM). |
|
| Gets the host details. |
|
| Installs the latest version of VDSM and related software on the host. |
|
| Discovers iSCSI targets on the host, using the initiator details. |
|
| Login to iSCSI targets on the host, using the target details. |
|
| Refresh the host devices and capabilities. |
|
| Remove the host from the system. |
|
| This method is used to change the configuration of the network interfaces of a host. |
|
| To synchronize all networks on the host, send a request like this: [source] ---- POST /ovirt-engine/api/hosts/123/syncallnetworks ---- With a request body like this: [source,xml] ---- <action/> ---- |
|
| Discovers the block Storage Domains which are candidates to be imported to the setup. |
|
| Update the host properties. |
|
| Upgrades VDSM and selected software on the host. |
|
| Check if there are upgrades available for the host. |
6.99.1. activate POST
Activates the host for use, for example to run virtual machines.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.99.2. approve POST
Approve a pre-installed Hypervisor host for usage in the virtualization environment.
This action also accepts an optional cluster element to define the target cluster for this host.
6.99.3. commitnetconfig POST
Marks the network configuration as good and persists it inside the host.
An API user commits the network configuration to persist a host network interface attachment or detachment, or persist the creation and deletion of a bonded interface.
Networking configuration is only committed after the engine has established that host connectivity is not lost as a result of the configuration changes. If host connectivity is lost, the host requires a reboot and automatically reverts to the previous networking configuration.
For example, to commit the network configuration of host with id 123 send a request like this:
POST /ovirt-engine/api/hosts/123/commitnetconfig
POST /ovirt-engine/api/hosts/123/commitnetconfigWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.99.4. deactivate POST
Deactivates the host to perform maintenance tasks.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. | |
|
| In | ||
|
| In | Indicates if the gluster service should be stopped as part of deactivating the host. |
6.99.4.1. stop_gluster_service
Indicates if the gluster service should be stopped as part of deactivating the host. It can be used while performing maintenance operations on the gluster host. Default value for this variable is false.
6.99.5. enrollcertificate POST
Enrolls the certificate of the host. Useful in case you get a warning that it is about to expire or has already expired.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the enrollment should be performed asynchronously. |
6.99.6. fence POST
Controls the host’s power management device.
For example, to start the host. This can be done via:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the fencing should be performed asynchronously. | |
|
| In | ||
|
| Out |
6.99.7. forceselectspm POST
To manually set a host as the storage pool manager (SPM).
POST /ovirt-engine/api/hosts/123/forceselectspm
POST /ovirt-engine/api/hosts/123/forceselectspmWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.99.8. get GET
Gets the host details.
GET /ovirt-engine/api/hosts/123
GET /ovirt-engine/api/hosts/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the host should be included in the response. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The queried host. |
6.99.8.1. all_content
Indicates if all of the attributes of the host should be included in the response.
By default the following attributes are excluded:
-
hosted_engine
For example, to retrieve the complete representation of host '123':
GET /ovirt-engine/api/hosts/123?all_content=true
GET /ovirt-engine/api/hosts/123?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.99.8.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.99.9. install POST
Installs the latest version of VDSM and related software on the host.
The action also performs every configuration steps on the host which is done during adding host to the engine: kdump configuration, hosted-engine deploy, kernel options changes, etc.
The host type defines additional parameters for the action.
Example of installing a host, using curl and JSON, plain:
Example of installing a host, using curl and JSON, with hosted engine components:
Since version 4.1.2 of the engine when a host is reinstalled we override the host firewall definitions by default.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the installation should be performed asynchronously. | |
|
| In |
When set to | |
|
| In |
The | |
|
| In | When installing Red Hat Virtualization Host, an ISO image file is required. | |
|
| In |
The password of of the | |
|
| In | The SSH details used to connect to the host. | |
|
| In |
When set to |
6.99.9.1. deploy_hosted_engine
When set to true it means this host should also deploy the self-hosted engine components. A missing value is treated as true i.e deploy. Omitting this parameter means false and will perform no operation in the self-hosted engine area.
6.99.9.2. undeploy_hosted_engine
When set to true it means this host should un-deploy the self-hosted engine components and this host will not function as part of the High Availability cluster. A missing value is treated as true i.e un-deploy Omitting this parameter means false and will perform no operation in the self-hosted engine area.
6.99.10. iscsidiscover POST
Discovers iSCSI targets on the host, using the initiator details.
For example, to discover iSCSI targets available in myiscsi.example.com, from host 123, send a request like this:
POST /ovirt-engine/api/hosts/123/iscsidiscover
POST /ovirt-engine/api/hosts/123/iscsidiscoverWith a request body like this:
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>The result will be like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the discovery should be performed asynchronously. | |
|
| Out | The discovered targets including all connection information. | |
|
| In | The target iSCSI device. | |
|
| Out | The iSCSI targets. |
6.99.10.1. iscsi_targets
The iSCSI targets.
Since version 4.2 of the engine, this parameter is deprecated, use discovered_targets instead.
6.99.11. iscsilogin POST
Login to iSCSI targets on the host, using the target details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the login should be performed asynchronously. | |
|
| In | The target iSCSI device. |
6.99.12. refresh POST
Refresh the host devices and capabilities.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the refresh should be performed asynchronously. |
6.99.13. remove DELETE
Remove the host from the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.99.14. setupnetworks POST
This method is used to change the configuration of the network interfaces of a host.
For example, if you have a host with three network interfaces eth0, eth1 and eth2 and you want to configure a new bond using eth0 and eth1, and put a VLAN on top of it. Using a simple shell script and the curl command line HTTP client that can be done as follows:
This is valid for version 4 of the API. In previous versions some elements were represented as XML attributes instead of XML elements. In particular the options and ip elements were represented as follows:
<options name="mode" value="4"/> <options name="miimon" value="100"/> <ip address="192.168.122.10" netmask="255.255.255.0"/>
<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>Using the Python SDK the same can be done with the following code:
To make sure that the network configuration has been saved in the host, and that it will be applied when the host is rebooted, remember to call commitnetconfig.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | A list of network attachments that will be synchronized. |
6.99.15. syncallnetworks POST
To synchronize all networks on the host, send a request like this:
POST /ovirt-engine/api/hosts/123/syncallnetworks
POST /ovirt-engine/api/hosts/123/syncallnetworksWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.99.16. unregisteredstoragedomainsdiscover POST
Discovers the block Storage Domains which are candidates to be imported to the setup. For FCP no arguments are required.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the discovery should be performed asynchronously. | |
|
| In | ||
|
| Out |
6.99.17. update PUT
Update the host properties.
For example, to update a the kernel command line of a host send a request like this:
PUT /ovirt-engine/api/hosts/123
PUT /ovirt-engine/api/hosts/123With request body like this:
<host>
<os>
<custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
</os>
</host>
<host>
<os>
<custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
</os>
</host>6.99.18. upgrade POST
Upgrades VDSM and selected software on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the upgrade should be performed asynchronously. | |
|
| In | The image parameter specifies path to image, which is used for upgrade. | |
|
| In | Indicates if the host should be rebooted after upgrade. |
6.99.18.1. image
The image parameter specifies path to image, which is used for upgrade. This parameter is used only to upgrade Vintage Node hosts and it is not relevant for other hosts types.
6.99.18.2. reboot
Indicates if the host should be rebooted after upgrade. By default the host is rebooted.
This parameter is ignored for Red Hat Virtualization Host, which is always rebooted after upgrade.
6.99.19. upgradecheck POST
Check if there are upgrades available for the host. If there are upgrades available an icon will be displayed next to host status icon in the Administration Portal. Audit log messages are also added to indicate the availability of upgrades. The upgrade can be started from the webadmin or by using the upgrade host action.
6.100. HostDevice
A service to access a particular device of a host.
| Name | Summary |
|---|---|
|
| Retrieve information about a particular host’s device. |
6.100.1. get GET
Retrieve information about a particular host’s device.
An example of getting a host device:
GET /ovirt-engine/api/hosts/123/devices/456
GET /ovirt-engine/api/hosts/123/devices/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.100.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.101. HostDevices
A service to access host devices.
| Name | Summary |
|---|---|
|
| List the devices of a host. |
6.101.1. list GET
List the devices of a host.
The order of the returned list of devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of devices to return. |
6.101.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.101.1.2. max
Sets the maximum number of devices to return. If not specified all the devices are returned.
6.102. HostHook
| Name | Summary |
|---|---|
|
|
6.102.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.102.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.103. HostHooks
| Name | Summary |
|---|---|
|
| Returns the list of hooks configured for the host. |
6.103.1. list GET
Returns the list of hooks configured for the host.
The order of the returned list of hooks isn’t guranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hooks to return. |
6.103.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.103.1.2. max
Sets the maximum number of hooks to return. If not specified all the hooks are returned.
6.104. HostNic
A service to manage a network interface of a host.
| Name | Summary |
|---|---|
|
| |
|
| The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC. |
6.104.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.104.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.104.2. updatevirtualfunctionsconfiguration POST
The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC. The input should be consisted of at least one of the following properties:
-
allNetworksAllowed -
numberOfVirtualFunctions
Please see the HostNicVirtualFunctionsConfiguration type for the meaning of the properties.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In |
6.105. HostNics
A service to manage the network interfaces of a host.
| Name | Summary |
|---|---|
|
| Returns the list of network interfaces of the host. |
6.105.1. list GET
Returns the list of network interfaces of the host.
The order of the returned list of network interfaces isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Out |
6.105.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.105.1.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.106. HostNumaNode
| Name | Summary |
|---|---|
|
|
6.106.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.106.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.107. HostNumaNodes
| Name | Summary |
|---|---|
|
| Returns the list of NUMA nodes of the host. |
6.107.1. list GET
Returns the list of NUMA nodes of the host.
The order of the returned list of NUMA nodes isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of nodes to return. | |
|
| Out |
6.107.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.107.1.2. max
Sets the maximum number of nodes to return. If not specified all the nodes are returned.
6.108. HostStorage
A service to manage host storages.
| Name | Summary |
|---|---|
|
| Get list of storages. |
6.108.1. list GET
Get list of storages.
GET /ovirt-engine/api/hosts/123/storage
GET /ovirt-engine/api/hosts/123/storageThe XML response you get will be like this one:
The order of the returned list of storages isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates if the status of the LUNs in the storage should be checked. | |
|
| Out | Retrieved list of storages. |
6.108.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.108.1.2. report_status
Indicates if the status of the LUNs in the storage should be checked. Checking the status of the LUN is an heavy weight operation and this data is not always needed by the user. This parameter will give the option to not perform the status check of the LUNs.
The default is true for backward compatibility.
Here an example with the LUN status :
Here an example without the LUN status :
6.109. Hosts
A service that manages hosts.
| Name | Summary |
|---|---|
|
| Creates a new host. |
|
| Get a list of all available hosts. |
6.109.1. add POST
Creates a new host.
The host is created based on the attributes of the host parameter. The name, address and root_password properties are required.
For example, to add a host send the following request:
POST /ovirt-engine/api/hosts
POST /ovirt-engine/api/hostsWith the following request body:
<host> <name>myhost</name> <address>myhost.example.com</address> <root_password>myrootpassword</root_password> </host>
<host>
<name>myhost</name>
<address>myhost.example.com</address>
<root_password>myrootpassword</root_password>
</host>
The root_password element is only included in the client-provided initial representation and is not exposed in the representations returned from subsequent requests.
Since version 4.1.2 of the engine when a host is newly added we override the host firewall definitions by default.
To add a hosted engine host, use the optional deploy_hosted_engine parameter:
POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
POST /ovirt-engine/api/hosts?deploy_hosted_engine=trueIf the cluster has a default external network provider which is supported for automatic deployment, the external network provider is deployed when adding the host. Only external network providers for OVN are supported for the automatic deployment. To deploy an external network provider that differs to what is defined in the clusters, overwrite the external network provider when adding hosts by sending a request like this:
POST /ovirt-engine/api/hosts
POST /ovirt-engine/api/hosts
With a request body that contains a reference to the desired provider in the external_network_provider_configuration:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
When set to | |
|
| In/Out | The host definition from which to create the new host is passed as parameter, and the newly created host is returned. | |
|
| In |
When set to |
6.109.1.1. deploy_hosted_engine
When set to true it means this host should deploy also hosted engine components. Missing value is treated as true i.e deploy. Omitting this parameter means false and will perform no operation in hosted engine area.
6.109.1.2. undeploy_hosted_engine
When set to true it means this host should un-deploy hosted engine components and this host will not function as part of the High Availability cluster. Missing value is treated as true i.e un-deploy. Omitting this parameter means false and will perform no operation in hosted engine area.
6.109.2. list GET
Get a list of all available hosts.
For example, to list the hosts send the following request:
GET /ovirt-engine/api/hosts
GET /ovirt-engine/api/hostsThe response body will be something like this:
The order of the returned list of hosts is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the hosts should be included in the response. | |
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hosts to return. | |
|
| In | A query string used to restrict the returned hosts. |
6.109.2.1. all_content
Indicates if all of the attributes of the hosts should be included in the response.
By default the following host attributes are excluded:
-
hosted_engine
For example, to retrieve the complete representation of the hosts:
GET /ovirt-engine/api/hosts?all_content=true
GET /ovirt-engine/api/hosts?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.109.2.2. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.109.2.3. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.109.2.4. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.110. Icon
A service to manage an icon (read-only).
| Name | Summary |
|---|---|
|
| Get an icon. |
6.110.1. get GET
Get an icon.
GET /ovirt-engine/api/icons/123
GET /ovirt-engine/api/icons/123You will get a XML response like this one:
<icon id="123"> <data>Some binary data here</data> <media_type>image/png</media_type> </icon>
<icon id="123">
<data>Some binary data here</data>
<media_type>image/png</media_type>
</icon>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved icon. |
6.110.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.111. Icons
A service to manage icons.
| Name | Summary |
|---|---|
|
| Get a list of icons. |
6.111.1. list GET
Get a list of icons.
GET /ovirt-engine/api/icons
GET /ovirt-engine/api/iconsYou will get a XML response which is similar to this one:
The order of the returned list of icons isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved list of icons. | |
|
| In | Sets the maximum number of icons to return. |
6.111.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.111.1.2. max
Sets the maximum number of icons to return. If not specified all the icons are returned.
6.112. Image
| Name | Summary |
|---|---|
|
| |
|
| Imports an image. |
6.112.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.112.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.112.2. import POST
Imports an image.
If the import_as_template parameter is true then the image will be imported as a template, otherwise it will be imported as a disk.
When imported as a template, the name of the template can be specified by the optional template.name parameter. If that parameter is not specified, then the name of the template will be automatically assigned by the engine as GlanceTemplate-x (where x will be seven random hexadecimal characters).
When imported as a disk, the name of the disk can be specified by the optional disk.name parameter. If that parameter is not specified, then the name of the disk will be automatically assigned by the engine as GlanceDisk-x (where x will be the seven hexadecimal characters of the image identifier).
It is recommended to always explicitly specify the template or disk name, to avoid these automatic names generated by the engine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In |
The cluster to which the image should be imported if the | |
|
| In | The disk to import. | |
|
| In | Specifies if a template should be created from the imported disk. | |
|
| In | The storage domain to which the disk should be imported. | |
|
| In |
The name of the template being created if the |
6.113. ImageTransfer
This service provides a mechanism to control an image transfer. The client will have to create a transfer by using add of the Section 6.114, “ImageTransfers” service, stating the image to transfer data to/from.
After doing that, the transfer is managed by this service.
Using oVirt’s Python’s SDK:
Uploading a disk with id 123 (on a random host in the data center):
Uploading a disk with id 123 on host id 456:
If the user wishes to download a disk rather than upload, he/she should specify download as the direction attribute of the transfer. This will grant a read permission from the image, instead of a write permission.
E.g:
Transfers have phases, which govern the flow of the upload/download. A client implementing such a flow should poll/check the transfer’s phase and act accordingly. All the possible phases can be found in ImageTransferPhase.
After adding a new transfer, its phase will be initializing. The client will have to poll on the transfer’s phase until it changes. When the phase becomes transferring, the session is ready to start the transfer.
For example:
transfer_service = transfers_service.image_transfer_service(transfer.id) while transfer.phase == types.ImageTransferPhase.INITIALIZING: time.sleep(3) transfer = transfer_service.get()
transfer_service = transfers_service.image_transfer_service(transfer.id)
while transfer.phase == types.ImageTransferPhase.INITIALIZING:
time.sleep(3)
transfer = transfer_service.get()At that stage, if the transfer’s phase is paused_system, then the session was not successfully established. One possible reason for that is that the ovirt-imageio-daemon is not running in the host that was selected for transfer. The transfer can be resumed by calling resume of the service that manages it.
If the session was successfully established - the returned transfer entity will contain the proxy_url and signed_ticket attributes, which the client needs to use in order to transfer the required data. The client can choose whatever technique and tool for sending the HTTPS request with the image’s data.
-
proxy_urlis the address of a proxy server to the image, to do I/O to. -
signed_ticketis the content that needs to be added to theAuthenticationheader in the HTTPS request, in order to perform a trusted communication.
For example, Python’s HTTPSConnection can be used in order to perform a transfer, so an transfer_headers dict is set for the upcoming transfer:
transfer_headers = {
'Authorization' : transfer.signed_ticket,
}
transfer_headers = {
'Authorization' : transfer.signed_ticket,
}
Using Python’s HTTPSConnection, a new connection is established:
For upload, the specific content range being sent must be noted in the Content-Range HTTPS header. This can be used in order to split the transfer into several requests for a more flexible process.
For doing that, the client will have to repeatedly extend the transfer session to keep the channel open. Otherwise, the session will terminate and the transfer will get into paused_system phase, and HTTPS requests to the server will be rejected.
E.g., the client can iterate on chunks of the file, and send them to the proxy server while asking the service to extend the session:
Similarly, for a download transfer, a Range header must be sent, making the download process more easily managed by downloading the disk in chunks.
E.g., the client will again iterate on chunks of the disk image, but this time he/she will download it to a local file, rather than uploading its own file to the image:
When finishing the transfer, the user should call finalize. This will make the final adjustments and verifications for finishing the transfer process.
For example:
transfer_service.finalize()
transfer_service.finalize()
In case of an error, the transfer’s phase will be changed to finished_failure, and the disk’s status will be changed to Illegal. Otherwise it will be changed to finished_success, and the disk will be ready to be used. In both cases, the transfer entity will be removed shortly after.
Using HTTP and cURL calls:
For upload, create a new disk first:
- Specify 'initial_size' and 'provisioned_size' in bytes.
- 'initial_size' must be bigger or the same as the size of the uploaded data.
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
-
Create a new image transfer for downloading/uploading a
diskwith id456:
POST /ovirt-engine/api/imagetransfers
POST /ovirt-engine/api/imagetransfersWith a request body as follows:
<image_transfer> <disk id="456"/> <direction>upload|download</direction> </image_transfer>
<image_transfer>
<disk id="456"/>
<direction>upload|download</direction>
</image_transfer>Will respond:
Note: If the phase is 'initializing', poll the image_transfer till its phase changes to 'transferring'.
- Use the 'transfer_url' or 'proxy_url' to invoke a curl command:
- use 'transfer_url' for transferring directly from/to ovirt-imageio-daemon, or, use 'proxy_url' for transferring from/to ovirt-imageio-proxy. Note: using the proxy would mitigate scenarios where there’s no direct connectivity to the daemon machine, e.g. vdsm machines are on a different network than the engine.
— Download:
curl --cacert /etc/pki/ovirt-engine/ca.pem https://daemon_fqdn:54322/images/41c732d4-2210-4e7b-9e5c-4e2805baadbb -o <output_file>
$ curl --cacert /etc/pki/ovirt-engine/ca.pem https://daemon_fqdn:54322/images/41c732d4-2210-4e7b-9e5c-4e2805baadbb -o <output_file>— Upload:
curl --cacert /etc/pki/ovirt-engine/ca.pem --upload-file <file_to_upload> -X PUT https://daemon_fqdn:54322/images/41c732d4-2210-4e7b-9e5c-4e2805baadbb
$ curl --cacert /etc/pki/ovirt-engine/ca.pem --upload-file <file_to_upload> -X PUT https://daemon_fqdn:54322/images/41c732d4-2210-4e7b-9e5c-4e2805baadbb- Finalize the image transfer by invoking the action:
POST /ovirt-engine/api/imagetransfers/123/finalize
POST /ovirt-engine/api/imagetransfers/123/finalizeWith a request body as follows:
<action />
<action />| Name | Summary |
|---|---|
|
| Cancel the image transfer session. |
|
| Extend the image transfer session. |
|
| After finishing to transfer the data, finalize the transfer. |
|
| Get the image transfer entity. |
|
| Pause the image transfer session. |
|
| Resume the image transfer session. |
6.113.1. cancel POST
Cancel the image transfer session. This terminates the transfer operation and removes the partial image.
6.113.2. extend POST
Extend the image transfer session.
6.113.3. finalize POST
After finishing to transfer the data, finalize the transfer.
This will make sure that the data being transferred is valid and fits the image entity that was targeted in the transfer. Specifically, will verify that if the image entity is a QCOW disk, the data uploaded is indeed a QCOW file, and that the image doesn’t have a backing file.
6.113.4. get GET
Get the image transfer entity.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.113.4.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.113.5. pause POST
Pause the image transfer session.
6.113.6. resume POST
Resume the image transfer session. The client will need to poll the transfer’s phase until it is different than resuming. For example:
6.114. ImageTransfers
This service manages image transfers, for performing Image I/O API in Red Hat Virtualization. Please refer to image transfer for further documentation.
| Name | Summary |
|---|---|
|
| Add a new image transfer. |
|
| Retrieves the list of image transfers that are currently being performed. |
6.114.1. add POST
Add a new image transfer. An image, disk or disk snapshot needs to be specified in order to make a new transfer.
The image attribute is deprecated since version 4.2 of the engine. Use the disk or snapshot attributes instead.
Creating a new image transfer for downloading or uploading a disk:
To create an image transfer to download or upload a disk with id 123, send the following request:
POST /ovirt-engine/api/imagetransfers
POST /ovirt-engine/api/imagetransfersWith a request body like this:
<image_transfer> <disk id="123"/> <direction>upload|download</direction> </image_transfer>
<image_transfer>
<disk id="123"/>
<direction>upload|download</direction>
</image_transfer>
Creating a new image transfer for downloading or uploading a disk_snapshot:
To create an image transfer to download or upload a disk_snapshot with id 456, send the following request:
POST /ovirt-engine/api/imagetransfers
POST /ovirt-engine/api/imagetransfersWith a request body like this:
<image_transfer> <snapshot id="456"/> <direction>download|upload</direction> </image_transfer>
<image_transfer>
<snapshot id="456"/>
<direction>download|upload</direction>
</image_transfer>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The image transfer to add. |
6.114.2. list GET
Retrieves the list of image transfers that are currently being performed.
The order of the returned list of image transfers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | A list of image transfers that are currently being performed. |
6.114.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.115. Images
Manages the set of images available in an storage domain or in an OpenStack image provider.
| Name | Summary |
|---|---|
|
| Returns the list of images available in the storage domain or provider. |
6.115.1. list GET
Returns the list of images available in the storage domain or provider.
The order of the returned list of images isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of images to return. |
6.115.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.115.1.2. max
Sets the maximum number of images to return. If not specified all the images are returned.
6.116. InstanceType
| Name | Summary |
|---|---|
|
| Get a specific instance type and it’s attributes. |
|
| Removes a specific instance type from the system. |
|
| Update a specific instance type and it’s attributes. |
6.116.1. get GET
Get a specific instance type and it’s attributes.
GET /ovirt-engine/api/instancetypes/123
GET /ovirt-engine/api/instancetypes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.116.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.116.2. remove DELETE
Removes a specific instance type from the system.
If a virtual machine was created using an instance type X after removal of the instance type the virtual machine’s instance type will be set to custom.
DELETE /ovirt-engine/api/instancetypes/123
DELETE /ovirt-engine/api/instancetypes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.116.3. update PUT
Update a specific instance type and it’s attributes.
All the attributes are editable after creation. If a virtual machine was created using an instance type X and some configuration in instance type X was updated, the virtual machine’s configuration will be updated automatically by the engine.
PUT /ovirt-engine/api/instancetypes/123
PUT /ovirt-engine/api/instancetypes/123
For example, to update the memory of instance type 123 to 1 GiB and set the cpu topology to 2 sockets and 1 core, send a request like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.117. InstanceTypeGraphicsConsole
| Name | Summary |
|---|---|
|
| Gets graphics console configuration of the instance type. |
|
| Remove the graphics console from the instance type. |
6.117.1. get GET
Gets graphics console configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the graphics console of the instance type. | |
|
| In | Indicates which inner links should be followed. |
6.117.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.117.2. remove DELETE
Remove the graphics console from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.118. InstanceTypeGraphicsConsoles
| Name | Summary |
|---|---|
|
| Add new graphics console to the instance type. |
|
| Lists all the configured graphics consoles of the instance type. |
6.118.1. add POST
Add new graphics console to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.118.2. list GET
Lists all the configured graphics consoles of the instance type.
The order of the returned list of graphics consoles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of graphics consoles of the instance type. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of consoles to return. |
6.118.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.118.2.2. max
Sets the maximum number of consoles to return. If not specified all the consoles are returned.
6.119. InstanceTypeNic
| Name | Summary |
|---|---|
|
| Gets network interface configuration of the instance type. |
|
| Remove the network interface from the instance type. |
|
| Updates the network interface configuration of the instance type. |
6.119.1. get GET
Gets network interface configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.119.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.119.2. remove DELETE
Remove the network interface from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.119.3. update PUT
Updates the network interface configuration of the instance type.
6.120. InstanceTypeNics
| Name | Summary |
|---|---|
|
| Add new network interface to the instance type. |
|
| Lists all the configured network interface of the instance type. |
6.120.1. add POST
Add new network interface to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.120.2. list GET
Lists all the configured network interface of the instance type.
The order of the returned list of network interfaces isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned templates. |
6.120.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.120.2.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.121. InstanceTypeWatchdog
| Name | Summary |
|---|---|
|
| Gets watchdog configuration of the instance type. |
|
| Remove a watchdog from the instance type. |
|
| Updates the watchdog configuration of the instance type. |
6.121.1. get GET
Gets watchdog configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.121.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.121.2. remove DELETE
Remove a watchdog from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.121.3. update PUT
Updates the watchdog configuration of the instance type.
6.122. InstanceTypeWatchdogs
| Name | Summary |
|---|---|
|
| Add new watchdog to the instance type. |
|
| Lists all the configured watchdogs of the instance type. |
6.122.1. add POST
Add new watchdog to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.122.2. list GET
Lists all the configured watchdogs of the instance type.
The order of the returned list of watchdogs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of watchdogs to return. | |
|
| In | A query string used to restrict the returned templates. | |
|
| Out |
6.122.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.122.2.2. max
Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.
6.123. InstanceTypes
| Name | Summary |
|---|---|
|
| Creates a new instance type. |
|
| Lists all existing instance types in the system. |
6.123.1. add POST
Creates a new instance type.
This requires only a name attribute and can include all hardware configurations of the virtual machine.
POST /ovirt-engine/api/instancetypes
POST /ovirt-engine/api/instancetypesWith a request body like this:
<instance_type> <name>myinstancetype</name> </template>
<instance_type>
<name>myinstancetype</name>
</template>Creating an instance type with all hardware configurations with a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.123.2. list GET
Lists all existing instance types in the system.
The order of the returned list of instance types isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of instance types to return. | |
|
| In | A query string used to restrict the returned templates. |
6.123.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.123.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.123.2.3. max
Sets the maximum number of instance types to return. If not specified all the instance types are returned.
6.124. IscsiBond
| Name | Summary |
|---|---|
|
| |
|
| Removes of an existing iSCSI bond. |
|
| Updates an iSCSI bond. |
6.124.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The iSCSI bond. | |
|
| In | Indicates which inner links should be followed. |
6.124.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.124.2. remove DELETE
Removes of an existing iSCSI bond.
For example, to remove the iSCSI bond 456 send a request like this:
DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456
DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.124.3. update PUT
Updates an iSCSI bond.
Updating of an iSCSI bond can be done on the name and the description attributes only. For example, to update the iSCSI bond 456 of data center 123, send a request like this:
PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234
PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234The request body should look like this:
<iscsi_bond> <name>mybond</name> <description>My iSCSI bond</description> </iscsi_bond>
<iscsi_bond>
<name>mybond</name>
<description>My iSCSI bond</description>
</iscsi_bond>6.125. IscsiBonds
| Name | Summary |
|---|---|
|
| Create a new iSCSI bond on a data center. |
|
| Returns the list of iSCSI bonds configured in the data center. |
6.125.1. add POST
Create a new iSCSI bond on a data center.
For example, to create a new iSCSI bond on data center 123 using storage connections 456 and 789, send a request like this:
POST /ovirt-engine/api/datacenters/123/iscsibonds
POST /ovirt-engine/api/datacenters/123/iscsibondsThe request body should look like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.125.2. list GET
Returns the list of iSCSI bonds configured in the data center.
The order of the returned list of iSCSI bonds isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bonds to return. |
6.125.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.125.2.2. max
Sets the maximum number of bonds to return. If not specified all the bonds are returned.
6.126. Job
A service to manage a job.
| Name | Summary |
|---|---|
|
| Set an external job execution to be cleared by the system. |
|
| Marks an external job execution as ended. |
|
| Retrieves a job. |
6.126.1. clear POST
Set an external job execution to be cleared by the system.
For example, to set a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/clear
POST /ovirt-engine/api/jobs/clearWith the following request body:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.126.2. end POST
Marks an external job execution as ended.
For example, to terminate a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/end
POST /ovirt-engine/api/jobs/endWith the following request body:
<action> <force>true</force> <status>finished</status> </action>
<action>
<force>true</force>
<status>finished</status>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the job should be forcibly terminated. | |
|
| In | Indicates if the job should be marked as successfully finished or as failed. |
6.126.2.1. succeeded
Indicates if the job should be marked as successfully finished or as failed.
This parameter is optional, and the default value is true.
6.126.3. get GET
Retrieves a job.
GET /ovirt-engine/api/jobs/123
GET /ovirt-engine/api/jobs/123You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieves the representation of the job. |
6.126.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.127. Jobs
A service to manage jobs.
| Name | Summary |
|---|---|
|
| Add an external job. |
|
| Retrieves the representation of the jobs. |
6.127.1. add POST
Add an external job.
For example, to add a job with the following request:
POST /ovirt-engine/api/jobs
POST /ovirt-engine/api/jobsWith the following request body:
<job> <description>Doing some work</description> <auto_cleared>true</auto_cleared> </job>
<job>
<description>Doing some work</description>
<auto_cleared>true</auto_cleared>
</job>The response should look like:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Job that will be added. |
6.127.2. list GET
Retrieves the representation of the jobs.
GET /ovirt-engine/api/jobs
GET /ovirt-engine/api/jobsYou will receive response in XML like this one:
The order of the returned list of jobs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | A representation of jobs. | |
|
| In | Sets the maximum number of jobs to return. | |
|
| In | A query string used to restrict the returned jobs. |
6.127.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.127.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.127.2.3. max
Sets the maximum number of jobs to return. If not specified all the jobs are returned.
6.128. KatelloErrata
A service to manage Katello errata. The information is retrieved from Katello.
| Name | Summary |
|---|---|
|
| Retrieves the representation of the Katello errata. |
6.128.1. list GET
Retrieves the representation of the Katello errata.
GET /ovirt-engine/api/katelloerrata
GET /ovirt-engine/api/katelloerrataYou will receive response in XML like this one:
The order of the returned list of erratum isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A representation of Katello errata. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of errata to return. |
6.128.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.128.1.2. max
Sets the maximum number of errata to return. If not specified all the errata are returned.
6.129. KatelloErratum
A service to manage a Katello erratum.
| Name | Summary |
|---|---|
|
| Retrieves a Katello erratum. |
6.129.1. get GET
Retrieves a Katello erratum.
GET /ovirt-engine/api/katelloerrata/123
GET /ovirt-engine/api/katelloerrata/123You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieves the representation of the Katello erratum. | |
|
| In | Indicates which inner links should be followed. |
6.129.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.130. LinkLayerDiscoveryProtocol
A service to fetch information elements received by Link Layer Discovery Protocol (LLDP).
| Name | Summary |
|---|---|
|
| Fetches information elements received by LLDP. |
6.130.1. list GET
Fetches information elements received by LLDP.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieves a list of information elements received by LLDP. | |
|
| In | Indicates which inner links should be followed. |
6.130.1.1. elements
Retrieves a list of information elements received by LLDP.
For example, to retrieve the information elements received on the NIC 321 on host 123, send a request like this:
GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelements
GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelementsIt will return a response like this:
6.130.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.131. MacPool
| Name | Summary |
|---|---|
|
| |
|
| Removes a MAC address pool. |
|
| Updates a MAC address pool. |
6.131.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.131.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.131.2. remove DELETE
Removes a MAC address pool.
For example, to remove the MAC address pool having id 123 send a request like this:
DELETE /ovirt-engine/api/macpools/123
DELETE /ovirt-engine/api/macpools/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.131.3. update PUT
Updates a MAC address pool.
The name, description, allow_duplicates, and ranges attributes can be updated.
For example, to update the MAC address pool of id 123 send a request like this:
PUT /ovirt-engine/api/macpools/123
PUT /ovirt-engine/api/macpools/123With a request body like this:
6.132. MacPools
| Name | Summary |
|---|---|
|
| Creates a new MAC address pool. |
|
| Return the list of MAC address pools of the system. |
6.132.1. add POST
Creates a new MAC address pool.
Creation of a MAC address pool requires values for the name and ranges attributes.
For example, to create MAC address pool send a request like this:
POST /ovirt-engine/api/macpools
POST /ovirt-engine/api/macpoolsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.132.2. list GET
Return the list of MAC address pools of the system.
The returned list of MAC address pools isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of pools to return. | |
|
| Out |
6.132.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.132.2.2. max
Sets the maximum number of pools to return. If not specified all the pools are returned.
6.133. Measurable
6.134. Moveable
| Name | Summary |
|---|---|
|
|
6.134.1. move POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. |
6.135. Network
A service managing a network
| Name | Summary |
|---|---|
|
| Gets a logical network. |
|
| Removes a logical network, or the association of a logical network to a data center. |
|
| Updates a logical network. |
6.135.1. get GET
Gets a logical network.
For example:
GET /ovirt-engine/api/networks/123
GET /ovirt-engine/api/networks/123Will respond:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.135.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.135.2. remove DELETE
Removes a logical network, or the association of a logical network to a data center.
For example, to remove the logical network 123 send a request like this:
DELETE /ovirt-engine/api/networks/123
DELETE /ovirt-engine/api/networks/123
Each network is bound exactly to one data center. So if we disassociate network with data center it has the same result as if we would just remove that network. However it might be more specific to say we’re removing network 456 of data center 123.
For example, to remove the association of network 456 to data center 123 send a request like this:
DELETE /ovirt-engine/api/datacenters/123/networks/456
DELETE /ovirt-engine/api/datacenters/123/networks/456
To remove an external logical network, the network has to be removed directly from its provider by OpenStack Networking API. The entity representing the external network inside Red Hat Virtualization is removed automatically, if auto_sync is enabled for the provider, otherwise the entity has to be removed using this method.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.135.3. update PUT
Updates a logical network.
The name, description, ip, vlan, stp and display attributes can be updated.
For example, to update the description of the logical network 123 send a request like this:
PUT /ovirt-engine/api/networks/123
PUT /ovirt-engine/api/networks/123With a request body like this:
<network> <description>My updated description</description> </network>
<network>
<description>My updated description</description>
</network>
The maximum transmission unit of a network is set using a PUT request to specify the integer value of the mtu attribute.
For example, to set the maximum transmission unit send a request like this:
PUT /ovirt-engine/api/datacenters/123/networks/456
PUT /ovirt-engine/api/datacenters/123/networks/456With a request body like this:
<network> <mtu>1500</mtu> </network>
<network>
<mtu>1500</mtu>
</network>6.136. NetworkAttachment
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified network attachment on the host. |
6.136.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.136.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.136.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.136.3. update PUT
Update the specified network attachment on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.137. NetworkAttachments
Manages the set of network attachments of a host or host NIC.
| Name | Summary |
|---|---|
|
| Add a new network attachment to the network interface. |
|
| Returns the list of network attachments of the host or host NIC. |
6.137.1. add POST
Add a new network attachment to the network interface.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.137.2. list GET
Returns the list of network attachments of the host or host NIC.
The order of the returned list of network attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of attachments to return. |
6.137.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.137.2.2. max
Sets the maximum number of attachments to return. If not specified all the attachments are returned.
6.138. NetworkFilter
Manages a network filter.
Please note that version is referring to the minimal support version for the specific filter.
| Name | Summary |
|---|---|
|
| Retrieves a representation of the network filter. |
6.138.1. get GET
Retrieves a representation of the network filter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.138.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.139. NetworkFilters
Represents a readonly network filters sub-collection.
The network filter enables to filter packets send to/from the VM’s nic according to defined rules. For more information please refer to NetworkFilter service documentation
Network filters are supported in different versions, starting from version 3.0.
A network filter is defined for each vnic profile.
A vnic profile is defined for a specific network.
A network can be assigned to several different clusters. In the future, each network will be defined in cluster level.
Currently, each network is being defined at data center level. Potential network filters for each network are determined by the network’s data center compatibility version V. V must be >= the network filter version in order to configure this network filter for a specific network. Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter’s version.
Example of listing all of the supported network filters for a specific cluster:
GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters
GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfiltersOutput:
| Name | Summary |
|---|---|
|
| Retrieves the representations of the network filters. |
6.139.1. list GET
Retrieves the representations of the network filters.
The order of the returned list of network filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.139.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.140. NetworkLabel
| Name | Summary |
|---|---|
|
| |
|
| Removes a label from a logical network. |
6.140.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.140.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.140.2. remove DELETE
Removes a label from a logical network.
For example, to remove the label exemplary from a logical network having id 123 send the following request:
DELETE /ovirt-engine/api/networks/123/labels/exemplary
DELETE /ovirt-engine/api/networks/123/labels/exemplary| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.141. NetworkLabels
Manages the ser of labels attached to a network or to a host NIC.
| Name | Summary |
|---|---|
|
| Attaches label to logical network. |
|
| Returns the list of labels attached to the network or host NIC. |
6.141.1. add POST
Attaches label to logical network.
You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached.
For example, to attach the label mylabel to a logical network having id 123 send a request like this:
POST /ovirt-engine/api/networks/123/labels
POST /ovirt-engine/api/networks/123/labelsWith a request body like this:
<label id="mylabel"/>
<label id="mylabel"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.141.2. list GET
Returns the list of labels attached to the network or host NIC.
The order of the returned list of labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of labels to return. |
6.141.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.141.2.2. max
Sets the maximum number of labels to return. If not specified all the labels are returned.
6.142. Networks
Manages logical networks.
The engine creates a default ovirtmgmt network on installation. This network acts as the management network for access to hypervisor hosts. This network is associated with the Default cluster and is a member of the Default data center.
| Name | Summary |
|---|---|
|
| Creates a new logical network, or associates an existing network with a data center. |
|
| List logical networks. |
6.142.1. add POST
Creates a new logical network, or associates an existing network with a data center.
Creation of a new network requires the name and data_center elements.
For example, to create a network named mynetwork for data center 123 send a request like this:
POST /ovirt-engine/api/networks
POST /ovirt-engine/api/networksWith a request body like this:
<network> <name>mynetwork</name> <data_center id="123"/> </network>
<network>
<name>mynetwork</name>
<data_center id="123"/>
</network>
To associate the existing network 456 with the data center 123 send a request like this:
POST /ovirt-engine/api/datacenters/123/networks
POST /ovirt-engine/api/datacenters/123/networksWith a request body like this:
<network> <name>ovirtmgmt</name> </network>
<network>
<name>ovirtmgmt</name>
</network>
To create a network named exnetwork on top of an external OpenStack network provider 456 send a request like this:
POST /ovirt-engine/api/networks
POST /ovirt-engine/api/networks<network> <name>exnetwork</name> <external_provider id="456"/> <data_center id="123"/> </network>
<network>
<name>exnetwork</name>
<external_provider id="456"/>
<data_center id="123"/>
</network>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.142.2. list GET
List logical networks.
For example:
GET /ovirt-engine/api/networks
GET /ovirt-engine/api/networksWill respond:
The order of the returned list of networks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned networks. |
6.142.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.142.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.142.2.3. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.143. NicNetworkFilterParameter
This service manages a parameter for a network filter.
| Name | Summary |
|---|---|
|
| Retrieves a representation of the network filter parameter. |
|
| Removes the filter parameter. |
|
| Updates the network filter parameter. |
6.143.1. get GET
Retrieves a representation of the network filter parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The representation of the network filter parameter. |
6.143.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.143.2. remove DELETE
Removes the filter parameter.
For example, to remove the filter parameter with id 123 on NIC 456 of virtual machine 789 send a request like this:
DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123
DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/1236.143.3. update PUT
Updates the network filter parameter.
For example, to update the network filter parameter having with with id 123 on NIC 456 of virtual machine 789 send a request like this:
PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123
PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123With a request body like this:
<network_filter_parameter> <name>updatedName</name> <value>updatedValue</value> </network_filter_parameter>
<network_filter_parameter>
<name>updatedName</name>
<value>updatedValue</value>
</network_filter_parameter>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network filter parameter that is being updated. |
6.144. NicNetworkFilterParameters
This service manages a collection of parameters for network filters.
| Name | Summary |
|---|---|
|
| Add a network filter parameter. |
|
| Retrieves the representations of the network filter parameters. |
6.144.1. add POST
Add a network filter parameter.
For example, to add the parameter for the network filter on NIC 456 of virtual machine 789 send a request like this:
POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters
POST /ovirt-engine/api/vms/789/nics/456/networkfilterparametersWith a request body like this:
<network_filter_parameter> <name>IP</name> <value>10.0.1.2</value> </network_filter_parameter>
<network_filter_parameter>
<name>IP</name>
<value>10.0.1.2</value>
</network_filter_parameter>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network filter parameter that is being added. |
6.144.2. list GET
Retrieves the representations of the network filter parameters.
The order of the returned list of network filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of the network filter parameters. |
6.144.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.145. OpenstackImage
| Name | Summary |
|---|---|
|
| |
|
| Imports a virtual machine from a Glance image storage domain. |
6.145.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.145.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.145.2. import POST
Imports a virtual machine from a Glance image storage domain.
For example, to import the image with identifier 456 from the storage domain with identifier 123 send a request like this:
POST /ovirt-engine/api/openstackimageproviders/123/images/456/import
POST /ovirt-engine/api/openstackimageproviders/123/images/456/importWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In |
This parameter is mandatory in case of using | |
|
| In | ||
|
| In | Indicates whether the image should be imported as a template. | |
|
| In | ||
|
| In |
6.146. OpenstackImageProvider
| Name | Summary |
|---|---|
|
| |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified OpenStack image provider in the system. |
6.146.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.146.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.146.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.146.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.146.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.146.5. update PUT
Update the specified OpenStack image provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.147. OpenstackImageProviders
| Name | Summary |
|---|---|
|
| Adds a new OpenStack image provider to the system. |
|
| Returns the list of providers. |
6.147.1. add POST
Adds a new OpenStack image provider to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.147.2. list GET
Returns the list of providers.
The order of the returned list of providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned OpenStack image providers. |
6.147.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.147.2.2. max
Sets the maximum number of providers to return. If not specified, all the providers are returned.
6.148. OpenstackImages
| Name | Summary |
|---|---|
|
| Lists the images of a Glance image storage domain. |
6.148.1. list GET
Lists the images of a Glance image storage domain.
The order of the returned list of images isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of images to return. |
6.148.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.148.1.2. max
Sets the maximum number of images to return. If not specified all the images are returned.
6.149. OpenstackNetwork
| Name | Summary |
|---|---|
|
| |
|
| This operation imports an external network into Red Hat Virtualization. |
6.149.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.149.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.149.2. import POST
This operation imports an external network into Red Hat Virtualization. The network will be added to the specified data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In | The data center into which the network is to be imported. |
6.149.2.1. data_center
The data center into which the network is to be imported. Data center is mandatory, and can be specified using the id or name attributes. The rest of the attributes will be ignored.
If auto_sync is enabled for the provider, the network might be imported automatically. To prevent this, automatic import can be disabled by setting the auto_sync to false, and enabling it again after importing the network.
6.150. OpenstackNetworkProvider
This service manages the OpenStack network provider.
| Name | Summary |
|---|---|
|
| Returns the representation of the object managed by this service. |
|
| Import the SSL certificates of the external host provider. |
|
| Removes the provider. |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Updates the provider. |
6.150.1. get GET
Returns the representation of the object managed by this service.
For example, to get the OpenStack network provider with identifier 1234, send a request like this:
GET /ovirt-engine/api/openstacknetworkproviders/1234
GET /ovirt-engine/api/openstacknetworkproviders/1234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.150.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.150.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.150.3. remove DELETE
Removes the provider.
For example, to remove the OpenStack network provider with identifier 1234, send a request like this:
DELETE /ovirt-engine/api/openstacknetworkproviders/1234
DELETE /ovirt-engine/api/openstacknetworkproviders/1234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.150.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.150.5. update PUT
Updates the provider.
For example, to update provider_name, requires_authentication, url, tenant_name and type properties, for the OpenStack network provider with identifier 1234, send a request like this:
PUT /ovirt-engine/api/openstacknetworkproviders/1234
PUT /ovirt-engine/api/openstacknetworkproviders/1234With a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The provider to update. |
6.151. OpenstackNetworkProviders
This service manages OpenStack network providers.
| Name | Summary |
|---|---|
|
| Adds a new network provider to the system. |
|
| Returns the list of providers. |
6.151.1. add POST
Adds a new network provider to the system. If the type property is not present, a default value of NEUTRON will be used.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.151.2. list GET
Returns the list of providers.
The order of the returned list of providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned OpenStack network providers. |
6.151.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.151.2.2. max
Sets the maximum number of providers to return. If not specified, all the providers are returned.
6.152. OpenstackNetworks
| Name | Summary |
|---|---|
|
| Returns the list of networks. |
6.152.1. list GET
Returns the list of networks.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.152.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.152.1.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.153. OpenstackSubnet
| Name | Summary |
|---|---|
|
| |
|
|
6.153.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.153.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.153.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.154. OpenstackSubnets
| Name | Summary |
|---|---|
|
| |
|
| Returns the list of sub-networks. |
6.154.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.154.2. list GET
Returns the list of sub-networks.
The order of the returned list of sub-networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of sub-networks to return. | |
|
| Out |
6.154.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.154.2.2. max
Sets the maximum number of sub-networks to return. If not specified all the sub-networks are returned.
6.155. OpenstackVolumeAuthenticationKey
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified authentication key. |
6.155.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.155.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.155.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.155.3. update PUT
Update the specified authentication key.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.156. OpenstackVolumeAuthenticationKeys
| Name | Summary |
|---|---|
|
| Add a new authentication key to the OpenStack volume provider. |
|
| Returns the list of authentication keys. |
6.156.1. add POST
Add a new authentication key to the OpenStack volume provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.156.2. list GET
Returns the list of authentication keys.
The order of the returned list of authentication keys isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of keys to return. |
6.156.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.156.2.2. max
Sets the maximum number of keys to return. If not specified all the keys are returned.
6.157. OpenstackVolumeProvider
| Name | Summary |
|---|---|
|
| |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified OpenStack volume provider in the system. |
6.157.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.157.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.157.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.157.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation. |
6.157.3.1. force
Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation.
This parameter is optional, and the default value is false.
6.157.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.157.5. update PUT
Update the specified OpenStack volume provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.158. OpenstackVolumeProviders
| Name | Summary |
|---|---|
|
| Adds a new volume provider. |
|
| Retrieves the list of volume providers. |
6.158.1. add POST
Adds a new volume provider.
For example:
POST /ovirt-engine/api/openstackvolumeproviders
POST /ovirt-engine/api/openstackvolumeprovidersWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.158.2. list GET
Retrieves the list of volume providers.
The order of the returned list of volume providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned volume providers. |
6.158.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.158.2.2. max
Sets the maximum number of providers to return. If not specified, all the providers are returned.
6.159. OpenstackVolumeType
| Name | Summary |
|---|---|
|
|
6.159.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.159.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.160. OpenstackVolumeTypes
| Name | Summary |
|---|---|
|
| Returns the list of volume types. |
6.160.1. list GET
Returns the list of volume types.
The order of the returned list of volume types isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of volume types to return. | |
|
| Out |
6.160.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.160.1.2. max
Sets the maximum number of volume types to return. If not specified all the volume types are returned.
6.161. OperatingSystem
| Name | Summary |
|---|---|
|
|
6.161.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.161.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.162. OperatingSystems
Manages the set of types of operating systems available in the system.
| Name | Summary |
|---|---|
|
| Returns the list of types of operating system available in the system. |
6.162.1. list GET
Returns the list of types of operating system available in the system.
The order of the returned list of operating systems isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.162.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.162.1.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.163. Permission
| Name | Summary |
|---|---|
|
| |
|
|
6.163.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.163.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.163.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.164. Permit
A service to manage a specific permit of the role.
| Name | Summary |
|---|---|
|
| Gets the information about the permit of the role. |
|
| Removes the permit from the role. |
6.164.1. get GET
Gets the information about the permit of the role.
For example to retrieve the information about the permit with the id 456 of the role with the id 123 send a request like this:
GET /ovirt-engine/api/roles/123/permits/456
GET /ovirt-engine/api/roles/123/permits/456<permit href="/ovirt-engine/api/roles/123/permits/456" id="456"> <name>change_vm_cd</name> <administrative>false</administrative> <role href="/ovirt-engine/api/roles/123" id="123"/> </permit>
<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
<name>change_vm_cd</name>
<administrative>false</administrative>
<role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The permit of the role. |
6.164.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.164.2. remove DELETE
Removes the permit from the role.
For example to remove the permit with id 456 from the role with id 123 send a request like this:
DELETE /ovirt-engine/api/roles/123/permits/456
DELETE /ovirt-engine/api/roles/123/permits/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.165. Permits
Represents a permits sub-collection of the specific role.
| Name | Summary |
|---|---|
|
| Adds a permit to the role. |
|
| List the permits of the role. |
6.165.1. add POST
Adds a permit to the role. The permit name can be retrieved from the Section 6.39, “ClusterLevels” service.
For example to assign a permit create_vm to the role with id 123 send a request like this:
POST /ovirt-engine/api/roles/123/permits
POST /ovirt-engine/api/roles/123/permitsWith a request body like this:
<permit> <name>create_vm</name> </permit>
<permit>
<name>create_vm</name>
</permit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The permit to add. |
6.165.2. list GET
List the permits of the role.
For example to list the permits of the role with the id 123 send a request like this:
GET /ovirt-engine/api/roles/123/permits
GET /ovirt-engine/api/roles/123/permitsThe order of the returned list of permits isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of permits to return. | |
|
| Out | List of permits. |
6.165.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.165.2.2. max
Sets the maximum number of permits to return. If not specified all the permits are returned.
6.166. Qos
| Name | Summary |
|---|---|
|
| Get specified QoS in the data center. |
|
| Remove specified QoS from datacenter. |
|
| Update the specified QoS in the dataCenter. |
6.166.1. get GET
Get specified QoS in the data center.
GET /ovirt-engine/api/datacenters/123/qoss/123
GET /ovirt-engine/api/datacenters/123/qoss/123You will get response like this one below:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Queried QoS object. |
6.166.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.166.2. remove DELETE
Remove specified QoS from datacenter.
DELETE /ovirt-engine/api/datacenters/123/qoss/123
DELETE /ovirt-engine/api/datacenters/123/qoss/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.166.3. update PUT
Update the specified QoS in the dataCenter.
PUT /ovirt-engine/api/datacenters/123/qoss/123
PUT /ovirt-engine/api/datacenters/123/qoss/123For example with curl:
curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \ "<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \ https://engine/ovirt-engine/api/datacenters/123/qoss/123
curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
"<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
https://engine/ovirt-engine/api/datacenters/123/qoss/123You will receive response like this:
6.167. Qoss
Manages the set of quality of service configurations available in a data center.
| Name | Summary |
|---|---|
|
| Add a new QoS to the dataCenter. |
|
| Returns the list of quality of service configurations available in the data center. |
6.167.1. add POST
Add a new QoS to the dataCenter.
POST /ovirt-engine/api/datacenters/123/qoss
POST /ovirt-engine/api/datacenters/123/qossThe response will look as follows:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Added QoS object. |
6.167.2. list GET
Returns the list of quality of service configurations available in the data center.
GET /ovirt-engine/api/datacenter/123/qoss
GET /ovirt-engine/api/datacenter/123/qossYou will get response which will look like this:
<qoss> <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos> <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos> <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos> </qoss>
<qoss>
<qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
<qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
<qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
</qoss>The returned list of quality of service configurations isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of QoS descriptors to return. | |
|
| Out | List of queried QoS objects. |
6.167.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.167.2.2. max
Sets the maximum number of QoS descriptors to return. If not specified all the descriptors are returned.
6.168. Quota
| Name | Summary |
|---|---|
|
| Retrieves a quota. |
|
| Delete a quota. |
|
| Updates a quota. |
6.168.1. get GET
Retrieves a quota.
An example of retrieving a quota:
GET /ovirt-engine/api/datacenters/123/quotas/456
GET /ovirt-engine/api/datacenters/123/quotas/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.168.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.168.2. remove DELETE
Delete a quota.
An example of deleting a quota:
DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321 -0472718ab224 HTTP/1.1 Accept: application/xml Content-type: application/xml
DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.168.3. update PUT
Updates a quota.
An example of updating a quota:
PUT /ovirt-engine/api/datacenters/123/quotas/456
PUT /ovirt-engine/api/datacenters/123/quotas/4566.169. QuotaClusterLimit
| Name | Summary |
|---|---|
|
| |
|
|
6.169.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.169.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.169.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.170. QuotaClusterLimits
Manages the set of quota limits configured for a cluster.
| Name | Summary |
|---|---|
|
| Add a cluster limit to a specified Quota. |
|
| Returns the set of quota limits configured for the cluster. |
6.170.1. add POST
Add a cluster limit to a specified Quota.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.170.2. list GET
Returns the set of quota limits configured for the cluster.
The returned list of quota limits isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of limits to return. |
6.170.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.170.2.2. max
Sets the maximum number of limits to return. If not specified all the limits are returned.
6.171. QuotaStorageLimit
| Name | Summary |
|---|---|
|
| |
|
|
6.171.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.171.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.171.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. |
6.172. QuotaStorageLimits
Manages the set of storage limits configured for a quota.
| Name | Summary |
|---|---|
|
| Adds a storage limit to a specified quota. |
|
| Returns the list of storage limits configured for the quota. |
6.172.1. add POST
Adds a storage limit to a specified quota.
To create a 100GiB storage limit for all storage domains in a data center, send a request like this:
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimitsWith a request body like this:
<quota_storage_limit> <limit>100</limit> </quota_storage_limit>
<quota_storage_limit>
<limit>100</limit>
</quota_storage_limit>
To create a 50GiB storage limit for a storage domain with the ID 000, send a request like this:
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimitsWith a request body like this:
<quota_storage_limit> <limit>50</limit> <storage_domain id="000"/> </quota_storage_limit>
<quota_storage_limit>
<limit>50</limit>
<storage_domain id="000"/>
</quota_storage_limit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.172.2. list GET
Returns the list of storage limits configured for the quota.
The order of the returned list of storage limits is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of limits to return. |
6.172.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.172.2.2. max
Sets the maximum number of limits to return. If not specified, all the limits are returned.
6.173. Quotas
Manages the set of quotas configured for a data center.
| Name | Summary |
|---|---|
|
| Creates a new quota. |
|
| Lists quotas of a data center. |
6.173.1. add POST
Creates a new quota.
An example of creating a new quota:
POST /ovirt-engine/api/datacenters/123/quotas
POST /ovirt-engine/api/datacenters/123/quotas<quota> <name>myquota</name> <description>My new quota for virtual machines</description> </quota>
<quota>
<name>myquota</name>
<description>My new quota for virtual machines</description>
</quota>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.173.2. list GET
Lists quotas of a data center.
The order of the returned list of quotas isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of quota descriptors to return. | |
|
| Out |
6.173.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.173.2.2. max
Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned.
6.174. Role
| Name | Summary |
|---|---|
|
| Get the role. |
|
| Removes the role. |
|
| Updates a role. |
6.174.1. get GET
Get the role.
GET /ovirt-engine/api/roles/123
GET /ovirt-engine/api/roles/123You will receive XML response like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved role. |
6.174.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.174.2. remove DELETE
Removes the role.
To remove the role you need to know its id, then send request like this:
DELETE /ovirt-engine/api/roles/{role_id}
DELETE /ovirt-engine/api/roles/{role_id}| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.174.3. update PUT
Updates a role. You are allowed to update name, description and administrative attributes after role is created. Within this endpoint you can’t add or remove roles permits you need to use service that manages permits of role.
For example to update role’s name, description and administrative attributes send a request like this:
PUT /ovirt-engine/api/roles/123
PUT /ovirt-engine/api/roles/123With a request body like this:
<role> <name>MyNewRoleName</name> <description>My new description of the role</description> <administrative>true</administrative> </group>
<role>
<name>MyNewRoleName</name>
<description>My new description of the role</description>
<administrative>true</administrative>
</group>6.175. Roles
Provides read-only access to the global set of roles
| Name | Summary |
|---|---|
|
| Create a new role. |
|
| List roles. |
6.175.1. add POST
Create a new role. The role can be administrative or non-administrative and can have different permits.
For example, to add the MyRole non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id):
POST /ovirt-engine/api/roles
POST /ovirt-engine/api/rolesWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Role that will be added. |
6.175.2. list GET
List roles.
GET /ovirt-engine/api/roles
GET /ovirt-engine/api/rolesYou will receive response in XML like this one:
The order of the returned list of roles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of roles to return. | |
|
| Out | Retrieved list of roles. |
6.175.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.175.2.2. max
Sets the maximum number of roles to return. If not specified all the roles are returned.
6.176. SchedulingPolicies
Manages the set of scheduling policies available in the system.
| Name | Summary |
|---|---|
|
| Add a new scheduling policy to the system. |
|
| Returns the list of scheduling policies available in the system. |
6.176.1. add POST
Add a new scheduling policy to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.176.2. list GET
Returns the list of scheduling policies available in the system.
The order of the returned list of scheduling policies isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of policies to return. | |
|
| Out |
6.176.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.176.2.2. max
Sets the maximum number of policies to return. If not specified all the policies are returned.
6.177. SchedulingPolicy
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified user defined scheduling policy in the system. |
6.177.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.177.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.177.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.177.3. update PUT
Update the specified user defined scheduling policy in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.178. SchedulingPolicyUnit
| Name | Summary |
|---|---|
|
| |
|
|
6.178.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.178.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.178.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.179. SchedulingPolicyUnits
Manages the set of scheduling policy units available in the system.
| Name | Summary |
|---|---|
|
| Returns the list of scheduling policy units available in the system. |
6.179.1. list GET
Returns the list of scheduling policy units available in the system.
The order of the returned list of scheduling policy units isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of policy units to return. | |
|
| Out |
6.179.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.179.1.2. max
Sets the maximum number of policy units to return. If not specified all the policy units are returned.
6.180. Snapshot
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Restores a virtual machine snapshot. |
6.180.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.180.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.180.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all the attributes of the virtual machine snapshot should be included in the response. | |
|
| In | Indicates if the remove should be performed asynchronously. |
6.180.2.1. all_content
Indicates if all the attributes of the virtual machine snapshot should be included in the response.
By default the attribute initialization.configuration.data is excluded.
For example, to retrieve the complete representation of the snapshot with id 456 of the virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true
GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true6.180.3. restore POST
Restores a virtual machine snapshot.
For example, to restore the snapshot with identifier 456 of virtual machine with identifier 123 send a request like this:
POST /ovirt-engine/api/vms/123/snapshots/456/restore
POST /ovirt-engine/api/vms/123/snapshots/456/restore
With an empty action in the body:
<action/>
<action/>Confirm that the commit operation is finished and the virtual machine is down before running the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the restore should be performed asynchronously. | |
|
| In | Specify the disks included in the snapshot’s restore. | |
|
| In |
6.180.3.1. disks
Specify the disks included in the snapshot’s restore.
For each disk parameter, it is also required to specify its image_id.
For example, to restore a snapshot with an identifier 456 of a virtual machine with identifier 123, including a disk with identifier 111 and image_id of 222, send a request like this:
POST /ovirt-engine/api/vms/123/snapshots/456/restore
POST /ovirt-engine/api/vms/123/snapshots/456/restoreRequest body:
6.181. SnapshotCdrom
| Name | Summary |
|---|---|
|
|
6.181.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.181.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.182. SnapshotCdroms
Manages the set of CD-ROM devices of a virtual machine snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of CD-ROM devices of the snapshot. |
6.182.1. list GET
Returns the list of CD-ROM devices of the snapshot.
The order of the returned list of CD-ROM devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of CDROMS to return. |
6.182.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.182.1.2. max
Sets the maximum number of CDROMS to return. If not specified all the CDROMS are returned.
6.183. SnapshotDisk
| Name | Summary |
|---|---|
|
|
6.183.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.183.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.184. SnapshotDisks
Manages the set of disks of an snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of disks of the snapshot. |
6.184.1. list GET
Returns the list of disks of the snapshot.
The order of the returned list of disks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.184.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.184.1.2. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.185. SnapshotNic
| Name | Summary |
|---|---|
|
|
6.185.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.185.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.186. SnapshotNics
Manages the set of NICs of an snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of NICs of the snapshot. |
6.186.1. list GET
Returns the list of NICs of the snapshot.
The order of the returned list of NICs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Out |
6.186.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.186.1.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.187. Snapshots
Manages the set of snapshots of a storage domain or virtual machine.
| Name | Summary |
|---|---|
|
| Creates a virtual machine snapshot. |
|
| Returns the list of snapshots of the storage domain or virtual machine. |
6.187.1. add POST
Creates a virtual machine snapshot.
For example, to create a new snapshot for virtual machine 123 send a request like this:
POST /ovirt-engine/api/vms/123/snapshots
POST /ovirt-engine/api/vms/123/snapshotsWith a request body like this:
<snapshot> <description>My snapshot</description> </snapshot>
<snapshot>
<description>My snapshot</description>
</snapshot>
For including only a sub-set of disks in the snapshots, add disk_attachments element to the request body. Note that disks which are not specified in disk_attachments element will not be a part of the snapshot. If an empty disk_attachments element is passed, the snapshot will include only the virtual machine configuration. If no disk_attachments element is passed, then all the disks will be included in the snapshot.
For each disk, image_id element can be specified for setting the new active image id. This is used in order to restore a chain of images from backup. I.e. when restoring a disk with snapshots, the relevant image_id should be specified for each snapshot (so the identifiers of the disk snapshots are identical to the backup).
When a snapshot is created the default value for the persist_memorystate attribute is true. That means that the content of the memory of the virtual machine will be included in the snapshot, and it also means that the virtual machine will be paused for a longer time. That can negatively affect applications that are very sensitive to timing (NTP servers, for example). In those cases make sure that you set the attribute to false:
<snapshot> <description>My snapshot</description> <persist_memorystate>false</persist_memorystate> </snapshot>
<snapshot>
<description>My snapshot</description>
<persist_memorystate>false</persist_memorystate>
</snapshot>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.187.2. list GET
Returns the list of snapshots of the storage domain or virtual machine.
The order of the returned list of snapshots isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all the attributes of the virtual machine snapshot should be included in the response. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of snapshots to return. | |
|
| Out |
6.187.2.1. all_content
Indicates if all the attributes of the virtual machine snapshot should be included in the response.
By default the attribute initialization.configuration.data is excluded.
For example, to retrieve the complete representation of the virtual machine with id 123 snapshots send a request like this:
GET /ovirt-engine/api/vms/123/snapshots?all_content=true
GET /ovirt-engine/api/vms/123/snapshots?all_content=true6.187.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.187.2.3. max
Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.
6.188. SshPublicKey
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
6.188.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.188.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.188.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.188.3. update PUT
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.189. SshPublicKeys
| Name | Summary |
|---|---|
|
| |
|
| Returns a list of SSH public keys of the user. |
6.189.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.189.2. list GET
Returns a list of SSH public keys of the user.
For example, to retrieve the list of SSH keys of user with identifier 123, send a request like this:
GET /ovirt-engine/api/users/123/sshpublickeys
GET /ovirt-engine/api/users/123/sshpublickeysThe result will be the following XML document:
Or the following JSON object
The order of the returned list of keys is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of keys to return. |
6.189.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.189.2.2. max
Sets the maximum number of keys to return. If not specified all the keys are returned.
6.190. Statistic
| Name | Summary |
|---|---|
|
|
6.190.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.190.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.191. Statistics
| Name | Summary |
|---|---|
|
| Retrieves a list of statistics. |
6.191.1. list GET
Retrieves a list of statistics.
For example, to retrieve the statistics for virtual machine 123 send a request like this:
GET /ovirt-engine/api/vms/123/statistics
GET /ovirt-engine/api/vms/123/statisticsThe result will be like this:
Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
GET /ovirt-engine/api/vms/123/statistics/456
GET /ovirt-engine/api/vms/123/statistics/456Outputs:
The order of the returned list of statistics isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of statistics to return. | |
|
| Out |
6.191.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.191.1.2. max
Sets the maximum number of statistics to return. If not specified all the statistics are returned.
6.192. Step
A service to manage a step.
| Name | Summary |
|---|---|
|
| Marks an external step execution as ended. |
|
| Retrieves a step. |
6.192.1. end POST
Marks an external step execution as ended.
For example, to terminate a step with identifier 456 which belongs to a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/123/steps/456/end
POST /ovirt-engine/api/jobs/123/steps/456/endWith the following request body:
<action> <force>true</force> <succeeded>true</succeeded> </action>
<action>
<force>true</force>
<succeeded>true</succeeded>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the step should be forcibly terminated. | |
|
| In | Indicates if the step should be marked as successfully finished or as failed. |
6.192.1.1. succeeded
Indicates if the step should be marked as successfully finished or as failed.
This parameter is optional, and the default value is true.
6.192.2. get GET
Retrieves a step.
GET /ovirt-engine/api/jobs/123/steps/456
GET /ovirt-engine/api/jobs/123/steps/456You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieves the representation of the step. |
6.192.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.193. Steps
A service to manage steps.
| Name | Summary |
|---|---|
|
| Add an external step to an existing job or to an existing step. |
|
| Retrieves the representation of the steps. |
6.193.1. add POST
Add an external step to an existing job or to an existing step.
For example, to add a step to job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/123/steps
POST /ovirt-engine/api/jobs/123/stepsWith the following request body:
The response should look like:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Step that will be added. |
6.193.2. list GET
Retrieves the representation of the steps.
GET /ovirt-engine/api/job/123/steps
GET /ovirt-engine/api/job/123/stepsYou will receive response in XML like this one:
The order of the returned list of steps isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of steps to return. | |
|
| Out | A representation of steps. |
6.193.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.193.2.2. max
Sets the maximum number of steps to return. If not specified all the steps are returned.
6.194. Storage
| Name | Summary |
|---|---|
|
|
6.194.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates if the status of the LUNs in the storage should be checked. | |
|
| Out |
6.194.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.194.1.2. report_status
Indicates if the status of the LUNs in the storage should be checked. Checking the status of the LUN is an heavy weight operation and this data is not always needed by the user. This parameter will give the option to not perform the status check of the LUNs.
The default is true for backward compatibility.
Here an example with the LUN status :
Here an example without the LUN status :
6.195. StorageDomain
| Name | Summary |
|---|---|
|
| Retrieves the description of the storage domain. |
|
| Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server. |
|
| This operation reduces logical units from the storage domain. |
|
| This operation refreshes the LUN size. |
|
| Removes the storage domain. |
|
| Updates a storage domain. |
|
|
This operation forces the update of the |
6.195.1. get GET
Retrieves the description of the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The description of the storage domain. |
6.195.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.195.2. isattached POST
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server. IMPORTANT: Executing this API will cause the host to disconnect from the storage domain.
6.195.3. reduceluns POST
This operation reduces logical units from the storage domain.
In order to do so the data stored on the provided logical units will be moved to other logical units of the storage domain and only then they will be reduced from the storage domain.
For example, in order to reduce two logical units from a storage domain send a request like this:
POST /ovirt-engine/api/storagedomains/123/reduceluns
POST /ovirt-engine/api/storagedomains/123/reducelunsWith a request body like this:
Note that this operation is only applicable to block storage domains (i.e., storage domains with the <<types/storage_type, storage type> of iSCSI or FCP).
Note that this operation is only applicable to block storage domains (i.e., storage domains with the
<<types/storage_type, storage type> of iSCSI or FCP).| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The logical units that need to be reduced from the storage domain. |
6.195.4. refreshluns POST
This operation refreshes the LUN size.
After increasing the size of the underlying LUN on the storage server, the user can refresh the LUN size. This action forces a rescan of the provided LUNs and updates the database with the new size, if required.
For example, in order to refresh the size of two LUNs send a request like this:
POST /ovirt-engine/api/storagedomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns
POST /ovirt-engine/api/storagedomains/262b056b-aede-40f1-9666-b883eff59d40/refreshlunsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the refresh should be performed asynchronously. | |
|
| In | The LUNs that need to be refreshed. |
6.195.5. remove DELETE
Removes the storage domain.
Without any special parameters, the storage domain is detached from the system and removed from the database. The storage domain can then be imported to the same or to a different setup, with all the data on it. If the storage is not accessible the operation will fail.
If the destroy parameter is true then the operation will always succeed, even if the storage is not accessible, the failure is just ignored and the storage domain is removed from the database anyway.
If the format parameter is true then the actual storage is formatted, and the metadata is removed from the LUN or directory, so it can no longer be imported to the same or to a different setup.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible. | |
|
| In | Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory: [source] ---- DELETE /ovirt-engine/api/storagedomains/123?format=true ----
This parameter is optional, and the default value is | |
|
| In | Indicates which host should be used to remove the storage domain. |
6.195.5.1. destroy
Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible.
DELETE /ovirt-engine/api/storagedomains/123?destroy=true
DELETE /ovirt-engine/api/storagedomains/123?destroy=true
This parameter is optional, and the default value is false. When the value of destroy is true the host parameter will be ignored.
6.195.5.2. host
Indicates which host should be used to remove the storage domain.
This parameter is mandatory, except if the destroy parameter is included and its value is true, in that case the host parameter will be ignored.
The value should contain the name or the identifier of the host. For example, to use the host named myhost to remove the storage domain with identifier 123 send a request like this:
DELETE /ovirt-engine/api/storagedomains/123?host=myhost
DELETE /ovirt-engine/api/storagedomains/123?host=myhost6.195.6. update PUT
Updates a storage domain.
Not all of the StorageDomain's attributes are updatable after creation. Those that can be updated are: name, description, comment, warning_low_space_indicator, critical_space_action_blocker and wipe_after_delete. (Note that changing the wipe_after_delete attribute will not change the wipe after delete property of disks that already exist).
To update the name and wipe_after_delete attributes of a storage domain with an identifier 123, send a request as follows:
PUT /ovirt-engine/api/storagedomains/123
PUT /ovirt-engine/api/storagedomains/123With a request body as follows:
<storage_domain> <name>data2</name> <wipe_after_delete>true</wipe_after_delete> </storage_domain>
<storage_domain>
<name>data2</name>
<wipe_after_delete>true</wipe_after_delete>
</storage_domain>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The updated storage domain. |
6.195.7. updateovfstore POST
This operation forces the update of the OVF_STORE of this storage domain.
The OVF_STORE is a disk image that contains the metadata of virtual machines and disks that reside in the storage domain. This metadata is used in case the domain is imported or exported to or from a different data center or a different installation.
By default the OVF_STORE is updated periodically (set by default to 60 minutes) but users might want to force an update after an important change, or when the they believe the OVF_STORE is corrupt.
When initiated by the user, OVF_STORE update will be performed whether an update is needed or not.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the |
6.196. StorageDomainContentDisk
| Name | Summary |
|---|---|
|
|
6.196.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.196.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.197. StorageDomainContentDisks
Manages the set of disks available in a storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of disks available in the storage domain. |
6.197.1. list GET
Returns the list of disks available in the storage domain.
The order of the returned list of disks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. | |
|
| In | A query string used to restrict the returned disks. |
6.197.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.197.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.197.1.3. max