ovirt_network – Module to manage logical networks in oVirt/RHV

Synopsis

  • Module to manage logical networks in oVirt/RHV

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.3.0

Parameters

Parameter Choices/Defaults Comments
auth
dictionary / required
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
ca_file
string
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, system wide CA certificate store is used.
Default value is set by OVIRT_CAFILE environment variable.
headers
dictionary
Dictionary of HTTP headers to be added to each API call.
hostname
string
A string containing the hostname of the server, usually something like `server.example.com`.
Default value is set by OVIRT_HOSTNAME environment variable.
Either url or hostname is required.
insecure
boolean
    Choices:
  • no
  • yes
A boolean flag that indicates if the server TLS certificate and host name should be checked.
kerberos
boolean
    Choices:
  • no
  • yes
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
password
string / required
The password of the user.
Default value is set by OVIRT_PASSWORD environment variable.
token
string
Token to be used instead of login with username/password.
Default value is set by OVIRT_TOKEN environment variable.
url
string
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
Default value is set by OVIRT_URL environment variable.
Either url or hostname is required.
username
string / required
The name of the user, something like admin@internal.
Default value is set by OVIRT_USERNAME environment variable.
clusters
-
List of dictionaries describing how the network is managed in specific cluster.
assigned
boolean
    Choices:
  • no
  • yes
true if the network should be assigned to cluster. Default is true.
display
boolean
    Choices:
  • no
  • yes
true if the network should marked as display network.
gluster
boolean
    Choices:
  • no
  • yes
true if the network should marked as gluster network.
migration
boolean
    Choices:
  • no
  • yes
true if the network should marked as migration network.
name
-
Cluster name.
required
boolean
    Choices:
  • no
  • yes
true if the network must remain operational for all hosts associated with this network.
comment
-
Comment of the network.
data_center
-
Datacenter name where network reside.
description
-
Description of the network.
external_provider
-
added in 2.8
Name of external network provider.
At first it tries to import the network when not found it will create network in external provider.
fetch_nested
boolean
    Choices:
  • no
  • yes
If True the module will fetch additional data from the API.
It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying nested_attributes.
id
-
added in 2.8
ID of the network to manage.
label
-
added in 2.5
Name of the label to assign to the network.
mtu
-
Maximum transmission unit (MTU) of the network.
name
- / required
Name of the network to manage.
nested_attributes
list
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
poll_interval
integer
Default:
3
Number of the seconds the module waits until another poll request on entity status is sent.
state
-
    Choices:
  • present ←
  • absent
Should the network be present or absent
timeout
integer
Default:
180
The amount of time in seconds the module should wait for the instance to get into desired state.
vlan_tag
-
Specify VLAN tag.
vm_network
boolean
    Choices:
  • no
  • yes
If True network will be marked as network for VM.
VM network carries traffic relevant to the virtual machine.
wait
boolean
    Choices:
  • no
  • yes ←
yes if the module should wait for the entity to get into desired state.

Notes

Note

  • In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.3.0

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create network
- ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: 1
    vm_network: true

# Remove network
- ovirt_network:
    state: absent
    name: mynetwork

# Change Network Name
- ovirt_network:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_network_name"
    data_center: mydatacenter

# Add network from external provider
- ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    external_provider: ovirt-provider-ovn

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
id
string
On success if network is found.
ID of the managed network

Sample:
7de90f31-222c-436c-a1ca-7e655bd5b60c
network
dictionary
On success if network is found.
Dictionary of all the network attributes. Network attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network.


Status

Authors

  • Ondra Machacek (@machacekondra)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.