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

@Beta
public interface HostAggregateApi

Provide access to the OpenStack Compute (Nova) Host Aggregates extension API.

Method Summary

HostAggregate	addHost(String id, String host) Adds a host to an aggregate
HostAggregate	createInAvailabilityZone(String name, String availabilityZone) Creates an aggregate, given its name and availability zone.
Boolean	delete(String id) Removes an aggregate.
HostAggregate	get(String id) Retrieves the details of an aggregate, hosts and metadata included.
com.google.common.collect.FluentIterable<HostAggregate>	list() Lists all host aggregates.
HostAggregate	removeHost(String id, String host) Removes a host from an aggregate
HostAggregate	setMetadata(String id, Map<String,String> metadata) Adds metadata to an aggregate
HostAggregate	updateAvailabilityZone(String id, String availabilityZone) Updates the availability zone for an aggregate.
HostAggregate	updateName(String id, String name) Updates the name of an aggregate.

Method Detail

list

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

Lists all host aggregates.

Returns:

the set of host aggregates.

get

@Named(value="hostAggregate:get")
@Nullable
HostAggregate get(String id)

Retrieves the details of an aggregate, hosts and metadata included.

Returns:

the details of the aggregate requested.

createInAvailabilityZone

@Named(value="hostAggregate:create")
HostAggregate createInAvailabilityZone(String name,
                                             String availabilityZone)

Creates an aggregate, given its name and availability zone.

Returns:

the newly created Aggregate

updateName

@Named(value="hostAggregate:update")
HostAggregate updateName(String id,
                               String name)

Updates the name of an aggregate.

updateAvailabilityZone

@Named(value="hostAggregate:update")
HostAggregate updateAvailabilityZone(String id,
                                           String availabilityZone)

Updates the availability zone for an aggregate.

delete

@Named(value="hostAggregate:delete")
Boolean delete(String id)

Removes an aggregate.

addHost

@Named(value="hostAggregate:addHost")
HostAggregate addHost(String id,
                            String host)

Adds a host to an aggregate

removeHost

@Named(value="hostAggregate:removeHost")
HostAggregate removeHost(String id,
                               String host)

Removes a host from an aggregate

setMetadata

@Named(value="hostAggregate:setMetadata")
HostAggregate setMetadata(String id,
                                Map<String,String> metadata)

Adds metadata to an aggregate