|
Oracle VM Manager Web Services API Reference Release 2.1.5 E14979-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VirtualMachineManagement
VirtualMachineService interface. This interface is to define these functions: pause/unpause/powerOn/powerOff/delete/reboot/suspend/resume/save as template/query Virtual Machine.
Method Summary | |
---|---|
void |
configureVM(VirtualMachine virtualMachine, VMConfig config) Deprecated. |
void |
createPropertiesFileOnVirtualMachine(java.util.Properties props, VirtualMachine vm, java.lang.String propFileName) Create vm property file for guest configuration |
void |
deleteVM(VirtualMachine virtualMachine) Deprecated. |
void |
deleteVMByVMId(java.lang.Long vmId) Delete a virtual machine |
java.util.List |
getAllAlertAssociatedWithImg(VirtualMachine vm) Query all alerts associated with a vm. |
java.util.List |
getAllOperatingSystem() Deprecated. |
OperatingSystem[] |
getAllOperatingSystemArray() Query all available Operating System. |
VirtualMachine[] |
getAllVMs(ServerPool serverPool) Returns an array of all the virtual machines by the server pool. |
VirtualMachine[] |
getAllVMs(VirtualServer server) Returns an array of all the virtual machines by the virtual server. |
ServerPool |
getAssociatedPool(VirtualMachine virtualMachine) Returns server pool details, where the virtual machine is physically (and logically) stored. |
VirtualServer |
getAssociatedServer(VirtualMachine virtualMachine) Returns virtual server details, currently hosting the virtual machine. |
AlertLog |
getLastAlertAssociatedWithDisk(VirtualDisk disk) Query latest alert associated with a disk. |
AlertLog |
getLastAlertAssociatedWithDisk(VirtualDisk disk, oracle.ovs.biz.log.AlertLevel level) Query latest alert associated with a disk. |
AlertLog |
getLastAlertAssociatedWithImg(VirtualMachine vm) Query latest alert associated with a vm. |
AlertLog |
getLastAlertAssociatedWithImg(VirtualMachine vm, oracle.ovs.biz.log.AlertLevel level) Query latest alert associated with a vm and alertLevel |
java.lang.String |
getRealPath(VirtualMachine vm) Get the absolute path of a virtual machine in the file system. |
VirtualMachine |
getVM(VirtualMachine virtualMachine) Returns an instance of the virtual machine details. |
VirtualMachine |
getVMByName(ServerPool serverPool, java.lang.String name) Deprecated. |
VirtualMachine |
getVMByName(java.lang.String serverPoolName, java.lang.String name) Returns an instance of the virtual machine details, by its name and serverPoolName |
java.lang.String |
getVncPassword(VirtualMachine vm) Get vnc password of a virtual machine. |
void |
pauseVM(VirtualMachine virtualMachine) Deprecated. |
void |
pauseVMByVMId(java.lang.Long vmId) Pause a virtual machine |
void |
powerOffVM(VirtualMachine virtualMachine) Deprecated. |
void |
powerOffVMByVMId(java.lang.Long vmId) Power off a virtual machine |
void |
powerOnVM(VirtualMachine virtualMachine) Deprecated. |
void |
powerOnVMByVMId(java.lang.Long vmId) Power on a virtual machine |
java.util.List |
queryCdrom(VirtualMachine vm) Deprecated. |
CdConfig[] |
queryCdromArray(VirtualMachine vm) Query CDROM of a virutal machine |
VirtualDisk |
queryLocalDiskInfo(VirtualDisk disk) Query virtual disk status |
java.util.List |
queryLocalDisks(VirtualMachine vm) Query local disks of a virtual machine. |
VirtualNetworkCard[] |
queryNetworkInterfaceCardArray(VirtualMachine vm) Query network interface cards of a vm |
java.util.List |
queryNetworkInterfaceCards(VirtualMachine vm) Deprecated. |
java.util.List |
queryPreferredServer(VirtualMachine vm) Query preferred servers of a vm |
VirtualServer[] |
queryPreferredServerArray(java.lang.Long vmId) Query preferred servers of a vm by vmId |
java.util.List |
querySharedDisks(VirtualMachine vm) Deprecated. |
SharedVirtualDisk[] |
querySharedVirtualDiskArray(java.lang.Long vmId) Query shared virtual disk of a virtual machine. |
VmMetrics[] |
queryVMMetricArrayByVMIds(long[] vmIds) Query virtual machine metrics array by vm Ids referenced queryVMMetricByVMId(long vmId) |
VmMetrics |
queryVMMetricByVMId(long vmId) Query virtual machine metrics by vm Id Performance metrics only apply to running vm, so if the vm status is not running, the return value will not contain useful info but just an object having vmId. |
VmStatus |
queryVMStatus(VirtualMachine virtualMachine) Deprecated. |
VmStatus[] |
queryVMStatusArrayByVMIds(long[] vmIds) Query virtual machine status array by vmIds |
VmStatus |
queryVMStatusByVMId(long vmId) Query virtual machine status by vmId |
void |
rebootVM(VirtualMachine virtualMachine) Deprecated. |
void |
rebootVMByVMId(java.lang.Long vmId) Reboot a virtual machine |
void |
resumeVM(VirtualMachine virtualMachine) Deprecated. |
void |
resumeVMByVMId(java.lang.Long vmId) resume a suspended virtual machine |
void |
saveAsTemplate(VirtualMachine vm) Deprecated. |
void |
saveAsTemplate(VirtualMachine vm, java.lang.String templateName) Save as template based on a virtual machine --must set imgId of parameter object |
void |
saveAsTemplateAsync(VirtualMachine vm, java.lang.String templateName) Save as template using async call based on a virtual machine --must set imgId of parameter object |
void |
setVMName(VirtualMachine virtualMachine, java.lang.String val) Sets the virtual machine name. |
void |
suspendVM(VirtualMachine virtualMachine) Deprecated. |
void |
suspendVMByVMId(java.lang.Long vmId) Suspend a running virtual machine. |
void |
unpauseVM(VirtualMachine virtualMachine) Deprecated. |
void |
unpauseVMByVMId(java.lang.Long vmId) Unpause a virtual machine |
void |
unregisterVM(VirtualMachine virtualMachine) Deprecated. |
void |
unregisterVMByVMId(java.lang.Long vmId) Unregister a virtual machine. |
java.lang.Object |
update(java.lang.Object object) Update information |
Method Detail |
---|
VirtualMachine[] getAllVMs(ServerPool serverPool) throws oracle.ovs.biz.exception.OVSException
serverPool
-oracle.ovs.biz.exception.OVSException
VirtualMachine[] getAllVMs(VirtualServer server) throws oracle.ovs.biz.exception.OVSException
server
-oracle.ovs.biz.exception.OVSException
VirtualMachine getVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
VirtualMachine getVMByName(ServerPool serverPool, java.lang.String name) throws oracle.ovs.biz.exception.OVSException
serverPool
-name
-oracle.ovs.biz.exception.OVSException
VirtualMachine getVMByName(java.lang.String serverPoolName, java.lang.String name) throws oracle.ovs.biz.exception.OVSException
serverPoolName
-name
-oracle.ovs.biz.exception.OVSException
VirtualServer getAssociatedServer(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
ServerPool getAssociatedPool(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void suspendVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void suspendVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void resumeVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void resumeVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void setVMName(VirtualMachine virtualMachine, java.lang.String val) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-val
-oracle.ovs.biz.exception.OVSException
void configureVM(VirtualMachine virtualMachine, VMConfig config) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-config
-oracle.ovs.biz.exception.OVSException
void deleteVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void deleteVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void powerOnVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void powerOnVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void powerOffVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void powerOffVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void pauseVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void pauseVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
void unpauseVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void unpauseVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
VmStatus queryVMStatus(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
VmStatus queryVMStatusByVMId(long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
VmStatus[] queryVMStatusArrayByVMIds(long[] vmIds) throws oracle.ovs.biz.exception.OVSException
vmIds
-oracle.ovs.biz.exception.OVSException
VmMetrics queryVMMetricByVMId(long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
VmMetrics[] queryVMMetricArrayByVMIds(long[] vmIds) throws oracle.ovs.biz.exception.OVSException
vmIds
-oracle.ovs.biz.exception.OVSException
VirtualDisk queryLocalDiskInfo(VirtualDisk disk) throws oracle.ovs.biz.exception.OVSException
oracle.ovs.biz.exception.OVSException
java.util.List queryCdrom(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
CdConfig[] queryCdromArray(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
void rebootVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void rebootVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
java.util.List getAllOperatingSystem() throws oracle.ovs.biz.exception.OVSException
oracle.ovs.biz.exception.OVSException
OperatingSystem[] getAllOperatingSystemArray() throws oracle.ovs.biz.exception.OVSException
oracle.ovs.biz.exception.OVSException
java.util.List getAllAlertAssociatedWithImg(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
AlertLog getLastAlertAssociatedWithImg(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
AlertLog getLastAlertAssociatedWithImg(VirtualMachine vm, oracle.ovs.biz.log.AlertLevel level) throws oracle.ovs.biz.exception.OVSException
vm
-level
-oracle.ovs.biz.exception.OVSException
AlertLog getLastAlertAssociatedWithDisk(VirtualDisk disk) throws oracle.ovs.biz.exception.OVSException
disk
-oracle.ovs.biz.exception.OVSException
AlertLog getLastAlertAssociatedWithDisk(VirtualDisk disk, oracle.ovs.biz.log.AlertLevel level) throws oracle.ovs.biz.exception.OVSException
disk
-level
-oracle.ovs.biz.exception.OVSException
java.util.List queryLocalDisks(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
java.util.List querySharedDisks(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
SharedVirtualDisk[] querySharedVirtualDiskArray(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
java.util.List queryNetworkInterfaceCards(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
VirtualNetworkCard[] queryNetworkInterfaceCardArray(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
java.util.List queryPreferredServer(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
VirtualServer[] queryPreferredServerArray(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
java.lang.Object update(java.lang.Object object) throws oracle.ovs.biz.exception.OVSException
object
-oracle.ovs.biz.exception.OVSException
java.lang.String getVncPassword(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
void saveAsTemplate(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
void saveAsTemplate(VirtualMachine vm, java.lang.String templateName) throws oracle.ovs.biz.exception.OVSException
vm
-templateName
- name of new templateoracle.ovs.biz.exception.OVSException
void saveAsTemplateAsync(VirtualMachine vm, java.lang.String templateName) throws oracle.ovs.biz.exception.OVSException
vm
-templateName
- name of new templateoracle.ovs.biz.exception.OVSException
java.lang.String getRealPath(VirtualMachine vm) throws oracle.ovs.biz.exception.OVSException
vm
-oracle.ovs.biz.exception.OVSException
void createPropertiesFileOnVirtualMachine(java.util.Properties props, VirtualMachine vm, java.lang.String propFileName) throws oracle.ovs.biz.exception.OVSException
props
-vm
-propFileName
-oracle.ovs.biz.exception.OVSException
void unregisterVM(VirtualMachine virtualMachine) throws oracle.ovs.biz.exception.OVSException
virtualMachine
-oracle.ovs.biz.exception.OVSException
void unregisterVMByVMId(java.lang.Long vmId) throws oracle.ovs.biz.exception.OVSException
vmId
-oracle.ovs.biz.exception.OVSException
|
Oracle VM Manager Web Services API Reference Release 2.1.5 E14979-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |