org.ovirt.engine.sdk.decorators

Class Hosts

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Host,Hosts,Host>

org.ovirt.engine.sdk.decorators.Hosts

public class Hosts
extends CollectionDecorator<Host,Hosts,Host>

Hosts providing relation and functional services

to Hosts.

Constructor Summary

Constructors

Constructor and Description
Hosts(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Host	add(Host host) Adds Host object.
Host	add(Host host, String expect) Adds Host object.
Host	add(Host host, String expect, String correlationId) Adds Host object.
Host	get(UUID id) Fetches Host object by id.
Host	getById(String id) Fetches Host object by id.
List<Host>	list() Lists Host objects.
List<Host>	list(String query, Boolean caseSensitive, Integer max) Lists Host objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

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

Constructor Detail

Hosts

public Hosts(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

public List<Host> list()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Lists Host objects.

Specified by:

list in class CollectionDecorator<Host,Hosts,Host>

Returns:

List of 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.

get

public Host get(UUID id)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Fetches Host object by id.

Specified by:

get in class CollectionDecorator<Host,Hosts,Host>

Parameters:

id - entity id

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.

getById

public Host getById(String id)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Fetches Host object by id.

Specified by:

getById in class CollectionDecorator<Host,Hosts,Host>

Parameters:

id - entity id

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.

list

public List<Host> list(String query,
                       Boolean caseSensitive,
                       Integer max)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Lists Host objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of 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.

add

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

Adds Host object.

Parameters:

host - Host

    Overload 1:

      add a new host to the system
      providing the host root
      password. This has been
      deprecated and provided for
      backwards compatibility

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

    Overload 2:

      add a new host to the system
      providing the ssh password or
      fingerprint

      host.name
      host.address
      host.cluster.id|name
      [host.comment]
      [host.ssh.port]
      [host.ssh.fingerprint]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [host.port]
      [host.display.address]
      [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.reboot_after_installation]
      [host.override_iptables]
      [host.power_management.kdump_detection]
      [host.protocol]
    

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.

add

public Host add(Host host,
                String expect)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Adds Host object.

Parameters:

host - Host

    Overload 1:

      add a new host to the system
      providing the host root
      password. This has been
      deprecated and provided for
      backwards compatibility

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

    Overload 2:

      add a new host to the system
      providing the ssh password or
      fingerprint

      host.name
      host.address
      host.cluster.id|name
      [host.comment]
      [host.ssh.port]
      [host.ssh.fingerprint]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [host.port]
      [host.display.address]
      [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.reboot_after_installation]
      [host.override_iptables]
      [host.power_management.kdump_detection]
      [host.protocol]
    

expect -

    [201-created]
    

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.

add

public Host add(Host host,
                String expect,
                String correlationId)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Adds Host object.

Parameters:

host - Host

    Overload 1:

      add a new host to the system
      providing the host root
      password. This has been
      deprecated and provided for
      backwards compatibility

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

    Overload 2:

      add a new host to the system
      providing the ssh password or
      fingerprint

      host.name
      host.address
      host.cluster.id|name
      [host.comment]
      [host.ssh.port]
      [host.ssh.fingerprint]
      [host.ssh.authentication_method]
      [host.ssh.user.user_name]
      [host.ssh.user.password]
      [host.port]
      [host.display.address]
      [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.reboot_after_installation]
      [host.override_iptables]
      [host.power_management.kdump_detection]
      [host.protocol]
    

expect -

    [201-created]
    

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.