ovirt_host_network – Module to manage host networks in oVirt/RHV
ovirt_host_network – Module to manage host networks in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage host networks in oVirt/RHV.
Aliases: ovirt_host_networks
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:
| |
bond - |
Dictionary describing network bond:
| |
check boolean |
|
If true verify connectivity between host and engine. Network configuration changes will be rolled back if connectivity between engine and the host is lost after changing network configuration. |
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 - |
Name of the network interface where logical network should be attached. | |
labels - |
List of names of the network label to be assigned to bond or interface. | |
name - / required |
Name of the host to manage networks for.
| |
nested_attributes - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
networks - |
List of dictionary describing networks to be attached to interface or bond:
| |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
save boolean |
|
If true network configuration will be persistent, by default they are temporary. |
state - |
|
Should the host be present/absent. |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
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:
# Create bond on eth0 and eth1 interface, and put 'myvlan' network on top of it:
- name: Bonds
ovirt_host_network:
name: myhost
bond:
name: bond0
mode: 2
interfaces:
- eth1
- eth2
networks:
- name: myvlan
boot_protocol: static
address: 1.2.3.4
netmask: 255.255.255.0
gateway: 1.2.3.4
version: v4
# Create bond on eth1 and eth2 interface, specifiyng both mode and miimon:
- name: Bonds
ovirt_host_network:
name: myhost
bond:
name: bond0
mode: 1
options:
miimon: 200
interfaces:
- eth1
- eth2
# Remove bond0 bond from host interfaces:
- ovirt_host_network:
state: absent
name: myhost
bond:
name: bond0
# Assign myvlan1 and myvlan2 vlans to host eth0 interface:
- ovirt_host_network:
name: myhost
interface: eth0
networks:
- name: myvlan1
- name: myvlan2
# Remove myvlan2 vlan from host eth0 interface:
- ovirt_host_network:
state: absent
name: myhost
interface: eth0
networks:
- name: myvlan2
# Remove all networks/vlans from host eth0 interface:
- ovirt_host_network:
state: absent
name: myhost
interface: eth0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
host_nic dictionary |
On success if host NIC is found. |
Dictionary of all the host NIC attributes. Host NIC attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host_nic.
|
id string |
On success if host NIC is found. |
ID of the host NIC which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
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_host_network_module.html