Documentation

ovirt_networks - Module to manage logical networks in oVirt

New in version 2.3.

Synopsis

  • Module to manage logical networks in oVirt

Requirements (on host that executes module)

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

Options

parameter required default choices comments
auth
yes
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
username[required] - The name of the user, something like [email protected]. Default value is set by OVIRT_USERNAME environment variable.
password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.
url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable.
token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.
insecure - A boolean flag that indicates if the server 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, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.
kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
clusters
no
List of dictionaries describing how the network is managed in specific cluster.
name - Cluster name.
assigned - true if the network should be assigned to cluster. Default is true.
required - true if the network must remain operational for all hosts associated with this network.
display - true if the network should marked as display network.
migration - true if the network should marked as migration network.
gluster - true if the network should marked as gluster network.
comment
no
Comment of the network.
data_center
no
Datacenter name where network reside.
description
no
Description of the network.
fetch_nested
(added in 2.3)
no
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.
mtu
no
Maximum transmission unit (MTU) of the network.
name
yes
Name of the the network to manage.
nested_attributes
(added in 2.3)
no
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
poll_interval
no 3
Number of the seconds the module waits until another poll request on entity status is sent.
state
no present
  • present
  • absent
Should the network be present or absent
timeout
no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
vlan_tag
no
Specify VLAN tag.
vm_network
no
If True network will be marked as network for VM.
VM network carries traffic relevant to the virtual machine.
wait
no
True if the module should wait for the entity to get into desired state.

Examples

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

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

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

Return Values

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

name description returned type sample
id ID of the managed network On success if network is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
network Dictionary of all the network attributes. Network attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/network. On success if network is found.


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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.