VirtualMachineApi (Apache jclouds 2.1.0 API)

Methods
Modifier and Type	Method and Description
`VirtualMachine`	`assignVirtualMachine(String virtualMachineId, AssignVirtualMachineOptions... options)` Re-assign a virtual machine to a different account/domain.
`String`	`changeServiceForVirtualMachine(String id, String serviceOfferingId)` Changes the service offering for a virtual machine.
`AsyncCreateResponse`	`deployVirtualMachineInZone(String zoneId, String serviceOfferingId, String templateId, DeployVirtualMachineOptions... options)` Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.
`String`	`destroyVirtualMachine(String id)` Destroys a virtual machine.
`String`	`getEncryptedPasswordForVirtualMachine(String id)` Return an encrypted password for the virtual machine.
`VirtualMachine`	`getVirtualMachine(String id)` get a specific VirtualMachine by id
`Set<VirtualMachine>`	`listVirtualMachines(ListVirtualMachinesOptions... options)` Lists VirtualMachines
`String`	`rebootVirtualMachine(String id)` Reboots a virtual machine.
`String`	`resetPasswordForVirtualMachine(String id)` Resets the password for virtual machine.
`String`	`startVirtualMachine(String id)` Starts a virtual machine.
`String`	`stopVirtualMachine(String id)` Stops a virtual machine.
`String`	`stopVirtualMachine(String id, StopVirtualMachineOptions options)` Stops a virtual machine.
`String`	`updateVirtualMachine(String id, UpdateVirtualMachineOptions options)` Updates parameters of a virtual machine.

```
public interface VirtualMachineApi
```
Provides synchronous access to cloudstack via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

VirtualMachine assignVirtualMachine(String virtualMachineId, AssignVirtualMachineOptions... options)
Re-assign a virtual machine to a different account/domain.

String changeServiceForVirtualMachine(String id, String serviceOfferingId)
Changes the service offering for a virtual machine.

AsyncCreateResponse deployVirtualMachineInZone(String zoneId, String serviceOfferingId, String templateId, DeployVirtualMachineOptions... options)
Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.

String destroyVirtualMachine(String id)
Destroys a virtual machine.

String getEncryptedPasswordForVirtualMachine(String id)
Return an encrypted password for the virtual machine.

VirtualMachine getVirtualMachine(String id)
get a specific VirtualMachine by id

Set<VirtualMachine> listVirtualMachines(ListVirtualMachinesOptions... options)
Lists VirtualMachines

String rebootVirtualMachine(String id)
Reboots a virtual machine.

String resetPasswordForVirtualMachine(String id)
Resets the password for virtual machine.

String startVirtualMachine(String id)
Starts a virtual machine.

String stopVirtualMachine(String id)
Stops a virtual machine.

String stopVirtualMachine(String id, StopVirtualMachineOptions options)
Stops a virtual machine.

String updateVirtualMachine(String id, UpdateVirtualMachineOptions options)
Updates parameters of a virtual machine.

Method Detail

listVirtualMachines
```
@Named(value="listVirtualMachines")
@GET
@Consumes(value="application/json")
Set<VirtualMachine> listVirtualMachines(ListVirtualMachinesOptions... options)
```
Lists VirtualMachines

Parameters:
options - if present, how to constrain the list.

Returns:
VirtualMachines matching query, or empty set, if no VirtualMachines are found

getVirtualMachine

@Named(value="listVirtualMachines")
@GET
@Consumes(value="application/json")
VirtualMachine getVirtualMachine(@QueryParam(value="id")
                                                  String id)

get a specific VirtualMachine by id

Parameters:: id - VirtualMachine to get
Returns:: VirtualMachine or null if not found

deployVirtualMachineInZone

@Named(value="deployVirtualMachine")
@GET
@Consumes(value="application/json")
AsyncCreateResponse deployVirtualMachineInZone(@QueryParam(value="zoneid")
                                                                String zoneId,
                                                                @QueryParam(value="serviceofferingid")
                                                                String serviceOfferingId,
                                                                @QueryParam(value="templateid")
                                                                String templateId,
                                                                DeployVirtualMachineOptions... options)

Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.

Parameters:: zoneId - availability zone for the virtual machine; serviceOfferingId - the ID of the service offering for the virtual machine; templateId - the ID of the template for the virtual machine
Returns:: virtual machine

rebootVirtualMachine

@Named(value="rebootVirtualMachine")
@GET
@Consumes(value="application/json")
String rebootVirtualMachine(@QueryParam(value="id")
                                             String id)

Reboots a virtual machine.

Parameters:: id - The ID of the virtual machine
Returns:: job id related to destroying the VM

startVirtualMachine

@Named(value="startVirtualMachine")
@GET
@Consumes(value="application/json")
String startVirtualMachine(@QueryParam(value="id")
                                            String id)

Starts a virtual machine.

Parameters:: id - The ID of the virtual machine
Returns:: job id related to destroying the VM

stopVirtualMachine

@Named(value="stopVirtualMachine")
@GET
@Consumes(value="application/json")
String stopVirtualMachine(@QueryParam(value="id")
                                           String id)

Stops a virtual machine.

Parameters:: id - The ID of the virtual machine
Returns:: job id related to destroying the VM

stopVirtualMachine

@GET
@Consumes(value="application/json")
String stopVirtualMachine(@QueryParam(value="id")
                                     String id,
                                     StopVirtualMachineOptions options)

Stops a virtual machine.

Parameters:: id - The ID of the virtual machine; options - If present, whether to force stop.
Returns:: job id related to destroying the VM

resetPasswordForVirtualMachine
```
@Named(value="resetPasswordForVirtualMachine")
@GET
@Consumes(value="application/json")
String resetPasswordForVirtualMachine(@QueryParam(value="id")
                                                       String id)
```
Resets the password for virtual machine. The virtual machine must be in a "Stopped" state and the template must already support this feature for this command to take effect.

Parameters:
id - The ID of the virtual machine

Returns:
job id related to destroying the VM

getEncryptedPasswordForVirtualMachine

@Named(value="getVMPassword")
@GET
@Consumes(value="application/json")
String getEncryptedPasswordForVirtualMachine(@QueryParam(value="id")
                                                              String id)

Return an encrypted password for the virtual machine. The command is asynchronous.

Parameters:: id - the ID of the virtual machine
Returns:: encrypted password

changeServiceForVirtualMachine

@Named(value="changeServiceForVirtualMachine")
@GET
@Consumes(value="application/json")
String changeServiceForVirtualMachine(@QueryParam(value="id")
                                                       String id,
                                                       @QueryParam(value="serviceofferingid")
                                                       String serviceOfferingId)

Changes the service offering for a virtual machine. The virtual machine must be in a "Stopped" state for this command to take effect.

Parameters:: id - The ID of the virtual machine; serviceOfferingId - The service offering ID to apply to the virtual machine
Returns:: job id related to destroying the VM

updateVirtualMachine

@Named(value="updateVirtualMachine")
@GET
@Consumes(value="application/json")
String updateVirtualMachine(@QueryParam(value="id")
                                             String id,
                                             UpdateVirtualMachineOptions options)

Updates parameters of a virtual machine.

Parameters:: id - The ID of the virtual machine
Returns:: job id related to destroying the VM

destroyVirtualMachine

@Named(value="destroyVirtualMachine")
@GET
@Consumes(value="application/json")
String destroyVirtualMachine(@QueryParam(value="id")
                                              String id)

Destroys a virtual machine. Once destroyed, only the administrator can recover it.

Parameters:: id - vm to destroy
Returns:: job id related to destroying the VM, or null if resource was not found

assignVirtualMachine

@Named(value="assignVirtualMachine")
@GET
@Consumes(value="application/json")
VirtualMachine assignVirtualMachine(@QueryParam(value="virtualmachineid")
                                                     String virtualMachineId,
                                                     AssignVirtualMachineOptions... options)

Re-assign a virtual machine to a different account/domain.

Parameters:: virtualMachineId - VirtualMachine to re-assign; options - AssignVirtualMachineOptions specifying account and domain to transfer to, and optional network and security group IDs.
Returns:: VirtualMachine or null if not found

Interface VirtualMachineApi

Method Summary

Method Detail

listVirtualMachines

getVirtualMachine

deployVirtualMachineInZone

rebootVirtualMachine

startVirtualMachine

stopVirtualMachine

stopVirtualMachine

resetPasswordForVirtualMachine

getEncryptedPasswordForVirtualMachine

changeServiceForVirtualMachine

updateVirtualMachine

destroyVirtualMachine

assignVirtualMachine