ovirt.ovirt.ovirt_network module – Module to manage logical networks in oVirt/RHV

Note

This module is part of the ovirt.ovirt collection (version 2.0.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ovirt.ovirt.

To use it in a playbook, specify: ovirt.ovirt.ovirt_network.

New in version 1.0.0: of ovirt.ovirt

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

Parameters

Parameter

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.

compress

boolean

Flag indicating if compression is used for connection.

Choices:

  • no

  • yes ← (default)

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 :emphasis:`server.example.com`.

Default value is set by OVIRT_HOSTNAME environment variable.

Either url or hostname is required.

insecure

boolean

A boolean flag that indicates if the server TLS certificate and host name should be checked.

Choices:

  • no ← (default)

  • yes

kerberos

boolean

A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.

Choices:

  • no

  • yes

password

string

The password of the user.

Default value is set by OVIRT_PASSWORD environment variable.

timeout

integer

Number of seconds to wait for response.

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 :emphasis:`https://server.example.com/ovirt-engine/api`.

Default value is set by OVIRT_URL environment variable.

Either url or hostname is required.

username

string

The name of the user, something like admin@internal.

Default value is set by OVIRT_USERNAME environment variable.

clusters

list / elements=dictionary

List of dictionaries describing how the network is managed in specific cluster.

assigned

boolean

true if the network should be assigned to cluster. Default is true.

Choices:

  • no

  • yes

display

boolean

true if the network should marked as display network.

Choices:

  • no

  • yes

gluster

boolean

true if the network should marked as gluster network.

Choices:

  • no

  • yes

migration

boolean

true if the network should marked as migration network.

Choices:

  • no

  • yes

name

string

Cluster name.

required

boolean

true if the network must remain operational for all hosts associated with this network.

Choices:

  • no

  • yes

comment

string

Comment of the network.

data_center

string / required

Datacenter name where network reside.

description

string

Description of the network.

external_provider

string

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

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.

Choices:

  • no ← (default)

  • yes

id

string

ID of the network to manage.

label

string

Name of the label to assign to the network.

mtu

integer

Maximum transmission unit (MTU) of the network.

name

string / required

Name of the network to manage.

nested_attributes

list / elements=string

Specifies list of the attributes which should be fetched from the API.

This parameter apply only when fetch_nested is true.

poll_interval

integer

Number of the seconds the module waits until another poll request on entity status is sent.

Default: 3

state

string

Should the network be present or absent

Choices:

  • present ← (default)

  • absent

timeout

integer

The amount of time in seconds the module should wait for the instance to get into desired state.

Default: 180

vlan_tag

integer

Specify VLAN tag.

NOTE - To remove the vlan_tag use -1.

vm_network

boolean

If True network will be marked as network for VM.

VM network carries traffic relevant to the virtual machine.

Choices:

  • no

  • yes

wait

boolean

yes if the module should wait for the entity to get into desired state.

Choices:

  • no

  • yes ← (default)

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

Examples

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

# Create network
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: 10
    vm_network: true

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

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

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

# Remove vlan_tag
- ovirt.ovirt.ovirt_network:
    data_center: mydatacenter
    name: mynetwork
    vlan_tag: -1

Return Values

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

Key

Description

id

string

ID of the managed network

Returned: On success if network is found.

Sample: “7de90f31-222c-436c-a1ca-7e655bd5b60c”

network

dictionary

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.

Returned: On success if network is found.

Authors

  • Ondra Machacek (@machacekondra)

  • Martin Necas (@mnecas)