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

Modifier and Type	Method and Description
Action	activate(Action action) Performs activate action.
Action	activate(Action action, String correlationId) Performs activate action.
Action	approve(Action action) Performs approve action.
Action	approve(Action action, String correlationId) Performs approve action.
Action	commitnetconfig(Action action) Performs commitnetconfig action.
Action	commitnetconfig(Action action, String correlationId) Performs commitnetconfig action.
Action	deactivate(Action action) Performs deactivate action.
Action	deactivate(Action action, String correlationId) Performs deactivate action.
Response	delete() 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	fence(Action action) Performs fence action.
Action	fence(Action action, String correlationId) Performs fence action.
Action	forceselectspm(Action action) Performs forceselectspm action.
Action	forceselectspm(Action action, String correlationId) Performs forceselectspm action.
HostHooks	getHooks() Gets the value of the HostHooks property.
HostNICs	getHostNics() Gets the value of the HostNICs property.
HostPermissions	getPermissions() Gets the value of the HostPermissions property.
HostStatistics	getStatistics() Gets the value of the HostStatistics property.
HostTags	getTags() Gets the value of the HostTags property.
Action	install(Action action) Performs install action.
Action	install(Action action, String correlationId) Performs install action.
Action	iscsidiscover(Action action) Performs iscsidiscover action.
Action	iscsidiscover(Action action, String correlationId) Performs iscsidiscover action.
Action	iscsilogin(Action action) Performs iscsilogin action.
Action	iscsilogin(Action action, String correlationId) Performs iscsilogin action.
Host	update() Updates Host object.
Host	update(Boolean async) Updates Host object.
Host	update(Boolean async, String correlationId) Updates Host object.

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

getAddress, getCertificate, getCluster, getCpu, getDisplay, getHardwareInformation, getIscsi, getKsm, getLibvirtVersion, getMaxSchedulingMemory, getMemory, getOs, getOverrideIptables, getPort, getPowerManagement, getRebootAfterInstallation, getRootPassword, getSsh, getStatus, getStorageManager, getSummary, getTransparentHugepages, getType, getVersion, isSetAddress, isSetCertificate, isSetCluster, isSetCpu, isSetDisplay, isSetHardwareInformation, isSetHooks, isSetIscsi, isSetKsm, isSetLibvirtVersion, isSetMaxSchedulingMemory, isSetMemory, isSetOs, isSetOverrideIptables, isSetPort, isSetPowerManagement, isSetRebootAfterInstallation, isSetRootPassword, isSetSsh, isSetStatistics, isSetStatus, isSetStorageManager, isSetSummary, isSetTransparentHugepages, isSetType, isSetVersion, setAddress, setCertificate, setCluster, setCpu, setDisplay, setHardwareInformation, setHooks, setIscsi, setKsm, setLibvirtVersion, setMaxSchedulingMemory, setMemory, setOs, setOverrideIptables, setPort, setPowerManagement, setRebootAfterInstallation, setRootPassword, setSsh, setStatistics, setStatus, setStorageManager, setSummary, setTransparentHugepages, setType, 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

getHooks

public HostHooks getHooks()

Gets the value of the HostHooks property.

Overrides:

getHooks in class Host

Returns:

HostHooks

getHostNics

public HostNICs getHostNics()

Gets the value of the HostNICs property.

Returns:

HostNICs

getTags

public HostTags getTags()

Gets the value of the HostTags property.

Returns:

HostTags

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

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]

    Overload 2:

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

      [action.ssh.port]
      [action.ssh.fingerprint]
      [action.ssh.authentication_method]
      [action.ssh.user.user_name]
      [action.ssh.user.password]
      [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.

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]

    Overload 2:

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

      [action.ssh.port]
      [action.ssh.fingerprint]
      [action.ssh.authentication_method]
      [action.ssh.user.user_name]
      [action.ssh.user.password]
      [action.image]
      [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)
                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.

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.storage_manager.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]

    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.storage_manager.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]
    

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.storage_manager.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]

    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.storage_manager.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]
    

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.storage_manager.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]

    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.storage_manager.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]
    

correlationId -

    [any string]
    

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.

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.

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.

approve

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

Performs approve action.

Parameters:

action - Action

    [action.cluster.id|name]
    [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

    [action.cluster.id|name]
    [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)
                  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.

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.

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:

correlationId -

    [any string]
    

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)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Deletes object.

Parameters:

action - Action

    [action.force]
    [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.force]
    [action.async]
    [action.grace_period.expiry]
    

correlationId -

    [any string]
    

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.

deactivate

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

Performs deactivate 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.

deactivate

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

Performs deactivate 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)
                       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.