ovirt_network – Module to manage logical networks in oVirt/RHV
ovirt_network – Module to manage logical networks in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage logical networks in oVirt/RHV
Aliases: ovirt_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:
| |
clusters - |
List of dictionaries describing how the network is managed in specific cluster.
| |
comment - |
Comment of the network. | |
data_center - |
Datacenter name where network reside. | |
description - |
Description of the network. | |
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 |
label - added in 2.5 |
Name of the label to assign to the network. | |
mtu - |
Maximum transmission unit (MTU) of the network. | |
name - / required |
Name of the network 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 | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
state - |
|
Should the network be present or absent |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
vlan_tag - |
Specify VLAN tag. | |
vm_network boolean |
|
If True network will be marked as network for VM. VM network carries traffic relevant to the virtual machine. |
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 network
- ovirt_network:
data_center: mydatacenter
name: mynetwork
vlan_tag: 1
vm_network: true
# Remove network
- ovirt_network:
state: absent
name: mynetwork
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 is found. |
ID of the managed network
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
network dictionary |
On success if network is found. |
Dictionary of all the network attributes. Network attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/network.
|
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_network_module.html