Chapter 3. Python Examples

3.1. Overview

This section provides examples demonstrating the steps to create a virtual machine within a basic Red Hat Virtualization environment, using the Python SDK.

These examples use the ovirtsdk Python library provided by the ovirt-engine-sdk-python package. This package is available to systems attached to a Red Hat Virtualization subscription pool in Red Hat Subscription Manager. See Section 1.2, “Installing the Python Software Development Kit” for more information on subscribing your system(s) to download the software.

You will also need:

A networked installation of Red Hat Virtualization Manager.
A networked and configured Red Hat Virtualization Host.
An ISO image file containing an operating system for installation on a virtual machine.
A working understanding of both the logical and physical objects that make up a Red Hat Virtualization environment.
A working understanding of the Python programming language.

The examples include placeholders for authentication details (admin@internal for user name, and redhat123 for password). Replace the placeholders with the authentication requirements of your environment.

Red Hat Virtualization Manager generates a globally unique identifier (GUID) for the id attribute for each resource. Identifier codes in these examples differ from the identifier codes in your Red Hat Virtualization environment.

The examples contain only basic exception and error handling logic. For more information on the exception handling specific to the SDK, see the pydoc for the ovirtsdk.infrastructure.errors module:

$ pydoc ovirtsdk.infrastructure.errors

3.2. Connecting to the Red Hat Virtualization Manager

3.2.1. Connecting to the Red Hat Virtualization Manager in Version 3

To connect to the Red Hat Virtualization Manager, you must create an instance of the API class from the ovirtsdk.api module by importing the class at the start of the script:

from ovirtsdk.api import API

The constructor of the API class takes a number of arguments. Supported arguments are:

url

Specifies the URL of the Manager to connect to, including the /api path. This parameter is mandatory.

username

Specifies the user name to connect. This parameter is mandatory.

password

Specifies the password for the user name provided by the username parameter. This parameter is mandatory.

kerberos

Uses a valid Kerberos ticket to authenticate the connection. Valid values are True and False. This parameter is optional.

key_file

Specifies a PEM formatted key file containing the private key associated with the certificate specified by cert_file. This parameter is optional.

cert_file

Specifies a PEM formatted client certificate to be used for establishing the identity of the client on the server. This parameter is optional.

ca_file

Specifies the certificate file of the certificate authority for the server. This parameter is mandatory unless the insecure parameter is set to True. The certificate is expected to be a copy of the one for the Manager’s Certificate Authority. For more information on obtaining the certificate, see the REST API Guide.

port

Specifies the port to connect using, where it has not been provided as component of the url parameter. This parameter is optional.

timeout

Specifies the amount of time in seconds that is allowed to pass before a request is to be considered as having timed out. This parameter is optional.

persistent_auth

Specifies whether persistent authentication is enabled for this connection. Valid values are True and False. This parameter is optional and defaults to False.

insecure

Allows a connection via SSL without certificate authority. Valid values are True and False. If the insecure parameter is set to False, which is the default, the ca_file must be supplied to secure the connection.

This option should be used with caution, as it may allow man-in-the-middle attackers to spoof the identity of the server.

filter

Specifies whether or not user permission based filter is on or off. Valid values are True and False. If the filter parameter is set to False - which is the default - then the authentication credentials provided must be those of an administrative user. If the filter parameter is set to True then any user can be used and the Manager will filter the actions available to the user based on their permissions.

debug

Specifies whether debug mode is enabled for this connection. Valid values are True and False. This parameter is optional.

Note

User names and passwords are written to the debug log, so handle it with care.

You can communicate with multiple Red Hat Virtualization Managers by creating and manipulating separate instances of the ovirtsdk.API Python class.

This example script creates an instance of the API class, checks that the connection is working using the test() method, and disconnects using the disconnect() method.

from ovirtsdk.api import API

api = API ( url="https://engine.example.com",
                username="admin@internal",
                password="redhat123",
                ca_file="ca.crt")

api.test()

print("Connected successfully!")

api.disconnect()

For a full list of supported methods, you can generate the documentation for the ovirtsdk.api module on the Manager machine:

$ pydoc ovirtsdk.api

3.2.2. Connecting to the Red Hat Virtualization Manager in Version 4

To connect to the Red Hat Virtualization Manager, you must create an instance of the Connection class from the ovirtsdk4.sdk module by importing the class at the start of the script:

import ovirtsdk4 as sdk

The constructor of the Connection class takes a number of arguments. Supported arguments are:

url: A string containing the base URL of the Manager, such as https://server.example.com/ovirt-engine/api.
username: Specifies the user name to connect, such as admin@internal. This parameter is mandatory.
password: Specifies the password for the user name provided by the username parameter. This parameter is mandatory.
token: An optional token to access the API, instead of a user name and password. If the token parameter is not specified, the SDK will create one automatically.
insecure: A Boolean flag that indicates whether the server’s TLS certificate and host name should be checked.
ca_file: A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If ca_file parameter is not set, the system-wide CA certificate store is used.
debug: A Boolean flag indicating whether debug output should be generated. If the value is True and the log parameter is not None, the data sent to and received from the server will be written to the log.
Note
User names and passwords are written to the debug log, so handle it with care.
Compression is disabled in debug mode, which means that debug messages are sent as plain text.
log: The logger where the log messages will be written.
kerberos: A Boolean flag indicating whether Kerberos authentication should be used instead of the default basic authentication.
timeout: The maximum total time to wait for the response, in seconds. A value of 0 (default) means to wait forever. If the timeout expires before the response is received, an exception is raised.
compress: A Boolean flag indicating whether the SDK should ask the server to send compressed responses. The default is True. This is a hint for the server, which may return uncompressed data even when this parameter is set to True. Compression is disabled in debug mode, which means that debug messages are sent as plain text.
sso_url: A string containing the base SSO URL of the server. The default SSO URL is computed from the url if no sso_url is provided.
sso_revoke_url: A string containing the base URL of the SSO revoke service. This needs to be specified only when using an external authentication service. By default, this URL is automatically calculated from the value of the url parameter, so that SSO token revoke will be performed using the SSO service, which is part of the Manager.
sso_token_name: The token name in the JSON SSO response returned from the SSO server. Default value is access_token.
headers: A dictionary with headers, which should be sent with every request.
connections: The maximum number of connections to open to the host. If the value is 0 (default), the number of connections is unlimited.
pipeline: The maximum number of requests to put in an HTTP pipeline without waiting for the response. If the value is 0 (default), pipelining is disabled.

import ovirtsdk4 as sdk

# Create a connection to the server:
connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

connection.test()

print("Connected successfully!")

connection.close()

For a full list of supported methods, you can generate the documentation for the ovirtsdk.api module on the Manager machine:

$ pydoc ovirtsdk.api

3.3. Listing Data Centers

The datacenters collection contains all the data centers in the environment.

Example 3.1. Listing data centers

These examples list the data centers in the datacenters collection and output some basic information about each data center in the collection.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    dc_list = api.datacenters.list()

    for dc in dc_list:
        print("%s (%s)" % (dc.get_name(), dc.get_id()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

dcs_service = connection.system_service().dcs_service()

dcs = dcs_service.list()

for dc in dcs:
    print("%s (%s)" % (dc.name, dc.id))

connection.close()

In an environment where only the Default data center exists, and it is not activated, the examples output the text:

Default (00000000-0000-0000-0000-000000000000)

3.4. Listing Clusters

The clusters collection contains all clusters in the environment.

Example 3.2. Listing clusters

These examples list the clusters in the clusters collection and output some basic information about each cluster in the collection.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    c_list = api.clusters.list()

    for c in c_list:
        print("%s (%s)" % (c.get_name(), c.get_id()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

cls_service = connection.system_service().clusters_service()

cls = cls_service.list()

for cl in cls:
    print("%s (%s)" % (cl.name, cl.id))

connection.close()

In an environment where only the Default cluster exists, the examples output the text:

Default (00000000-0000-0000-0000-000000000000)

3.5. Listing Hosts

The hosts collection contains all hosts in the environment.

Example 3.3. Listing hosts

These examples list the hosts in the hosts collection and their IDs.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API(url="https://engine.example.com/ovirt-engine/api",
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    h_list = api.hosts.list()

    for h in h_list:
        print("%s (%s)" % (h.get_name(), h.get_id()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

host_service = connection.system_service().hosts_service()

hosts = host_service.list()

for host in hosts:
    print("%s (%s)" % (host.name, host.id))

connection.close()

In an environment where only one host, MyHost, has been attached, the examples output the text:

MyHost (00000000-0000-0000-0000-000000000000)

3.6. Listing Logical Networks

The networks collection contains all logical networks in the environment.

Example 3.4. Listing logical networks

These examples list the logical networks in the networks collection and outputs some basic information about each network in the collection.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API(url="https://engine.example.com/ovirt-engine/api",
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    n_list = api.networks.list()

    for n in n_list:
        print("%s (%s)" % (n.get_name(), n.get_id()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

nws_service = connection.system_service().networks_service()

nws = nws_service.list()

for nw in nws:
    print("%s (%s)" % (nw.name, nw.id))

connection.close()

In an environment where only the default management network exists, the examples output the text:

ovirtmgmt (00000000-0000-0000-0000-000000000000)

3.7. Listing Virtual Machines and Total Disk Size

The vms collection contains a disks collection that describes the details of each disk attached to a virtual machine.

Example 3.5. Listing virtual machines and total disk size

These examples print a list of virtual machines and their total disk size in bytes:

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    virtual_machines = api.vms.list()

    if len(virtual_machines) > 0:

        print("%-30s  %s" % ("Name","Disk Size"))
        print("==================================================")

        for virtual_machine in virtual_machines:
            disks = virtual_machine.disks.list()
            disk_size = 0
            for disk in disks:
                disk_size += disk.get_size()

            print("%-30s: %d" % (virtual_machine.get_name(), disk_size))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

vms_service = connection.system_service().vms_service()

vms = vms_service.list()

virtual_machines = vms.list()

if len(virtual_machines) > 0:

    print("%-30s  %s" % ("Name","Disk Size"))
    print("==================================================")

    for virtual_machine in virtual_machines:
        vm_service = vms_service.vm_service(virtual_machine.id)
        disk_attachments = vm_service.disk_attachments_service().list()
        disk_size = 0
        for disk in disks:
            disk = connection.follow_link(disk_attachment.disk)
            disk_size += disk.provisioned_size

            print("%-30s: %d" % (virtual_machine.name(), disk_size))

The examples output the virtual machine names and their disk sizes:

Name                          Disk Size
==================================================
vm1                           50000000000

3.8. Creating NFS Data Storage

When a Red Hat Virtualization environment is first created, it is necessary to define at least a data storage domain and an ISO storage domain. The data storage domain stores virtual disks while the ISO storage domain stores the installation media for guest operating systems.

The storagedomains collection contains all the storage domains in the environment and can be used to add and remove storage domains.

Note

The code provided in this example assumes that the remote NFS share has been pre-configured for use with Red Hat Virtualization. See the Administration Guide for more information on preparing NFS shares.

Example 3.6. Creating NFS data storage

These examples add an NFS data domain to the storagedomains collection. For V3, adding an NFS storage domain can be broken down into several steps:

Identify the data center to which the storage must be attached, using the get method of the datacenters collection.
```
dc = api.datacenters.get(name="Default")
```
Identify the host that must be used to attach the storage, using the get method of the hosts collection.
```
h = api.hosts.get(name="myhost")
```
Define the Storage parameters for the NFS storage domain. In this example the NFS location 192.0.43.10/storage/data is being used.
```
s = params.Storage(address="_IP_address_", path="/storage/data", type_="nfs")
```
Request creation of the storage domain, using the add method of the storagedomains collection. In addition to the Storage parameters it is necessary to pass:
- A name for the storage domain.
- The data center object that was retrieved from the datacenters collection.
- The host object that was retrieved from the hosts collection.
- The type of storage domain being added (data, iso, or export).
- The storage format to use (v1, v2, or v3).

Once these steps are combined, the completed script is:

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    dc = api.datacenters.get(name="Default")
    h = api.hosts.get(name="myhost")

    s = params.Storage(address="_IP_address_", path="/storage/data", type_="nfs")
    sd_params = params.StorageDomain(name="mydata", data_center=dc, host=h, type_="data", storage_format="v3", storage=s)

    try:
        sd = api.storagedomains.add(sd_params)
        print("Storage Domain '%s' added (%s)." % (sd.get_name(), sd.get_id()))

    api.disconnect()

For V4, the add method is used to add the new storage domain and the types class is used to pass the parameters.

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

# Create the connection to the server:
connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the storage domains service:
sds_service = connection.system_service().storage_domains_service()

# Create a new NFS storage domain:
sd = sds_service.add(
    types.StorageDomain(
        name='mydata',
        description='My data',
        type=types.StorageDomainType.DATA,
        host=types.Host(
            name='myhost',
        ),
        storage=types.HostStorage(
            type=types.StorageType.NFS,
            address='_FQDN_',
            path='/nfs/ovirt/path/to/mydata',
        ),
    ),
)

# Wait until the storage domain is unattached:
sd_service = sds_service.storage_domain_service(sd.id)
while True:
    time.sleep(5)
    sd = sd_service.get()
    if sd.status == types.StorageDomainStatus.UNATTACHED:
        break

print("Storage Domain '%s' added (%s)." % (sd.name(), sd.id()))

connection.close()

If the add method call is successful, the examples output the text:

Storage Domain 'mydata' added (00000000-0000-0000-0000-000000000000).

3.9. Creating NFS ISO Storage

To create a virtual machine, you need installation media for the guest operating system. The installation media are stored in an ISO storage domain.

Note

Example 3.7. Creating NFS ISO storage

These examples add an NFS ISO domain to the storagedomains collection. For V3, adding an NFS storage domain can be broken down into several steps:

Identify the data center to which the storage must be attached, using the get method of the datacenters collection.
```
dc = api.datacenters.get( name="Default" )
```
Identify the host that must be used to attach the storage, using the get method of the hosts collection.
```
h = api.hosts.get(name="myhost")
```
Define the Storage parameters for the NFS storage domain. In this example the NFS location FQDN/storage/iso is being used.
```
s = params.Storage(address="_IP_address_", path="/storage/iso", type_="nfs")
```
Request creation of the storage domain, using the add method of the storagedomains collection. In addition to the Storage parameters it is necessary to pass:
- A name for the storage domain.
- The data center object that was retrieved from the datacenters collection.
- The host object that was retrieved from the hosts collection.
- The type of storage domain being added (data, iso, or export).
- The storage format to use (v1, v2, or v3).

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    dc = api.datacenters.get(name="Default")
    h = api.hosts.get(name="myhost")

    s = params.Storage(address="_IP_address_", path="/storage/iso", type_="nfs")
    sd_params = params.StorageDomain(name="myiso", data_center=dc, host=h, type_="iso", storage_format="v3", storage=s)

    try:
        sd = api.storagedomains.add(sd_params)
        print("Storage Domain '%s' added (%s)." % (sd.get_name(), sd.get_id()))

    api.disconnect()

For V4, the add method is used to add the new storage domain and the types class is used to pass the parameters.

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the storage domains service:
sds_service = connection.system_service().storage_domains_service()

# Use the "add" method to create a new NFS storage domain:
sd = sds_service.add(
    types.StorageDomain(
        name='myiso',
        description='My ISO',
        type=types.StorageDomainType.ISO,
        host=types.Host(
            name='myhost',
        ),
        storage=types.HostStorage(
            type=types.StorageType.NFS,
            address='FQDN',
            path='/nfs/ovirt/path/to/myiso',
        ),
    ),
)

# Wait until the storage domain is unattached:
sd_service = sds_service.storage_domain_service(sd.id)
while True:
    time.sleep(5)
    sd = sd_service.get()
    if sd.status == types.StorageDomainStatus.UNATTACHED:
        break

print("Storage Domain '%s' added (%s)." % (sd.name(), sd.id()))

# Close the connection to the server:
connection.close()

If the add method call is successful, the examples output the text:

Storage Domain 'myiso' added (00000000-0000-0000-0000-000000000000).

3.10. Attaching a Storage Domain to a Data Center

Once you have added a storage domain to Red Hat Virtualization, you must attach it to a data center and activate it before it will be ready for use.

Example 3.8. Attaching a storage domain to a data center

These examples attach an existing NFS storage domain, mydata, to the an existing data center, Default. The attach action is facilitated by the add method of the data center’s storagedomains collection. These examples may be used to attach both data and ISO storage domains.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    dc = api.datacenters.get(name="Default")

    sd_data = api.storagedomains.get(name="mydata")

    try:
        dc_sd = dc.storagedomains.add(sd_data)
        print("Attached data storage domain '%s' to data center '%s' (Status: %s)." %
		    (dc_sd.get_name(), dc.get_name(), dc_sd.get_status.get_state()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

# Create the connection to the server:
connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Locate the service that manages the storage domains and use it to
# search for the storage domain:
sds_service = connection.system_service().storage_domains_service()
sd = sds_service.list(search='name=mydata')[0]

# Locate the service that manages the data centers and use it to
# search for the data center:
dcs_service = connection.system_service().data_centers_service()
dc = dcs_service.list(search='name=Default')[0]

# Locate the service that manages the data center where we want to
# attach the storage domain:
dc_service = dcs_service.data_center_service(dc.id)

# Locate the service that manages the storage domains that are attached
# to the data centers:
attached_sds_service = dc_service.storage_domains_service()

# Use the "add" method of service that manages the attached storage
# domains to attach it:
attached_sds_service.add(
    types.StorageDomain(
        id=sd.id,
    ),
)

# Wait until the storage domain is active:
attached_sd_service = attached_sds_service.storage_domain_service(sd.id)
while True:
    time.sleep(5)
    sd = attached_sd_service.get()
    if sd.status == types.StorageDomainStatus.ACTIVE:
        break

print("Attached data storage domain '%s' to data center '%s' (Status: %s)." %
  (sd.name(), dc.name(), sd.status.state()))

# Close the connection to the server:
connection.close()

If the calls to the add methods are successful, the examples output the following text:

Attached data storage domain 'data1' to data center 'Default' (Status: maintenance).

Status: maintenance indicates that the storage domains still need to be activated.

3.11. Activating a Storage Domain

Once you have added a storage domain to Red Hat Virtualization and attached it to a data center, you must activate it before it will be ready for use.

Example 3.9. Activating a storage domain

These examples activate an NFS storage domain, mydata, attached to the data center, Default. The activate action is facilitated by the activate method of the storage domain.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
             username='admin@internal',
             password='redhat123',
             ca_file='ca.pem')

    dc = api.datacenters.get(name="Default")

    sd_data = dc.storagedomains.get(name="mydata")

    try:
        sd_data.activate()
        print("Activated storage domain '%s' in data center '%s' (Status: %s)." %
		      (sd_data.get_name(), dc.get_name(), sd_data.get_status.get_state()))

    api.disconnect()

import ovirtsdk4 as sdk

connection = sdk.Connection
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Locate the service that manages the storage domains and use it to
# search for the storage domain:
sds_service = connection.system_service().storage_domains_service()
sd = sds_service.list(search='name=mydata')[0]

# Locate the service that manages the data centers and use it to
# search for the data center:
dcs_service = connection.system_service().data_centers_service()
dc = dcs_service.list(search='name=Default')[0]

# Locate the service that manages the data center where we want to
# attach the storage domain:
dc_service = dcs_service.data_center_service(dc.id)

# Locate the service that manages the storage domains that are attached
# to the data centers:
attached_sds_service = dc_service.storage_domains_service()

# Activate storage domain:
attached_sd_service = attached_sds_service.storage_domain_service(sd.id)
attached_sd_service.activate()

# Wait until the storage domain is active:
while True:
    time.sleep(5)
    sd = attached_sd_service.get()
    if sd.status == types.StorageDomainStatus.ACTIVE:
        break

print("Attached data storage domain '%s' to data center '%s' (Status: %s)." %
  (sd.name(), dc.name(), sd.status.state()))

# Close the connection to the server:
connection.close()

If the activate requests are successful, the examples output the text:

Activated storage domain 'mydata' in data center 'Default' (Status: active).

Status: active indicates that the storage domains have been activated.

3.12. Listing Files in an ISO Storage Domain

The storagedomains collection contains a files collection that describes the files in a storage domain.

Example 3.10. Listing Files in an ISO Storage Domain

These examples print a list of the ISO files in each ISO storage domain:

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    storage_domains = api.storagedomains.list()

    for storage_domain in storage_domains:
        if(storage_domain.get_type() == "iso"):

            print(storage_domain.get_name() + ":\n")

            files = storage_domain.files.list()

            for file in files:
                print("%s" % file.get_name())

            print()

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

storage_domains_service = connection.system_service().storage_domains_service()

storage_domains = storage_domains_service.list()

for storage_domain in storage_domains:
    if(storage_domain.type == types.StorageDomainType.ISO):
        print(storage_domain.name + ":\n")
        files = storage_domain.files_service().list()

        for file in files:
            print("%s" % file.name + "\n")

connection.close()

The examples output the text:

ISO_storage_domain:
file1
file2

3.13. Creating a Virtual Machine

Virtual machine creation is performed in several steps. The first step, covered here, is to create the virtual machine object itself.

Example 3.11. Creating a virtual machine

These examples create a virtual machine, vm1, with the following requirements:

512 MB of memory, expressed in bytes.
Attached to the Default cluster, and therefore the Default data center.
Based on the default Blank template.
Boots from the virtual hard disk drive.

In V3, the virtual machine options are combined into a virtual machine parameter object, before using the add method of the vms collection to create the virtual machine itself.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    vm_name = "vm1"
    vm_memory = 512*1024*1024
    vm_cluster = api.clusters.get(name="Default")
    vm_template = api.templates.get(name="Blank")
    vm_os = params.OperatingSystem(boot=[params.Boot(dev="hd")])

    vm_params = params.VM(name=vm_name,
                            memory=vm_memory,
                            cluster=vm_cluster,
                            template=vm_template,
                            os=vm_os)

    try:
        api.vms.add(vm=vm_params)
        print("Virtual machine '%s' added." % vm_name)

    api.disconnect()

In V4, the options are added as types, using the add method.

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

# Use the "add" method to create a new virtual machine:
vms_service.add(
    types.Vm(
        name='vm1',
        memory = 512*1024*1024
        cluster=types.Cluster(
            name='Default',
        ),
        template=types.Template(
            name='Blank',
        ),
        os=types.OperatingSystem(boot=types.Boot(devices=[types.BootDevice.HD)]
    ),
)

print("Virtual machine '%s' added." % vm.name)

# Close the connection to the server:
connection.close()

If the add request is successful, the examples output the text:

Virtual machine 'vm1' added.

3.14. Creating a Virtual NIC

To ensure that a newly created virtual machine has network access, you must create and attach a virtual NIC.

Example 3.12. Creating a virtual NIC

These examples create a NIC, nic1, and attach it to a virtual machine, vm1. The NIC in this example is a virtio network device and attached to the ovirtmgmt management network.

In V3, these options are combined into an NIC parameter object, before using the add method of the virtual machine’s nics collection to create the NIC.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    vm = api.vms.get(name="vm1")

    nic_name = "nic1"
    nic_interface = "virtio"
    nic_network = api.networks.get(name="ovirtmgmt")
    nic_params = params.NIC(name=nic_name, interface=nic_interface, network=nic_network)

    try:
        nic = vm.nics.add(nic_params)
        print("Network interface '%s' added to '%s'." % (nic.get_name(), vm.get_name()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Locate the virtual machines service and use it to find the virtual
# machine:
vms_service = connection.system_service().vms_service()
vm = vms_service.list(search='name=vm1')[0]

# Locate the service that manages the network interface cards of the
# virtual machine:
nics_service = vms_service.vm_service(vm.id).nics_service()

# Use the "add" method of the network interface cards service to add the
# new network interface card:
nics_service.add(
    types.Nic(
        name='nic1',
        interface='virtio',
        network='ovirtmgmt',
    ),
)

print("Network interface '%s' added to '%s'." % (nic.name(), vm.name()))

connection.close()

If the add request is successful, the examples output the text:

Network interface 'nic1' added to 'vm1'.

3.15. Creating a Virtual Machine Disk

To ensure that a newly created virtual machine has access to persistent storage, you must create and attach a disk.

Example 3.13. Creating a virtual machine disk

These examples create an 8 GB virtio disk and attach it to a virtual machine, vm1. The disk has the following requirements:

Stored on the storage domain named data1.
8 GB in size.
system type disk (as opposed to data).
virtio storage device.
COW format.
Marked as a usable boot device.

In V3, the options are combined into a disk parameter object, before using the add method of the virtual machine’s disks collection to create the disk itself.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
               username='admin@internal',
               password='redhat123',
               ca_file='ca.pem')

    vm = api.vms.get(name='vm1')

    sd = params.StorageDomains(storage_domain=[api.storagedomains.get(name='data1')])
    disk_size = 8*1024*1024
    disk_type = 'system'
    disk_interface = 'virtio'
    disk_format = 'cow'
    disk_bootable = True

    disk_params = params.Disk(storage_domains=sd,
        size=disk_size,
        type_=disk_type,
        interface=disk_interface,
        format=disk_format,
        bootable=disk_bootable)

    try:
        d = vm.disks.add(disk_params)
        print("Disk '%s' added to '%s'." % (d.get_name(), vm.get_name()))

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Locate the virtual machines service and use it to find the virtual
# machine:
vms_service = connection.system_service().vms_service()
vm = vms_service.list(search='name=vm1')[0]

# Locate the service that manages the disk attachments of the virtual
# machine:
disk_attachments_service = vms_service.vm_service(vm.id).disk_attachments_service()

# Use the "add" method of the disk attachments service to add the disk.
# Note that the size of the disk, the `provisioned_size` attribute, is
# specified in bytes, so to create a disk of 10 GiB the value should
# be 10 * 2^30.
disk_attachment = disk_attachments_service.add(
    types.DiskAttachment(
        disk=types.Disk(
            format=types.DiskFormat.COW,
            provisioned_size=8*1024*1024,
            storage_domains=[
                types.StorageDomain(
                    name='data1',
                ),
            ],
        ),
        interface=types.DiskInterface.VIRTIO,
        bootable=True,
        active=True,
    ),
)

# Wait until the disk status is OK:
disks_service = connection.system_service().disks_service()
disk_service = disks_service.disk_service(disk_attachment.disk.id)
while True:
    time.sleep(5)
    disk = disk_service.get()
    if disk.status == types.DiskStatus.OK:
        break

print("Disk '%s' added to '%s'." % (disk.name(), vm.name()))

# Close the connection to the server:
connection.close()

If the add request is successful, the examples output the text:

Disk 'vm1_Disk1' added to 'vm1'.

3.16. Attaching an ISO Image to a Virtual Machine

To install a guest operating system on a newly created virtual machine, you must attach an ISO file containing the operating system installation media. To locate the ISO file, see Section 3.12, “Listing Files in an ISO Storage Domain”.

Example 3.14. Attaching an ISO image to a virtual machine

These examples attach my_iso_file.iso to the vm1 virtual machine, using the add method of the virtual machine’s cdroms collection.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API(url='https://engine.example.com/ovirt-engine/api',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    sd = api.storagedomains.get(name='iso1')

    cd_iso = sd.files.get(name='my_iso_file.iso')
    cd_vm = api.vms.get(name='vm1')
    cd_params = params.CdRom(file=cd_iso)

try:
    cd_vm.cdroms.add(cd_params)
    print("Attached CD to '%s'." % cd_vm.get_name())

api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

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

# Locate the service that manages the virtual machine:
vm_service = vms_service.vm_service(vm.id)

# Locate the service that manages the CDROM devices of the virtual machine:
cdroms_service = vm_service.cdroms_service()

# Get the first CDROM:
cdrom = cdroms_service.list()[0]

# Locate the service that manages the CDROM device found in previous step:
cdrom_service = cdroms_service.cdrom_service(cdrom.id)

# Change the CD of the VM to 'my_iso_file.iso'. By default the
# operation permanently changes the disk that is visible to the
# virtual machine after the next boot, but has no effect
# on the currently running virtual machine. If you want to change the
# disk that is visible to the current running virtual machine, change
# the `current` parameter's value to `True`.
cdrom_service.update(
    cdrom=types.Cdrom(
        file=types.File(
            id='my_iso_file.iso'
        ),
    ),
    current=False,
)

print("Attached CD to '%s'." % vm.name())

# Close the connection to the server:
connection.close()

If the add request is successful, the examples output the text:

Attached CD to 'vm1'.

Example 3.15. Ejecting a cdrom from a virtual machine

These examples eject an ISO image from a virtual machine’s cdrom collection.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API(url='https://engine.example.com/ovirt-engine/api',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    sd = api.storagedomains.get(name='iso1')
    vm = api.vms.get(name='vm1')

    try:
        vm.cdroms.get(id='00000000-0000-0000-0000-000000000000').delete()
        print("Removed CD from '%s'." % vm.get_name())

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

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

# Locate the service that manages the virtual machine:
vm_service = vms_service.vm_service(vm.id)

# Locate the service that manages the CDROM devices of the VM:
cdroms_service = vm_service.cdroms_service()

# Get the first found CDROM:
cdrom = cdroms_service.list()[0]

# Locate the service that manages the CDROM device found in previous step
# of the VM:
cdrom_service = cdroms_service.cdrom_service(cdrom.id)

cdrom_service.remove()

print("Removed CD from '%s'." % vm.name())

connection.close()

If the delete or remove request is successful, the examples output the text:

Removed CD from 'vm1'.

3.17. Detaching a Disk

You can detach a disk from a virtual machine.

Example 3.16. Detaching a disk

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API(url="https://engine.example.com/ovirt-engine/api",
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    vm = api.vms.get(name="VM_NAME")
    disk = vm.disks.get(name="DISK_NAME")

    detach = params.Action(detach=True)
    disk.delete(action=detach)

    print("Detached disk %s successfully!" % disk)

    api.disconnect()

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

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

# Locate the service that manages the virtual machine:
vm_service = vms_service.vm_service(vm.id)

attachments_service = vm_service.disk_attachments_service()
attachment = next(
    (a for a in disk_attachments if a.disk.id == disk.id), None
)

# Remove the attachment. The default behavior is that the disk is detached
# from the virtual machine, but not deleted from the system. If you wish to
# delete the disk, change the detach_only parameter to "False".
attachment.remove(detach_only=True)

print("Detached disk %s successfully!" % attachment)

# Close the connection to the server:
connection.close()

If the delete or remove request is successful, the examples output the text:

Detached disk vm1_disk1 successfully!

3.18. Starting a Virtual Machine

You can start a virtual machine.

Example 3.17. Starting a virtual machine

These examples start the virtual machine using the start method.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')

    vm = api.vms.get(name="vm1")

    try:
        vm.start()
        print("Started '%s'." % vm.get_name())

    api.disconnect()

import time
import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

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

# Locate the service that manages the virtual machine, as that is where
# the action methods are defined:
vm_service = vms_service.vm_service(vm.id)

# Call the "start" method of the service to start it:
vm_service.start()

# Wait until the virtual machine is up:
while True:
    time.sleep(5)
    vm = vm_service.get()
    if vm.status == types.VmStatus.UP:
        break

print("Started '%s'." % vm.name())

# Close the connection to the server:
connection.close()

If the start request is successful, the examples output the text:

Started 'vm1'.

The UP status indicates that the virtual machine is running.

3.19. Starting a Virtual Machine with Overridden Parameters

You can start a virtual machine, overriding its default parameters.

Example 3.18. Starting a virtual machine with overridden parameters

These examples boot a virtual machine with a Windows ISO and attach the virtio-win_x86.vfd floppy disk, which contains Windows drivers. This action is equivalent to using the Run Once window in the Administration Portal to start a virtual machine.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')
try:
    vm = api.vms.get(name="vm1")

cdrom = params.CdRom(file=params.File(id='windows_example.iso'))
floppy = params.Floppy(file=params.File(id='virtio-win_x86.vfd'))
try:
    vm.start(
        action=params.Action(
            vm=params.VM(
            os=params.OperatingSystem(
                boot=[params.Boot(dev='cdrom')]),
                cdroms=params.CdRoms(cdrom=[cdrom]),
                floppies=params.Floppies(floppy=[floppy])
            )
        )
    )

import time
import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Get the reference to the "vms" service:
vms_service = connection.system_service().vms_service()

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

# Locate the service that manages the virtual machine:
vm_service = vms_service.vm_service(vm.id)

# Locate the service that manages the CDROM devices of the virtual machine:
cdroms_service = vm_service.cdroms_service()

# Get the first CDROM:
cdrom = cdroms_service.list()[0]

# Locate the service that manages the CDROM device found in previous step:
cdrom_service = cdroms_service.cdrom_service(cdrom.id)

# Change the CD of the VM to 'windows_example.iso':
cdrom_service.update(
    cdrom=types.Cdrom(
        file=types.File(
            id='windows_example.iso'
        ),
    ),
    current=False,
)

# Call the "start" method of the service to start it:
vm_service.start(
    vm=types.Vm(
        os=types.OperatingSystem(
            boot=types.Boot(
                devices=[
                    types.BootDevice.CDROM,
                ]
            )
        ),
    )
)

# Wait until the virtual machine's status is "UP":
while True:
    time.sleep(5)
    vm = vm_service.get()
    if vm.status == types.VmStatus.UP:
        break

print("Started '%s'." % vm.name())

# Close the connection to the server:
connection.close()

Note

The CD image and floppy disk file must be available to the virtual machine. See Uploading Images to a Data Storage Domain for details.

3.20. Starting a Virtual Machine with Cloud-Init

You can start a virtual machine with a specific configuration, using the Cloud-Init tool.

Example 3.19. Starting a virtual machine with Cloud-Init

These examples show you how to start a virtual machine using the Cloud-Init tool to set a host name and a static IP for the eth0 interface.

from ovirtsdk.api import API
from ovirtsdk.xml import params

try:
    api = API (url='https://engine.example.com',
                username='admin@internal',
                password='redhat123',
                ca_file='ca.pem')
try:
    vm = api.vms.get(name="vm1")

try:
    vm.start(
    use_cloud_init=True,
        action=params.Action(
            vm=params.VM(
                initialization=params.Initialization(
                    cloud_init=params.CloudInit(
                        host=params.Host(address="MyHost.example.com"),
                        network_configuration=params.NetworkConfiguration(
                        nics=params.Nics(
                        nic=[params.NIC(
                        name="eth0",
                        boot_protocol="static",
                        on_boot=True,
                        network=params.Network(
                        ip=params.IP(
                        address="10.10.10.1",
                        netmask="255.255.255.0",
                        gateway="10.10.10.1"
                                            )
                                        )
                                    )
                                ]
                            )
                        )
                    )
                )
            )
        )
    )

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

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

# Find the service that manages the virtual machine:
vm_service = vms_service.vm_service(vm.id)

# Start the virtual machine enabling cloud-init and providing the
# password for the `root` user and the network configuration:
vm_service.start(
    use_cloud_init=True,
    vm=types.Vm(
        initialization=types.Initialization(
        user_name='root',
        root_password='redhat123',
        host_name='MyHost.example.com',
        nic_configurations=[
            types.NicConfiguration(
                name='eth0',
                on_boot=True,
                boot_protocol=types.BootProtocol.STATIC,
                ip=types.Ip(
                    version=types.IpVersion.V4,
                    address='10.10.10.1',
                    netmask='255.255.255.0',
                    gateway='10.10.10.1'
                )
            )
        )
    )
)

# Close the connection to the server:
connection.close()

3.21. Checking System Events

Red Hat Virtualization Manager records and logs many system events. These event logs are accessible through the user interface, the system log files, and using the API. The ovirtsdk library exposes events using the events collection.

Example 3.20. Checking system events

In this example the events collection is listed.

The query parameter of the list method is used to ensure that all available pages of results are returned. By default the list method returns only the first page of results, which is 100 records in length.

The returned list is sorted in reverse chronological order, to display the events in the order in which they occurred.

from ovirtsdk.api import API
from ovirtsdk.xml import params

api = API (url='https://engine.example.com',
            username='admin@internal',
            password='redhat123',
            ca_file='ca.pem')

event_list = []
event_page_index = 1
event_page_current = api.events.list(query="page %s" % event_page_index)

while(len(event_page_current) != 0):
    event_list = event_list + event_page_current
    event_page_index = event_page_index + 1
try:
    event_page_current = api.events.list(query="page %s" % event_page_index)

event_list.reverse()

for event in event_list:
    print("%s %s CODE %s - %s" % (event.get_time(),
                                    event.get_severity().upper(),
                                    event.get_code(),
                                    event.get_description()))

import ovirtsdk4 as sdk
import ovirtsdk4.types as types

connection = sdk.Connection(
    url='https://engine.example.com/ovirt-engine/api',
    username='admin@internal',
    password='redhat123',
    ca_file='ca.pem',
)

# Find the service that manages the collection of events:
events_service = connection.system_service().events_service()

page_number = 1
events = events_service.list(search='page %s' % page_number)
while events:
    for event in events:
        print(
            "%s %s CODE %s - %s" % (
                event.time,
                event.severity,
                event.code,
                event.description,
            )
        )
    page_number = page_number + 1
    events = events_service.list(search='page %s' % page_number)

# Close the connection to the server:
connection.close()

These examples output events in the following format:

YYYY-MM-DD_T_HH:MM:SS NORMAL CODE 30 - User admin@internal logged in.
YYYY-MM-DD_T_HH:MM:SS NORMAL CODE 153 - VM vm1 was started by admin@internal (Host: MyHost).
YYYY-MM-DD_T_HH:MM:SS NORMAL CODE 30 - User admin@internal logged in.

Where did the comment section go?

Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.