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:

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

-----BEGIN CERTIFICATE-----
MIIDxjCCAq6gAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwSTELMAkGA1UEBhMCVVMx
FTATBgNVBAoTDEV4YW1wbGUgSW5jLjEjMCEGA1UEAxMaZW5naW5lNDEuZXhhbXBs
Pkyg1rQHR6ebGQ==
-----END CERTIFICATE-----
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.

  1. If the browser downloads the certificate: save the file as ca.crt.

  2. 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, export the certificate from the truststore, and copy it to your client machine.

  1. Log in to the oVirt Engine machine as root.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4. Requests

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

5. Services

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

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

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

5.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 remove should be performed asynchronously.

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

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

5.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 remove should be performed asynchronously.

5.3. AffinityGroupVms

This service manages a collection of all virtual machines assigned to an affinity group.

Table 9. Methods summary
Name Summary

add

Add a virtual machine to the affinity group.

list

List all virtual machines assigned to this affinity group.

5.3.1. add POST

Add a virtual machine to the affinity group.

For example to add the virtual machine 000-000 to affinity group 123-456 send a request to:

POST /ovirt-engine/api/clusters/000-000/affinitygroups/123-456/vms

With the following body:

<vm id="000-000"/>
Table 10. Parameters summary
Name Type Direction Summary

vm

Vm

In/Out

5.3.2. list GET

List all virtual machines assigned to this affinity group.

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.

5.4. AffinityGroups

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.

5.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>
  <positive>true</positive>
  <enforcing>true</enforcing>
</affinity_group>
Table 13. Parameters summary
Name Type Direction Summary

group

AffinityGroup

In/Out

The affinity group object to create.

5.4.2. list GET

List existing affinity groups.

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.

5.5. AffinityLabel

Single affinity label details.

Table 15. Methods summary
Name Summary

get

Retrieves details about a label.

remove

Removes a label from system and clears all assignments of the removed label.

update

Updates a label.

5.5.1. get GET

Retrieves details about a label.

Table 16. Parameters summary
Name Type Direction Summary

label

AffinityLabel

Out

5.5.2. remove DELETE

Removes a label from system and clears all assignments of the removed label.

5.5.3. update PUT

Updates a label.

This call will update all metadata like name or description.

Table 17. Parameters summary
Name Type Direction Summary

label

AffinityLabel

In/Out

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

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

5.6.2. remove DELETE

Remove a label from a host.

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

5.7.1. add POST

Add a label to a host.

Table 21. Parameters summary
Name Type Direction Summary

host

Host

In/Out

5.7.2. list GET

List all hosts with the label.

Table 22. Parameters summary
Name Type Direction Summary

hosts

Host[]

Out

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

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

5.8.2. remove DELETE

Remove a label from a vm.

5.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 vms with the label.

5.9.1. add POST

Add a label to a vm.

Table 26. Parameters summary
Name Type Direction Summary

vm

Vm

In/Out

5.9.2. list GET

List all vms with the label.

Table 27. Parameters summary
Name Type Direction Summary

vms

Vm[]

Out

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

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

5.10.2. list GET

Lists all labels present in the system.

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.

5.11. Area

This annotation is intended to specify what oVirt area is the annotated concept related to. Currently the following areas are in use, and they are closely related to the oVirt teams, but not necessarily the same:

  • Infrastructure

  • Network

  • SLA

  • Storage

  • Virtualization

A concept may be associated to more than one area, or to no area.

The value of this annotation is intended for reporting only, and it doesn’t affect at all the generated code or the validity of the model

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

5.12.1. get GET

Retrieves details about the attached label.

Table 32. Parameters summary
Name Type Direction Summary

label

AffinityLabel

Out

5.12.2. remove DELETE

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

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

5.13.1. add POST

Attaches a label to an entity.

Table 34. Parameters summary
Name Type Direction Summary

label

AffinityLabel

In/Out

5.13.2. list GET

Lists all labels that are attached to an entity.

Table 35. Parameters summary
Name Type Direction Summary

label

AffinityLabel[]

Out

5.14. AssignedCpuProfile

Table 36. Methods summary
Name Summary

get

remove

5.14.1. get GET

Table 37. Parameters summary
Name Type Direction Summary

profile

CpuProfile

Out

5.14.2. remove DELETE

Table 38. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.15. AssignedCpuProfiles

Table 39. Methods summary
Name Summary

add

list

5.15.1. add POST

Table 40. Parameters summary
Name Type Direction Summary

profile

CpuProfile

In/Out

5.15.2. list GET

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.

5.16. AssignedDiskProfile

Table 42. Methods summary
Name Summary

get

remove

5.16.1. get GET

Table 43. Parameters summary
Name Type Direction Summary

disk_profile

DiskProfile

Out

5.16.2. remove DELETE

Table 44. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.17. AssignedDiskProfiles

Table 45. Methods summary
Name Summary

add

list

5.17.1. add POST

Table 46. Parameters summary
Name Type Direction Summary

profile

DiskProfile

In/Out

5.17.2. list GET

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.

5.18. AssignedNetwork

Table 48. Methods summary
Name Summary

get

remove

update

5.18.1. get GET

Table 49. Parameters summary
Name Type Direction Summary

network

Network

Out

5.18.2. remove DELETE

Table 50. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.18.3. update PUT

Table 51. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

network

Network

In/Out

5.19. AssignedNetworks

Table 52. Methods summary
Name Summary

add

list

5.19.1. add POST

Table 53. Parameters summary
Name Type Direction Summary

network

Network

In/Out

5.19.2. list GET

Table 54. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of networks to return.

networks

Network[]

Out
max

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

5.20. AssignedPermissions

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

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

5.20.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 56. Parameters summary
Name Type Direction Summary

permission

Permission

In/Out

The permission.

5.20.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>
Table 57. Parameters summary
Name Type Direction Summary

permissions

Permission[]

Out

The list of permissions.

5.21. AssignedRoles

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

Table 58. Methods summary
Name Summary

list

5.21.1. list GET

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

5.22. AssignedTag

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

Table 60. Methods summary
Name Summary

get

Gets the information about the assigned tag.

remove

Unassign tag from specific entity in the system.

5.22.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 61. Parameters summary
Name Type Direction Summary

tag

Tag

Out

The assigned tag.

5.22.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 62. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.23. AssignedTags

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

Table 63. Methods summary
Name Summary

add

Assign tag to specific entity in the system.

list

List all tags assigned to the specific entity.

5.23.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 64. Parameters summary
Name Type Direction Summary

tag

Tag

In/Out

The assigned tag.

5.23.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>
Table 65. 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.

5.24. AssignedVnicProfile

Table 66. Methods summary
Name Summary

get

remove

5.24.1. get GET

Table 67. Parameters summary
Name Type Direction Summary

profile

VnicProfile

Out

5.24.2. remove DELETE

Table 68. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.25. AssignedVnicProfiles

Table 69. Methods summary
Name Summary

add

list

5.25.1. add POST

Table 70. Parameters summary
Name Type Direction Summary

profile

VnicProfile

In/Out

5.25.2. list GET

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

5.26. AttachedStorageDomain

Table 72. Methods summary
Name Summary

activate

This operation activates an attached storage domain.

deactivate

This operation deactivates an attached storage domain.

get

remove

5.26.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 73. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the activation should be performed asynchronously.

5.26.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 74. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the deactivation should be performed asynchronously.

5.26.3. get GET

Table 75. Parameters summary
Name Type Direction Summary

storage_domain

StorageDomain

Out

5.26.4. remove DELETE

Table 76. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.27. AttachedStorageDomainDisk

Manages a single disk available in a storage domain attached to a data center.

Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations use the service that manages all the disks of the system, or the service that manages an specific disk.
Table 77. Methods summary
Name Summary

copy

Copies a disk to the specified storage domain.

export

Exports a disk to an export storage domain.

get

Retrieves the description of the disk.

move

Moves a disk to another storage domain.

register

Registers an unregistered disk.

remove

Removes a disk.

sparsify

Sparsify the disk.

update

Updates the disk.

5.27.1. copy POST

Copies a disk to the specified storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To copy a disk use the copy operation of the service that manages that disk.
Table 78. Parameters summary
Name Type Direction Summary

disk

Disk

In

Description of the resulting disk.

storage_domain

StorageDomain

In

The storage domain where the new disk will be created.

5.27.2. export POST

Exports a disk to an export storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To export a disk use the export operation of the service that manages that disk.
Table 79. Parameters summary
Name Type Direction Summary

storage_domain

StorageDomain

In

The export storage domain where the disk should be exported to.

5.27.3. get GET

Retrieves the description of the disk.

Table 80. Parameters summary
Name Type Direction Summary

disk

Disk

Out

The description of the disk.

5.27.4. move POST

Moves a disk to another storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To move a disk use the move operation of the service that manages that disk.
Table 81. 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

The storage domain where the disk will be moved to.

5.27.5. register POST

Registers an unregistered disk.

5.27.6. remove DELETE

Removes a disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.

5.27.7. sparsify POST

Sparsify the disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.

5.27.8. update PUT

Updates the disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To update a disk use the update operation of the service that manages that disk.
Table 82. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The update to apply to the disk.

5.28. AttachedStorageDomainDisks

Manages the collection of disks available inside an storage domain that is attached to a data center.

Table 83. Methods summary
Name Summary

add

Adds or registers a disk.

list

Retrieve the list of disks that are available in the storage domain.

5.28.1. add POST

Adds or registers a disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To add a new disk use the add operation of the service that manages the disks of the system. To register an unregistered disk use the register operation of the service that manages that disk.
Table 84. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The disk to add or register.

unregistered

Boolean

In

Indicates if a new disk should be added or if an existing unregistered disk should be registered.
unregistered

Indicates if a new disk should be added or if an existing unregistered disk should be registered. If the value is true then the identifier of the disk to register needs to be provided. For example, to register the disk with id 456 send a request like this:

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

With a request body like this:

<disk id="456"/>

If the value is false then a new disk will be created in the storage domain. In that case the provisioned_size, format and name attributes are mandatory. For example, to create a new copy on write disk of 1 GiB, send a request like this:

POST /ovirt-engine/api/storagedomains/123/disks

With a request body like this:

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

The default value is false.

5.28.2. list GET

Retrieve the list of disks that are available in the storage domain.

Table 85. Parameters summary
Name Type Direction Summary

disks

Disk[]

Out

List of retrieved disks.

max

Integer

In

Sets the maximum number of disks to return.
max

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

5.29. AttachedStorageDomains

Table 86. Methods summary
Name Summary

add

list

5.29.1. add POST

Table 87. Parameters summary
Name Type Direction Summary

storage_domain

StorageDomain

In/Out

5.29.2. list GET

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

5.30. Balance

Table 89. Methods summary
Name Summary

get

remove

5.30.1. get GET

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

5.30.2. remove DELETE

Table 91. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.31. Balances

Table 92. Methods summary
Name Summary

add

list

5.31.1. add POST

Table 93. Parameters summary
Name Type Direction Summary

balance

Balance

In/Out

5.31.2. list GET

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

5.32. Bookmark

A service to manage a bookmark.

Table 95. Methods summary
Name Summary

get

Get a bookmark.

remove

Remove a bookmark.

update

Update a bookmark.

5.32.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 96. Parameters summary
Name Type Direction Summary

bookmark

Bookmark

Out

The requested bookmark.

5.32.2. remove DELETE

Remove a bookmark.

An example for removing a bookmark:

DELETE /ovirt-engine/api/bookmarks/123
Table 97. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.32.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 98. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

bookmark

Bookmark

In/Out

The updated bookmark.

5.33. Bookmarks

A service to manage bookmarks.

Table 99. Methods summary
Name Summary

add

Adding a new bookmark.

list

Listing all the available bookmarks.

5.33.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 100. Parameters summary
Name Type Direction Summary

bookmark

Bookmark

In/Out

The added bookmark.

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

5.34. Cluster

A service to manage specific cluster.

Table 102. Methods summary
Name Summary

get

Get information about the cluster.

remove

Removes cluster from the system.

resetemulatedmachine

update

Updates information about the cluster.

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

5.34.2. remove DELETE

Removes cluster from the system.

DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
Table 104. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.34.3. resetemulatedmachine POST

Table 105. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the reset should be performed asynchronously.

5.34.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 106. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

cluster

Cluster

In/Out

5.35. ClusterLevel

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

Table 107. Methods summary
Name Summary

get

Provides the information about the capabilities of the specific cluster level managed by this service.

5.35.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 108. Parameters summary
Name Type Direction Summary

level

ClusterLevel

Out

Retreived cluster level.

5.36. 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 109. Methods summary
Name Summary

list

Lists the cluster levels supported by the system.

5.36.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>
Table 110. Parameters summary
Name Type Direction Summary

levels

ClusterLevel[]

Out

Retrieved cluster levels.

5.37. Clusters

A service to manage clusters.

Table 111. Methods summary
Name Summary

add

Creates a new cluster.

list

5.37.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 112. Parameters summary
Name Type Direction Summary

cluster

Cluster

In/Out

5.37.2. list GET

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

5.38. Copyable

Table 114. Methods summary
Name Summary

copy

5.38.1. copy POST

Table 115. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the copy should be performed asynchronously.

5.39. CpuProfile

Table 116. Methods summary
Name Summary

get

remove

update

5.39.1. get GET

Table 117. Parameters summary
Name Type Direction Summary

profile

CpuProfile

Out

5.39.2. remove DELETE

Table 118. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.39.3. update PUT

Table 119. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

profile

CpuProfile

In/Out

5.40. CpuProfiles

Table 120. Methods summary
Name Summary

add

list

5.40.1. add POST

Table 121. Parameters summary
Name Type Direction Summary

profile

CpuProfile

In/Out

5.40.2. list GET

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

5.41. DataCenter

A service to manage a data center.

Table 123. Methods summary
Name Summary

get

Get a data center.

remove

Removes the data center.

update

Updates the data center.

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

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

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

5.42. DataCenters

A service to manage data centers.

Table 127. Methods summary
Name Summary

add

Creates a new data center.

list

Lists the data centers.

5.42.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 128. Parameters summary
Name Type Direction Summary

data_center

DataCenter

In/Out

The data center that is being added.

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

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

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 data centers to return. If not specified all the data centers are returned.

5.43. Disk

Manages a single disk.

Table 130. Methods summary
Name Summary

copy

This operation copies a disk to the specified storage domain.

export

Exports a disk to an export storage domain.

get

Retrieves the description of the disk.

move

Moves a disk to another storage domain.

remove

Removes a disk.

sparsify

Sparsify the disk.

update

This operation updates the disk with the appropriate parameters.

5.43.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 131. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the copy should be performed asynchronously.

disk

Disk

In

Description of the resulting disk.

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

storage_domain

StorageDomain

In

The storage domain where the new disk will be created.
disk

Description of the resulting disk. The only accepted value is the name attribute, which will be the name used for the new disk. For example, to copy disk 123 using myname as the name for the new disk, send a request like this:

POST /ovirt-engine/disks/123

With a request body like this:

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

The storage domain where the new disk will be created. Can be specified using the id or name attributes. For example, to copy a disk to the storage domain named mydata send a request like this:

POST /ovirt-engine/api/storagedomains/123/disks/789

With a request body like this:

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

5.43.2. export POST

Exports a disk to an export storage domain.

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

The export storage domain where the disk should be exported to.

5.43.3. get GET

Retrieves the description of the disk.

Table 133. Parameters summary
Name Type Direction Summary

disk

Disk

Out

The description of the disk.

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

The storage domain where the disk will be moved to.

5.43.5. remove DELETE

Removes a disk.

Table 135. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

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

5.43.7. update PUT

This operation updates the disk with the appropriate parameters. The only field that can be updated is qcow_version.

For example, update disk can be facilitated using the following request:

PUT /ovirt-engine/api/disks/123

With a request body like this:

<disk>
  <qcow_version>qcow2_v3</qcow_version>
</disk>

Since the backend operation is asynchronous the disk element which will be returned to the user might not be synced with the changed properties.

Table 136. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The update to apply to the disk.

5.44. DiskAttachment

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

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

5.44.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 138. Parameters summary
Name Type Direction Summary

attachment

DiskAttachment

Out

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

5.44.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 140. Parameters summary
Name Type Direction Summary

disk_attachment

DiskAttachment

In/Out

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

5.45.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 142. Parameters summary
Name Type Direction Summary

attachment

DiskAttachment

In/Out

5.45.2. list GET

List the disk that are attached to the virtual machine.

Table 143. Parameters summary
Name Type Direction Summary

attachments

DiskAttachment[]

Out

5.46. DiskProfile

Table 144. Methods summary
Name Summary

get

remove

update

5.46.1. get GET

Table 145. Parameters summary
Name Type Direction Summary

profile

DiskProfile

Out

5.46.2. remove DELETE

Table 146. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.46.3. update PUT

Table 147. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

profile

DiskProfile

In/Out

5.47. DiskProfiles

Table 148. Methods summary
Name Summary

add

list

5.47.1. add POST

Table 149. Parameters summary
Name Type Direction Summary

profile

DiskProfile

In/Out

5.47.2. list GET

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

5.48. DiskSnapshot

Table 151. Methods summary
Name Summary

get

remove

5.48.1. get GET

Table 152. Parameters summary
Name Type Direction Summary

snapshot

DiskSnapshot

Out

5.48.2. remove DELETE

Table 153. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.49. DiskSnapshots

Table 154. Methods summary
Name Summary

list

5.49.1. list GET

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

5.50. Disks

Manages the collection of disks available in the system.

Table 156. Methods summary
Name Summary

add

Adds a new floating disk.

list

Get list of disks.

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

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

  2. 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 157. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The disk.

5.50.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>
Table 158. 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.
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 disks to return. If not specified all the disks are returned.

5.51. Domain

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

Table 159. Methods summary
Name Summary

get

Gets the authentication domain information.

5.51.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 160. Parameters summary
Name Type Direction Summary

domain

Domain

Out

The authentication domain.

5.52. DomainGroup

Table 161. Methods summary
Name Summary

get

5.52.1. get GET

Table 162. Parameters summary
Name Type Direction Summary

get

Group

Out

5.53. DomainGroups

Table 163. Methods summary
Name Summary

list

5.53.1. list GET

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

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 groups to return. If not specified all the groups are returned.

5.54. DomainUser

A service to view a domain user in the system.

Table 165. Methods summary
Name Summary

get

Gets the domain user information.

5.54.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 166. Parameters summary
Name Type Direction Summary

user

User

Out

The domain user.

5.55. DomainUsers

A service to list all domain users in the system.

Table 167. Methods summary
Name Summary

list

List all the users in the domain.

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

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

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 users to return. If not specified all the users are returned.

5.56. Domains

A service to list all authentication domains in the system.

Table 169. Methods summary
Name Summary

list

List all the authentication domains in the system.

5.56.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>
Table 170. 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.

5.57. EngineKatelloErrata

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

Table 171. Methods summary
Name Summary

list

Retrieves the representation of the Katello errata.

5.57.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>
Table 172. 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.

5.58. Event

A service to manage an event in the system.

Table 173. Methods summary
Name Summary

get

Get an event.

remove

Removes an event from internal audit log.

5.58.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 174. Parameters summary
Name Type Direction Summary

event

Event

Out

5.58.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 175. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.59. Events

A service to manage events in the system.

Table 176. Methods summary
Name Summary

add

Adds an external event to the internal audit log.

list

Get list of events.

undelete

5.59.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 177. Parameters summary
Name Type Direction Summary

event

Event

In/Out

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

Table 178. 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 identifier of the the first event that 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

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.

from

Indicates the identifier of the the first event that should be returned. The identifiers of events are strictly increasing, so when this parameter is used only the events with that identifiers equal or greater than the given value will be returned. For example, the following request will return only the events with identifiers greater or equal 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

5.59.3. undelete POST

Table 179. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the un-delete should be performed asynchronously.

5.60. ExternalComputeResource

Table 180. Methods summary
Name Summary

get

5.60.1. get GET

Table 181. Parameters summary
Name Type Direction Summary

resource

ExternalComputeResource

Out

5.61. ExternalComputeResources

Table 182. Methods summary
Name Summary

list

5.61.1. list GET

Table 183. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of resources to return.

resources

ExternalComputeResource[]

Out
max

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

5.62. ExternalDiscoveredHost

Table 184. Methods summary
Name Summary

get

5.62.1. get GET

Table 185. Parameters summary
Name Type Direction Summary

host

ExternalDiscoveredHost

Out

5.63. ExternalDiscoveredHosts

Table 186. Methods summary
Name Summary

list

5.63.1. list GET

Table 187. Parameters summary
Name Type Direction Summary

hosts

ExternalDiscoveredHost[]

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.

5.64. ExternalHost

Table 188. Methods summary
Name Summary

get

5.64.1. get GET

Table 189. Parameters summary
Name Type Direction Summary

host

ExternalHost

Out

5.65. ExternalHostGroup

Table 190. Methods summary
Name Summary

get

5.65.1. get GET

Table 191. Parameters summary
Name Type Direction Summary

group

ExternalHostGroup

Out

5.66. ExternalHostGroups

Table 192. Methods summary
Name Summary

list

5.66.1. list GET

Table 193. Parameters summary
Name Type Direction Summary

groups

ExternalHostGroup[]

Out

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.

5.67. ExternalHostProvider

Table 194. Methods summary
Name Summary

get

importcertificates

remove

testconnectivity

update

5.67.1. get GET

Table 195. Parameters summary
Name Type Direction Summary

provider

ExternalHostProvider

Out

5.67.2. importcertificates POST

Table 196. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

In

5.67.3. remove DELETE

Table 197. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.67.4. testconnectivity POST

Table 198. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the test should be performed asynchronously.

5.67.5. update PUT

Table 199. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

provider

ExternalHostProvider

In/Out

5.68. ExternalHostProviders

Table 200. Methods summary
Name Summary

add

list

5.68.1. add POST

Table 201. Parameters summary
Name Type Direction Summary

provider

ExternalHostProvider

In/Out

5.68.2. list GET

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

5.69. ExternalHosts

Table 203. Methods summary
Name Summary

list

5.69.1. list GET

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

5.70. ExternalProvider

Table 205. Methods summary
Name Summary

importcertificates

testconnectivity

5.70.1. importcertificates POST

Table 206. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

In

5.70.2. testconnectivity POST

Table 207. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the test should be performed asynchronously.

5.71. ExternalProviderCertificate

Table 208. Methods summary
Name Summary

get

5.71.1. get GET

Table 209. Parameters summary
Name Type Direction Summary

certificate

Certificate

Out

5.72. ExternalProviderCertificates

Table 210. Methods summary
Name Summary

list

5.72.1. list GET

Table 211. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

Out

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.

5.73. ExternalVmImports

Provides capability to import external virtual machines.

Table 212. Methods summary
Name Summary

add

This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware.

5.73.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 213. Parameters summary
Name Type Direction Summary

import

ExternalVmImport

In/Out

5.74. FenceAgent

Table 214. Methods summary
Name Summary

get

remove

update

5.74.1. get GET

Table 215. Parameters summary
Name Type Direction Summary

agent

Agent

Out

5.74.2. remove DELETE

Table 216. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.74.3. update PUT

Table 217. Parameters summary
Name Type Direction Summary

agent

Agent

In/Out

async

Boolean

In

Indicates if the update should be performed asynchronously.

5.75. FenceAgents

Table 218. Methods summary
Name Summary

add

list

5.75.1. add POST

Table 219. Parameters summary
Name Type Direction Summary

agent

Agent

In/Out

5.75.2. list GET

Table 220. Parameters summary
Name Type Direction Summary

agents

Agent[]

Out

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.

5.76. File

Table 221. Methods summary
Name Summary

get

5.76.1. get GET

Table 222. Parameters summary
Name Type Direction Summary

file

File

Out

5.77. Files

Provides a way for clients to list available files.

This services is specifically targeted to ISO storage domains, which contain ISO images and virtual floppy disks (VFDs) that an administrator uploads.

The addition of a CDROM device to a virtual machine requires an ISO image from the files of an ISO storage domain.

Table 223. Methods summary
Name Summary

list

5.77.1. list GET

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

file

File[]

Out

max

Integer

In

Sets the maximum number of files to return.

search

String

In

A query string used to restrict the returned files.
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 files to return. If not specified all the files are returned.

5.78. Filter

Table 225. Methods summary
Name Summary

get

remove

5.78.1. get GET

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

5.78.2. remove DELETE

Table 227. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.79. Filters

Table 228. Methods summary
Name Summary

add

list

5.79.1. add POST

Table 229. Parameters summary
Name Type Direction Summary

filter

Filter

In/Out

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

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.

5.80. GlusterBrick

This service manages a single gluster brick.

Table 231. Methods summary
Name Summary

get

Get details of a brick.

remove

Removes a brick.

replace

Replaces this brick with a new one.

5.80.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 232. Parameters summary
Name Type Direction Summary

brick

GlusterBrick

Out

5.80.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 233. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.80.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 234. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the replacement should be performed asynchronously.

force

Boolean

In

5.81. GlusterBricks

This service manages the gluster bricks in a gluster volume

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

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

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

5.81.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>
Table 238. 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.

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

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

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

5.82. GlusterHook

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

5.82.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 243. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.82.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 244. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.82.3. get GET

Table 245. Parameters summary
Name Type Direction Summary

hook

GlusterHook

Out

5.82.4. remove DELETE

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

Table 246. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.82.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 247. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

host

Host

In

resolution_type

String

In

5.83. GlusterHooks

Table 248. Methods summary
Name Summary

list

5.83.1. list GET

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

5.84. GlusterVolume

This service manages a single gluster volume.

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

5.84.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 251. Parameters summary
Name Type Direction Summary

volume

GlusterVolume

Out

Representation of the gluster volume.

5.84.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 252. Parameters summary
Name Type Direction Summary

details

GlusterVolumeProfileDetails

Out

Gluster volume profiling information returned from the action.

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

5.84.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 254. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.84.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 255. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the reset should be performed asynchronously.

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

5.84.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 257. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

option

Option

In

Option to set.

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

5.84.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 259. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.84.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 260. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

force

Boolean

In

5.84.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 261. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.84.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 262. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.85. GlusterVolumes

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

Table 263. Methods summary
Name Summary

add

Creates a new gluster volume.

list

Lists all gluster volumes in the cluster.

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

5.85.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
Table 265. 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

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 volumes to return. If not specified all the volumes are returned.

5.86. Group

Table 266. Methods summary
Name Summary

get

remove

5.86.1. get GET

Table 267. Parameters summary
Name Type Direction Summary

get

Group

Out

5.86.2. remove DELETE

Table 268. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.87. Groups

Table 269. Methods summary
Name Summary

add

Add group from a directory service.

list

5.87.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 270. Parameters summary
Name Type Direction Summary

group

Group

In/Out

5.87.2. list GET

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

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 groups to return. If not specified all the groups are returned.

5.88. Host

A service to manage a host.

Table 272. Methods summary
Name Summary

activate

Activate the host for use, such as running 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

Deactivate the host to perform maintenance tasks.

enrollcertificate

Enroll certificate of the host.

fence

Controls host’s power management device.

forceselectspm

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

get

Get the host details.

install

Install VDSM and related software on the host.

iscsidiscover

Discover 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

update

Update the host properties.

upgrade

Upgrade VDSM and selected software on the host.

upgradecheck

Check if there are upgrades available for the host.

5.88.1. activate POST

Activate the host for use, such as running virtual machines.

Table 273. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the activation should be performed asynchronously.

5.88.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 274. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the approval should be performed asynchronously.

cluster

Cluster

In

5.88.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 275. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.88.4. deactivate POST

Deactivate the host to perform maintenance tasks.

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

5.88.5. enrollcertificate POST

Enroll certificate of the host. Useful in case you get a warning that it is about to, or already expired.

Table 277. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the enrollment should be performed asynchronously.

5.88.6. fence POST

Controls host’s power management device.

For example, let’s assume you want 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 278. 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

5.88.7. forceselectspm POST

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 279. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.88.8. get GET

Get the host details.

Table 280. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

host

Host

Out

5.88.9. install POST

Install 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"
Table 281. 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 deploy also hosted engine components.

host

Host

In

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

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

5.88.10. iscsidiscover POST

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

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

5.88.11. iscsilogin POST

Login to iSCSI targets on the host, using the target details.

Table 283. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the login should be performed asynchronously.

iscsi

IscsiDetails

In

The target iSCSI device.

5.88.12. refresh POST

Refresh the host devices and capabilities.

Table 284. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the refresh should be performed asynchronously.

5.88.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 285. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.88.14. setupnetworks POST

This method is used to change the configuration of the network interfaces of a host.

For example, lets assume that you have a host with three network interfaces eth0, eth1 and eth2 and that 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"

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

5.88.15. unregisteredstoragedomainsdiscover POST

Table 287. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the discovery should be performed asynchronously.

iscsi

IscsiDetails

In

storage_domains

StorageDomain[]

Out

5.88.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 288. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

host

Host

In/Out

5.88.17. upgrade POST

Upgrade VDSM and selected software on the host.

Table 289. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the upgrade should be performed asynchronously.

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

5.89. HostDevice

A service to access a particular device of a host.

Table 290. Methods summary
Name Summary

get

Retrieve information about a particular host’s device.

5.89.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 291. Parameters summary
Name Type Direction Summary

device

HostDevice

Out

5.90. HostDevices

A service to access host devices.

Table 292. Methods summary
Name Summary

list

List the devices of a host.

5.90.1. list GET

List the devices of a host.

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

5.91. HostHook

Table 294. Methods summary
Name Summary

get

5.91.1. get GET

Table 295. Parameters summary
Name Type Direction Summary

hook

Hook

Out

5.92. HostHooks

Table 296. Methods summary
Name Summary

list

5.92.1. list GET

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

5.93. HostNic

A service to manage a network interface of a host.

Table 298. Methods summary
Name Summary

get

updatevirtualfunctionsconfiguration

The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC.

5.93.1. get GET

Table 299. Parameters summary
Name Type Direction Summary

nic

HostNic

Out

5.93.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 300. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

In

5.94. HostNics

A service to manage the network interfaces of a host.

Table 301. Methods summary
Name Summary

list

5.94.1. list GET

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

5.95. HostNumaNode

Table 303. Methods summary
Name Summary

get

5.95.1. get GET

Table 304. Parameters summary
Name Type Direction Summary

node

NumaNode

Out

5.96. HostNumaNodes

Table 305. Methods summary
Name Summary

list

5.96.1. list GET

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

5.97. HostStorage

A service to manage host storages.

Table 307. Methods summary
Name Summary

list

Get list of storages.

5.97.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>
Table 308. 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>

5.98. Hosts

A service that manages hosts.

Table 309. Methods summary
Name Summary

add

Creates a new host.

list

Get a list of all available hosts.

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

To add a hosted engine host, use the optional deploy_hosted_engine parameter:

POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
Table 310. 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.

5.98.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>
Table 311. 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.

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.
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 hosts to return. If not specified all the hosts are returned.

5.99. Icon

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

Table 312. Methods summary
Name Summary

get

Get an icon.

5.99.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 313. Parameters summary
Name Type Direction Summary

icon

Icon

Out

Retrieved icon.

5.100. Icons

A service to manage icons.

Table 314. Methods summary
Name Summary

list

Get a list of icons.

5.100.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>
Table 315. 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.

5.101. Image

Table 316. Methods summary
Name Summary

get

import

5.101.1. get GET

Table 317. Parameters summary
Name Type Direction Summary

image

Image

Out

5.101.2. import POST

Table 318. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the import should be performed asynchronously.

cluster

Cluster

In

Cluster where the image should be imported.

disk

Disk

In

The disk which should be imported.

import_as_template

Boolean

In

Specify if template should be created from the imported disk.

storage_domain

StorageDomain

In

Storage domain where disk should be imported.

template

Template

In

Name of the template, which should be created.
cluster

Cluster where the image should be imported. Has effect only in case import_as_template parameter is set to true.

template

Name of the template, which should be created. Has effect only in case import_as_template parameter is set to true.

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

5.102.1. extend POST

Extend the image transfer session.

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

5.102.3. get GET

Get the image transfer entity.

Table 320. Parameters summary
Name Type Direction Summary

image_transfer

ImageTransfer

Out

5.102.4. pause POST

Pause the image transfer session.

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

5.103. ImageTransfers

This service manages image transfers, for performing Image I/O API in oVirt. Please refer to image transfer for further documentation.

Table 321. Methods summary
Name Summary

add

Add a new image transfer.

list

Retrieves the list of image transfers that are currently being performed.

5.103.1. add POST

Add a new image transfer. An image needs to be specified in order to make a new transfer.

Table 322. Parameters summary
Name Type Direction Summary

image_transfer

ImageTransfer

In/Out

5.103.2. list GET

Retrieves the list of image transfers that are currently being performed.

Table 323. Parameters summary
Name Type Direction Summary

image_transfer

ImageTransfer[]

Out

5.104. Images

Table 324. Methods summary
Name Summary

list

5.104.1. list GET

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

5.105. InstanceType

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

5.105.1. get GET

Get a specific instance type and it’s attributes.

GET /ovirt-engine/api/instancetypes/123
Table 327. Parameters summary
Name Type Direction Summary

instance_type

InstanceType

Out

5.105.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 328. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.105.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 329. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

instance_type

InstanceType

In/Out

5.106. InstanceTypeGraphicsConsole

Table 330. Methods summary
Name Summary

get

Gets graphics console configuration of the instance type.

remove

Remove the graphics console from the instance type.

5.106.1. get GET

Gets graphics console configuration of the instance type.

Table 331. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

Out

The information about the graphics console of the instance type.

5.106.2. remove DELETE

Remove the graphics console from the instance type.

Table 332. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.107. InstanceTypeGraphicsConsoles

Table 333. Methods summary
Name Summary

add

Add new graphics console to the instance type.

list

Lists all the configured graphics consoles of the instance type.

5.107.1. add POST

Add new graphics console to the instance type.

Table 334. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

In/Out

5.107.2. list GET

Lists all the configured graphics consoles of the instance type.

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

5.108. InstanceTypeNic

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

5.108.1. get GET

Gets network interface configuration of the instance type.

Table 337. Parameters summary
Name Type Direction Summary

nic

Nic

Out

5.108.2. remove DELETE

Remove the network interface from the instance type.

Table 338. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.108.3. update PUT

Updates the network interface configuration of the instance type.

Table 339. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

nic

Nic

In/Out

5.109. InstanceTypeNics

Table 340. Methods summary
Name Summary

add

Add new network interface to the instance type.

list

Lists all the configured network interface of the instance type.

5.109.1. add POST

Add new network interface to the instance type.

Table 341. Parameters summary
Name Type Direction Summary

nic

Nic

In/Out

5.109.2. list GET

Lists all the configured network interface of the instance type.

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

5.110. InstanceTypeWatchdog

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

5.110.1. get GET

Gets watchdog configuration of the instance type.

Table 344. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

Out

5.110.2. remove DELETE

Remove a watchdog from the instance type.

Table 345. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.110.3. update PUT

Updates the watchdog configuration of the instance type.

Table 346. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

watchdog

Watchdog

In/Out

5.111. InstanceTypeWatchdogs

Table 347. Methods summary
Name Summary

add

Add new watchdog to the instance type.

list

Lists all the configured watchdogs of the instance type.

5.111.1. add POST

Add new watchdog to the instance type.

Table 348. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

In/Out

5.111.2. list GET

Lists all the configured watchdogs of the instance type.

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

5.112. InstanceTypes

Table 350. Methods summary
Name Summary

add

Creates a new instance type.

list

Lists all existing instance types in the system.

5.112.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 351. Parameters summary
Name Type Direction Summary

instance_type

InstanceType

In/Out

5.112.2. list GET

Lists all existing instance types in the system.

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

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 instance types to return. If not specified all the instance types are returned.

5.113. IscsiBond

Table 353. Methods summary
Name Summary

get

remove

Removes of an existing iSCSI bond.

update

Updates an iSCSI bond.

5.113.1. get GET

Table 354. Parameters summary
Name Type Direction Summary

bond

IscsiBond

Out

5.113.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 355. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.113.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 356. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

bond

IscsiBond

In/Out

5.114. IscsiBonds

Table 357. Methods summary
Name Summary

add

Create a new iSCSI bond on a data center.

list

5.114.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 358. Parameters summary
Name Type Direction Summary

bond

IscsiBond

In/Out

5.114.2. list GET

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

5.115. Job

A service to manage a job.

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

5.115.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 361. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

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

5.115.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 363. Parameters summary
Name Type Direction Summary

job

Job

Out

Retrieves the representation of the job.

5.116. Jobs

A service to manage jobs.

Table 364. Methods summary
Name Summary

add

Add an external job.

list

Retrieves the representation of the jobs.

5.116.1. add POST

Add an external job.

For example, to add a job with the following request:

POST /ovirt-engine/api/jobs

With the following request body:

<job>
  <description>Doing some work</description>
  <auto_cleared>true</auto_cleared>
</job>

The response should look like:

<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>Doing some work</description>
  <link href="/ovirt-engine/api/jobs/123/steps" rel="steps"/>
  <auto_cleared>true</auto_cleared>
  <external>true</external>
  <last_updated>2016-12-13T02:15:42.130+02:00</last_updated>
  <start_time>2016-12-13T02:15:42.130+02:00</start_time>
  <status>started</status>
  <owner href="/ovirt-engine/api/users/456" id="456"/>
</job>
Table 365. Parameters summary
Name Type Direction Summary

job

Job

In/Out

Job that will be added.

5.116.2. list GET

Retrieves the representation of the jobs.

GET /ovirt-engine/api/jobs

You will receive response in XML like this one:

<jobs>
  <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>
  ...
</jobs>
Table 366. Parameters summary
Name Type Direction Summary

jobs

Job[]

Out

A representation of jobs.

max

Integer

In

Sets the maximum number of jobs to return.
max

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

5.117. KatelloErrata

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

Table 367. Methods summary
Name Summary

list

Retrieves the representation of the Katello errata.

5.117.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>
Table 368. 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.

5.118. KatelloErratum

A service to manage a Katello erratum.

Table 369. Methods summary
Name Summary

get

Retrieves a Katello erratum.

5.118.1. get GET

Retrieves a Katello erratum.

GET /ovirt-engine/api/katelloerrata/123

You will receive response in XML like this one:

<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>
Table 370. Parameters summary
Name Type Direction Summary

erratum

KatelloErratum

Out

Retrieves the representation of the Katello erratum.

5.119. MacPool

Table 371. Methods summary
Name Summary

get

remove

Removes a MAC address pool.

update

Updates a MAC address pool.

5.119.1. get GET

Table 372. Parameters summary
Name Type Direction Summary

pool

MacPool

Out

5.119.2. remove DELETE

Removes a MAC address pool.

For example, to remove the MAC address pool having id 123 send a request like this:

DELETE /ovirt-engine/api/macpools/123
Table 373. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.119.3. update PUT

Updates a MAC address pool.

The name, description, allow_duplicates, and ranges attributes can be updated.

For example, to update the MAC address pool of id 123 send a request like this:

PUT /ovirt-engine/api/macpools/123

With a request body like this:

<mac_pool>
  <name>UpdatedMACPool</name>
  <description>An updated MAC address pool</description>
  <allow_duplicates>false</allow_duplicates>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
    <range>
      <from>02:1A:4A:01:00:00</from>
      <to>02:1A:4A:FF:FF:FF</to>
    </range>
  </ranges>
</mac_pool>
Table 374. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

pool

MacPool

In/Out

5.120. MacPools

Table 375. Methods summary
Name Summary

add

Creates a new MAC address pool.

list

5.120.1. add POST

Creates a new MAC address pool.

Creation of a MAC address pool requires values for the name and ranges attributes.

For example, to create MAC address pool send a request like this:

POST /ovirt-engine/api/macpools

With a request body like this:

<mac_pool>
  <name>MACPool</name>
  <description>A MAC address pool</description>
  <allow_duplicates>true</allow_duplicates>
  <default_pool>false</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:e6</to>
    </range>
  </ranges>
</mac_pool>
Table 376. Parameters summary
Name Type Direction Summary

pool

MacPool

In/Out

5.120.2. list GET

Table 377. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of pools to return.

pools

MacPool[]

Out
max

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

5.121. Measurable

5.122. Moveable

Table 378. Methods summary
Name Summary

move

5.122.1. move POST

Table 379. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the move should be performed asynchronously.

5.123. Network

A service managing a network

Table 380. Methods summary
Name Summary

get

Gets a logical network.

remove

Removes a logical network, or the association of a logical network to a data center.

update

Updates a logical network.

5.123.1. get GET

Gets a logical network.

For example:

GET /ovirt-engine/api/networks/123

Will respond:

<network href="/ovirt-engine/api/networks/123" id="123">
  <name>ovirtmgmt</name>
  <description>Default Management Network</description>
  <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
  <mtu>0</mtu>
  <stp>false</stp>
  <usages>
    <usage>vm</usage>
  </usages>
  <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
</network>
Table 381. Parameters summary
Name Type Direction Summary

network

Network

Out

5.123.2. remove DELETE

Removes a logical network, or the association of a logical network to a data center.

For example, to remove the logical network 123 send a request like this:

DELETE /ovirt-engine/api/networks/123

Each network is bound exactly to one data center. So if we disassociate network with data center it has the same result as if we would just remove that network. However it might be more specific to say we’re removing network 456 of data center 123.

For example, to remove the association of network 456 to data center 123 send a request like this:

DELETE /ovirt-engine/api/datacenters/123/networks/456
Table 382. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.123.3. update PUT

Updates a logical network.

The name, description, ip, vlan, stp and display attributes can be updated.

For example, to update the description of the logical network 123 send a request like this:

PUT /ovirt-engine/api/networks/123

With a request body like this:

<network>
  <description>My updated description</description>
</network>

The maximum transmission unit of a network is set using a PUT request to specify the integer value of the mtu attribute.

For example, to set the maximum transmission unit send a request like this:

PUT /ovirt-engine/api/datacenters/123/networks/456

With a request body like this:

<network>
  <mtu>1500</mtu>
</network>
Table 383. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

network

Network

In/Out

5.124. NetworkAttachment

Table 384. Methods summary
Name Summary

get

remove

update

5.124.1. get GET

Table 385. Parameters summary
Name Type Direction Summary

attachment

NetworkAttachment

Out

5.124.2. remove DELETE

Table 386. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.124.3. update PUT

Table 387. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

attachment

NetworkAttachment

In/Out

5.125. NetworkAttachments

Table 388. Methods summary
Name Summary

add

list

5.125.1. add POST

Table 389. Parameters summary
Name Type Direction Summary

attachment

NetworkAttachment

In/Out

5.125.2. list GET

Table 390. Parameters summary
Name Type Direction Summary

attachments

NetworkAttachment[]

Out

max

Integer

In

Sets the maximum number of attachments to return.
max

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

5.126. NetworkFilter

Manages a network filter.

<network_filter id="00000019-0019-0019-0019-00000000026b">
  <name>example-network-filter-b</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

Please note that version is referring to the minimal support version for the specific filter.

Table 391. Methods summary
Name Summary

get

Retrieves a representation of the network filter.

5.126.1. get GET

Retrieves a representation of the network filter.

Table 392. Parameters summary
Name Type Direction Summary

network_filter

NetworkFilter

Out

5.127. NetworkFilterParameter

This service manages a parameter for a network filter.

Table 393. Methods summary
Name Summary

get

Retrieves a representation of the network filter parameter.

remove

Removes the filter parameter.

update

Updates the network filter parameter.

5.127.1. get GET

Retrieves a representation of the network filter parameter.

Table 394. Parameters summary
Name Type Direction Summary

parameter

NetworkFilterParameter

Out

The representation of the network filter parameter.

5.127.2. remove DELETE

Removes the filter parameter.

For example, to remove the filter parameter with id 123 on NIC 456 of virtual machine 789 send a request like this:

DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

5.127.3. update PUT

Updates the network filter parameter.

For example, to update the network filter parameter having with with id 123 on NIC 456 of virtual machine 789 send a request like this:

PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123

With a request body like this:

<network_filter_parameter>
  <name>updatedName</name>
  <value>updatedValue</value>
</network_filter_parameter>
Table 395. Parameters summary
Name Type Direction Summary

parameter

NetworkFilterParameter

In/Out

The network filter parameter that is being updated.

5.128. NetworkFilterParameters

This service manages a collection of parameters for network filters.

Table 396. Methods summary
Name Summary

add

Add a network filter parameter.

list

Retrieves the representations of the network filter parameters.

5.128.1. add POST

Add a network filter parameter.

For example, to add the parameter for the network filter on NIC 456 of virtual machine 789 send a request like this:

POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters

With a request body like this:

<network_filter_parameter>
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>
Table 397. Parameters summary
Name Type Direction Summary

parameter

NetworkFilterParameter

In/Out

The network filter parameter that is being added.

5.128.2. list GET

Retrieves the representations of the network filter parameters.

Table 398. Parameters summary
Name Type Direction Summary

parameters

NetworkFilterParameter[]

Out

The list of the network filter parameters.

5.129. NetworkFilters

Represents a readonly network filters sub-collection.

The network filter enables to filter packets send to/from the VM’s nic according to defined rules. For more information please refer to NetworkFilter service documentation

Network filters are supported in different versions, starting from version 3.0.

A network filter is defined for each vnic profile.

A vnic profile is defined for a specific network.

A network can be assigned to several different clusters. In the future, each network will be defined in cluster level.

Currently, each network is being defined at data center level. Potential network filters for each network are determined by the network’s data center compatibility version V. V must be >= the network filter version in order to configure this network filter for a specific network. Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter’s version.

Example of listing all of the supported network filters for a specific cluster:

GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters

Output:

<network_filters>
  <network_filter id="00000019-0019-0019-0019-00000000026c">
    <name>example-network-filter-a</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026b">
    <name>example-network-filter-b</name>
    <version>
      <major>4</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
  <network_filter id="00000019-0019-0019-0019-00000000026a">
    <name>example-network-filter-a</name>
    <version>
      <major>3</major>
      <minor>0</minor>
      <build>-1</build>
      <revision>-1</revision>
    </version>
  </network_filter>
</network_filters>
Table 399. Methods summary
Name Summary

list

Retrieves the representations of the network filters.

5.129.1. list GET

Retrieves the representations of the network filters.

Table 400. Parameters summary
Name Type Direction Summary

filters

NetworkFilter[]

Out

5.130. NetworkLabel

Table 401. Methods summary
Name Summary

get

remove

Removes a label from a logical network.

5.130.1. get GET

Table 402. Parameters summary
Name Type Direction Summary

label

NetworkLabel

Out

5.130.2. remove DELETE

Removes a label from a logical network.

For example, to remove the label exemplary from a logical network having id 123 send the following request:

DELETE /ovirt-engine/api/networks/123/labels/exemplary
Table 403. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.131. NetworkLabels

Table 404. Methods summary
Name Summary

add

Attaches label to logical network.

list

5.131.1. add POST

Attaches label to logical network.

You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached.

For example, to attach the label mylabel to a logical network having id 123 send a request like this:

POST /ovirt-engine/api/networks/123/labels

With a request body like this:

<label id="mylabel"/>
Table 405. Parameters summary
Name Type Direction Summary

label

NetworkLabel

In/Out

5.131.2. list GET

Table 406. Parameters summary
Name Type Direction Summary

labels

NetworkLabel[]

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.

5.132. Networks

Manages logical networks.

The engine creates a default ovirtmgmt network on installation. This network acts as the management network for access to hypervisor hosts. This network is associated with the Default cluster and is a member of the Default data center.

Table 407. Methods summary
Name Summary

add

Creates a new logical network, or associates an existing network with a data center.

list

List logical networks.

5.132.1. add POST

Creates a new logical network, or associates an existing network with a data center.

Creation of a new network requires the name and data_center elements.

For example, to create a network named mynetwork for data center 123 send a request like this:

POST /ovirt-engine/api/networks

With a request body like this:

<network>
  <name>mynetwork</name>
  <data_center id="123"/>
</network>

To associate the existing network 456 with the data center 123 send a request like this:

POST /ovirt-engine/api/datacenters/123/networks

With a request body like this:

<network>
  <name>ovirtmgmt</name>
</network>
Table 408. Parameters summary
Name Type Direction Summary

network

Network

In/Out

5.132.2. list GET

List logical networks.

For example:

GET /ovirt-engine/api/networks

Will respond:

<networks>
  <network href="/ovirt-engine/api/networks/123" id="123">
    <name>ovirtmgmt</name>
    <description>Default Management Network</description>
    <link href="/ovirt-engine/api/networks/123/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/networks/123/vnicprofiles" rel="vnicprofiles"/>
    <link href="/ovirt-engine/api/networks/123/networklabels" rel="networklabels"/>
    <mtu>0</mtu>
    <stp>false</stp>
    <usages>
      <usage>vm</usage>
    </usages>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </network>
  ...
</networks>
Table 409. 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 networks to return.

networks

Network[]

Out

search

String

In

A query string used to restrict the returned networks.
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 networks to return. If not specified all the networks are returned.

5.133. OpenstackImage

Table 410. Methods summary
Name Summary

get

import

Imports a virtual machine from a Glance image storage domain.

5.133.1. get GET

Table 411. Parameters summary
Name Type Direction Summary

image

OpenStackImage

Out

5.133.2. import POST

Imports a virtual machine from a Glance image storage domain.

For example, to import the image with identifier 456 from the storage domain with identifier 123 send a request like this:

POST /ovirt-engine/api/openstackimageproviders/123/images/456/import

With a request body like this:

<action>
  <storage_domain>
    <name>images0</name>
  </storage_domain>
  <cluster>
    <name>images0</name>
  </cluster>
</action>
Table 412. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the import should be performed asynchronously.

cluster

Cluster

In

This parameter is mandatory in case of using import_as_template and indicates which cluster should be used for import glance image as template.

disk

Disk

In

import_as_template

Boolean

In

Indicates whether the image should be imported as a template.

storage_domain

StorageDomain

In

template

Template

In

5.134. OpenstackImageProvider

Table 413. Methods summary
Name Summary

get

importcertificates

remove

testconnectivity

update

5.134.1. get GET

Table 414. Parameters summary
Name Type Direction Summary

provider

OpenStackImageProvider

Out

5.134.2. importcertificates POST

Table 415. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

In

5.134.3. remove DELETE

Table 416. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.134.4. testconnectivity POST

Table 417. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the test should be performed asynchronously.

5.134.5. update PUT

Table 418. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

provider

OpenStackImageProvider

In/Out

5.135. OpenstackImageProviders

Table 419. Methods summary
Name Summary

add

list

5.135.1. add POST

Table 420. Parameters summary
Name Type Direction Summary

provider

OpenStackImageProvider

In/Out

5.135.2. list GET

Table 421. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of providers to return.

providers

OpenStackImageProvider[]

Out
max

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

5.136. OpenstackImages

Table 422. Methods summary
Name Summary

list

Lists the images of a Glance image storage domain.

5.136.1. list GET

Lists the images of a Glance image storage domain.

Table 423. Parameters summary
Name Type Direction Summary

images

OpenStackImage[]

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.

5.137. OpenstackNetwork

Table 424. Methods summary
Name Summary

get

import

This operation imports an external network into oVirt.

5.137.1. get GET

Table 425. Parameters summary
Name Type Direction Summary

network

OpenStackNetwork

Out

5.137.2. import POST

This operation imports an external network into oVirt. The network will be added to the data center specified.

Table 426. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the import should be performed asynchronously.

data_center

DataCenter

In

The data center into which the network is to be imported.
data_center

The data center into which the network is to be imported. Data center is mandatory, and can be specified using the id or name attributes, the rest of the attributes will be ignored.

5.138. OpenstackNetworkProvider

This service manages OpenStack network provider.

Table 427. Methods summary
Name Summary

get

Returns the representation of the object managed by this service.

importcertificates

remove

Removes the provider.

testconnectivity

update

Updates the provider.

5.138.1. get GET

Returns the representation of the object managed by this service.

For example, to get the OpenStack network provider with identifier 1234, send a request like this:

GET /ovirt-engine/api/openstacknetworkproviders/1234
Table 428. Parameters summary
Name Type Direction Summary

provider

OpenStackNetworkProvider

Out

5.138.2. importcertificates POST

Table 429. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

In

5.138.3. remove DELETE

Removes the provider.

For example, to remove the OpenStack network provider with identifier 1234, send a request like this:

DELETE /ovirt-engine/api/openstacknetworkproviders/1234
Table 430. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.138.4. testconnectivity POST

Table 431. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the test should be performed asynchronously.

5.138.5. update PUT

Updates the provider.

For example, to update provider_name, requires_authentication, url, tenant_name and type properties, for the OpenStack network provider with identifier 1234, send a request like this:

PUT /ovirt-engine/api/openstacknetworkproviders/1234

With a request body like this:

<openstack_network_provider>
  <name>ovn-network-provider</name>
  <requires_authentication>false</requires_authentication>
  <url>http://some_server_url.domain.com:9696</url>
  <tenant_name>oVirt</tenant_name>
  <type>external</type>
</openstack_network_provider>
Table 432. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

provider

OpenStackNetworkProvider

In/Out

The provider to update.

5.139. OpenstackNetworkProviders

This service manages OpenStack network providers.

Table 433. Methods summary
Name Summary

add

The operation adds a new network provider to the system.

list

5.139.1. add POST

The operation adds a new network provider to the system. If the type property is not present, a default value of NEUTRON will be used.

Table 434. Parameters summary
Name Type Direction Summary

provider

OpenStackNetworkProvider

In/Out

5.139.2. list GET

Table 435. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of providers to return.

providers

OpenStackNetworkProvider[]

Out
max

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

5.140. OpenstackNetworks

Table 436. Methods summary
Name Summary

list

5.140.1. list GET

Table 437. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of networks to return.

networks

OpenStackNetwork[]

Out
max

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

5.141. OpenstackSubnet

Table 438. Methods summary
Name Summary

get

remove

5.141.1. get GET

Table 439. Parameters summary
Name Type Direction Summary

subnet

OpenStackSubnet

Out

5.141.2. remove DELETE

Table 440. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.142. OpenstackSubnets

Table 441. Methods summary
Name Summary

add

list

5.142.1. add POST

Table 442. Parameters summary
Name Type Direction Summary

subnet

OpenStackSubnet

In/Out

5.142.2. list GET

Table 443. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of sub-networks to return.

subnets

OpenStackSubnet[]

Out
max

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

5.143. OpenstackVolumeAuthenticationKey

Table 444. Methods summary
Name Summary

get

remove

update

5.143.1. get GET

Table 445. Parameters summary
Name Type Direction Summary

key

OpenstackVolumeAuthenticationKey

Out

5.143.2. remove DELETE

Table 446. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.143.3. update PUT

Table 447. Parameters summary
Name Type Direction Summary

key

OpenstackVolumeAuthenticationKey

In/Out

5.144. OpenstackVolumeAuthenticationKeys

Table 448. Methods summary
Name Summary

add

list

5.144.1. add POST

Table 449. Parameters summary
Name Type Direction Summary

key

OpenstackVolumeAuthenticationKey

In/Out

5.144.2. list GET

Table 450. Parameters summary
Name Type Direction Summary

keys

OpenstackVolumeAuthenticationKey[]

Out

max

Integer

In

Sets the maximum number of keys to return.
max

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

5.145. OpenstackVolumeProvider

Table 451. Methods summary
Name Summary

get

importcertificates

remove

testconnectivity

update

5.145.1. get GET

Table 452. Parameters summary
Name Type Direction Summary

provider

OpenStackVolumeProvider

Out

5.145.2. importcertificates POST

Table 453. Parameters summary
Name Type Direction Summary

certificates

Certificate[]

In

5.145.3. remove DELETE

Table 454. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.145.4. testconnectivity POST

Table 455. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the test should be performed asynchronously.

5.145.5. update PUT

Table 456. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

provider

OpenStackVolumeProvider

In/Out

5.146. OpenstackVolumeProviders

Table 457. Methods summary
Name Summary

add

Adds a new volume provider.

list

Retrieves the list of volume providers.

5.146.1. add POST

Adds a new volume provider.

For example:

POST /ovirt-engine/api/openstackvolumeproviders

With a request body like this:

<openstack_volume_provider>
  <name>mycinder</name>
  <url>https://mycinder.example.com:8776</url>
  <data_center>
    <name>mydc</name>
  </data_center>
  <requires_authentication>true</requires_authentication>
  <username>admin</username>
  <password>mypassword</password>
  <tenant_name>mytenant</tenant_name>
</openstack_volume_provider>
Table 458. Parameters summary
Name Type Direction Summary

provider

OpenStackVolumeProvider

In/Out

5.146.2. list GET

Retrieves the list of volume providers.

Table 459. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of providers to return.

providers

OpenStackVolumeProvider[]

Out
max

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

5.147. OpenstackVolumeType

Table 460. Methods summary
Name Summary

get

5.147.1. get GET

Table 461. Parameters summary
Name Type Direction Summary

type

OpenStackVolumeType

Out

5.148. OpenstackVolumeTypes

Table 462. Methods summary
Name Summary

list

5.148.1. list GET

Table 463. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of volume types to return.

types

OpenStackVolumeType[]

Out
max

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

5.149. OperatingSystem

Table 464. Methods summary
Name Summary

get

5.149.1. get GET

Table 465. Parameters summary
Name Type Direction Summary

operating_system

OperatingSystemInfo

Out

5.150. OperatingSystems

Table 466. Methods summary
Name Summary

list

5.150.1. list GET

Table 467. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of networks to return.

operating_system

OperatingSystemInfo[]

Out
max

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

5.151. Permission

Table 468. Methods summary
Name Summary

get

remove

5.151.1. get GET

Table 469. Parameters summary
Name Type Direction Summary

permission

Permission

Out

5.151.2. remove DELETE

Table 470. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.152. Permit

A service to manage a specific permit of the role.

Table 471. Methods summary
Name Summary

get

Gets the information about the permit of the role.

remove

Removes the permit from the role.

5.152.1. get GET

Gets the information about the permit of the role.

For example to retrieve the information about the permit with the id 456 of the role with the id 123 send a request like this:

GET /ovirt-engine/api/roles/123/permits/456
<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
  <name>change_vm_cd</name>
  <administrative>false</administrative>
  <role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>
Table 472. Parameters summary
Name Type Direction Summary

permit

Permit

Out

The permit of the role.

5.152.2. remove DELETE

Removes the permit from the role.

For example to remove the permit with id 456 from the role with id 123 send a request like this:

DELETE /ovirt-engine/api/roles/123/permits/456
Table 473. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.153. Permits

Represents a permits sub-collection of the specific role.

Table 474. Methods summary
Name Summary

add

Adds a permit to the role.

list

List the permits of the role.

5.153.1. add POST

Adds a permit to the role. The permit name can be retrieved from the ClusterLevels service.

For example to assign a permit create_vm to the role with id 123 send a request like this:

POST /ovirt-engine/api/roles/123/permits

With a request body like this:

<permit>
  <name>create_vm</name>
</permit>
Table 475. Parameters summary
Name Type Direction Summary

permit

Permit

In/Out

The permit to add.

5.153.2. list GET

List the permits of the role.

For example to list the permits of the role with the id 123 send a request like this:

GET /ovirt-engine/api/roles/123/permits
<permits>
  <permit href="/ovirt-engine/api/roles/123/permits/5" id="5">
    <name>change_vm_cd</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
  <permit href="/ovirt-engine/api/roles/123/permits/7" id="7">
    <name>connect_to_vm</name>
    <administrative>false</administrative>
    <role href="/ovirt-engine/api/roles/123" id="123"/>
  </permit>
</permits>
Table 476. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of permits to return.

permits

Permit[]

Out

List of permits.
max

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

5.154. Qos

Table 477. Methods summary
Name Summary

get

remove

update

5.154.1. get GET

Table 478. Parameters summary
Name Type Direction Summary

qos

Qos

Out

5.154.2. remove DELETE

Table 479. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.154.3. update PUT

Table 480. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

qos

Qos

In/Out

5.155. Qoss

Table 481. Methods summary
Name Summary

add

list

5.155.1. add POST

Table 482. Parameters summary
Name Type Direction Summary

qos

Qos

In/Out

5.155.2. list GET

Table 483. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of QoS descriptors to return.

qoss

Qos[]

Out
max

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

5.156. Quota

Table 484. Methods summary
Name Summary

get

Retrieves a quota.

remove

Delete a quota.

update

Updates a quota.

5.156.1. get GET

Retrieves a quota.

An example of retrieving a quota:

GET /ovirt-engine/api/datacenters/123/quotas/456
<quota id="456">
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
  <cluster_hard_limit_pct>20</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>80</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>
Table 485. Parameters summary
Name Type Direction Summary

quota

Quota

Out

5.156.2. remove DELETE

Delete a quota.

An example of deleting a quota:

DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml
Table 486. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.156.3. update PUT

Updates a quota.

An example of updating a quota:

PUT /ovirt-engine/api/datacenters/123/quotas/456
<quota>
  <cluster_hard_limit_pct>30</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>70</cluster_soft_limit_pct>
  <storage_hard_limit_pct>20</storage_hard_limit_pct>
  <storage_soft_limit_pct>80</storage_soft_limit_pct>
</quota>
Table 487. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

quota

Quota

In/Out

5.157. QuotaClusterLimit

Table 488. Methods summary
Name Summary

get

remove

5.157.1. get GET

Table 489. Parameters summary
Name Type Direction Summary

limit

QuotaClusterLimit

Out

5.157.2. remove DELETE

Table 490. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.158. QuotaClusterLimits

Table 491. Methods summary
Name Summary

add

list

5.158.1. add POST

Table 492. Parameters summary
Name Type Direction Summary

limit

QuotaClusterLimit

In/Out

5.158.2. list GET

Table 493. Parameters summary
Name Type Direction Summary

limits

QuotaClusterLimit[]

Out

max

Integer

In

Sets the maximum number of limits to return.
max

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

5.159. QuotaStorageLimit

Table 494. Methods summary
Name Summary

get

remove

5.159.1. get GET

Table 495. Parameters summary
Name Type Direction Summary

limit

QuotaStorageLimit

Out

5.159.2. remove DELETE

Table 496. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

5.160. QuotaStorageLimits

Table 497. Methods summary
Name Summary

add

list

5.160.1. add POST

Table 498. Parameters summary
Name Type Direction Summary

limit

QuotaStorageLimit

In/Out

5.160.2. list GET

Table 499. Parameters summary
Name Type Direction Summary

limits

QuotaStorageLimit[]

Out

max

Integer

In

Sets the maximum number of limits to return.
max

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

5.161. Quotas

Table 500. Methods summary
Name Summary

add

Creates a new quota.

list

Lists quotas of a data center

5.161.1. add POST

Creates a new quota.

An example of creating a new quota:

POST /ovirt-engine/api/datacenters/123/quotas
<quota>
  <name>myquota</name>
  <description>My new quota for virtual machines</description>
</quota>
Table 501. Parameters summary
Name Type Direction Summary

quota

Quota

In/Out

5.161.2. list GET

Lists quotas of a data center

Table 502. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of quota descriptors to return.

quotas

Quota[]

Out
max

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

5.162. Role

Table 503. Methods summary
Name Summary

get

Get the role.

remove

Removes the role.

update

Updates a role.

5.162.1. get GET

Get the role.

GET /ovirt-engine/api/roles/123

You will receive XML response like this one:

<role id="123">
  <name>MyRole</name>
  <description>MyRole description</description>
  <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
  <administrative>true</administrative>
  <mutable>false</mutable>
</role>
Table 504. Parameters summary
Name Type Direction Summary

role

Role

Out

Retrieved role.

5.162.2. remove DELETE

Removes the role.

To remove the role you need to know its id, then send request like this:

DELETE /ovirt-engine/api/roles/{role_id}
Table 505. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.162.3. update PUT

Updates a role. You are allowed to update name, description and administrative attributes after role is created. Within this endpoint you can’t add or remove roles permits you need to use service that manages permits of role.

For example to update role’s name, description and administrative attributes send a request like this:

PUT /ovirt-engine/api/roles/123

With a request body like this:

<role>
  <name>MyNewRoleName</name>
  <description>My new description of the role</description>
  <administrative>true</administrative>
</group>
Table 506. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

role

Role

In/Out

Updated role.

5.163. Roles

Provides read-only access to the global set of roles

Table 507. Methods summary
Name Summary

add

Create a new role.

list

List roles.

5.163.1. add POST

Create a new role. The role can be administrative or non-administrative and can have different permits.

For example, to add the MyRole non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id):

POST /ovirt-engine/api/roles

With a request body like this:

<role>
  <name>MyRole</name>
  <description>My custom role to create virtual machines</description>
  <administrative>false</administrative>
  <permits>
    <permit id="1"/>
    <permit id="1300"/>
  </permits>
</group>
Table 508. Parameters summary
Name Type Direction Summary

role

Role

In/Out

Role that will be added.

5.163.2. list GET

List roles.

GET /ovirt-engine/api/roles

You will receive response in XML like this one:

<roles>
  <role id="123">
     <name>SuperUser</name>
     <description>Roles management administrator</description>
     <link href="/ovirt-engine/api/roles/123/permits" rel="permits"/>
     <administrative>true</administrative>
     <mutable>false</mutable>
  </role>
  ...
</roles>
Table 509. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of roles to return.

roles

Role[]

Out

Retrieved list of roles.
max

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

5.164. SchedulingPolicies

Table 510. Methods summary
Name Summary

add

list

5.164.1. add POST

Table 511. Parameters summary
Name Type Direction Summary

policy

SchedulingPolicy

In/Out

5.164.2. list GET

Table 512. Parameters summary
Name Type Direction Summary

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 policies to return.

policies

SchedulingPolicy[]

Out
max

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

5.165. SchedulingPolicy

Table 513. Methods summary
Name Summary

get

remove

update

5.165.1. get GET

Table 514. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

policy

SchedulingPolicy

Out

5.165.2. remove DELETE

Table 515. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.165.3. update PUT

Table 516. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

policy

SchedulingPolicy

In/Out

5.166. SchedulingPolicyUnit

Table 517. Methods summary
Name Summary

get

remove

5.166.1. get GET

Table 518. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

unit

SchedulingPolicyUnit

Out

5.166.2. remove DELETE

Table 519. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.167. SchedulingPolicyUnits

Table 520. Methods summary
Name Summary

list

5.167.1. list GET

Table 521. Parameters summary
Name Type Direction Summary

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 policy units to return.

units

SchedulingPolicyUnit[]

Out
max

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

5.168. Snapshot

Table 522. Methods summary
Name Summary

get

remove

restore

Restores a virtual machine snapshot.

5.168.1. get GET

Table 523. Parameters summary
Name Type Direction Summary

snapshot

Snapshot

Out

5.168.2. remove DELETE

Table 524. Parameters summary
Name Type Direction Summary

all_content

Boolean

In

Indicates if all the attributes of the virtual machine snapshot should be included in the response.

async

Boolean

In

Indicates if the remove should be performed asynchronously.
all_content

Indicates if all the attributes of the virtual machine snapshot should be included in the response.

By default the attribute initialization.configuration.data is excluded.

For example, to retrieve the complete representation of the snapshot with id 456 of the virtual machine with id 123 send a request like this:

GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true

5.168.3. restore POST

Restores a virtual machine snapshot.

For example, to restore the snapshot with identifier 456 of virtual machine with identifier 123 send a request like this:

POST /ovirt-engine/api/vms/123/snapshots/456/restore

With an empty action in the body:

<action/>
Table 525. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the restore should be performed asynchronously.

disks

Disk[]

In

restore_memory

Boolean

In

5.169. SnapshotCdrom

Table 526. Methods summary
Name Summary

get

5.169.1. get GET

Table 527. Parameters summary
Name Type Direction Summary

cdrom

Cdrom

Out

5.170. SnapshotCdroms

Table 528. Methods summary
Name Summary

list

5.170.1. list GET

Table 529. Parameters summary
Name Type Direction Summary

cdroms

Cdrom[]

Out

max

Integer

In

Sets the maximum number of CDROMS to return.
max

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

5.171. SnapshotDisk

Table 530. Methods summary
Name Summary

get

5.171.1. get GET

Table 531. Parameters summary
Name Type Direction Summary

disk

Disk

Out

5.172. SnapshotDisks

Table 532. Methods summary
Name Summary

list

5.172.1. list GET

Table 533. Parameters summary
Name Type Direction Summary

disks

Disk[]

Out

max

Integer

In

Sets the maximum number of disks to return.
max

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

5.173. SnapshotNic

Table 534. Methods summary
Name Summary

get

5.173.1. get GET

Table 535. Parameters summary
Name Type Direction Summary

nic

Nic

Out

5.174. SnapshotNics

Table 536. Methods summary
Name Summary

list

5.174.1. list GET

Table 537. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of NICs to return.

nics

Nic[]

Out
max

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

5.175. Snapshots

Table 538. Methods summary
Name Summary

add

Creates a virtual machine snapshot.

list

5.175.1. add POST

Creates a virtual machine snapshot.

For example, to create a new snapshot for virtual machine 123 send a request like this:

POST /ovirt-engine/api/vms/123/snapshots

With a request body like this:

<snapshot>
  <description>My snapshot</description>
</snapshot>
Table 539. Parameters summary
Name Type Direction Summary

snapshot

Snapshot

In/Out

5.175.2. list GET

Table 540. Parameters summary
Name Type Direction Summary

all_content

Boolean

In

Indicates if all the attributes of the virtual machine snapshot should be included in the response.

max

Integer

In

Sets the maximum number of snapshots to return.

snapshots

Snapshot[]

Out
all_content

Indicates if all the attributes of the virtual machine snapshot should be included in the response.

By default the attribute initialization.configuration.data is excluded.

For example, to retrieve the complete representation of the virtual machine with id 123 snapshots send a request like this:

GET /ovirt-engine/api/vms/123/snapshots?all_content=true
max

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

5.176. SshPublicKey

Table 541. Methods summary
Name Summary

get

remove

update

5.176.1. get GET

Table 542. Parameters summary
Name Type Direction Summary

key

SshPublicKey

Out

5.176.2. remove DELETE

Table 543. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.176.3. update PUT

Table 544. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

key

SshPublicKey

In/Out

5.177. SshPublicKeys

Table 545. Methods summary
Name Summary

add

list

5.177.1. add POST

Table 546. Parameters summary
Name Type Direction Summary

key

SshPublicKey

In/Out

5.177.2. list GET

Table 547. Parameters summary
Name Type Direction Summary

keys

SshPublicKey[]

Out

max

Integer

In

Sets the maximum number of keys to return.
max

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

5.178. Statistic

Table 548. Methods summary
Name Summary

get

5.178.1. get GET

Table 549. Parameters summary
Name Type Direction Summary

statistic

Statistic

In/Out

5.179. Statistics

Table 550. Methods summary
Name Summary

list

Retrieves a list of statistics.

5.179.1. list GET

Retrieves a list of statistics.

For example, to retrieve the statistics for virtual machine 123 send a request like this:

GET /ovirt-engine/api/vms/123/statistics

The result will be like this:

<statistics>
  <statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
    <name>memory.installed</name>
    <description>Total memory configured</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>1073741824</datum>
      </value>
    </values>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </statistic>
  ...
</statistics>

Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:

GET /ovirt-engine/api/vms/123/statistics/456

Outputs:

<statistic href="/ovirt-engine/api/vms/123/statistics/456" id="456">
  <name>memory.installed</name>
  <description>Total memory configured</description>
  <kind>gauge</kind>
  <type>integer</type>
  <unit>bytes</unit>
  <values>
    <value>
      <datum>1073741824</datum>
    </value>
  </values>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</statistic>
Table 551. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of statistics to return.

statistics

Statistic[]

Out
max

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

5.180. Step

A service to manage a step.

Table 552. Methods summary
Name Summary

end

Marks an external step execution as ended.

get

Retrieves a step.

5.180.1. end POST

Marks an external step execution as ended.

For example, to terminate a step with identifier 456 which belongs to a job with identifier 123 send the following request:

POST /ovirt-engine/api/jobs/123/steps/456/end

With the following request body:

<action>
  <force>true</force>
  <succeeded>true</succeeded>
</action>
Table 553. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

force

Boolean

In

Indicates if the step should be forcibly terminated.

succeeded

Boolean

In

Indicates if the step should be marked as successfully finished or as failed.
succeeded

Indicates if the step should be marked as successfully finished or as failed.

This parameter is optional, and the default value is true.

5.180.2. get GET

Retrieves a step.

GET /ovirt-engine/api/jobs/123/steps/456

You will receive response in XML like this one:

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <end_time>2016-12-12T23:07:26.627+02:00</end_time>
  <external>false</external>
  <number>0</number>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>finished</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Table 554. Parameters summary
Name Type Direction Summary

step

Step

Out

Retrieves the representation of the step.

5.181. Steps

A service to manage steps.

Table 555. Methods summary
Name Summary

add

Add an external step to an existing job or to an existing step.

list

Retrieves the representation of the steps.

5.181.1. add POST

Add an external step to an existing job or to an existing step.

For example, to add a step to job with identifier 123 send the following request:

POST /ovirt-engine/api/jobs/123/steps

With the following request body:

<step>
  <description>Validating</description>
  <start_time>2016-12-12T23:07:26.605+02:00</start_time>
  <status>started</status>
  <type>validating</type>
</step>

The response should look like:

<step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
  <actions>
    <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
  </actions>
  <description>Validating</description>
  <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
  <external>true</external>
  <number>2</number>
  <start_time>2016-12-13T01:06:15.380+02:00</start_time>
  <status>started</status>
  <type>validating</type>
  <job href="/ovirt-engine/api/jobs/123" id="123"/>
</step>
Table 556. Parameters summary
Name Type Direction Summary

step

Step

In/Out

Step that will be added.

5.181.2. list GET

Retrieves the representation of the steps.

GET /ovirt-engine/api/job/123/steps

You will receive response in XML like this one:

<steps>
  <step href="/ovirt-engine/api/jobs/123/steps/456" id="456">
    <actions>
      <link href="/ovirt-engine/api/jobs/123/steps/456/end" rel="end"/>
    </actions>
    <description>Validating</description>
    <link href="/ovirt-engine/api/jobs/123/steps/456/statistics" rel="statistics"/>
    <external>true</external>
    <number>2</number>
    <start_time>2016-12-13T01:06:15.380+02:00</start_time>
    <status>started</status>
    <type>validating</type>
    <job href="/ovirt-engine/api/jobs/123" id="123"/>
  </step>
  ...
</steps>
Table 557. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of steps to return.

steps

Step[]

Out

A representation of steps.
max

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

5.182. Storage

Table 558. Methods summary
Name Summary

get

5.182.1. get GET

Table 559. Parameters summary
Name Type Direction Summary

report_status

Boolean

In

Indicates if the status of the LUNs in the storage should be checked.

storage

HostStorage

Out
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="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <status>used</status>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

Here an example without the LUN status :

<host_storage id="360014051136c20574f743bdbd28177fd">
  <logical_units>
    <logical_unit id="360014051136c20574f743bdbd28177fd">
      <lun_mapping>0</lun_mapping>
      <paths>1</paths>
      <product_id>lun0</product_id>
      <serial>SLIO-ORG_lun0_1136c205-74f7-43bd-bd28-177fd5ce6993</serial>
      <size>10737418240</size>
      <vendor_id>LIO-ORG</vendor_id>
      <volume_group_id>O9Du7I-RahN-ECe1-dZ1w-nh0b-64io-MNzIBZ</volume_group_id>
    </logical_unit>
  </logical_units>
  <type>iscsi</type>
  <host id="8bb5ade5-e988-4000-8b93-dbfc6717fe50"/>
</host_storage>

5.183. StorageDomain

Table 560. Methods summary
Name Summary

get

isattached

reduceluns

This operation reduces logical units from the storage domain.

refreshluns

This operation refreshes the LUN size.

remove

Removes the storage domain.

update

Updates a storage domain.

updateovfstore

This operation forces the update of the OVF_STORE of this storage domain.

5.183.1. get GET

Table 561. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

storage_domain

StorageDomain

Out

5.183.2. isattached POST

Table 562. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

host

Host

In

is_attached

Boolean

Out

5.183.3. reduceluns POST

This operation reduces logical units from the storage domain.

In order to do so the data stored on the provided logical units will be moved to other logical units of the storage domain and only then they will be reduced from the storage domain.

For example, in order to reduce two logical units from a storage domain send a request like this:

POST /ovirt-engine/api/storagedomains/123/reduceluns

With a request body like this:

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>
Table 563. Parameters summary
Name Type Direction Summary

logical_units

LogicalUnit[]

In

The logical units that needs to be reduced from the storage domain.

5.183.4. refreshluns POST

This operation refreshes the LUN size.

After increasing the size of the underlying LUN on the storage server, the user can refresh the LUN size. This action forces a rescan of the provided LUNs and updates the database with the new size if required.

For example, in order to refresh the size of two LUNs send a request like this:

POST /ovirt-engine/api/storagedomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns

With a request body like this:

 <action>
   <logical_units>
     <logical_unit id="1IET_00010001"/>
     <logical_unit id="1IET_00010002"/>
   </logical_units>
 </action>
Table 564. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the refresh should be performed asynchronously.

logical_units

LogicalUnit[]

In

The LUNs that need to be refreshed.

5.183.5. remove DELETE

Removes the storage domain.

Without any special parameters, the storage domain is detached from the system and removed from the database. The storage domain can then be imported to the same or different setup, with all the data on it. If the storage isn’t accessible the operation will fail.

If the destroy parameter is true then the operation will always succeed, even if the storage isn’t accessible, the failure is just ignored and the storage domain is removed from the database anyway.

If the format parameter is true then the actual storage is formatted, and the metadata is removed from the LUN or directory, so it can no longer be imported to the same or a different setup.

Table 565. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

destroy

Boolean

In

Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage isn’t accessible.

format

Boolean

In

Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory:

[source] ---- DELETE /ovirt-engine/api/storagedomains/123?format=true ----

This parameter is optional, and the default value is false.

host

String

In

Indicates what host should be used to remove the storage domain.
destroy

Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage isn’t accessible.

DELETE /ovirt-engine/api/storagedomains/123?destroy=true

This parameter is optional, and the default value is false.

host

Indicates what host should be used to remove the storage domain.

This parameter is mandatory, and it can contain the name or the identifier of the host. For example, to use the host named myhost to remove the storage domain with identifier 123 send a request like this:

DELETE /ovirt-engine/api/storagedomains/123?host=myhost

5.183.6. update PUT

Updates a storage domain.

Not all of the StorageDomain's attributes are updatable post-creation. Those that can be updated are: name, description, comment, warning_low_space_indicator, critical_space_action_blocker and wipe_after_delete (note that changing the wipe_after_delete attribute will not change the wipe after delete property of disks that already exist).

To update the name and wipe_after_delete attributes of a storage domain with an identifier 123, send a request as follows:

PUT /ovirt-engine/api/storagedomains/123

With a request body as follows:

<storage_domain>
  <name>data2</name>
  <wipe_after_delete>true</wipe_after_delete>
</storage_domain>
Table 566. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

storage_domain

StorageDomain

In/Out

5.183.7. updateovfstore POST

This operation forces the update of the OVF_STORE of this storage domain.

The OVF_STORE is a disk image that contains the meta-data of virtual machines and disks that reside in the storage domain. This meta-data is used in case the domain is imported or exported to or from a different data center or a different installation.

By default the OVF_STORE is updated periodically (set by default to 60 minutes) but users might want to force an update after an important change, or when the they believe the OVF_STORE is corrupt.

When initiated by the user, OVF_STORE update will be performed whether an update is needed or not.

Table 567. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the OVF_STORE update should be performed asynchronously.

5.184. StorageDomainContentDisk

Table 568. Methods summary
Name Summary

get

5.184.1. get GET

Table 569. Parameters summary
Name Type Direction Summary

disk

Disk

Out

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

5.185. StorageDomainContentDisks

Table 570. Methods summary
Name Summary

list

5.185.1. list GET

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

max

Integer

In

Sets the maximum number of disks to return.

search

String

In

A query string used to restrict the returned disks.
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 disks to return. If not specified all the disks are returned.

5.186. StorageDomainDisk

Manages a single disk available in a storage domain.

Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations use the service that manages all the disks of the system, or the service that manages an specific disk.
Table 572. Methods summary
Name Summary

copy

Copies a disk to the specified storage domain.

export

Exports a disk to an export storage domain.

get

Retrieves the description of the disk.

move

Moves a disk to another storage domain.

remove

Removes a disk.

sparsify

Sparsify the disk.

update

Updates the disk.

5.186.1. copy POST

Copies a disk to the specified storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To copy a disk use the copy operation of the service that manages that disk.
Table 573. Parameters summary
Name Type Direction Summary

disk

Disk

In

Description of the resulting disk.

storage_domain

StorageDomain

In

The storage domain where the new disk will be created.

5.186.2. export POST

Exports a disk to an export storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To export a disk use the export operation of the service that manages that disk.
Table 574. Parameters summary
Name Type Direction Summary

storage_domain

StorageDomain

In

The export storage domain where the disk should be exported to.

5.186.3. get GET

Retrieves the description of the disk.

Table 575. Parameters summary
Name Type Direction Summary

disk

Disk

Out

The description of the disk.

5.186.4. move POST

Moves a disk to another storage domain.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To move a disk use the move operation of the service that manages that disk.
Table 576. 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

The storage domain where the disk will be moved to.

5.186.5. remove DELETE

Removes a disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.

5.186.6. sparsify POST

Sparsify the disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.

5.186.7. update PUT

Updates the disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To update a disk use the update operation of the service that manages that disk.
Table 577. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The update to apply to the disk.

5.187. StorageDomainDisks

Manages the collection of disks available inside an specific storage domain.

Table 578. Methods summary
Name Summary

add

Adds or registers a disk.

list

Retrieve the list of disks that are available in the storage domain.

5.187.1. add POST

Adds or registers a disk.

Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To add a new disk use the add operation of the service that manages the disks of the system. To register an unregistered disk use the register operation of the service that manages that disk.
Table 579. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

The disk to add or register.

unregistered

Boolean

In

Indicates if a new disk should be added or if an existing unregistered disk should be registered.
unregistered

Indicates if a new disk should be added or if an existing unregistered disk should be registered. If the value is true then the identifier of the disk to register needs to be provided. For example, to register the disk with id 456 send a request like this:

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

With a request body like this:

<disk id="456"/>

If the value is false then a new disk will be created in the storage domain. In that case the provisioned_size, format and name attributes are mandatory. For example, to create a new copy on write disk of 1 GiB, send a request like this:

POST /ovirt-engine/api/storagedomains/123/disks

With a request body like this:

<disk>
  <name>mydisk</name>
  <format>cow</format>
  <provisioned_size>1073741824</provisioned_size>
</disk>

The default value is false.

5.187.2. list GET

Retrieve the list of disks that are available in the storage domain.

Table 580. Parameters summary
Name Type Direction Summary

disks

Disk[]

Out

List of retrieved disks.

max

Integer

In

Sets the maximum number of disks to return.
max

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

5.188. StorageDomainServerConnection

Table 581. Methods summary
Name Summary

get

remove

Detaches a storage connection from storage.

5.188.1. get GET

Table 582. Parameters summary
Name Type Direction Summary

connection

StorageConnection

Out

5.188.2. remove DELETE

Detaches a storage connection from storage.

Table 583. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.189. StorageDomainServerConnections

Table 584. Methods summary
Name Summary

add

list

5.189.1. add POST

Table 585. Parameters summary
Name Type Direction Summary

connection

StorageConnection

In/Out

5.189.2. list GET

Table 586. Parameters summary
Name Type Direction Summary

connections

StorageConnection[]

Out

max

Integer

In

Sets the maximum number of connections to return.
max

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

5.190. StorageDomainTemplate

Table 587. Methods summary
Name Summary

get

import

Action to import a template from an export storage domain.

register

remove

5.190.1. get GET

Table 588. Parameters summary
Name Type Direction Summary

template

Template

Out

5.190.2. import POST

Action to import a template from an export storage domain.

For example, to import the template 456 from the storage domain 123 send the following request:

POST /ovirt-engine/api/storagedomains/123/templates/456/import

With the following request body:

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>
Table 589. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the import should be performed asynchronously.

clone

Boolean

In

Use the optional clone parameter to generate new UUIDs for the imported template and its entities.

cluster

Cluster

In

exclusive

Boolean

In

storage_domain

StorageDomain

In

template

Template

In

vm

Vm

In
clone

Use the optional clone parameter to generate new UUIDs for the imported template and its entities.

The user might want to import a template with the clone parameter set to false when importing a template from an export domain, with templates that was exported by a different oVirt environment.

5.190.3. register POST

Table 590. Parameters summary
Name Type Direction Summary

allow_partial_import

Boolean

In

Indicates whether a template is allowed to be registered with only some of its disks.

async

Boolean

In

Indicates if the registration should be performed asynchronously.

clone

Boolean

In

cluster

Cluster

In

exclusive

Boolean

In

template

Template

In
allow_partial_import

Indicates whether a template is allowed to be registered with only some of its disks.

If this flag is true, the engine will not fail in the validation process if an image is not found, but instead it will allow the template to be registered without the missing disks. This is mainly used during registration of a template when some of the storage domains are not available. The default value is false.

5.190.4. remove DELETE

Table 591. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.191. StorageDomainTemplates

Table 592. Methods summary
Name Summary

list

5.191.1. list GET

Table 593. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of templates to return.

templates

Template[]

Out
max

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

5.192. StorageDomainVm

Table 594. Methods summary
Name Summary

get

import

Imports a virtual machine from an export storage domain.

register

remove

Deletes a virtual machine from an export storage domain.

5.192.1. get GET

Table 595. Parameters summary
Name Type Direction Summary

vm

Vm

Out

5.192.2. import POST

Imports a virtual machine from an export storage domain.

For example, send a request like this:

POST /ovirt-engine/api/storagedomains/123/vms/456/import

With a request body like this:

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
</action>

To import a virtual machine as a new entity add the clone parameter:

<action>
  <storage_domain>
    <name>mydata</name>
  </storage_domain>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <clone>true</clone>
  <vm>
    <name>myvm</name>
  </vm>
</action>

Include an optional disks parameter to choose which disks to import. For example, to import the disks of the template that have the identifiers 123 and 456 send the following request body:

<action>
  <cluster>
    <name>mycluster</name>
  </cluster>
  <vm>
    <name>myvm</name>
  </vm>
  <disks>
    <disk id="123"/>
    <disk id="456"/>
  </disks>
</action>
Table 596. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the import should be performed asynchronously.

clone

Boolean

In

Indicates if the identifiers of the imported virtual machine should be regenerated.

cluster

Cluster

In

collapse_snapshots

Boolean

In

Indicates of the snapshots of the virtual machine that is imported should be collapsed, so that the result will be a virtual machine without snapshots.

reassign_bad_macs

Boolean

In

Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine.

storage_domain

StorageDomain

In

vm

Vm

In

vnic_profile_mappings

VnicProfileMapping[]

In

Mapping rules for virtual NIC profiles that will be applied during the import process.
clone

Indicates if the identifiers of the imported virtual machine should be regenerated.

By default when a virtual machine is imported the identifiers are preserved. This means that the same virtual machine can’t be imported multiple times, as that identifiers needs to be unique. To allow importing the same machine multiple times set this parameter to true, as the default is false.

collapse_snapshots

Indicates of the snapshots of the virtual machine that is imported should be collapsed, so that the result will be a virtual machine without snapshots.

This parameter is optional, and if it isn’t explicitly specified the default value is false.

reassign_bad_macs

Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine.

A MAC address would be considered as a problematic one if one of the following is true:

  • It conflicts with a MAC address that is already allocated to a virtual machine in the target environment.

  • It’s out of the range of the target MAC address pool.

5.192.3. register POST

Table 597. Parameters summary
Name Type Direction Summary

allow_partial_import

Boolean

In

Indicates whether a virtual machine is allowed to be registered with only some of its disks.

async

Boolean

In

Indicates if the registration should be performed asynchronously.

clone

Boolean

In

cluster

Cluster

In

vm

Vm

In
allow_partial_import

Indicates whether a virtual machine is allowed to be registered with only some of its disks.

If this flag is true, the engine will not fail in the validation process if an image is not found, but instead it will allow the virtual machine to be registered without the missing disks. This is mainly used during registration of a virtual machine when some of the storage domains are not available. The default value is false.

5.192.4. remove DELETE

Deletes a virtual machine from an export storage domain.

For example, to delete the virtual machine 456 from the storage domain 123, send a request like this:

DELETE /ovirt-engine/api/storagedomains/123/vms/456
Table 598. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.193. StorageDomainVmDiskAttachment

Returns the details of the disks attached to a virtual machine in the export domain.

Table 599. Methods summary
Name Summary

get

Returns the details of the attachment with all its properties and a link to the disk.

5.193.1. get GET

Returns the details of the attachment with all its properties and a link to the disk.

Table 600. Parameters summary
Name Type Direction Summary

attachment

DiskAttachment

Out

The disk attachment.

5.194. StorageDomainVmDiskAttachments

Returns the details of a disk attached to a virtual machine in the export domain.

Table 601. Methods summary
Name Summary

list

List the disks that are attached to the virtual machine.

5.194.1. list GET

List the disks that are attached to the virtual machine.

Table 602. Parameters summary
Name Type Direction Summary

attachments

DiskAttachment[]

Out

5.195. StorageDomainVms

Lists the virtual machines of an export storage domain.

For example, to retrieve the virtual machines that are available in the storage domain with identifier 123 send the following request:

GET /ovirt-engine/api/storagedomains/123/vms

This will return the following response body:

<vms>
  <vm id="456" href="/api/storagedomains/123/vms/456">
    <name>vm1</name>
    ...
    <storage_domain id="123" href="/api/storagedomains/123"/>
    <actions>
      <link rel="import" href="/api/storagedomains/123/vms/456/import"/>
    </actions>
  </vm>
</vms>

Virtual machines and templates in these collections have a similar representation to their counterparts in the top-level Vm and Template collections, except they also contain a StorageDomain reference and an import action.

Table 603. Methods summary
Name Summary

list

5.195.1. list GET

Table 604. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of virtual machines to return.

vm

Vm[]

Out
max

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

5.196. StorageDomains

Table 605. Methods summary
Name Summary

add

Adds a new storage domain.

list

5.196.1. add POST

Adds a new storage domain.

Creation of a new StorageDomain requires the name, type, host and storage attributes. Identify the host attribute with the id or name attributes. In oVirt 3.6 and later 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.

To add a new storage domain with specified name, type, storage.type, storage.address and storage.path and by using a host with an id 123, send a request as follows:

POST /ovirt-engine/api/storagedomains

With a request body as follows:

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

To create a new NFS ISO storage domain send a request like this:

<storage_domain>
  <name>myisos</name>
  <type>iso</type>
  <storage>
    <type>nfs</type>
    <address>mynfs.example.com</address>
    <path>/export/myisos</path>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>

To create a new iSCSI storage domain send a request like this:

<storage_domain>
  <name>myiscsi</name>
  <type>data</type>
  <storage>
    <type>iscsi</type>
    <logical_units>
      <logical_unit id="3600144f09dbd050000004eedbd340001"/>
      <logical_unit id="3600144f09dbd050000004eedbd340002"/>
    </logical_units>
  </storage>
  <host>
    <name>myhost</name>
  </host>
</storage_domain>
Table 606. Parameters summary
Name Type Direction Summary

storage_domain

StorageDomain

In/Out

5.196.2. list GET

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

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 storage domains to return.

search

String

In

A query string used to restrict the returned storage domains.

storage_domains

StorageDomain[]

Out
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 storage domains to return. If not specified all the storage domains are returned.

5.197. StorageServerConnection

Table 608. Methods summary
Name Summary

get

remove

Removes a storage connection.

update

Updates the storage connection.

5.197.1. get GET

Table 609. Parameters summary
Name Type Direction Summary

conection

StorageConnection

Out

5.197.2. remove DELETE

Removes a storage connection.

A storage connection can only be deleted if neither storage domain nor LUN disks reference it. The host name or id is optional; providing it disconnects (unmounts) the connection from that host.

Table 610. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

host

String

In

The name or identifier of the host from which the connection would be unmounted (disconnected).
host

The name or identifier of the host from which the connection would be unmounted (disconnected). If not provided, no host will be disconnected.

For example, to use the host with identifier 456 to delete the storage connection with identifier 123 send a request like this:

DELETE /ovirt-engine/api/storageconnections/123?host=456

5.197.3. update PUT

Updates the storage connection.

For example, to change the address of the storage server send a request like this:

PUT /ovirt-engine/api/storageconnections/123

With a request body like this:

<storage_connection>
  <address>mynewnfs.example.com</address>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>
Table 611. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

connection

StorageConnection

In/Out

force

Boolean

In

Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.
force

Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).

This parameter is optional, and the default value is false.

5.198. StorageServerConnectionExtension

Table 612. Methods summary
Name Summary

get

remove

update

Update a storage server connection extension for the given host.

5.198.1. get GET

Table 613. Parameters summary
Name Type Direction Summary

extension

StorageConnectionExtension

Out

5.198.2. remove DELETE

Table 614. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.198.3. update PUT

Update a storage server connection extension for the given host.

To update the storage connection 456 of host 123 send a request like this:

PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456

With a request body like this:

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Table 615. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

extension

StorageConnectionExtension

In/Out

5.199. StorageServerConnectionExtensions

Table 616. Methods summary
Name Summary

add

Creates a new storage server connection extension for the given host.

list

5.199.1. add POST

Creates a new storage server connection extension for the given host.

The extension lets the user define credentials for an iSCSI target for a specific host. For example to use myuser and mypassword as the credentials when connecting to the iSCSI target from host 123 send a request like this:

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

With a request body like this:

<storage_connection_extension>
  <target>iqn.2016-01.com.example:mytarget</target>
  <username>myuser</username>
  <password>mypassword</password>
</storage_connection_extension>
Table 617. Parameters summary
Name Type Direction Summary

extension

StorageConnectionExtension

In/Out

5.199.2. list GET

Table 618. Parameters summary
Name Type Direction Summary

extensions

StorageConnectionExtension[]

Out

max

Integer

In

Sets the maximum number of extensions to return.
max

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

5.200. StorageServerConnections

Table 619. Methods summary
Name Summary

add

Creates a new storage connection.

list

5.200.1. add POST

Creates a new storage connection.

For example, to create a new storage connection for the NFS server mynfs.example.com and NFS share /export/mydata send a request like this:

POST /ovirt-engine/api/storageconnections

With a request body like this:

<storage_connection>
  <type>nfs</type>
  <address>mynfs.example.com</address>
  <path>/export/mydata</path>
  <host>
    <name>myhost</name>
  </host>
</storage_connection>
Table 620. Parameters summary
Name Type Direction Summary

connection

StorageConnection

In/Out

5.200.2. list GET

Table 621. Parameters summary
Name Type Direction Summary

connections

StorageConnection[]

Out

max

Integer

In

Sets the maximum number of connections to return.
max

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

5.201. System

Table 622. Methods summary
Name Summary

get

Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects.

reloadconfigurations

5.201.1. get GET

Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects.

GET /ovirt-engine/api

We get following response:

<api>
  <link rel="capabilities" href="/api/capabilities"/>
  <link rel="clusters" href="/api/clusters"/>
  <link rel="clusters/search" href="/api/clusters?search={query}"/>
  <link rel="datacenters" href="/api/datacenters"/>
  <link rel="datacenters/search" href="/api/datacenters?search={query}"/>
  <link rel="events" href="/api/events"/>
  <link rel="events/search" href="/api/events?search={query}"/>
  <link rel="hosts" href="/api/hosts"/>
  <link rel="hosts/search" href="/api/hosts?search={query}"/>
  <link rel="networks" href="/api/networks"/>
  <link rel="roles" href="/api/roles"/>
  <link rel="storagedomains" href="/api/storagedomains"/>
  <link rel="storagedomains/search" href="/api/storagedomains?search={query}"/>
  <link rel="tags" href="/api/tags"/>
  <link rel="templates" href="/api/templates"/>
  <link rel="templates/search" href="/api/templates?search={query}"/>
  <link rel="users" href="/api/users"/>
  <link rel="groups" href="/api/groups"/>
  <link rel="domains" href="/api/domains"/>
  <link rel="vmpools" href="/api/vmpools"/>
  <link rel="vmpools/search" href="/api/vmpools?search={query}"/>
  <link rel="vms" href="/api/vms"/>
  <link rel="vms/search" href="/api/vms?search={query}"/>
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>4</build>
      <full_version>4.0.4</full_version>
      <major>4</major>
      <minor>0</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <blank_template href="/ovirt-engine/api/templates/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
    <root_tag href="/ovirt-engine/api/tags/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"/>
  </special_objects>
  <summary>
    <hosts>
      <active>0</active>
      <total>0</total>
    </hosts>
    <storage_domains>
      <active>0</active>
      <total>1</total>
    </storage_domains>
    <users>
      <active>1</active>
      <total>1</total>
    </users>
    <vms>
      <active>0</active>
      <total>0</total>
    </vms>
  </summary>
  <time>2016-09-14T12:00:48.132+02:00</time>
</api>

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 entry point also contains other data such as product_info, special_objects and summary.

Table 623. Parameters summary
Name Type Direction Summary

api

Api

Out

5.201.2. reloadconfigurations POST

Table 624. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the reload should be performed asynchronously.

5.202. SystemPermissions

This service doesn’t add any new methods, it is just a placeholder for the annotation that specifies the path of the resource that manages the permissions assigned to the system object.

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

5.202.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 626. Parameters summary
Name Type Direction Summary

permission

Permission

In/Out

The permission.

5.202.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>
Table 627. Parameters summary
Name Type Direction Summary

permissions

Permission[]

Out

The list of permissions.

5.203. Tag

A service to manage a specific tag in the system.

Table 628. Methods summary
Name Summary

get

Gets the information about the tag.

remove

Removes the tag from the system.

update

Updates the tag entity.

5.203.1. get GET

Gets the information about the tag.

For example to retrieve the information about the tag with the id 123 send a request like this:

GET /ovirt-engine/api/tags/123
<tag href="/ovirt-engine/api/tags/123" id="123">
  <name>root</name>
  <description>root</description>
</tag>
Table 629. Parameters summary
Name Type Direction Summary

tag

Tag

Out

The tag.

5.203.2. remove DELETE

Removes the tag from the system.

For example to remove the tag with id 123 send a request like this:

DELETE /ovirt-engine/api/tags/123
Table 630. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.203.3. update PUT

Updates the tag entity.

For example to update parent tag to tag with id 456 of the tag with id 123 send a request like this:

PUT /ovirt-engine/api/tags/123

With request body like:

<tag>
  <parent id="456"/>
</tag>

You may also specify a tag name instead of id. For example to update parent tag to tag with name mytag of the tag with id 123 send a request like this:

<tag>
  <parent>
    <name>mytag</name>
  </parent>
</tag>
Table 631. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

tag

Tag

In/Out

The updated tag.

5.204. Tags

Represents a service to manage collection of the tags in the system.

Table 632. Methods summary
Name Summary

add

Add a new tag to the system.

list

List the tags in the system.

5.204.1. add POST

Add a new tag to the system.

For example, to add new tag with name mytag to the system send a request like this:

POST /ovirt-engine/api/tags

With a request body like this:

<tag>
  <name>mytag</name>
</tag>
The root tag is a special pseudo-tag assumed as the default parent tag if no parent tag is specified. The root tag cannot be deleted nor assigned a parent tag.

To create new tag with specific parent tag send a request body like this:

<tag>
  <name>mytag</name>
  <parent>
    <name>myparenttag</name>
  </parent>
</tag>
Table 633. Parameters summary
Name Type Direction Summary

tag

Tag

In/Out

The added tag.

5.204.2. list GET

List the tags in the system.

For example to list the full hierarchy of the tags in the system send a request like this:

GET /ovirt-engine/api/tags
<tags>
  <tag href="/ovirt-engine/api/tags/222" id="222">
    <name>root2</name>
    <description>root2</description>
    <parent href="/ovirt-engine/api/tags/111" id="111"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/333" id="333">
    <name>root3</name>
    <description>root3</description>
    <parent href="/ovirt-engine/api/tags/222" id="222"/>
  </tag>
  <tag href="/ovirt-engine/api/tags/111" id="111">
    <name>root</name>
    <description>root</description>
  </tag>
</tags>

In the previous XML output you can see the following hierarchy of the tags:

root:        (id: 111)
  - root2    (id: 222)
    - root3  (id: 333)
Table 634. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of tags to return.

tags

Tag[]

Out

List of all tags in the system.
max

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

5.205. Template

Manages the virtual machine template and template versions.

Table 635. Methods summary
Name Summary

export

Exports a template to the data center export domain.

get

Returns the information about this template or template version.

remove

Removes a virtual machine template.

seal

Seal the template.

update

Updates the template.

5.205.1. export POST

Exports a template to the data center export domain.

For example, the operation can be facilitated using the following request:

POST /ovirt-engine/api/templates/123/export

With a request body like this:

<action>
  <storage_domain id="456"/>
  <exclusive>true<exclusive/>
</action>
Table 636. Parameters summary
Name Type Direction Summary

exclusive

Boolean

In

Indicates if the existing templates with the same name should be overwritten.

storage_domain

StorageDomain

In

Specifies the destination export storage domain.
exclusive

Indicates if the existing templates with the same name should be overwritten.

The export action reports a failed action if a template of the same name exists in the destination domain. Set this parameter to true to change this behavior and overwrite any existing template.

5.205.2. get GET

Returns the information about this template or template version.

Table 637. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

template

Template

Out

The information about the template or template version.

5.205.3. remove DELETE

Removes a virtual machine template.

DELETE /ovirt-engine/api/templates/123
Table 638. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.205.4. seal POST

Seal the template.

Sealing erases all host-specific configuration from the filesystem: SSH keys, UDEV rules, MAC addresses, system ID, hostname etc., thus making easy to use the template to create multiple virtual machines without manual intervention.

Currently sealing is supported only for Linux OS.

5.205.5. update PUT

Updates the template.

The name, description, type, memory, cpu, topology, os, high_availability, display, stateless, usb and timezone elements can be updated after a template has been created.

For example, to update a template to so that it has 1 GiB of memory send a request like this:

PUT /ovirt-engine/api/templates/123

With the following request body:

<template>
  <memory>1073741824</memory>
</template>

The version_name name attribute is the only one that can be updated within the version attribute used for template versions:

<template>
  <version>
    <version_name>mytemplate_2</version_name>
  </version>
</template>
Table 639. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

template

Template

In/Out

5.206. TemplateCdrom

A service managing a CD-ROM device on templates.

Table 640. Methods summary
Name Summary

get

Returns the information about this CD-ROM device.

5.206.1. get GET

Returns the information about this CD-ROM device.

For example, to get information about the CD-ROM device of template 123 send a request like:

GET /ovirt-engine/api/templates/123/cdroms/
Table 641. Parameters summary
Name Type Direction Summary

cdrom

Cdrom

Out

The information about the CD-ROM device.
cdrom

The information about the CD-ROM device.

The information consists of cdrom attribute containing reference to the CD-ROM device, the template, and optionally the inserted disk.

If there is a disk inserted then the file attribute will contain a reference to the ISO image:

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
  <file id="mycd.iso"/>
</cdrom>

If there is no disk inserted then the file attribute won’t be reported:

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>

5.207. TemplateCdroms

Lists the CD-ROM devices of a template.

Table 642. Methods summary
Name Summary

list

5.207.1. list GET

Table 643. Parameters summary
Name Type Direction Summary

cdroms

Cdrom[]

Out

The list of CD-ROM devices of the template.

max

Integer

In

Sets the maximum number of CD-ROMs to return.
max

Sets the maximum number of CD-ROMs to return. If not specified all the CD-ROMs are returned.

5.208. TemplateDisk

Table 644. Methods summary
Name Summary

copy

export

get

remove

5.208.1. copy POST

Table 645. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the copy should be performed asynchronously.

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

5.208.2. export POST

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

5.208.3. get GET

Table 647. Parameters summary
Name Type Direction Summary

disk

Disk

Out

5.208.4. remove DELETE

Table 648. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.209. TemplateDiskAttachment

This service manages the attachment of a disk to a template.

Table 649. Methods summary
Name Summary

get

Returns the details of the attachment.

remove

Removes the disk from the template.

5.209.1. get GET

Returns the details of the attachment.

Table 650. Parameters summary
Name Type Direction Summary

attachment

DiskAttachment

Out

5.209.2. remove DELETE

Removes the disk from the template. The disk will only be removed if there are other existing copies of the disk on other storage domains.

A storage domain has to be specified to determine which of the copies should be removed (template disks can have copies on multiple storage domains).

DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74
Table 651. Parameters summary
Name Type Direction Summary

force

Boolean

In

storage_domain

String

In

Specifies the identifier of the storage domain the image to be removed resides on.

5.210. TemplateDiskAttachments

This service manages the set of disks attached to a template. Each attached disk is represented by a DiskAttachment.

Table 652. Methods summary
Name Summary

list

List the disks that are attached to the template.

5.210.1. list GET

List the disks that are attached to the template.

Table 653. Parameters summary
Name Type Direction Summary

attachments

DiskAttachment[]

Out

5.211. TemplateDisks

Table 654. Methods summary
Name Summary

list

5.211.1. list GET

Table 655. Parameters summary
Name Type Direction Summary

disks

Disk[]

Out

max

Integer

In

Sets the maximum number of disks to return.
max

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

5.212. TemplateGraphicsConsole

Table 656. Methods summary
Name Summary

get

Gets graphics console configuration of the template.

remove

Remove the graphics console from the template.

5.212.1. get GET

Gets graphics console configuration of the template.

Table 657. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

Out

The information about the graphics console of the template.

5.212.2. remove DELETE

Remove the graphics console from the template.

Table 658. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.213. TemplateGraphicsConsoles

Table 659. Methods summary
Name Summary

add

Add new graphics console to the template.

list

Lists all the configured graphics consoles of the template.

5.213.1. add POST

Add new graphics console to the template.

Table 660. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

In/Out

5.213.2. list GET

Lists all the configured graphics consoles of the template.

Table 661. Parameters summary
Name Type Direction Summary

consoles

GraphicsConsole[]

Out

The list of graphics consoles of the template.

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.

5.214. TemplateNic

Table 662. Methods summary
Name Summary

get

remove

update

5.214.1. get GET

Table 663. Parameters summary
Name Type Direction Summary

nic

Nic

Out

5.214.2. remove DELETE

Table 664. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.214.3. update PUT

Table 665. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

nic

Nic

In/Out

5.215. TemplateNics

Table 666. Methods summary
Name Summary

add

list

5.215.1. add POST

Table 667. Parameters summary
Name Type Direction Summary

nic

Nic

In/Out

5.215.2. list GET

Table 668. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of NICs to return.

nics

Nic[]

Out
max

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

5.216. TemplateWatchdog

Table 669. Methods summary
Name Summary

get

remove

update

5.216.1. get GET

Table 670. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

Out

5.216.2. remove DELETE

Table 671. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.216.3. update PUT

Table 672. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

watchdog

Watchdog

In/Out

5.217. TemplateWatchdogs

Table 673. Methods summary
Name Summary

add

list

5.217.1. add POST

Table 674. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

In/Out

5.217.2. list GET

Table 675. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of watchdogs to return.

watchdogs

Watchdog[]

Out
max

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

5.218. Templates

This service manages the virtual machine templates available in the system.

Table 676. Methods summary
Name Summary

add

Creates a new template.

list

Returns the list of virtual machine templates.

5.218.1. add POST

Creates a new template.

This requires the name and vm elements. Identify the virtual machine with the id name attributes.

POST /ovirt-engine/api/templates

With a request body like this:

<template>
  <name>mytemplate</name>
  <vm id="123"/>
</template>

The template can be created as a sub version of an existing template.This requires the name and vm attributes for the new template, and the base_template and version_name attributes for the new template version. The base_template and version_name attributes must be specified within a version section enclosed in the template section. Identify the virtual machine with the id or name attributes.

<template>
  <name>mytemplate</name>
  <vm id="123"/>
  <version>
    <base_template id="456"/>
    <version_name>mytemplate_001</version_name>
  </version>
</template>
Table 677. Parameters summary
Name Type Direction Summary

clone_permissions

Boolean

In

Specifies if the permissions of the virtual machine should be copied to the template.

template

Template

In/Out

The information about the template or template version.
clone_permissions

Specifies if the permissions of the virtual machine should be copied to the template.

If this optional parameter is provided, and its values is true then the permissions of the virtual machine (only the direct ones, not the inherited ones) will be copied to the created template. For example, to create a template from the myvm virtual machine copying its permissions, send a request like this:

POST /ovirt-engine/api/templates?clone_permissions=true

With a request body like this:

<template>
  <name>mytemplate<name>
  <vm>
    <name>myvm<name>
  </vm>
</template>

5.218.2. list GET

Returns the list of virtual machine templates.

For example:

GET /ovirt-engine/api/templates

Will return the list of virtual machines and virtual machine templates.

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

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 templates to return.

search

String

In

A query string used to restrict the returned templates.

templates

Template[]

Out

The list of virtual machine templates.
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 templates to return. If not specified all the templates are returned.

5.219. UnmanagedNetwork

Table 679. Methods summary
Name Summary

get

remove

5.219.1. get GET

Table 680. Parameters summary
Name Type Direction Summary

network

UnmanagedNetwork

Out

5.219.2. remove DELETE

Table 681. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.220. UnmanagedNetworks

Table 682. Methods summary
Name Summary

list

5.220.1. list GET

Table 683. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of networks to return.

networks

UnmanagedNetwork[]

Out
max

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

5.221. User

A service to manage a user in the system. Use this service to either get users details or remove users. In order to add new users please use Users.

Table 684. Methods summary
Name Summary

get

Gets the system user information.

remove

Removes the system user.

5.221.1. get GET

Gets the system user information.

Usage:

GET /ovirt-engine/api/users/1234

Will return the user information:

<user href="/ovirt-engine/api/users/1234" id="1234">
  <name>admin</name>
  <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
  <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
  <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
  <department></department>
  <domain_entry_id>23456</domain_entry_id>
  <email>user1@domain.com</email>
  <last_name>Lastname</last_name>
  <namespace>*</namespace>
  <principal>user1</principal>
  <user_name>user1@domain-authz</user_name>
  <domain href="/ovirt-engine/api/domains/45678" id="45678">
    <name>domain-authz</name>
  </domain>
</user>
Table 685. Parameters summary
Name Type Direction Summary

user

User

Out

The system user.

5.221.2. remove DELETE

Removes the system user.

Usage:

DELETE /ovirt-engine/api/users/1234
Table 686. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.222. Users

A service to manage the users in the system.

Table 687. Methods summary
Name Summary

add

Add user from a directory service.

list

List all the users in the system.

5.222.1. add POST

Add user from a directory service.

For example, to add the myuser user from the myextension-authz authorization provider send a request like this:

POST /ovirt-engine/api/users

With a request body like this:

<user>
  <user_name>myuser@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>

In case you are working with Active Directory you have to pass user principal name (UPN) as username, followed by authorization provider name. Due to bug 1147900 you need to provide also principal parameter set to UPN of the user.

For example, to add the user with UPN myuser@mysubdomain.mydomain.com from the myextension-authz authorization provider send a request body like this:

<user>
  <principal>myuser@mysubdomain.mydomain.com</principal>
  <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name>
  <domain>
    <name>myextension-authz</name>
  </domain>
</user>
Table 688. Parameters summary
Name Type Direction Summary

user

User

In/Out

5.222.2. list GET

List all the users in the system.

Usage:

GET /ovirt-engine/api/users

Will return the list of users:

<users>
  <user href="/ovirt-engine/api/users/1234" id="1234">
    <name>admin</name>
    <link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
    <link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
    <link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
    <link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
    <domain_entry_id>23456</domain_entry_id>
    <namespace>*</namespace>
    <principal>user1</principal>
    <user_name>user1@domain-authz</user_name>
    <domain href="/ovirt-engine/api/domains/45678" id="45678">
      <name>domain-authz</name>
    </domain>
  </user>
</users>
Table 689. 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.
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 users to return. If not specified all the users are returned.

5.223. VirtualFunctionAllowedNetwork

Table 690. Methods summary
Name Summary

get

remove

5.223.1. get GET

Table 691. Parameters summary
Name Type Direction Summary

network

Network

Out

5.223.2. remove DELETE

Table 692. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.224. VirtualFunctionAllowedNetworks

Table 693. Methods summary
Name Summary

add

list

5.224.1. add POST

Table 694. Parameters summary
Name Type Direction Summary

network

Network

In/Out

5.224.2. list GET

Table 695. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of networks to return.

networks

Network[]

Out
max

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

5.225. Vm

Table 696. Methods summary
Name Summary

cancelmigration

This operation stops any migration of a virtual machine to another physical host.

clone

commitsnapshot

detach

Detaches a virtual machine from a pool.

export

Export a virtual machine to an export domain.

freezefilesystems

Freeze virtual machine file systems.

get

Retrieves the description of the virtual machine.

logon

Initiates the automatic user logon to access a virtual machine from an external console.

maintenance

Sets the global maintenance mode on the hosted engine virtual machine.

migrate

This operation migrates a virtual machine to another physical host.

previewsnapshot

reboot

This operation sends a reboot request to a virtual machine.

remove

Removes the virtual machine, including the virtual disks attached to it.

reordermacaddresses

shutdown

This operation sends a shutdown request to a virtual machine.

start

Starts the virtual machine.

stop

This operation forces a virtual machine to power-off.

suspend

This operation saves the virtual machine state to disk and stops it.

thawfilesystems

Thaw virtual machine file systems.

ticket

Generates a time-sensitive authentication token for accessing a virtual machine’s display.

undosnapshot

update

5.225.1. cancelmigration POST

This operation stops any migration of a virtual machine to another physical host.

POST /ovirt-engine/api/vms/123/cancelmigration

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

<action/>
Table 697. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the migration should cancelled asynchronously.

5.225.2. clone POST

Table 698. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the clone should be performed asynchronously.

vm

Vm

In

5.225.3. commitsnapshot POST

Table 699. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the snapshots should be committed asynchronously.

5.225.4. detach POST

Detaches a virtual machine from a pool.

POST /ovirt-engine/api/vms/123/detach

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

<action/>
Table 700. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the detach should be performed asynchronously.

5.225.5. export POST

Export a virtual machine to an export domain.

For example to export virtual machine 123 to the export domain myexport, send a request like this:

POST /ovirt-engine/api/vms/123/export

With a request body like this:

<action>
  <storage_domain>
    <name>myexport</name>
  </storage_domain>
  <exclusive>true</exclusive>
  <discard_snapshots>true</discard_snapshots>
</action>
Table 701. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the export should be performed asynchronously.

discard_snapshots

Boolean

In

The discard_snapshots parameter is to be used when the virtual machine should be exported with all its snapshots collapsed.

exclusive

Boolean

In

The exclusive parameter is to be used when the virtual machine should be exported even if another copy of it already exists in the export domain (override).

storage_domain

StorageDomain

In

5.225.6. freezefilesystems POST

Freeze virtual machine file systems.

This operation freezes a virtual machine’s file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.

Example:

POST /ovirt-engine/api/vms/123/freezefilesystems
<action/>
Table 702. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the freeze should be performed asynchronously.

5.225.7. get GET

Retrieves the description of the virtual machine.

Table 703. Parameters summary
Name Type Direction Summary

all_content

Boolean

In

Indicates if all the attributes of the virtual machine should be included in the response.

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

next_run

Boolean

In

Indicates if the returned result describes the virtual machine as it is currently running, or if describes it with the modifications that have already been performed but that will have effect only when it is restarted.

vm

Vm

Out

Description of the virtual machine.
all_content

Indicates if all the attributes of the virtual machine should be included in the response.

By default the following attributes are excluded:

  • console

  • initialization.configuration.data - The OVF document describing the virtual machine.

  • rng_source

  • soundcard

  • virtio_scsi

For example, to retrieve the complete representation of the virtual machine '123' send a request like this:

GET /ovirt-engine/api/vms/123?all_content=true
The reason for not including these attributes is performance: they are seldom used and they require additional queries to the database. So try to use the this parameter only when it is really needed.
next_run

Indicates if the returned result describes the virtual machine as it is currently running, or if describes it with the modifications that have already been performed but that will have effect only when it is restarted. By default the values is false.

If the parameter is included in the request, but without a value, it is assumed that the value is true, so the following request:

GET /vms/{vm:id};next_run

Is equivalent to using the value true:

GET /vms/{vm:id};next_run=true

5.225.8. logon POST

Initiates the automatic user logon to access a virtual machine from an external console.

This action requires the ovirt-guest-agent-gdm-plugin and the ovirt-guest-agent-pam-module packages to be installed and the ovirt-guest-agent service to be running on the virtual machine.

Users require the appropriate user permissions for the virtual machine in order to access the virtual machine from an external console.

This is how an example request would look like:

POST /ovirt-engine/api/vms/123/logon

Request body:

<action/>
Table 704. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the logon should be performed asynchronously.

5.225.9. maintenance POST

Sets the global maintenance mode on the hosted engine virtual machine.

This action has no effect on other virtual machines.

Example:

POST /ovirt-engine/api/vms/123/maintenance
<action>
  <maintenance_enabled>true<maintenance_enabled/>
</action>
Table 705. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

maintenance_enabled

Boolean

In

Indicates if global maintenance should be enabled or disabled.

5.225.10. migrate POST

This operation migrates a virtual machine to another physical host.

POST /ovirt-engine/api/vms/123/migrate

One can specify a specific host to migrate the virtual machine to:

<action>
  <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>
Table 706. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the migration should be performed asynchronously.

cluster

Cluster

In

Specifies the cluster the virtual machine should migrate to.

force

Boolean

In

Specifies the virtual machine should migrate although it might be defined as non migratable.

host

Host

In

Specifies a specific host the virtual machine should migrate to.
cluster

Specifies the cluster the virtual machine should migrate to. This is an optional parameter. By default, the virtual machine is migrated to another host within the same cluster.

force

Specifies the virtual machine should migrate although it might be defined as non migratable. This is an optional parameter. By default, it is set to false.

host

Specifies a specific host the virtual machine should migrate to. This is an optional parameters. By default, the oVirt Engine automatically selects a default host for migration within the same cluster. If an API user requires a specific host, the user can specify the host with either an id or name parameter.

5.225.11. previewsnapshot POST

Table 707. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the preview should be performed asynchronously.

disks

Disk[]

In

restore_memory

Boolean

In

snapshot

Snapshot

In

vm

Vm

In

5.225.12. reboot POST

This operation sends a reboot request to a virtual machine.

POST /ovirt-engine/api/vms/123/reboot

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

<action/>
Table 708. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the reboot should be performed asynchronously.

5.225.13. remove DELETE

Removes the virtual machine, including the virtual disks attached to it.

For example, to remove the virtual machine with identifier 123 send a request like this:

DELETE /ovirt-engine/api/vms/123
Table 709. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

detach_only

Boolean

In

Indicates if the attached virtual disks should be detached first and preserved instead of being removed.

force

Boolean

In

Indicates if the virtual machine should be forcibly removed.
force

Indicates if the virtual machine should be forcibly removed.

Locked virtual machines and virtual machines with locked disk images cannot be removed without this flag set to true.

5.225.14. reordermacaddresses POST

Table 710. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.225.15. shutdown POST

This operation sends a shutdown request to a virtual machine.

POST /ovirt-engine/api/vms/123/shutdown

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

<action/>
Table 711. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the shutdown should be performed asynchronously.

5.225.16. start POST

Starts the virtual machine.

If the virtual environment is complete and the virtual machine contains all necessary components to function, it can be started.

This example starts the virtual machine:

POST /ovirt-engine/api/vms/123/start

With a request body:

<action/>
Table 712. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

pause

Boolean

In

If set to true, start the virtual machine in paused mode.

use_cloud_init

Boolean

In

If set to true, the initialization type is set to cloud-init.

use_sysprep

Boolean

In

If set to true, the initialization type is set to Sysprep.

vm

Vm

In

The definition of the virtual machine for this specific run.
pause

If set to true, start the virtual machine in paused mode. Default is false.

use_cloud_init

If set to true, the initialization type is set to cloud-init. The default value is false. See this for details.

use_sysprep

If set to true, the initialization type is set to Sysprep. The default value is false. See this for details.

vm

The definition of the virtual machine for this specific run.

For example:

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

This will set the boot device to the CDROM only for this specific start. After the virtual machine will be powered off, this definition will be reverted.

5.225.17. stop POST

This operation forces a virtual machine to power-off.

POST /ovirt-engine/api/vms/123/stop

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

<action/>
Table 713. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.225.18. suspend POST

This operation saves the virtual machine state to disk and stops it. Start a suspended virtual machine and restore the virtual machine state with the start action.

POST /ovirt-engine/api/vms/123/suspend

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

<action/>
Table 714. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.225.19. thawfilesystems POST

Thaw virtual machine file systems.

This operation thaws a virtual machine’s file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.

Example:

POST /api/vms/123/thawfilesystems
<action/>
Table 715. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.225.20. ticket POST

Generates a time-sensitive authentication token for accessing a virtual machine’s display.

POST /ovirt-engine/api/vms/123/ticket

The client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.

In any case, the response specifies the actual ticket value and expiry used.

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>

If the virtual machine is configured to support only one graphics protocol then the generated authentication token will be valid for that protocol. But if the virtual machine is configured to support multiple protocols, VNC and SPICE, then the authentication token will only be valid for the SPICE protocol.

In order to obtain an authentication token for a specific protocol, for example for VNC, use the ticket method of the service that manages the graphics consoles of the virtual machine, sending a request like this:

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
Table 716. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the generation of the ticket should be performed asynchronously.

ticket

Ticket

In/Out

5.225.21. undosnapshot POST

Table 717. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the action should be performed asynchronously.

5.225.22. update PUT

Table 718. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

next_run

Boolean

In

Indicates if the update should be applied to the virtual machine immediately, or if it should be applied only when the virtual machine is restarted.

vm

Vm

In/Out
next_run

Indicates if the update should be applied to the virtual machine immediately, or if it should be applied only when the virtual machine is restarted. The default value is false, so by default changes are applied immediately.

5.226. VmApplication

A service that provides information about an application installed in a virtual machine.

Table 719. Methods summary
Name Summary

get

Returns the information about the application.

5.226.1. get GET

Returns the information about the application.

Table 720. Parameters summary
Name Type Direction Summary

application

Application

Out

The information about the application.

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.
application

The information about the application.

The information consists of name attribute containing the name of the application (which is an arbitrary string that may also contain additional information such as version) and vm attribute identifying the virtual machine.

For example, a request like this:

GET /ovirt-engine/api/vms/123/applications/789

May return information like this:

<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
  <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

5.227. VmApplications

A service that provides information about applications installed in a virtual machine.

Table 721. Methods summary
Name Summary

list

Returns a list of applications installed in the virtual machine.

5.227.1. list GET

Returns a list of applications installed in the virtual machine.

Table 722. Parameters summary
Name Type Direction Summary

applications

Application[]

Out

A list of applications installed in the virtual machine.

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 applications to return.
applications

A list of applications installed in the virtual machine.

For example, a request like this:

GET /ovirt-engine/api/vms/123/applications/

May return a list like this:

<applications>
  <application href="/ovirt-engine/api/vms/123/applications/456" id="456">
    <name>kernel-3.10.0-327.36.1.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
  <application href="/ovirt-engine/api/vms/123/applications/789" id="789">
    <name>ovirt-guest-agent-common-1.0.12-3.el7</name>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </application>
</applications>
max

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

5.228. VmCdrom

Manages a CDROM device of a virtual machine.

Changing and ejecting the disk is done using always the update method, to change the value of the file attribute.

Table 723. Methods summary
Name Summary

get

Returns the information about this CDROM device.

update

Updates the information about this CDROM device.

5.228.1. get GET

Returns the information about this CDROM device.

The information consists of cdrom attribute containing reference to the CDROM device, the virtual machine, and optionally the inserted disk.

If there is a disk inserted then the file attribute will contain a reference to the ISO image:

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <file id="mycd.iso"/>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>

If there is no disk inserted then the file attribute won’t be reported:

<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
Table 724. Parameters summary
Name Type Direction Summary

cdrom

Cdrom

Out

The information about the CDROM device.

current

Boolean

In

Indicates if the operation should return the information for the currently running virtual machine.
current

Indicates if the operation should return the information for the currently running virtual machine. This parameter is optional, and the default value is false.

5.228.2. update PUT

Updates the information about this CDROM device.

It allows to change or eject the disk by changing the value of the file attribute. For example, to insert or change the disk send a request like this:

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000

The body should contain the new value for the file attribute:

<cdrom>
  <file id="mycd.iso"/>
</cdrom>

The value of the id attribute, mycd.iso in this example, should correspond to a file available in an attached ISO storage domain.

To eject the disk use a file with an empty id:

<cdrom>
  <file id=""/>
</cdrom>

By default the above operations change permanently the disk that will be visible to the virtual machine after the next boot, but they don’t have any effect on the currently running virtual machine. If you want to change the disk that is visible to the current running virtual machine, add the current=true parameter. For example, to eject the current disk send a request like this:

PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true

With a request body like this:

<cdrom>
  <file id=""/>
</cdrom>
The changes made with the current=true parameter are never persisted, so they won’t have any effect after the virtual machine is rebooted.
Table 725. Parameters summary
Name Type Direction Summary

cdrom

Cdrom

In/Out

The information about the CDROM device.

current

Boolean

In

Indicates if the update should apply to the currently running virtual machine, or to the virtual machine after the next boot.
current

Indicates if the update should apply to the currently running virtual machine, or to the virtual machine after the next boot. This parameter is optional, and the default value is false, which means that by default the update will have effect only after the next boot.

5.229. VmCdroms

Manages the CDROM devices of a virtual machine.

Currently virtual machines have exactly one CDROM device. No new devices can be added, and the existing one can’t be removed, thus there are no add or remove methods. Changing and ejecting CDROM disks is done with the update method of the service that manages the CDROM device.

Table 726. Methods summary
Name Summary

list

Returns the list of CDROM devices of the virtual machine.

5.229.1. list GET

Returns the list of CDROM devices of the virtual machine.

Table 727. Parameters summary
Name Type Direction Summary

cdroms

Cdrom[]

Out

The list of CDROM devices of the virtual machine.

max

Integer

In

Sets the maximum number of CDROMs to return.
max

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

5.230. VmDisk

Table 728. Methods summary
Name Summary

activate

deactivate

export

get

move

remove

Detach the disk from the virtual machine.

update

5.230.1. activate POST

Table 729. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the activation should be performed asynchronously.

5.230.2. deactivate POST

Table 730. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the deactivation should be performed asynchronously.

5.230.3. export POST

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

5.230.4. get GET

Table 732. Parameters summary
Name Type Direction Summary

disk

Disk

Out

5.230.5. move POST

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

5.230.6. remove DELETE

Detach the disk from the virtual machine.

In version 3 of the API this used to also remove the disk completely from the system, but starting with version 4 it doesn’t. If you need to remove it completely use the remove method of the top level disk service.
Table 734. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.230.7. update PUT

Table 735. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

disk

Disk

In/Out

5.231. VmDisks

Table 736. Methods summary
Name Summary

add

list

5.231.1. add POST

Table 737. Parameters summary
Name Type Direction Summary

disk

Disk

In/Out

5.231.2. list GET

Table 738. Parameters summary
Name Type Direction Summary

disks

Disk[]

Out

max

Integer

In

Sets the maximum number of disks to return.
max

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

5.232. VmGraphicsConsole

Table 739. Methods summary
Name Summary

get

Gets graphics console configuration of the virtual machine.

proxyticket

remoteviewerconnectionfile

Generates the file which is compatible with remote-viewer client.

remove

Remove the graphics console from the virtual machine.

ticket

Generates a time-sensitive authentication token for accessing this virtual machine’s console.

5.232.1. get GET

Gets graphics console configuration of the virtual machine.

Table 740. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

Out

The information about the graphics console of the virtual machine.

current

Boolean

In

Use the following query to obtain the current run-time configuration of the graphics console.
current

Use the following query to obtain the current run-time configuration of the graphics console.

GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true

The default value is false.

5.232.2. proxyticket POST

Table 741. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the generation of the ticket should be performed asynchronously.

proxy_ticket

ProxyTicket

Out

5.232.3. remoteviewerconnectionfile POST

Generates the file which is compatible with remote-viewer client.

Use the following request to generate remote viewer connection file of the graphics console. Note that this action generates the file only if virtual machine is running.

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile

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

<action/>

The response contains the file, which can be used with remote-viewer client.

<action>
  <remote_viewer_connection_file>
    [virt-viewer]
    type=spice
    host=192.168.1.101
    port=-1
    password=123456789
    delete-this-file=1
    fullscreen=0
    toggle-fullscreen=shift+f11
    release-cursor=shift+f12
    secure-attention=ctrl+alt+end
    tls-port=5900
    enable-smartcard=0
    enable-usb-autoshare=0
    usb-filter=null
    tls-ciphers=DEFAULT
    host-subject=O=local,CN=example.com
    ca=...
  </remote_viewer_connection_file>
</action>

E.g., to fetch the content of remote viewer connection file and save it into temporary file, user can use oVirt Python SDK as follows:

# Find the virtual machine:
vm = vms_service.list(search='name=myvm')[0]

# Locate the service that manages the virtual machine, as that is where
# the locators are defined:
vm_service = vms_service.vm_service(vm.id)

# Find the graphic console of the virtual machine:
graphics_consoles_service = vm_service.graphics_consoles_service()
graphics_console = graphics_consoles_service.list()[0]

# Generate the remote viewer connection file:
console_service = graphics_consoles_service.console_service(graphics_console.id)
remote_viewer_connection_file = console_service.remote_viewer_connection_file()

# Write the content to file "/tmp/remote_viewer_connection_file.vv"
path = "/tmp/remote_viewer_connection_file.vv"
with open(path, "w") as f:
    f.write(remote_viewer_connection_file)

When you create the remote viewer connection file, then you can connect to virtual machine graphic console, as follows:

#!/bin/sh -ex

remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv
Table 742. Parameters summary
Name Type Direction Summary

remote_viewer_connection_file

String

Out

Contains the file which is compatible with remote-viewer client.
remote_viewer_connection_file

Contains the file which is compatible with remote-viewer client.

User can use the content of this attribute to create a file, which can be passed to remote-viewer client to connect to virtual machine graphic console.

5.232.4. remove DELETE

Remove the graphics console from the virtual machine.

Table 743. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.232.5. ticket POST

Generates a time-sensitive authentication token for accessing this virtual machine’s console.

POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket

The client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.

In any case, the response specifies the actual ticket value and expiry used.

<action>
  <ticket>
    <value>abcd12345</value>
    <expiry>120</expiry>
  </ticket>
</action>
Table 744. Parameters summary
Name Type Direction Summary

ticket

Ticket

In/Out

The generated ticket that can be used to access this console.

5.233. VmGraphicsConsoles

Table 745. Methods summary
Name Summary

add

Add new graphics console to the virtual machine.

list

Lists all the configured graphics consoles of the virtual machine.

5.233.1. add POST

Add new graphics console to the virtual machine.

Table 746. Parameters summary
Name Type Direction Summary

console

GraphicsConsole

In/Out

5.233.2. list GET

Lists all the configured graphics consoles of the virtual machine.

Table 747. Parameters summary
Name Type Direction Summary

consoles

GraphicsConsole[]

Out

The list of graphics consoles of the virtual machine.

current

Boolean

In

Use the following query to obtain the current run-time configuration of the graphics consoles.

max

Integer

In

Sets the maximum number of consoles to return.
current

Use the following query to obtain the current run-time configuration of the graphics consoles.

GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true

The default value is false.

max

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

5.234. VmHostDevice

A service to manage individual host device attached to a virtual machine.

Table 748. Methods summary
Name Summary

get

Retrieve information about particular host device attached to given virtual machine.

remove

Remove the attachment of this host device from given virtual machine.

5.234.1. get GET

Retrieve information about particular host device attached to given virtual machine.

Example:

GET /ovirt-engine/api/vms/123/hostdevices/456
<host_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
  <name>pci_0000_04_00_0</name>
  <capability>pci</capability>
  <iommu_group>30</iommu_group>
  <placeholder>true</placeholder>
  <product id="0x13ba">
    <name>GM107GL [Quadro K2200]</name>
  </product>
  <vendor id="0x10de">
    <name>NVIDIA Corporation</name>
  </vendor>
  <host href="/ovirt-engine/api/hosts/543" id="543"/>
  <parent_device href="/ovirt-engine/api/hosts/543/devices/456" id="456">
    <name>pci_0000_00_03_0</name>
  </parent_device>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</host_device>
Table 749. Parameters summary
Name Type Direction Summary

device

HostDevice

Out

Retrieved information about the host device attached to given virtual machine.

5.234.2. remove DELETE

Remove the attachment of this host device from given virtual machine.

In case this device serves as an IOMMU placeholder, it cannot be removed (remove will result only in setting its placeholder flag to true). Note that all IOMMU placeholder devices will be removed automatically as soon as there will be no more non-placeholder devices (all devices from given IOMMU group are detached). 
DELETE /ovirt-engine/api/vms/123/hostdevices/456
Table 750. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.235. VmHostDevices

A service to manage host devices attached to a virtual machine.

Table 751. Methods summary
Name Summary

add

Attach target device to given virtual machine.

list

List the host devices assigned to given virtual machine.

5.235.1. add POST

Attach target device to given virtual machine.

Example:

POST /ovirt-engine/api/vms/123/hostdevices

With request body of type HostDevice, for example

<host_device id="123" />
A necessary precondition for a successful host device attachment is that the virtual machine must be pinned to exactly one host. The device ID is then taken relative to this host.
Attachment of a PCI device that is part of a bigger IOMMU group will result in attachment of the remaining devices from that IOMMU group as "placeholders". These devices are then identified using the placeholder attribute of the HostDevice type set to true.

In case you want attach a device that already serves as an IOMMU placeholder, simply issue an explicit Add operation for it, and its placeholder flag will be cleared, and the device will be accessible to the virtual machine.

Table 752. Parameters summary
Name Type Direction Summary

device

HostDevice

In/Out

The host device to be attached to given virtual machine.

5.235.2. list GET

List the host devices assigned to given virtual machine.

Table 753. Parameters summary
Name Type Direction Summary

device

HostDevice[]

Out

Retrieved list of host devices attached to given virtual machine.

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.

5.236. VmNic

Table 754. Methods summary
Name Summary

activate

deactivate

get

remove

Removes the NIC.

update

Updates the NIC.

5.236.1. activate POST

Table 755. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the activation should be performed asynchronously.

5.236.2. deactivate POST

Table 756. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the deactivation should be performed asynchronously.

5.236.3. get GET

Table 757. Parameters summary
Name Type Direction Summary

nic

Nic

Out

5.236.4. remove DELETE

Removes the NIC.

For example, to remove the NIC with id 456 from the virtual machine with id 123 send a request like this:

DELETE /ovirt-engine/api/vms/123/nics/456

The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:

  • Red Hat Enterprise Linux 6

  • Red Hat Enterprise Linux 5

  • Windows Server 2008 and

  • Windows Server 2003
Table 758. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.236.5. update PUT

Updates the NIC.

For example, to update the NIC having with 456 belonging to virtual the machine with id 123 send a request like this:

PUT /ovirt-engine/api/vms/123/nics/456

With a request body like this:

<nic>
  <name>mynic</name>
  <interface>e1000</interface>
  <vnic_profile id='789'/>
</nic>

The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:

  • Red Hat Enterprise Linux 6

  • Red Hat Enterprise Linux 5

  • Windows Server 2008 and

  • Windows Server 2003
Table 759. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

nic

Nic

In/Out

5.237. VmNics

Table 760. Methods summary
Name Summary

add

Adds a NIC to the virtual machine.

list

5.237.1. add POST

Adds a NIC to the virtual machine.

The following example adds a network interface named mynic using virtio and the ovirtmgmt network to the virtual machine.

POST /ovirt-engine/api/vms/123/nics
<nic>
  <interface>virtio</interface>
  <name>mynic</name>
  <network>
    <name>ovirtmgmt</name>
  </network>
</nic>

The following example sends that request using curl:

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

The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:

  • Red Hat Enterprise Linux 6

  • Red Hat Enterprise Linux 5

  • Windows Server 2008 and

  • Windows Server 2003
Table 761. Parameters summary
Name Type Direction Summary

nic

Nic

In/Out

5.237.2. list GET

Table 762. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of NICs to return.

nics

Nic[]

Out
max

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

5.238. VmNumaNode

Table 763. Methods summary
Name Summary

get

remove

Removes a virtual NUMA node.

update

Updates a virtual NUMA node.

5.238.1. get GET

Table 764. Parameters summary
Name Type Direction Summary

node

VirtualNumaNode

Out

5.238.2. remove DELETE

Removes a virtual NUMA node.

An example of removing a virtual NUMA node:

DELETE /ovirt-engine/api/vms/123/numanodes/456
Table 765. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.238.3. update PUT

Updates a virtual NUMA node.

An example of pinning a virtual NUMA node to a physical NUMA node on the host:

PUT /ovirt-engine/api/vms/123/numanodes/456

The request body should contain the following:

<vm_numa_node>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
</vm_numa_node>
Table 766. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

node

VirtualNumaNode

In/Out

5.239. VmNumaNodes

Table 767. Methods summary
Name Summary

add

Creates a new virtual NUMA node for the virtual machine.

list

Lists virtual NUMA nodes of a virtual machine.

5.239.1. add POST

Creates a new virtual NUMA node for the virtual machine.

An example of creating a NUMA node:

POST /ovirt-engine/api/vms/c7ecd2dc/numanodes
Accept: application/xml
Content-type: application/xml

The request body can contain the following:

<vm_numa_node>
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
</vm_numa_node>
Table 768. Parameters summary
Name Type Direction Summary

node

VirtualNumaNode

In/Out

5.239.2. list GET

Lists virtual NUMA nodes of a virtual machine.

Table 769. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of nodes to return.

nodes

VirtualNumaNode[]

Out
max

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

5.240. VmPool

A service to manage a virtual machines pool.

Table 770. Methods summary
Name Summary

allocatevm

This operation allocates a virtual machine in the virtual machine pool.

get

Get the virtual machine pool.

remove

Removes a virtual machine pool.

update

Update the virtual machine pool.

5.240.1. allocatevm POST

This operation allocates a virtual machine in the virtual machine pool.

POST /ovirt-engine/api/vmpools/123/allocatevm

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

<action/>
Table 771. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the allocation should be performed asynchronously.

5.240.2. get GET

Get the virtual machine pool.

GET /ovirt-engine/api/vmpools/123

You will get a XML response like that one:

<vm_pool id="123">
  <actions>...</actions>
  <name>MyVmPool</name>
  <description>MyVmPool description</description>
  <link href="/ovirt-engine/api/vmpools/123/permissions" rel="permissions"/>
  <max_user_vms>1</max_user_vms>
  <prestarted_vms>0</prestarted_vms>
  <size>100</size>
  <stateful>false</stateful>
  <type>automatic</type>
  <use_latest_template_version>false</use_latest_template_version>
  <cluster id="123"/>
  <template id="123"/>
  <vm id="123">...</vm>
  ...
</vm_pool>
Table 772. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

pool

VmPool

Out

Retrieved virtual machines pool.

5.240.3. remove DELETE

Removes a virtual machine pool.

DELETE /ovirt-engine/api/vmpools/123
Table 773. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.240.4. update PUT

Update the virtual machine pool.

PUT /ovirt-engine/api/vmpools/123

The name, description, size, prestarted_vms and max_user_vms attributes can be updated after the virtual machine pool has been created.

<vmpool>
  <name>VM_Pool_B</name>
  <description>Virtual Machine Pool B</description>
  <size>3</size>
  <prestarted_vms>1</size>
  <max_user_vms>2</size>
</vmpool>
Table 774. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

pool

VmPool

In/Out

The virtual machine pool that is being updated.

5.241. VmPools

Provides read-write access to virtual machines pools.

Table 775. Methods summary
Name Summary

add

Creates a new virtual machine pool.

list

Get a list of available virtual machines pools.

5.241.1. add POST

Creates a new virtual machine pool.

A new pool requires the name, cluster and template attributes. Identify the cluster and template with the id or name nested attributes:

POST /ovirt-engine/api/vmpools

With the following body:

<vmpool>
  <name>mypool</name>
  <cluster id="123"/>
  <template id="456"/>
</vmpool>
Table 776. Parameters summary
Name Type Direction Summary

pool

VmPool

In/Out

Pool to add.

5.241.2. list GET

Get a list of available virtual machines pools.

GET /ovirt-engine/api/vmpools

You will receive the following response:

<vm_pools>
  <vm_pool id="123">
    ...
  </vm_pool>
  ...
</vm_pools>
Table 777. 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.

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 pools to return.

pools

VmPool[]

Out

Retrieved pools.

search

String

In

A query string used to restrict the returned pools.
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 pools to return. If this value is not specified, all of the pools are returned.

5.242. VmReportedDevice

Table 778. Methods summary
Name Summary

get

5.242.1. get GET

Table 779. Parameters summary
Name Type Direction Summary

reported_device

ReportedDevice

Out

5.243. VmReportedDevices

Table 780. Methods summary
Name Summary

list

5.243.1. list GET

Table 781. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of devices to return.

reported_device

ReportedDevice[]

Out
max

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

5.244. VmSession

Table 782. Methods summary
Name Summary

get

5.244.1. get GET

Table 783. Parameters summary
Name Type Direction Summary

session

Session

Out

5.245. VmSessions

Provides information about virtual machine user sessions.

Table 784. Methods summary
Name Summary

list

Lists all user sessions for this virtual machine.

5.245.1. list GET

Lists all user sessions for this virtual machine.

For example, to retrieve the session information for virtual machine 123 send a request like this:

GET /ovirt-engine/api/vms/123/sessions

The response body will contain something like this:

<sessions>
  <session href="/ovirt-engine/api/vms/123/sessions/456" id="456">
    <console_user>true</console_user>
    <ip>
      <address>192.168.122.1</address>
    </ip>
    <user href="/ovirt-engine/api/users/789" id="789"/>
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
  </session>
  ...
</sessions>
Table 785. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of sessions to return.

sessions

Session[]

Out
max

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

5.246. VmWatchdog

A service managing a watchdog on virtual machines.

Table 786. Methods summary
Name Summary

get

Returns the information about the watchdog.

remove

Removes the watchdog from the virtual machine.

update

Updates the information about the watchdog.

5.246.1. get GET

Returns the information about the watchdog.

Table 787. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

Out

The information about the watchdog.
watchdog

The information about the watchdog.

The information consists of model element, action element and the reference to the virtual machine. It may look like this:

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

5.246.2. remove DELETE

Removes the watchdog from the virtual machine.

For example, to remove a watchdog from a virtual machine, send a request like this:

DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000
Table 788. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.246.3. update PUT

Updates the information about the watchdog.

You can update the information using action and model elements.

For example, to update a watchdog, send a request like this:

PUT /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>reset</action>
</watchdog>

with response body:

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>reset</action>
  <model>i6300esb</model>
</watchdog>
Table 789. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

watchdog

Watchdog

In/Out

The information about the watchdog.
watchdog

The information about the watchdog.

The request data must contain at least one of model and action elements. The response data contains complete information about the updated watchdog.

5.247. VmWatchdogs

Lists the watchdogs of a virtual machine.

Table 790. Methods summary
Name Summary

add

Adds new watchdog to the virtual machine.

list

The list of watchdogs of the virtual machine.

5.247.1. add POST

Adds new watchdog to the virtual machine.

For example, to add a watchdog to a virtual machine, send a request like this:

POST /ovirt-engine/api/vms/123/watchdogs
<watchdog>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>

with response body:

<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <action>poweroff</action>
  <model>i6300esb</model>
</watchdog>
Table 791. Parameters summary
Name Type Direction Summary

watchdog

Watchdog

In/Out

The information about the watchdog.
watchdog

The information about the watchdog.

The request data must contain model element (such as i6300esb) and action element (one of none, reset, poweroff, dump, pause). The response data additionally contains references to the added watchdog and to the virtual machine.

5.247.2. list GET

The list of watchdogs of the virtual machine.

Table 792. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of watchdogs to return.

watchdogs

Watchdog[]

Out

The information about the watchdog.
max

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

watchdogs

The information about the watchdog.

The information consists of model element, action element and the reference to the virtual machine. It may look like this:

<watchdogs>
  <watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
    <vm href="/ovirt-engine/api/vms/123" id="123"/>
    <action>poweroff</action>
    <model>i6300esb</model>
  </watchdog>
</watchdogs>

5.248. Vms

Table 793. Methods summary
Name Summary

add

Creates a new virtual machine.

list

5.248.1. add POST

Creates a new virtual machine.

The virtual machine can be created in different ways:

  • From a template. In this case the identifier or name of the template must be provided. For example, using a plain shell script and XML:

#!/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 '
<vm>
  <name>myvm</name>
  <template>
    <name>Blank</name>
  </template>
  <cluster>
    <name>mycluster</name>
  </cluster>
</vm>
' \
"${url}/vms"

  • From a snapshot. In this case the identifier of the snapshot has to be provided. For example, using a plain shel script and XML:

#!/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 "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<vm>
  <name>myvm</name>
  <snapshots>
    <snapshot id="266742a5-6a65-483c-816d-d2ce49746680"/>
  </snapshots>
  <cluster>
    <name>mycluster</name>
  </cluster>
</vm>
' \
"${url}/vms"

When creating a virtual machine from a template or from a snapshot it is usually useful to explicitly indicate in what storage domain to create the disks for the virtual machine. If the virtual machine is created from a template then this is achieved passing a set of disk_attachment elements that indicate the mapping:

<vm>
  ...
  <disk_attachments>
    <disk_attachment>
      <disk id="8d4bd566-6c86-4592-a4a7-912dbf93c298">
        <storage_domains>
          <storage_domain id="9cb6cb0a-cf1d-41c2-92ca-5a6d665649c9"/>
        </storage_domains>
      </disk>
    <disk_attachment>
  </disk_attachments>
</vm>

When the virtual machine is created from a snapshot this set of disks is slightly different, it uses the image_id attribute instead of id.

<vm>
  ...
  <disk_attachments>
    <disk_attachment>
      <disk>
        <image_id>8d4bd566-6c86-4592-a4a7-912dbf93c298</image_id>
        <storage_domains>
          <storage_domain id="9cb6cb0a-cf1d-41c2-92ca-5a6d665649c9"/>
        </storage_domains>
      </disk>
    <disk_attachment>
  </disk_attachments>
</vm>

It is possible to specify additional virtual machine parameters in the XML description, e.g. a virtual machine of desktop type, with 2 GiB of RAM and additional description can be added sending a request body like the following:

<vm>
  <name>myvm</name>
  <description>My Desktop Virtual Machine</description>
  <type>desktop</type>
  <memory>2147483648</memory>
  ...
</vm>

A bootable CDROM device can be set like this:

<vm>
  ...
  <os>
    <boot dev="cdrom"/>
  </os>
</vm>

In order to boot from CDROM, you first need to insert a disk, as described in the CDROM service. Then booting from that CDROM can be specified using the os.boot.devices attribute:

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

In all cases the name or identifier of the cluster where the virtual machine will be created is mandatory.

Table 794. Parameters summary
Name Type Direction Summary

clone

Boolean

In

Specifies if the virtual machine should be independent of the template.

clone_permissions

Boolean

In

Specifies if the permissions of the template should be copied to the virtual machine.

vm

Vm

In/Out
clone

Specifies if the virtual machine should be independent of the template.

When a virtual machine is created from a template by default the disks of the virtual machine depend on the disks of the template, they are using the copy on write mechanism so that only the differences from the template take up real storage space. If this parameter is specified and the value is true then the disks of the created virtual machine will be cloned, and independent of the template. For example, to create an independent virtual machine, send a request like this:

POST /ovirt-engine/vms?clone=true

With a request body like this:

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
</vm>
When this parameter is true the permissions of the template will also be copied, as when using clone_permissions=true.
clone_permissions

Specifies if the permissions of the template should be copied to the virtual machine.

If this optional parameter is provided, and its values is true then the permissions of the template (only the direct ones, not the inherited ones) will be copied to the created virtual machine. For example, to create a virtual machine from the mytemplate template copying its permissions, send a request like this:

POST /ovirt-engine/api/vms?clone_permissions=true

With a request body like this:

<vm>
  <name>myvm<name>
  <template>
    <name>mytemplate<name>
  </template>
  <cluster>
    <name>mycluster<name>
  </cluster>
</vm>

5.248.2. list GET

Table 795. Parameters summary
Name Type Direction Summary

all_content

Boolean

In

Indicates if all the attributes of the virtual machines 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.

max

Integer

In

The maximum number of results to return.

search

String

In

A query string used to restrict the returned virtual machines.

vms

Vm[]

Out
all_content

Indicates if all the attributes of the virtual machines should be included in the response.

By default the following attributes are excluded:

  • console

  • initialization.configuration.data - The OVF document describing the virtual machine.

  • rng_source

  • soundcard

  • virtio_scsi

For example, to retrieve the complete representation of the virtual machines send a request like this:

GET /ovirt-engine/api/vms?all_content=true
The reason for not including these attributes is performance: they are seldom used and they require additional queries to the database. So try to use the this parameter only when it is really needed.
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.

5.249. VnicProfile

This service manages a vNIC profile.

Table 796. Methods summary
Name Summary

get

Retrieves details about a vNIC profile.

remove

Removes the vNIC profile.

update

Updates details of a vNIC profile.

5.249.1. get GET

Retrieves details about a vNIC profile.

Table 797. Parameters summary
Name Type Direction Summary

profile

VnicProfile

Out

5.249.2. remove DELETE

Removes the vNIC profile.

Table 798. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.249.3. update PUT

Updates details of a vNIC profile.

Table 799. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the update should be performed asynchronously.

profile

VnicProfile

In/Out

The vNIC profile that is being updated.

5.250. VnicProfiles

This service manages the collection of all vNIC profiles.

Table 800. Methods summary
Name Summary

add

Add a vNIC profile.

list

List all vNIC profiles.

5.250.1. add POST

Add a vNIC profile.

For example to add vNIC profile 123 to network 456 send a request to:

POST /ovirt-engine/api/networks/456/vnicprofiles

With the following body:

<vnic_profile id="123">
  <name>new_vNIC_name</name>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
</vnic_profile>

Please note that there is a default network filter to each VNIC profile. For more details of how the default network filter is calculated please refer to the documentation in NetworkFilters.

The output of creating a new VNIC profile depends in the body arguments that were given. In case no network filter was given, the default network filter will be configured. For example:

<vnic_profile href="/ovirt-engine/api/vnicprofiles/123" id="123">
  <name>new_vNIC_name</name>
  <link href="/ovirt-engine/api/vnicprofiles/123/permissions" rel="permissions"/>
  <pass_through>
    <mode>disabled</mode>
  </pass_through>
  <port_mirroring>false</port_mirroring>
  <network href="/ovirt-engine/api/networks/456" id="456"/>
  <network_filter href="/ovirt-engine/api/networkfilters/789" id="789"/>
</vnic_profile>

In case an empty network filter was given, no network filter will be configured for the specific VNIC profile regardless of the VNIC profile’s default network filter. For example:

<vnic_profile>
  <name>no_network_filter</name>
  <network_filter/>
</vnic_profile>

In case that a specific valid network filter id was given, the VNIC profile will be configured with the given network filter regardless of the VNIC profiles’s default network filter. For example:

<vnic_profile>
  <name>user_choice_network_filter</name>
  <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
</vnic_profile>
Table 801. Parameters summary
Name Type Direction Summary

profile

VnicProfile

In/Out

The vNIC profile that is being added.

5.250.2. list GET

List all vNIC profiles.

Table 802. Parameters summary
Name Type Direction Summary

max

Integer

In

Sets the maximum number of profiles to return.

profiles

VnicProfile[]

Out

The list of all vNIC profiles.
max

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

5.251. Weight

Table 803. Methods summary
Name Summary

get

remove

5.251.1. get GET

Table 804. Parameters summary
Name Type Direction Summary

filter

Boolean

In

Indicates if the results should be filtered according to the permissions of the user.

weight

Weight

Out

5.251.2. remove DELETE

Table 805. Parameters summary
Name Type Direction Summary

async

Boolean

In

Indicates if the remove should be performed asynchronously.

5.252. Weights

Table 806. Methods summary
Name Summary

add

list

5.252.1. add POST

Table 807. Parameters summary
Name Type Direction Summary

weight

Weight

In/Out

5.252.2. list GET

Table 808. Parameters summary
Name Type Direction Summary

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 weights to return.

weights

Weight[]

Out
max

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

6. Types

This section enumerates all the data types that are available in the API.

6.1. AccessProtocol enum

Table 809. Values summary
Name Summary

cifs

gluster

nfs

6.2. Action struct

Table 810. Attributes summary
Name Type Summary

allow_partial_import

Boolean

async

Boolean

bricks

GlusterBrick[]

certificates

Certificate[]

check_connectivity

Boolean

clone

Boolean

cluster

Cluster

collapse_snapshots

Boolean

comment

String

Free text containing comments about this object.

connectivity_timeout

Integer

data_center

DataCenter

deploy_hosted_engine

Boolean

description

String

A human-readable description in plain text.

details

GlusterVolumeProfileDetails

discard_snapshots

Boolean

disk

Disk

disks

Disk[]

exclusive

Boolean

fault

Fault

fence_type

String

filter

Boolean

fix_layout

Boolean

force

Boolean

grace_period

GracePeriod

host

Host

id

String

A unique identifier.

image

String

import_as_template

Boolean

is_attached

Boolean

iscsi

IscsiDetails

iscsi_targets

String[]

job

Job

logical_units

LogicalUnit[]

maintenance_enabled

Boolean

modified_bonds

HostNic[]

modified_labels

NetworkLabel[]

modified_network_attachments

NetworkAttachment[]

name

String

A human-readable name in plain text.

option

Option

pause

Boolean

power_management

PowerManagement

proxy_ticket

ProxyTicket

reason

String

reassign_bad_macs

Boolean

remote_viewer_connection_file

String

removed_bonds

HostNic[]

removed_labels

NetworkLabel[]

removed_network_attachments

NetworkAttachment[]

resolution_type

String

restore_memory

Boolean

root_password

String

snapshot

Snapshot

ssh

Ssh

status

String

stop_gluster_service

Boolean

storage_domain

StorageDomain

storage_domains

StorageDomain[]

succeeded

Boolean

synchronized_network_attachments

NetworkAttachment[]

template

Template

ticket

Ticket

undeploy_hosted_engine

Boolean

use_cloud_init

Boolean

use_sysprep

Boolean

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

vm

Vm

vnic_profile_mappings

VnicProfileMapping[]

6.3. AffinityGroup struct

An affinity group represents a group of virtual machines with a defined relationship.

Table 811. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

enforcing

Boolean

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.

hosts_rule

AffinityRule

Specifies the affinity rule applied between virtual machines and hosts that are members of this affinity group.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

positive

Boolean

Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.

vms_rule

AffinityRule

Specifies the affinity rule applied to virtual machines that are members of this affinity group.

6.3.1. enforcing

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.

Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.

6.3.2. positive

Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.

Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.
Table 812. Links summary
Name Type Summary

cluster

Cluster

A reference to the cluster to which the affinity group applies.

hosts

Host[]

A list of all hosts assigned to this affinity group.

vms

Vm[]

A list of all virtual machines assigned to this affinity group.

6.4. AffinityLabel struct

The affinity label can influence virtual machine scheduling. It is most frequently used to create a sub-cluster from the available hosts.

Table 813. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

read_only

Boolean

The read_only property marks a label that can not be modified.

6.4.1. read_only

The read_only property marks a label that can not be modified. This is usually the case when listing internally-generated labels.

Table 814. Links summary
Name Type Summary

hosts

Host[]

A list of hosts that were labeled using this scheduling label.

vms

Vm[]

A list of virtual machines that were labeled using this scheduling label.

6.5. AffinityRule struct

Generic rule definition for affinity group. Each supported resource type (virtual machine, host) is controlled by a separate rule. This allows expressing of rules like: no affinity between defined virtual machines, but hard affinity between defined virtual machines and virtual hosts.

Table 815. Attributes summary
Name Type Summary

enabled

Boolean

Specifies whether the affinity group uses this rule or not.

enforcing

Boolean

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule.

positive

Boolean

Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule.

6.5.1. enabled

Specifies whether the affinity group uses this rule or not. This attribute is optional during creation and is considered to be true when it is not provided. In case this attribute is not provided to the update operation, it is considered to be true if AffinityGroup positive attribute is set as well. The backend enabled value will be preserved when both enabled and positive attributes are missing.

6.5.2. enforcing

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.

6.5.3. positive

Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.

6.6. Agent struct

Type representing a fence agent.

Table 816. Attributes summary
Name Type Summary

address

String

Fence agent address.

comment

String

Free text containing comments about this object.

concurrent

Boolean

Specifies whether the agent should be used concurrently or sequentially.

description

String

A human-readable description in plain text.

encrypt_options

Boolean

Specifies whether the options should be encrypted.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

options

Option[]

Fence agent options (comma-delimited list of key-value pairs).

order

Integer

The order of this agent if used with other agents.

password

String

Fence agent password.

port

Integer

Fence agent port.

type

String

Fence agent type.

username

String

Fence agent user name.
Table 817. Links summary
Name Type Summary

host

Host

Reference to the host service.

6.6.1. host

Reference to the host service. Each fence agent belongs to a single host.

6.7. AgentConfiguration struct

Table 818. Attributes summary
Name Type Summary

address

String

broker_type

MessageBrokerType

network_mappings

String

password

String

port

Integer

username

String

6.8. Api struct

This type contains the information returned by the root service of the API.

To get that information send a request like this:

GET /ovirt-engine/api

The result will be like this:

<api>
  <link rel="hosts" href="/ovirt-engine/api/hosts"/>
  <link rel="vms" href="/ovirt-engine/api/vms"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.1.0_master</full_version>
      <major>4</major>
      <minor>1</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <link rel="templates/blank" href="..."/>
    <link rel="tags/root" href="..."/>
  </special_objects>
  <summary>
    <vms>
      <total>10</total>
      <active>3</active>
    </vms>
    <hosts>
      <total>2</total>
      <active>2</active>
    </hosts>
    <users>
      <total>8</total>
      <active>2</active>
    </users>
    <storage_domains>
      <total>2</total>
      <active>2</active>
    </storage_domains>
  </summary>
  <time>2016-12-12T12:22:25.866+01:00</time>
</api>
Table 819. Attributes summary
Name Type Summary

product_info

ProductInfo

Information about the product, such as its name, the name of the vendor, and the version.

special_objects

SpecialObjects

References to special objects, such as the blank template and the root of the hierarchy of tags.

summary

ApiSummary

A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.

time

Date

The date and time when this information was generated.

6.9. ApiSummary struct

A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.

Table 820. Attributes summary
Name Type Summary

hosts

ApiSummaryItem

The summary of hosts.

storage_domains

ApiSummaryItem

The summary of storage domains.

users

ApiSummaryItem

The summary of users.

vms

ApiSummaryItem

The summary of virtual machines.

6.10. ApiSummaryItem struct

This type contains an item of the API summary. Each item contains the total and active number of some kind of object.

Table 821. Attributes summary
Name Type Summary

active

Integer

The total number of active objects.

total

Integer

The total number of objects.

6.11. Application struct

Table 822. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 823. Links summary
Name Type Summary

vm

Vm

6.12. Architecture enum

Table 824. Values summary
Name Summary

ppc64

undefined

x86_64

6.13. AuthorizedKey struct

Table 825. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

key

String

name

String

A human-readable name in plain text.
Table 826. Links summary
Name Type Summary

user

User

6.14. AutoNumaStatus enum

Table 827. Values summary
Name Summary

disable

enable

unknown

6.15. Balance struct

Table 828. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 829. Links summary
Name Type Summary

scheduling_policy

SchedulingPolicy

scheduling_policy_unit

SchedulingPolicyUnit

6.16. Bios struct

Table 830. Attributes summary
Name Type Summary

boot_menu

BootMenu

6.17. BlockStatistic struct

Table 831. Attributes summary
Name Type Summary

statistics

Statistic[]

6.18. Bonding struct

Represents a network interfaces bond.

Table 832. Attributes summary
Name Type Summary

ad_partner_mac

Mac

The ad_partner_mac property of the partner bond in mode 4.

options

Option[]

A list of option elements for a bonded interface.

slaves

HostNic[]

A list of slave NICs for a bonded interface.

6.18.1. ad_partner_mac

The ad_partner_mac property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, which is also called dynamic link aggregation. See Wikipedia and Presentation for more information. ad_partner_mac is the MAC address of the system (switch) at the other end of a bond. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/ad_partner_mac file on the system where the bond is located.

6.18.2. options

A list of option elements for a bonded interface. Each option contains property name and value attributes. Only required when adding bonded interfaces.

6.18.3. slaves

A list of slave NICs for a bonded interface. Only required when adding bonded interfaces.

Table 833. Links summary
Name Type Summary

active_slave

HostNic

The active_slave property of the bond in modes that support it (active-backup, balance-alb and balance-tlb).

6.18.4. active_slave

The active_slave property of the bond in modes that support it (active-backup, balance-alb and balance-tlb). See Linux documentation for further details. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/active_slave file on the system where the bond is located.

For example:

GET /ovirt-engine/api/hosts/123/nics/321

Will respond:

<host_nic href="/ovirt-engine/api/hosts/123/nics/321" id="321">
  ...
  <bonding>
    <slaves>
      <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
      ...
    </slaves>
    <active_slave href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
  </bonding>
  ...
</host_nic>

6.19. Bookmark struct

Table 834. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

value

String

6.20. Boot struct

Table 835. Attributes summary
Name Type Summary

devices

BootDevice[]

6.21. BootDevice enum

Table 836. Values summary
Name Summary

cdrom

hd

network

6.22. BootMenu struct

Table 837. Attributes summary
Name Type Summary

enabled

Boolean

6.23. BootProtocol enum

Defines the options of the IP address assignment method to a NIC.

Table 838. Values summary
Name Summary

autoconf

Stateless address auto-configuration.

dhcp

Dynamic host configuration protocol.

none

No address configuration.

static

Statically-defined address, mask and gateway.

6.23.1. autoconf

Stateless address auto-configuration.

The mechanism is defined by RFC 4862. Please refer to this wikipedia article for more information.

The value is valid for IPv6 addresses only.

6.23.2. dhcp

Dynamic host configuration protocol.

Please refer to this wikipedia article for more information.

6.24. BrickProfileDetail struct

Table 839. Attributes summary
Name Type Summary

profile_details

ProfileDetail[]
Table 840. Links summary
Name Type Summary

brick

GlusterBrick

6.25. Cdrom struct

Table 841. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

file

File

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 842. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.25.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.26. Certificate struct

Table 843. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

content

String

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

organization

String

subject

String

6.27. CloudInit struct

Table 844. Attributes summary
Name Type Summary

authorized_keys

AuthorizedKey[]

files

File[]

host

Host

network_configuration

NetworkConfiguration

regenerate_ssh_keys

Boolean

timezone

String

users

User[]

6.28. Cluster struct

Type representation of a cluster.

A JSON representation of a cluster

{
  "cluster" : [ {
    "ballooning_enabled" : "false",
    "cpu" : {
      "architecture" : "x86_64",
      "type" : "Intel SandyBridge Family"
    },
    "custom_scheduling_policy_properties" : {
      "property" : [ {
        "name" : "HighUtilization",
        "value" : "80"
      }, {
        "name" : "CpuOverCommitDurationMinutes",
        "value" : "2"
      } ]
    },
    "error_handling" : {
      "on_error" : "migrate"
    },
    "fencing_policy" : {
      "enabled" : "true",
      "skip_if_connectivity_broken" : {
        "enabled" : "false",
        "threshold" : "50"
      },
      "skip_if_gluster_bricks_up" : "false",
      "skip_if_gluster_quorum_not_met" : "false",
      "skip_if_sd_active" : {
        "enabled" : "false"
      }
    },
    "gluster_service" : "false",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "maintenance_reason_required" : "false",
    "memory_policy" : {
      "over_commit" : {
        "percent" : "100"
      },
      "transparent_hugepages" : {
        "enabled" : "true"
      }
    },
    "migration" : {
      "auto_converge" : "inherit",
      "bandwidth" : {
        "assignment_method" : "auto"
      },
      "compressed" : "inherit",
      "policy" : {
        "id" : "00000000-0000-0000-0000-000000000000"
      }
    },
    "optional_reason" : "false",
    "required_rng_sources" : {
      "required_rng_source" : [ "random" ]
    },
    "switch_type" : "legacy",
    "threads_as_cores" : "false",
    "trusted_service" : "false",
    "tunnel_migration" : "false",
    "version" : {
      "major" : "4",
      "minor" : "1"
    },
    "virt_service" : "true",
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "mac_pool" : {
      "href" : "/ovirt-engine/api/macpools/456",
      "id" : "456"
    },
    "scheduling_policy" : {
      "href" : "/ovirt-engine/api/schedulingpolicies/789",
      "id" : "789"
    },
    "actions" : {
      "link" : [ {
        "href" : "/ovirt-engine/api/clusters/234/resetemulatedmachine",
        "rel" : "resetemulatedmachine"
      } ]
    },
    "name" : "Default",
    "description" : "The default server cluster",
    "href" : "/ovirt-engine/api/clusters/234",
    "id" : "234",
    "link" : [ {
      "href" : "/ovirt-engine/api/clusters/234/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/cpuprofiles",
      "rel" : "cpuprofiles"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networkfilters",
      "rel" : "networkfilters"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/networks",
      "rel" : "networks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/affinitygroups",
      "rel" : "affinitygroups"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glusterhooks",
      "rel" : "glusterhooks"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/glustervolumes",
      "rel" : "glustervolumes"
    } ]
  } ]
}
Table 845. Attributes summary
Name Type Summary

ballooning_enabled

Boolean

comment

String

Free text containing comments about this object.

cpu

Cpu

custom_scheduling_policy_properties

Property[]

Custom scheduling policy properties of the cluster.

description

String

A human-readable description in plain text.

display

Display

error_handling

ErrorHandling

fencing_policy

FencingPolicy

Custom fencing policy can be defined for a cluster.

gluster_service

Boolean

gluster_tuned_profile

String

The name of the https://fedorahosted.

ha_reservation

Boolean

id

String

A unique identifier.

ksm

Ksm

maintenance_reason_required

Boolean

memory_policy

MemoryPolicy

migration

MigrationOptions

name

String

A human-readable name in plain text.

optional_reason

Boolean

required_rng_sources

RngSource[]

Set of random number generator (RNG) sources required from each host in the cluster.

serial_number

SerialNumber

supported_versions

Version[]

switch_type

SwitchType

Type of switch to be used by all networks in given cluster.

threads_as_cores

Boolean

trusted_service

Boolean

tunnel_migration

Boolean

version

Version

The compatibility version of the cluster.

virt_service

Boolean

6.28.1. custom_scheduling_policy_properties

Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the scheduling_policy link, and apply only for this specific cluster.

For example, to update the custom properties of the cluster, send a request:

PUT /ovirt-engine/api/clusters/123

With a request body:

<cluster>
  <custom_scheduling_policy_properties>
    <property>
      <name>HighUtilization</name>
      <value>70</value>
    </property>
  </custom_scheduling_policy_properties>
</cluster>

Update operations using the custom_scheduling_policy_properties attribute will not update the the properties of the scheduling policy specified by the scheduling_policy link, they will only be reflected on this specific cluster.

6.28.2. fencing_policy

Custom fencing policy can be defined for a cluster.

Here is an example:

PUT /ovirt-engine/api/cluster/123

With request body:

<cluster>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
  </fencing_policy>
</cluster>

6.28.3. gluster_tuned_profile

The name of the tuned profile to set on all the hosts in the cluster. This is not mandatory and relevant only for clusters with gluster service.

6.28.4. required_rng_sources

Set of random number generator (RNG) sources required from each host in the cluster.

When read, it returns the implicit urandom (for cluster version 4.1 and higher) or random (for cluster version 4.0 and lower) plus additional selected RNG sources. When written, the implicit urandom and random RNG sources cannot be removed.

Before version 4.1 of the engine, the set of required random number generators was completely controllable by the administrator; any source could be added or removed, including the random source. But starting with version 4.1, the urandom and random sources will always be part of the set, and can’t be removed.

Engine version 4.1 introduces a new RNG source urandom that replaces random RNG source in clusters with compatibility version 4.1 or higher.

6.28.5. version

The compatibility version of the cluster.

All hosts in this cluster must support at least this compatibility version.

For example:

GET /ovirt-engine/api/clusters/123

Will respond:

<cluster>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</cluster>

To update the compatibility version, use:

PUT /ovirt-engine/api/clusters/123

With a request body:

<cluster>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</cluster>

In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version.

Table 846. Links summary
Name Type Summary

affinity_groups

AffinityGroup[]

cpu_profiles

CpuProfile[]

data_center

DataCenter

gluster_hooks

GlusterHook[]

gluster_volumes

GlusterVolume[]

mac_pool

MacPool

A reference to the MAC pool used by this cluster.

management_network

Network

network_filters

NetworkFilter[]

networks

Network[]

permissions

Permission[]

scheduling_policy

SchedulingPolicy

Reference to the default scheduling policy used by this cluster.

6.28.6. scheduling_policy

Reference to the default scheduling policy used by this cluster.

The scheduling policy properties are taken by default from the referenced scheduling policy, but they are overridden by the properties specified in the custom_scheduling_policy_properties attribute for this cluster.

6.29. ClusterLevel struct

Describes the capabilities supported by a specific cluster level.

Table 847. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

cpu_types

CpuType[]

The CPU types supported by this cluster level.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

permits

Permit[]

The permits supported by this cluster level.

6.30. Configuration struct

Table 848. Attributes summary
Name Type Summary

data

String

The document describing the virtual machine.

type

ConfigurationType

6.30.1. data

The document describing the virtual machine.

Example of the OVF document:

<?xml version='1.0' encoding='UTF-8'?>
<ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/"
  xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
  xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  ovf:version="3.5.0.0">
  <References/>
  <Section xsi:type="ovf:NetworkSection_Type">
    <Info>List of networks</Info>
    <Network ovf:name="Network 1"/>
  </Section>
  <Section xsi:type="ovf:DiskSection_Type">
    <Info>List of Virtual Disks</Info>
  </Section>
  <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type">
    <CreationDate>2014/12/03 04:25:45</CreationDate>
    <ExportDate>2015/02/09 14:12:24</ExportDate>
    <DeleteProtected>false</DeleteProtected>
    <SsoMethod>guest_agent</SsoMethod>
    <IsSmartcardEnabled>false</IsSmartcardEnabled>
    <TimeZone>Etc/GMT</TimeZone>
    <default_boot_sequence>0</default_boot_sequence>
    <Generation>1</Generation>
    <VmType>1</VmType>
    <MinAllocatedMem>1024</MinAllocatedMem>
    <IsStateless>false</IsStateless>
    <IsRunAndPause>false</IsRunAndPause>
    <AutoStartup>false</AutoStartup>
    <Priority>1</Priority>
    <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId>
    <IsBootMenuEnabled>false</IsBootMenuEnabled>
    <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
    <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
    <Name>VM_export</Name>
    <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
    <TemplateName>Blank</TemplateName>
    <IsInitilized>false</IsInitilized>
    <Origin>3</Origin>
    <DefaultDisplayType>1</DefaultDisplayType>
    <TrustedService>false</TrustedService>
    <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId>
    <OriginalTemplateName>Blank</OriginalTemplateName>
    <UseLatestVersion>false</UseLatestVersion>
    <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
      ovf:required="false"
      xsi:type="ovf:OperatingSystemSection_Type">
      <Info>Guest Operating System</Info>
      <Description>other</Description>
    </Section>
    <Section xsi:type="ovf:VirtualHardwareSection_Type">
      <Info>1 CPU, 1024 Memory</Info>
      <System>
        <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType>
      </System>
      <Item>
        <rasd:Caption>1 virtual cpu</rasd:Caption>
        <rasd:Description>Number of virtual CPU</rasd:Description>
        <rasd:InstanceId>1</rasd:InstanceId>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:num_of_sockets>1</rasd:num_of_sockets>
        <rasd:cpu_per_socket>1</rasd:cpu_per_socket>
      </Item>
      <Item>
        <rasd:Caption>1024 MB of memory</rasd:Caption>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:InstanceId>2</rasd:InstanceId>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
        <rasd:VirtualQuantity>1024</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Caption>USB Controller</rasd:Caption>
        <rasd:InstanceId>3</rasd:InstanceId>
        <rasd:ResourceType>23</rasd:ResourceType>
        <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
      </Item>
    </Section>
  </Content>
</ovf:Envelope>

6.31. ConfigurationType enum

Table 849. Values summary
Name Summary

ovf

6.32. Console struct

Table 850. Attributes summary
Name Type Summary

enabled

Boolean

6.33. Core struct

Table 851. Attributes summary
Name Type Summary

index

Integer

socket

Integer

6.34. Cpu struct

Table 852. Attributes summary
Name Type Summary

architecture

Architecture

cores

Core[]

cpu_tune

CpuTune

level

Integer

mode

CpuMode

name

String

speed

Decimal

topology

CpuTopology

type

String

6.35. CpuMode enum

Table 853. Values summary
Name Summary

custom

host_model

host_passthrough

6.36. CpuProfile struct

Table 854. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 855. Links summary
Name Type Summary

cluster

Cluster

permissions

Permission[]

qos

Qos

6.37. CpuTopology struct

Table 856. Attributes summary
Name Type Summary

cores

Integer

sockets

Integer

threads

Integer

6.38. CpuTune struct

Table 857. Attributes summary
Name Type Summary

vcpu_pins

VcpuPin[]

6.39. CpuType struct

Describes a supported CPU type.

Table 858. Attributes summary
Name Type Summary

architecture

Architecture

The architecture of the CPU.

level

Integer

The level of the CPU type.

name

String

The name of the CPU type, for example Intel Conroe Family.

6.40. CreationStatus enum

Table 859. Values summary
Name Summary

complete

failed

in_progress

pending

6.41. CustomProperty struct

Table 860. Attributes summary
Name Type Summary

name

String

regexp

String

value

String

6.42. DataCenter struct

Table 861. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

local

Boolean

name

String

A human-readable name in plain text.

quota_mode

QuotaModeType

status

DataCenterStatus

storage_format

StorageFormat

supported_versions

Version[]

version

Version

The compatibility version of the data center.

6.42.1. version

The compatibility version of the data center.

All clusters in this data center must already be set to at least this compatibility version.

For example:

GET /ovirt-engine/api/datacenters/123

Will respond:

<data_center>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</data_center>

To update the compatibility version, use:

PUT /ovirt-engine/api/datacenters/123

With a request body:

<data_center>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</data_center>
Table 862. Links summary
Name Type Summary

clusters

Cluster[]

Reference to clusters inside this data center.

iscsi_bonds

IscsiBond[]

Reference to ISCSI bonds used by this data center.

mac_pool

MacPool

Reference to the MAC pool used by this data center.

networks

Network[]

Reference to networks attached to this data center.

permissions

Permission[]

Reference to permissions assigned to this data center.

qoss

Qos[]

Reference to quality of service used by this data center.

quotas

Quota[]

Reference to quotas assigned to this data center.

storage_domains

StorageDomain[]

Reference to storage domains attached to this data center.

6.43. DataCenterStatus enum

Table 863. Values summary
Name Summary

contend

maintenance

not_operational

problematic

uninitialized

up

6.44. Device struct

A device wraps links to potential parents of a device.

Table 864. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 865. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.44.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.45. Disk struct

Represents a virtual disk device.

Table 866. Attributes summary
Name Type Summary

active

Boolean

Indicates if the disk is visible to the virtual machine.

actual_size

Integer

The actual size of the disk, in bytes.

alias

String

bootable

Boolean

Indicates if the disk is marked as bootable.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

format

DiskFormat

The underlying storage format.

id

String

A unique identifier.

image_id

String

initial_size

Integer

The initial size of a sparse image disk created on block storage, in bytes.

interface

DiskInterface

The type of interface driver used to connect the disk device to the virtual machine.

logical_name

String

lun_storage

HostStorage

name

String

A human-readable name in plain text.

propagate_errors

Boolean

Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.

provisioned_size

Integer

The virtual size of the disk, in bytes.

qcow_version

QcowVersion

The underlying QCOW version of a QCOW volume.

read_only

Boolean

Indicates if the disk is in read-only mode.

sgio

ScsiGenericIO

shareable

Boolean

Indicates if the disk can be attached to multiple virtual machines.

sparse

Boolean

Indicates if the physical storage for the disk should not be preallocated.

status

DiskStatus

The status of the disk device.

storage_type

DiskStorageType

uses_scsi_reservation

Boolean

wipe_after_delete

Boolean

Indicates if the disk’s blocks will be read back as zeros after it is deleted:

- On block storage, the disk will be zeroed and only then deleted.

6.45.1. active

Indicates if the disk is visible to the virtual machine.

When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then 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 this attribute with the desired value.

6.45.2. actual_size

The actual size of the disk, in bytes.

The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.

6.45.3. bootable

Indicates if the disk is marked as bootable.

This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.

6.45.4. initial_size

The initial size of a sparse image disk created on block storage, in bytes.

The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.

6.45.5. interface

The type of interface driver used to connect the disk device to the virtual machine.

This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.

6.45.6. provisioned_size

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

6.45.7. qcow_version

The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 volumes, while V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.

6.45.8. shareable

Indicates if the disk can be attached to multiple virtual machines.

When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like GlusterFS or GFS.

6.45.9. wipe_after_delete

Indicates if the disk’s blocks will be read back as zeros after it is deleted:

  • On block storage, the disk will be zeroed and only then deleted.

  • On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.

Table 867. Links summary
Name Type Summary

disk_profile

DiskProfile

instance_type

InstanceType

Optionally references to an instance type the device is used by.

openstack_volume_type

OpenStackVolumeType

permissions

Permission[]

quota

Quota

snapshot

Snapshot

statistics

Statistic[]

Statistics exposed by the disk.

storage_domain

StorageDomain

storage_domains

StorageDomain[]

The storage domains associated with this disk.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.45.10. statistics

Statistics exposed by the disk. For example:

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

These statistics aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:

GET /ovirt-engine/api/disks/123/statistics

6.45.11. storage_domains

The storage domains associated with this disk.

Only required when the first disk is being added to a virtual machine that was not itself created from a template.

6.45.12. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.46. DiskAttachment struct

Describes how a disk is attached to a virtual machine.

Table 868. Attributes summary
Name Type Summary

active

Boolean

Defines whether the disk is active in the virtual machine it’s attached to.

bootable

Boolean

Defines whether the disk is bootable.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

interface

DiskInterface

The type of interface driver used to connect the disk device to the virtual machine.

logical_name

String

The logical name of the virtual machine’s disk, as seen from inside the virtual machine.

name

String

A human-readable name in plain text.

pass_discard

Boolean

Defines whether the virtual machine passes discard commands to the storage.

uses_scsi_reservation

Boolean

Defines whether SCSI reservation is enabled for this disk.

6.46.1. active

Defines whether the disk is active in the virtual machine it’s attached to.

A disk attached to a virtual machine in an active status is connected to the virtual machine at run time and can be used.

6.46.2. logical_name

The logical name of the virtual machine’s disk, as seen from inside the virtual machine.

The logical name of a disk is reported only when the guest agent is installed and running inside the virtual machine.

For example, if the guest operating system is Linux and the disk is connected via a VirtIO interface, the logical name will be reported as /dev/vda:

<disk_attachment>
  ...
  <logical_name>/dev/vda</logical_name>
</disk_attachment>

If the guest operating system is Windows, the logical name will be reported as \\.\PHYSICALDRIVE0.

6.46.3. uses_scsi_reservation

Defines whether SCSI reservation is enabled for this disk.

Virtual machines with VIRTIO-SCSI passthrough enabled can set persistent SCSI reservations on disks. If they set persistent SCSI reservations, those virtual machines cannot be migrated to a different host because they would lose access to the disk, because SCSI reservations are specific to SCSI initiators, and therefore hosts. This scenario cannot be automatically detected. To avoid migrating these virtual machines, the user can set this attribute to true, to indicate the virtual machine is using SCSI reservations.

Table 869. Links summary
Name Type Summary

disk

Disk

The reference to the disk.

template

Template

The reference to the template.

vm

Vm

The reference to the virtual machine.

6.47. DiskFormat enum

The underlying storage format of disks.

Table 870. Values summary
Name Summary

cow

The Copy On Write format allows snapshots, with a small performance overhead.

raw

The raw format does not allow snapshots, but offers improved performance.

6.48. DiskInterface enum

Table 871. Values summary
Name Summary

ide

spapr_vscsi

virtio

virtio_scsi

6.49. DiskProfile struct

Table 872. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 873. Links summary
Name Type Summary

permissions

Permission[]

qos

Qos

storage_domain

StorageDomain

6.50. DiskSnapshot struct

Table 874. Attributes summary
Name Type Summary

active

Boolean

Indicates if the disk is visible to the virtual machine.

actual_size

Integer

The actual size of the disk, in bytes.

alias

String

bootable

Boolean

Indicates if the disk is marked as bootable.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

format

DiskFormat

The underlying storage format.

id

String

A unique identifier.

image_id

String

initial_size

Integer

The initial size of a sparse image disk created on block storage, in bytes.

interface

DiskInterface

The type of interface driver used to connect the disk device to the virtual machine.

logical_name

String

lun_storage

HostStorage

name

String

A human-readable name in plain text.

propagate_errors

Boolean

Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.

provisioned_size

Integer

The virtual size of the disk, in bytes.

qcow_version

QcowVersion

The underlying QCOW version of a QCOW volume.

read_only

Boolean

Indicates if the disk is in read-only mode.

sgio

ScsiGenericIO

shareable

Boolean

Indicates if the disk can be attached to multiple virtual machines.

sparse

Boolean

Indicates if the physical storage for the disk should not be preallocated.

status

DiskStatus

The status of the disk device.

storage_type

DiskStorageType

uses_scsi_reservation

Boolean

wipe_after_delete

Boolean

Indicates if the disk’s blocks will be read back as zeros after it is deleted:

- On block storage, the disk will be zeroed and only then deleted.

6.50.1. active

Indicates if the disk is visible to the virtual machine.

When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then 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 this attribute with the desired value.

6.50.2. actual_size

The actual size of the disk, in bytes.

The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.

6.50.3. bootable

Indicates if the disk is marked as bootable.

This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.

6.50.4. initial_size

The initial size of a sparse image disk created on block storage, in bytes.

The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.

6.50.5. interface

The type of interface driver used to connect the disk device to the virtual machine.

This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.

6.50.6. provisioned_size

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

6.50.7. qcow_version

The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 volumes, while V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.

6.50.8. shareable

Indicates if the disk can be attached to multiple virtual machines.

When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like GlusterFS or GFS.

6.50.9. wipe_after_delete

Indicates if the disk’s blocks will be read back as zeros after it is deleted:

  • On block storage, the disk will be zeroed and only then deleted.

  • On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.

Table 875. Links summary
Name Type Summary

disk

Disk

disk_profile

DiskProfile

instance_type

InstanceType

Optionally references to an instance type the device is used by.

openstack_volume_type

OpenStackVolumeType

permissions

Permission[]

quota

Quota

snapshot

Snapshot

statistics

Statistic[]

Statistics exposed by the disk.

storage_domain

StorageDomain

storage_domains

StorageDomain[]

The storage domains associated with this disk.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.50.10. statistics

Statistics exposed by the disk. For example:

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

These statistics aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:

GET /ovirt-engine/api/disks/123/statistics

6.50.11. storage_domains

The storage domains associated with this disk.

Only required when the first disk is being added to a virtual machine that was not itself created from a template.

6.50.12. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.51. DiskStatus enum

Table 876. Values summary
Name Summary

illegal

locked

ok

6.52. DiskStorageType enum

Table 877. Values summary
Name Summary

cinder

image

lun

6.53. DiskType enum

Table 878. Values summary
Name Summary

data

system

6.54. Display struct

Table 879. Attributes summary
Name Type Summary

address

String

allow_override

Boolean

certificate

Certificate

copy_paste_enabled

Boolean

disconnect_action

String

file_transfer_enabled

Boolean

keyboard_layout

String

monitors

Integer

port

Integer

proxy

String

secure_port

Integer

single_qxl_pci

Boolean

smartcard_enabled

Boolean

type

DisplayType

6.55. DisplayType enum

Table 880. Values summary
Name Summary

spice

vnc

6.56. Dns struct

Represents the DNS resolver configuration.

Table 881. Attributes summary
Name Type Summary

search_domains

Host[]

Array of hosts serving as search domains.

servers

Host[]

Array of hosts serving as DNS servers.

6.57. DnsResolverConfiguration struct

Represents the DNS resolver configuration.

Table 882. Attributes summary
Name Type Summary

name_servers

String[]

Array of addresses of name servers.

6.57.1. name_servers

Array of addresses of name servers. Either IPv4 or IPv6 addresses may be specified.

6.58. Domain struct

This type represents a directory service domain.

Table 883. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

user

User
Table 884. Links summary
Name Type Summary

groups

Group[]

A reference to all groups in the directory service.

users

User[]

A reference to a list of all users in the directory service.

6.58.1. users

A reference to a list of all users in the directory service. This information is used to add new users to the oVirt environment.

6.59. EntityExternalStatus enum

Type representing an external entity status.

Table 885. Values summary
Name Summary

error

The external entity status is erroneous.

failure

The external entity has an issue that causes failures.

info

There external entity status is okay but with some information that might be relevant.

ok

The external entity status is okay.

warning

The external entity status is okay but with an issue that might require attention.

6.59.1. error

The external entity status is erroneous. This might require a moderate attention.

6.59.2. failure

The external entity has an issue that causes failures. This might require immediate attention.

6.60. EntityProfileDetail struct

Table 886. Attributes summary
Name Type Summary

profile_details

ProfileDetail[]

6.61. ErrorHandling struct

Table 887. Attributes summary
Name Type Summary

on_error

MigrateOnError

6.62. Event struct

Type representing an event.

Table 888. Attributes summary
Name Type Summary

code

Integer

The event code.

comment

String

Free text containing comments about this object.

correlation_id

String

The event correlation identifier.

custom_data

String

Free text representing custom event data.

custom_id

Integer

A custom event identifier.

description

String

A human-readable description in plain text.

flood_rate

Integer

Defines the flood rate.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

origin

String

Free text identifying the origin of the event.

severity

LogSeverity

The event severity.

time

Date

The event time.

6.62.1. correlation_id

The event correlation identifier. Used in order to correlate several events together.

6.62.2. flood_rate

Defines the flood rate. This prevents flooding in case an event appeared more than once in the defined rate. Defaults is 30 seconds.

Table 889. Links summary
Name Type Summary

cluster

Cluster

Reference to the cluster service.

data_center

DataCenter

Reference to the data center service.

host

Host

Reference to the host service.

storage_domain

StorageDomain

Reference to the storage domain service.

template

Template

Reference to the template service.

user

User

Reference to the user service.

vm

Vm

Reference to the virtual machine service.

6.62.3. cluster

Reference to the cluster service. Event can be associated with a cluster.

6.62.4. data_center

Reference to the data center service. Event can be associated with a data center.

6.62.5. host

Reference to the host service. Event can be associated with a host.

6.62.6. storage_domain

Reference to the storage domain service. Event can be associated with a storage domain.

6.62.7. template

Reference to the template service. Event can be associated with a template.

6.62.8. user

Reference to the user service. Event can be associated with a user.

6.62.9. vm

Reference to the virtual machine service. Event can be associated with a virtual machine.

6.63. ExternalComputeResource struct

Table 890. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

provider

String

url

String

user

String
Table 891. Links summary
Name Type Summary

external_host_provider

ExternalHostProvider

6.64. ExternalDiscoveredHost struct

Table 892. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

ip

String

last_report

String

mac

String

name

String

A human-readable name in plain text.

subnet_name

String
Table 893. Links summary
Name Type Summary

external_host_provider

ExternalHostProvider

6.65. ExternalHost struct

Table 894. Attributes summary
Name Type Summary

address

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 895. Links summary
Name Type Summary

external_host_provider

ExternalHostProvider

6.66. ExternalHostGroup struct

Table 896. Attributes summary
Name Type Summary

architecture_name

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

domain_name

String

id

String

A unique identifier.

name

String

A human-readable name in plain text.

operating_system_name

String

subnet_name

String
Table 897. Links summary
Name Type Summary

external_host_provider

ExternalHostProvider

6.67. ExternalHostProvider struct

Table 898. Attributes summary
Name Type Summary

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

properties

Property[]

Array of provider name/value properties.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.67.1. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

Table 899. Links summary
Name Type Summary

certificates

Certificate[]

compute_resources

ExternalComputeResource[]

discovered_hosts

ExternalDiscoveredHost[]

host_groups

ExternalHostGroup[]

hosts

Host[]

6.68. ExternalProvider struct

Represents an external provider.

Table 900. Attributes summary
Name Type Summary

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

properties

Property[]

Array of provider name/value properties.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.68.1. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

6.69. ExternalStatus enum

Table 901. Values summary
Name Summary

error

failure

info

ok

warning

6.70. ExternalSystemType enum

Represents the type of the external system that is associated with the step.

Table 902. Values summary
Name Summary

gluster

Represents Gluster as the external system which is associated with the step.

vdsm

Represents VDSM as the external system which is associated with the step.

6.71. ExternalVmImport struct

Describes the parameters for the virtual machine import operation from an external system.

Table 903. Attributes summary
Name Type Summary

name

String

The name of the virtual machine to be imported, as is defined within the external system.

password

String

The password to authenticate against the external hypervisor system.

provider

ExternalVmProviderType

The type of external virtual machine provider.

sparse

Boolean

Specifies the disk allocation policy of the resulting virtual machine: true for sparse, false for preallocated.

url

String

The URL to be passed to the virt-v2v tool for conversion.

username

String

The username to authenticate against the external hypervisor system.

6.71.1. url

The URL to be passed to the virt-v2v tool for conversion.

Example:

vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1

More examples can be found at http://libguestfs.org/virt-v2v.1.html.

Table 904. Links summary
Name Type Summary

cluster

Cluster

Specifies the target cluster for the resulting virtual machine.

cpu_profile

CpuProfile

Optional.

drivers_iso

File

Optional.

host

Host

Optional.

quota

Quota

Optional.

storage_domain

StorageDomain

Specifies the target storage domain for converted disks.

vm

Vm

The virtual machine entity used to specify a name for the newly created virtual machine.

6.71.2. cpu_profile

Optional. Specifies the CPU profile of the resulting virtual machine.

6.71.3. drivers_iso

Optional. The name of the ISO containing drivers that can be used during the virt-v2v conversion process.

6.71.4. host

Optional. Specifies the host (using host’s ID) to be used for the conversion process. If not specified, one is selected automatically.

6.71.5. quota

Optional. Specifies the quota that will be applied to the resulting virtual machine.

6.71.6. vm

The virtual machine entity used to specify a name for the newly created virtual machine.

If a name is not specified, the source virtual machine name will be used.

6.72. ExternalVmProviderType enum

Describes the type of external hypervisor system.

Table 905. Values summary
Name Summary

kvm

vmware

xen

6.73. Fault struct

Table 906. Attributes summary
Name Type Summary

detail

String

reason

String

6.74. FenceType enum

Type representing the type of the fence operation.

Table 907. Values summary
Name Summary

manual

Manual host fencing via power management.

restart

Restart the host via power management.

start

Start the host via power management.

status

Check the host power status via power management.

stop

Stop the host via power management.

6.75. FencingPolicy struct

Type representing a cluster fencing policy.

Table 908. Attributes summary
Name Type Summary

enabled

Boolean

Enable or disable fencing on this cluster.

skip_if_connectivity_broken

SkipIfConnectivityBroken

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well.

skip_if_gluster_bricks_up

Boolean

A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced.

skip_if_gluster_quorum_not_met

Boolean

A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks.

skip_if_sd_active

SkipIfSdActive

If enabled, we will skip fencing in case the host maintains its lease in the storage.

6.75.1. skip_if_connectivity_broken

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.

6.75.2. skip_if_gluster_bricks_up

A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced. This flag is optional, and the default value is false.

6.75.3. skip_if_gluster_quorum_not_met

A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks. This flag is optional, and the default value is false.

6.75.4. skip_if_sd_active

If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.

6.76. File struct

Table 909. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

content

String

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

type

String
Table 910. Links summary
Name Type Summary

storage_domain

StorageDomain

6.77. Filter struct

Table 911. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

position

Integer
Table 912. Links summary
Name Type Summary

scheduling_policy_unit

SchedulingPolicyUnit

6.78. Floppy struct

Table 913. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

file

File

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 914. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.78.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.79. FopStatistic struct

Table 915. Attributes summary
Name Type Summary

name

String

statistics

Statistic[]

6.80. GlusterBrick struct

Table 916. Attributes summary
Name Type Summary

brick_dir

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

device

String

fs_name

String

gluster_clients

GlusterClient[]

id

String

A unique identifier.

memory_pools

GlusterMemoryPool[]

mnt_options

String

name

String

A human-readable name in plain text.

pid

Integer

port

Integer

server_id

String

status

GlusterBrickStatus
Table 917. Links summary
Name Type Summary

gluster_volume

GlusterVolume

instance_type

InstanceType

Optionally references to an instance type the device is used by.

statistics

Statistic[]

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.80.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.81. GlusterBrickAdvancedDetails struct

Table 918. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

device

String

fs_name

String

gluster_clients

GlusterClient[]

id

String

A unique identifier.

memory_pools

GlusterMemoryPool[]

mnt_options

String

name

String

A human-readable name in plain text.

pid

Integer

port

Integer
Table 919. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.81.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.82. GlusterBrickMemoryInfo struct

Table 920. Attributes summary
Name Type Summary

memory_pools

GlusterMemoryPool[]

6.83. GlusterBrickStatus enum

Table 921. Values summary
Name Summary

down

Brick is in down state, the data cannot be stored or retrieved from it.

unknown

When the status cannot be determined due to host being non-responsive.

up

Brick is in up state, the data can be stored or retrieved from it.

6.84. GlusterClient struct

Table 922. Attributes summary
Name Type Summary

bytes_read

Integer

bytes_written

Integer

client_port

Integer

host_name

String

6.85. GlusterHook struct

Table 923. Attributes summary
Name Type Summary

checksum

String

comment

String

Free text containing comments about this object.

conflict_status

Integer

conflicts

String

content

String

content_type

HookContentType

description

String

A human-readable description in plain text.

gluster_command

String

id

String

A unique identifier.

name

String

A human-readable name in plain text.

stage

HookStage

status

GlusterHookStatus
Table 924. Links summary
Name Type Summary

cluster

Cluster

server_hooks

GlusterServerHook[]

6.86. GlusterHookStatus enum

Table 925. Values summary
Name Summary

disabled

Hook is disabled in the cluster.

enabled

Hook is enabled in the cluster.

missing

Unknown/missing hook status.

6.87. GlusterMemoryPool struct

Table 926. Attributes summary
Name Type Summary

alloc_count

Integer

cold_count

Integer

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

hot_count

Integer

id

String

A unique identifier.

max_alloc

Integer

max_stdalloc

Integer

name

String

A human-readable name in plain text.

padded_size

Integer

pool_misses

Integer

type

String

6.88. GlusterServerHook struct

Table 927. Attributes summary
Name Type Summary

checksum

String

comment

String

Free text containing comments about this object.

content_type

HookContentType

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

status

GlusterHookStatus
Table 928. Links summary
Name Type Summary

host

Host

6.89. GlusterState enum

Table 929. Values summary
Name Summary

down

unknown

up

6.90. GlusterVolume struct

Table 930. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

disperse_count

Integer

id

String

A unique identifier.

name

String

A human-readable name in plain text.

options

Option[]

redundancy_count

Integer

replica_count

Integer

status

GlusterVolumeStatus

stripe_count

Integer

transport_types

TransportType[]

volume_type

GlusterVolumeType
Table 931. Links summary
Name Type Summary

bricks

GlusterBrick[]

cluster

Cluster

statistics

Statistic[]

6.91. GlusterVolumeProfileDetails struct

Table 932. Attributes summary
Name Type Summary

brick_profile_details

BrickProfileDetail[]

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

nfs_profile_details

NfsProfileDetail[]

6.92. GlusterVolumeStatus enum

Table 933. Values summary
Name Summary

down

Volume needs to be started, for clients to be able to mount and use it.

unknown

When the status cannot be determined due to host being non-responsive.

up

Volume is started, and can be mounted and used by clients.

6.93. GlusterVolumeType enum

Type representing the type of Gluster Volume.

Table 934. Values summary
Name Summary

disperse

Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures.

distribute

Distributed volumes distributes files throughout the bricks in the volume.

distributed_disperse

Distributed dispersed volumes distribute files across dispersed subvolumes.

distributed_replicate

Distributed replicated volumes distributes files across replicated bricks in the volume.

distributed_stripe

Distributed striped volumes stripe data across two or more nodes in the cluster.

distributed_striped_replicate

Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster.

replicate

Replicated volumes replicates files across bricks in the volume.

stripe

Striped volumes stripes data across bricks in the volume.

striped_replicate

Striped replicated volumes stripes data across replicated bricks in the cluster.

6.93.1. disperse

Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures.

Dispersed volumes an encoded fragment of the original file to each brick in a way that only a subset of the fragments is needed to recover the original file. The number of bricks that can be missing without losing access to data is configured by the administrator on volume creation time.

6.93.2. distribute

Distributed volumes distributes files throughout the bricks in the volume.

Distributed volumes can be used where the requirement is to scale storage and the redundancy is either not important or is provided by other hardware/software layers.

6.93.3. distributed_disperse

Distributed dispersed volumes distribute files across dispersed subvolumes.

This has the same advantages of distribute replicate volumes, but using disperse to store the data into the bricks.

6.93.4. distributed_replicate

Distributed replicated volumes distributes files across replicated bricks in the volume.

Distributed replicated volumes can be used in environments where the requirement is to scale storage and high-reliability is critical. Distributed replicated volumes also offer improved read performance in most environments.

6.93.5. distributed_stripe

Distributed striped volumes stripe data across two or more nodes in the cluster.

Distributed striped volumes should be used where the requirement is to scale storage and in high concurrency environments accessing very large files is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

6.93.6. distributed_striped_replicate

Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster.

For best results, distributed striped replicated volumes should be used in highly concurrent environments where parallel access of very large files and performance is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

6.93.7. replicate

Replicated volumes replicates files across bricks in the volume.

Replicated volumes can be used in environments where high-availability and high-reliability are critical.

6.93.8. stripe

Striped volumes stripes data across bricks in the volume.

For best results, striped volumes should only in high concurrency environments accessing very large files.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

6.93.9. striped_replicate

Striped replicated volumes stripes data across replicated bricks in the cluster.

For best results, striped replicated volumes should be used in highly concurrent environments where there is parallel access of very large files and performance is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

6.94. GracePeriod struct

Table 935. Attributes summary
Name Type Summary

expiry

Integer

6.95. GraphicsConsole struct

Table 936. Attributes summary
Name Type Summary

address

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

port

Integer

protocol

GraphicsType

tls_port

Integer
Table 937. Links summary
Name Type Summary

instance_type

InstanceType

template

Template

vm

Vm

6.96. GraphicsType enum

Table 938. Values summary
Name Summary

spice

vnc

6.97. Group struct

This type represents all groups in the directory service.

Table 939. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

domain_entry_id

String

The containing directory service domain id.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

namespace

String

Namespace where group resides.
Table 940. Links summary
Name Type Summary

domain

Domain

A link to the domain containing this group.

permissions

Permission[]

A link to the permissions sub-collection for permissions attached to this group.

roles

Role[]

A link to the roles sub-collection for roles attached to this group.

tags

Tag[]

A link to the tags sub-collection for tags attached to this group.

6.97.1. roles

A link to the roles sub-collection for roles attached to this group.

Used only to represent the initial role assignments for a new group; thereafter, modification of role assignments is only supported via the roles sub-collection.

6.98. GuestOperatingSystem struct

Table 941. Attributes summary
Name Type Summary

architecture

String

codename

String

distribution

String

family

String

kernel

Kernel

version

Version

6.99. HardwareInformation struct

Table 942. Attributes summary
Name Type Summary

family

String

manufacturer

String

product_name

String

serial_number

String

supported_rng_sources

RngSource[]

uuid

String

version

String

6.100. HighAvailability struct

Table 943. Attributes summary
Name Type Summary

enabled

Boolean

priority

Integer

6.101. Hook struct

Represents a hook.

Table 944. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

event_name

String

Name of the event to execute the hook on.

id

String

A unique identifier.

md5

String

Checksum of the hook.

name

String

A human-readable name in plain text.
Table 945. Links summary
Name Type Summary

host

Host

Reference to the host the hook belongs to.

6.102. HookContentType enum

Represents content type of hook script.

Table 946. Values summary
Name Summary

binary

Binary content type of the hook.

text

Text content type of the hook.

6.103. HookStage enum

Table 947. Values summary
Name Summary

post

pre

6.104. HookStatus enum

Type represents the status of a hook.

Table 948. Values summary
Name Summary

disabled

Hook is disabled.

enabled

Hook is enabled.

missing

Hook is missing.

6.105. Host struct

Type representing a host.

Table 949. Attributes summary
Name Type Summary

address

String

The host address (FQDN/IP).

auto_numa_status

AutoNumaStatus

The host auto non uniform memory access (NUMA) status.

certificate

Certificate

The host certificate.

comment

String

Free text containing comments about this object.

cpu

Cpu

The CPU type of this host.

description

String

A human-readable description in plain text.

device_passthrough

HostDevicePassthrough

Specifies whether host device passthrough is enabled on this host.

display

Display

Optionally specify the display address of this host explicitly.

external_status

ExternalStatus

The host external status.

hardware_information

HardwareInformation

The host hardware information.

hosted_engine

HostedEngine

The hosted engine status on this host.

id

String

A unique identifier.

iscsi

IscsiDetails

The host iSCSI details.

kdump_status

KdumpStatus

The host KDUMP status.

ksm

Ksm

Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference.

libvirt_version

Version

The host libvirt version.

max_scheduling_memory

Integer

The max scheduling memory on this host in bytes.

memory

Integer

The amount of physical memory on this host in bytes.

name

String

A human-readable name in plain text.

numa_supported

Boolean

Specifies whether non uniform memory access (NUMA) is supported on this host.

os

OperatingSystem

The operating system on this host.

override_iptables

Boolean

Specifies whether we should override firewall definitions.

port

Integer

The host port.

power_management

PowerManagement

The host power management definitions.

protocol

HostProtocol

The protocol that the engine uses to communicate with the host.

root_password

String

When creating a new host, a root password is required if the password authentication method is chosen, but this is not subsequently included in the representation.

se_linux

SeLinux

The host SElinux status.

spm

Spm

The host storage pool manager (SPM) status and definition.

ssh

Ssh

The SSH definitions.

status

HostStatus

The host status.

status_detail

String

The host status details.

summary

VmSummary

The virtual machine summary - how many are active, migrating and total.

transparent_huge_pages

TransparentHugePages

Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit.

type

HostType

Indicates if the host contains a full installation of the operating system or a scaled-down version intended only to host virtual machines.

update_available

Boolean

Specifies whether there is an oVirt-related update on this host.

version

Version

The version of VDSM.

6.105.1. external_status

The host external status. This can be used by third-party software to change the host external status in case of an issue. This has no effect on the host lifecycle, unless a third-party software checks for this status and acts accordingly.

6.105.2. kdump_status

The host KDUMP status. KDUMP happens when the host kernel has crashed and it is now going through memory dumping.

6.105.3. ksm

Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference. This helps with optimization for memory density.

For example, to enable KSM for host 123, send a request like this:

PUT /ovirt-engine/api/hosts/123

With a request body like this:

<host>
  <ksm>
    <enabled>true</enabled>
  </ksm>
</host>

6.105.4. libvirt_version

The host libvirt version. For more information on libvirt please go to libvirt.

6.105.5. override_iptables

Specifies whether we should override firewall definitions. This applies only when the host is installed or re-installed.

6.105.6. protocol

The protocol that the engine uses to communicate with the host.

Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.

6.105.7. se_linux

The host SElinux status. Security-Enhanced Linux (SELinux) is a component in the Linux kernel that provides a mechanism for supporting access control security policies.

6.105.8. spm

The host storage pool manager (SPM) status and definition. Use it to set the SPM priority of this host, and to see whether this is the current SPM or not.

6.105.9. status_detail

The host status details. Relevant for Gluster hosts.

6.105.10. transparent_huge_pages

Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit. This reduces memory consumption and increases host performance.

For example, to enable transparent huge page support for host 123, send a request like this:

PUT /ovirt-engine/api/hosts/123

With a request body like this:

<host>
  <transparent_hugepages>
    <enabled>true</enabled>
  </transparent_hugepages>
</host>

6.105.11. version

The version of VDSM.

For example:

GET /ovirt-engine/api/hosts/123

This GET request will return the following output:

<host>
  ...
  <version>
    <build>999</build>
    <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version>
    <major>4</major>
    <minor>18</minor>
    <revision>0</revision>
  </version>
  ...
</host>
Table 950. Links summary
Name Type Summary

affinity_labels

AffinityLabel[]

agents

Agent[]

cluster

Cluster

devices

Device[]

external_host_provider

ExternalHostProvider

hooks

Hook[]

katello_errata

KatelloErratum[]

Lists all the Katello errata assigned to the host.

network_attachments

NetworkAttachment[]

nics

Nic[]

numa_nodes

NumaNode[]

permissions

Permission[]

statistics

Statistic[]

Each host resource exposes a statistics sub-collection for host-specific statistics.

storage_connection_extensions

StorageConnectionExtension[]

storages

HostStorage[]

tags

Tag[]

unmanaged_networks

UnmanagedNetwork[]

6.105.12. katello_errata

Lists all the Katello errata assigned to the host.

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

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <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>

6.105.13. statistics

Each host resource exposes a statistics sub-collection for host-specific statistics.

An example of an XML representation:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/statistics/456" id="456">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host href="/ovirt-engine/api/hosts/123" id="123"/>
  </statistic>
    ...
</statistics>
This statistics sub-collection is read-only.

The following list shows the statistic types for hosts:

Name Description

memory.total

Total memory in bytes on the host.

memory.used

Memory in bytes used on the host.

memory.free

Memory in bytes free on the host.

memory.shared

Memory in bytes shared on the host.

memory.buffers

I/O buffers in bytes.

memory.cached

OS caches in bytes.

swap.total

Total swap memory in bytes on the host.

swap.free

Swap memory in bytes free on the host.

swap.used

Swap memory in bytes used on the host.

swap.cached

Swap memory in bytes also cached in host’s memory.

ksm.cpu.current

Percentage of CPU usage for Kernel SamePage Merging.

cpu.current.user

Percentage of CPU usage for user slice.

cpu.current.system

Percentage of CPU usage for system.

cpu.current.idle

Percentage of idle CPU usage.

cpu.load.avg.5m

CPU load average per five minutes.

boot.time

Boot time of the machine.

6.106. HostDevice struct

Table 951. Attributes summary
Name Type Summary

capability

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

iommu_group

Integer

name

String

A human-readable name in plain text.

physical_function

HostDevice

placeholder

Boolean

product

Product

vendor

Vendor

virtual_functions

Integer
Table 952. Links summary
Name Type Summary

host

Host

parent_device

HostDevice

vm

Vm

6.107. HostDevicePassthrough struct

Table 953. Attributes summary
Name Type Summary

enabled

Boolean

6.108. HostNic struct

Represents a host NIC.

For example, the XML representation of a host NIC looks like this:

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>eth0</name>
  <boot_protocol>static</boot_protocol>
  <bridged>true</bridged>
  <custom_configuration>true</custom_configuration>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <ipv6>
    <gateway>::</gateway>
    <version>v6</version>
  </ipv6>
  <ipv6_boot_protocol>none</ipv6_boot_protocol>
  <mac>
    <address>52:54:00:0c:79:1d</address>
  </mac>
  <mtu>1500</mtu>
  <status>up</status>
</host_nic>

A bonded interface is represented as a HostNic object containing the bonding and slaves attributes.

For example, the XML representation of a bonded host NIC looks like this:

<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456">
  <name>bond0</name>
  <mac address="00:00:00:00:00:00"/>
  <ip>
    <address>192.168.122.39</address>
    <gateway>192.168.122.1</gateway>
    <netmask>255.255.255.0</netmask>
    <version>v4</version>
  </ip>
  <boot_protocol>dhcp</boot_protocol>
  <bonding>
    <options>
      <option>
        <name>mode</name>
        <value>4</value>
        <type>Dynamic link aggregation (802.3ad)</type>
      </option>
      <option>
        <name>miimon</name>
        <value>100</value>
      </option>
    </options>
    <slaves>
      <host_nic id="123"/>
      <host_nic id="456"/>
    </slaves>
  </bonding>
  <mtu>1500</mtu>
  <bridged>true</bridged>
  <custom_configuration>false</custom_configuration>
</host_nic>
Table 954. Attributes summary
Name Type Summary

ad_aggregator_id

Integer

The ad_aggregator_id property of a bond or bond slave, for bonds in mode 4.

base_interface

String

The base interface of the NIC.

bonding

Bonding

The bonding parameters of the NIC.

boot_protocol

BootProtocol

The IPv4 boot protocol configuration of the NIC.

bridged

Boolean

Defines the bridged network status.

check_connectivity

Boolean

comment

String

Free text containing comments about this object.

custom_configuration

Boolean

description

String

A human-readable description in plain text.

id

String

A unique identifier.

ip

Ip

The IPv4 address of the NIC.

ipv6

Ip

The IPv6 address of the NIC.

ipv6_boot_protocol

BootProtocol

The IPv6 boot protocol configuration of the NIC.

mac

Mac

The MAC address of the NIC.

mtu

Integer

The maximum transmission unit for the interface.

name

String

A human-readable name in plain text.

network_labels

NetworkLabel[]

The labels that are applied to this NIC.

override_configuration

Boolean

properties

Property[]

speed

Integer

statistics

Statistic[]

A link to the statistics of the NIC.

status

NicStatus

virtual_functions_configuration

HostNicVirtualFunctionsConfiguration

Describes the virtual functions configuration of a physical function NIC.

vlan

Vlan

6.108.1. ad_aggregator_id

The ad_aggregator_id property of a bond or bond slave, for bonds in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation. (See Wikipedia and Presentation for more information). This is only valid for bonds in mode 4, or NICs which are part of a bond. It is not present for bonds in other modes, or NICs which are not part of a bond in mode 4. The ad_aggregator_id property indicates which of the bond slaves are active. The value of the ad_aggregator_id of an active slave is the same as the value of the ad_aggregator_id property of the bond. This parameter is read only. Setting it will have no effect on the bond/NIC. It is retrieved from the /sys/class/net/bondX/bonding/ad_aggregator file for a bond, and the /sys/class/net/ensX/bonding_slave/ad_aggregator_id file for a NIC.

6.108.2. bridged

Defines the bridged network status. Set to true for a bridged network and false for a bridgeless network.

6.108.3. statistics

A link to the statistics of the NIC.

The data types for HostNic statistical values:

  • data.current.rx - The rate in bytes per second of data received.

  • data.current.tx - The rate in bytes per second of data transmitted.

  • data.total.rx - Total received data.

  • data.total.tx - Total transmitted data.

  • errors.total.rx - Total errors from receiving data.

  • errors.total.tx - Total errors from transmitting data.

Table 955. Links summary
Name Type Summary

host

Host

network

Network

A reference to the network to which the interface should be connected.

physical_function

HostNic

A reference to the physical function NIC of a SR-IOV virtual function NIC.

qos

Qos

A link to the quality-of-service configuration of the interface.

6.108.4. network

A reference to the network to which the interface should be connected. A blank network ID is allowed.

6.109. HostNicVirtualFunctionsConfiguration struct

Describes the virtual functions configuration of an SR-IOV-enabled physical function NIC.

Table 956. Attributes summary
Name Type Summary

all_networks_allowed

Boolean

Defines whether all networks are allowed to be defined on the related virtual functions, or specified ones only.

max_number_of_virtual_functions

Integer

The maximum number of virtual functions the NIC supports.

number_of_virtual_functions

Integer

The number of virtual functions currently defined.

6.109.1. max_number_of_virtual_functions

The maximum number of virtual functions the NIC supports. This property is read-only.

6.109.2. number_of_virtual_functions

The number of virtual functions currently defined. A user-defined value between 0 and max_number_of_virtual_functions.

6.110. HostProtocol enum

The protocol used by the engine to communicate with a host.

Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.
Table 957. Values summary
Name Summary

stomp

JSON-RPC protocol on top of STOMP.

xml

XML-RPC protocol.

6.111. HostStatus enum

Type representing a host status.

Table 958. Values summary
Name Summary

connecting

The engine cannot communicate with the host for a specific threshold so it is now trying to connect before going through fencing.

down

The host is down.

error

The host is in error status.

initializing

The host is initializing.

install_failed

The host installation failed.

installing

The host is being installed.

installing_os

The host operating system is now installing.

kdumping

The host kernel has crashed and it is now going through memory dumping.

maintenance

The host is in maintenance status.

non_operational

The host is non operational.

non_responsive

The host is not responsive.

pending_approval

The host is pending administrator approval.

preparing_for_maintenance

The host is preparing for maintenance.

reboot

The host is being rebooted.

unassigned

The host is in activation process.

up

The host is up.

6.111.1. error

The host is in error status. This will happen if we will try to run a virtual machine several times and it will fail.

6.111.2. initializing

The host is initializing. This is an intermediate step before moving the host to 'up' status.

6.111.3. install_failed

The host installation failed. In such cases look at the event log to understand what failed the installation, and issue a re-install.

6.111.4. installing_os

The host operating system is now installing. This status is relevant when using a Satellite/Foreman provider, and issuing a bare-metal provisioning (discovered host provisioning).

6.111.5. maintenance

The host is in maintenance status. When a host is in maintenance it cannot run virtual machines.

6.111.6. non_operational

The host is non operational. This can happen due to various reasons, such as not having a connection with the storage, not supporting a mandatory network, not supporting the cluster level, and more.

6.111.7. non_responsive

The host is not responsive. This means that the engine is not able to communicate with the host.

6.111.8. pending_approval

The host is pending administrator approval. This is relevant only for vintage ovirt-node / RHV-H.

6.111.9. preparing_for_maintenance

The host is preparing for maintenance. During this time the engine makes sure to live migrate all the virtual machines from this host to other hosts. Once all migrations have been completed the host will move to 'maintenance' status.

6.112. HostStorage struct

Table 959. Attributes summary
Name Type Summary

address

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

logical_units

LogicalUnit[]

mount_options

String

name

String

A human-readable name in plain text.

nfs_retrans

Integer

The number of times to retry a request before attempting further recovery actions.

nfs_timeo

Integer

The time in tenths of a second to wait for a response before retrying NFS requests.

nfs_version

NfsVersion

override_luns

Boolean

password

String

path

String

port

Integer

portal

String

target

String

type

StorageType

username

String

vfs_type

String

volume_group

VolumeGroup

6.112.1. nfs_retrans

The number of times to retry a request before attempting further recovery actions. The value must be in the range of 0 to 65535. For more details see the description of the retrans mount option in the nfs man page.

6.112.2. nfs_timeo

The time in tenths of a second to wait for a response before retrying NFS requests. The value must be in the range of 0 to 65535. For more details see the description of the timeo mount option in the nfs man page.

Table 960. Links summary
Name Type Summary

host

Host

6.113. HostType enum

This enumerated type is used to determine which type of operating system is used by the host.

Table 961. Values summary
Name Summary

ovirt_node

The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora.

rhel

The host contains a full Red Hat Enterprise Linux, CentOS, or Fedora installation.

rhev_h

The host contains Red Hat Enterprise Virtualization Hypervisor (RHEV-H), a small-scaled version of Red Hat Enterprise Linux, CentOS, or Fedora, used solely to host virtual machines.

6.113.1. ovirt_node

The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora. The main difference between RHVH and legacy RHEV-H is that RHVH has a writeable file system and will handle its own installation instead of having RPMs pushed to it by the Manager like in legacy RHEV-H.

6.114. HostedEngine struct

Table 962. Attributes summary
Name Type Summary

active

Boolean

configured

Boolean

global_maintenance

Boolean

local_maintenance

Boolean

score

Integer

6.115. Icon struct

Icon of virtual machine or template.

Table 963. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

data

String

Base64 encode content of the icon file.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

media_type

String

Format of icon file.

name

String

A human-readable name in plain text.

6.115.1. media_type

Format of icon file.

One of:

  • image/jpeg

  • image/png

  • image/gif

6.116. Identified struct

This interface is the base model for all types that represent objects with an identifier.

Table 964. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

6.117. Image struct

Table 965. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 966. Links summary
Name Type Summary

storage_domain

StorageDomain

6.118. ImageTransfer struct

This type contains information regarding an image transfer being performed.

Table 967. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

direction

ImageTransferDirection

The direction indicates whether the transfer is sending image data (upload) or receiving image data (download).

id

String

A unique identifier.

name

String

A human-readable name in plain text.

phase

ImageTransferPhase

The current phase of the image transfer in progress.

proxy_url

String

The URL of the proxy server that the user inputs or outputs to.

signed_ticket

String

The signed ticket that should be attached as an Authentication header in the HTTPS request for the proxy server to input or output to (See the proxy_url attribute).

6.118.1. direction

The direction indicates whether the transfer is sending image data (upload) or receiving image data (download).

If a direction is not set during an addition of a new transfer, The default direction for the transfer will be upload.

6.118.2. phase

The current phase of the image transfer in progress. Each transfer needs a managed session, which must be opened for the user to input or output an image. Please refer to image transfer for further documentation.

6.118.3. proxy_url

The URL of the proxy server that the user inputs or outputs to. This attribute is available only if the image transfer entity is in the transferring phase. See phase for details.

Table 968. Links summary
Name Type Summary

host

Host

The host which will be used to write to the image which is targeted for input or output.

image

Image

The image which is targeted for input or output.

6.119. ImageTransferDirection enum

The image transfer direction for a transfer.

When adding a new transfer, the user can choose whether the transfer will be to an image, choosing upload, or to transfer from an image- choosing download as an ImageTransferDirection.

Please refer to image transfer for further documentation.

Table 969. Values summary
Name Summary

download

The user must choose download when he/she wants to stream data from an image.

upload

The user can choose upload when he/she wants to stream data to an image.

6.120. ImageTransferPhase enum

A list of possible phases for an image transfer entity. Each of these values defines a specific point in a transfer flow.

Please refer to image transfer for more information.

Table 970. Values summary
Name Summary

cancelled

This phase will be set as a result of the user cancelling the transfer.

finalizing_failure

This phase can only be set in the Administration Portal, and indicates that there was an error during the transfer, and it is being finalized with a failure.

finalizing_success

This phase will be set when the user calls finalize.

finished_failure

Indicates that the targeted image failed the verification, and cannot be used.

finished_success

Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used.

initializing

The initial phase of an image transfer.

paused_system

This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host.

paused_user

This phase is a result of a pause call by the user, using pause.

resuming

The phase where the transfer has been resumed by the client calling resume.

transferring

The phase where the transfer session is open, and the client can input or output the desired image using the preferred tools.

unknown

An unknown phase.

6.120.1. cancelled

This phase will be set as a result of the user cancelling the transfer. The cancellation can only be performed in the Administration Portal.

6.120.2. finalizing_success

This phase will be set when the user calls finalize. Calling finalize is essential to finish the transfer session, and finish using the targeted image. After finalizing, the phase will be changed to finished_success or finished_failure.

Refer to image transfer for more information.

6.120.3. finished_failure

Indicates that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will be deleted, and the targeted image will be set to illegal.

6.120.4. finished_success

Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will be deleted.

6.120.5. initializing

The initial phase of an image transfer. It is set while the transfer session is establishing. Once the session is established, the phase will be changed to transferring

6.120.6. paused_system

This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host. To resume the session, the client should call resume. After resuming, the phase will change to resuming.

6.120.7. resuming

The phase where the transfer has been resumed by the client calling resume. Resuming starts a new session, and after calling it, the phase will be changed to transferring, or paused_system in case of a failure.

6.120.8. unknown

An unknown phase. This will only be set in cases of unpredictable errors.

6.121. InheritableBoolean enum

Enum representing the boolean value that can be either set, or inherited from a higher level. The inheritance order is virtual machine → cluster → engine-config.

Table 971. Values summary
Name Summary

false

Set the value to false on this level.

inherit

Inherit the value from higher level.

true

Set the value to true on this level.

6.122. Initialization struct

Table 972. Attributes summary
Name Type Summary

active_directory_ou

String

authorized_ssh_keys

String

cloud_init

CloudInit

configuration

Configuration

custom_script

String

dns_search

String

dns_servers

String

domain

String

host_name

String

input_locale

String

nic_configurations

NicConfiguration[]

org_name

String

regenerate_ids

Boolean

regenerate_ssh_keys

Boolean

root_password

String

system_locale

String

timezone

String

ui_language

String

user_locale

String

user_name

String

windows_license_key

String

6.123. InstanceType struct

Describes the hardware configuration of virtual machines.

For example medium instance type includes 1 virtual CPU and 4 GiB of memory. It is a top-level entity (e.g. not bound to any data center or cluster). The attributes that are used for instance types and are common to virtual machine and template types are:

  • console

  • cpu

  • custom_cpu_model

  • custom_emulated_machine

  • display

  • high_availability

  • io

  • memory

  • memory_policy

  • migration

  • migration_downtime

  • os

  • rng_device

  • soundcard_enabled

  • usb

  • virtio_scsi

When creating a virtual machine from both an instance type and a template, the virtual machine will inherit the hardware configurations from the instance type

An instance type inherits it’s attributes from the template entity although most template attributes are not used in instance types.
Table 973. Attributes summary
Name Type Summary

bios

Bios

Reference to virtual machine’s BIOS configuration.

comment

String

Free text containing comments about this object.

console

Console

Console configured for this virtual machine.

cpu

Cpu

The configuration of the virtual machine CPU.

cpu_shares

Integer

creation_time

Date

The virtual machine creation date.

custom_compatibility_version

Version

Virtual machine custom compatibility version.

custom_cpu_model

String

custom_emulated_machine

String

custom_properties

CustomProperty[]

Properties sent to VDSM to configure various hooks.

delete_protected

Boolean

If true, the virtual machine cannot be deleted.

description

String

A human-readable description in plain text.

display

Display

The virtual machine display configuration.

domain

Domain

Domain configured for this virtual machine.

high_availability

HighAvailability

The virtual machine high availability configuration.

id

String

A unique identifier.

initialization

Initialization

Reference to virtual machine’s initialization configuration.

io

Io

For performance tuning of IO threading.

large_icon

Icon

Virtual machine’s large icon.

lease

StorageDomainLease

Reference to the storage domain this virtual machine/template lease reside on.

memory

Integer

The virtual machine’s memory, in bytes.

memory_policy

MemoryPolicy

Reference to virtual machine’s memory management configuration.

migration

MigrationOptions

Reference to configuration of migration of running virtual machine to another host.

migration_downtime

Integer

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

name

String

A human-readable name in plain text.

origin

String

The origin of this virtual machine.

os

OperatingSystem

Operating system type installed on the virtual machine.

rng_device

RngDevice

Random Number Generator device configuration for this virtual machine.

serial_number

SerialNumber

Virtual machine’s serial number in a cluster.

small_icon

Icon

Virtual machine’s small icon.

soundcard_enabled

Boolean

If true, the sound card is added to the virtual machine.

sso

Sso

Reference to the Single Sign On configuration this virtual machine is configured for.

start_paused

Boolean

If true, the virtual machine will be initially in 'paused' state after start.

stateless

Boolean

If true, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.

status

TemplateStatus

The status of the template.

time_zone

TimeZone

The virtual machine’s time zone set by oVirt.

tunnel_migration

Boolean

If true, the network data transfer will be encrypted during virtual machine live migration.

type

VmType

Determines whether the virtual machine is optimized for desktop or server.

usb

Usb

Configuration of USB devices for this virtual machine (count, type).

version

TemplateVersion

Indicates whether this is a base version or a sub version of another template.

virtio_scsi

VirtioScsi

Reference to VirtIO SCSI configuration.

vm

Vm

The virtual machine configuration associated with this template.

6.123.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.123.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.123.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.123.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.123.5. lease

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

6.123.6. memory

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.123.7. migration_downtime

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

6.123.8. origin

The origin of this virtual machine.

Possible values:

  • ovirt

  • rhev

  • vmware

  • xen

  • external

  • hosted_engine

  • managed_hosted_engine

  • kvm

  • physical_machine

  • hyperv

6.123.9. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.123.10. sso

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Table 974. Links summary
Name Type Summary

cdroms

Cdrom[]

References to the CD-ROM devices attached to the template.

cluster

Cluster

Reference to cluster the virtual machine belongs to.

cpu_profile

CpuProfile

Reference to CPU profile used by this virtual machine.

disk_attachments

DiskAttachment[]

References to the disks attached to the template.

graphics_consoles

GraphicsConsole[]

References to the graphic consoles attached to the template.

nics

Nic[]

References to the network interfaces attached to the template.

permissions

Permission[]

References to the user permissions attached to the template.

quota

Quota

Reference to quota configuration set for this virtual machine.

storage_domain

StorageDomain

Reference to storage domain the virtual machine belongs to.

tags

Tag[]

References to the tags attached to the template.

watchdogs

Watchdog[]

References to the watchdog devices attached to the template.

6.124. Io struct

Table 975. Attributes summary
Name Type Summary

threads

Integer

6.125. Ip struct

Represents the IP configuration of a network interface.

Table 976. Attributes summary
Name Type Summary

address

String

The text representation of the IP address.

gateway

String

The address of the default gateway.

netmask

String

The network mask.

version

IpVersion

The version of the IP protocol.

6.125.1. address

The text representation of the IP address.

For example, an IPv4 address will be represented as follows:

<ip>
  <address>192.168.0.1</address>
  ...
</ip>

An IPv6 address will be represented as follows:

<ip>
  <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
  ...
</ip>

6.125.2. version

The version of the IP protocol.

From version 4.1 of the Manager this attribute will be optional, and when a value is not provided, it will be inferred from the value of the address attribute.

6.126. IpAddressAssignment struct

Represents an IP address assignment for a network device.

For a static boot protocol assignment, subnet mask and IP address (and optinally default gateway) must be provided in the IP configuration.

Table 977. Attributes summary
Name Type Summary

assignment_method

BootProtocol

Sets the boot protocol used to assign the IP configuration for a network device.

ip

Ip

Sets the IP configuration for a network device.

6.127. IpVersion enum

Defines the values for the IP protocol version.

Table 978. Values summary
Name Summary

v4

IPv4.

v6

IPv6.

6.128. IscsiBond struct

Table 979. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 980. Links summary
Name Type Summary

data_center

DataCenter

networks

Network[]

storage_connections

StorageConnection[]

6.129. IscsiDetails struct

Table 981. Attributes summary
Name Type Summary

address

String

disk_id

String

initiator

String

lun_mapping

Integer

password

String

paths

Integer

port

Integer

portal

String

product_id

String

serial

String

size

Integer

status

String

storage_domain_id

String

target

String

username

String

vendor_id

String

volume_group_id

String

6.130. Job struct

Represents a job, which monitors execution of a flow in the system. A job can contain multiple steps in a hierarchic structure. The steps can be processed in parallel, depends on the implementation of the flow.

Table 982. Attributes summary
Name Type Summary

auto_cleared

Boolean

Indicates if the job should be cleared automatically after it was completed by the system.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

end_time

Date

The end time of the job.

external

Boolean

Indicates if the job is originated by an external system.

id

String

A unique identifier.

last_updated

Date

The last update date of the job.

name

String

A human-readable name in plain text.

start_time

Date

The start time of the job.

status

JobStatus

The status of the job.

6.130.1. external

Indicates if the job is originated by an external system. External jobs are managed externally, by the creator of the job.

Table 983. Links summary
Name Type Summary

owner

User

The user who is the owner of the job.

steps

Step[]

The steps of the job.

6.131. JobStatus enum

Represents the status of the job.

Table 984. Values summary
Name Summary

aborted

The aborted job status.

failed

The failed job status.

finished

The finished job status.

started

The started job status.

unknown

The unknown job status.

6.131.1. aborted

The aborted job status. This status is applicable for an external job that was forcibly aborted.

6.131.2. finished

The finished job status. This status describes a completed job execution.

6.131.3. started

The started job status. This status represents a job which is currently being executed.

6.131.4. unknown

The unknown job status. This status represents jobs which their resolution is not known, i.e. jobs that were executed before the system was unexpectedly restarted.

6.132. KatelloErratum struct

Type representing a Katello erratum.

Table 985. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

issued

Date

The date when the Katello erratum was issued.

name

String

A human-readable name in plain text.

packages

Package[]

The list of packages which solve the issue reported by the Katello erratum.

severity

String

The severity of the Katello erratum.

solution

String

The solution for the issue described by the Katello erratum.

summary

String

The summary of the Katello erratum.

title

String

The title of the Katello erratum.

type

String

The type of the Katello erratum.

6.132.1. severity

The severity of the Katello erratum.

The supported severities are moderate, important or critical.

6.132.2. type

The type of the Katello erratum.

The supported types are bugfix, enhancement or security.

Table 986. Links summary
Name Type Summary

host

Host

Reference to the host that the Katello erratum is assigned to.

vm

Vm

Reference to the virtual machine that the Katello erratum is assigned to.

6.133. KdumpStatus enum

Table 987. Values summary
Name Summary

disabled

enabled

unknown

6.134. Kernel struct

Table 988. Attributes summary
Name Type Summary

version

Version

6.135. Ksm struct

Table 989. Attributes summary
Name Type Summary

enabled

Boolean

merge_across_nodes

Boolean

6.136. LogSeverity enum

Enum representing a severity of an event.

Table 990. Values summary
Name Summary

alert

Alert severity.

error

Error severity.

normal

Normal severity.

warning

Warning severity.

6.136.1. alert

Alert severity. Used to specify a condition that requires an immediate attention.

6.136.2. error

Error severity. Used to specify that there is an error that needs to be examined.

6.136.3. normal

Normal severity. Used for information events.

6.136.4. warning

Warning severity. Used to warn something might be wrong.

6.137. LogicalUnit struct

Table 991. Attributes summary
Name Type Summary

address

String

discard_max_size

Integer

The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation.

discard_zeroes_data

Boolean

True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros.

disk_id

String

id

String

lun_mapping

Integer

password

String

paths

Integer

port

Integer

portal

String

product_id

String

serial

String

size

Integer

status

LunStatus

storage_domain_id

String

target

String

username

String

vendor_id

String

volume_group_id

String

6.137.1. discard_max_size

The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation. A value of 0 means that the device does not support discard functionality.

This is the software limit, and not the hardware limit, as noted in the documentation of queue-sysfs for discard_max_bytes.

6.137.2. discard_zeroes_data

True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros. For more information please see the documentation of queue-sysfs for discard_zeroes_data.

6.138. LunStatus enum

Table 992. Values summary
Name Summary

free

unusable

used

6.139. Mac struct

Table 993. Attributes summary
Name Type Summary

address

String

6.140. MacPool struct

Represents a MAC address pool.

Example of an XML representation of a MAC address pool:

<mac_pool href="/ovirt-engine/api/macpools/123" id="123">
  <name>Default</name>
  <description>Default MAC pool</description>
  <allow_duplicates>false</allow_duplicates>
  <default_pool>true</default_pool>
  <ranges>
    <range>
      <from>00:1A:4A:16:01:51</from>
      <to>00:1A:4A:16:01:E6</to>
    </range>
  </ranges>
</mac_pool>
Table 994. Attributes summary
Name Type Summary

allow_duplicates

Boolean

Defines whether duplicate MAC addresses are permitted in the pool.

comment

String

Free text containing comments about this object.

default_pool

Boolean

Defines whether this is the default pool.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

ranges

Range[]

Defines the range of MAC addresses for the pool.

6.140.1. allow_duplicates

Defines whether duplicate MAC addresses are permitted in the pool. If not specified, defaults to false.

6.140.2. default_pool

Defines whether this is the default pool. If not specified, defaults to false.

6.140.3. ranges

Defines the range of MAC addresses for the pool. Multiple ranges can be defined.

6.141. MemoryOverCommit struct

Table 995. Attributes summary
Name Type Summary

percent

Integer

6.142. MemoryPolicy struct

Logical grouping of memory related properties of virtual machine-like entities.

Table 996. Attributes summary
Name Type Summary

ballooning

Boolean

guaranteed

Integer

max

Integer

Maximum virtual machine’s memory, in bytes.

over_commit

MemoryOverCommit

transparent_huge_pages

TransparentHugePages

6.142.1. max

Maximum virtual machine’s memory, in bytes.

The user provides the value in bytes, and the engine rounds the value down to the nearest lower MiB value.

For example, if the user enters a value of 1073741825 (1 GiB + 1 byte), then the oVirt Engine will truncate that value to the nearest lower MiB boundary: in this case 1073741824 (1 GiB).

6.143. MessageBrokerType enum

Table 997. Values summary
Name Summary

qpid

rabbit_mq

6.144. Method struct

Table 998. Attributes summary
Name Type Summary

id

SsoMethod

6.145. MigrateOnError enum

Table 999. Values summary
Name Summary

do_not_migrate

migrate

migrate_highly_available

6.146. MigrationBandwidth struct

Defines the bandwidth used by migration.

Table 1000. Attributes summary
Name Type Summary

assignment_method

MigrationBandwidthAssignmentMethod

The method used to assign the bandwidth.

custom_value

Integer

Custom bandwidth in Mbps.

6.146.1. custom_value

Custom bandwidth in Mbps. Will be applied only if the assignmentMethod attribute is custom.

6.147. MigrationBandwidthAssignmentMethod enum

Defines the method how the migration bandwidth is assigned.

Table 1001. Values summary
Name Summary

auto

Takes the bandwidth from QoS if QoS defined.

custom

Custom defined bandwidth in Mbit/s.

hypervisor_default

Takes the value as configured on the hypervisor.

6.147.1. auto

Takes the bandwidth from QoS if QoS defined. If not, taken from detected link speed being used. If nothing detected, falls back to hypervisor_default value.

6.148. MigrationOptions struct

Table 1002. Attributes summary
Name Type Summary

auto_converge

InheritableBoolean

bandwidth

MigrationBandwidth

The bandwidth which is allowed to be used by the migrations.

compressed

InheritableBoolean
Table 1003. Links summary
Name Type Summary

policy

MigrationPolicy

Reference to the migration policy as defined using engine-config.

6.149. MigrationPolicy struct

A policy describing how the migration is going to be treated (convergence, how many parallel migrations allowed).

Table 1004. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

6.150. Network struct

Logical network.

An example of the JSON representation of a logical network:

{
  "network" : [ {
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "stp" : "false",
    "mtu" : "0",
    "usages" : {
      "usage" : [ "vm" ]
    },
    "name" : "ovirtmgmt",
    "description" : "Management Network",
    "href" : "/ovirt-engine/api/networks/456",
    "id" : "456",
    "link" : [ {
      "href" : "/ovirt-engine/api/networks/456/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/networks/456/vnicprofiles",
      "rel" : "vnicprofiles"
    }, {
      "href" : "/ovirt-engine/api/networks/456/labels",
      "rel" : "labels"
    } ]
  } ]
}

An example of the XML representation of the same logical network:

<network href="/ovirt-engine/api/networks/456" id="456">
  <name>ovirtmgmt</name>
  <description>Management Network</description>
  <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
  <stp>false</stp>
  <mtu>0</mtu>
  <usages>
    <usage>vm</usage>
  </usages>
</network>
Table 1005. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

display

Boolean

dns_resolver_configuration

DnsResolverConfiguration

id

String

A unique identifier.

ip

Ip

mtu

Integer

Specifies the maximum transmission unit for the network.

name

String

A human-readable name in plain text.

profile_required

Boolean

required

Boolean

status

NetworkStatus

stp

Boolean

Specifies whether spanning tree protocol is enabled for the network.

usages

NetworkUsage[]

Defines a set of usage elements for the network.

vlan

Vlan

6.150.1. usages

Defines a set of usage elements for the network.

Users can, for example, specify that the network is to be used for virtual machine traffic and also for display traffic with the vm and display values.

Table 1006. Links summary
Name Type Summary

cluster

Cluster

data_center

DataCenter

A reference to the data center of which the network is a member.

network_labels

NetworkLabel[]

A reference to the labels assigned to the network.

permissions

Permission[]

A reference to the permissions of the network.

qos

Qos

vnic_profiles

VnicProfile[]

A reference to the profiles of the network.

6.151. NetworkAttachment struct

Describes how a host connects to a network.

An XML representation of a network attachment on a host:

<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789">
  <network href="/ovirt-engine/api/networks/234" id="234"/>
  <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/>
  <in_sync>true</in_sync>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>192.168.122.39</address>
        <gateway>192.168.122.1</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
  <reported_configurations>
    <reported_configuration>
      <name>mtu</name>
      <expected_value>1500</expected_value>
      <actual_value>1500</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    <reported_configuration>
      <name>bridged</name>
      <expected_value>true</expected_value>
      <actual_value>true</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

When attaching a network to a network interface card, the network element is required, with either an id or a name.

For example, to attach a network to a host network interface card, send a request like this:

POST /ovirt-engine/api/hosts/123/nics/456/networkattachments

With a request body like this:

<networkattachment>
  <network id="234"/>
</networkattachment>

To attach a newtwork to a host, send a request like this:

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

With a request body like this:

<network_attachment>
  <network id="234"/>
  <host_nic id="456"/>
</network_attachment>

The ip_address_assignments and properties elements are updatable post-creation.

For example to update a newtork attachment, send a request like this:

PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

With a request body like this:

<network_attachment>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>7.1.1.1</address>
        <gateway>7.1.1.2</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
</network_attachment>

To detach a network from the network interface card send a request like this:

DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
Changes to network attachment configuration must be explicitly committed.

An XML representation of a network attachment’s properties sub-collection:

<network_attachment>
  <properties>
    <property>
      <name>bridge_opts</name>
      <value>
        forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1
      </value>
    </property>
  </properties>
  ...
</network_attachment>
Table 1007. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

dns_resolver_configuration

DnsResolverConfiguration

DNS resolver configuration.

id

String

A unique identifier.

in_sync

Boolean

ip_address_assignments

IpAddressAssignment[]

The IP configuration of the network.

name

String

A human-readable name in plain text.

properties

Property[]

Defines custom properties for the network configuration.

reported_configurations

ReportedConfiguration[]

A read-only list of configuration properties.

6.151.1. dns_resolver_configuration

DNS resolver configuration. Will be reported when retrieving network attachment using GET. Optional both when creating a new network attachment or updating existing one.

6.151.2. properties

Defines custom properties for the network configuration.

Bridge options have the set name of bridge_opts. Separate multiple entries with a whitespace character. The following keys are valid for bridge_opts:

Name Default value

forward_delay

1500

gc_timer

3765

group_addr

1:80:c2:0:0:0

group_fwd_mask

0x0

hash_elasticity

4

hash_max

512

hello_time

200

hello_timer

70

max_age

2000

multicast_last_member_count

2

multicast_last_member_interval

100

multicast_membership_interval

26000

multicast_querier

0

multicast_querier_interval

25500

multicast_query_interval

13000

multicast_query_response_interval

1000

multicast_query_use_ifaddr

0

multicast_router

1

multicast_snooping

1

multicast_startup_query_count

2

multicast_startup_query_interval

3125
Table 1008. Links summary
Name Type Summary

host

Host

host_nic

HostNic

A reference to the host network interface.

network

Network

A reference to the network to which the interface is attached.

qos

Qos

6.152. NetworkConfiguration struct

Table 1009. Attributes summary
Name Type Summary

dns

Dns

nics

Nic[]

6.153. NetworkFilter struct

Network filter enables to filter packets send to/from the VM’s nic according to defined rules.

There are several types of network filters supported based on libvirt. More details about the different network filters can be found here.

In addition to libvirt’s network filters, there are two additional network filters: The first called vdsm-no-mac-spoofing, composed of no-mac-spoofing and no-arp-mac-spoofing. The second called ovirt-no-filter is used when no network filter is to be defined for the VM’s nic. ovirt-no-filter network filter is only used for internal implementation, and doesn’t exist on the nics.

This is a example of the XML representation:

<network_filter id="00000019-0019-0019-0019-00000000026c">
  <name>example-filter</name>
  <version>
    <major>4</major>
    <minor>0</minor>
    <build>-1</build>
    <revision>-1</revision>
  </version>
</network_filter>

If any part of the version is not present, it is represented by -1.

Table 1010. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

version

Version

Represent the minimal supported version of the specific NetworkFilter for which it was first introduced.

6.154. NetworkFilterParameter struct

Parameter for the network filter.

See Libvirt-Filters for further details. This is a example of the XML representation:

<network_filter_parameter id="123">
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>
Table 1011. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

value

String

Represents the value of the parameter.

6.155. NetworkLabel struct

Represents a label which can be added to a host network interface.

Table 1012. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1013. Links summary
Name Type Summary

host_nic

HostNic

network

Network

6.156. NetworkPluginType enum

Table 1014. Values summary
Name Summary

open_vswitch

6.157. NetworkStatus enum

Table 1015. Values summary
Name Summary

non_operational

operational

6.158. NetworkUsage enum

Table 1016. Values summary
Name Summary

default_route

The default gateway and the DNS resolver configuration of the host will be taken from this network.

display

gluster

The network will be used for Gluster(bricks) data traffic.

management

migration

vm

6.158.1. default_route

The default gateway and the DNS resolver configuration of the host will be taken from this network.

If this network is attached to the host, then the DNS resolver configuration will be taken from the dns_resolver_configuration attribute of the network attachment. If there is no dns_resolver_configuration attribute in this network attachment, then they will be taken from the dns_resolver_configuration of the network itself. If dns_resolver_configuration attribute isn’t present even there, DNS resolver configuration won’t be set.

If you set this flag on a network, then the the default gateway for the host will be taken from the gateway attribute of the ip_address_assignment of the network attachment.

6.159. NfsProfileDetail struct

Table 1017. Attributes summary
Name Type Summary

nfs_server_ip

String

profile_details

ProfileDetail[]

6.160. NfsVersion enum

Table 1018. Values summary
Name Summary

auto

v3

v4

v4_1

v4_2

NFS 4.

6.160.1. v4_2

NFS 4.2.

6.161. Nic struct

Represents a NIC of a virtual machine.

For example, the XML representation of a NIC will look like this:

<nic href="/ovirt-engine/api/vms/123/nics/456" id="456">
  <name>nic1</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <interface>virtio</interface>
  <linked>true</linked>
  <mac>
    <address>02:00:00:00:00:00</address>
  </mac>
  <plugged>true</plugged>
  <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/>
</nic>
Table 1019. Attributes summary
Name Type Summary

boot_protocol

BootProtocol

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

interface

NicInterface

The type of driver used for the NIC.

linked

Boolean

Defines if the NIC is linked to the virtual machine.

mac

Mac

The MAC address of the interface.

name

String

A human-readable name in plain text.

on_boot

Boolean

plugged

Boolean

Defines if the NIC is plugged in to the virtual machine.
Table 1020. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

network

Network

A reference to the network which the interface should be connected to.

network_attachments

NetworkAttachment[]

network_filter_parameters

NetworkFilterParameter[]

Link to the network filter parameters.

network_labels

NetworkLabel[]

reported_devices

ReportedDevice[]

statistics

Statistic[]

A link to the statistics for the NIC.

template

Template

Optionally references to a template the device is used by.

virtual_function_allowed_labels

NetworkLabel[]

virtual_function_allowed_networks

Network[]

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

vnic_profile

VnicProfile

6.161.1. network

A reference to the network which the interface should be connected to. A blank network id is allowed.

Usage of this element for creating or updating a NIC is deprecated, use vnic_profile instead. It is preserved because it is still in use by the initialization element, as a holder for IP addresses and other network details.

6.161.2. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.162. NicConfiguration struct

The type describes the configuration of a virtual network interface.

Table 1021. Attributes summary
Name Type Summary

boot_protocol

BootProtocol

IPv4 boot protocol.

ip

Ip

IPv4 address details.

ipv6

Ip

IPv6 address details.

ipv6_boot_protocol

BootProtocol

IPv6 boot protocol.

name

String

Network interface name.

on_boot

Boolean

Specifies whether the network interface should be activated on the virtual machine guest operating system boot.

6.163. NicInterface enum

Table 1022. Values summary
Name Summary

e1000

pci_passthrough

rtl8139

rtl8139_virtio

spapr_vlan

virtio

6.164. NicStatus enum

Table 1023. Values summary
Name Summary

down

up

6.165. NumaNode struct

Represents a physical NUMA node.

Example XML representation:

<host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>65536</memory>
  <node_distance>40 20 40 10</node_distance>
  <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/>
</host_numa_node>
Table 1024. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

cpu

Cpu

description

String

A human-readable description in plain text.

id

String

A unique identifier.

index

Integer

memory

Integer

Memory of the NUMA node in MB.

name

String

A human-readable name in plain text.

node_distance

String
Table 1025. Links summary
Name Type Summary

host

Host

statistics

Statistic[]

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

6.165.1. statistics

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

An example of an XML representation:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>
This statistics sub-collection is read-only.

The following list shows the statistic types for a host NUMA node:

Name Description

memory.total

Total memory in bytes on the NUMA node.

memory.used

Memory in bytes used on the NUMA node.

memory.free

Memory in bytes free on the NUMA node.

cpu.current.user

Percentage of CPU usage for user slice.

cpu.current.system

Percentage of CPU usage for system.

cpu.current.idle

Percentage of idle CPU usage.

6.166. NumaNodePin struct

Represents the pinning of a virtual NUMA node to a physical NUMA node.

Table 1026. Attributes summary
Name Type Summary

host_numa_node

NumaNode

Deprecated.

index

Integer

The index of a physical NUMA node to which the virtual NUMA node is pinned.

pinned

Boolean

Deprecated.

6.166.1. host_numa_node

Deprecated. Has no function.

6.166.2. pinned

Deprecated. Should always be true.

6.167. NumaTuneMode enum

Table 1027. Values summary
Name Summary

interleave

preferred

strict

6.168. OpenStackImage struct

Table 1028. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1029. Links summary
Name Type Summary

openstack_image_provider

OpenStackImageProvider

6.169. OpenStackImageProvider struct

Table 1030. Attributes summary
Name Type Summary

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

properties

Property[]

Array of provider name/value properties.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

tenant_name

String

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.169.1. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

Table 1031. Links summary
Name Type Summary

certificates

Certificate[]

images

OpenStackImage[]

6.170. OpenStackNetwork struct

Table 1032. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1033. Links summary
Name Type Summary

openstack_network_provider

OpenStackNetworkProvider

6.171. OpenStackNetworkProvider struct

Table 1034. Attributes summary
Name Type Summary

agent_configuration

AgentConfiguration

Agent configuration settings.

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

plugin_type

NetworkPluginType

Network plugin type.

properties

Property[]

Array of provider name/value properties.

read_only

Boolean

Indicates whether the provider is read-only.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

tenant_name

String

type

OpenStackNetworkProviderType

The type of provider.

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.171.1. read_only

Indicates whether the provider is read-only.

A read-only provider does not allow adding, modifying, or deleting of networks or subnets. Port-related operations are allowed, as they are required for the provisioning of virtual NICs.

6.171.2. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

Table 1035. Links summary
Name Type Summary

certificates

Certificate[]

Reference to the certificates list.

networks

OpenStackNetwork[]

Reference to OpenStack networks list.

subnets

OpenStackSubnet[]

Reference to OpenStack networks subnets list.

6.172. OpenStackNetworkProviderType enum

The OpenStack network provider can either be implemented by OpenStack Neutron, in which case the Neutron agent is automatically installed on the hosts, or it can be an external provider implementing the OpenStack API, in which case the virtual interface driver is a custom solution installed manually.

Table 1036. Values summary
Name Summary

external

Indicates that the provider is an external one, implementing the OpenStack Neutron API.

neutron

Indicates that the provider is OpenStack Neutron.

6.172.1. external

Indicates that the provider is an external one, implementing the OpenStack Neutron API. The virtual interface driver in this case is implemented by the external provider.

6.172.2. neutron

Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent is used as the virtual interface driver.

6.173. OpenStackProvider struct

Table 1037. Attributes summary
Name Type Summary

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

properties

Property[]

Array of provider name/value properties.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

tenant_name

String

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.173.1. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

6.174. OpenStackSubnet struct

Table 1038. Attributes summary
Name Type Summary

cidr

String

Defines network CIDR.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

dns_servers

String[]

Defines a list of DNS servers.

gateway

String

Defines IP gateway.

id

String

A unique identifier.

ip_version

String

Defines IP version.

name

String

A human-readable name in plain text.

6.174.1. ip_version

Defines IP version.

Values can be v4' for IPv4 or `v6 for IPv6.

Table 1039. Links summary
Name Type Summary

openstack_network

OpenStackNetwork

Reference to the service managing the OpenStack network.

6.175. OpenStackVolumeProvider struct

Table 1040. Attributes summary
Name Type Summary

authentication_url

String

Defines the external provider authentication URL address.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

Defines password for the user during the authentication process.

properties

Property[]

Array of provider name/value properties.

requires_authentication

Boolean

Defines whether provider authentication is required or not.

tenant_name

String

url

String

Defines URL address of the external provider.

username

String

Defines user name to be used during authentication process.

6.175.1. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

Table 1041. Links summary
Name Type Summary

authentication_keys

OpenstackVolumeAuthenticationKey[]

certificates

Certificate[]

data_center

DataCenter

volume_types

OpenStackVolumeType[]

6.176. OpenStackVolumeType struct

Table 1042. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

properties

Property[]
Table 1043. Links summary
Name Type Summary

openstack_volume_provider

OpenStackVolumeProvider

6.177. OpenstackVolumeAuthenticationKey struct

Table 1044. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

creation_date

Date

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

usage_type

OpenstackVolumeAuthenticationKeyUsageType

uuid

String

value

String
Table 1045. Links summary
Name Type Summary

openstack_volume_provider

OpenStackVolumeProvider

6.178. OpenstackVolumeAuthenticationKeyUsageType enum

Table 1046. Values summary
Name Summary

ceph

6.179. OperatingSystem struct

Information describing the operating system. This is used for both virtual machines and hosts.

Table 1047. Attributes summary
Name Type Summary

boot

Boot

cmdline

String

custom_kernel_cmdline

String

A custom part of the host kernel command line.

initrd

String

kernel

String

reported_kernel_cmdline

String

The host kernel command line as reported by a running host.

type

String

version

Version

6.179.1. custom_kernel_cmdline

A custom part of the host kernel command line. This will be merged with the existing kernel command line.

You must reinstall and then reboot the host to apply the changes implemented by this attribute.

During each host deploy procedure, kernel parameters that were added in the previous host deploy procedure are removed using grubby --update-kernel DEFAULT --remove-args <previous_custom_params>, and the current kernel command line customization is applied using grubby --update-kernel DEFAULT --args <custom_params>. The Manager internally keeps track of the last-applied kernel parameters customization.

This attribute is currently only used for hosts.

6.179.2. reported_kernel_cmdline

The host kernel command line as reported by a running host.

This is a read-only attribute. Attempts to change this attribute are silently ignored.

This attribute is currently only used for hosts.

6.180. OperatingSystemInfo struct

Table 1048. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

large_icon

Icon

name

String

A human-readable name in plain text.

small_icon

Icon

6.181. Option struct

Table 1049. Attributes summary
Name Type Summary

name

String

type

String

value

String

6.182. OsType enum

Table 1050. Values summary
Name Summary

other

other_linux

rhel_3

rhel_3x64

rhel_4

rhel_4x64

rhel_5

rhel_5x64

rhel_6

rhel_6x64

unassigned

windows_2003

windows_2003x64

windows_2008

windows_2008r2x64

windows_2008x64

windows_2012x64

windows_7

windows_7x64

windows_8

windows_8x64

windows_xp

6.183. Package struct

Type representing a package.

This is an example of the package element:

<package>
  <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
</package>
Table 1051. Attributes summary
Name Type Summary

name

String

The name of the package.

6.184. Payload struct

Table 1052. Attributes summary
Name Type Summary

files

File[]

type

VmDeviceType

volume_id

String

6.185. PayloadEncoding enum

Table 1053. Values summary
Name Summary

base64

plaintext

6.186. Permission struct

Table 1054. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1055. Links summary
Name Type Summary

cluster

Cluster

data_center

DataCenter

disk

Disk

group

Group

host

Host

role

Role

storage_domain

StorageDomain

template

Template

user

User

vm

Vm

vm_pool

VmPool

6.187. Permit struct

Type represents a permit.

Table 1056. Attributes summary
Name Type Summary

administrative

Boolean

Specifies whether permit is administrative or not.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1057. Links summary
Name Type Summary

role

Role

Reference to the role the permit belongs to.

6.188. PmProxy struct

Table 1058. Attributes summary
Name Type Summary

type

PmProxyType

6.189. PmProxyType enum

Table 1059. Values summary
Name Summary

cluster

The fence proxy is selected from the same cluster as the fenced host.

dc

The fence proxy is selected from the same data center as the fenced host.

other_dc

The fence proxy is selected from a different data center than the fenced host.

6.190. PolicyUnitType enum

Holds the types of all internal policy unit types.

Table 1060. Values summary
Name Summary

filter

load_balancing

weight

6.191. PortMirroring struct

6.192. PowerManagement struct

Table 1061. Attributes summary
Name Type Summary

address

String

The host name or IP address of the host.

agents

Agent[]

Specifies fence agent options when multiple fences are used.

automatic_pm_enabled

Boolean

Toggles the automated power control of the host in order to save energy.

enabled

Boolean

Indicates whether power management configuration is enabled or disabled.

kdump_detection

Boolean

Toggles whether to determine if kdump is running on the host before it is shut down.

options

Option[]

Fencing options for the selected type= specified with the option name="" and value="" strings.

password

String

A valid, robust password for power management.

pm_proxies

PmProxy[]

Determines the power management proxy.

status

PowerManagementStatus

Determines the power status of the host.

type

String

Fencing device code.

username

String

A valid user name for power management.

6.192.1. agents

Specifies fence agent options when multiple fences are used.

Use the order sub-element to prioritize the fence agents. Agents are run sequentially according to their order until the fence action succeeds. When two or more fence agents have the same order, they are run concurrently. Other sub-elements include type, ip, user, password, and options.

6.192.2. automatic_pm_enabled

Toggles the automated power control of the host in order to save energy. When set to true, the host will be automatically powered down if the cluster’s load is low, and powered on again when required. This is set to true when a host is created, unless disabled by the user.

6.192.3. kdump_detection

Toggles whether to determine if kdump is running on the host before it is shut down. When set to true, the host will not shut down during a kdump process. This is set to true when a host has power management enabled, unless disabled by the user.

6.192.4. type

Fencing device code.

A list of valid fencing device codes are available in the capabilities collection.

6.193. PowerManagementStatus enum

Table 1062. Values summary
Name Summary

off

Host is OFF.

on

Host is ON.

unknown

Unknown status.

6.194. Product struct

Table 1063. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

6.195. ProductInfo struct

Product information.

The entry point contains a product_info element to help an API user determine the legitimacy of the oVirt environment. This includes the name of the product, the vendor and the version.

Verify a genuine oVirt environment

The follow elements identify a genuine oVirt environment:

<api>
...
<product_info>
  <name>oVirt Engine</name>
  <vendor>ovirt.org</vendor>
  <version>
    <build>0</build>
    <full_version>4.1.0_master</full_version>
    <major>4</major>
    <minor>1</minor>
    <revision>0</revision>
  </version>
</product_info>
...
</api>
Table 1064. Attributes summary
Name Type Summary

name

String

The name of the product, for example oVirt Engine.

vendor

String

The name of the vendor, for example `ovirt.

version

Version

The version number of the product.

6.195.1. vendor

The name of the vendor, for example ovirt.org.

6.196. ProfileDetail struct

Table 1065. Attributes summary
Name Type Summary

block_statistics

BlockStatistic[]

duration

Integer

fop_statistics

FopStatistic[]

profile_type

String

statistics

Statistic[]

6.197. Property struct

Table 1066. Attributes summary
Name Type Summary

name

String

value

String

6.198. ProxyTicket struct

Table 1067. Attributes summary
Name Type Summary

value

String

6.199. QcowVersion enum

The QCOW version specifies to the qemu which qemu version the volume supports.

This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 version 2 volumes, while V4 storage domains also support QCOW2 version 3. For more information about features of the different QCOW versions, see here.

Table 1068. Values summary
Name Summary

qcow2_v2

The Copy On Write default compatibility version It means that every QEMU can use it.

qcow2_v3

The Copy On Write compatibility version which was introduced in QEMU 1.

6.199.1. qcow2_v3

The Copy On Write compatibility version which was introduced in QEMU 1.1 It means that the new format is in use.

6.200. Qos struct

This type represents the attributes to define Quality of service (QoS).

For storage the type is storage, the attributes max_throughput, max_read_throughput, max_write_throughput, max_iops, max_read_iops and max_write_iops are relevant.

For resources with computing capabilities the type is cpu, the attribute cpu_limit is relevant.

For virtual machines networks the type is network, the attributes inbound_average, inbound_peak, inbound_burst, outbound_average, outbound_peak and outbound_burst are relevant.

For host networks the type is hostnetwork, the attributes outbound_average_linkshare, outbound_average_upperlimit and outbound_average_realtime are relevant.

Table 1069. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

cpu_limit

Integer

The maximum processing capability in %.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

inbound_average

Integer

The desired average inbound bit rate in Mbps.

inbound_burst

Integer

The amount of data that can be delivered in a single burst in MiB.

inbound_peak

Integer

The maximum inbound rate in Mbps.

max_iops

Integer

Maximum permitted number of input and output operations per second.

max_read_iops

Integer

Maximum permitted number of input operations per second.

max_read_throughput

Integer

Maximum permitted throughput for read operations.

max_throughput

Integer

Maximum permitted total throughput.

max_write_iops

Integer

Maximum permitted number of output operations per second.

max_write_throughput

Integer

Maximum permitted throughput for write operations.

name

String

A human-readable name in plain text.

outbound_average

Integer

The desired average outbound bit rate in Mbps.

outbound_average_linkshare

Integer

Weighted share.

outbound_average_realtime

Integer

The committed rate in Mbps.

outbound_average_upperlimit

Integer

The maximum bandwidth to be used by a network in Mbps.

outbound_burst

Integer

The amount of data that can be sent in a single burst in MiB.

outbound_peak

Integer

The maximum outbound rate in Mbps.

type

QosType

The kind of resources this entry can be assigned.

6.200.1. cpu_limit

The maximum processing capability in %.

Used to configure computing resources.

6.200.2. inbound_average

The desired average inbound bit rate in Mbps.

Used to configure virtual machines networks. If defined, inbound_peak and inbound_burst also has to be set.

See Libvirt-QOS for further details.

6.200.3. inbound_burst

The amount of data that can be delivered in a single burst in MiB.

Used to configure virtual machines networks. If defined, inbound_average and inbound_peak also has to be set.

See Libvirt-QOS for further details.

6.200.4. inbound_peak

The maximum inbound rate in Mbps.

Used to configure virtual machines networks. If defined, inbound_average and inbound_burst also has to be set.

See Libvirt-QOS for further details.

6.200.5. max_iops

Maximum permitted number of input and output operations per second.

Used to configure storage. Must not be set if max_read_iops or max_write_iops is set.

6.200.6. max_read_iops

Maximum permitted number of input operations per second.

Used to configure storage. Must not be set if max_iops is set.

6.200.7. max_read_throughput

Maximum permitted throughput for read operations.

Used to configure storage. Must not be set if max_throughput is set.

6.200.8. max_throughput

Maximum permitted total throughput.

Used to configure storage. Must not be set if max_read_throughput or max_write_throughput is set.

6.200.9. max_write_iops

Maximum permitted number of output operations per second.

Used to configure storage. Must not be set if max_iops is set.

6.200.10. max_write_throughput

Maximum permitted throughput for write operations.

Used to configure storage. Must not be set if max_throughput is set.

6.200.11. outbound_average

The desired average outbound bit rate in Mbps.

Used to configure virtual machines networks. If defined, outbound_peak and outbound_burst also has to be set.

See Libvirt-QOS for further details.

6.200.12. outbound_average_linkshare

Weighted share.

Used to configure host networks. Signifies how much of the logical link’s capacity a specific network should be allocated, relative to the other networks attached to the same logical link. The exact share depends on the sum of shares of all networks on that link. By default this is a number in the range 1-100.

6.200.13. outbound_average_realtime

The committed rate in Mbps.

Used to configure host networks. The minimum bandwidth required by a network. The committed rate requested is not guaranteed and will vary depending on the network infrastructure and the committed rate requested by other networks on the same logical link.

6.200.14. outbound_average_upperlimit

The maximum bandwidth to be used by a network in Mbps.

Used to configure host networks. If outboundAverageUpperlimit and outbound_average_realtime are provided, the outbound_averageUpperlimit must not be lower than the outbound_average_realtime.

See Libvirt-QOS for further details.

6.200.15. outbound_burst

The amount of data that can be sent in a single burst in MiB.

Used to configure virtual machines networks. If defined, outbound_average and outbound_peak also has to be set.

See Libvirt-QOS for further details.

6.200.16. outbound_peak

The maximum outbound rate in Mbps.

Used to configure virtual machines networks. If defined, outbound_average and outbound_burst also has to be set.

See Libvirt-QOS for further details.

Table 1070. Links summary
Name Type Summary

data_center

DataCenter

The data center the QoS is assiciated to.

6.201. QosType enum

This type represents the kind of resource the Quality of service (QoS) can be assigned to.

Table 1071. Values summary
Name Summary

cpu

The Quality of service (QoS) can be assigned to resources with computing capabilities.

hostnetwork

The Quality of service (QoS) can be assigned to host networks.

network

The Quality of service (QoS) can be assigned to virtual machines networks.

storage

The Quality of service (QoS) can be assigned to storage.

6.202. Quota struct

Represents a quota object.

An example XML representation of a quota:

<quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc">
  <name>My Quota</name>
  <description>A quota for my oVirt environment</description>
  <cluster_hard_limit_pct>0</cluster_hard_limit_pct>
  <cluster_soft_limit_pct>0</cluster_soft_limit_pct>
  <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/>
  <storage_hard_limit_pct>0</storage_hard_limit_pct>
  <storage_soft_limit_pct>0</storage_soft_limit_pct>
</quota>
Table 1072. Attributes summary
Name Type Summary

cluster_hard_limit_pct

Integer

cluster_soft_limit_pct

Integer

comment

String

Free text containing comments about this object.

data_center

DataCenter

description

String

A human-readable description in plain text.

disks

Disk[]

id

String

A unique identifier.

name

String

A human-readable name in plain text.

storage_hard_limit_pct

Integer

storage_soft_limit_pct

Integer

users

User[]

vms

Vm[]
Table 1073. Links summary
Name Type Summary

permissions

Permission[]

quota_cluster_limits

QuotaClusterLimit[]

quota_storage_limits

QuotaStorageLimit[]

6.203. QuotaClusterLimit struct

Table 1074. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

memory_limit

Decimal

memory_usage

Decimal

name

String

A human-readable name in plain text.

vcpu_limit

Integer

vcpu_usage

Integer
Table 1075. Links summary
Name Type Summary

cluster

Cluster

quota

Quota

6.204. QuotaModeType enum

Table 1076. Values summary
Name Summary

audit

disabled

enabled

6.205. QuotaStorageLimit struct

Table 1077. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

limit

Integer

name

String

A human-readable name in plain text.

usage

Decimal
Table 1078. Links summary
Name Type Summary

quota

Quota

storage_domain

StorageDomain

6.206. Range struct

Table 1079. Attributes summary
Name Type Summary

from

String

to

String

6.207. Rate struct

Determines maximum speed of consumption of bytes from random number generator device.

Table 1080. Attributes summary
Name Type Summary

bytes

Integer

Number of bytes allowed to consume per period.

period

Integer

Duration of one period in milliseconds.

6.208. ReportedConfiguration struct

Table 1081. Attributes summary
Name Type Summary

actual_value

String

expected_value

String

in_sync

Boolean

false when the network attachment contains uncommitted network configuration.

name

String

6.209. ReportedDevice struct

Table 1082. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

ips

Ip[]

mac

Mac

name

String

A human-readable name in plain text.

type

ReportedDeviceType
Table 1083. Links summary
Name Type Summary

vm

Vm

6.210. ReportedDeviceType enum

Table 1084. Values summary
Name Summary

network

6.211. ResolutionType enum

Table 1085. Values summary
Name Summary

add

copy

6.212. RngDevice struct

Random number generator (RNG) device model.

Table 1086. Attributes summary
Name Type Summary

rate

Rate

Determines maximum speed of consumption of bytes from random number generator device.

source

RngSource

Backend of the random number generator device.

6.213. RngSource enum

Representing the random generator backend types.

Table 1087. Values summary
Name Summary

hwrng

Obtains random data from the /dev/hwrng (usually specialized HW generator) device.

random

Obtains random data from the /dev/random device.

urandom

Obtains random data from the /dev/urandom device.

6.213.1. urandom

Obtains random data from the /dev/urandom device.

This RNG source is meant to replace random RNG source for non-cluster-aware entities (i.e. Blank template and instance types) and entities associated with clusters with compatibility version 4.1 or higher.

6.214. Role struct

Represents a system role.

Table 1088. Attributes summary
Name Type Summary

administrative

Boolean

Defines the role as administrative-only or not.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

mutable

Boolean

Defines the ability to update or delete the role.

name

String

A human-readable name in plain text.

6.214.1. mutable

Defines the ability to update or delete the role.

Roles with mutable set to false are predefined roles.

Table 1089. Links summary
Name Type Summary

permits

Permit[]

A link to the permits sub-collection for role permits.

user

User

6.215. RoleType enum

Type representing whether a role is administrative or not. A user which was granted at least one administrative role is considered an administrator.

Table 1090. Values summary
Name Summary

admin

Administrative role.

user

User role.

6.216. SchedulingPolicy struct

Table 1091. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

default_policy

Boolean

description

String

A human-readable description in plain text.

id

String

A unique identifier.

locked

Boolean

name

String

A human-readable name in plain text.

properties

Property[]
Table 1092. Links summary
Name Type Summary

balances

Balance[]

filters

Filter[]

weight

Weight[]

6.217. SchedulingPolicyUnit struct

Table 1093. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

enabled

Boolean

id

String

A unique identifier.

internal

Boolean

name

String

A human-readable name in plain text.

properties

Property[]

type

PolicyUnitType

6.218. ScsiGenericIO enum

Table 1094. Values summary
Name Summary

filtered

unfiltered

6.219. SeLinux struct

Table 1095. Attributes summary
Name Type Summary

mode

SeLinuxMode

6.220. SeLinuxMode enum

Table 1096. Values summary
Name Summary

disabled

enforcing

permissive

6.221. SerialNumber struct

Table 1097. Attributes summary
Name Type Summary

policy

SerialNumberPolicy

value

String

6.222. SerialNumberPolicy enum

Table 1098. Values summary
Name Summary

custom

host

vm

6.223. Session struct

Describes a user session to a virtual machine.

Table 1099. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

console_user

Boolean

Indicates if this is a console session.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

ip

Ip

The IP address the user is connected from.

name

String

A human-readable name in plain text.

protocol

String

The protocol used by the session.

6.223.1. console_user

Indicates if this is a console session.

The value will be true for console users (SPICE or VNC), and false for others (such as RDP or SSH).

6.223.2. ip

The IP address the user is connected from.

Currently only available for console users.

6.223.3. protocol

The protocol used by the session.

Currently not used. Intended for info about how the user is connected: through SPICE, VNC, SSH, or RDP.

Table 1100. Links summary
Name Type Summary

user

User

The user related to this session.

vm

Vm

A link to the virtual machine related to this session.

6.223.4. user

The user related to this session.

If the user is a console user, this is a link to the real oVirt user. Otherwise, only the user name is provided.

6.224. SkipIfConnectivityBroken struct

Table 1101. Attributes summary
Name Type Summary

enabled

Boolean

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well.

threshold

Integer

Threshold for connectivity testing.

6.224.1. enabled

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.

6.224.2. threshold

Threshold for connectivity testing. If at least the threshold percentage of hosts in the cluster lost connectivity then fencing will not take place.

6.225. SkipIfSdActive struct

This type represents the storage related configuration in the fencing policy.

Table 1102. Attributes summary
Name Type Summary

enabled

Boolean

If enabled, we will skip fencing in case the host maintains its lease in the storage.

6.225.1. enabled

If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.

6.226. Snapshot struct

Represents a snapshot object.

Example XML representation:

<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456">
  <actions>
    <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/>
  </actions>
  <vm id="123" href="/ovirt-engine/api/vms/123"/>
  <description>Virtual Machine 1 - Snapshot A</description>
  <type>active</type>
  <date>2010-08-16T14:24:29</date>
  <persist_memorystate>false</persist_memorystate>
</snapshot>
Table 1103. Attributes summary
Name Type Summary

bios

Bios

Reference to virtual machine’s BIOS configuration.

comment

String

Free text containing comments about this object.

console

Console

Console configured for this virtual machine.

cpu

Cpu

The configuration of the virtual machine CPU.

cpu_shares

Integer

creation_time

Date

The virtual machine creation date.

custom_compatibility_version

Version

Virtual machine custom compatibility version.

custom_cpu_model

String

custom_emulated_machine

String

custom_properties

CustomProperty[]

Properties sent to VDSM to configure various hooks.

date

Date

delete_protected

Boolean

If true, the virtual machine cannot be deleted.

description

String

A human-readable description in plain text.

display

Display

The virtual machine display configuration.

domain

Domain

Domain configured for this virtual machine.

fqdn

String

Fully qualified domain name of the virtual machine.

guest_operating_system

GuestOperatingSystem

What operating system is installed on the virtual machine.

guest_time_zone

TimeZone

What time zone is used by the virtual machine (as returned by guest agent).

high_availability

HighAvailability

The virtual machine high availability configuration.

id

String

A unique identifier.

initialization

Initialization

Reference to virtual machine’s initialization configuration.

io

Io

For performance tuning of IO threading.

large_icon

Icon

Virtual machine’s large icon.

lease

StorageDomainLease

Reference to the storage domain this virtual machine/template lease reside on.

memory

Integer

The virtual machine’s memory, in bytes.

memory_policy

MemoryPolicy

Reference to virtual machine’s memory management configuration.

migration

MigrationOptions

Reference to configuration of migration of running virtual machine to another host.

migration_downtime

Integer

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

name

String

A human-readable name in plain text.

next_run_configuration_exists

Boolean

Virtual machine configuration has been changed and requires restart of the virtual machine.

numa_tune_mode

NumaTuneMode

How the NUMA topology is applied.

origin

String

The origin of this virtual machine.

os

OperatingSystem

Operating system type installed on the virtual machine.

payloads

Payload[]

Optional payloads of the virtual machine, used for ISOs to configure it.

persist_memorystate

Boolean

placement_policy

VmPlacementPolicy

The configuration of the virtual machine’s placement policy.

rng_device

RngDevice

Random Number Generator device configuration for this virtual machine.

run_once

Boolean

If true, the virtual machine has been started using the run once command, meaning it’s configuration might differ from the stored one for the purpose of this single run.

serial_number

SerialNumber

Virtual machine’s serial number in a cluster.

small_icon

Icon

Virtual machine’s small icon.

snapshot_status

SnapshotStatus

snapshot_type

SnapshotType

soundcard_enabled

Boolean

If true, the sound card is added to the virtual machine.

sso

Sso

Reference to the Single Sign On configuration this virtual machine is configured for.

start_paused

Boolean

If true, the virtual machine will be initially in 'paused' state after start.

start_time

Date

The date in which the virtual machine was started.

stateless

Boolean

If true, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.

status

VmStatus

The current status of the virtual machine.

status_detail

String

Human readable detail of current status.

stop_reason

String

The reason the virtual machine was stopped.

stop_time

Date

The date in which the virtual machine was stopped.

time_zone

TimeZone

The virtual machine’s time zone set by oVirt.

tunnel_migration

Boolean

If true, the network data transfer will be encrypted during virtual machine live migration.

type

VmType

Determines whether the virtual machine is optimized for desktop or server.

usb

Usb

Configuration of USB devices for this virtual machine (count, type).

use_latest_template_version

Boolean

If true, the virtual machine is reconfigured to the latest version of it’s template when it is started.

virtio_scsi

VirtioScsi

Reference to VirtIO SCSI configuration.

6.226.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.226.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.226.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.226.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.226.5. lease

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

6.226.6. memory

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.226.7. migration_downtime

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

6.226.8. next_run_configuration_exists

Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.

6.226.9. origin

The origin of this virtual machine.

Possible values:

  • ovirt

  • rhev

  • vmware

  • xen

  • external

  • hosted_engine

  • managed_hosted_engine

  • kvm

  • physical_machine

  • hyperv

6.226.10. placement_policy

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned.

For example, to pin a virtual machine to two hosts, send the following request:

PUT /api/vms/123

With a request body like this:

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

6.226.11. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.226.12. sso

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

6.226.13. stop_reason

The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.

Table 1104. Links summary
Name Type Summary

affinity_labels

AffinityLabel[]

Optional.

applications

Application[]

List of applications installed on the virtual machine.

cdroms

Cdrom[]

Reference to the ISO mounted to the CDROM.

cluster

Cluster

Reference to cluster the virtual machine belongs to.

cpu_profile

CpuProfile

Reference to CPU profile used by this virtual machine.

disk_attachments

DiskAttachment[]

References the disks attached to the virtual machine.

external_host_provider

ExternalHostProvider

floppies

Floppy[]

Reference to the ISO mounted to the floppy.

graphics_consoles

GraphicsConsole[]

List of graphics consoles configured for this virtual machine.

host

Host

Reference to the host the virtual machine is running on.

host_devices

HostDevice[]

References devices associated to this virtual machine.

instance_type

InstanceType

The virtual machine configuration can be optionally predefined via one of the instance types.

katello_errata

KatelloErratum[]

Lists all the Katello errata assigned to the virtual machine.

nics

Nic[]

References the list of network interface devices on the virtual machine.

numa_nodes

NumaNode[]

Refers to the NUMA Nodes configuration used by this virtual machine.

original_template

Template

References the original template used to create the virtual machine.

permissions

Permission[]

Permissions set for this virtual machine.

quota

Quota

Reference to quota configuration set for this virtual machine.

reported_devices

ReportedDevice[]

sessions

Session[]

List of user sessions opened for this virtual machine.

snapshots

Snapshot[]

Refers to all snapshots taken from the virtual machine.

statistics

Statistic[]

Statistics data collected from this virtual machine.

storage_domain

StorageDomain

Reference to storage domain the virtual machine belongs to.

tags

Tag[]

template

Template

Reference to the template the virtual machine is based on.

vm

Vm

vm_pool

VmPool

Reference to the pool the virtual machine is optionally member of.

watchdogs

Watchdog[]

Refers to the Watchdog configuration.

6.226.14. affinity_labels

Optional. Used for labeling of sub-clusters.

6.226.15. katello_errata

Lists all the Katello errata assigned to the virtual machine.

GET /ovirt-engine/api/vms/123/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <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>

6.226.16. original_template

References the original template used to create the virtual machine.

If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.

Otherwise the template and original_template are the same.

6.227. SnapshotStatus enum

Table 1105. Values summary
Name Summary

in_preview

locked

ok

6.228. SnapshotType enum

Table 1106. Values summary
Name Summary

active

preview

regular

stateless

6.229. SpecialObjects struct

This type contains references to special objects, such as blank templates and the root of a hierarchy of tags.

Table 1107. Links summary
Name Type Summary

blank_template

Template

A reference to a blank template.

root_tag

Tag

A reference to the root of a hierarchy of tags.

6.230. Spm struct

Table 1108. Attributes summary
Name Type Summary

priority

Integer

status

SpmStatus

6.231. SpmStatus enum

Table 1109. Values summary
Name Summary

contending

none

spm

6.232. Ssh struct

Table 1110. Attributes summary
Name Type Summary

authentication_method

SshAuthenticationMethod

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

fingerprint

String

id

String

A unique identifier.

name

String

A human-readable name in plain text.

port

Integer

user

User

6.233. SshAuthenticationMethod enum

Table 1111. Values summary
Name Summary

password

publickey

6.234. SshPublicKey struct

Table 1112. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

content

String

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1113. Links summary
Name Type Summary

user

User

6.235. Sso struct

Table 1114. Attributes summary
Name Type Summary

methods

Method[]

6.236. SsoMethod enum

Table 1115. Values summary
Name Summary

guest_agent

6.237. Statistic struct

A generic type used for all kinds of statistics.

Statistic contains the statistics values for various entities. The following object contain statistics:

  • Disk

  • Host

  • HostNic

  • NumaNode

  • Nic

  • Vm

  • GlusterBrick

  • Step

  • GlusterVolume

An example of a XML representation:

<statistics>
  <statistic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234/statistics/1234">
    <name>data.current.rx</name>
    <description>Receive data rate</description>
    <values type="DECIMAL">
      <value>
        <datum>0</datum>
      </value>
    </values>
    <type>GAUGE</type>
    <unit>BYTES_PER_SECOND</unit>
    <host_nic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234"/>
  </statistic>
  ...
</statistics>
This statistics sub-collection is read-only.
Table 1116. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

kind

StatisticKind

The type of statistic measures.

name

String

A human-readable name in plain text.

type

ValueType

The data type for the statistical values that follow.

unit

StatisticUnit

The unit or rate to measure of the statistical values.

values

Value[]

A data set that contains datum.
Table 1117. Links summary
Name Type Summary

brick

GlusterBrick

disk

Disk

A relationship to the containing disk resource.

gluster_volume

GlusterVolume

host

Host

host_nic

HostNic

A reference to the host NIC.

host_numa_node

NumaNode

nic

Nic

step

Step

vm

Vm

6.238. StatisticKind enum

Table 1118. Values summary
Name Summary

counter

gauge

6.239. StatisticUnit enum

Table 1119. Values summary
Name Summary

bits_per_second

bytes

bytes_per_second

count_per_second

none

percent

seconds

6.240. Step struct

Represents a step, which is part of job execution. Step is used to describe and track a specific execution unit which is part of a wider sequence. Some steps support reporting their progress.

Table 1120. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

end_time

Date

The end time of the step.

external

Boolean

Indicates if the step is originated by an external system.

external_type

ExternalSystemType

The external system which is referenced by the step.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

number

Integer

The order of the step in current hierarchy level.

progress

Integer

The step progress (if reported) in percentages.

start_time

Date

The start time of the step.

status

StepStatus

The status of the step.

type

StepEnum

The type of the step.

6.240.1. external

Indicates if the step is originated by an external system. External steps are managed externally, by the creator of the step.

Table 1121. Links summary
Name Type Summary

execution_host

Host

The host used for the step execution (optional).

job

Job

References the job which is the top of the current step hierarchy.

parent_step

Step

References the parent step of the current step in the hierarchy.

statistics

Statistic[]

6.241. StepEnum enum

Type representing a step type.

Table 1122. Values summary
Name Summary

executing

The executing step type.

finalizing

The finalizing step type.

rebalancing_volume

The rebalancing volume step type.

removing_bricks

The removing bricks step type.

unknown

The unknown step type.

validating

The validation step type.

6.241.1. executing

The executing step type. Used to track the main execution block of the job. Usually it will be a parent step of several sub-steps which describe portions of the execution step.

6.241.2. finalizing

The finalizing step type. Describes the post-execution steps requires to complete the job.

6.241.3. rebalancing_volume

The rebalancing volume step type. Describes a step type which is part of Gluster flow.

6.241.4. removing_bricks

The removing bricks step type. Describes a step type which is part of Gluster flow.

6.241.5. unknown

The unknown step type. Describes a step type which its origin is unknown.

6.241.6. validating

The validation step type. Used to verify the correctness of parameters and the validity of the parameters prior to the execution.

6.242. StepStatus enum

Represents the status of the step.

Table 1123. Values summary
Name Summary

aborted

The aborted step status.

failed

The failed step status.

finished

The finished step status.

started

The started step status.

unknown

The unknown step status.

6.242.1. aborted

The aborted step status. This status is applicable for an external step that was forcibly aborted.

6.242.2. finished

The finished step status. This status describes a completed step execution.

6.242.3. started

The started step status. This status represents a step which is currently being executed.

6.242.4. unknown

The unknown step status. This status represents steps which their resolution is not known, i.e. steps that were executed before the system was unexpectedly restarted.

6.243. StorageConnection struct

Represents a storage server connection.

Example XML representation:

<storage_connection id="123">
  <address>mynfs.example.com</address>
  <type>nfs</type>
  <path>/exports/mydata</path>
</storage_connection>
Table 1124. Attributes summary
Name Type Summary

address

String

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

mount_options

String

name

String

A human-readable name in plain text.

nfs_retrans

Integer

nfs_timeo

Integer

nfs_version

NfsVersion

password

String

path

String

port

Integer

portal

String

target

String

type

StorageType

username

String

vfs_type

String
Table 1125. Links summary
Name Type Summary

host

Host

6.244. StorageConnectionExtension struct

Table 1126. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

password

String

target

String

username

String
Table 1127. Links summary
Name Type Summary

host

Host

6.245. StorageDomain struct

Storage domain.

An XML representation of a NFS storage domain with identifier 123:

<storage_domain href="/ovirt-engine/api/storagedomains/123" id="123">
  <name>mydata</name>
  <description>My data</description>
  <available>38654705664</available>
  <committed>1073741824</committed>
  <critical_space_action_blocker>5</critical_space_action_blocker>
  <external_status>ok</external_status>
  <master>true</master>
  <storage>
    <address>mynfs.example.com</address>
    <nfs_version>v3</nfs_version>
    <path>/exports/mydata</path>
    <type>nfs</type>
  </storage>
  <storage_format>v3</storage_format>
  <type>data</type>
  <used>13958643712</used>
  <warning_low_space_indicator>10</warning_low_space_indicator>
  <wipe_after_delete>false</wipe_after_delete>
  <data_centers>
    <data_center href="/ovirt-engine/api/datacenters/456" id="456"/>
  </data_centers>
</storage_domain>
Table 1128. Attributes summary
Name Type Summary

available

Integer

comment

String

Free text containing comments about this object.

committed

Integer

critical_space_action_blocker

Integer

description

String

A human-readable description in plain text.

discard_after_delete

Boolean

Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted.

external_status

ExternalStatus

id

String

A unique identifier.

import

Boolean

master

Boolean

name

String

A human-readable name in plain text.

status

StorageDomainStatus

storage

HostStorage

storage_format

StorageFormat

supports_discard

Boolean

Indicates whether a block storage domain supports discard operations.

supports_discard_zeroes_data

Boolean

Indicates whether a block storage domain supports the property that discard zeroes the data.

type

StorageDomainType

used

Integer

warning_low_space_indicator

Integer

wipe_after_delete

Boolean

Serves as the default value of wipe_after_delete for disks on this storage domain.

6.245.1. discard_after_delete

Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted.

If true, and a disk on this storage domain has its wipe_after_delete value enabled, then when the disk is deleted:

  1. It is first wiped.

  2. Then its blocks are discarded.

  3. Finally it is deleted.

Note that:

  • Discard after delete will always be false for non block storage types.

  • Discard after delete can be set to true only if the storage domain supports discard.

6.245.2. supports_discard

Indicates whether a block storage domain supports discard operations. A storage domain only supports discard if all of the logical units that it is built from support discard; that is, if each logical unit’s discard_max_size value is greater than 0. This is one of the conditions necessary for a virtual disk in this storage domain to have its pass_discard attribute enabled. Since the engine cannot check if the underlying block device supports discard for file storage domains, this attribute will not be reported for them at all.

6.245.3. supports_discard_zeroes_data

Indicates whether a block storage domain supports the property that discard zeroes the data. A storage domain only supports the property that discard zeroes the data if all of the logical units that it is built from support it; that is, if each logical unit’s discard_zeroes_data value is true. This is one of the conditions necessary for a virtual disk in this storage domain to have both wipe_after_delete and pass_discard attributes enabled. Since the engine cannot check if the underlying block device supports the property that discard zeroes the data for file storage domains, this attribute will not be reported for them at all.

6.245.4. wipe_after_delete

Serves as the default value of wipe_after_delete for disks on this storage domain.

That is, newly created disks will get their wipe_after_delete value from their storage domains by default. Note that the configuration value SANWipeAfterDelete serves as the default value of block storage domains' wipe_after_delete value.

Table 1129. Links summary
Name Type Summary

data_center

DataCenter

A link to the data center that the storage domain is attached to.

data_centers

DataCenter[]

A set of links to the data centers that the storage domain is attached to.

disk_profiles

DiskProfile[]

disk_snapshots

DiskSnapshot[]

disks

Disk[]

files

File[]

host

Host

Host is only relevant at creation time.

images

Image[]

permissions

Permission[]

storage_connections

StorageConnection[]

templates

Template[]

vms

Vm[]

6.245.5. data_center

A link to the data center that the storage domain is attached to. This is preserved for backwards compatibility only, as the storage domain may be attached to multiple data centers (if it is an ISO domain). Use the dataCenters element instead.

6.246. StorageDomainLease struct

Represents a lease residing on a storage domain.

A lease is a Sanlock resource residing on a special volume on the storage domain, this Sanlock resource is used to provide storage base locking.

Table 1130. Links summary
Name Type Summary

storage_domain

StorageDomain

Reference to the storage domain on which the lock resides on.

6.247. StorageDomainStatus enum

Table 1131. Values summary
Name Summary

activating

active

detaching

inactive

locked

maintenance

mixed

preparing_for_maintenance

unattached

unknown

6.248. StorageDomainType enum

Table 1132. Values summary
Name Summary

data

export

image

iso

volume

6.249. StorageFormat enum

Table 1133. Values summary
Name Summary

v1

v2

v3

v4

Version 4 of the storage domain format.

6.250. StorageType enum

Type representing a storage domain type.

Table 1134. Values summary
Name Summary

cinder

Cinder storage domain.

fcp

Fibre-Channel storage domain.

glance

Glance storage domain.

glusterfs

Gluster-FS storage domain.

iscsi

iSCSI storage domain.

localfs

Storage domain on Local storage.

nfs

NFS storage domain.

posixfs

POSIX-FS storage domain.

6.250.1. cinder

Cinder storage domain. For more details on Cinder please go to Cinder.

6.250.2. glance

Glance storage domain. For more details on Glance please go to Glance.

6.250.3. glusterfs

Gluster-FS storage domain. For more details on Gluster please go to Gluster.

6.251. SwitchType enum

Describes all switch types supported by the Manager.

Table 1135. Values summary
Name Summary

legacy

The native switch type.

ovs

The Open vSwitch type.

6.252. Tag struct

Represents a tag in the system.

Table 1136. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1137. Links summary
Name Type Summary

group

Group

Reference to the group which has this tag assigned.

host

Host

Reference to the host which has this tag assigned.

parent

Tag

Reference to the parent tag of this tag.

template

Template

Reference to the template which has this tag assigned.

user

User

Reference to the user who has this tag assigned.

vm

Vm

Reference to the virtual machine which has this tag assigned.

6.253. Template struct

Type representing a virtual machine template. This allows a rapid instanstiation of virtual machines with common configuration and disk states.

Table 1138. Attributes summary
Name Type Summary

bios

Bios

Reference to virtual machine’s BIOS configuration.

comment

String

Free text containing comments about this object.

console

Console

Console configured for this virtual machine.

cpu

Cpu

The configuration of the virtual machine CPU.

cpu_shares

Integer

creation_time

Date

The virtual machine creation date.

custom_compatibility_version

Version

Virtual machine custom compatibility version.

custom_cpu_model

String

custom_emulated_machine

String

custom_properties

CustomProperty[]

Properties sent to VDSM to configure various hooks.

delete_protected

Boolean

If true, the virtual machine cannot be deleted.

description

String

A human-readable description in plain text.

display

Display

The virtual machine display configuration.

domain

Domain

Domain configured for this virtual machine.

high_availability

HighAvailability

The virtual machine high availability configuration.

id

String

A unique identifier.

initialization

Initialization

Reference to virtual machine’s initialization configuration.

io

Io

For performance tuning of IO threading.

large_icon

Icon

Virtual machine’s large icon.

lease

StorageDomainLease

Reference to the storage domain this virtual machine/template lease reside on.

memory

Integer

The virtual machine’s memory, in bytes.

memory_policy

MemoryPolicy

Reference to virtual machine’s memory management configuration.

migration

MigrationOptions

Reference to configuration of migration of running virtual machine to another host.

migration_downtime

Integer

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

name

String

A human-readable name in plain text.

origin

String

The origin of this virtual machine.

os

OperatingSystem

Operating system type installed on the virtual machine.

rng_device

RngDevice

Random Number Generator device configuration for this virtual machine.

serial_number

SerialNumber

Virtual machine’s serial number in a cluster.

small_icon

Icon

Virtual machine’s small icon.

soundcard_enabled

Boolean

If true, the sound card is added to the virtual machine.

sso

Sso

Reference to the Single Sign On configuration this virtual machine is configured for.

start_paused

Boolean

If true, the virtual machine will be initially in 'paused' state after start.

stateless

Boolean

If true, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.

status

TemplateStatus

The status of the template.

time_zone

TimeZone

The virtual machine’s time zone set by oVirt.

tunnel_migration

Boolean

If true, the network data transfer will be encrypted during virtual machine live migration.

type

VmType

Determines whether the virtual machine is optimized for desktop or server.

usb

Usb

Configuration of USB devices for this virtual machine (count, type).

version

TemplateVersion

Indicates whether this is a base version or a sub version of another template.

virtio_scsi

VirtioScsi

Reference to VirtIO SCSI configuration.

vm

Vm

The virtual machine configuration associated with this template.

6.253.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.253.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.253.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.253.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.253.5. lease

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

6.253.6. memory

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.253.7. migration_downtime

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

6.253.8. origin

The origin of this virtual machine.

Possible values:

  • ovirt

  • rhev

  • vmware

  • xen

  • external

  • hosted_engine

  • managed_hosted_engine

  • kvm

  • physical_machine

  • hyperv

6.253.9. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.253.10. sso

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Table 1139. Links summary
Name Type Summary

cdroms

Cdrom[]

References to the CD-ROM devices attached to the template.

cluster

Cluster

Reference to cluster the virtual machine belongs to.

cpu_profile

CpuProfile

Reference to CPU profile used by this virtual machine.

disk_attachments

DiskAttachment[]

References to the disks attached to the template.

graphics_consoles

GraphicsConsole[]

References to the graphic consoles attached to the template.

nics

Nic[]

References to the network interfaces attached to the template.

permissions

Permission[]

References to the user permissions attached to the template.

quota

Quota

Reference to quota configuration set for this virtual machine.

storage_domain

StorageDomain

Reference to storage domain the virtual machine belongs to.

tags

Tag[]

References to the tags attached to the template.

watchdogs

Watchdog[]

References to the watchdog devices attached to the template.

6.254. TemplateStatus enum

Type representing a status of a virtual machine template.

Table 1140. Values summary
Name Summary

illegal

This status indicates that at least one of the disks of the template is illegal.

locked

This status indicates that some operation that prevents other operations with the template is being executed.

ok

This status indicates that the template is valid and ready for use.

6.255. TemplateVersion struct

Type representing a version of a virtual machine template.

Table 1141. Attributes summary
Name Type Summary

version_name

String

The name of this version.

version_number

Integer

The index of this version in the versions hierarchy of the template.

6.255.1. version_number

The index of this version in the versions hierarchy of the template. The index 1 represents the original version of a template that is also called base version.

Table 1142. Links summary
Name Type Summary

base_template

Template

References the template that this version is associated with.

6.256. Ticket struct

Type representing a ticket that allows virtual machine access.

Table 1143. Attributes summary
Name Type Summary

expiry

Integer

Time to live for the ticket in seconds.

value

String

The virtual machine access ticket.

6.257. TimeZone struct

Time zone representation.

Table 1144. Attributes summary
Name Type Summary

name

String

Name of the time zone.

utc_offset

String

Offset from https://en.

6.257.1. utc_offset

Offset from UTC.

6.258. TransparentHugePages struct

Type representing a transparent huge pages (THP) support.

Table 1145. Attributes summary
Name Type Summary

enabled

Boolean

Enable THP support.

6.259. TransportType enum

Protocol used to access a Gluster volume.

Table 1146. Values summary
Name Summary

rdma

Remote direct memory access.

tcp

TCP.

6.260. UnmanagedNetwork struct

Table 1147. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1148. Links summary
Name Type Summary

host

Host

host_nic

HostNic

6.261. Usb struct

Table 1149. Attributes summary
Name Type Summary

enabled

Boolean

type

UsbType

6.262. UsbType enum

Table 1150. Values summary
Name Summary

legacy

A legacy USB type.

native

6.262.1. legacy

A legacy USB type.

This USB type has been deprecated since version 3.6 of the engine, and has been completely removed in version 4.1. It is preserved only to avoid syntax errors in existing scripts. If it is used it will be automatically replaced by native.

6.263. User struct

Represents a user in the system.

Table 1151. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

department

String

description

String

A human-readable description in plain text.

domain_entry_id

String

email

String

id

String

A unique identifier.

last_name

String

logged_in

Boolean

name

String

A human-readable name in plain text.

namespace

String

Namespace where the user resides.

password

String

principal

String

Similar to user_name.

user_name

String

The user’s username.

6.263.1. namespace

Namespace where the user resides. When using the authorization provider that stores users in the LDAP server, this attribute equals the naming context of the LDAP server. See https://github.com/oVirt/ovirt-engine-extension-aaa-ldap for more information. When using the built-in authorization provider that stores users in the database this attribute is ignored. See https://github.com/oVirt/ovirt-engine-extension-aaa-jdbc for more information.

6.263.2. principal

Similar to user_name. The format depends on the LDAP provider. With most LDAP providers it is the value of the uid LDAP attribute. In the case of Active Directory it is the User Principal Name (UPN).

6.263.3. user_name

The user’s username. The format depends on authorization provider type. In most LDAP providers it is the value of the uid LDAP attribute. In Active Directory it is the User Principal Name (UPN). UPN or uid must be followed by the authorization provider name. For example, in the case of LDAP’s uid attribute it is: myuser@myextension-authz. In the case of Active Directory using UPN it is: myuser@mysubdomain.mydomain.com@myextension-authz. This attribute is a required parameter when adding a new user.

Table 1152. Links summary
Name Type Summary

domain

Domain

groups

Group[]

permissions

Permission[]

roles

Role[]

A link to the roles sub-collection for user resources.

ssh_public_keys

SshPublicKey[]

tags

Tag[]

A link to the tags sub-collection for user resources.

6.264. Value struct

Table 1153. Attributes summary
Name Type Summary

datum

Decimal

detail

String

6.265. ValueType enum

Table 1154. Values summary
Name Summary

decimal

integer

string

6.266. VcpuPin struct

Table 1155. Attributes summary
Name Type Summary

cpu_set

String

vcpu

Integer

6.267. Vendor struct

Table 1156. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

name

String

A human-readable name in plain text.

6.268. Version struct

Table 1157. Attributes summary
Name Type Summary

build

Integer

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

full_version

String

id

String

A unique identifier.

major

Integer

minor

Integer

name

String

A human-readable name in plain text.

revision

Integer

6.269. VirtioScsi struct

Type representing the support of virtio-SCSI. If it supported we use virtio driver for SCSI guest device.

Table 1158. Attributes summary
Name Type Summary

enabled

Boolean

Enable Virtio SCSI support.

6.270. VirtualNumaNode struct

Represents the virtual NUMA node.

An example XML representation:

<vm_numa_node href="/ovirt-engine/api/vms/123/numanodes/456" id="456">
  <cpu>
    <cores>
      <core>
        <index>0</index>
      </core>
    </cores>
  </cpu>
  <index>0</index>
  <memory>1024</memory>
  <numa_node_pins>
    <numa_node_pin>
      <index>0</index>
    </numa_node_pin>
  </numa_node_pins>
  <vm href="/ovirt-engine/api/vms/123" id="123" />
</vm_numa_node>
Table 1159. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

cpu

Cpu

description

String

A human-readable description in plain text.

id

String

A unique identifier.

index

Integer

memory

Integer

Memory of the NUMA node in MB.

name

String

A human-readable name in plain text.

node_distance

String

numa_node_pins

NumaNodePin[]
Table 1160. Links summary
Name Type Summary

host

Host

statistics

Statistic[]

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

vm

Vm

6.270.1. statistics

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

An example of an XML representation:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>
This statistics sub-collection is read-only.

The following list shows the statistic types for a host NUMA node:

Name Description

memory.total

Total memory in bytes on the NUMA node.

memory.used

Memory in bytes used on the NUMA node.

memory.free

Memory in bytes free on the NUMA node.

cpu.current.user

Percentage of CPU usage for user slice.

cpu.current.system

Percentage of CPU usage for system.

cpu.current.idle

Percentage of idle CPU usage.

6.271. Vlan struct

Type representing a Virtual LAN (VLAN) type.

Table 1161. Attributes summary
Name Type Summary

id

Integer

Virtual LAN ID.

6.272. Vm struct

Represents a virtual machine.

Table 1162. Attributes summary
Name Type Summary

bios

Bios

Reference to virtual machine’s BIOS configuration.

comment

String

Free text containing comments about this object.

console

Console

Console configured for this virtual machine.

cpu

Cpu

The configuration of the virtual machine CPU.

cpu_shares

Integer

creation_time

Date

The virtual machine creation date.

custom_compatibility_version

Version

Virtual machine custom compatibility version.

custom_cpu_model

String

custom_emulated_machine

String

custom_properties

CustomProperty[]

Properties sent to VDSM to configure various hooks.

delete_protected

Boolean

If true, the virtual machine cannot be deleted.

description

String

A human-readable description in plain text.

display

Display

The virtual machine display configuration.

domain

Domain

Domain configured for this virtual machine.

fqdn

String

Fully qualified domain name of the virtual machine.

guest_operating_system

GuestOperatingSystem

What operating system is installed on the virtual machine.

guest_time_zone

TimeZone

What time zone is used by the virtual machine (as returned by guest agent).

high_availability

HighAvailability

The virtual machine high availability configuration.

id

String

A unique identifier.

initialization

Initialization

Reference to virtual machine’s initialization configuration.

io

Io

For performance tuning of IO threading.

large_icon

Icon

Virtual machine’s large icon.

lease

StorageDomainLease

Reference to the storage domain this virtual machine/template lease reside on.

memory

Integer

The virtual machine’s memory, in bytes.

memory_policy

MemoryPolicy

Reference to virtual machine’s memory management configuration.

migration

MigrationOptions

Reference to configuration of migration of running virtual machine to another host.

migration_downtime

Integer

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

name

String

A human-readable name in plain text.

next_run_configuration_exists

Boolean

Virtual machine configuration has been changed and requires restart of the virtual machine.

numa_tune_mode

NumaTuneMode

How the NUMA topology is applied.

origin

String

The origin of this virtual machine.

os

OperatingSystem

Operating system type installed on the virtual machine.

payloads

Payload[]

Optional payloads of the virtual machine, used for ISOs to configure it.

placement_policy

VmPlacementPolicy

The configuration of the virtual machine’s placement policy.

rng_device

RngDevice

Random Number Generator device configuration for this virtual machine.

run_once

Boolean

If true, the virtual machine has been started using the run once command, meaning it’s configuration might differ from the stored one for the purpose of this single run.

serial_number

SerialNumber

Virtual machine’s serial number in a cluster.

small_icon

Icon

Virtual machine’s small icon.

soundcard_enabled

Boolean

If true, the sound card is added to the virtual machine.

sso

Sso

Reference to the Single Sign On configuration this virtual machine is configured for.

start_paused

Boolean

If true, the virtual machine will be initially in 'paused' state after start.

start_time

Date

The date in which the virtual machine was started.

stateless

Boolean

If true, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.

status

VmStatus

The current status of the virtual machine.

status_detail

String

Human readable detail of current status.

stop_reason

String

The reason the virtual machine was stopped.

stop_time

Date

The date in which the virtual machine was stopped.

time_zone

TimeZone

The virtual machine’s time zone set by oVirt.

tunnel_migration

Boolean

If true, the network data transfer will be encrypted during virtual machine live migration.

type

VmType

Determines whether the virtual machine is optimized for desktop or server.

usb

Usb

Configuration of USB devices for this virtual machine (count, type).

use_latest_template_version

Boolean

If true, the virtual machine is reconfigured to the latest version of it’s template when it is started.

virtio_scsi

VirtioScsi

Reference to VirtIO SCSI configuration.

6.272.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.272.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.272.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.272.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.272.5. lease

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

6.272.6. memory

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.272.7. migration_downtime

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

6.272.8. next_run_configuration_exists

Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.

6.272.9. origin

The origin of this virtual machine.

Possible values:

  • ovirt

  • rhev

  • vmware

  • xen

  • external

  • hosted_engine

  • managed_hosted_engine

  • kvm

  • physical_machine

  • hyperv

6.272.10. placement_policy

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned.

For example, to pin a virtual machine to two hosts, send the following request:

PUT /api/vms/123

With a request body like this:

<vm>
  <high_availability>
    <enabled>true</enabled>
    <priority>1</priority>
  </high_availability>
  <placement_policy>
    <hosts>
      <host>
        <name>Host1</name>
      </host>
      <host>
        <name>Host2</name>
      </host>
    </hosts>
    <affinity>pinned</affinity>
  </placement_policy>
</vm>

6.272.11. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.272.12. sso

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

6.272.13. stop_reason

The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.

Table 1163. Links summary
Name Type Summary

affinity_labels

AffinityLabel[]

Optional.

applications

Application[]

List of applications installed on the virtual machine.

cdroms

Cdrom[]

Reference to the ISO mounted to the CDROM.

cluster

Cluster

Reference to cluster the virtual machine belongs to.

cpu_profile

CpuProfile

Reference to CPU profile used by this virtual machine.

disk_attachments

DiskAttachment[]

References the disks attached to the virtual machine.

external_host_provider

ExternalHostProvider

floppies

Floppy[]

Reference to the ISO mounted to the floppy.

graphics_consoles

GraphicsConsole[]

List of graphics consoles configured for this virtual machine.

host

Host

Reference to the host the virtual machine is running on.

host_devices

HostDevice[]

References devices associated to this virtual machine.

instance_type

InstanceType

The virtual machine configuration can be optionally predefined via one of the instance types.

katello_errata

KatelloErratum[]

Lists all the Katello errata assigned to the virtual machine.

nics

Nic[]

References the list of network interface devices on the virtual machine.

numa_nodes

NumaNode[]

Refers to the NUMA Nodes configuration used by this virtual machine.

original_template

Template

References the original template used to create the virtual machine.

permissions

Permission[]

Permissions set for this virtual machine.

quota

Quota

Reference to quota configuration set for this virtual machine.

reported_devices

ReportedDevice[]

sessions

Session[]

List of user sessions opened for this virtual machine.

snapshots

Snapshot[]

Refers to all snapshots taken from the virtual machine.

statistics

Statistic[]

Statistics data collected from this virtual machine.

storage_domain

StorageDomain

Reference to storage domain the virtual machine belongs to.

tags

Tag[]

template

Template

Reference to the template the virtual machine is based on.

vm_pool

VmPool

Reference to the pool the virtual machine is optionally member of.

watchdogs

Watchdog[]

Refers to the Watchdog configuration.

6.272.14. affinity_labels

Optional. Used for labeling of sub-clusters.

6.272.15. katello_errata

Lists all the Katello errata assigned to the virtual machine.

GET /ovirt-engine/api/vms/123/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <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>

6.272.16. original_template

References the original template used to create the virtual machine.

If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.

Otherwise the template and original_template are the same.

6.273. VmAffinity enum

Table 1164. Values summary
Name Summary

migratable

pinned

user_migratable

6.274. VmBase struct

Represents basic virtual machine configuration. This is used by virtual machines, templates and instance types.

Table 1165. Attributes summary
Name Type Summary

bios

Bios

Reference to virtual machine’s BIOS configuration.

comment

String

Free text containing comments about this object.

console

Console

Console configured for this virtual machine.

cpu

Cpu

The configuration of the virtual machine CPU.

cpu_shares

Integer

creation_time

Date

The virtual machine creation date.

custom_compatibility_version

Version

Virtual machine custom compatibility version.

custom_cpu_model

String

custom_emulated_machine

String

custom_properties

CustomProperty[]

Properties sent to VDSM to configure various hooks.

delete_protected

Boolean

If true, the virtual machine cannot be deleted.

description

String

A human-readable description in plain text.

display

Display

The virtual machine display configuration.

domain

Domain

Domain configured for this virtual machine.

high_availability

HighAvailability

The virtual machine high availability configuration.

id

String

A unique identifier.

initialization

Initialization

Reference to virtual machine’s initialization configuration.

io

Io

For performance tuning of IO threading.

large_icon

Icon

Virtual machine’s large icon.

lease

StorageDomainLease

Reference to the storage domain this virtual machine/template lease reside on.

memory

Integer

The virtual machine’s memory, in bytes.

memory_policy

MemoryPolicy

Reference to virtual machine’s memory management configuration.

migration

MigrationOptions

Reference to configuration of migration of running virtual machine to another host.

migration_downtime

Integer

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

name

String

A human-readable name in plain text.

origin

String

The origin of this virtual machine.

os

OperatingSystem

Operating system type installed on the virtual machine.

rng_device

RngDevice

Random Number Generator device configuration for this virtual machine.

serial_number

SerialNumber

Virtual machine’s serial number in a cluster.

small_icon

Icon

Virtual machine’s small icon.

soundcard_enabled

Boolean

If true, the sound card is added to the virtual machine.

sso

Sso

Reference to the Single Sign On configuration this virtual machine is configured for.

start_paused

Boolean

If true, the virtual machine will be initially in 'paused' state after start.

stateless

Boolean

If true, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.

time_zone

TimeZone

The virtual machine’s time zone set by oVirt.

tunnel_migration

Boolean

If true, the network data transfer will be encrypted during virtual machine live migration.

type

VmType

Determines whether the virtual machine is optimized for desktop or server.

usb

Usb

Configuration of USB devices for this virtual machine (count, type).

virtio_scsi

VirtioScsi

Reference to VirtIO SCSI configuration.

6.274.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.274.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.274.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.274.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.274.5. lease

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

6.274.6. memory

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from oVirt 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.274.7. migration_downtime

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

6.274.8. origin

The origin of this virtual machine.

Possible values:

  • ovirt

  • rhev

  • vmware

  • xen

  • external

  • hosted_engine

  • managed_hosted_engine

  • kvm

  • physical_machine

  • hyperv

6.274.9. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.274.10. sso

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Table 1166. Links summary
Name Type Summary

cluster

Cluster

Reference to cluster the virtual machine belongs to.

cpu_profile

CpuProfile

Reference to CPU profile used by this virtual machine.

quota

Quota

Reference to quota configuration set for this virtual machine.

storage_domain

StorageDomain

Reference to storage domain the virtual machine belongs to.

6.275. VmDeviceType enum

Table 1167. Values summary
Name Summary

cdrom

floppy

6.276. VmPlacementPolicy struct

Table 1168. Attributes summary
Name Type Summary

affinity

VmAffinity
Table 1169. Links summary
Name Type Summary

hosts

Host[]

6.277. VmPool struct

Table 1170. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

display

Display

id

String

A unique identifier.

max_user_vms

Integer

name

String

A human-readable name in plain text.

prestarted_vms

Integer

rng_device

RngDevice

size

Integer

soundcard_enabled

Boolean

stateful

Boolean

Virtual machine pool’s stateful flag.

type

VmPoolType

use_latest_template_version

Boolean

6.277.1. stateful

Virtual machine pool’s stateful flag.

Virtual machines from a stateful virtual machine pool are always started in stateful mode (stateless snapshot is not created). The state of the virtual machine is preserved even when the virtual machine is passed to a different user.

Table 1171. Links summary
Name Type Summary

cluster

Cluster

instance_type

InstanceType

Reference to the instance type on which this pool is based.

permissions

Permission[]

template

Template

vm

Vm

6.277.2. instance_type

Reference to the instance type on which this pool is based. It can be set only on pool creation and cannot be edited.

6.278. VmPoolType enum

Table 1172. Values summary
Name Summary

automatic

manual

6.279. VmStatus enum

Type represeting a status of a virtual machine.

Table 1173. Values summary
Name Summary

down

This status indicates that the virtual machine process is not running.

image_locked

This status indicates that the virtual machine process is not running and there is some operation on the disks of the virtual machine that prevents it from being started.

migrating

This status indicates that the virtual machine process is running and the virtual machine is being migrated from one host to another.

not_responding

This status indicates that the hypervisor detected that the virtual machine is not responding.

paused

This status indicates that the virtual machine process is running and the virtual machine is paused.

powering_down

This status indicates that the virtual machine process is running and it is about to stop running.

powering_up

This status indicates that the virtual machine process is running and the guest operating system is being loaded.

reboot_in_progress

This status indicates that the virtual machine process is running and the guest operating system is being rebooted.

restoring_state

This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation.

saving_state

This status indicates that the virtual machine process is running and the virtual machine is being hibernated.

suspended

This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved.

unassigned

This status is set when an invalid status is received.

unknown

This status indicates that the system failed to determine the status of the virtual machine.

up

This status indicates that the virtual machine process is running and the guest operating system is loaded.

wait_for_launch

This status indicates that the virtual machine process is about to run.

6.279.1. paused

This status indicates that the virtual machine process is running and the virtual machine is paused. This may happen in two cases: when running a virtual machine is paused mode and when the virtual machine is being automatically paused due to an error.

6.279.2. powering_up

This status indicates that the virtual machine process is running and the guest operating system is being loaded. Note that if no guest-agent is installed, this status is set for a predefined period of time, that is by default 60 seconds, when running a virtual machine.

6.279.3. restoring_state

This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation. In this status, the running state of the virtual machine is being restored.

6.279.4. saving_state

This status indicates that the virtual machine process is running and the virtual machine is being hibernated. In this status, the running state of the virtual machine is being saved. Note that this status does not mean that the guest operating system is being hibernated.

6.279.5. suspended

This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved. This status is similar to Down, but when the VM is started in this status its saved running state is restored instead of being booted using the normal procedue.

6.279.6. unknown

This status indicates that the system failed to determine the status of the virtual machine. The virtual machine process may be running or not running in this status. For instance, when host becomes non-responsive the virtual machines that ran on it are set with this status.

6.279.7. up

This status indicates that the virtual machine process is running and the guest operating system is loaded. Note that if no guest-agent is installed, this status is set after a predefined period of time, that is by default 60 seconds, when running a virtual machine.

6.279.8. wait_for_launch

This status indicates that the virtual machine process is about to run. This status is set when a request to run a virtual machine arrives to the host. It is possible that the virtual machine process will fail to run.

6.280. VmSummary struct

Table 1174. Attributes summary
Name Type Summary

active

Integer

migrating

Integer

total

Integer

6.281. VmType enum

Type representing what the virtual machine is optimized for.

Table 1175. Values summary
Name Summary

desktop

The virtual machine is intended to be used as a desktop.

server

The virtual machine is intended to be used as a server.

6.281.1. desktop

The virtual machine is intended to be used as a desktop. Currently, its implication is that a sound device will be automatically added to the virtual machine.

6.281.2. server

The virtual machine is intended to be used as a server. Currently, its implication is that a sound device will not be automatically added to the virtual machine.

6.282. VnicPassThrough struct

Table 1176. Attributes summary
Name Type Summary

mode

VnicPassThroughMode

Defines whether the vNIC will be implemented as a virtual device, or as a pass-through to a host device.

6.283. VnicPassThroughMode enum

The enum describes whether vNIC to be implemented as a pass-through device or a virtual one. Currently it supports only 2 option, but there is a plan to add more in the future.

Table 1177. Values summary
Name Summary

disabled

To be implemented as a virtual device

enabled

To be implemented as a pass-through device

6.284. VnicProfile struct

A vNIC profile is a collection of settings that can be applied to individual NIC.

Table 1178. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

custom_properties

CustomProperty[]

Custom properties applied to the vNIC profile.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

migratable

Boolean

Marks, whether pass_through NIC is migratable or not.

name

String

A human-readable name in plain text.

pass_through

VnicPassThrough

Enables the passthrough to a SR-IOV-enabled host NIC.

port_mirroring

Boolean

Enables port mirroring.

6.284.1. migratable

Marks, whether pass_through NIC is migratable or not.

If pass_through.mode is set to disabled this option has no meaning, and it will be considered to be true. If you omit this option from request, by default, this will be set to true.

When migrating virtual machine, this virtual machine will be migrated only if all pass_through NICs are flagged as migratable.

6.284.2. pass_through

Enables the passthrough to a SR-IOV-enabled host NIC.

A vNIC profile enables a NIC to be directly connected to a virtual function (VF) of an SR-IOV-enabled host NIC, if passthrough is enabled. The NIC will then bypass the software network virtualization and connect directly to the VF for direct device assignment.

The passthrough cannot be enabled if the vNIC profile is already attached to a NIC. If a vNIC profile has passthrough enabled, qos and port_mirroring are disabled for the vNIC profile.

6.284.3. port_mirroring

Enables port mirroring.

Port mirroring copies layer 3 network traffic on a given logical networkand host to a NIC on a virtual machine. This virtual machine can be used for network debugging and tuning, intrusion detection, and monitoring the behavior of other virtual machine on the same host and logical network. The only traffic copied is internal to one logical network on one host. There is no increase on traffic on the network external to the host; however a virtual machine with port mirroring enabled uses more host CPU and RAM than other virtual machines.

Port mirroring has the following limitations:

  • Hot plugging NIC with a vNIC profile that has port mirroring enabled is not supported.

  • Port mirroring cannot be altered when the vNIC profile is attached to a virtual machine.

Given the above limitations, it is recommended that you enable port mirroring on an additional, dedicated vNIC profile.

Enabling port mirroring reduces the privacy of other network users.
Table 1179. Links summary
Name Type Summary

network

Network

Reference to the network that the vNIC profile is applied to.

network_filter

NetworkFilter

Reference to the top-level network filter that apply to the NICs that use this profile.

permissions

Permission[]

Permissions to allow usage of the vNIC profile.

qos

Qos

Reference to the quality of service attributes to apply to the vNIC profile.

6.284.4. network_filter

Reference to the top-level network filter that apply to the NICs that use this profile.

Network filters will enhance the admin ability to manage the network packets traffic from/to the participated virtual machines. The network filter may either contain a references to other filters, rules for traffic filtering, or hold a combination of both.

6.284.5. qos

Reference to the quality of service attributes to apply to the vNIC profile.

Quality of Service attributes regulate inbound and outbound network traffic of the NIC.

6.285. VnicProfileMapping struct

Maps an external virtual NIC profile to one that exists in the engine.

Given the desired virtual NIC profiles mapping include the following 2 lines:

Source network name Source network profile name Target virtual NIC profile ID

red

gold

738dd914-8ec8-4a8b-8628-34672a5d449b

blue

silver

892a12ec-2028-4451-80aa-ff3bf55d6bac

It should be expressed in the following form:

<vnic_profile_mappings>
  <vnic_profile_mapping>
    <source_network_name>red</source_network_name>
    <source_network_profile_name>gold</source_network_profile_name>
    <target_vnic_profile id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </vnic_profile_mapping>
  <vnic_profile_mapping>
    <source_network_name>blue</source_network_name>
    <source_network_profile_name>silver</source_network_profile_name>
    <target_vnic_profile id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </vnic_profile_mapping>
</vnic_profile_mappings>
Table 1180. Attributes summary
Name Type Summary

source_network_name

String

Specifies the name of the external network.

source_network_profile_name

String

Specifies the name of the external network profile.
Table 1181. Links summary
Name Type Summary

target_vnic_profile

VnicProfile

Points to an existing virtual NIC profile.

6.286. VolumeGroup struct

Table 1182. Attributes summary
Name Type Summary

id

String

logical_units

LogicalUnit[]

name

String

6.287. Watchdog struct

This type represents a watchdog configuration.

Table 1183. Attributes summary
Name Type Summary

action

WatchdogAction

Watchdog action to be performed when watchdog is triggered.

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

id

String

A unique identifier.

model

WatchdogModel

Model of watchdog device.

name

String

A human-readable name in plain text.

6.287.1. model

Model of watchdog device. Currently supported only I6300ESB.

Table 1184. Links summary
Name Type Summary

instance_type

InstanceType

Optionally references to an instance type the device is used by.

template

Template

Optionally references to a template the device is used by.

vm

Vm

Don’t use this element, use vms instead.

vms

Vm[]

References to the virtual machines that are using this device.

6.287.2. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.288. WatchdogAction enum

This type describes available watchdog actions.

Table 1185. Values summary
Name Summary

dump

Virtual machine process will get core dumped to the default path on the host.

none

No action will be performed when watchdog action is triggered.

pause

Virtual machine will be paused when watchdog action is triggered.

poweroff

Virtual machine will be powered off when watchdog action is triggered.

reset

Virtual machine will be rebooted when watchdog action is triggered.

6.288.1. none

No action will be performed when watchdog action is triggered. However log message will still be generated.

6.289. WatchdogModel enum

This type represents the watchdog model.

Table 1186. Values summary
Name Summary

i6300esb

Currently only model supported is model I6300ESB.

6.290. Weight struct

Table 1187. Attributes summary
Name Type Summary

comment

String

Free text containing comments about this object.

description

String

A human-readable description in plain text.

factor

Integer

id

String

A unique identifier.

name

String

A human-readable name in plain text.
Table 1188. Links summary
Name Type Summary

scheduling_policy

SchedulingPolicy

scheduling_policy_unit

SchedulingPolicyUnit

Appendix A: Primitive types

This section describes the primitive data types supported by the API.

A.1. String primitive

A finite sequence of Unicode characters.

A.2. Boolean primitive

Represents the false and true concepts used in mathematical logic.

The valid values are the strings false and true.

Case is ignored by the engine, so for example False and FALSE also valid values. However the server will always return lower case values.

For backwards compatibility with older versions of the engine, the values 0 and 1 are also accepted. The value 0 has the same meaning than false, and 1 has the same meaning than true. Try to avoid using these values, as support for them may be removed in the future.

A.3. Integer primitive

Represents the mathematical concept of integer number.

The valid values are finite sequences of decimal digits.

Currently the engine implements this type using a signed 32 bit integer, so the minimum value is -231 (-2147483648) and the maximum value is 231-1 (2147483647).

However, there are some attributes in the system where the range of values possible with 32 bit isn’t enough. In those exceptional cases the engine uses 64 bit integers, in particular for the following attributes:

  • Disk.actual_size

  • Disk.provisioned_size

  • GlusterClient.bytes_read

  • GlusterClient.bytes_written

  • Host.max_scheduling_memory

  • Host.memory

  • HostNic.speed

  • LogicalUnit.size

  • MemoryPolicy.guaranteed

  • NumaNode.memory

  • QuotaStorageLimit.limit

  • StorageDomain.available

  • StorageDomain.used

  • StorageDomain.committed

  • VmBase.memory

For these exception cases the minimum value is -263 (-9223372036854775808) and the maximum value is 263-1 (9223372036854775807).

In the future the integer type will be implemented using unlimited precission integers, so the above limitations and exceptions will eventually disappear.

A.4. Decimal primitive

Represents the mathematical concept of real number.

Currently the engine implements this type using 32 bit IEEE 754 single precision floating point numbers.

For some attributes this isn’t enough precision. In those exceptional cases the engine uses 64 bit double precision floating point numbers, in particular for the following attributes:

  • QuotaStorageLimit.usage

  • QuotaStorageLimit.memory_limit

  • QuotaStorageLimit.memory_usage

In the future the decimal type will be implemented using unlimited precision decimal numbers, so the above limitations and exceptions will eventually disappear.

A.5. Date primitive

Represents a date and time.

The format returned by the engine is the one described in the XML Schema specification when requesting XML. For example, if you send a request like this to retrieve the XML representation of a virtual machine:

GET /ovirt-engine/api/vms/123
Accept: application/xml

The response body will contain the following XML document:

<vm id="123" href="/ovirt-engine/api/vms/123">
  ...
  <creation_time>2016-09-08T09:53:35.138+02:00</creation_time>
  ...
</vm>

When requesting the JSON representation the engine uses a different, format: an integer containing the number of seconds since Jan 1st 1970, also know as epoch time. For example, if you send a request like this to retrieve the JSON representation of a virtual machine:

GET /ovirt-engine/api/vms/123
Accept: application/json

The response body will contain the following JSON document:

{
  "id": "123",
  "href="/ovirt-engine/api/vms/123",
  ...
  "creation_time": 1472564909990,
  ...
}
In both cases, the dates returned by the engine use the time zone configured in the server where it is running, in the above examples it is UTC+2.

Appendix B: Changes in version 4 of the API

This section enumerates the backwards compatibility breaking changes that have been introduced in version 4 of the API.

B.1. Removed YAML support

The support for YAML has been completely removed.

B.2. Renamed complex types

The following XML schema complex types have been renamed:

Version 3 Version 4

API

Api

CPU

Cpu

CPUs

Cpus

CdRom

Cdrom

CdRoms

Cdroms

DNS

Dns

GuestNicConfiguration

NicConfiguration

GuestNicsConfiguration

NicConfigurations

HostNICStates

HostNicStates

HostNIC

HostNic

HostStorage

HostStorages

IO

Io

IP

Ip

IPs

Ips

KSM

Ksm

MAC

Mac

NIC

Nic

PreviewVMs

PreviewVms

QoS

Qos

QoSs

Qoss

RSDL

Rsdl

SELinux

SeLinux

SPM

Spm

SSHPublicKey

SshPublicKey

SSHPublicKeys

SshPublicKeys

SSH

Ssh

SkipIfSDActive

SkipIfSdActive

Slaves

HostNics

Storage

HostStorage

SupportedVersions

Versions

VCpuPin

VcpuPin

VLAN

Vlan

VM

Vm

VMs

Vms

VirtIO_SCSI

VirtioScsi

WatchDog

Watchdog

WatchDogs

Watchdogs

These renamings don’t affect users of the API, unless they are using the XML schema, either directly or indirectly via the Python or Java SDKs.

B.3. Replaced the Status type with enum types

Currently the status of different objects is reported using the Status type, which contains a state string describing the status and another detail string for additional details. For example, the status of a virtual machine that is paused due to an IO error is currently reported as follows:

<vm>
  ...
  <status>
    <state>paused</state>
    <detail>eio</detail>
  </status>
  ...
</vm>

In version 4 of the API this Status type has been removed and replaced by enum types. When the additional detail string is needed it has been replaced with an additional status_detail attribute. So, for example, the status of the same virtual machine will now be reported as follows:

<vm>
  ...
  <status>paused</status>
  <status_detail>eio</status_detail>
  ...
</vm>

B.4. Remove the NIC network and port_mirroring properties

The NIC network and port_mirroring elements have been replaced by the vnic_profile element, so when creating or updating a NIC instead of specifying the network and port mirroring configuration, these are previusly specified creating a vNIC profile:

POST /vnicprofiles
<vnic_profile>
  <name>myprofile</name>
  <network id="..."/>
  <port_mirroring>true</port_mirroring>
</vnic_profile>

And then the NIC is created or referencing the existing vNIC profile:

PUT /vms/{vm:id}/nics/{nic:id}
<nic>
  <vnic_profile id="/vnicprofiles/...">
</nic>

The old elements and their meaning were preserved for backwards compatibility, but they have now been completely removed.

Note that the network element hasn’t been removed from the XML schema because it is still used by the initialization element, but it will be completely ignored if provided when creating or updating a NIC.

B.5. Remove the NIC active property

The NIC active property was replaced by plugged some time ago. It has been completely removed now.

B.6. Remove the disk type property

The type property of disks has been removed, but kept in the XML schema and ignored. It has been completely removed now.

B.7. Remove the disk size property

The disk size property has been replaced by provisioned_size long ago. It has been completely removed now.

B.8. Removed support for pinning a VM to a single host

Before version 3.6 the API had the possibility to pin a VM to a single host, using the placement_policy element of the VM entity:

PUT /vms/{vm:id}
<vm>
  <placement_policy>
    <host id="{host:id}/">
  </placement_policy>
<vm>

In version 3.6 this capability was enhanced to support multiple hosts, and to do so a new hosts element was added:

PUT /vms/{vm:id}
<vm>
  <placement_policy>
    <hosts>
      <host id="{host:id}"/>
      <host id="{host:id}"/>
      ...
    </hosts>
  </placement_policy>
<vm>

To preserve backwards compatibility the single host element was preserved. In 4.0 this has been removed, so applications will need to use the hosts element even if when pinning to a single host.

B.9. Removed the capabilities.permits element

The list of permits is potentiall different for each cluster level, and it has been added to the version element long ago, but it has been kept into the capabilities element as well, just for backwards compatibility.

In 4.0 it the capabilities service has been completely removed, and replaced by the new clusterlevels service. To find the permits supported by cluster level 4.0 a request like this should be used:

GET /clusterlevels/4.0

The result will be a document containing the information specific to that cluster level, in particular the set of supported permits:

<cluster_level id="4.0" href="/clusterlevels/4.0">
  ...
  <permits>
    <permit id="1">
      <name>create_vm</name>
      <administrative>false</administrative>
    </permit>
    ...
  </permits>
</cluster_level>

B.10. Removed the storage_manager element

The storage_manager element was replaced by the spm element some time ago. The old one was kept for backwards compatibility, but it has been completely removed now.

B.11. Removed the data center storage_type element

Data centers used to be associated to a specific storage type (NFS, Fiber Channel, iSCSI, etc) but they have been changed some time so that there are only two types: with local storage and with shared storage. A new local element was introduced to indicate this, and the old storage_type was element was preserved for backwards compatibility. This old element has now been completely removed.

B.12. Remove the timezone element

The VM resource used to contain a timezone element to represent the time zone. This element only allowed a string:

<vm>
  <timezone>Europe/Madrid</timezone>
</vm>

This doesn’t allow extension, and as a it was necessary to add the UTC offset, it was replaced with a new structured time_zone element:

<vm>
  <time_zone>
    <name>Europe/Madrid</name>
    <utc_offset>GMT+1</utc_offset>
  </time_zone>
</vm>

The old timezone element was preserved, but it has been completely removed now.

B.13. Removed the guest_info element

The guest_info element was used to hold information gathered by the guest agent, like the IP addresses and the fully qualified host name. This information is also available in other places. For example, the IP addresses are available within VM resource:

GET /vms/{vm:id}
<vm>
  <guest_info>
    <ips>
      <ip address="192.168.122.30"/>
    </ips>
    <fqdn>whatever.example.com</fqdn>
  </guest_info>
</vm>

And also within the NIC resource, using the newer reported_devices element:

GET /vms/{vm:id}/nics/{nic:id}
<nic>
  <reported_devices>
    <reported_device>
      <name>eth0</name>
      <mac address="00:1a:4a:b5:4c:94"/>
      <ips>
        <ip address="192.168.1.115" version="v4"/>
        <ip address="fe80::21a:4aff:feb5:4c94" version="v6"/>
        <ip address="::1:21a:4aff:feb5:4c94" version="v6"/>
      </ips>
    </reported_device>
  </reported_devices>
</nic>

In addition this newer reported_devices element provides more complete information, like multiple IP addresses, MAC addresses, etc.

To remove this duplication the guest_info element has been removed.

To support the fully qualified domain name a new fqdn element has been added to the VM resource:

GET /vms/{vm:id}
<vm>
  <fqdn>whatever.example.com</fqdn>
</vms>

This will contain the same information that guest_info.fqdn used to contain.

B.14. Replaced CPU id attribute with type element

The cpu element used to have an id attribute that indicates the type of CPU:

<cpu id="Intel Conroe Family">
  <architecture>X86_64</architecture>
  ...
</cpu>

This is in contradiction with the rest of the elements of the API model, where the id attribute is used for opaque identifiers. This id attribute has been replaced with a new type element:

<cpu>
  <type>Intel Conroe Family</type>
  <architecture>X86_64</architecture>
</cpu>

B.15. Use elements instead of attributes in CPU topology

In the past the CPU topology element used attributes for its properties:

<cpu>
  <topology sockets="1" cores="1" threads="1"/>
  ...
</cpu>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<cpu>
  <topology>
    <sockets>1<sockets>
    <cores>1<cores>
    <threads>1<threads>
  </topology>
  ...
</cpu>

B.16. Use elements instead of attributes in VCPU pin

In the past the VCPU pin element used attributes for its properties:

<cpu_tune>
  <vcpu_pin vcpu="0" cpu_set="0"/>
</cpu_tune>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<cpu_tune>
  <vcpu_pin>
    <vcpu>0</vcpu>
    <cpu_set>0</cpu_set>
  </vcpu_pin>
</cpu_tune>

B.17. Use elements instead of attributes in VCPU pin

In the past the version element used attributes for its properties:

<version major="3" minor="5" ../>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<version>
  <major>3</minor>
  <minor>5</minor>
  ...
</version>

B.18. Use elements instead of attributes in memory overcommit

In the past the overcommit element used attributes for its properties:

<memory_policy>
  <overcommit percent="100"/>
  ...
</memory_policy>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<memory_policy>
  <overcommit>
    <percent>100</percent>
  </overcommit>
  ...
</memory_policy>

B.19. Use elements instead of attributes in console

In the past the console element used attributes for its properties:

<console enabled="true"/>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<console>
  <enabled>true</enabled>
</console>

B.20. Use elements instead of attributes in VIRTIO SCSI

In the past the VIRTIO ISCSI element used attributes for its properties:

<virtio_scsi enabled="true"/>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<virtio_scsi>
  <enabled>true</enabled>
</virtio_scsi>

B.21. Use element instead of attribute for power management agent type

The power management type property was represented as an attribute:

<agent type="apc">
  <username>myuser</username>
  ...
</agent>

This is contrary to the common practice in the API. It has been replaced with an inner element:

<agent>
  <type>apc</type>
  <username>myuser</username>
  ...
</agent>

B.22. Use elements instead of attributes in power management agent options

In the past the power management agent options element used attributes for its properties:

<options>
  <option name="port" value="22"/>
  <option name="slot" value="5"/>
  ...
</options>

This is contrary to the common practice in the API. They have been replaced with inner elements:

<options>
  <option>
    <name>port</name>
    <value>22</value>
  </option>
  <option>
    <name>slot</name>
    <value>5</value>
  </option>
  ...
</options>

B.23. Use elements instead of attributes in IP address:

In the past the IP address element used attributes for its properties:

<ip address="192.168.122.1" netmask="255.255.255.0"/>

This is contrary to the common practice in the API. They have been replaced with inner elements:

<ip>
  <address>192.168.122.1</address>
  <netmask>255.255.255.0</netmask>
</ip>

B.24. Use elements instead of attributes in MAC address:

In the past the MAC address element used attributes for its properties:

<mac address="66:f2:c5:5f:bb:8d"/>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<mac>
  <address>66:f2:c5:5f:bb:8d</address>
</mac>

B.25. Use elements instead of attributes in boot device:

In the past the boot device element used attributes for its properties:

<boot dev="cdrom"/>

This is contrary to the common practice in the API. They have been replaced by inner elements:

<boot>
  <dev>cdrom</dev>
</boot>

B.26. Use element instead of attribute for operating system type

The operating system type property was represented as an attribute:

<os type="other">
  ...
</os>

This is contrary to the common practice in the API. It has been replaced with an inner element:

<os>
  <type>other</type>
  ...
</os>

B.27. Removed the force parameter from the request to retrieve a host

The request to retrieve a host used to support a force matrix parameter to indicate that the data of the host should be refreshed (calling VDSM to reload host capabilities and devices) before retrieving it from the database:

GET /hosts/{host:id};force

This force parameter has been superseded by the host refresh action, but kept for backwards compatibility. It has been completely removed now. Applications that require this functionality should perform two requests, first one to refresh the host:

POST /hosts/{host:id}/refresh
<action/>

And then one to retrieve it, without the force parameter:

GET /hosts/{host:id}

B.28. Removed deprecated host power management configuration

The host power management configuration used to be part of the host resource, using embedded configuration elements:

<power_management type="apc">
  <enabled>true</enabled>
  <address>myaddress</address>
  <username>myaddress</username>
  <options>
    <option name="port" value="22/>
    </option name="slot" value="5/>
  </options>
  ...
</power_management>

This has been changed some time ago, in order to support multiple power management agents, introducing a new `/hosts/{host:id}fenceagents`collection.

The old type attribute, the old address, username and password elements, and the inner agents element directly inside power_management were preserved for backwards compatibility. All these elements have been completely removed, so the only way to query or modify the power management agents is now the /hosts/{host:id}/fenceagents sub-collection.

B.29. Use multiple boot.devices.device instead of multiple boot

In the past the way to specify the boot sequence when starting a virtual machine was to use multiple boot elements, each containing a dev element. For example, to specify that the virtual machine should first try to boot from CDROM and then from hard disk the following request was used:

POST /vms/{vm:id}/start
<action>
  <vm>
    ...
    <boot>
      <dev>cdrom</dev>
    </boot>
    <boot>
      <dev>hd</dev>
    </boot>
  </vm>
</action>

The common practice in other parts of the API is to represent arrays with a wrapper element. In that case that wrapper element could be named boots, but that doesn’t make much sense, as what can have multiple values here is the boot device, not the boot sequence. To fix this inconsistence this has been replaced with a single boot element that can contain multiple devices:

POST /vms/{vm:id}/start
<action>
  <vm>
    ...
    <boot>
      <devices>
        <device>cdrom</device>
        <device>hd</device>
      </devices>
    </boot>
  </vm>
</action>

B.30. Removed the disks.clone and disks.detach_only elements

These elements aren’t really part of the representation of disks, but parameters of the operations to add and remove virtual machines.

The disks.clone element was used to indicate that the disks of a new virtual machine have to be cloned:

POST /vms
<vm>
  ...
  <disks>
    <clone>true</clone>
  </disks>
<vm>

This has been now removed, and replaced by a new clone matrix parameter:

POST /vms;clone=true
<vm>
  ...
</vm>

The disks.detach_only element was used to indicate that when removing a virtual machine the disks don’t have to be removed, but just detached from the virtual machine:

DELETE /vms/{vm:id}
<action>
  <vm>
    <disks>
      <detach_only>true</detach_only>
    </disks>
  </vm>
</action>

This has been now removed, and replaced by a new detach_only matrix parameter:

DELETE /vms/{vm:id};detach_only=true

B.31. Rename element vmpool to vm_pool

The names of the elements that represent pools of virtual machines used to be vmpool and vmpools. They have been renamed to vm_pool and vm_pools in order to have a consistent correspondence between names of complex types (VmPool and VmPools in this case) and elements.

B.32. Use logical_units instead of multiple logical_unit

The logical units that are part of a volume group used to be reported as an unbounded number of logical_unit elements. For example, when reporting the details of a storage domain:

GET /storagedomains/{storagedomain:id}
<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_unit>
        <!-- First LU -->
      </logical_unit>
      <logical_unit>
        <!-- Second LU -->
      </logical_unit>
      ...
    </volume_group>
  </storage>
</storage_domain>

This is contrary to the usual practice in the API, as list of elements are always wrapped with an element. This has been fixed now, so the list of logical units will be wrapped with the logical_units element:

GET /storagedomains/{storagedomain:id}
<storage_domain>
  ...
  <storage>
    ...
    <volume_group>
      <logical_units>
        <logical_unit>
          <!-- First LU -->
        </logical_unit>
        <logical_unit>
          <!-- Second LU -->
        </logical_unit>
        ...
      </logical_units>
    </volume_group>
  </storage>
</storage_domain>

B.33. Removed the snapshots.collapse_snapshots element

This element isn’t really part of the representation of snapshots, but a parameter of the operation that imports a virtual machine from an export storage domain:

POST /storagedomains/{sd:id}/vms/{vm:id}/import
<action>
  <vm>
    <snapshots>
      <collapse_snapshots>true</collapse_snapshots>
    </snapshots>
  </vm>
</action>

This has been now removed, and replaced by a new collapse_snapshots matrix parameter:

POST /storagedomains/{sd:id}/vms/{vm:id}/import;collapse_snapshots
<action/>

B.34. Renamed storage and host_storage elements

The host storage collection used the storage and host_storage elements and the Storage and HostStorage complex types to report the storage associated to a host:

GET /hosts/{host:id}/storage
<host_storage>
  <storage>
    ...
  </storage>
  <storage>
    ...
  </storage>
  ...
</host_storage>

This doesn’t follow the pattern used in the rest of the API, where the outer element is a plural name and the inner element is the same name but in singular. This has now been changed to use host_storages as the outer element and host_storage as the inner element:

GET /hosts/{host:id}/storage
<host_storages>
  <host_storage>
    ...
  </host_storage>
  <host_storage>
    ...
  </host_storage>
  ...
</host_storage>

B.35. Removed the permissions.clone element

This element isn’t really part of the representation of permissions, but a parameter of the operations to create virtual machines or templates:

POST /vms
<vm>
  <template id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </template>
</action>
POST /templates
<template>
  <vm id="...">
    <permissions>
      <clone>true</clone>
    </permissions>
  </vm>
</template>

This has been now removed, and replaced by a new clone_permissions matrix parameter:

POST /vms;clone_permissions
<vm>
  <template id="..."/>
</vm>
POST /templates;clone_permissions
<template>
  <vm id="..."/>
</template>

B.36. Renamed the random number generator source elements

The random number generator sources used to be reported using a collection of source elements wrapped by an element with a name reflecting its use. For example, the required random number generator sources of a cluster used to be reported as follows:

GET /clusters/{cluster:id}
<cluster>
  ...
  <required_rng_sources>
    <source>RANDOM</source>
  </required_rng_sources>
  ...
</cluster>

And the random number generator sources suported by a host used to be reported as follows:

GET /hosts/{host:id}
<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <source>RANDOM</source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

This isn’t consistent with the rest of the API, where collections are wrapped by a name in plural and elements by the same name in singular. This has been now fixed. The required random number generator sources will now be reported as follows:

GET /clusters/{cluster:id}
<cluster>
  <required_rng_sources>
    <required_rng_sourcesRANDOM</required_rng_source>
  </required_rng_sources>
  ...
</cluster>

And the random number generator sources supported by a host will be reported as follows:

GET /hosts/{host:id}
<host>
  ...
  <hardware_information>
    <supported_rng_sources>
      <supported_rng_source>RANDOM</supported_rng_source>
    </supported_rng_sources>
  </hardware_information>
  ...
</host>

Note the use of required_rng_source and supported_rng_source instead of just source.

B.37. Removed the intermediate tag.parent element

The relationship bettween a tag and it’s parent tag used to be represented using an intermedite parent tag, that in turn contains another tag element:

<tag>
  <name>mytag</name>
  <parent>
    <tag id="..." href="..."/>
  </parent>
</tag>

This structure has been simplified so that only one parent element is used now:

<tag>
  <name>mytag</name>
  <parent id="..." href="..."/>
</tag>

B.38. Remove scheduling built-in names and thresholds

In the past the specification of scheduling policies for clusters was based in built-in names and thresholds. For example a cluster that used the evenly distributed scheduling policy was represented as follows:

<cluster>
  <name>mycluster</name>
  <scheduling_policy>
    <policy>evenly_distributed</policy>
    <thresholds high="80" duration="120"/>
  </scheduling_policy>
  ...
</cluster>

This mechanism was replaced with a top level /schedulingpolicies collection where scheduling policies can be defined with arbitrary names and properties. For example, the same scheduling policy is represented as follows in that top level collection:

<scheduling_policy>
  <name>evenly_distributed</name>
  <properties>
    <property>
      <name>CpuOverCommitDurationMinutes</name>
      <value>2</value>
    </property>
    <property>
      <name>HighUtilization</name>
      <value>80</value>
    </property>
  </properties>
</scheduling_policy>

The representation of the cluster references the scheduling policy with its identifier:

<cluster>
  <name>mycluster</name>
  <scheduling_policy id="..."/>
  ...
</cluster>

To preserve backwards compatibility the old policy and thresholds elements were preserved. The scheduling policy representation embedded within the cluster was also preserved. All these things have been completely removed now, so the only way to reference a scheduling policy when retrieving, creating or updating a cluster is to reference an existing one using its identifier. For example, when retrieving a cluster only the id (and href) will be populated:

GET /clusters/{cluster:id}
<cluster>
  ...
  <scheduling_policy id="..." href="..."/>
  ...
</cluster>

When creating or updating a cluster only the id will be accepted.

B.39. Removed the bricks.replica_count and bricks.stripe_count elements

These elements aren’t really part of the representation of a collection of bricks, but parameters of the operations to add and remove bricks. They have now been removed, and replaced by a new replica_count and stripe_count matrix parameters:

POST .../bricks;replica_count=3;stripe_count=2
DELETE .../bricks;replica_count=3

B.40. Renamed the statistics type property to kind

The statistics used to be represented using a type element that indicates the kind of statistic (gauge, counter, etc) and also a type attribute that indicates the type of the values (integer, string, etc):

<statistic>
  <type>GAUGE</type>
  <values type="INTEGER">
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

To avoid the use of the type concept for both things the first has been replaced by kind, and both kind and type are now elements:

<statistic>
  <kind>GAUGE</kind>
  <type>INTEGER</type>
  <values>
    <value>...</value>
    <value>...</value>
    ...
  </values>
</statistic>

B.41. Use multiple vcpu_pins.vcpu_pin instead of multiple vcpu_pin

In the past the way to specify the virtual to physical CPU pinning of a virtual machie was to use multiple vcpu_pin elements:

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pin>...</vcpu_pin>
      <vcpu_pin>...</vcpu_pin>
      ...
    </cpu_tune>
  </cpu>
</vm>

In order to conform to the common practice in other parts of the API this has been changed to use a wrapper element, in this case vcpu_pins:

<vm>
  <cpu>
    <cpu_tune>
      <vcpu_pins>
        <vcpu_pin>...</vcpu_pin>
        <vcpu_pin>...</vcpu_pin>
        ...
      </vcpu_pins>
    </cpu_tune>
  </cpu>
</vm>

B.42. Use force parameter to force remove a data center

The operation that removes a data center supports a force parameter. In order to use it the DELETE operation used to support an optional action parameter:

DELETE /datacenters/{datacenter:id}
<action>
  <force>true</force>
</action>

This optional action parameter has been replaced with an optional parameter:

DELETE /datacenters/{datacenter:id}?force=true

B.43. Use force matrix parameter to force remove a host

The operation that removes a host supports a force parameter. In order to use it the DELETE operation used to support an optional action parameter:

DELETE /host/{host:id}
<action>
  <force>true</force>
</action>

This optional action parameter has been replaced with an optional matrix parameter:

DELETE /host/{host:id};force=true

B.44. Use matrix parameters for force remove storage domain

The operation that removes a storage domain supports the force, destroy and host parameters. These parameters were passed to the DELETE method using the representation of the storage domain as the body:

DELETE /storagedomains/{storagedomain:id}
<storage_domain>
  <force>...</force>
  <destroy>...</destroy>
  <host id="...">
    <name>...</name>
  </host>
</storage_domain>

This was problematic, as the HTTP DELETE parameters shouldn’t have a body, and the representation of the storage domain shouldn’t include things that aren’t attributes of the storage domain, rather parameters of the operation.

The force, delete and host attributes have been replaced by equivalent matrix parameters, and the operation doesn’t now accept a body. For example, now the correct way to delete a storage domain with the force parameter is the following:

DELETE /storagedomain/{storagedomain:id};host=myhost;force=true

To delete with the destroy parameter:

DELETE /storagedomain/{storagedomain:id};host=myhost;destroy=true

B.45. Use host matrix parameter to remove storage server connection

The operation that removes a storage server connection supports a host parameter. In order to use it the DELETE method used to support an optional action parameter:

DELETE /storageconnections/{storageconnection:id}
<action>
  <host id="...">
    <name>...</name>
  </host>
</action>

This optional action parameter has been replaced with an optional matrix parameter:

DELETE /storageconnections/{storageconnection:id};host=myhost

B.46. Use force and storage_domain matrix parameters to remove template disks

The operation that removes a template disk supports the force and storage_domain parameters. In order to use it them the DELETE method used to support an optional action parameter:

DELETE /templates/{template:id}/disks/{disk:id}
<action>
  <force>...</force>
  <storage_domain id="..."/>
</action>

In version 4 of the API this operation has been moved to the new diskattachments collection, and the request body has been replaced with the query parameters force and storage_domain:

DELETE /templates/{template:id}/disksattachments/{attachment:id}?force=true
DELETE /templates/{template:id}/disksattachments/{attachment:id}?storage_domain=123

B.47. Don’t remove disks via the VM disk API

Removing an entity by deleting /vms/{vm:id}/disks/{disk:id} means removing the relationship between the VM and the disk - i.e., this operation should just detach the disk from the VM. This operation is no longer able to remove disks completely from the system, which was prone to user errors and had unreverseable consequences. To remove a disk, instead use the /disk/{disk:id} API:

DELETE /disks/{disk:id}

B.48. Use force matrix parameter to force remove a virtual machine

The operation that removes a virtual machine supports a force parameter. In order to use it the DELETE method used to support an optional action parameter:

DELETE /vms/{vm:id}
<action>
  <force>true</force>
</action>

This optional action parameter has been replaced with an optional matrix parameter:

DELETE /vms/{vm:id};force=true

B.49. Use POST instead of DELETE to remove multiple bricks

The operation that removes multiple Gluster bricks was implemented using the DELETE method and passing the list of bricks as the body of the request:

DELETE /clusters/{cluster:id}/glustervolumes/{volume:id}/bricks
<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

This is problematic because the DELETE method shouldn’t have a body, so it has been replaced with a new remove action that uses the POST method:

POST /clusters/{cluster:id}/glustervolumes/{volume:id}/bricks/remove
<bricks>
  <bricks id="..."/>
  <bricks id="..."/>
  ...
</bricks>

B.50. Removed the scheduling_policy.policy element

The element was kept for backward compatibility. Use scheduling_policy.name instead.

POST /schedulingpolicies
<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>
PUT /schedulingpolicies/{schedulingpolicy:id}
<scheduling_policy>
  ...
  <name>policy_name</name>
  ...
</scheduling_policy>

B.51. Added snapshot.snapshot_type

Enums are being gradually introduces to the API. Some fields which were string until now, are replaced with an appropriate enum. One such field is vm.type. But this field is inherited by snapshot, and snapshot type is different than vm type. So a new field has been added to snapshot entity: snapshot.snapshot_type.

<snapshot>
  ...
  <snapshot_type>regular|active|stateless|preview</snapshot_type>
  ...
</snapshot>

B.52. Removed move action from VM

The deprecated move action of the VM entity has been removed. Instead, you can move inidividual disks.

B.53. Moved reported_configurations.in_sync to network_attachment

In version 3 of the API the XML schema type ReportedConfigurations had a in_sync property:

<network_attachment>
  <reported_configurations>
    <in_sync>true</in_sync>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

In the specification mechanism used by version 4 of the API this can’t be expressed, because list types (the list of reported configurations) can’t have attributes. To be able to represent it the attribute has been moved to the enclosing network_attachment:

<network_attachment>
  <in_sync>true</in_sync>
  <reported_configurations>
    <reported_configuration>
      ...
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

B.54. Replaced capabilities with clusterlevels

The top level capabilities collection has been replaced by the new clusterlevels collection. This new collection will contain the information that isn’t available in the model, like the list of CPU types available for each cluster level:

GET /clusterlevels

This will return a list of ClusterLevel objects containing the details for all the cluster levels supported by the system:

<cluster_levels>
  <cluster_level id="3.6" href="/clusterlevels/3.6">
    <cpu_types>
      <cpu_type>
        <name>Intel Conroe Family</name>
        <level>2</level>
        <architecture>x86_64</architecture>
      </cpu_type>
      ...
    </cpu_types>
    ...
  </cluster_level>
</cluster_levels>

Each specific cluster level has it’s own subresource, identified by the version itself:

GET /clusterlevels/3.6

This will return the details of that version:

<cluster_level id="3.6" href="/clusterlevels/3.6">
  <cpu_types>
    <cpu_type>
      <name>Intel Conroe Family</name>
      <level>2</level>
      <architecture>x86_64</architecture>
    </cpu_type>
    ...
  </cpu_types>
  ...
</cluster_level>

B.55. Replaced disks with diskattachments

In version 3 of the API virtual machines and templates had a disks collection containing all the information of the disks attached to them. In version 4 of the API these disks collections have been removed and replaced with a new diskattachments collection that will contain only the references to the disk and the attributes that are specific of the relationship between disks and the virtual machine or template that they are attached to: interface and bootable.

To find what disks are attached to a virtual machine, for example, send a request like this:

GET /vms/{vm:id}/diskattachments

That will return a response like this:

<disk_attachments>
  <disk_attachment href="/vms/123/diskattachments/456" id="456">
    <bootable>false</bootable>
    <interface>virtio</interface>
    <disk href="/disks/456" id="456"/>
    <vm href="/vms/123" id="123"/>
  </disk_attachment>
  ...
<disk_attachments>

To find the rest of the details of the disk, follow the link provided.

Adding disks to a virtual machine or template uses the new disk_attachment element as well: request like this:

POST /vms/123/diskattachments

With the following body if the disk doesn’t exist and you want to create it:

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

Or with the following body if the disk already exists, and you just want to attach it to the virtual machine:

<disk_attachment>
  <bootable>false</bootable>
  <interface>virtio</interface>
  <disk id="456"/>
</disk_attachment>

Take into account that the vm.disks and template.disks attribtes have disk_attachments for all usages. For example, when creating a template the vm.disks element was used to indicate in which storage domain to create the disks of the template. This usage has also been replaced by vm.disk_attachments, so the request to creaate a template with disks in specific storage domains will now look like this:

<template>
  <name>mytemplate</name>
  <vm id="123">
    <disk_attachments>
      <disk_attachment>
        <disk id="456">
          <storage_domains>
            <storage_domain id="789"/>
          </storage_domains>
        </disk>
      </disk_attachment>
      ...
    </disk_attachments>
  </vm>
</template>

B.56. Use iscsi_targets element to discover unregistered storage

In version 3 of the API the operation to discover unregistered storage domains used to receive a list of iSCSI targets, using multiple iscsi_target elements:

POST /hosts/{host:id}/unregisteredstoragedomaindiscover
<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
  <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
</action>

In version 4 of the API all repeating elements, like iscsi_target in this case, are wrapped with another element, iscsi_targets in case. So the same request should now look like this:

POST /hosts/{host:id}/unregisteredstoragedomaindiscover
<action>
  <iscsi>
    <address>myiscsiserver</address>
  </iscsi>
  <iscsi_targets>
    <iscsi_target>iqn.2016-07.com.example:mytarget1</iscsi_target>
    <iscsi_target>iqn.2016-07.com.example:mytarget2</iscsi_target>
  </iscsi_targets>
</action>
1. HTTPS is described in RFC 2818 HTTP Over TLS.
2. Basic Authentication is described in RFC 2617 HTTP Authentication: Basic and Digest Access Authentication.