ovirt_network_facts – Retrieve facts about one or more oVirt/RHV networks
ovirt_network_facts – Retrieve facts about one or more oVirt/RHV networks
New in version 2.3.
Synopsis
- Retrieve facts about one or more oVirt/RHV networks.
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:
| |
fetch_nested boolean added in 2.3 |
|
If yes 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 list added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
pattern - |
Search term which is accepted by oVirt/RHV search backend. For example to search network starting with string vlan1 use: name=vlan1* |
Notes
Note
- This module creates a new top-level
ovirt_networks
fact, which contains a list of networks. - 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:
# Gather facts about all networks which names start with C(vlan1):
- ovirt_network_facts:
pattern: name=vlan1*
- debug:
var: ovirt_networks
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_networks list |
On success. |
List of dictionaries describing the networks. Network attributes are mapped to dictionary keys, all networks attributes can be found 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.8/modules/ovirt_network_facts_module.html