Introduction

1. Introduction

The oVirt Engine provides a Representational State Transfer (REST) API. The API provides software developers and system administrators with control over their oVirt environment outside of the standard web interface. The API is useful for developers and administrators to integrate the functionality of a oVirt 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 oVirt environment with scripts.

This documentation acts as a reference for the oVirt API. It aims to provide developers and administrators with instructions and examples to help harness the functionality of their oVirt 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 oVirt API:

A networked installation of oVirt Engine, 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.

2. Authentication and Security

2.1. TLS/SSL Certification

The oVirt 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 oVirt Engine 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_client command 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

This command will connect to the server and display output similar to the following:

CONNECTED(00000003)
depth=1 C = US, O = Example Inc., CN = myengine.example.com.23416
verify error:num=19:self signed certificate in certificate chain
---
Certificate chain
 0 s:/C=US/O=Example Inc./CN=myengine.example.com
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIEaTCCA1GgAwIBAgICEAQwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
SVlJe7e5FTEtHJGTAeWWM6dGbsFhip5VXM0gfqg=
-----END CERTIFICATE-----
 1 s:/C=US/O=Example Inc./CN=myengine.example.com.23416
   i:/C=US/O=Example Inc./CN=myengine.example.com.23416
-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----

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 the ca.crt file. The result should look like this:

This 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_client method described above, you can instead use a command line tool to download the CA certificate from the oVirt Engine.

Examples of command line tools include curl and wget, 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'

If using wget:

$ wget \
--output-document ca.crt \
'http://myengine.example.com/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA'

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

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.

Method 4

Log in to the oVirt Engine machine as root.
Export the certificate from the truststore using the Java keytool management utility:
```
# keytool \
-keystore /etc/pki/ovirt-engine/.truststore \
-storepass mypass \
-exportcert \
-alias cacert \
-rfc \
-file ca.crt
```
This creates a certificate file called ca.crt.
Copy the certificate to the client machine using the scp command:
```
$ scp ca.crt myuser@myclient.example.com:/home/myuser/.
```

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 oVirt Engine 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 oVirt 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 oVirt 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 oVirt Engine 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

The request body must contain the grant_type, scope, username, and password parameters:

Table 1. OAuth token request parameters
Name	Value
`grant_type`	`password`
`scope`	`ovirt-app-api`
`username`	`admin@internal`
`password`	`mypassword`

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

The scope parameter is described as optional in the OAuth RFC, but when using it with the oVirt API it is mandatory, and its value must be ovirt-app-api.

If the user name and password are valid, the oVirt Engine single sign-on service will respond with a JSON document similar to this one:

{
  "access_token": "fqbR1ftzh8wBCviLxJcYuV5oSDI=",
  "token_type": "bearer",
  "scope": "...",
  ...
}

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=

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

When this happens, a new token is needed, as the oVirt Engine 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 oVirt, 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

Request are issued with an Authorization header for the specified realm. Encode an appropriate oVirt Engine domain and user in the supplied credentials with the username@domain:password convention.

The following table shows the process for encoding credentials in Base64.

Table 2. Encoding credentials for API access
Item	Value
User name	`admin`
Domain	`internal`
Password	`mypassword`
Unencoded credentials	`admin@internal:mypassword`
Base64 encoded credentials	`YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==`

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

Basic 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.

Requesting an Authenticated Session

Send a request with the Authorization and Prefer: persistent-auth headers:

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==
Prefer: persistent-auth

HTTP/1.1 200 OK
...

This returns a response with the following header:

Set-Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK; Path=/ovirt-engine/api; Secure

Take note of the JSESSIONID= value. In this example the value is 5dQja5ubr4yvI2MM2z+LZxrK.

Send all subsequent requests with the Prefer: persistent-auth and Cookie headers with the JSESSIONID= value. The Authorization header is no longer needed when using an authenticated session.
```
HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Prefer: persistent-auth
Cookie: JSESSIONID=5dQja5ubr4yvI2MM2z+LZxrK

HTTP/1.1 200 OK
...
```

When the session is no longer required, perform a request to the sever without the Prefer: persistent-auth header.

HEAD /ovirt-engine/api HTTP/1.1
Host: myengine.example.com
Authorization: Basic YWRtaW5AaW50ZXJuYWw6bXlwYXNzd29yZA==

HTTP/1.1 200 OK
...

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:

Primitive types: Describe simple kinds of objects, like strings or integers.
Enumerated types: Describe lists of valid values like VmStatus or DiskFormat.
Structured types: Describe structured objects, with multiple attributes and links, like Vm or Disk.

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

Attribute	Type	Description
`id`	String	Each object in the virtualization infrastructure contains an `id`, which acts as an unique identifier.
`href`	String	The canonical location of the object as an absolute path.
`name`	String	A user-supplied human readable name for the object. The `name` name is unique across all objects of the same type.
`description`	String	A free-form user-supplied human readable description of the object.

id

String

Each object in the virtualization infrastructure contains an id, which acts as an unique identifier.

href

String

The canonical location of the object as an absolute path.

name

String

A user-supplied human readable name for the object. The name name is unique across all objects of the same type.

description

String

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:

<vm id="123" href="/ovirt-engine/api/vms/123">
  <name>myvm</name>
  <description>My VM</description>
  <memory>1073741824</memory>
  ...
</vm>

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:

<vms>
  <vm id="123" href="/ovirt-engine/api/vms/123">
    <name>yourvm</name>
    <description>Your VM</description>
    <memory>1073741824</memory>
    ...
  </vm>
  <vm id="456" href="/ovirt-engine/api/vms/456">
    <name>myname</name>
    <description>My description</description>
    <memory>2147483648</memory>
    ...
  </vm>
  ...
</vms>

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:

{
  "id": "123",
  "href": "/ovirt-engine/api/vms/123",
  "name": "myvm",
  "description": "My VM",
  "memory": 1073741824,
  ...
}

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:

{
  "vm": [
    {
      "id": "123",
      "href": "/ovirt-engine/api/vms/123",
      "name": "myvm",
      "description": "My VM",
      "memory": 1073741824,
      ...
    },
    {
      "id": "456",
      "href": "/ovirt-engine/api/vms/456",
      "name": "yourvm",
      "description": "Your VM",
      "memory": 2147483648,
      ...
    },
  ]
}

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

Method name	HTTP method
`add`	POST
`get`	GET
`list`	GET
`update`	PUT
`remove`	DELETE

add

POST

get

GET

list

GET

update

PUT

remove

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

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

Each 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, list and update methods, 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:

POST /ovirt-engine/api/vms HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

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:

HTTP/1.1 201 Created
Content-Type: application/xml

<vm href="/ovirt-engine/api/vms/123" id="123">
  <name>myvm</name>
  <description>My VM</description>
  ...
</vm>

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:

POST /ovirt-engine/api/vms?clone=true HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
</vm>

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:

POST /ovirt-engine/api/vms/123/start HTTP/1.1
Host: myengine.example.com
Authorization: Bearer fqbR1ftzh8wBCviLxJcYuV5oSDI=
Content-Type: application/xml
Accept: application/xml

<action>
  <use_cloud_init>true</use_cloud_init>
  <vm>
    <initialization>
      <nic_configurations>
        <nic_configuration>
          <name>eth0</name>
          <on_boot>true</on_boot>
          <boot_protocol>static</boot_protocol>
          <ip>
            <address>192.168.0.100</address>
            <netmask>255.255.255.0</netmask>
            <gateway>192.168.0.1</netmask>
          </ip>
        </nic_configuration>
      </nic_configurations>
      <dns_servers>192.168.0.1</dns_servers>
    </initialization>
  </vm>
</action>

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

3.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

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

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

3.7.3. Search syntax

The search parameters use the same syntax as the oVirt query language:

(criteria) [sortby (element) asc|desc]

The sortby clause is optional and only needed when ordering results.

Example search queries:

Collection Criteria Result

Collection	Criteria	Result
`hosts`	`vms.status=up`	Returns a list of all hosts running virtual machines that are `up`.
`vms`	`domain=example.com`	Returns a list of all virtual machines running on the specified domain.
`vms`	`users.name=mary`	Returns a list of all virtual machines belonging to users with the user name `mary`.
`events`	`severity > normal sortby time`	Returns a list of all events with severity higher than `normal` and sorted by the the value of their `time` attribute.
`events`	`severity > normal sortby time desc`	Returns a list of all events with severity higher than `normal` and sorted by the the value of their `time` attribute in descending order.

hosts

vms.status=up

Returns a list of all hosts running virtual machines that are up.

vms

domain=example.com

Returns a list of all virtual machines running on the specified domain.

vms

users.name=mary

Returns a list of all virtual machines belonging to users with the user name mary.

events

severity > normal sortby time

Returns a list of all events with severity higher than normal and sorted by the the value of their time attribute.

events

severity > normal sortby time desc

Returns a list of all events with severity higher than normal and sorted by the the value of their time attribute in descending order.

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

3.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*

3.7.5. Pagination

Some oVirt 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

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

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

The 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. 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

The response body will look like this:

<permissions>
  <permission id="456" href="/ovirt-engien/api/vms/123/permissions/456">
    <user id="789" href="/ovirt-engine/api/users/789"/>
    <role id="abc" href="/ovirt-engine/api/roles/abc"/>
    <vm id="123" href="/ovirt-engine/api/vms/123"/>
  </permission>
  ...
</permissions>

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.9. 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

And the following response body:

<fault>
  <reason>Incomplete parameters</reason>
  <detail>Vm [name] required for add</detail>
</fault>

4. Quick start example

This chapter provides an example to demonstrate the REST API’s ability to setup a basic oVirt environment and create a virtual machine. In addition to the standard prerequisites, this example requires the following:

A networked and configured oVirt installation;
An ISO file containing a desired virtual machine operating system to install. This chapter uses CentOS 7 for our installation ISO example; and
oVirt’s engine-iso-uploader tool to upload your chosen operating system ISO file.

This example uses curl to demonstrate API requests with a client application. Note that any application capable of HTTP requests can substitute for curl.

For simplicity, 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 oVirt.

All the curl examples use admin@internal as the user name, mypassword as the password, /etc/pki/ovirt-engine/ca.pem as the certificate location and myengine.example.com as the host name. These are just examples, Make sure to replace them with valid values for your environment.

oVirt generates an unique identifier for the id attribute for each resource. Identifier codes in this example might appear different to the identifier codes in your oVirt environment.

In many examples of this section some of the attributes of results returned by the API have been omitted, to make them shorter. You can always use the reference to find the complete list of attributes. For example, if you want to see the complete list of attributes of the Cluster type, just go here.

4.1. Example: Access API entry point

The following request retrieves a representation of the main entry point for version 4 of of the API:

GET /ovirt-engine/api HTTP/1.1
Version: 4
Accept: application/xml

Same request, but using the /v4 URL prefix instead of the Version header:

GET /ovirt-engine/api/v4 HTTP/1.1
Accept: application/xml

Same request, using the curl command:

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api

The result will be an object of type Api:

<api>
  <link href="/ovirt-engine/api/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters" rel="datacenters"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.0.0-0.0.el7</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="..." id="..."/>
    <root_tag href="..." id="..."/>
  </special_objects>
  <summary>
    <hosts>
      <active>23</active>
      <total>30</total>
    </hosts>
    <storage_domains>
      <active>5</active>
      <total>6</total>
    </storage_domains>
    <users>
      <active>12</active>
      <total>102</total>
    </users>
    <vms>
      <active>253</active>
      <total>545</total>
    </vms>
  </summary>
  <time>2016-10-06T15:38:18.548+02:00</time>
</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

Changing 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. Example: List data centers

oVirt creates a Default data center on installation. This example uses the Default data center as the basis for our virtual environment.

The following request retrieves a representation of the data centers:

GET /ovirt-engine/api/datacenters HTTP/1.1
Accept: application/xml

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/datacenters

The result will be a list of objects of type DataCenter:

<data_centers>
  <data_center href="/ovirt-engine/api/datacenters/001" id="001">
    <name>Default</name>
    <description>The default Data Center</description>
    <link href="/ovirt-engine/api/datacenters/001/clusters" rel="clusters"/>
    <link href="/ovirt-engine/api/datacenters/001/storagedomains" rel="storagedomains"/>
    ...
    <local>false</local>
    <quota_mode>disabled</quota_mode>
    <status>up</status>
    <supported_versions>
      <version>
        <major>4</major>
        <minor>0</minor>
      </version>
    </supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </data_center>
  ...
</data_centers>

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"/>

That service is used to attach storage domains from the main storagedomains collection, which this example covers later.

4.3. Example: List host clusters

oVirt creates a Default hosts cluster on installation. This example uses the Default cluster to group resources in your oVirt environment.

The following request retrieves a representation of the cluster collection:

GET /ovirt-engine/api/clusters HTTP/1.1
Accept: application/xml

Same request, using the curl command:

curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/clusters

The result will be a list of objects of type Cluster:

<clusters>
  <cluster href="/ovirt-engine/api/clusters/002" id="002">
    <name>Default</name>
    <description>The default server cluster</description>
    <link href="/ovirt-engine/api/clusters/002/networks" rel="networks"/>
    <link href="/ovirt-engine/api/clusters/002" rel="permissions"/>
    ...
    <cpu>
      <architecture>x86_64</architecture>
      <type>Intel Conroe Family</type>
    </cpu>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </cluster>
  ...
</clusters>

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"/>

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. Example: List logical networks

oVirt creates a default ovirtmgmt network on installation. This network acts as the management network for oVirt Engine to access hosts.

This network is associated with our Default cluster and is a member of the Default data center. This example uses the ovirtmgmt network to connect our virtual machines.

The following request retrieves the list of logical networks:

GET /ovirt-engine/api/networks HTTP/1.1
Accept: application/xml

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/networks

The result will be a list of objects of type Network:

<networks>
  <network href="/ovirt-engine/api/networks/003" id="003">
    <name>ovirtmgmt</name>
    <description>Management Network</description>
    <link href="/ovirt-engine/api/networks/003/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/003/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/003/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/001" id="001"/>
  </network>
  ...
</networks>

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. Example: 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

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
--user 'admin@internal:mypassword' \
https://myengine.example.com/ovirt-engine/api/hosts

The result will be a list of objects of type Host:

<hosts>
  <host href="/ovirt-engine/api/hosts/004" id="004">
    <name>myhost</name>
    <link href="/ovirt-engine/api/hosts/004/nics" rel="nics"/>
    ...
    <address>node40.example.com</address>
    <cpu>
      <name>Intel Core Processor (Haswell, no TSX)</name>
      <speed>3600</speed>
      <topology>
        <cores>1</cores>
        <sockets>2</sockets>
        <threads>1</threads>
      </topology>
    </cpu>
    <memory>8371830784</memory>
    <os>
      <type>RHEL</type>
      <version>
        <full_version>7 - 2.1511.el7.centos.2.10</full_version>
        <major>7</major>
      </version>
    </os>
    <port>54321</port>
    <status>up</status>
    <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  </host>
  ...
</hosts>

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. Example: 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

And the request body should be like this:

<storage_domain>
  <name>mydata</name>
  <type>data</type>
  <description>My data</description>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

The same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
  <description>My data</description>
  <type>data</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

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):

<storage_domain href="/ovirt-engine/api/storagedomains/005" id="005">
  <name>mydata</name>
  <description>My data</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>9663676416</used>
</storage_domain>

4.7. Example: 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

And the request body should be like this:

<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

The same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
  <description>My ISOs</description>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/storagedomains

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):

<storage_domain href="/ovirt-engine/api/storagedomains/006" id="006">
  <name>myiso</name>
  <description>My ISOs</description>
  <available>42949672960</available>
  <committed>0</committed>
  <master>false</master>
  <status>unattached</status>
  <storage>
    <address>mynfs.example.com</address>
    <path>/exports/myisos</path>
    <type>nfs</type>
  </storage>
  <storage_format>v1</storage_format>
  <type>iso</type>
  <used>9663676416</used>
</storage_domain>

4.8. Example: 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

With a request body like this:

<storage_domain>
  <name>mydata</name>
</storage_domain>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>mydata</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

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

With a request body like this:

<storage_domain>
  <name>myisos</name>
</storage_domain>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<storage_domain>
  <name>myisos</name>
</storage_domain>
' \
https://myengine.example.com/ovirt-engine/api/datacenters/001/storagedomains

4.9. Example: 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

And the request body should be like this:

<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<vm>
  <name>myvm</name>
  <description>My VM</description>
  <cluster>
    <name>Default</name>
  </cluster>
  <template>
    <name>Blank</name>
  </template>
  <memory>536870912</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
</vm>
' \
https://myengine.example.com/ovirt-engine/api/vms

The response body will be an object of the Vm type:

<vm href="/ovirt-engine/api/vms/007" id="007">
  <name>myvm</name>
  <link href="/ovirt-engine/api/vms/007/diskattachments" rel="diskattachments"/>
  <link href="/ovirt-engine/api/vms/007/nics" rel="nics"/>
  ...
  <cpu>
    <architecture>x86_64</architecture>
    <topology>
      <cores>1</cores>
      <sockets>1</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <memory>1073741824</memory>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
    <type>other</type>
  </os>
  <type>desktop</type>
  <cluster href="/ovirt-engine/api/clusters/002" id="002"/>
  <status>down</status>
  <original_template href="/ovirt-engine/api/templates/000" id="00"/>
  <template href="/ovirt-engine/api/templates/000" id="000"/>
</vm>

4.10. Example: 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

The 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>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<nic>
  <name>mynic</name>
  <description>My network interface card</description>
</nic>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/nics

4.11. Example: 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

The request body should be an object of type DiskAttachment describing the disk and how it will be attached to the virtual machine:

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <active>true</active>
  <disk>
    <description>My disk</description>
    <format>cow</format>
    <name>mydisk</name>
    <provisioned_size>8589934592</provisioned_size>
    <storage_domains>
      <storage_domain>
        <name>mydata</name>
      </storage_domain>
    </storage_domains>
  </disk>
</disk_attachment>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/diskattachments

The storage_domains attribute tells the API to store the disk on the mydata storage domain.

4.12. Example: Attach ISO image to virtual machine

The boot media for our example virtual machine requires an CD-ROM or DVD ISO image for an operating system installation. This example uses a CentOS 7 image for installation.

ISO images must be available in the myisos ISO domain for the virtual machines to use. oVirt provides an uploader tool that ensures that the ISO images are uploaded into the correct directory path with the correct user permissions.

Once the ISO 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

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request GET \
--header 'Version: 4' \
--header 'Accept: application/xml' \
https://myengine.example.com/ovirt-engine/api/storagedomains/006/files

The server returns the following list of objects of type File, one for each available ISO (or floppy) image:

<files>
  <file href="..." id="CentOS-7-x86_64-Minimal.iso">
    <name>CentOS-7-x86_64-Minimal.iso</name>
  </file>
  ...
</files>

An API user attaches the CentOS-7-x86_64-Minimal.iso to our 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

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>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request PUT \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<cdrom>
  <file id="CentOS-7-x86_64-Minimal.iso"/>
</cdrom>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/cdroms/00000000-0000-0000-0000-000000000000

For more details see the documentation of the service that manages virtual machine CD-ROMS.

4.13. Example: 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

The request body should be like this:

<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>

Same request, using the curl command:

# curl \
--cacert '/etc/pki/ovirt-engine/ca.pem' \
--user 'admin@internal:mypassword' \
--request POST \
--header 'Version: 4' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--data '
<action>
  <vm>
    <os>
      <boot>
        <devices>
          <device>cdrom</device>
        </devices>
      </boot>
    </os>
  </vm>
</action>
' \
https://myengine.example.com/ovirt-engine/api/vms/007/start

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.

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}/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 /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}/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}/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
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}/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
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}/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
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}/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}/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}
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
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}/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}
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
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}/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}

6. Services

This section enumerates all the services that are available in the API.

6.1. AffinityGroup

This service manages a single affinity group.

Table 3. Methods summary
Name	Summary
`get`	Retrieve the affinity group details.
`remove`	Remove the affinity group.
`update`	Update the affinity group.

6.1.1. get GET

Retrieve the affinity group details.

<affinity_group id="00000000-0000-0000-0000-000000000000">
  <name>AF_GROUP_001</name>
  <cluster id="00000000-0000-0000-0000-000000000000"/>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>

Table 4. Parameters summary
Name	Type	Direction	Summary
`group`	AffinityGroup	Out	The affinity group.

6.1.2. remove DELETE

Remove the affinity group.

DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456

Table 5. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the removal should be performed asynchronously.

6.1.3. update PUT

Update the affinity group.

Table 6. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`group`	AffinityGroup	In/Out	The affinity group.

6.2. AffinityGroupVm

This service manages a single virtual machine to affinity group assignment.

Table 7. Methods summary
Name	Summary
`remove`	Remove this virtual machine from the affinity group.

6.2.1. remove DELETE

Remove this virtual machine from the affinity group.

Table 8. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	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.

Table 9. Methods summary
Name	Summary
`add`	Adds a virtual machine to the affinity group.
`list`	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

With the following body:

<vm id="789"/>

Table 10. Parameters summary
Name	Type	Direction	Summary
`vm`	Vm	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.

Table 11. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of virtual machines to return.
`vms`	Vm[]	Out

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.

Table 12. Methods summary
Name	Summary
`add`	Create a new affinity group.
`list`	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

And use the following example in its body:

<affinity_group>
  <name>AF_GROUP_001</name>
  <hosts_rule>
    <enforcing>true</enforcing>
    <positive>true</positive>
  </hosts_rule>
  <vms_rule>
    <enabled>false</enabled>
  </vms_rule>
</affinity_group>

Table 13. Parameters summary
Name	Type	Direction	Summary
`group`	AffinityGroup	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.

Table 14. Parameters summary
Name	Type	Direction	Summary
`groups`	AffinityGroup[]	Out	The list of existing affinity groups.
`max`	Integer	In	Sets the maximum number of affinity groups to return.

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.

Table 15. Methods summary
Name	Summary
`get`	Retrieves the details of a label.
`remove`	Removes a label from the system and clears all assignments of the removed label.
`update`	Updates a label.

6.5.1. get GET

Retrieves the details of a label.

Table 16. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel	Out

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.

Table 17. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel	In/Out

6.6. AffinityLabelHost

This service represents a host that has a specific label when accessed through the affinitylabels/hosts subcollection.

Table 18. Methods summary
Name	Summary
`get`	Retrieves details about a host that has this label assigned.
`remove`	Remove a label from a host.

6.6.1. get GET

Retrieves details about a host that has this label assigned.

Table 19. Parameters summary
Name	Type	Direction	Summary
`host`	Host	Out

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.

Table 20. Methods summary
Name	Summary
`add`	Add a label to a host.
`list`	List all hosts with the label.

6.7.1. add POST

Add a label to a host.

Table 21. Parameters summary
Name	Type	Direction	Summary
`host`	Host	In/Out

6.7.2. list GET

List all hosts with the label.

The order of the returned hosts isn’t guaranteed.

Table 22. Parameters summary
Name	Type	Direction	Summary
`hosts`	Host[]	Out

6.8. AffinityLabelVm

This service represents a vm that has a specific label when accessed through the affinitylabels/vms subcollection.

Table 23. Methods summary
Name	Summary
`get`	Retrieves details about a vm that has this label assigned.
`remove`	Remove a label from a vm.

6.8.1. get GET

Retrieves details about a vm that has this label assigned.

Table 24. Parameters summary
Name	Type	Direction	Summary
`vm`	Vm	Out

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.

Table 25. Methods summary
Name	Summary
`add`	Add a label to a vm.
`list`	List all virtual machines with the label.

6.9.1. add POST

Add a label to a vm.

Table 26. Parameters summary
Name	Type	Direction	Summary
`vm`	Vm	In/Out

6.9.2. list GET

List all virtual machines with the label.

The order of the returned virtual machines isn’t guaranteed.

Table 27. Parameters summary
Name	Type	Direction	Summary
`vms`	Vm[]	Out

6.10. AffinityLabels

Manages the affinity labels available in the system.

Table 28. Methods summary
Name	Summary
`add`	Creates a new label.
`list`	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.

Table 29. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel	In/Out

6.10.2. list GET

Lists all labels present in the system.

The order of the returned labels isn’t guaranteed.

Table 30. Parameters summary
Name	Type	Direction	Summary
`labels`	AffinityLabel[]	Out
`max`	Integer	In	Sets the maximum number of labels to return.

max

Sets the maximum number of labels to return. If not specified all the labels are returned.

6.11. AssignedAffinityLabel

This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection.

Table 31. Methods summary
Name	Summary
`get`	Retrieves details about the attached label.
`remove`	Removes the label from an entity.

6.11.1. get GET

Retrieves details about the attached label.

Table 32. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel	Out

6.11.2. remove DELETE

Removes the label from an entity. Does not touch the label itself.

6.12. AssignedAffinityLabels

This service is used to list and manipulate affinity labels that are assigned to supported entities when accessed using entities/affinitylabels.

Table 33. Methods summary
Name	Summary
`add`	Attaches a label to an entity.
`list`	Lists all labels that are attached to an entity.

6.12.1. add POST

Attaches a label to an entity.

Table 34. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel	In/Out

6.12.2. list GET

Lists all labels that are attached to an entity.

The order of the returned entities isn’t guaranteed.

Table 35. Parameters summary
Name	Type	Direction	Summary
`label`	AffinityLabel[]	Out

6.13. AssignedCpuProfile

Table 36. Methods summary
Name	Summary
`get`
`remove`

6.13.1. get GET

Table 37. Parameters summary
Name	Type	Direction	Summary
`profile`	CpuProfile	Out

6.13.2. remove DELETE

Table 38. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.14. AssignedCpuProfiles

Table 39. Methods summary
Name	Summary
`add`
`list`	List the CPU profiles assigned to the cluster.

6.14.1. add POST

Table 40. Parameters summary
Name	Type	Direction	Summary
`profile`	CpuProfile	In/Out

6.14.2. list GET

List the CPU profiles assigned to the cluster.

The order of the returned CPU profiles isn’t guaranteed.

Table 41. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of profiles to return.
`profiles`	CpuProfile[]	Out

max

Sets the maximum number of profiles to return. If not specified all the profiles are returned.

6.15. AssignedDiskProfile

Table 42. Methods summary
Name	Summary
`get`
`remove`

6.15.1. get GET

Table 43. Parameters summary
Name	Type	Direction	Summary
`disk_profile`	DiskProfile	Out

6.15.2. remove DELETE

Table 44. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.16. AssignedDiskProfiles

Table 45. Methods summary
Name	Summary
`add`
`list`	Returns the list of disk profiles assigned to the storage domain.

6.16.1. add POST

Table 46. Parameters summary
Name	Type	Direction	Summary
`profile`	DiskProfile	In/Out

6.16.2. list GET

Returns the list of disk profiles assigned to the storage domain.

The order of the returned disk profiles isn’t guaranteed.

Table 47. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of profiles to return.
`profiles`	DiskProfile[]	Out

max

Sets the maximum number of profiles to return. If not specified all the profiles are returned.

6.17. AssignedPermissions

Represents a permission sub-collection, scoped by user, group or some entity type.

Table 48. Methods summary
Name	Summary
`add`	Assign a new permission to a user or group for specific entity.
`list`	List all the permissions of the specific entity.

6.17.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

With a request body like this:

<permission>
  <role>
    <name>UserVmManager</name>
  </role>
  <user id="456"/>
</permission>

To assign the SuperUser role to the system to the user with id 456 send a request like this:

POST /ovirt-engine/api/permissions

With a request body like this:

<permission>
  <role>
    <name>SuperUser</name>
  </role>
  <user id="456"/>
</permission>

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

With a request body like this:

<permission>
  <role>
    <name>UserRole</name>
  </role>
  <group id="789"/>
</permission>

Table 49. Parameters summary
Name	Type	Direction	Summary
`permission`	Permission	In/Out	The permission.

6.17.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

<permissions>
  <permission id="456">
    <cluster id="123"/>
    <role id="789"/>
    <user id="451"/>
  </permission>
  <permission id="654">
    <cluster id="123"/>
    <role id="789"/>
    <group id="127"/>
  </permission>
</permissions>

The order of the returned permissions isn’t guaranteed.

Table 50. Parameters summary
Name	Type	Direction	Summary
`permissions`	Permission[]	Out	The list of permissions.

6.18. AssignedRoles

Represents a roles sub-collection, for example scoped by user.

Table 51. Methods summary
Name	Summary
`list`	Returns the roles assigned to the permission.

6.18.1. list GET

Returns the roles assigned to the permission.

The order of the returned roles isn’t guaranteed.

Table 52. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of roles to return.
`roles`	Role[]	Out

max

Sets the maximum number of roles to return. If not specified all the roles are returned.

6.19. AssignedTag

A service to manage assignment of specific tag to specific entities in system.

Table 53. Methods summary
Name	Summary
`get`	Gets the information about the assigned tag.
`remove`	Unassign tag from specific entity in the system.

6.19.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

<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>

Table 54. Parameters summary
Name	Type	Direction	Summary
`tag`	Tag	Out	The assigned tag.

6.19.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

Table 55. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.20. AssignedTags

A service to manage collection of assignment of tags to specific entities in system.

Table 56. Methods summary
Name	Summary
`add`	Assign tag to specific entity in the system.
`list`	List all tags assigned to the specific entity.

6.20.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

With a request body like this:

<tag>
  <name>mytag</name>
</tag>

Table 57. Parameters summary
Name	Type	Direction	Summary
`tag`	Tag	In/Out	The assigned tag.

6.20.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

<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>mytag</name>
    <description>mytag</description>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </tag>
</tags>

The order of the returned tags isn’t guaranteed.

Table 58. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of tags to return.
`tags`	Tag[]	Out	The list of assigned tags.

max

Sets the maximum number of tags to return. If not specified all the tags are returned.

6.21. AssignedVnicProfile

Table 59. Methods summary
Name	Summary
`get`
`remove`

6.21.1. get GET

Table 60. Parameters summary
Name	Type	Direction	Summary
`profile`	VnicProfile	Out

6.21.2. remove DELETE

Table 61. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.22. AssignedVnicProfiles

Table 62. Methods summary
Name	Summary
`add`
`list`	Returns the list of VNIC profiles assifned to the network.

6.22.1. add POST

Table 63. Parameters summary
Name	Type	Direction	Summary
`profile`	VnicProfile	In/Out

6.22.2. list GET

Returns the list of VNIC profiles assifned to the network.

The order of the returned VNIC profiles isn’t guaranteed.

Table 64. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of profiles to return.
`profiles`	VnicProfile[]	Out

max

Sets the maximum number of profiles to return. If not specified all the profiles are returned.

6.23. AttachedStorageDomain

Table 65. Methods summary
Name	Summary
`activate`	This operation activates an attached storage domain.
`deactivate`	This operation deactivates an attached storage domain.
`get`
`remove`

6.23.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

The activate action does not take any action specific parameters, so the request body should contain an empty action:

<action/>

Table 66. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the activation should be performed asynchronously.

6.23.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.

POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate

The deactivate action does not take any action specific parameters, so the request body should contain an empty action:

<action/>

Table 67. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the deactivation should be performed asynchronously.

6.23.3. get GET

Table 68. Parameters summary
Name	Type	Direction	Summary
`storage_domain`	StorageDomain	Out

6.23.4. remove DELETE

Table 69. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.24. AttachedStorageDomains

Manages the storage domains attached to a data center.

Table 70. Methods summary
Name	Summary
`add`	Attaches an existing storage domain to the data center.
`list`	Returns the list of storage domains attached to the data center.

6.24.1. add POST

Attaches an existing storage domain to the data center.

Table 71. Parameters summary
Name	Type	Direction	Summary
`storage_domain`	StorageDomain	In/Out

6.24.2. list GET

Returns the list of storage domains attached to the data center.

The order of the returned storage domains isn’t guaranteed.

Table 72. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of storage domains to return.
`storage_domains`	StorageDomain[]	Out

max

Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.

6.25. Balance

Table 73. Methods summary
Name	Summary
`get`
`remove`

6.25.1. get GET

Table 74. Parameters summary
Name	Type	Direction	Summary
`balance`	Balance	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.

6.25.2. remove DELETE

Table 75. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.26. Balances

Table 76. Methods summary
Name	Summary
`add`
`list`	Returns the list of balance modules used by the scheduling policy.

6.26.1. add POST

Table 77. Parameters summary
Name	Type	Direction	Summary
`balance`	Balance	In/Out

6.26.2. list GET

Returns the list of balance modules used by the scheduling policy.

The order of the returned balance modules isn’t guaranteed.

Table 78. Parameters summary
Name	Type	Direction	Summary
`balances`	Balance[]	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`max`	Integer	In	Sets the maximum number of balances to return.

max

Sets the maximum number of balances to return. If not specified all the balances are returned.

6.27. Bookmark

A service to manage a bookmark.

Table 79. Methods summary
Name	Summary
`get`	Get a bookmark.
`remove`	Remove a bookmark.
`update`	Update a bookmark.

6.27.1. get GET

Get a bookmark.

An example for getting a bookmark:

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>

Table 80. Parameters summary
Name	Type	Direction	Summary
`bookmark`	Bookmark	Out	The requested bookmark.

6.27.2. remove DELETE

Remove a bookmark.

An example for removing a bookmark:

DELETE /ovirt-engine/api/bookmarks/123

Table 81. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.27.3. update PUT

Update a bookmark.

An example for updating a bookmark:

PUT /ovirt-engine/api/bookmarks/123

With the request body:

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

Table 82. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`bookmark`	Bookmark	In/Out	The updated bookmark.

6.28. Bookmarks

A service to manage bookmarks.

Table 83. Methods summary
Name	Summary
`add`	Adding a new bookmark.
`list`	Listing all the available bookmarks.

6.28.1. add POST

Adding a new bookmark.

Example of adding a bookmark:

POST /ovirt-engine/api/bookmarks

<bookmark>
  <name>new_example_vm</name>
  <value>vm: name=new_example*</value>
</bookmark>

Table 84. Parameters summary
Name	Type	Direction	Summary
`bookmark`	Bookmark	In/Out	The added bookmark.

6.28.2. list GET

Listing all the available bookmarks.

Example of listing bookmarks:

GET /ovirt-engine/api/bookmarks

<bookmarks>
  <bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
    <name>database</name>
    <value>vm: name=database*</value>
  </bookmark>
  <bookmark href="/ovirt-engine/api/bookmarks/456" id="456">
    <name>example</name>
    <value>vm: name=example*</value>
  </bookmark>
</bookmarks>

The order of the returned bookmarks isn’t guaranteed.

Table 85. Parameters summary
Name	Type	Direction	Summary
`bookmarks`	Bookmark[]	Out	The list of available bookmarks.
`max`	Integer	In	Sets the maximum number of bookmarks to return.

max

Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.

6.29. Cluster

A service to manage specific cluster.

Table 86. Methods summary
Name	Summary
`get`	Get information about the cluster.
`remove`	Removes cluster from the system.
`resetemulatedmachine`
`update`	Updates information about the cluster.

6.29.1. get GET

Get information about the cluster.

An example of getting a cluster:

GET /ovirt-engine/api/clusters/123

<cluster href="/ovirt-engine/api/clusters/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/clusters/123/resetemulatedmachine" rel="resetemulatedmachine"/>
  </actions>
  <name>Default</name>
  <description>The default server cluster</description>
  <link href="/ovirt-engine/api/clusters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/clusters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/clusters/123/glustervolumes" rel="glustervolumes"/>
  <link href="/ovirt-engine/api/clusters/123/glusterhooks" rel="glusterhooks"/>
  <link href="/ovirt-engine/api/clusters/123/affinitygroups" rel="affinitygroups"/>
  <link href="/ovirt-engine/api/clusters/123/cpuprofiles" rel="cpuprofiles"/>
  <ballooning_enabled>false</ballooning_enabled>
  <cpu>
    <architecture>x86_64</architecture>
    <type>Intel Penryn Family</type>
  </cpu>
  <error_handling>
    <on_error>migrate</on_error>
  </error_handling>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
  </fencing_policy>
  <gluster_service>false</gluster_service>
  <ha_reservation>false</ha_reservation>
  <ksm>
    <enabled>true</enabled>
    <merge_across_nodes>true</merge_across_nodes>
  </ksm>
  <maintenance_reason_required>false</maintenance_reason_required>
  <memory_policy>
    <over_commit>
      <percent>100</percent>
    </over_commit>
    <transparent_hugepages>
      <enabled>true</enabled>
    </transparent_hugepages>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <bandwidth>
      <assignment_method>auto</assignment_method>
    </bandwidth>
    <compressed>inherit</compressed>
  </migration>
  <optional_reason>false</optional_reason>
  <required_rng_sources>
    <required_rng_source>random</required_rng_source>
  </required_rng_sources>
  <scheduling_policy href="/ovirt-engine/api/schedulingpolicies/456" id="456"/>
  <threads_as_cores>false</threads_as_cores>
  <trusted_service>false</trusted_service>
  <tunnel_migration>false</tunnel_migration>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <virt_service>true</virt_service>
  <data_center href="/ovirt-engine/api/datacenters/111" id="111"/>
</cluster>

Table 87. Parameters summary
Name	Type	Direction	Summary
`cluster`	Cluster	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.

6.29.2. remove DELETE

Removes cluster from the system.

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000

Table 88. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.29.3. resetemulatedmachine POST

Table 89. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the reset should be performed asynchronously.

6.29.4. update PUT

Updates information about the cluster.

Only specified fields are updated, others remain unchanged.

E.g. update cluster’s CPU:

PUT /ovirt-engine/api/clusters/123

With request body like:

<cluster>
  <cpu>
    <type>Intel Haswell-noTSX Family</type>
  </cpu>
</cluster>

Table 90. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`cluster`	Cluster	In/Out

6.30. ClusterEnabledFeature

Represents a feature enabled for the cluster.

Table 91. Methods summary
Name	Summary
`get`	Provides the information about the cluster feature enabled.
`remove`	Disables a cluster feature.

6.30.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

That will return a ClusterFeature object containing the name:

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

Table 92. Parameters summary
Name	Type	Direction	Summary
`feature`	ClusterFeature	Out	Retrieved cluster feature that’s enabled.

6.30.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

6.31. 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

Table 93. Methods summary
Name	Summary
`add`	Enable an additional feature for a cluster.
`list`	Lists the additional features enabled for the cluster.

6.31.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

The request body should look like this:

<cluster_feature id="456"/>

Table 94. Parameters summary
Name	Type	Direction	Summary
`feature`	ClusterFeature	In/Out

6.31.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

This will return a list of features:

<enabled_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</enabled_features>

Table 95. Parameters summary
Name	Type	Direction	Summary
`features`	ClusterFeature[]	Out	Retrieved features.

6.32. ClusterFeature

Represents a feature enabled for the cluster level

Table 96. Methods summary
Name	Summary
`get`	Provides the information about the a cluster feature supported by a cluster level.

6.32.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

That will return a ClusterFeature object containing the name:

<cluster_feature id="456">
  <name>libgfapi_supported</name>
</cluster_feature>

Table 97. Parameters summary
Name	Type	Direction	Summary
`feature`	ClusterFeature	Out	Retrieved cluster feature.

6.33. ClusterFeatures

Provides information about the cluster features that are supported by a cluster level.

Table 98. Methods summary
Name	Summary
`list`	Lists the cluster features supported by the cluster level.

6.33.1. list GET

Lists the cluster features supported by the cluster level.

GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures

This will return a list of cluster features supported by the cluster level:

<cluster_features>
  <cluster_feature id="123">
     <name>test_feature</name>
  </cluster_feature>
  ...
</cluster_features>

Table 99. Parameters summary
Name	Type	Direction	Summary
`features`	ClusterFeature[]	Out	Retrieved features.

6.34. ClusterLevel

Provides information about a specific cluster level. See the ClusterLevels service for more information.

Table 100. Methods summary
Name	Summary
`get`	Provides the information about the capabilities of the specific cluster level managed by this service.

6.34.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

That will return a ClusterLevel object containing the supported CPU types, and other information which describes the cluster level:

<cluster_level id="3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Conroe Family</name>
      <level>3</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

Table 101. Parameters summary
Name	Type	Direction	Summary
`level`	ClusterLevel	Out	Retreived cluster level.

6.35. 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.

Table 102. Methods summary
Name	Summary
`list`	Lists the cluster levels supported by the system.

6.35.1. list GET

Lists the cluster levels supported by the system.

GET /ovirt-engine/api/clusterlevels

This will return a list of available cluster levels.

<cluster_levels>
  <cluster_level id="4.0">
     ...
  </cluster_level>
  ...
</cluster_levels>

The order of the returned cluster levels isn’t guaranteed.

Table 103. Parameters summary
Name	Type	Direction	Summary
`levels`	ClusterLevel[]	Out	Retrieved cluster levels.

6.36. ClusterNetwork

A service to manage a specific cluster network.

Table 104. Methods summary
Name	Summary
`get`	Retrieves the cluster network details.
`remove`	Unassigns the network from a cluster.
`update`	Updates the network in the cluster.

6.36.1. get GET

Retrieves the cluster network details.

Table 105. Parameters summary
Name	Type	Direction	Summary
`network`	Network	Out	The cluster network.

6.36.2. remove DELETE

Unassigns the network from a cluster.

6.36.3. update PUT

Updates the network in the cluster.

Table 106. Parameters summary
Name	Type	Direction	Summary
`network`	Network	In/Out	The cluster network.

6.37. ClusterNetworks

A service to manage cluster networks.

Table 107. Methods summary
Name	Summary
`add`	Assigns the network to a cluster.
`list`	Lists the networks that are assigned to the cluster.

6.37.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

Use the following example in its body:

<network id="123" />

Table 108. Parameters summary
Name	Type	Direction	Summary
`network`	Network	In/Out	The network object to be assigned to the cluster.

6.37.2. list GET

Lists the networks that are assigned to the cluster.

The order of the returned clusters isn’t guaranteed.

Table 109. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of networks to return.
`networks`	Network[]	Out	The list of networks that are assigned to the cluster.

max

Sets the maximum number of networks to return. If not specified, all the networks are returned.

6.38. Clusters

A service to manage clusters.

Table 110. Methods summary
Name	Summary
`add`	Creates a new cluster.
`list`	Returns the list of clusters of the system.

6.38.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 attributes.

POST /ovirt-engine/api/clusters

With a request body like this:

<cluster>
  <name>mycluster</name>
  <cpu>
    <type>Intel Penryn Family</type>
  </cpu>
  <data_center id="123"/>
</cluster>

Table 111. Parameters summary
Name	Type	Direction	Summary
`cluster`	Cluster	In/Out

6.38.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.

Table 112. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`clusters`	Cluster[]	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`max`	Integer	In	Sets the maximum number of clusters to return.
`search`	String	In	A query string used to restrict the returned clusters.

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.

max

Sets the maximum number of clusters to return. If not specified all the clusters are returned.

6.39. Copyable

Table 113. Methods summary
Name	Summary
`copy`

6.39.1. copy POST

Table 114. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the copy should be performed asynchronously.

6.40. CpuProfile

Table 115. Methods summary
Name	Summary
`get`
`remove`
`update`

6.40.1. get GET

Table 116. Parameters summary
Name	Type	Direction	Summary
`profile`	CpuProfile	Out

6.40.2. remove DELETE

Table 117. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.40.3. update PUT

Table 118. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`profile`	CpuProfile	In/Out

6.41. CpuProfiles

Table 119. Methods summary
Name	Summary
`add`
`list`	Returns the list of CPU profiles of the system.

6.41.1. add POST

Table 120. Parameters summary
Name	Type	Direction	Summary
`profile`	CpuProfile	In/Out

6.41.2. list GET

Returns the list of CPU profiles of the system.

The order of the returned list of CPU profiles isn’t guranteed.

Table 121. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of profiles to return.
`profile`	CpuProfile[]	Out

max

Sets the maximum number of profiles to return. If not specified all the profiles are returned.

6.42. DataCenter

A service to manage a data center.

Table 122. Methods summary
Name	Summary
`get`	Get a data center.
`remove`	Removes the data center.
`update`	Updates the data center.

6.42.1. get GET

Get a data center.

An example of getting a data center:

GET /ovirt-engine/api/datacenters/123

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <storage_format>v3</storage_format>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
   </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  <mac_pool href="/ovirt-engine/api/macpools/456" id="456"/>
</data_center>

Table 123. Parameters summary
Name	Type	Direction	Summary
`data_center`	DataCenter	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.

6.42.2. remove DELETE

Removes the data center.

DELETE /ovirt-engine/api/datacenters/123

Without 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.

Table 124. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.
`force`	Boolean	In	Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation.

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.42.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

With a request body like this:

<data_center>
  <name>myupdatedname</name>
  <description>An updated description for the data center</description>
</data_center>

Table 125. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`data_center`	DataCenter	In/Out	The data center that is being updated.

6.43. DataCenterNetwork

A service to manage a specific data center network.

Table 126. Methods summary
Name	Summary
`get`	Retrieves the data center network details.
`remove`	Removes the network.
`update`	Updates the network in the data center.

6.43.1. get GET

Retrieves the data center network details.

Table 127. Parameters summary
Name	Type	Direction	Summary
`network`	Network	Out	The data center network.

6.43.2. remove DELETE

Removes the network.

6.43.3. update PUT

Updates the network in the data center.

Table 128. Parameters summary
Name	Type	Direction	Summary
`network`	Network	In/Out	The data center network.

6.44. DataCenterNetworks

A service to manage data center networks.

Table 129. Methods summary
Name	Summary
`add`	Create a new network in a data center.
`list`	Lists networks in the data center.

6.44.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

Use the following example in its body:

<network>
  <name>mynetwork</name>
</network>

Table 130. Parameters summary
Name	Type	Direction	Summary
`network`	Network	In/Out	The network object to be created in the data center.

6.44.2. list GET

Lists networks in the data center.

The order of the returned list of networks isn’t guaranteed.

Table 131. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of networks to return.
`networks`	Network[]	Out	The list of networks which are in the data center.

max

Sets the maximum number of networks to return. If not specified, all the networks are returned.

6.45. DataCenters

A service to manage data centers.

Table 132. Methods summary
Name	Summary
`add`	Creates a new data center.
`list`	Lists the data centers.

6.45.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

With a request body like this:

<data_center>
  <name>mydc</name>
  <local>false</local>
</data_center>

Table 133. Parameters summary
Name	Type	Direction	Summary
`data_center`	DataCenter	In/Out	The data center that is being added.

6.45.2. list GET

Lists the data centers.

The following request retrieves a representation of the data centers:

GET /ovirt-engine/api/datacenters

The above request performed with curl:

curl \
--request GET \
--cacert /etc/pki/ovirt-engine/ca.pem \
--header "Version: 4" \
--header "Accept: application/xml" \
--user "admin@internal:mypassword" \
https://myengine.example.com/ovirt-engine/api/datacenters

This is what an example response could look like:

<data_center href="/ovirt-engine/api/datacenters/123" id="123">
  <name>Default</name>
  <description>The default Data Center</description>
  <link href="/ovirt-engine/api/datacenters/123/networks" rel="networks"/>
  <link href="/ovirt-engine/api/datacenters/123/storagedomains" rel="storagedomains"/>
  <link href="/ovirt-engine/api/datacenters/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/datacenters/123/clusters" rel="clusters"/>
  <link href="/ovirt-engine/api/datacenters/123/qoss" rel="qoss"/>
  <link href="/ovirt-engine/api/datacenters/123/iscsibonds" rel="iscsibonds"/>
  <link href="/ovirt-engine/api/datacenters/123/quotas" rel="quotas"/>
  <local>false</local>
  <quota_mode>disabled</quota_mode>
  <status>up</status>
  <supported_versions>
    <version>
      <major>4</major>
      <minor>0</minor>
    </version>
  </supported_versions>
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
</data_center>

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.

Table 134. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`data_centers`	DataCenter[]	Out
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`max`	Integer	In	Sets the maximum number of data centers to return.
`search`	String	In	A query string used to restrict the returned data centers.

case_sensitive

max

Sets the maximum number of data centers to return. If not specified all the data centers are returned.

6.46. Disk

Manages a single disk.

Table 135. Methods summary
Name	Summary
`copy`	This operation copies a disk to the specified storage domain.
`export`
`get`
`move`	Moves a disk to another storage domain.
`remove`
`sparsify`	Sparsify the disk.

6.46.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

With a request body like this:

<action>
  <storage_domain id="456"/>
  <disk>
    <name>mydisk</name>
  </disk>
</action>

Table 136. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the copy should be performed asynchronously.
`disk`	Disk	In
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`storage_domain`	StorageDomain	In

6.46.2. export POST

Table 137. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the export should be performed asynchronously.
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`storage_domain`	StorageDomain	In

6.46.3. get GET

Table 138. Parameters summary
Name	Type	Direction	Summary
`disk`	Disk	Out

6.46.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

With the following request body:

<action>
  <storage_domain id="456"/>
</action>

Table 139. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the move should be performed asynchronously.
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`storage_domain`	StorageDomain	In

6.46.5. remove DELETE

Table 140. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.46.6. 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.47. DiskAttachment

This service manages the attachment of a disk to a virtual machine.

Table 141. Methods summary
Name	Summary
`get`	Returns the details of the attachment, including the bootable flag and link to the disk.
`remove`	Removes the disk attachment.
`update`	Update the disk attachment and the disk properties within it.

6.47.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

<disk_attachment href="/ovirt-engine/api/vms/123/diskattachments/456" id="456">
  <active>true</active>
  <bootable>true</bootable>
  <interface>virtio</interface>
  <disk href="/ovirt-engine/api/disks/456" id="456"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</disk_attachment>

Table 142. Parameters summary
Name	Type	Direction	Summary
`attachment`	DiskAttachment	Out

6.47.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

Table 143. Parameters summary
Name	Type	Direction	Summary
`detach_only`	Boolean	In	Indicates if the disk should only be detached from the virtual machine, but not removed from the system.

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.47.3. update PUT

Update the disk attachment and the disk properties within it.

PUT /vms/{vm:id}/disksattachments/{attachment:id}
<disk_attachment>
  <bootable>true</bootable>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

Table 144. Parameters summary
Name	Type	Direction	Summary
`disk_attachment`	DiskAttachment	In/Out

6.48. 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.

Table 145. Methods summary
Name	Summary
`add`	Adds a new disk attachment to the virtual machine.
`list`	List the disk that are attached to the virtual machine.

6.48.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:

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk id="123"/>
</disk_attachment>

Or it can contain the complete representation of the disk, if the disk doesn’t exist yet:

<disk_attachment>
  <bootable>true</bootable>
  <pass_discard>true</pass_discard>
  <interface>ide</interface>
  <active>true</active>
  <disk>
    <name>mydisk</name>
    <provisioned_size>1024</provisioned_size>
    ...
  </disk>
</disk_attachment>

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

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.

Table 146. Parameters summary
Name	Type	Direction	Summary
`attachment`	DiskAttachment	In/Out

6.48.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.

Table 147. Parameters summary
Name	Type	Direction	Summary
`attachments`	DiskAttachment[]	Out

6.49. DiskProfile

Table 148. Methods summary
Name	Summary
`get`
`remove`
`update`

6.49.1. get GET

Table 149. Parameters summary
Name	Type	Direction	Summary
`profile`	DiskProfile	Out

6.49.2. remove DELETE

Table 150. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.49.3. update PUT

Table 151. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`profile`	DiskProfile	In/Out

6.50. DiskProfiles

Table 152. Methods summary
Name	Summary
`add`
`list`	Returns the list of disk profiles of the system.

6.50.1. add POST

Table 153. Parameters summary
Name	Type	Direction	Summary
`profile`	DiskProfile	In/Out

6.50.2. list GET

Returns the list of disk profiles of the system.

The order of the returned list of disk profiles isn’t guaranteed.

Table 154. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of profiles to return.
`profile`	DiskProfile[]	Out

max

Sets the maximum number of profiles to return. If not specified all the profiles are returned.

6.51. DiskSnapshot

Table 155. Methods summary
Name	Summary
`get`
`remove`

6.51.1. get GET

Table 156. Parameters summary
Name	Type	Direction	Summary
`snapshot`	DiskSnapshot	Out

6.51.2. remove DELETE

Table 157. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.52. DiskSnapshots

Manages the collection of disk snapshots available in an storage domain.

Table 158. Methods summary
Name	Summary
`list`	Returns the list of disk snapshots of the storage domain.

6.52.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.

Table 159. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of snapshots to return.
`snapshots`	DiskSnapshot[]	Out

max

Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.

6.53. Disks

Manages the collection of disks available in the system.

Table 160. Methods summary
Name	Summary
`add`	Adds a new floating disk.
`list`	Get list of disks.

6.53.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.

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

With a request body as follows:

<disk>
  <storage_domains>
    <storage_domain id="123"/>
  </storage_domains>
  <name>mydisk</name>
  <provisioned_size>1048576</provisioned_size>
  <format>cow</format>
</disk>

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 host element - 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 host element - 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

With a request body as follows:

<disk>
  <alias>mylun</alias>
  <lun_storage>
    <host id="123"/>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="456">
        <address>10.35.10.20</address>
        <port>3260</port>
        <target>iqn.2017-01.com.myhost:444</target>
      </logical_unit>
    </logical_units>
  </lun_storage>
</disk>

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

With a request body as follows:

<disk>
  <openstack_volume_type>
    <name>myceph</name>
  </openstack_volume_type>
  <storage_domains>
    <storage_domain>
      <name>cinderDomain</name>
    </storage_domain>
  </storage_domains>
  <provisioned_size>1073741824</provisioned_size>
  <interface>virtio</interface>
  <format>raw</format>
</disk>

Table 161. Parameters summary
Name	Type	Direction	Summary
`disk`	Disk	In/Out	The disk.

6.53.2. list GET

Get list of disks.

GET /ovirt-engine/api/disks

You will get a XML response which will look like this one:

<disks>
  <disk id="123">
    <actions>...</actions>
    <name>MyDisk</name>
    <description>MyDisk description</description>
    <link href="/ovirt-engine/api/disks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/disks/123/statistics" rel="statistics"/>
    <actual_size>5345845248</actual_size>
    <alias>MyDisk alias</alias>
    ...
    <status>ok</status>
    <storage_type>image</storage_type>
    <wipe_after_delete>false</wipe_after_delete>
    <disk_profile id="123"/>
    <quota id="123"/>
    <storage_domains>...</storage_domains>
  </disk>
  ...
</disks>

The order of the returned list of disks is guaranteed only if the sortby clause is included in the search parameter.

Table 162. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`disks`	Disk[]	Out	List of retrieved disks.
`max`	Integer	In	Sets the maximum number of disks to return.
`search`	String	In	A query string used to restrict the returned disks.
`unregistered`	Boolean	In	Indicates whether to retrieve a list of registered or unregistered disks in the storage domain.

case_sensitive

max

Sets the maximum number of disks to return. If not specified all the disks are returned.

unregistered

Indicates whether to retrieve a list of registered or unregistered disks in the storage domain. To get a list of unregistered disks in the storage domain the call should indicate the unregistered flag. For example, to get a list of unregistered disks the REST API call should look like this:

GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true

The default value of the unregistered flag is false.

This parameter only applies to the disks sub-collection of attached storage domains, it does not apply to the top level disks collection.

6.54. Domain

A service to view details of an authentication domain in the system.

Table 163. Methods summary
Name	Summary
`get`	Gets the authentication domain information.

6.54.1. get GET

Gets the authentication domain information.

Usage:

GET /ovirt-engine/api/domains/5678

Will return the domain information:

<domain href="/ovirt-engine/api/domains/5678" id="5678">
  <name>internal-authz</name>
  <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
  <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
  <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
  <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
</domain>

Table 164. Parameters summary
Name	Type	Direction	Summary
`domain`	Domain	Out	The authentication domain.

6.55. DomainGroup

Table 165. Methods summary
Name	Summary
`get`

6.55.1. get GET

Table 166. Parameters summary
Name	Type	Direction	Summary
`get`	Group	Out

6.56. DomainGroups

Table 167. Methods summary
Name	Summary
`list`	Returns the list of groups.

6.56.1. list GET

Returns the list of groups.

The order of the returned list of groups isn’t guaranteed.

Table 168. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`groups`	Group[]	Out
`max`	Integer	In	Sets the maximum number of groups to return.
`search`	String	In	A query string used to restrict the returned groups.

case_sensitive

max

Sets the maximum number of groups to return. If not specified all the groups are returned.

6.57. DomainUser

A service to view a domain user in the system.

Table 169. Methods summary
Name	Summary
`get`	Gets the domain user information.

6.57.1. get GET

Gets the domain user information.

Usage:

GET /ovirt-engine/api/domains/5678/users/1234

Will return the domain user information:

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <namespace>*</namespace>
  <principal>admin</principal>
  <user_name>admin@internal-authz</user_name>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
  </domain>
  <groups/>
</user>

Table 170. Parameters summary
Name	Type	Direction	Summary
`user`	User	Out	The domain user.

6.58. DomainUsers

A service to list all domain users in the system.

Table 171. Methods summary
Name	Summary
`list`	List all the users in the domain.

6.58.1. list GET

List all the users in the domain.

Usage:

GET /ovirt-engine/api/domains/5678/users

Will return the list of users in the domain:

<users>
  <user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
    <name>admin</name>
    <namespace>*</namespace>
    <principal>admin</principal>
    <user_name>admin@internal-authz</user_name>
    <domain href="/ovirt-engine/api/domains/5678" id="5678">
      <name>internal-authz</name>
    </domain>
    <groups/>
  </user>
</users>

The order of the returned list of users isn’t guaranteed.

Table 172. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`max`	Integer	In	Sets the maximum number of users to return.
`search`	String	In	A query string used to restrict the returned users.
`users`	User[]	Out	The list of users in the domain.

case_sensitive

max

Sets the maximum number of users to return. If not specified all the users are returned.

6.59. Domains

A service to list all authentication domains in the system.

Table 173. Methods summary
Name	Summary
`list`	List all the authentication domains in the system.

6.59.1. list GET

List all the authentication domains in the system.

Usage:

GET /ovirt-engine/api/domains

Will return the list of domains:

<domains>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
    <link href="/ovirt-engine/api/domains/5678/users" rel="users"/>
    <link href="/ovirt-engine/api/domains/5678/groups" rel="groups"/>
    <link href="/ovirt-engine/api/domains/5678/users?search={query}" rel="users/search"/>
    <link href="/ovirt-engine/api/domains/5678/groups?search={query}" rel="groups/search"/>
  </domain>
</domains>

The order of the returned list of domains isn’t guaranteed.

Table 174. Parameters summary
Name	Type	Direction	Summary
`domains`	Domain[]	Out	The list of domains.
`max`	Integer	In	Sets the maximum number of domains to return.

max

Sets the maximum number of domains to return. If not specified all the domains are returned.

6.60. EngineKatelloErrata

A service to manage Katello errata assigned to the engine. The information is retrieved from Katello.

Table 175. Methods summary
Name	Summary
`list`	Retrieves the representation of the Katello errata.

6.60.1. list GET

Retrieves the representation of the Katello errata.

GET /ovirt-engine/api/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/123" id="123">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

The order of the returned list of erratum isn’t guaranteed.

Table 176. Parameters summary
Name	Type	Direction	Summary
`errata`	KatelloErratum[]	Out	A representation of Katello errata.
`max`	Integer	In	Sets the maximum number of errata to return.

max

Sets the maximum number of errata to return. If not specified all the errata are returned.

6.61. Event

A service to manage an event in the system.

Table 177. Methods summary
Name	Summary
`get`	Get an event.
`remove`	Removes an event from internal audit log.

6.61.1. get GET

Get an event.

An example of getting an event:

GET /ovirt-engine/api/events/123

<event href="/ovirt-engine/api/events/123" id="123">
  <description>Host example.com was added by admin@internal-authz.</description>
  <code>42</code>
  <correlation_id>135</correlation_id>
  <custom_id>-1</custom_id>
  <flood_rate>30</flood_rate>
  <origin>oVirt</origin>
  <severity>normal</severity>
  <time>2016-12-11T11:13:44.654+02:00</time>
  <cluster href="/ovirt-engine/api/clusters/456" id="456"/>
  <host href="/ovirt-engine/api/hosts/789" id="789"/>
  <user href="/ovirt-engine/api/users/987" id="987"/>
</event>

Note 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.

Table 178. Parameters summary
Name	Type	Direction	Summary
`event`	Event	Out

6.61.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

Table 179. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.62. Events

A service to manage events in the system.

Table 180. Methods summary
Name	Summary
`add`	Adds an external event to the internal audit log.
`list`	Get list of events.
`undelete`

6.62.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:

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
</event>

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:

POST /ovirt-engine/api/events
<event>
  <description>File system /home is full</description>
  <severity>alert</severity>
  <origin>mymonitor</origin>
  <custom_id>1467879754</custom_id>
  <vm id="aae98225-5b73-490d-a252-899209af17e9"/>
</event>

When using links, like the vm in the previous example, only the id attribute is accepted. The name attribute, if provided, is simply ignored.

Table 181. Parameters summary
Name	Type	Direction	Summary
`event`	Event	In/Out

6.62.2. list GET

Get list of events.

GET /ovirt-engine/api/events

To the above request we get following response:

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1e892ea9</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T12:14:34.541+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>User admin logged in.</description>
    <code>30</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
</events>

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

Table 182. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`events`	Event[]	Out
`from`	Integer	In	Indicates the event index after which events should be returned.
`max`	Integer	In	Sets the maximum number of events to return.
`search`	String	In	The events service provides search queries similar to other resource services.

case_sensitive

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

This parameter is optional, and if not specified then the first event returned will be most recently generated.

max

Sets the maximum number of events to return. If not specified all the events are returned.

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

To the above request we get a list of events which severity is equal to normal:

<events>
  <event href="/ovirt-engine/api/events/2" id="2">
    <description>User admin@internal-authz logged out.</description>
    <code>31</code>
    <correlation_id>1fbd81f4</correlation_id>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:54:35.229+02:00</time>
    <user href="/ovirt-engine/api/users/57d91d48-00da-0137-0138-000000000244" id="57d91d48-00da-0137-0138-000000000244"/>
  </event>
  <event href="/ovirt-engine/api/events/1" id="1">
    <description>Affinity Rules Enforcement Manager started.</description>
    <code>10780</code>
    <custom_id>-1</custom_id>
    <flood_rate>30</flood_rate>
    <origin>oVirt</origin>
    <severity>normal</severity>
    <time>2016-09-14T11:52:18.861+02:00</time>
  </event>
</events>

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

Below example paginates event resources. The URL-encoded request is:

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201

Increase the page value to view the next page of results.

GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202

6.62.3. undelete POST

Table 183. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the un-delete should be performed asynchronously.

6.63. 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.

Table 184. Methods summary
Name	Summary
`get`	Retrieves external compute resource details.

6.63.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

It will return a response like this:

<external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
  <name>hostname</name>
  <provider>oVirt</provider>
  <url>https://hostname/api</url>
  <user>admin@internal</user>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_compute_resource>

Table 185. Parameters summary
Name	Type	Direction	Summary
`resource`	ExternalComputeResource	Out	External compute resource information

6.64. 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.

Table 186. Methods summary
Name	Summary
`list`	Retrieves a list of external compute resources.

6.64.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

It will return a response like this:

<external_compute_resources>
  <external_compute_resource href="/ovirt-engine/api/externalhostproviders/123/computeresources/234" id="234">
    <name>hostname</name>
    <provider>oVirt</provider>
    <url>https://address/api</url>
    <user>admin@internal</user>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
   </external_compute_resource>
   ...
</external_compute_resources>

The order of the returned list of compute resources isn’t guaranteed.

Table 187. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of resources to return.
`resources`	ExternalComputeResource[]	Out	List of external computer resources.

max

Sets the maximum number of resources to return. If not specified all the resources are returned.

6.65. ExternalDiscoveredHost

This service manages a single discovered host.

Table 188. Methods summary
Name	Summary
`get`	Get discovered host info.

6.65.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

The result will be like this:

<external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/234" id="234">
 <name>mac001a4ad04040</name>
 <ip>10.34.67.43</ip>
 <last_report>2017-04-24 11:05:41 UTC</last_report>
 <mac>00:1a:4a:d0:40:40</mac>
 <subnet_name>sat0</subnet_name>
 <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_discovered_host>

Table 189. Parameters summary
Name	Type	Direction	Summary
`host`	ExternalDiscoveredHost	Out	Host’s hardware and config information.

6.66. ExternalDiscoveredHosts

This service manages external discovered hosts.

Table 190. Methods summary
Name	Summary
`list`	Get list of discovered hosts' information.

6.66.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

<external_discovered_hosts>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/456" id="456">
  <name>mac001a4ad04031</name>
  <ip>10.34.67.42</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:31</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 <external_discovered_host href="/ovirt-engine/api/externalhostproviders/123/discoveredhosts/789" id="789">
  <name>mac001a4ad04040</name>
  <ip>10.34.67.43</ip>
  <last_report>2017-04-24 11:05:41 UTC</last_report>
  <mac>00:1a:4a:d0:40:40</mac>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
 </external_discovered_host>
 ...
</external_discovered_hosts>

The order of the returned list of hosts isn’t guaranteed.

Table 191. Parameters summary
Name	Type	Direction	Summary
`hosts`	ExternalDiscoveredHost[]	Out	List of discovered hosts
`max`	Integer	In	Sets the maximum number of hosts to return.

max

Sets the maximum number of hosts to return. If not specified all the hosts are returned.

6.67. ExternalHost

Table 192. Methods summary
Name	Summary
`get`

6.67.1. get GET

Table 193. Parameters summary
Name	Type	Direction	Summary
`host`	ExternalHost	Out

6.68. 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.

Table 194. Methods summary
Name	Summary
`get`	Get host group information.

6.68.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

It will return a response like this:

<external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
  <name>rhel7</name>
  <architecture_name>x86_64</architecture_name>
  <domain_name>s.com</domain_name>
  <operating_system_name>RedHat 7.3</operating_system_name>
  <subnet_name>sat0</subnet_name>
  <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
</external_host_group>

Table 195. Parameters summary
Name	Type	Direction	Summary
`group`	ExternalHostGroup	Out	Host group information.

6.69. ExternalHostGroups

This service manages hostgroups.

Table 196. Methods summary
Name	Summary
`list`	Get host groups list from external host provider.

6.69.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

The response will be like this:

<external_host_groups>
  <external_host_group href="/ovirt-engine/api/externalhostproviders/123/hostgroups/234" id="234">
    <name>rhel7</name>
    <architecture_name>x86_64</architecture_name>
    <domain_name>example.com</domain_name>
    <operating_system_name>RedHat 7.3</operating_system_name>
    <subnet_name>sat0</subnet_name>
    <external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123"/>
  </external_host_group>
  ...
</external_host_groups>

The order of the returned list of host groups isn’t guaranteed.

Table 197. Parameters summary
Name	Type	Direction	Summary
`groups`	ExternalHostGroup[]	Out	List of all hostgroups available for external host provider
`max`	Integer	In	Sets the maximum number of groups to return.

max

Sets the maximum number of groups to return. If not specified all the groups are returned.

6.70. 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.

Table 198. Methods summary
Name	Summary
`get`	Get external host provider information Host provider, Foreman or Satellite, can be set as an external provider in ovirt.
`importcertificates`
`remove`
`testconnectivity`	In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
`update`

6.70.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

The response will be like this:

<external_host_provider href="/ovirt-engine/api/externalhostproviders/123" id="123">
  <name>mysatellite</name>
  <requires_authentication>true</requires_authentication>
  <url>https://mysatellite.example.com</url>
  <username>admin</username>
</external_host_provider>

Table 199. Parameters summary
Name	Type	Direction	Summary
`provider`	ExternalHostProvider	Out

6.70.2. importcertificates POST

Table 200. Parameters summary
Name	Type	Direction	Summary
`certificates`	Certificate[]	In

6.70.3. remove DELETE

Table 201. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.70.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

Table 202. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the test should be performed asynchronously.

6.70.5. update PUT

Table 203. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`provider`	ExternalHostProvider	In/Out

6.71. ExternalHostProviders

Table 204. Methods summary
Name	Summary
`add`
`list`	Returns the list of external host providers.

6.71.1. add POST

Table 205. Parameters summary
Name	Type	Direction	Summary
`provider`	ExternalHostProvider	In/Out

6.71.2. list GET

Returns the list of external host providers.

The order of the returned list of host providers isn’t guaranteed.

Table 206. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of providers to return.
`providers`	ExternalHostProvider[]	Out

max

Sets the maximum number of providers to return. If not specified all the providers are returned.

6.72. ExternalHosts

Table 207. Methods summary
Name	Summary
`list`	Return the list of external hosts.

6.72.1. list GET

Return the list of external hosts.

The order of the returned list of hosts isn’t guaranteed.

Table 208. Parameters summary
Name	Type	Direction	Summary
`hosts`	ExternalHost[]	Out
`max`	Integer	In	Sets the maximum number of hosts to return.

max

Sets the maximum number of hosts to return. If not specified all the hosts are returned.

6.73. ExternalProvider

Provides capability to manage external providers.

Table 209. Methods summary
Name	Summary
`importcertificates`
`testconnectivity`	In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.

6.73.1. importcertificates POST

Table 210. Parameters summary
Name	Type	Direction	Summary
`certificates`	Certificate[]	In

6.73.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

Table 211. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the test should be performed asynchronously.

6.74. ExternalProviderCertificate

A service to view specific certificate for external provider.

Table 212. Methods summary
Name	Summary
`get`	Get specific certificate.

6.74.1. get GET

Get specific certificate.

GET /ovirt-engine/api/externalhostproviders/123/certificate/0

And here is sample response:

<certificate id="0">
  <organization>provider.example.com</organization>
  <subject>CN=provider.example.com</subject>
  <content>...</content>
</certificate>

Table 213. Parameters summary
Name	Type	Direction	Summary
`certificate`	Certificate	Out	The details of the certificate.

6.75. ExternalProviderCertificates

A service to view certificates for external provider.

Table 214. Methods summary
Name	Summary
`list`	Returns the chain of certificates presented by the external provider.

6.75.1. list GET

Returns the chain of certificates presented by the external provider.

GET /ovirt-engine/api/externalhostproviders/123/certificates

And here is sample response:

<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.

Table 215. Parameters summary
Name	Type	Direction	Summary
`certificates`	Certificate[]	Out	List containing certificate details.
`max`	Integer	In	Sets the maximum number of certificates to return.

max

Sets the maximum number of certificates to return. If not specified all the certificates are returned.

6.76. ExternalVmImports

Provides capability to import external virtual machines.

Table 216. Methods summary
Name	Summary
`add`	This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware.

6.76.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

With request body of type ExternalVmImport, for example:

<external_vm_import>
  <vm>
    <name>my_vm</name>
  </vm>
  <cluster id="360014051136c20574f743bdbd28177fd" />
  <storage_domain id="8bb5ade5-e988-4000-8b93-dbfc6717fe50" />
  <name>vm_name_as_is_in_vmware</name>
  <sparse>true</sparse>
  <username>vmware_user</username>
  <password>123456</password>
  <provider>VMWARE</provider>
  <url>vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1</url>
  <drivers_iso id="virtio-win-1.6.7.iso" />
</external_vm_import>

Table 217. Parameters summary
Name	Type	Direction	Summary
`import`	ExternalVmImport	In/Out

6.77. FenceAgent

A service to manage fence agent for a specific host.

Table 218. Methods summary
Name	Summary
`get`	Gets details of this fence agent.
`remove`	Removes a fence agent for a specific host.
`update`

6.77.1. get GET

Gets details of this fence agent.

GET /ovirt-engine/api/hosts/123/fenceagents/0

And here is sample response:

<agent id="0">
  <type>apc</type>
  <order>1</order>
  <ip>192.168.1.101</ip>
  <user>user</user>
  <password>xxx</password>
  <port>9</port>
  <options>name1=value1, name2=value2</options>
</agent>

Table 219. Parameters summary
Name	Type	Direction	Summary
`agent`	Agent	Out	Fence agent details.

6.77.2. remove DELETE

Removes a fence agent for a specific host.

DELETE /ovirt-engine/api/hosts/123/fenceagents/0

Table 220. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.77.3. update PUT

Table 221. Parameters summary
Name	Type	Direction	Summary
`agent`	Agent	In/Out	Fence agent details.
`async`	Boolean	In	Indicates if the update should be performed asynchronously.

6.78. FenceAgents

A service to manage fence agents for a specific host.

Table 222. Methods summary
Name	Summary
`add`
`list`	Returns the list of fencing agents configured for the host.

6.78.1. add POST

Table 223. Parameters summary
Name	Type	Direction	Summary
`agent`	Agent	In/Out

6.78.2. list GET

Returns the list of fencing agents configured for the host.

GET /ovirt-engine/api/hosts/123/fenceagents

And here is sample response:

<agents>
  <agent id="0">
    <type>apc</type>
    <order>1</order>
    <ip>192.168.1.101</ip>
    <user>user</user>
    <password>xxx</password>
    <port>9</port>
    <options>name1=value1, name2=value2</options>
  </agent>
</agents>

The order of the returned list of fencing agents isn’t guaranteed.

Table 224. Parameters summary
Name	Type	Direction	Summary
`agents`	Agent[]	Out	List of fence agent details.
`max`	Integer	In	Sets the maximum number of agents to return.

max

Sets the maximum number of agents to return. If not specified all the agents are returned.

6.79. File

Table 225. Methods summary
Name	Summary
`get`

6.79.1. get GET

Table 226. Parameters summary
Name	Type	Direction	Summary
`file`	File	Out

6.80. 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.

Table 227. Methods summary
Name	Summary
`list`	Returns the list of ISO images and virtual floppy disks available in the storage domain.

6.80.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

Setting the value of the refresh parameter to true has an impact on the performance of the server. Use it only if necessary.

Table 228. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should take case into account.
`file`	File[]	Out
`max`	Integer	In	Sets the maximum number of files to return.
`refresh`	Boolean	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.
`search`	String	In	A query string used to restrict the returned files.

case_sensitive

Indicates if the search performed using the search parameter should take case into account. The default value is true.

max

Sets the maximum number of files to return. If not specified, all the files are returned.

6.81. Filter

Table 229. Methods summary
Name	Summary
`get`
`remove`

6.81.1. get GET

Table 230. Parameters summary
Name	Type	Direction	Summary
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`result`	Filter	Out

6.81.2. remove DELETE

Table 231. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.82. Filters

Manages the filters used by an scheduling policy.

Table 232. Methods summary
Name	Summary
`add`
`list`	Returns the list of filters used by the scheduling policy.

6.82.1. add POST

Table 233. Parameters summary
Name	Type	Direction	Summary
`filter`	Filter	In/Out

6.82.2. list GET

Returns the list of filters used by the scheduling policy.

The order of the returned list of filters isn’t guaranteed.

Table 234. Parameters summary
Name	Type	Direction	Summary
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`filters`	Filter[]	Out
`max`	Integer	In	Sets the maximum number of filters to return.

max

Sets the maximum number of filters to return. If not specified all the filters are returned.

6.83. GlusterBrick

This service manages a single gluster brick.

Table 235. Methods summary
Name	Summary
`get`	Get details of a brick.
`remove`	Removes a brick.
`replace`	Replaces this brick with a new one.

6.83.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

Which will return a response body like this:

<brick id="234">
  <name>host1:/rhgs/data/brick1</name>
  <brick_dir>/rhgs/data/brick1</brick_dir>
  <server_id>111</server_id>
  <status>up</status>
  <device>/dev/mapper/RHGS_vg1-lv_vmaddldisks</device>
  <fs_name>xfs</fs_name>
  <gluster_clients>
    <gluster_client>
      <bytes_read>2818417648</bytes_read>
      <bytes_written>1384694844</bytes_written>
      <client_port>1011</client_port>
      <host_name>client2</host_name>
    </gluster_client>
  </gluster_clients>
  <memory_pools>
    <memory_pool>
      <name>data-server:fd_t</name>
      <alloc_count>1626348</alloc_count>
      <cold_count>1020</cold_count>
      <hot_count>4</hot_count>
      <max_alloc>23</max_alloc>
      <max_stdalloc>0</max_stdalloc>
      <padded_size>140</padded_size>
      <pool_misses>0</pool_misses>
    </memory_pool>
  </memory_pools>
  <mnt_options>rw,seclabel,noatime,nodiratime,attr2,inode64,sunit=512,swidth=2048,noquota</mnt_options>
  <pid>25589</pid>
  <port>49155</port>
</brick>

Table 236. Parameters summary
Name	Type	Direction	Summary
`brick`	GlusterBrick	Out

6.83.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

Table 237. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.83.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.

Table 238. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the replacement should be performed asynchronously.
`force`	Boolean	In

6.84. GlusterBricks

This service manages the gluster bricks in a gluster volume

Table 239. Methods summary
Name	Summary
`activate`	Activate the bricks post data migration of remove brick operation.
`add`	Adds a list of bricks to gluster volume.
`list`	Lists the bricks of a gluster volume.
`migrate`	Start migration of data prior to removing bricks.
`remove`	Removes bricks from gluster volume.
`stopmigrate`	Stops migration of data from bricks for a remove brick operation.

6.84.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

With a request body like this:

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

Table 240. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the activation should be performed asynchronously.
`bricks`	GlusterBrick[]	In	The list of bricks that need to be re-activated.

6.84.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

With a request body like this:

<bricks>
  <brick>
    <server_id>111</server_id>
    <brick_dir>/export/data/brick3</brick_dir>
  </brick>
</bricks>

Table 241. Parameters summary
Name	Type	Direction	Summary
`bricks`	GlusterBrick[]	In/Out	The list of bricks to be added to the volume
`replica_count`	Integer	In	Replica count of volume post add operation.
`stripe_count`	Integer	In	Stripe count of volume post add operation.

6.84.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

Provides an output as below:

<bricks>
  <brick id="234">
    <name>host1:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>111</server_id>
    <status>up</status>
  </brick>
  <brick id="233">
    <name>host2:/rhgs/data/brick1</name>
    <brick_dir>/rhgs/data/brick1</brick_dir>
    <server_id>222</server_id>
    <status>up</status>
  </brick>
</bricks>

The order of the returned list is based on the brick order provided at gluster volume creation.

Table 242. Parameters summary
Name	Type	Direction	Summary
`bricks`	GlusterBrick[]	Out
`max`	Integer	In	Sets the maximum number of bricks to return.

max

Sets the maximum number of bricks to return. If not specified all the bricks are returned.

6.84.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

With a request body like this:

<action>
  <bricks>
    <brick>
      <name>host1:/rhgs/brick1</name>
    </brick>
  </bricks>
</action>

The migration process can be tracked from the job id returned from the API using job and steps in job using step

Table 243. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the migration should be performed asynchronously.
`bricks`	GlusterBrick[]	In	List of bricks for which data migration needs to be started.

6.84.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

With a request body like this:

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

Table 244. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.
`bricks`	GlusterBrick[]	In	The list of bricks to be removed
`replica_count`	Integer	In	Replica count of volume post add operation.

6.84.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

With a request body like this:

<bricks>
  <brick>
    <name>host:brick_directory</name>
  </brick>
</bricks>

Table 245. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`bricks`	GlusterBrick[]	In	List of bricks for which data migration needs to be stopped.

bricks

List of bricks for which data migration needs to be stopped. This list should match the arguments passed to migrate.

6.85. GlusterHook

Table 246. Methods summary
Name	Summary
`disable`	Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster.
`enable`	Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster.
`get`
`remove`	Removes the this Gluster hook from all servers in cluster and deletes it from the database.
`resolve`	Resolves missing hook conflict depending on the resolution type.

6.85.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.

Table 247. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.85.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.

Table 248. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.85.3. get GET

Table 249. Parameters summary
Name	Type	Direction	Summary
`hook`	GlusterHook	Out

6.85.4. remove DELETE

Removes the this Gluster hook from all servers in cluster and deletes it from the database.

Table 250. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.85.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.

Table 251. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`host`	Host	In
`resolution_type`	String	In

6.86. GlusterHooks

Table 252. Methods summary
Name	Summary
`list`	Returns the list of hooks.

6.86.1. list GET

Returns the list of hooks.

The order of the returned list of hooks isn’t guaranteed.

Table 253. Parameters summary
Name	Type	Direction	Summary
`hooks`	GlusterHook[]	Out
`max`	Integer	In	Sets the maximum number of hooks to return.

max

Sets the maximum number of hooks to return. If not specified all the hooks are returned.

6.87. GlusterVolume

This service manages a single gluster volume.

Table 254. Methods summary
Name	Summary
`get`	Get the gluster volume details.
`getprofilestatistics`	Get gluster volume profile statistics.
`rebalance`	Rebalance the gluster volume.
`remove`	Removes the gluster volume.
`resetalloptions`	Resets all the options set in the gluster volume.
`resetoption`	Resets a particular option in the gluster volume.
`setoption`	Sets a particular option in the gluster volume.
`start`	Starts the gluster volume.
`startprofile`	Start profiling the gluster volume.
`stop`	Stops the gluster volume.
`stopprofile`	Stop profiling the gluster volume.
`stoprebalance`	Stop rebalancing the gluster volume.

6.87.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

This GET request will return the following output:

<gluster_volume id="123">
 <name>data</name>
 <link href="/ovirt-engine/api/clusters/456/glustervolumes/123/glusterbricks" rel="glusterbricks"/>
 <disperse_count>0</disperse_count>
 <options>
   <option>
     <name>storage.owner-gid</name>
     <value>36</value>
   </option>
   <option>
     <name>performance.io-cache</name>
     <value>off</value>
   </option>
   <option>
     <name>cluster.data-self-heal-algorithm</name>
     <value>full</value>
   </option>
 </options>
 <redundancy_count>0</redundancy_count>
 <replica_count>3</replica_count>
 <status>up</status>
 <stripe_count>0</stripe_count>
 <transport_types>
   <transport_type>tcp</transport_type>
 </transport_types>
 <volume_type>replicate</volume_type>
 </gluster_volume>

Table 255. Parameters summary
Name	Type	Direction	Summary
`volume`	GlusterVolume	Out	Representation of the gluster volume.

6.87.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

Table 256. Parameters summary
Name	Type	Direction	Summary
`details`	GlusterVolumeProfileDetails	Out	Gluster volume profiling information returned from the action.

6.87.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

Table 257. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the rebalance should be performed asynchronously.
`fix_layout`	Boolean	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.
`force`	Boolean	In	Indicates if the rebalance should be force started.

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.

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.87.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

Table 258. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.87.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

Table 259. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the reset should be performed asynchronously.

6.87.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

With the following request body:

<action>
 <option name="option1"/>
</action>

Table 260. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the reset should be performed asynchronously.
`force`	Boolean	In
`option`	Option	In	Option to reset.

6.87.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

With the following request body:

<action>
 <option name="option1" value="value1"/>
</action>

Table 261. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`option`	Option	In	Option to set.

6.87.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

Table 262. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`force`	Boolean	In	Indicates if the volume should be force started.

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.87.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

Table 263. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.87.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

Table 264. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`force`	Boolean	In

6.87.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

Table 265. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.87.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

Table 266. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.88. GlusterVolumes

This service manages a collection of gluster volumes available in a cluster.

Table 267. Methods summary
Name	Summary
`add`	Creates a new gluster volume.
`list`	Lists all gluster volumes in the cluster.

6.88.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

With the following request body:

<gluster_volume>
  <name>myvolume</name>
  <volume_type>replicate</volume_type>
  <replica_count>3</replica_count>
  <bricks>
    <brick>
      <server_id>server1</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server2</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
    <brick>
      <server_id>server3</server_id>
      <brick_dir>/exp1</brick_dir>
    </brick>
  <bricks>
</gluster_volume>

Table 268. Parameters summary
Name	Type	Direction	Summary
`volume`	GlusterVolume	In/Out	The gluster volume definition from which to create the volume is passed as input and the newly created volume is returned.

6.88.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

The order of the returned list of volumes isn’t guaranteed.

Table 269. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`max`	Integer	In	Sets the maximum number of volumes to return.
`search`	String	In	A query string used to restrict the returned volumes.
`volumes`	GlusterVolume[]	Out

case_sensitive

max

Sets the maximum number of volumes to return. If not specified all the volumes are returned.

6.89. 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.

Table 270. Methods summary
Name	Summary
`get`	Gets the system group information.
`remove`	Removes the system group.

6.89.1. get GET

Gets the system group information.

Usage:

GET /ovirt-engine/api/groups/123

Will return the group information:

<group href="/ovirt-engine/api/groups/123" id="123">
  <name>mygroup</name>
  <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
  <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
  <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
  <namespace>DC=example,DC=com</namespace>
  <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
    <name>myextension-authz</name>
  </domain>
</group>

Table 271. Parameters summary
Name	Type	Direction	Summary
`get`	Group	Out	The system group.

6.89.2. remove DELETE

Removes the system group.

Usage:

DELETE /ovirt-engine/api/groups/123

Table 272. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.90. Groups

Manages the collection of groups of users.

Table 273. Methods summary
Name	Summary
`add`	Add group from a directory service.
`list`	List all the groups in the system.

6.90.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

With a request body like this:

<group>
  <name>Developers</name>
  <domain>
    <name>internal-authz</name>
  </domain>
</group>

Table 274. Parameters summary
Name	Type	Direction	Summary
`group`	Group	In/Out	The group to be added.

6.90.2. list GET

List all the groups in the system.

Usage:

GET /ovirt-engine/api/groups

Will return the list of groups:

<groups>
  <group href="/ovirt-engine/api/groups/123" id="123">
    <name>mygroup</name>
    <link href="/ovirt-engine/api/groups/123/roles" rel="roles"/>
    <link href="/ovirt-engine/api/groups/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/groups/123/tags" rel="tags"/>
    <domain_entry_id>476652557A382F67696B6D2B32762B37796E46476D513D3D</domain_entry_id>
    <namespace>DC=example,DC=com</namespace>
    <domain href="/ovirt-engine/api/domains/ABCDEF" id="ABCDEF">
      <name>myextension-authz</name>
    </domain>
  </group>
  ...
</groups>

The order of the returned list of groups isn’t guaranteed.

Table 275. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`groups`	Group[]	Out	The list of groups.
`max`	Integer	In	Sets the maximum number of groups to return.
`search`	String	In	A query string used to restrict the returned groups.

case_sensitive

max

Sets the maximum number of groups to return. If not specified all the groups are returned.

6.91. Host

A service to manage a host.

Table 276. Methods summary
Name	Summary
`activate`	Activates the host for use, for example to run virtual machines.
`approve`	Approve a pre-installed Hypervisor host for usage in the virtualization environment.
`commitnetconfig`	Marks the network configuration as good and persists it inside the host.
`deactivate`	Deactivates the host to perform maintenance tasks.
`enrollcertificate`	Enrolls the certificate of the host.
`fence`	Controls the host’s power management device.
`forceselectspm`	To manually set a host as the storage pool manager (SPM).
`get`	Gets the host details.
`install`	Installs VDSM and related software on the host.
`iscsidiscover`	Discovers iSCSI targets on the host, using the initiator details.
`iscsilogin`	Login to iSCSI targets on the host, using the target details.
`refresh`	Refresh the host devices and capabilities.
`remove`	Remove the host from the system.
`setupnetworks`	This method is used to change the configuration of the network interfaces of a host.
`unregisteredstoragedomainsdiscover`	Discovers the block Storage Domains which are candidates to be imported to the setup.
`update`	Update the host properties.
`upgrade`	Upgrades VDSM and selected software on the host.
`upgradecheck`	Check if there are upgrades available for the host.

6.91.1. activate POST

Activates the host for use, for example to run virtual machines.

Table 277. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the activation should be performed asynchronously.

6.91.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.

Table 278. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the approval should be performed asynchronously.
`cluster`	Cluster	In	The cluster where the host will be added after it is approved.
`host`	Host	In	The host to approve.

6.91.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

With a request body like this:

<action/>

Table 279. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.91.4. deactivate POST

Deactivates the host to perform maintenance tasks.

Table 280. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the deactivation should be performed asynchronously.
`reason`	String	In
`stop_gluster_service`	Boolean	In	Indicates if the gluster service should be stopped as part of deactivating the host.

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.91.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.

Table 281. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the enrollment should be performed asynchronously.

6.91.6. fence POST

Controls the host’s power management device.

For example, to start the host. This can be done via:

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<action>
  <fence_type>start</fence_type>
</action>
' \
"${url}/hosts/123/fence"

Table 282. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the fencing should be performed asynchronously.
`fence_type`	String	In
`power_management`	PowerManagement	Out

6.91.7. forceselectspm POST

To manually set a host as the storage pool manager (SPM).

POST /ovirt-engine/api/hosts/123/forceselectspm

With a request body like this:

<action/>

Table 283. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.91.8. get GET

Gets the host details.

GET /ovirt-engine/api/hosts/123

Table 284. Parameters summary
Name	Type	Direction	Summary
`all_content`	Boolean	In	Indicates if all of the attributes of the host should be included in the response.
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`host`	Host	Out	The queried host.

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

These 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.91.9. install POST

Installs VDSM and related software on the host. The host type defines additional parameters for the action.

Example of installing a host, using curl and JSON, plain:

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123"

Example of installing a host, using curl and JSON, with hosted engine components:

curl \
curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--request PUT \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Version: 4" \
--user "admin@internal:..." \
--data '
{
  "root_password": "myrootpassword"
}
' \
"https://engine.example.com/ovirt-engine/api/hosts/123?deploy_hosted_engine=true"

Since version 4.1.2 of the engine when a host is reinstalled we override the host firewall definitions by default.

Table 285. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the installation should be performed asynchronously.
`deploy_hosted_engine`	Boolean	In	When set to `true` it means this host should also deploy the self-hosted engine components.
`host`	Host	In	The `override_iptables` property is used to indicate if the firewall configuration should be replaced by the default one.
`image`	String	In	When installing an oVirt node a image ISO file is required.
`root_password`	String	In	The password of of the `root` user, used to connect to the host via SSH.
`ssh`	Ssh	In	The SSH details used to connect to the host.
`undeploy_hosted_engine`	Boolean	In	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.

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.

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.91.10. iscsidiscover POST

Discovers iSCSI targets on the host, using the initiator details.

Table 286. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the discovery should be performed asynchronously.
`iscsi`	IscsiDetails	In	The target iSCSI device.
`iscsi_targets`	String[]	Out	The iSCSI targets.

6.91.11. iscsilogin POST

Table 287. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the login should be performed asynchronously.
`iscsi`	IscsiDetails	In	The target iSCSI device.

6.91.12. refresh POST

Refresh the host devices and capabilities.

Table 288. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the refresh should be performed asynchronously.

6.91.13. remove DELETE

Remove the host from the system.

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request DELETE \
--header "Version: 4" \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"

Table 289. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.91.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:

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<action>
  <modified_bonds>
    <host_nic>
      <name>bond0</name>
      <bonding>
        <options>
          <option>
            <name>mode</name>
            <value>4</value>
          </option>
          <option>
            <name>miimon</name>
            <value>100</value>
          </option>
        </options>
        <slaves>
          <host_nic>
            <name>eth1</name>
          </host_nic>
          <host_nic>
            <name>eth2</name>
          </host_nic>
        </slaves>
      </bonding>
    </host_nic>
  </modified_bonds>
  <modified_network_attachments>
    <network_attachment>
      <network>
        <name>myvlan</name>
      </network>
      <host_nic>
        <name>bond0</name>
      </host_nic>
      <ip_address_assignments>
        <assignment_method>static</assignment_method>
        <ip_address_assignment>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
      <dns_resolver_configuration>
        <name_servers>
          <name_server>1.1.1.1</name_server>
          <name_server>2.2.2.2</name_server>
        </name_servers>
      </dns_resolver_configuration>
    </network_attachment>
  </modified_network_attachments>
 </action>
' \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"

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"/>

Using the Python SDK the same can be done with the following code:

# Find the service that manages the collection of hosts:
hosts_service = connection.system_service().hosts_service()

# Find the host:
host = hosts_service.list(search='name=myhost')[0]

# Find the service that manages the host:
host_service = hosts_service.host_service(host.id)

# Configure the network adding a bond with two slaves and attaching it to a
# network with an static IP address:
host_service.setup_networks(
    modified_bonds=[
        types.HostNic(
            name='bond0',
            bonding=types.Bonding(
                options=[
                    types.Option(
                        name='mode',
                        value='4',
                    ),
                    types.Option(
                        name='miimon',
                        value='100',
                    ),
                ],
                slaves=[
                    types.HostNic(
                        name='eth1',
                    ),
                    types.HostNic(
                        name='eth2',
                    ),
                ],
            ),
        ),
    ],
    modified_network_attachments=[
        types.NetworkAttachment(
            network=types.Network(
                name='myvlan',
            ),
            host_nic=types.HostNic(
                name='bond0',
            ),
            ip_address_assignments=[
                types.IpAddressAssignment(
                    assignment_method=types.BootProtocol.STATIC,
                    ip=types.Ip(
                        address='192.168.122.10',
                        netmask='255.255.255.0',
                    ),
                ),
            ],
            dns_resolver_configuration=types.DnsResolverConfiguration(
                name_servers=[
                    '1.1.1.1',
                    '2.2.2.2',
                ],
            ),
        ),
    ],
)

# After modifying the network configuration it is very important to make it
# persistent:
host_service.commit_net_config()

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.

Table 290. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`check_connectivity`	Boolean	In
`connectivity_timeout`	Integer	In
`modified_bonds`	HostNic[]	In
`modified_labels`	NetworkLabel[]	In
`modified_network_attachments`	NetworkAttachment[]	In
`removed_bonds`	HostNic[]	In
`removed_labels`	NetworkLabel[]	In
`removed_network_attachments`	NetworkAttachment[]	In
`synchronized_network_attachments`	NetworkAttachment[]	In

6.91.15. unregisteredstoragedomainsdiscover POST

Discovers the block Storage Domains which are candidates to be imported to the setup. For FCP no arguments are required.

Table 291. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the discovery should be performed asynchronously.
`iscsi`	IscsiDetails	In
`storage_domains`	StorageDomain[]	Out

6.91.16. 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

With request body like this:

<host>
  <os>
    <custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
  </os>
</host>

Table 292. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`host`	Host	In/Out

6.91.17. upgrade POST

Upgrades VDSM and selected software on the host.

Table 293. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the upgrade should be performed asynchronously.
`image`	String	In	The image parameter specifies path to image, which is used for upgrade.

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.91.18. 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.92. HostDevice

A service to access a particular device of a host.

Table 294. Methods summary
Name	Summary
`get`	Retrieve information about a particular host’s device.

6.92.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

<host_device href="/ovirt-engine/api/hosts/123/devices/456" id="456">
  <name>usb_1_9_1_1_0</name>
  <capability>usb</capability>
  <host href="/ovirt-engine/api/hosts/123" id="123"/>
  <parent_device href="/ovirt-engine/api/hosts/123/devices/789" id="789">
    <name>usb_1_9_1</name>
  </parent_device>
</host_device>

Table 295. Parameters summary
Name	Type	Direction	Summary
`device`	HostDevice	Out

6.93. HostDevices

A service to access host devices.

Table 296. Methods summary
Name	Summary
`list`	List the devices of a host.

6.93.1. list GET

List the devices of a host.

The order of the returned list of devices isn’t guaranteed.

Table 297. Parameters summary
Name	Type	Direction	Summary
`devices`	HostDevice[]	Out
`max`	Integer	In	Sets the maximum number of devices to return.

max

Sets the maximum number of devices to return. If not specified all the devices are returned.

6.94. HostHook

Table 298. Methods summary
Name	Summary
`get`

6.94.1. get GET

Table 299. Parameters summary
Name	Type	Direction	Summary
`hook`	Hook	Out

6.95. HostHooks

Table 300. Methods summary
Name	Summary
`list`	Returns the list of hooks configured for the host.

6.95.1. list GET

Returns the list of hooks configured for the host.

The order of the returned list of hooks isn’t guranteed.

Table 301. Parameters summary
Name	Type	Direction	Summary
`hooks`	Hook[]	Out
`max`	Integer	In	Sets the maximum number of hooks to return.

max

Sets the maximum number of hooks to return. If not specified all the hooks are returned.

6.96. HostNic

A service to manage a network interface of a host.

Table 302. Methods summary
Name	Summary
`get`
`updatevirtualfunctionsconfiguration`	The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC.

6.96.1. get GET

Table 303. Parameters summary
Name	Type	Direction	Summary
`nic`	HostNic	Out

6.96.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.

Table 304. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration	In

6.97. HostNics

A service to manage the network interfaces of a host.

Table 305. Methods summary
Name	Summary
`list`	Returns the list of network interfaces of the host.

6.97.1. list GET

Returns the list of network interfaces of the host.

The order of the returned list of network interfaces isn’t guaranteed.

Table 306. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of NICs to return.
`nics`	HostNic[]	Out

max

Sets the maximum number of NICs to return. If not specified all the NICs are returned.

6.98. HostNumaNode

Table 307. Methods summary
Name	Summary
`get`

6.98.1. get GET

Table 308. Parameters summary
Name	Type	Direction	Summary
`node`	NumaNode	Out

6.99. HostNumaNodes

Table 309. Methods summary
Name	Summary
`list`	Returns the list of NUMA nodes of the host.

6.99.1. list GET

Returns the list of NUMA nodes of the host.

The order of the returned list of NUMA nodes isn’t guaranteed.

Table 310. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of nodes to return.
`nodes`	NumaNode[]	Out

max

Sets the maximum number of nodes to return. If not specified all the nodes are returned.

6.100. HostStorage

A service to manage host storages.

Table 311. Methods summary
Name	Summary
`list`	Get list of storages.

6.100.1. list GET

Get list of storages.

GET /ovirt-engine/api/hosts/123/storage

The XML response you get will be like this one:

<host_storages>
  <host_storage id="123">
    ...
  </host_storage>
  ...
</host_storages>

The order of the returned list of storages isn’t guaranteed.

Table 312. Parameters summary
Name	Type	Direction	Summary
`report_status`	Boolean	In	Indicates if the status of the LUNs in the storage should be checked.
`storages`	HostStorage[]	Out	Retrieved list of storages.

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 :

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

Here an example without the LUN status :

<host_storage id="123">
  <logical_units>
    <logical_unit id="123">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>123</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>123</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="123"/>
</host_storage>

6.101. Hosts

A service that manages hosts.

Table 313. Methods summary
Name	Summary
`add`	Creates a new host.
`list`	Get a list of all available hosts.

6.101.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

With the following request body:

<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

Table 314. Parameters summary
Name	Type	Direction	Summary
`deploy_hosted_engine`	Boolean	In	When set to `true` it means this host should deploy also hosted engine components.
`host`	Host	In/Out	The host definition from which to create the new host is passed as parameter, and the newly created host is returned.
`undeploy_hosted_engine`	Boolean	In	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.

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.

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.101.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

The response body will be something like this:

<hosts>
  <host href="/ovirt-engine/api/hosts/123" id="123">
    ...
  </host>
  <host href="/ovirt-engine/api/hosts/456" id="456">
    ...
  </host>
  ...
</host>

The order of the returned list of hosts is guaranteed only if the sortby clause is included in the search parameter.

Table 315. Parameters summary
Name	Type	Direction	Summary
`all_content`	Boolean	In	Indicates if all of the attributes of the hosts should be included in the response.
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`filter`	Boolean	In	Indicates if the results should be filtered according to the permissions of the user.
`hosts`	Host[]	Out
`max`	Integer	In	Sets the maximum number of hosts to return.
`search`	String	In	A query string used to restrict the returned hosts.

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

case_sensitive

max

Sets the maximum number of hosts to return. If not specified all the hosts are returned.

6.102. Icon

A service to manage an icon (read-only).

Table 316. Methods summary
Name	Summary
`get`	Get an icon.

6.102.1. get GET

Get an icon.

GET /ovirt-engine/api/icons/123

You will get a XML response like this one:

<icon id="123">
  <data>Some binary data here</data>
  <media_type>image/png</media_type>
</icon>

Table 317. Parameters summary
Name	Type	Direction	Summary
`icon`	Icon	Out	Retrieved icon.

6.103. Icons

A service to manage icons.

Table 318. Methods summary
Name	Summary
`list`	Get a list of icons.

6.103.1. list GET

Get a list of icons.

GET /ovirt-engine/api/icons

You will get a XML response which is similar to this one:

<icons>
  <icon id="123">
    <data>...</data>
    <media_type>image/png</media_type>
  </icon>
  ...
</icons>

The order of the returned list of icons isn’t guaranteed.

Table 319. Parameters summary
Name	Type	Direction	Summary
`icons`	Icon[]	Out	Retrieved list of icons.
`max`	Integer	In	Sets the maximum number of icons to return.

max

Sets the maximum number of icons to return. If not specified all the icons are returned.

6.104. Image

Table 320. Methods summary
Name	Summary
`get`
`import`	Imports an image.

6.104.1. get GET

Table 321. Parameters summary
Name	Type	Direction	Summary
`image`	Image	Out

6.104.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.

Table 322. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the import should be performed asynchronously.
`cluster`	Cluster	In	The cluster to which the image should be imported if the `import_as_template` parameter is set to `true`.
`disk`	Disk	In	The disk to import.
`import_as_template`	Boolean	In	Specifies if a template should be created from the imported disk.
`storage_domain`	StorageDomain	In	The storage domain to which the disk should be imported.
`template`	Template	In	The name of the template being created if the `import_as_template` parameter is set to `true`.

6.105. ImageTransfer

This service provides a mechanism to control an image transfer. The client will have to create a transfer by using add of the ImageTransfers service, stating the image to transfer data to/from.

After doing that, the transfer is managed by this service.

E.g., for uploading to the disk image with id 52cb593f-837c-4633-a444-35a0a0383706, the client can use oVirt’s Python’s SDK as follows:

transfers_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      image=types.Image(
         id='52cb593f-837c-4633-a444-35a0a0383706'
      )
   )
)

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_service = system_service.image_transfers_service()
transfer = transfers_service.add(
   types.ImageTransfer(
      image=types.Image(
         id='52cb593f-837c-4633-a444-35a0a0383706'
      ),
      direction=types.ImageTransferDirection.DOWNLOAD
   )
)

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()

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_url is the address of a proxy server to the image, to do I/O to.
signed_ticket is the content that needs to be added to the Authentication header 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,
}

Using Python’s HTTPSConnection, a new connection is established:

# Extract the URI, port, and path from the transfer's proxy_url.
url = urlparse.urlparse(transfer.proxy_url)

# Create a new instance of the connection.
proxy_connection = HTTPSConnection(
   url.hostname,
   url.port,
   context=ssl.SSLContext(ssl.PROTOCOL_SSLv23)
)

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:

path = "/path/to/image"
MB_per_request = 32
with open(path, "rb") as disk:
   size = os.path.getsize(path)
   chunk_size = 1024*1024*MB_per_request
   pos = 0
   while (pos < size):
      transfer_service.extend()
      transfer_headers['Content-Range'] = "bytes %d-%d/%d" % (pos, min(pos + chunk_size, size)-1, size)
      proxy_connection.request(
         'PUT',
         url.path,
         disk.read(chunk_size),
         headers=transfer_headers
      )
      r = proxy_connection.getresponse()
      print r.status, r.reason, "Completed", "{:.0%}".format(pos/ float(size))
      pos += chunk_size

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:

output_file = "/home/user/downloaded_image"
MiB_per_request = 32
chunk_size = 1024*1024*MiB_per_request
total = disk_size

with open(output_file, "wb") as disk:
   pos = 0
   while pos < total:
      transfer_service.extend()
      transfer_headers['Range'] = "bytes=%d-%d" %  (pos, min(total, pos + chunk_size) - 1)
      proxy_connection.request('GET', proxy_url.path, headers=transfer_headers)
      r = proxy_connection.getresponse()
      disk.write(r.read())
      print "Completed", "{:.0%}".format(pos/ float(total))
      pos += chunk_size

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()

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.

Table 323. Methods summary
Name	Summary
`extend`	Extend the image transfer session.
`finalize`	After finishing to transfer the data, finalize the transfer.
`get`	Get the image transfer entity.
`pause`	Pause the image transfer session.
`resume`	Resume the image transfer session.

6.105.1. extend POST

Extend the image transfer session.

6.105.2. 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.105.3. get GET

Get the image transfer entity.

Table 324. Parameters summary
Name	Type	Direction	Summary
`image_transfer`	ImageTransfer	Out

6.105.4. pause POST

Pause the image transfer session.

6.105.5. 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:

transfer_service = transfers_service.image_transfer_service(transfer.id)
transfer_service.resume()
transfer = transfer_service.get()

while transfer.phase == types.ImageTransferPhase.RESUMING:
   time.sleep(1)
   transfer = transfer_service.get()

6.106. ImageTransfers

This service manages image transfers, for performing Image I/O API in oVirt. Please refer to image transfer for further documentation.

Table 325. Methods summary
Name	Summary
`add`	Add a new image transfer.
`list`	Retrieves the list of image transfers that are currently being performed.

6.106.1. add POST

Add a new image transfer. An image needs to be specified in order to make a new transfer.

Table 326. Parameters summary
Name	Type	Direction	Summary
`image_transfer`	ImageTransfer	In/Out

6.106.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.

Table 327. Parameters summary
Name	Type	Direction	Summary
`image_transfer`	ImageTransfer[]	Out

6.107. Images

Manages the set of images available in an storage domain or in an OpenStack image provider.

Table 328. Methods summary
Name	Summary
`list`	Returns the list of images available in the storage domain or provider.

6.107.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.

Table 329. Parameters summary
Name	Type	Direction	Summary
`images`	Image[]	Out
`max`	Integer	In	Sets the maximum number of images to return.

max

Sets the maximum number of images to return. If not specified all the images are returned.

6.108. InstanceType

Table 330. Methods summary
Name	Summary
`get`	Get a specific instance type and it’s attributes.
`remove`	Removes a specific instance type from the system.
`update`	Update a specific instance type and it’s attributes.

6.108.1. get GET

Get a specific instance type and it’s attributes.

GET /ovirt-engine/api/instancetypes/123

Table 331. Parameters summary
Name	Type	Direction	Summary
`instance_type`	InstanceType	Out

6.108.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

Table 332. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.108.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

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:

<instance_type>
  <memory>1073741824</memory>
  <cpu>
    <topology>
      <cores>1</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
</instance_type>

Table 333. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`instance_type`	InstanceType	In/Out

6.109. InstanceTypeGraphicsConsole

Table 334. Methods summary
Name	Summary
`get`	Gets graphics console configuration of the instance type.
`remove`	Remove the graphics console from the instance type.

6.109.1. get GET

Gets graphics console configuration of the instance type.

Table 335. Parameters summary
Name	Type	Direction	Summary
`console`	GraphicsConsole	Out	The information about the graphics console of the instance type.

6.109.2. remove DELETE

Remove the graphics console from the instance type.

Table 336. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.110. InstanceTypeGraphicsConsoles

Table 337. Methods summary
Name	Summary
`add`	Add new graphics console to the instance type.
`list`	Lists all the configured graphics consoles of the instance type.

6.110.1. add POST

Add new graphics console to the instance type.

Table 338. Parameters summary
Name	Type	Direction	Summary
`console`	GraphicsConsole	In/Out

6.110.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.

Table 339. Parameters summary
Name	Type	Direction	Summary
`consoles`	GraphicsConsole[]	Out	The list of graphics consoles of the instance type.
`max`	Integer	In	Sets the maximum number of consoles to return.

max

Sets the maximum number of consoles to return. If not specified all the consoles are returned.

6.111. InstanceTypeNic

Table 340. Methods summary
Name	Summary
`get`	Gets network interface configuration of the instance type.
`remove`	Remove the network interface from the instance type.
`update`	Updates the network interface configuration of the instance type.

6.111.1. get GET

Gets network interface configuration of the instance type.

Table 341. Parameters summary
Name	Type	Direction	Summary
`nic`	Nic	Out

6.111.2. remove DELETE

Remove the network interface from the instance type.

Table 342. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.111.3. update PUT

Updates the network interface configuration of the instance type.

Table 343. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`nic`	Nic	In/Out

6.112. InstanceTypeNics

Table 344. Methods summary
Name	Summary
`add`	Add new network interface to the instance type.
`list`	Lists all the configured network interface of the instance type.

6.112.1. add POST

Add new network interface to the instance type.

Table 345. Parameters summary
Name	Type	Direction	Summary
`nic`	Nic	In/Out

6.112.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.

Table 346. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of NICs to return.
`nics`	Nic[]	Out
`search`	String	In	A query string used to restrict the returned templates.

max

Sets the maximum number of NICs to return. If not specified all the NICs are returned.

6.113. InstanceTypeWatchdog

Table 347. Methods summary
Name	Summary
`get`	Gets watchdog configuration of the instance type.
`remove`	Remove a watchdog from the instance type.
`update`	Updates the watchdog configuration of the instance type.

6.113.1. get GET

Gets watchdog configuration of the instance type.

Table 348. Parameters summary
Name	Type	Direction	Summary
`watchdog`	Watchdog	Out

6.113.2. remove DELETE

Remove a watchdog from the instance type.

Table 349. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.113.3. update PUT

Updates the watchdog configuration of the instance type.

Table 350. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`watchdog`	Watchdog	In/Out

6.114. InstanceTypeWatchdogs

Table 351. Methods summary
Name	Summary
`add`	Add new watchdog to the instance type.
`list`	Lists all the configured watchdogs of the instance type.

6.114.1. add POST

Add new watchdog to the instance type.

Table 352. Parameters summary
Name	Type	Direction	Summary
`watchdog`	Watchdog	In/Out

6.114.2. list GET

Lists all the configured watchdogs of the instance type.

The order of the returned list of watchdogs isn’t guaranteed.

Table 353. Parameters summary
Name	Type	Direction	Summary
`max`	Integer	In	Sets the maximum number of watchdogs to return.
`search`	String	In	A query string used to restrict the returned templates.
`watchdogs`	Watchdog[]	Out

max

Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.

6.115. InstanceTypes

Table 354. Methods summary
Name	Summary
`add`	Creates a new instance type.
`list`	Lists all existing instance types in the system.

6.115.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

With a request body like this:

<instance_type>
  <name>myinstancetype</name>
</template>

Creating an instance type with all hardware configurations with a request body like this:

<instance_type>
  <name>myinstancetype</name>
  <console>
    <enabled>true</enabled>
  </console>
  <cpu>
    <topology>
      <cores>2</cores>
      <sockets>2</sockets>
      <threads>1</threads>
    </topology>
  </cpu>
  <custom_cpu_model>AMD Opteron_G2</custom_cpu_model>
  <custom_emulated_machine>q35</custom_emulated_machine>
  <display>
    <monitors>1</monitors>
    <single_qxl_pci>true</single_qxl_pci>
    <smartcard_enabled>true</smartcard_enabled>
    <type>spice</type>
  </display>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <io>
    <threads>2</threads>
  </io>
  <memory>4294967296</memory>
  <memory_policy>
    <ballooning>true</ballooning>
    <guaranteed>268435456</guaranteed>
  </memory_policy>
  <migration>
    <auto_converge>inherit</auto_converge>
    <compressed>inherit</compressed>
    <policy id="00000000-0000-0000-0000-000000000000"/>
  </migration>
  <migration_downtime>2</migration_downtime>
  <os>
    <boot>
      <devices>
        <device>hd</device>
      </devices>
    </boot>
  </os>
  <rng_device>
    <rate>
      <bytes>200</bytes>
      <period>2</period>
    </rate>
    <source>urandom</source>
  </rng_device>
  <soundcard_enabled>true</soundcard_enabled>
  <usb>
    <enabled>true</enabled>
    <type>native</type>
  </usb>
  <virtio_scsi>
    <enabled>true</enabled>
  </virtio_scsi>
</instance_type>

Table 355. Parameters summary
Name	Type	Direction	Summary
`instance_type`	InstanceType	In/Out

6.115.2. list GET

Lists all existing instance types in the system.

The order of the returned list of instance types isn’t guaranteed.

Table 356. Parameters summary
Name	Type	Direction	Summary
`case_sensitive`	Boolean	In	Indicates if the search performed using the `search` parameter should be performed taking case into account.
`instance_type`	InstanceType[]	Out
`max`	Integer	In	Sets the maximum number of instance types to return.
`search`	String	In	A query string used to restrict the returned templates.

case_sensitive

max

Sets the maximum number of instance types to return. If not specified all the instance types are returned.

6.116. IscsiBond

Table 357. Methods summary
Name	Summary
`get`
`remove`	Removes of an existing iSCSI bond.
`update`	Updates an iSCSI bond.

6.116.1. get GET

Table 358. Parameters summary
Name	Type	Direction	Summary
`bond`	IscsiBond	Out

6.116.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

Table 359. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the remove should be performed asynchronously.

6.116.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

The request body should look like this:

<iscsi_bond>
   <name>mybond</name>
   <description>My iSCSI bond</description>
</iscsi_bond>

Table 360. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the update should be performed asynchronously.
`bond`	IscsiBond	In/Out

6.117. IscsiBonds

Table 361. Methods summary
Name	Summary
`add`	Create a new iSCSI bond on a data center.
`list`	Returns the list of iSCSI bonds configured in the data center.

6.117.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

The request body should look like this:

<iscsi_bond>
  <name>mybond</name>
  <storage_connections>
    <storage_connection id="456"/>
    <storage_connection id="789"/>
  </storage_connections>
  <networks>
    <network id="abc"/>
  </networks>
</iscsi_bond>

Table 362. Parameters summary
Name	Type	Direction	Summary
`bond`	IscsiBond	In/Out

6.117.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.

Table 363. Parameters summary
Name	Type	Direction	Summary
`bonds`	IscsiBond[]	Out
`max`	Integer	In	Sets the maximum number of bonds to return.

max

Sets the maximum number of bonds to return. If not specified all the bonds are returned.

6.118. Job

A service to manage a job.

Table 364. Methods summary
Name	Summary
`clear`	Set an external job execution to be cleared by the system.
`end`	Marks an external job execution as ended.
`get`	Retrieves a job.

6.118.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

With the following request body:

<action/>

Table 365. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.

6.118.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

With the following request body:

<action>
  <force>true</force>
  <status>finished</status>
</action>

Table 366. Parameters summary
Name	Type	Direction	Summary
`async`	Boolean	In	Indicates if the action should be performed asynchronously.
`force`	Boolean	In	Indicates if the job should be forcibly terminated.
`succeeded`	Boolean	In	Indicates if the job should be marked as successfully finished or as failed.

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.118.3. get GET

Retrieves a job.

GET /ovirt-engine/api/jobs/123

You will receive response in XML like this one:

<job href="/ovirt-engine/api/jobs/123" id="123">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/clear" rel="clear"/>
    <link href="/ovirt-engine/api/jobs/123/end" rel="end"/>
  </actions>
  <description>Adding Disk</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <end_time>2016-12-12T23:07:29.758+02:00</end_time>
  <external>false</external>
  <last_updated>2016-12-12T23:07:29.758+02:00</last_updated>
  <start_time>2016-12-12T23:07:26.593+02:00</start_time>
  <status>failed</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>

Table 367. Parameters summary
Name	Type	Direction	Summary
`job`	Job	Out	Retrieves the representation of the job.

6.119. Jobs

A service to manage jobs.