Package org.opennebula.client.host
Class Host
java.lang.Object
org.opennebula.client.PoolElement
org.opennebula.client.host.Host
This class represents an OpenNebula host.
It also offers static XML-RPC call wrappers.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class org.opennebula.client.PoolElement
client, id, xml, xpath
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic OneResponse
Allocates a new host in OpenNebulastatic OneResponse
Allocates a new host in OpenNebuladelete()
Deletes the host from OpenNebula.static OneResponse
Deletes a host from OpenNebula.disable()
Disables the hostenable()
Enables the host.info()
Loads the xml representation of the host.static OneResponse
Retrieves the information of the given host.static OneResponse
Retrieves the information of the given Host.boolean
Returns true if the host is enabled.Retrieves the monitoring information of the given host, in XMLstatic OneResponse
monitoring
(Client client, int id) Retrieves the monitoring information of the given host, in XMLoffline()
Sets the host offlineRenames this Host.static OneResponse
Renames this Host.Returns the short length string state of the Host.stateStr()
Returns the state of the Host.static OneResponse
status
(Client client, int id, Host.Status status) Enables or disables a given host.Replaces the template contents.Replaces the template contents.static OneResponse
Replaces the template contents.
-
Constructor Details
-
Host
Creates a new Host representation.- Parameters:
id
- The host id (hid) of the machine.client
- XML-RPC Client.
-
Host
- See Also:
-
-
Method Details
-
allocate
public static OneResponse allocate(Client client, String hostname, String im, String vmm, int clusterId) Allocates a new host in OpenNebula- Parameters:
client
- XML-RPC Client.hostname
- Hostname of the machine we want to addim
- The name of the information manager (im_mad_name), this values are taken from the oned.conf with the tag name IM_MAD (name)vmm
- The name of the virtual machine manager mad name (vmm_mad_name), this values are taken from the oned.conf with the tag name VM_MAD (name)clusterId
- The cluster ID. If it is -1, this host won't be added to any cluster.- Returns:
- If successful the message contains the associated id generated for this host
-
allocate
Allocates a new host in OpenNebula- Parameters:
client
- XML-RPC Client.hostname
- Hostname of the machine we want to addim
- The name of the information manager (im_mad_name), this values are taken from the oned.conf with the tag name IM_MAD (name)vmm
- The name of the virtual machine manager mad name (vmm_mad_name), this values are taken from the oned.conf with the tag name VM_MAD (name)- Returns:
- If successful the message contains the associated id generated for this host
-
info
Retrieves the information of the given host.- Parameters:
client
- XML-RPC Client.id
- The host id (hid) of the target machine.- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
info
Retrieves the information of the given Host.- Parameters:
client
- XML-RPC Client.id
- The Host id for the Host to retrieve the information fromdecrypt
- If true decrypt sensitive attributes- Returns:
- If successful the message contains the string with the information returned by OpenNebula.
-
delete
Deletes a host from OpenNebula.- Parameters:
client
- XML-RPC Client.id
- The host id (hid) of the target machine.- Returns:
- A encapsulated response.
-
status
Enables or disables a given host.- Parameters:
client
- XML-RPC Client.id
- The host id (hid) of the target machine.status
- Host status- Returns:
- A encapsulated response.
-
update
Replaces the template contents.- Parameters:
client
- XML-RPC Client.id
- The image id of the target host we want to modify.new_template
- New template contentsappend
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the host id.
-
monitoring
Retrieves the monitoring information of the given host, in XML- Parameters:
client
- XML-RPC Client.id
- The host id (hid) of the target machine.- Returns:
- If successful the message contains the string with the monitoring information returned by OpenNebula.
-
rename
Renames this Host.- Parameters:
client
- XML-RPC Client.id
- The image id of the target host we want to modify.name
- New name for the Host- Returns:
- If successful the message contains the host id.
-
info
Loads the xml representation of the host. The info is also stored internally.- See Also:
-
delete
Deletes the host from OpenNebula.- See Also:
-
enable
Enables the host.- Returns:
- A encapsulated response.
-
disable
Disables the host- Returns:
- A encapsulated response.
-
offline
Sets the host offline- Returns:
- A encapsulated response.
-
update
Replaces the template contents.- Parameters:
new_template
- New template contents- Returns:
- If successful the message contains the host id.
-
update
Replaces the template contents.- Parameters:
new_template
- New template contentsappend
- True to append new attributes instead of replace the whole template- Returns:
- If successful the message contains the host id.
-
monitoring
Retrieves the monitoring information of the given host, in XML- Returns:
- If successful the message contains the string with the monitoring information returned by OpenNebula.
-
rename
Renames this Host.- Parameters:
name
- New name for the Host- Returns:
- If successful the message contains the host id.
-
stateStr
Returns the state of the Host.
The methodinfo()
must be called before.- Returns:
- The state of the Host.
-
shortStateStr
Returns the short length string state of the Host.
The methodinfo()
must be called before.- Returns:
- The short length string state of the Host.
-
isEnabled
public boolean isEnabled()Returns true if the host is enabled.- Returns:
- True if the host is enabled.
-