ovirt_nics - Module to manage network interfaces of Virtual Machines in oVirt

New in version 2.3.


  • Module to manage network interfaces of Virtual Machines in oVirt.

Requirements (on host that executes module)

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


parameter required default choices comments
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 ``. 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.
(added in 2.3)
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.
no virtio
  • virtio
  • e1000
  • rtl8139
  • pci_passthrough
  • rtl8139_virtio
  • spapr_vlan
Type of the network interface.
Custom MAC address of the network interface, by default it's obtained from MAC pool.
Name of the network interface to manage.
(added in 2.3)
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
Logical network to which the VM network interface should use, by default Empty network is used if network is not specified.
no 3
Number of the seconds the module waits until another poll request on entity status is sent.
Virtual network interface profile to be attached to VM network interface.
no present
  • present
  • absent
  • plugged
  • unplugged
Should the Virtual Machine NIC be present/absent/plugged/unplugged.
no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
Name of the Virtual Machine to manage.
True if the module should wait for the entity to get into desired state.


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

# Add NIC to VM
- ovirt_nics:
    state: present
    vm: myvm
    name: mynic
    interface: e1000
    mac_address: 00:1a:4a:16:01:56
    profile: ovirtmgmt
    network: ovirtmgmt

# Plug NIC to VM
- ovirt_nics:
    state: plugged
    vm: myvm
    name: mynic

# Unplug NIC from VM
- ovirt_nics:
    state: unplugged
    vm: myvm
    name: mynic

# Remove NIC from VM
- ovirt_nics:
    state: absent
    vm: myvm
    name: mynic

Return Values

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

name description returned type sample
nic Dictionary of all the network interface attributes. Network interface attributes can be found on your oVirt instance at following url: On success if network interface is found.
id ID of the network interface which is managed On success if network interface is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c



  • 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


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


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.