org.ovirt.engine.sdk.decorators

Class Host

java.lang.Object

org.ovirt.engine.sdk.entities.ActionableResource

org.ovirt.engine.sdk.entities.BaseResource

org.ovirt.engine.sdk.entities.Host

org.ovirt.engine.sdk.decorators.Host

public class Host
extends Host

Host providing relation and functional services

to Host.

Constructor Summary

Constructors

Constructor and Description
Host(HttpProxyBroker proxy)

Method Summary

Methods

Modifier and Type	Method and Description
Action	activate(Action action) Performs activate action.
Action	activate(Action action, String correlationId) Performs activate action.
Action	activate(Action action, String correlationId, Boolean async) Performs activate action.
Action	approve(Action action) Performs approve action.
Action	approve(Action action, String correlationId) Performs approve action.
Action	approve(Action action, String correlationId, Boolean async) Performs approve action.
Action	commitnetconfig(Action action) Performs commitnetconfig action.
Action	commitnetconfig(Action action, String correlationId) Performs commitnetconfig action.
Action	commitnetconfig(Action action, String correlationId, Boolean async) Performs commitnetconfig action.
Action	deactivate(Action action) Performs deactivate action.
Action	deactivate(Action action, String correlationId) Performs deactivate action.
Action	deactivate(Action action, String correlationId, Boolean async) Performs deactivate action.
Response	delete() Deletes object.
Response	delete(Action action) Deletes object.
Response	delete(Action action, Boolean async) Deletes object.
Response	delete(Action action, Boolean async, String correlationId) Deletes object.
Response	delete(Boolean async) Deletes object.
Response	delete(Boolean async, String correlationId) Deletes object.
Action	enrollcertificate(Action action) Performs enrollcertificate action.
Action	enrollcertificate(Action action, Boolean async) Performs enrollcertificate action.
Action	enrollcertificate(Action action, Boolean async, String correlationId) Performs enrollcertificate action.
Action	fence(Action action) Performs fence action.
Action	fence(Action action, String correlationId) Performs fence action.
Action	fence(Action action, String correlationId, Boolean async) Performs fence action.
Action	forceselectspm(Action action) Performs forceselectspm action.
Action	forceselectspm(Action action, String correlationId) Performs forceselectspm action.
Action	forceselectspm(Action action, String correlationId, Boolean async) Performs forceselectspm action.
HostAgents	getAgents() Gets the value of the HostAgents property.
HostHooks	getHooks() Gets the value of the HostHooks property.
HostHostDevices	getHostDevices() Gets the value of the HostHostDevices property.
HostNICs	getHostNics() Gets the value of the HostNICs property.
HostStorages	getHostStorage() Gets the value of the HostStorages property.
HostKatelloErrata	getKatelloErrata() Gets the value of the HostKatelloErrata property.
HostNetworkAttachments	getNetworkAttachments() Gets the value of the HostNetworkAttachments property.
HostNumaNodes	getNumaNodes() Gets the value of the HostNumaNodes property.
HostPermissions	getPermissions() Gets the value of the HostPermissions property.
HostStatistics	getStatistics() Gets the value of the HostStatistics property.
HostStorageConnectionExtensions	getStorageConnectionExtensions() Gets the value of the HostStorageConnectionExtensions property.
HostTags	getTags() Gets the value of the HostTags property.
HostUnmanagedNetworks	getUnmanagedNetworks() Gets the value of the HostUnmanagedNetworks property.
Action	install(Action action) Performs install action.
Action	install(Action action, String correlationId) Performs install action.
Action	install(Action action, String correlationId, Boolean async) Performs install action.
Action	iscsidiscover(Action action) Performs iscsidiscover action.
Action	iscsidiscover(Action action, String correlationId) Performs iscsidiscover action.
Action	iscsidiscover(Action action, String correlationId, Boolean async) Performs iscsidiscover action.
Action	iscsilogin(Action action) Performs iscsilogin action.
Action	iscsilogin(Action action, String correlationId) Performs iscsilogin action.
Action	iscsilogin(Action action, String correlationId, Boolean async) Performs iscsilogin action.
Action	refresh(Action action) Performs refresh action.
Action	refresh(Action action, Boolean async) Performs refresh action.
Action	refresh(Action action, Boolean async, String correlationId) Performs refresh action.
Action	setupnetworks(Action action) Performs setupnetworks action.
Action	setupnetworks(Action action, Boolean async) Performs setupnetworks action.
Action	setupnetworks(Action action, Boolean async, String correlationId) Performs setupnetworks action.
Action	unregisteredstoragedomainsdiscover(Action action) Performs unregisteredstoragedomainsdiscover action.
Action	unregisteredstoragedomainsdiscover(Action action, String correlationId) Performs unregisteredstoragedomainsdiscover action.
Action	unregisteredstoragedomainsdiscover(Action action, String correlationId, Boolean async) Performs unregisteredstoragedomainsdiscover action.
Host	update() Updates Host object.
Host	update(Boolean async) Updates Host object.
Host	update(Boolean async, String correlationId) Updates Host object.
Host	update(Boolean async, String correlationId, String expect) Updates Host object.
Action	upgrade(Action action) Performs upgrade action.
Action	upgrade(Action action, Boolean async) Performs upgrade action.
Action	upgrade(Action action, Boolean async, String correlationId) Performs upgrade action.

Methods inherited from class org.ovirt.engine.sdk.entities.Host

getAddress, getAutoNumaStatus, getCertificate, getCluster, getCpu, getDevicePassthrough, getDisplay, getExternalHostProvider, getExternalStatus, getHardwareInformation, getHostedEngine, getIscsi, getKdumpStatus, getKsm, getLibvirtVersion, getLiveSnapshotSupport, getMaxSchedulingMemory, getMemory, getNumaSupported, getOs, getOverrideIptables, getPort, getPowerManagement, getProtocol, getRebootAfterInstallation, getRootPassword, getSelinux, getSpm, getSsh, getStatus, getStorageManager, getSummary, getTransparentHugepages, getType, getUpdateAvailable, getVersion, isSetAddress, isSetAutoNumaStatus, isSetCertificate, isSetCluster, isSetCpu, isSetDevicePassthrough, isSetDisplay, isSetExternalHostProvider, isSetExternalStatus, isSetHardwareInformation, isSetHooks, isSetHostedEngine, isSetIscsi, isSetKatelloErrata, isSetKdumpStatus, isSetKsm, isSetLibvirtVersion, isSetLiveSnapshotSupport, isSetMaxSchedulingMemory, isSetMemory, isSetNumaSupported, isSetOs, isSetOverrideIptables, isSetPort, isSetPowerManagement, isSetProtocol, isSetRebootAfterInstallation, isSetRootPassword, isSetSelinux, isSetSpm, isSetSsh, isSetStatistics, isSetStatus, isSetStorageConnectionExtensions, isSetStorageManager, isSetSummary, isSetTransparentHugepages, isSetType, isSetUpdateAvailable, isSetVersion, setAddress, setAutoNumaStatus, setCertificate, setCluster, setCpu, setDevicePassthrough, setDisplay, setExternalHostProvider, setExternalStatus, setHardwareInformation, setHooks, setHostedEngine, setIscsi, setKatelloErrata, setKdumpStatus, setKsm, setLibvirtVersion, setLiveSnapshotSupport, setMaxSchedulingMemory, setMemory, setNumaSupported, setOs, setOverrideIptables, setPort, setPowerManagement, setProtocol, setRebootAfterInstallation, setRootPassword, setSelinux, setSpm, setSsh, setStatistics, setStatus, setStorageConnectionExtensions, setStorageManager, setSummary, setTransparentHugepages, setType, setUpdateAvailable, setVersion

Methods inherited from class org.ovirt.engine.sdk.entities.BaseResource

getComment, getCreationStatus, getDescription, getHref, getId, getLinks, getName, isSetComment, isSetCreationStatus, isSetDescription, isSetHref, isSetId, isSetLinks, isSetName, setComment, setCreationStatus, setDescription, setHref, setId, setName, unsetLinks

Methods inherited from class org.ovirt.engine.sdk.entities.ActionableResource

getActions, isSetActions, setActions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Host

public Host(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

getHostDevices

public HostHostDevices getHostDevices()

Gets the value of the HostHostDevices property.

Returns:

HostHostDevices

getAgents

public HostAgents getAgents()

Gets the value of the HostAgents property.

Returns:

HostAgents

getHooks

public HostHooks getHooks()

Gets the value of the HostHooks property.

Overrides:

getHooks in class Host

Returns:

HostHooks

getKatelloErrata

public HostKatelloErrata getKatelloErrata()

Gets the value of the HostKatelloErrata property.

Overrides:

getKatelloErrata in class Host

Returns:

HostKatelloErrata

getNetworkAttachments

public HostNetworkAttachments getNetworkAttachments()

Gets the value of the HostNetworkAttachments property.

Returns:

HostNetworkAttachments

getHostNics

public HostNICs getHostNics()

Gets the value of the HostNICs property.

Returns:

HostNICs

getNumaNodes

public HostNumaNodes getNumaNodes()

Gets the value of the HostNumaNodes property.

Returns:

HostNumaNodes

getPermissions

public HostPermissions getPermissions()

Gets the value of the HostPermissions property.

Returns:

HostPermissions

getStatistics

public HostStatistics getStatistics()

Gets the value of the HostStatistics property.

Overrides:

getStatistics in class Host

Returns:

HostStatistics

getHostStorage

public HostStorages getHostStorage()

Gets the value of the HostStorages property.

Returns:

HostStorages

getStorageConnectionExtensions

public HostStorageConnectionExtensions getStorageConnectionExtensions()

Gets the value of the HostStorageConnectionExtensions property.

Overrides:

getStorageConnectionExtensions in class Host

Returns:

HostStorageConnectionExtensions

getTags

public HostTags getTags()

Gets the value of the HostTags property.

Returns:

HostTags

getUnmanagedNetworks

public HostUnmanagedNetworks getUnmanagedNetworks()

Gets the value of the HostUnmanagedNetworks property.

Returns:

HostUnmanagedNetworks

activate

public Action activate(Action action)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

activate

public Action activate(Action action,
              String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

activate

public Action activate(Action action,
              String correlationId,
              Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Performs activate action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

approve

public Action approve(Action action)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs approve action.

Parameters:

action - Action

    Overload 1:

      approve specified host to be
      added to the engine by using
      root password (deprecated
      verb). this occurs when the
      host registers itself with the
      engine

      [action.cluster.id|name]
      [host.root_password]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      approve specified host to be
      added to the engine by using
      ssh authentication. this
      occurs when the host registers
      itself with the engine

      [action.cluster.id|name]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [action.async]
      [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

approve

public Action approve(Action action,
             String correlationId)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs approve action.

Parameters:

action - Action

    Overload 1:

      approve specified host to be
      added to the engine by using
      root password (deprecated
      verb). this occurs when the
      host registers itself with the
      engine

      [action.cluster.id|name]
      [host.root_password]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      approve specified host to be
      added to the engine by using
      ssh authentication. this
      occurs when the host registers
      itself with the engine

      [action.cluster.id|name]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [action.async]
      [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

approve

public Action approve(Action action,
             String correlationId,
             Boolean async)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs approve action.

Parameters:

action - Action

    Overload 1:

      approve specified host to be
      added to the engine by using
      root password (deprecated
      verb). this occurs when the
      host registers itself with the
      engine

      [action.cluster.id|name]
      [host.root_password]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      approve specified host to be
      added to the engine by using
      ssh authentication. this
      occurs when the host registers
      itself with the engine

      [action.cluster.id|name]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [action.async]
      [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

commitnetconfig

public Action commitnetconfig(Action action)
                       throws org.apache.http.client.ClientProtocolException,
                              ServerException,
                              IOException

Performs commitnetconfig action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

commitnetconfig

public Action commitnetconfig(Action action,
                     String correlationId)
                       throws org.apache.http.client.ClientProtocolException,
                              ServerException,
                              IOException

Performs commitnetconfig action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

commitnetconfig

public Action commitnetconfig(Action action,
                     String correlationId,
                     Boolean async)
                       throws org.apache.http.client.ClientProtocolException,
                              ServerException,
                              IOException

Performs commitnetconfig action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

    [action.reason]
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action,
                String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

    [action.reason]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

deactivate

public Action deactivate(Action action,
                String correlationId,
                Boolean async)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs deactivate action.

Parameters:

action - Action

    [action.reason]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Boolean async,
              String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Action action)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Action action,
              Boolean async)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

delete

public Response delete(Action action,
              Boolean async,
              String correlationId)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Response

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

enrollcertificate

public Action enrollcertificate(Action action)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Performs enrollcertificate action.

Parameters:

action - Action

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

enrollcertificate

public Action enrollcertificate(Action action,
                       Boolean async)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Performs enrollcertificate action.

Parameters:

action - Action

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

enrollcertificate

public Action enrollcertificate(Action action,
                       Boolean async,
                       String correlationId)
                         throws org.apache.http.client.ClientProtocolException,
                                ServerException,
                                IOException

Performs enrollcertificate action.

Parameters:

action - Action

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

fence

public Action fence(Action action)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Performs fence action.

Parameters:

action - Action

    action.fence_type
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

fence

public Action fence(Action action,
           String correlationId)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Performs fence action.

Parameters:

action - Action

    action.fence_type
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

fence

public Action fence(Action action,
           String correlationId,
           Boolean async)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Performs fence action.

Parameters:

action - Action

    action.fence_type
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

forceselectspm

public Action forceselectspm(Action action)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs forceselectspm action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

forceselectspm

public Action forceselectspm(Action action,
                    String correlationId)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs forceselectspm action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

forceselectspm

public Action forceselectspm(Action action,
                    String correlationId,
                    Boolean async)
                      throws org.apache.http.client.ClientProtocolException,
                             ServerException,
                             IOException

Performs forceselectspm action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

install

public Action install(Action action)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs install action.

Parameters:

action - Action

    Overload 1:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the root
      password. This has been
      deprecated

      [action.root_password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the ssh
      password

      [action.ssh.port]
      [action.ssh.fingerprint]
      [action.ssh.authentication_method]
      [action.ssh.user.user_name]
      [action.ssh.user.password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

install

public Action install(Action action,
             String correlationId)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs install action.

Parameters:

action - Action

    Overload 1:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the root
      password. This has been
      deprecated

      [action.root_password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the ssh
      password

      [action.ssh.port]
      [action.ssh.fingerprint]
      [action.ssh.authentication_method]
      [action.ssh.user.user_name]
      [action.ssh.user.password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

install

public Action install(Action action,
             String correlationId,
             Boolean async)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs install action.

Parameters:

action - Action

    Overload 1:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the root
      password. This has been
      deprecated

      [action.root_password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]

    Overload 2:

      install vdsm and other
      packages required to get the
      host ready to be used in the
      engine providing the ssh
      password

      [action.ssh.port]
      [action.ssh.fingerprint]
      [action.ssh.authentication_method]
      [action.ssh.user.user_name]
      [action.ssh.user.password]
      [action.image]
      [action.host.override_iptables]
      [action.async]
      [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsidiscover

public Action iscsidiscover(Action action)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs iscsidiscover action.

Parameters:

action - Action

    action.iscsi.address
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsidiscover

public Action iscsidiscover(Action action,
                   String correlationId)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs iscsidiscover action.

Parameters:

action - Action

    action.iscsi.address
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsidiscover

public Action iscsidiscover(Action action,
                   String correlationId,
                   Boolean async)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs iscsidiscover action.

Parameters:

action - Action

    action.iscsi.address
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsilogin

public Action iscsilogin(Action action)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs iscsilogin action.

Parameters:

action - Action

    action.iscsi.address
    action.iscsi.target
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsilogin

public Action iscsilogin(Action action,
                String correlationId)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs iscsilogin action.

Parameters:

action - Action

    action.iscsi.address
    action.iscsi.target
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

iscsilogin

public Action iscsilogin(Action action,
                String correlationId,
                Boolean async)
                  throws org.apache.http.client.ClientProtocolException,
                         ServerException,
                         IOException

Performs iscsilogin action.

Parameters:

action - Action

    action.iscsi.address
    action.iscsi.target
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

refresh

public Action refresh(Action action)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs refresh action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

refresh

public Action refresh(Action action,
             Boolean async)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs refresh action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

refresh

public Action refresh(Action action,
             Boolean async,
             String correlationId)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs refresh action.

Parameters:

action - Action

    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

setupnetworks

public Action setupnetworks(Action action)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs setupnetworks action.

Parameters:

action - Action

    [action.modified_network_attachments.network_attachment]
    [action.removed_network_attachments.network_attachment]
    [action.modified_bonds.host_nic]
    [action.removed_bonds.host_nic]
    [action.synchronized_network_attachments.network_attachment]
    [action.modified_labels.label]
    [action.removed_labels.label]
    [action.check_connectivity]
    [action.connectivity_timeout]
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

setupnetworks

public Action setupnetworks(Action action,
                   Boolean async)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs setupnetworks action.

Parameters:

action - Action

    [action.modified_network_attachments.network_attachment]
    [action.removed_network_attachments.network_attachment]
    [action.modified_bonds.host_nic]
    [action.removed_bonds.host_nic]
    [action.synchronized_network_attachments.network_attachment]
    [action.modified_labels.label]
    [action.removed_labels.label]
    [action.check_connectivity]
    [action.connectivity_timeout]
    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

setupnetworks

public Action setupnetworks(Action action,
                   Boolean async,
                   String correlationId)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Performs setupnetworks action.

Parameters:

action - Action

    [action.modified_network_attachments.network_attachment]
    [action.removed_network_attachments.network_attachment]
    [action.modified_bonds.host_nic]
    [action.removed_bonds.host_nic]
    [action.synchronized_network_attachments.network_attachment]
    [action.modified_labels.label]
    [action.removed_labels.label]
    [action.check_connectivity]
    [action.connectivity_timeout]
    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

unregisteredstoragedomainsdiscover

public Action unregisteredstoragedomainsdiscover(Action action)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 ServerException,
                                                 IOException

Performs unregisteredstoragedomainsdiscover action.

Parameters:

action - Action

    [action.iscsi.address]
    [action.iscsi_target]
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

unregisteredstoragedomainsdiscover

public Action unregisteredstoragedomainsdiscover(Action action,
                                        String correlationId)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 ServerException,
                                                 IOException

Performs unregisteredstoragedomainsdiscover action.

Parameters:

action - Action

    [action.iscsi.address]
    [action.iscsi_target]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

unregisteredstoragedomainsdiscover

public Action unregisteredstoragedomainsdiscover(Action action,
                                        String correlationId,
                                        Boolean async)
                                          throws org.apache.http.client.ClientProtocolException,
                                                 ServerException,
                                                 IOException

Performs unregisteredstoragedomainsdiscover action.

Parameters:

action - Action

    [action.iscsi.address]
    [action.iscsi_target]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public Host update()
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Updates Host object.

Parameters:

host - Host

    Overload 1:

      update the specified host in
      the system. This is deprecated
      and is provided only for
      backwards compatibility

      [host.name]
      [host.comment]
      [host.address]
      [host.root_password]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
      [host.external_host_provider.id]

    Overload 2:

      update the specified host in the system

      [host.name]
      [host.comment]
      [host.address]
      [host.ssh.port]
      [host.ssh.user.user_name]
      [host.ssh.fingerprint]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
    

Returns:

Host

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public Host update(Boolean async)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Updates Host object.

Parameters:

host - Host

    Overload 1:

      update the specified host in
      the system. This is deprecated
      and is provided only for
      backwards compatibility

      [host.name]
      [host.comment]
      [host.address]
      [host.root_password]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
      [host.external_host_provider.id]

    Overload 2:

      update the specified host in the system

      [host.name]
      [host.comment]
      [host.address]
      [host.ssh.port]
      [host.ssh.user.user_name]
      [host.ssh.fingerprint]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
    

async -

    [true|false]
    

Returns:

Host

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public Host update(Boolean async,
          String correlationId)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Updates Host object.

Parameters:

host - Host

    Overload 1:

      update the specified host in
      the system. This is deprecated
      and is provided only for
      backwards compatibility

      [host.name]
      [host.comment]
      [host.address]
      [host.root_password]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
      [host.external_host_provider.id]

    Overload 2:

      update the specified host in the system

      [host.name]
      [host.comment]
      [host.address]
      [host.ssh.port]
      [host.ssh.user.user_name]
      [host.ssh.fingerprint]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Host

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

update

public Host update(Boolean async,
          String correlationId,
          String expect)
            throws org.apache.http.client.ClientProtocolException,
                   ServerException,
                   IOException

Updates Host object.

Parameters:

host - Host

    Overload 1:

      update the specified host in
      the system. This is deprecated
      and is provided only for
      backwards compatibility

      [host.name]
      [host.comment]
      [host.address]
      [host.root_password]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
      [host.external_host_provider.id]

    Overload 2:

      update the specified host in the system

      [host.name]
      [host.comment]
      [host.address]
      [host.ssh.port]
      [host.ssh.user.user_name]
      [host.ssh.fingerprint]
      [host.display.address]
      [host.cluster.id|name]
      [host.port]
      [host.spm.priority]
      [host.power_management.type]
      [host.power_management.automatic_pm_enabled]
      [host.power_management.enabled]
      [host.power_management.address]
      [host.power_management.username]
      [host.power_management.password]
      [host.power_management.options.option]
      [host.power_management.pm_proxy]
      [host.power_management.agents.agent]
      [host.power_management.kdump_detection]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

expect -

    [202-accepted]
    

Returns:

Host

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

upgrade

public Action upgrade(Action action)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs upgrade action.

Parameters:

action - Action

    [action.image]
    [action.async]
    [action.grace_period.expiry]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

upgrade

public Action upgrade(Action action,
             Boolean async)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs upgrade action.

Parameters:

action - Action

    [action.image]
    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

upgrade

public Action upgrade(Action action,
             Boolean async,
             String correlationId)
               throws org.apache.http.client.ClientProtocolException,
                      ServerException,
                      IOException

Performs upgrade action.

Parameters:

action - Action

    [action.image]
    [action.async]
    [action.grace_period.expiry]
    

async -

    [true|false]
    

correlationId -

    [any string]
    

Returns:

Action

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.