ovirt_host_network – Module to manage host networks in oVirt/RHV

Synopsis

  • Module to manage host networks in oVirt/RHV.

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:
ca_file
string
A PEM file containing the trusted CA certificates.
The certificate presented by the server will be verified using these CA certificates.
If ca_file parameter is not set, system wide CA certificate store is used.
Default value is set by OVIRT_CAFILE environment variable.
headers
dictionary
Dictionary of HTTP headers to be added to each API call.
hostname
string
A string containing the hostname of the server, usually something like `server.example.com`.
Default value is set by OVIRT_HOSTNAME environment variable.
Either url or hostname is required.
insecure
boolean
    Choices:
  • no
  • yes
A boolean flag that indicates if the server TLS certificate and host name should be checked.
kerberos
boolean
    Choices:
  • no
  • yes
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
password
string / required
The password of the user.
Default value is set by OVIRT_PASSWORD environment variable.
token
string
Token to be used instead of login with username/password.
Default value is set by OVIRT_TOKEN environment variable.
url
string
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
Default value is set by OVIRT_URL environment variable.
Either url or hostname is required.
username
string / required
The name of the user, something like admin@internal.
Default value is set by OVIRT_USERNAME environment variable.
bond
-
Dictionary describing network bond:
name - Bond name.
mode - Bonding mode.
options - Bonding options.
interfaces - List of interfaces to create a bond.
check
boolean
    Choices:
  • no
  • yes
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
    Choices:
  • no
  • yes
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 nested_attributes.
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.

aliases: host
nested_attributes
list
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
networks
-
List of dictionary describing networks to be attached to interface or bond:
name - Name of the logical network to be assigned to bond or interface.
boot_protocol - Boot protocol one of the none, static or dhcp.
address - IP address in case of static boot protocol is used.
netmask - Subnet mask in case of static boot protocol is used.
gateway - Gateway in case of static boot protocol is used.
version - IP version. Either v4 or v6. Default is v4.
poll_interval
integer
Default:
3
Number of the seconds the module waits until another poll request on entity status is sent.
save
boolean
    Choices:
  • no
  • yes ←
If true network configuration will be persistent, otherwise it is temporary. Default true since Ansible 2.8.
state
-
    Choices:
  • present ←
  • absent
Should the host be present/absent.
sync_networks
boolean
added in 2.8
    Choices:
  • no ←
  • yes
If true all networks will be synchronized before modification
timeout
integer
Default:
180
The amount of time in seconds the module should wait for the instance to get into desired state.
wait
boolean
    Choices:
  • no
  • yes ←
yes 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.3.0

Examples

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# In all examples the durability of the configuration created is dependent on the 'save' option value:

# Create bond on eth0 and eth1 interface, and put 'myvlan' network on top of it and persist the new configuration:
- name: Bonds
  ovirt_host_network:
    name: myhost
    save: yes
    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

Authors

  • Ondra Machacek (@machacekondra)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.