ovirt.ovirt.ovirt_nic module – Module to manage network interfaces of Virtual Machines in oVirt/RHV
Note
This module is part of the ovirt.ovirt collection (version 3.2.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ovirt.ovirt.ovirt_nic.
New in ovirt.ovirt 1.0.0
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.4.0
Parameters
Parameter |
Comments |
|---|---|
Dictionary with values needed to create HTTP/HTTPS connection to oVirt: |
|
A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If Default value is set by |
|
Flag indicating if compression is used for connection. Choices:
|
|
Dictionary of HTTP headers to be added to each API call. |
|
A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by Either |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. Choices:
|
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. Choices:
|
|
The password of the user. Default value is set by |
|
Number of seconds to wait for response. |
|
Token to be used instead of login with username/password. Default value is set by |
|
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by Either |
|
The name of the user, something like admin@internal. Default value is set by |
|
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 Choices:
|
|
ID of the nic to manage. |
|
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. |
|
Defines if the NIC is linked to the virtual machine. Choices:
|
|
Custom MAC address of the network interface, by default it’s obtained from MAC pool. |
|
Name of the network interface to manage. |
|
Specifies list of the attributes which should be fetched from the API. This parameter apply only when |
|
Logical network to which the VM network interface should use, by default Empty network is used if network is not specified. |
|
The list of network filter parameters. |
|
Name of the network filter parameter. |
|
Value of the network filter parameter. |
|
Number of the seconds the module waits until another poll request on entity status is sent. Default: |
|
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. |
|
Should the Virtual Machine NIC be present/absent/plugged/unplugged. Choices:
|
|
Name of the template to manage. You must provide either |
|
Version number of the template. |
|
The amount of time in seconds the module should wait for the instance to get into desired state. Default: |
|
Name of the Virtual Machine to manage. You must provide either |
|
Choices:
|
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:
- name: Add NIC to VM
ovirt.ovirt.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.ovirt.ovirt_nic:
state: plugged
vm: myvm
name: mynic
- name: Unplug NIC from VM
ovirt.ovirt.ovirt_nic:
state: unplugged
linked: false
vm: myvm
name: mynic
- name: Add NIC to template
ovirt.ovirt.ovirt_nic:
auth: "{{ ovirt_auth }}"
state: present
template: my_template
name: nic1
interface: virtio
profile: ovirtmgmt
network: ovirtmgmt
- name: Remove NIC from VM
ovirt.ovirt.ovirt_nic:
state: absent
vm: myvm
name: mynic
# Change NIC Name
- ovirt.ovirt.ovirt_nic:
id: 00000000-0000-0000-0000-000000000000
name: "new_nic_name"
vm: myvm
# Add NIC network filter parameters
- ovirt.ovirt.ovirt_nic:
state: present
name: mynic
vm: myvm
network_filter_parameters:
- name: GATEWAY_MAC
value: 01:02:03:ab:cd:ef
- name: GATEWAY_MAC
value: 01:02:03:ab:cd:eg
- name: GATEWAY_MAC
value: 01:02:03:ab:cd:eh
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
ID of the network interface which is managed Returned: On success if network interface is found. Sample: |
|
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. Returned: On success if network interface is found. |