ovirt_nic – Module to manage network interfaces of Virtual Machines in oVirt/RHV — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ovirt_nic – Module to manage network interfaces of Virtual Machines in oVirt/RHV

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Module to manage network interfaces of Virtual Machines 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.
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 nic to manage.
interface - |  | Type of the network interface. For example e1000, pci_passthrough, rtl8139, rtl8139_virtio, spapr_vlan or virtio. It's required parameter when creating the new NIC.
linked boolean added in 2.9 | Choices: no yes | Defines if the NIC is linked to the virtual machine.
mac_address - |  | Custom MAC address of the network interface, by default it's obtained from MAC pool.
name - / required |  | Name of the network interface 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.
network - |  | Logical network to which the VM network interface should use, by default Empty network is used if network is not specified.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.
profile - |  | Virtual network interface profile to be attached to VM network interface. When not specified and network has only single profile it will be auto-selected, otherwise you must specify profile.
state - | Choices: absent plugged present ← unplugged | Should the Virtual Machine NIC be present/absent/plugged/unplugged.
template - added in 2.4 |  | Name of the template to manage. You must provide either `vm` parameter or `template` parameter.
timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state.
vm - |  | Name of the Virtual Machine to manage. You must provide either `vm` parameter or `template` parameter.
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:

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

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

    - name: Unplug NIC from VM
      ovirt_nic:
        state: unplugged
        linked: false
        vm: myvm
        name: mynic

    - name: Add NIC to template
      ovirt_nic:
        auth: "{{ ovirt_auth }}"
        state: present
        template: my_template
        name: nic1
        interface: virtio
        profile: ovirtmgmt
        network: ovirtmgmt

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

    # Change NIC Name
    - ovirt_nic:
        id: 00000000-0000-0000-0000-000000000000
        name: "new_nic_name"
        vm: myvm

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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Ondra Machacek (@machacekondra)

Hint

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