org.jclouds.cloudstack.features

Interface VMGroupClient

public interface VMGroupClient

Provides synchronous access to CloudStack VM group features.

Author:

Richard Downer

See Also:

VMGroupAsyncClient,

Method Summary

Methods

Modifier and Type	Method and Description
VMGroup	createInstanceGroup(String name, CreateVMGroupOptions... options) Creates a VM group
void	deleteInstanceGroup(long id) Delete a VM group
VMGroup	getInstanceGroup(long id) Retrieve a VM group by its id
Set<VMGroup>	listInstanceGroups(ListVMGroupsOptions... options) Lists VM groups
VMGroup	updateInstanceGroup(long id, UpdateVMGroupOptions... options) Modify a VM group

Method Detail

listInstanceGroups

Set<VMGroup> listInstanceGroups(ListVMGroupsOptions... options)

Lists VM groups

Parameters:

options - if present, how to constrain the list.

Returns:

VM groups matching query, or empty set, if no groups are found

getInstanceGroup

VMGroup getInstanceGroup(long id)

Retrieve a VM group by its id

Parameters:

id - the id of the required VM group.

Returns:

the VM group with the requested id, or null if not found

createInstanceGroup

VMGroup createInstanceGroup(String name,
                          CreateVMGroupOptions... options)

Creates a VM group

Parameters:

name - the name of the VM group

options - optional parameters

Returns:

the new VMGroup

updateInstanceGroup

VMGroup updateInstanceGroup(long id,
                          UpdateVMGroupOptions... options)

Modify a VM group

Parameters:

name - the new name of the group

Returns:

the modified VMGroup

deleteInstanceGroup

void deleteInstanceGroup(long id)

Delete a VM group

Parameters:

id - the ID of the VM group