HostService.SetupNetworksRequest (oVirt Java SDK 4.2.4 API)

This method is used to change the configuration of the network interfaces of a host.

For example, if you have a host with three network interfaces eth0, eth1 and eth2 and you want to configure a new bond using eth0 and eth1, and put a VLAN on top of it. Using a simple shell script and the curl command line HTTP client that can be done as follows:

#!/bin/sh -ex

url="https://engine.example.com/ovirt-engine/api"
user="admin@internal"
password="..."

curl \
--verbose \
--cacert /etc/pki/ovirt-engine/ca.pem \
--user "${user}:${password}" \
--request POST \
--header "Version: 4" \
--header "Content-Type: application/xml" \
--header "Accept: application/xml" \
--data '
<action>
  <modified_bonds>
    <host_nic>
      <name>bond0</name>
      <bonding>
        <options>
          <option>
            <name>mode</name>
            <value>4</value>
          </option>
          <option>
            <name>miimon</name>
            <value>100</value>
          </option>
        </options>
        <slaves>
          <host_nic>
            <name>eth1</name>
          </host_nic>
          <host_nic>
            <name>eth2</name>
          </host_nic>
        </slaves>
      </bonding>
    </host_nic>
  </modified_bonds>
  <modified_network_attachments>
    <network_attachment>
      <network>
        <name>myvlan</name>
      </network>
      <host_nic>
        <name>bond0</name>
      </host_nic>
      <ip_address_assignments>
        <assignment_method>static</assignment_method>
        <ip_address_assignment>
          <ip>
            <address>192.168.122.10</address>
            <netmask>255.255.255.0</netmask>
          </ip>
        </ip_address_assignment>
      </ip_address_assignments>
      <dns_resolver_configuration>
        <name_servers>
          <name_server>1.1.1.1</name_server>
          <name_server>2.2.2.2</name_server>
        </name_servers>
      </dns_resolver_configuration>
    </network_attachment>
  </modified_network_attachments>
 </action>
' \
"${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc/setupnetworks"

Note	This is valid for version 4 of the API. In previous versions some elements were represented as XML attributes instead of XML elements. In particular the `options` and `ip` elements were represented as follows:

<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>

Using the Python SDK the same can be done with the following code:

# Find the service that manages the collection of hosts:
hosts_service = connection.system_service().hosts_service()

# Find the host:
host = hosts_service.list(search='name=myhost')[0]

# Find the service that manages the host:
host_service = hosts_service.host_service(host.id)

# Configure the network adding a bond with two slaves and attaching it to a
# network with an static IP address:
host_service.setup_networks(
    modified_bonds=[
        types.HostNic(
            name='bond0',
            bonding=types.Bonding(
                options=[
                    types.Option(
                        name='mode',
                        value='4',
                    ),
                    types.Option(
                        name='miimon',
                        value='100',
                    ),
                ],
                slaves=[
                    types.HostNic(
                        name='eth1',
                    ),
                    types.HostNic(
                        name='eth2',
                    ),
                ],
            ),
        ),
    ],
    modified_network_attachments=[
        types.NetworkAttachment(
            network=types.Network(
                name='myvlan',
            ),
            host_nic=types.HostNic(
                name='bond0',
            ),
            ip_address_assignments=[
                types.IpAddressAssignment(
                    assignment_method=types.BootProtocol.STATIC,
                    ip=types.Ip(
                        address='192.168.122.10',
                        netmask='255.255.255.0',
                    ),
                ),
            ],
            dns_resolver_configuration=types.DnsResolverConfiguration(
                name_servers=[
                    '1.1.1.1',
                    '2.2.2.2',
                ],
            ),
        ),
    ],
)

# After modifying the network configuration it is very important to make it
# persistent:
host_service.commit_net_config()

Important

To make sure that the network configuration has been saved in the host, and that it will be applied when the host is rebooted, remember to call commitnetconfig.

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`HostService.SetupNetworksRequest`	`async(Boolean async)` Indicates if the action should be performed asynchronously.
`HostService.SetupNetworksRequest`	`checkConnectivity(Boolean checkConnectivity)`
`HostService.SetupNetworksRequest`	`connectivityTimeout(BigInteger connectivityTimeout)`
`HostService.SetupNetworksRequest`	`connectivityTimeout(Integer connectivityTimeout)`
`HostService.SetupNetworksRequest`	`connectivityTimeout(Long connectivityTimeout)`
`HostService.SetupNetworksRequest`	`modifiedBonds(HostNic... modifiedBonds)`
`HostService.SetupNetworksRequest`	`modifiedBonds(HostNicBuilder... modifiedBonds)`
`HostService.SetupNetworksRequest`	`modifiedBonds(List<HostNic> modifiedBonds)`
`HostService.SetupNetworksRequest`	`modifiedLabels(List<NetworkLabel> modifiedLabels)`
`HostService.SetupNetworksRequest`	`modifiedLabels(NetworkLabel... modifiedLabels)`
`HostService.SetupNetworksRequest`	`modifiedLabels(NetworkLabelBuilder... modifiedLabels)`
`HostService.SetupNetworksRequest`	`modifiedNetworkAttachments(List<NetworkAttachment> modifiedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`modifiedNetworkAttachments(NetworkAttachment... modifiedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`modifiedNetworkAttachments(NetworkAttachmentBuilder... modifiedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`removedBonds(HostNic... removedBonds)`
`HostService.SetupNetworksRequest`	`removedBonds(HostNicBuilder... removedBonds)`
`HostService.SetupNetworksRequest`	`removedBonds(List<HostNic> removedBonds)`
`HostService.SetupNetworksRequest`	`removedLabels(List<NetworkLabel> removedLabels)`
`HostService.SetupNetworksRequest`	`removedLabels(NetworkLabel... removedLabels)`
`HostService.SetupNetworksRequest`	`removedLabels(NetworkLabelBuilder... removedLabels)`
`HostService.SetupNetworksRequest`	`removedNetworkAttachments(List<NetworkAttachment> removedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`removedNetworkAttachments(NetworkAttachment... removedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`removedNetworkAttachments(NetworkAttachmentBuilder... removedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`synchronizedNetworkAttachments(List<NetworkAttachment> synchronizedNetworkAttachments)`
`HostService.SetupNetworksRequest`	`synchronizedNetworkAttachments(NetworkAttachment... synchronizedNetworkAttachments)` A list of network attachments that will be synchronized.
`HostService.SetupNetworksRequest`	`synchronizedNetworkAttachments(NetworkAttachmentBuilder... synchronizedNetworkAttachments)` A list of network attachments that will be synchronized.

All Methods Instance Methods Abstract Methods

Modifier and Type

Method and Description