Package org.jclouds.cloudstack.features

Interface VMGroupApi

public interface VMGroupApi

Provides synchronous access to CloudStack VM group features.

See Also:

Method Summary

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

Method Detail

listInstanceGroups

@Named("listInstanceGroups")
@GET
@Consumes("application/json")
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 zones are found

getInstanceGroup

@Named("listInstanceGroups")
@GET
@Consumes("application/json")
VMGroup getInstanceGroup(@QueryParam("id")
                         String id)

See Also:

getInstanceGroup(java.lang.String)

createInstanceGroup

@Named("createInstanceGroup")
@GET
@Consumes("application/json")
VMGroup createInstanceGroup(@QueryParam("name")
                            String name,
                            CreateVMGroupOptions... options)

Creates a VM group

Parameters:

name - the name of the VM group

options - optional parameters

Returns:

the new VMGroup

updateInstanceGroup

@Named("updateInstanceGroup")
@GET
@Consumes("application/json")
VMGroup updateInstanceGroup(@QueryParam("id")
                            String id,
                            UpdateVMGroupOptions... options)

Modify a VM group

Parameters:

name - the new name of the group

Returns:

the modified VMGroup

deleteInstanceGroup

@Named("deleteInstanceGroup")
@GET
void deleteInstanceGroup(@QueryParam("id")
                         String id)

Delete a VM group

Parameters:

id - the ID of the VM group