HostServiceImpl (oVirt Java SDK 4.2.0.alpha2 API)

Constructors
Constructor and Description
`HostServiceImpl(HttpConnection connection, String path)`

Constructors

Constructor and Description

HostServiceImpl(HttpConnection connection,
               String path)

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HostService.ActivateRequest`	`activate()` Activate the host for use, such as running virtual machines.
`AssignedAffinityLabelsService`	`affinityLabelsService()` List of scheduling labels assigned to this host.
`HostService.ApproveRequest`	`approve()` Approve a pre-installed Hypervisor host for usage in the virtualization environment.
`HostService.CommitNetConfigRequest`	`commitNetConfig()` Marks the network configuration as good and persists it inside the host.
`HostService.DeactivateRequest`	`deactivate()` Deactivate the host to perform maintenance tasks.
`HostDevicesService`	`devicesService()` Reference to the host devices service.
`HostService.EnrollCertificateRequest`	`enrollCertificate()` Enroll certificate of the host.
`HostService.FenceRequest`	`fence()` Controls host’s power management device.
`FenceAgentsService`	`fenceAgentsService()` Reference to the fence agents service.
`HostService.ForceSelectSpmRequest`	`forceSelectSpm()` Manually set a host as the storage pool manager (SPM).
`HostService.GetRequest`	`get()` Get the host details.
`HostHooksService`	`hooksService()` Reference to the host hooks service.
`HostService.InstallRequest`	`install()` Install VDSM and related software on the host.
`HostService.IscsiDiscoverRequest`	`iscsiDiscover()` Discover iSCSI targets on the host, using the initiator details.
`HostService.IscsiLoginRequest`	`iscsiLogin()` Login to iSCSI targets on the host, using the target details.
`KatelloErrataService`	`katelloErrataService()` Reference to the service that can show the applicable errata available on the host.
`NetworkAttachmentsService`	`networkAttachmentsService()` Reference to the network attachments service.
`HostNicsService`	`nicsService()` Reference to the service that manages the network interface devices on the host.
`HostNumaNodesService`	`numaNodesService()` Reference to the service that manage NUMA nodes for the host.
`AssignedPermissionsService`	`permissionsService()` Reference to the host permission service.
`HostService.RefreshRequest`	`refresh()` Refresh the host devices and capabilities.
`HostService.RemoveRequest`	`remove()` Remove the host from the system.
`Service`	`service(String path)` Service locator method, returns individual service on which the URI is dispatched.
`HostService.SetupNetworksRequest`	`setupNetworks()` This method is used to change the configuration of the network interfaces of a host.
`StatisticsService`	`statisticsService()`
`StorageServerConnectionExtensionsService`	`storageConnectionExtensionsService()` Reference to storage connection extensions.
`HostStorageService`	`storageService()` Reference to the service that manage hosts storage.
`AssignedTagsService`	`tagsService()` Reference to the host tags service.
`String`	`toString()`
`UnmanagedNetworksService`	`unmanagedNetworksService()` Reference to unmanaged networks.
`HostService.UnregisteredStorageDomainsDiscoverRequest`	`unregisteredStorageDomainsDiscover()` Discover the block Storage Domains which are candidates to be imported to the setup.
`HostService.UpdateRequest`	`update()` Update the host properties.
`HostService.UpgradeRequest`	`upgrade()` Upgrade VDSM and selected software on the host.
`HostService.UpgradeCheckRequest`	`upgradeCheck()` Check if there are upgrades available for the host.

All Methods Instance Methods Concrete Methods

Modifier and Type

Method and Description

HostService.ActivateRequest

activate()

Activate the host for use, such as running virtual machines.

AssignedAffinityLabelsService

affinityLabelsService()

List of scheduling labels assigned to this host.

HostService.ApproveRequest

approve()

Approve a pre-installed Hypervisor host for usage in the virtualization environment.

HostService.CommitNetConfigRequest

commitNetConfig()

Marks the network configuration as good and persists it inside the host.

HostService.DeactivateRequest

deactivate()

Deactivate the host to perform maintenance tasks.

HostDevicesService

devicesService()

Reference to the host devices service.

HostService.EnrollCertificateRequest

enrollCertificate()

Enroll certificate of the host.

HostService.FenceRequest

fence()

Controls host’s power management device.

FenceAgentsService

fenceAgentsService()

Reference to the fence agents service.

HostService.ForceSelectSpmRequest

forceSelectSpm()

Manually set a host as the storage pool manager (SPM).

HostService.GetRequest

get()

Get the host details.

HostHooksService

hooksService()

Reference to the host hooks service.

HostService.InstallRequest

install()

Install VDSM and related software on the host.

HostService.IscsiDiscoverRequest

iscsiDiscover()

Discover iSCSI targets on the host, using the initiator details.

HostService.IscsiLoginRequest

iscsiLogin()

KatelloErrataService

katelloErrataService()

Reference to the service that can show the applicable errata available on the host.

NetworkAttachmentsService

networkAttachmentsService()

Reference to the network attachments service.

HostNicsService

nicsService()

Reference to the service that manages the network interface devices on the host.

HostNumaNodesService

numaNodesService()

Reference to the service that manage NUMA nodes for the host.

AssignedPermissionsService

permissionsService()

Reference to the host permission service.

HostService.RefreshRequest

refresh()

Refresh the host devices and capabilities.

HostService.RemoveRequest

remove()

Remove the host from the system.

Service

service(String path)

Service locator method, returns individual service on which the URI is dispatched.

HostService.SetupNetworksRequest

setupNetworks()

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

StatisticsService

statisticsService()

StorageServerConnectionExtensionsService

storageConnectionExtensionsService()

Reference to storage connection extensions.

HostStorageService

storageService()

Reference to the service that manage hosts storage.

AssignedTagsService

tagsService()

Reference to the host tags service.

String

toString()

UnmanagedNetworksService

unmanagedNetworksService()

Reference to unmanaged networks.

HostService.UnregisteredStorageDomainsDiscoverRequest

unregisteredStorageDomainsDiscover()

Discover the block Storage Domains which are candidates to be imported to the setup.

HostService.UpdateRequest

update()

Update the host properties.

HostService.UpgradeRequest

upgrade()

Upgrade VDSM and selected software on the host.

HostService.UpgradeCheckRequest

upgradeCheck()

Check if there are upgrades available for the host.

#!/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> <fence_type>start</fence_type> </action> ' \ "${url}/hosts/123/fence"

curl \ --verbose \ --cacert /etc/pki/ovirt-engine/ca.pem \ --request PUT \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Version: 4" \ --user "admin@internal:..." \ --data ' { "root_password": "myrootpassword" } ' \ "https://engine.example.com/ovirt-engine/api/hosts/123"

curl \ curl \ --verbose \ --cacert /etc/pki/ovirt-engine/ca.pem \ --request PUT \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Version: 4" \ --user "admin@internal:..." \ --data ' { "root_password": "myrootpassword" } ' \ "https://engine.example.com/ovirt-engine/api/hosts/123?deploy_hosted_engine=true"

#!/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 DELETE \ --header "Version: 4" \ "${url}/hosts/1ff7a191-2f3b-4eff-812b-9f91a30c3acc"

#!/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"

# 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()

Class HostServiceImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.ovirt.engine.sdk4.services.HostService

Constructor Summary

Method Summary

Methods inherited from class org.ovirt.engine.sdk4.internal.services.ServiceImpl

Methods inherited from class java.lang.Object

Constructor Detail

HostServiceImpl

Method Detail

activate

approve

commitNetConfig

deactivate

enrollCertificate

fence

forceSelectSpm

get

install

iscsiDiscover

iscsiLogin

refresh

remove

setupNetworks

unregisteredStorageDomainsDiscover

update

upgrade

upgradeCheck

affinityLabelsService

devicesService

fenceAgentsService

hooksService

katelloErrataService

networkAttachmentsService

nicsService

numaNodesService

permissionsService

statisticsService

storageService

storageConnectionExtensionsService

tagsService

unmanagedNetworksService

service

toString