ovirt_host_networks - Module to manage host networks in oVirt

New in version 2.3.

Synopsis

Module to manage host networks in oVirt.

Requirements (on host that executes module)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Options

parameter required default choices comments
auth
 yes
    Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
    username[required] - The name of the user, something like `admin@internal`.
    password[required] - The password of the user.
    url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
    token - Token to be used instead of login with username/password.
    insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.
    ca_file - 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.
    kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
    bond
    		 no
      Dictionary describing network bond:
      name - Bond name.
      mode - Bonding mode.
      interfaces - List of interfaces to create a bond.
      check
      		 no
        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.
        interface
        		 no
          Name of the network interface where logical network should be attached.
          labels
          		 no
            List of names of the network label to be assigned to bond or interface.
            name
            		 yes
              Name of the the host to manage networks for.
              networks
              		 no
                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.
                prefix - Routing prefix 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.
                poll_interval
                		 no 3
                  Number of the seconds the module waits until another poll request on entity status is sent.
                  save
                  		 no
                    If true network configuration will be persistent, by default they are temporary.
                    state
                    		 no present
                    • present
                    • absent
                    Should the host be present/absent.
                    timeout
                    		 no 180
                      The amount of time in seconds the module should wait for the instance to get into desired state.
                      wait
                      		 no
                        True if the module should wait for the entity to get into desired state.

                        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_networks:
    name: myhost
    bond:
      name: bond0
      mode: 2
      interfaces:
        - eth1
        - eth2
    networks:
      - name: myvlan
        boot_protocol: static
        address: 1.2.3.4
        prefix: 24
        gateway: 1.2.3.4
        version: v4

# Remove bond0 bond from host interfaces:
- ovirt_host_networks:
    state: absent
    name: myhost
    bond:
      name: bond0

# Assign myvlan1 and myvlan2 vlans to host eth0 interface:
- ovirt_host_networks:
    name: myhost
    interface: eth0
    networks:
      - name: myvlan1
      - name: myvlan2

# Remove myvlan2 vlan from host eth0 interface:
- ovirt_host_networks:
    state: absent
    name: myhost
    interface: eth0
    networks:
      - name: myvlan2

# Remove all networks/vlans from host eth0 interface:
- ovirt_host_networks:
    state: absent
    name: myhost
    interface: eth0

                        Return Values

                        Common return values are documented here common_return_values, the following are the fields unique to this module:

                        name description returned type sample
                        id ID of the host NIC which is managed On success if host NIC is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
                        host_nic Dictionary of all the host NIC attributes. Host NIC attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/host_nic. On success if host NIC is found.


                        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.0.0

                        This is an Extras Module

                        For more information on what this means please read modules_extra

                        For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.