ovirt_nic – Module to manage network interfaces of Virtual Machines in oVirt/RHV
ovirt_nic – Module to manage network interfaces of Virtual Machines in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage network interfaces of Virtual Machines in oVirt/RHV.
Aliases: ovirt_nics
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth - / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
fetch_nested boolean 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 |
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. | |
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 - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
network - |
Logical network to which the VM network interface should use, by default Empty network is used if network is not specified. | |
poll_interval - |
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. | |
state - |
|
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 | |
timeout - |
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 | |
wait boolean |
|
True 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.2.4
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
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
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_nic_module.html