org.jclouds.openstack.nova.v2_0.extensions

Interface HostAdministrationApi

public interface HostAdministrationApi

Provides asynchronous access to Host Administration features via the REST API.

Author:

Adam Lowe

See Also:

HostAdministrationAsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	disableHost(String hostId) Prevent the specified host from accepting new instances.
Boolean	enableHost(String hostId) Allow the specified host to accept new instances.
Set<HostResourceUsage>	getHostResourceUsage(String hostId) Retrieves the physical/usage resource on a specific host
Set<Host>	listHosts() Returns the list of hosts
Boolean	rebootHost(String hostId) Reboot a host.
Boolean	shutdownHost(String hostId) Shutdown a host.
Boolean	startHostMaintenance(String hostId) Start host maintenance window.
Boolean	startupHost(String hostId) Startup a host.
Boolean	stopHostMaintenance(String hostId) Stop host maintenance window.

Method Detail

listHosts

Set<Host> listHosts()

Returns the list of hosts

Returns:

the usage information

getHostResourceUsage

Set<HostResourceUsage> getHostResourceUsage(String hostId)

Retrieves the physical/usage resource on a specific host

Returns:

the usage information

enableHost

Boolean enableHost(String hostId)

Allow the specified host to accept new instances.

Returns:

true if successful

disableHost

Boolean disableHost(String hostId)

Prevent the specified host from accepting new instances.

Returns:

true if successful

startHostMaintenance

Boolean startHostMaintenance(String hostId)

Start host maintenance window.

Note: this triggers guest VMs evacuation.

Returns:

true if successful

stopHostMaintenance

Boolean stopHostMaintenance(String hostId)

Stop host maintenance window.

Returns:

true if successful

startupHost

Boolean startupHost(String hostId)

Startup a host.

Returns:

true if successful

shutdownHost

Boolean shutdownHost(String hostId)

Shutdown a host.

Returns:

true if successful

rebootHost

Boolean rebootHost(String hostId)

Reboot a host.

Returns:

true if successful