org.jclouds.openstack.nova.v2_0.extensions
Interface HostAdministrationApi

@Beta
public interface HostAdministrationApi

Provides access to OpenStack Compute (Nova) Host Administration extension API.

Method Summary

boolean	disable(String hostId) Prevent the specified host from accepting new instances.
boolean	enable(String hostId) Allow the specified host to accept new instances.
com.google.common.collect.FluentIterable<Host>	list() Returns the list of hosts
com.google.common.collect.FluentIterable<HostResourceUsage>	listResourceUsage(String hostId) Retrieves the physical/usage resource on a specific host
boolean	reboot(String hostId) Reboot a host.
boolean	shutdown(String hostId) Shutdown a host.
boolean	startMaintenance(String hostId) Start host maintenance window.
boolean	startup(String hostId) Startup a host.
boolean	stopMaintenance(String hostId) Stop host maintenance window.

Method Detail

list

@Named(value="hostAdmin:list")
com.google.common.collect.FluentIterable<Host> list()

Returns the list of hosts

Returns:

the usage information

listResourceUsage

@Named(value="hostAdmin:listResourceUsage")
com.google.common.collect.FluentIterable<HostResourceUsage> listResourceUsage(String hostId)

Retrieves the physical/usage resource on a specific host

Returns:

the usage information

enable

@Named(value="hostAdmin:enable")
boolean enable(String hostId)

Allow the specified host to accept new instances.

Returns:

true if successful

disable

@Named(value="hostAdmin:disable")
boolean disable(String hostId)

Prevent the specified host from accepting new instances.

Returns:

true if successful

startMaintenance

@Named(value="hostAdmin:startMaintenance")
boolean startMaintenance(String hostId)

Start host maintenance window.

Note: this triggers guest VMs evacuation.

Returns:

true if successful

stopMaintenance

@Named(value="hostAdmin:stopMaintenance")
boolean stopMaintenance(String hostId)

Stop host maintenance window.

Returns:

true if successful

startup

@Named(value="hostAdmin:startup")
boolean startup(String hostId)

Startup a host.

Returns:

true if successful

shutdown

@Named(value="hostAdmin:shutdown")
boolean shutdown(String hostId)

Shutdown a host.

Returns:

true if successful

reboot

@Named(value="hostAdmin:reboot")
boolean reboot(String hostId)

Reboot a host.

Returns:

true if successful