Package com.xensource.xenapi
Class VM
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VM
A virtual machine (or 'guest').
First published in XenServer 4.0.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addTags
(Connection c, String value) Add the given value to the tags field of the given VM.void
addToBlockedOperations
(Connection c, Types.VmOperations key, String value) Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.addToBlockedOperationsAsync
(Connection c, Types.VmOperations key, String value) Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.void
addToHVMBootParams
(Connection c, String key, String value) Add the given key-value pair to the HVM/boot_params field of the given VM.void
addToNVRAM
(Connection c, String key, String value) Minimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.void
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VM.void
addToPlatform
(Connection c, String key, String value) Add the given key-value pair to the platform field of the given VM.void
addToVCPUsParams
(Connection c, String key, String value) Add the given key-value pair to the VCPUs/params field of the given VM.void
addToVCPUsParamsLive
(Connection c, String key, String value) Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.addToVCPUsParamsLiveAsync
(Connection c, String key, String value) Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.void
addToXenstoreData
(Connection c, String key, String value) Add the given key-value pair to the xenstore_data field of the given VM.void
Returns an error if the VM is not considered agile e.g.Returns an error if the VM is not considered agile e.g.void
assertCanBeRecovered
(Connection c, Session sessionTo) Assert whether all SRs required to recover this VM are available.assertCanBeRecoveredAsync
(Connection c, Session sessionTo) Assert whether all SRs required to recover this VM are available.void
assertCanBootHere
(Connection c, Host host) Returns an error if the VM could not boot on this host for some reason Minimum allowed role: read-only First published in XenServer 4.0.assertCanBootHereAsync
(Connection c, Host host) Returns an error if the VM could not boot on this host for some reason Minimum allowed role: read-only First published in XenServer 4.0.void
assertCanMigrate
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Assert whether a VM can be migrated to the specified destination.void
assertCanMigrate
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Assert whether a VM can be migrated to the specified destination.assertCanMigrateAsync
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Assert whether a VM can be migrated to the specified destination.assertCanMigrateAsync
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Assert whether a VM can be migrated to the specified destination.void
Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason Minimum allowed role: read-only First published in XenServer 4.0.Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason Minimum allowed role: read-only First published in XenServer 4.0.callPlugin
(Connection c, String plugin, String fn, Map<String, String> args) Call an API plugin on this vm Minimum allowed role: vm-operator First published in XenServer 6.5 SP1.callPluginAsync
(Connection c, String plugin, String fn, Map<String, String> args) Call an API plugin on this vm Minimum allowed role: vm-operator First published in XenServer 6.5 SP1.checkpoint
(Connection c, String newName) Checkpoints the specified VM, making a new VM.checkpointAsync
(Connection c, String newName) Checkpoints the specified VM, making a new VM.void
Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g.void
Attempt to cleanly shutdown the specified VM.Attempt to cleanly shutdown the specified VM.Computes the virtualization memory overhead of a VM.Computes the virtualization memory overhead of a VM.copy
(Connection c, String newName, SR sr) Copied the specified VM, making a new VM.copyAsync
(Connection c, String newName, SR sr) Copied the specified VM, making a new VM.void
copyBiosStrings
(Connection c, Host host) Copy the BIOS strings from the given host to this VM Minimum allowed role: vm-admin First published in XenServer 5.6.copyBiosStringsAsync
(Connection c, Host host) Copy the BIOS strings from the given host to this VM Minimum allowed role: vm-admin First published in XenServer 5.6.static VM
create
(Connection c, VM.Record record) NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations.static Task
createAsync
(Connection c, VM.Record record) NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations.createClone
(Connection c, String newName) Clones the specified VM, making a new VM.createCloneAsync
(Connection c, String newName) Clones the specified VM, making a new VM.createNewBlob
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.createNewBlob
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType) Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.createNewBlobAsync
(Connection c, String name, String mimeType, Boolean _public) Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.void
Destroy the specified VM.Destroy the specified VM.boolean
If obj is a VM, compares XenAPI references for equality.void
forgetDataSourceArchives
(Connection c, String dataSource) Forget the recorded statistics related to the specified data source Minimum allowed role: vm-admin First published in XenServer 5.0.Get the actions/after_crash field of the given VM.Get the actions/after_reboot field of the given VM.Get the actions/after_shutdown field of the given VM.Get the actions/after_softreboot field of the given VM.Get the affinity field of the given VM.getAll
(Connection c) Return a list of all the VMs known to the system.Get the allowed_operations field of the given VM.Returns a list of the allowed values that a VBD device field can take Minimum allowed role: read-only First published in XenServer 4.0.Returns a list of the allowed values that a VIF device field can take Minimum allowed role: read-only First published in XenServer 4.0.Return a map of VM references to VM records for all VMs known to the system.Get the appliance field of the given VM.Get the attached_PCIs field of the given VM.Get the bios_strings field of the given VM.Get the blobs field of the given VM.Get the blocked_operations field of the given VM.Deprecated.since XenServer 7.3getByNameLabel
(Connection c, String label) Get all the VM instances with the given label.static VM
getByUuid
(Connection c, String uuid) Get a reference to the VM instance with the specified UUID.Get the children field of the given VM.Get the consoles field of the given VM.Deprecated.since XenServer 6.1Deprecated.since XenServer 6.1Get the crash_dumps field of the given VM.Get the current_operations field of the given VM.Minimum allowed role: read-only First published in XenServer 5.0.Get the domain_type field of the given VM.Get the domarch field of the given VM.Get the domid field of the given VM.Get the generation_id field of the given VM.Get the groups field of the given VM.Get the guest_metrics field of the given VM.Deprecated.since XenServer 6.0Get the hardware_platform_version field of the given VM.Get the ha_restart_priority field of the given VM.Get the has_vendor_device field of the given VM.Get the HVM/boot_params field of the given VM.Deprecated.since XenServer 7.5Get the HVM/shadow_multiplier field of the given VM.Get the is_a_snapshot field of the given VM.Get the is_a_template field of the given VM.Get the is_control_domain field of the given VM.Get the is_default_template field of the given VM.Deprecated.since XenServer 6.2Get the is_vmss_snapshot field of the given VM.Get the last_boot_CPU_flags field of the given VM.Get the last_booted_record field of the given VM.Get the memory/dynamic_max field of the given VM.Get the memory/dynamic_min field of the given VM.Get the memory/overhead field of the given VM.Get the memory/static_max field of the given VM.Get the memory/static_min field of the given VM.Deprecated.since XenServer 5.6Get the metrics field of the given VM.Get the name/description field of the given VM.Get the name/label field of the given VM.Get the NVRAM field of the given VM.Get the order field of the given VM.Get the other_config field of the given VM.Get the parent field of the given VM.Deprecated.since XenServer 6.0Get the pending_guidances field of the given VM.Get the pending_guidances_full field of the given VM.Get the pending_guidances_recommended field of the given VM.Get the platform field of the given VM.Return the list of hosts on which this VM may run.Return the list of hosts on which this VM may run.Get the power_state field of the given VM.Deprecated.since XenServer 6.2Get the PV/args field of the given VM.Get the PV/bootloader field of the given VM.Get the PV/bootloader_args field of the given VM.Get the PV/kernel field of the given VM.Get the PV/legacy_args field of the given VM.Get the PV/ramdisk field of the given VM.Get the recommendations field of the given VM.Get a record containing the current state of the given VM.Get the reference_label field of the given VM.Get the requires_reboot field of the given VM.Get the resident_on field of the given VM.Get the scheduled_to_be_resident_on field of the given VM.Return the secureboot readiness of the VM Minimum allowed role: pool-admin Experimental.Return the secureboot readiness of the VM Minimum allowed role: pool-admin Experimental.Get the shutdown_delay field of the given VM.Get the snapshot_info field of the given VM.Get the snapshot_metadata field of the given VM.Get the snapshot_of field of the given VM.Get the snapshots field of the given VM.Get the snapshot_schedule field of the given VM.Get the snapshot_time field of the given VM.getSRsRequiredForRecovery
(Connection c, Session sessionTo) List all the SR's that are required for the VM to be recovered Minimum allowed role: read-only First published in XenServer 6.5.getSRsRequiredForRecoveryAsync
(Connection c, Session sessionTo) List all the SR's that are required for the VM to be recovered Minimum allowed role: read-only First published in XenServer 6.5.Get the start_delay field of the given VM.Get the suspend_SR field of the given VM.Get the suspend_VDI field of the given VM.Get the tags field of the given VM.Get the transportable_snapshot_id field of the given VM.Get the user_version field of the given VM.Get the uuid field of the given VM.Get the VBDs field of the given VM.Get the VCPUs/at_startup field of the given VM.Get the VCPUs/max field of the given VM.Get the VCPUs/params field of the given VM.Get the version field of the given VM.Get the VGPUs field of the given VM.Get the VIFs field of the given VM.Get the VTPMs field of the given VM.Get the VUSBs field of the given VM.Get the xenstore_data field of the given VM.void
Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM.void
Stop executing the specified VM without attempting a clean shutdown.Stop executing the specified VM without attempting a clean shutdown.int
hashCode()
Import an XVA from a URI Minimum allowed role: pool-operator First published in XenServer 7.0.static Task
import_Async
(Connection c, String url, SR sr, Boolean fullRestore, Boolean force) Import an XVA from a URI Minimum allowed role: pool-operator First published in XenServer 7.0.static void
import_Convert
(Connection c, String type, String username, String password, SR sr, Map<String, String> remoteConfig) Import using a conversion service.static Task
import_ConvertAsync
(Connection c, String type, String username, String password, SR sr, Map<String, String> remoteConfig) Import using a conversion service.maximiseMemory
(Connection c, Long total, Boolean approximate) Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory.maximiseMemoryAsync
(Connection c, Long total, Boolean approximate) Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory.migrateSend
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Migrate the VM to another host.migrateSend
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Migrate the VM to another host.migrateSendAsync
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Migrate the VM to another host.migrateSendAsync
(Connection c, Map<String, String> dest, Boolean live, Map<VDI, SR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Migrate the VM to another host.void
pause
(Connection c) Pause the specified VM.Pause the specified VM.void
poolMigrate
(Connection c, Host host, Map<String, String> options) Migrate a VM to another Host.poolMigrateAsync
(Connection c, Host host, Map<String, String> options) Migrate a VM to another Host.void
Reset the power-state of the VM to halted in the database only.Reset the power-state of the VM to halted in the database only.void
Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script.queryDataSource
(Connection c, String dataSource) Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 5.0.Query the system services advertised by this VM and register them.Query the system services advertised by this VM and register them.void
recordDataSource
(Connection c, String dataSource) Start recording the specified data source Minimum allowed role: vm-admin First published in XenServer 5.0.void
recover
(Connection c, Session sessionTo, Boolean force) Recover the VM Minimum allowed role: read-only First published in XenServer 6.0.recoverAsync
(Connection c, Session sessionTo, Boolean force) Recover the VM Minimum allowed role: read-only First published in XenServer 6.0.void
Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.void
removeFromHVMBootParams
(Connection c, String key) Remove the given key and its corresponding value from the HVM/boot_params field of the given VM.void
removeFromNVRAM
(Connection c, String key) Minimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VM.void
removeFromPlatform
(Connection c, String key) Remove the given key and its corresponding value from the platform field of the given VM.void
removeFromVCPUsParams
(Connection c, String key) Remove the given key and its corresponding value from the VCPUs/params field of the given VM.void
removeFromXenstoreData
(Connection c, String key) Remove the given key and its corresponding value from the xenstore_data field of the given VM.void
removeTags
(Connection c, String value) Remove the given value from the tags field of the given VM.void
Restart device models of the VM Minimum allowed role: vm-power-admin Experimental.Restart device models of the VM Minimum allowed role: vm-power-admin Experimental.void
resume
(Connection c, Boolean startPaused, Boolean force) Awaken the specified VM and resume it.resumeAsync
(Connection c, Boolean startPaused, Boolean force) Awaken the specified VM and resume it.void
resumeOn
(Connection c, Host host, Boolean startPaused, Boolean force) Awaken the specified VM and resume it on a particular Host.resumeOnAsync
(Connection c, Host host, Boolean startPaused, Boolean force) Awaken the specified VM and resume it on a particular Host.Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb.Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb.void
revert
(Connection c) Reverts the specified VM to a previous state.Reverts the specified VM to a previous state.void
sendSysrq
(Connection c, String key) Send the given key as a sysrq to this VM.sendSysrqAsync
(Connection c, String key) Send the given key as a sysrq to this VM.void
sendTrigger
(Connection c, String trigger) Send the named trigger to this VM.sendTriggerAsync
(Connection c, String trigger) Send the named trigger to this VM.void
Sets the actions_after_crash parameter Minimum allowed role: vm-admin First published in XenServer 4.0.Sets the actions_after_crash parameter Minimum allowed role: vm-admin First published in XenServer 4.0.void
setActionsAfterReboot
(Connection c, Types.OnNormalExit afterReboot) Set the actions/after_reboot field of the given VM.void
setActionsAfterShutdown
(Connection c, Types.OnNormalExit afterShutdown) Set the actions/after_shutdown field of the given VM.void
setActionsAfterSoftreboot
(Connection c, Types.OnSoftrebootBehavior afterSoftreboot) Set the actions/after_softreboot field of the given VM.void
setAffinity
(Connection c, Host affinity) Set the affinity field of the given VM.void
setAppliance
(Connection c, VMAppliance value) Assign this VM to an appliance.setApplianceAsync
(Connection c, VMAppliance value) Assign this VM to an appliance.void
setBiosStrings
(Connection c, Map<String, String> value) Set custom BIOS strings to this VM.setBiosStringsAsync
(Connection c, Map<String, String> value) Set custom BIOS strings to this VM.void
setBlockedOperations
(Connection c, Map<Types.VmOperations, String> value) Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.void
setDomainType
(Connection c, Types.DomainType value) Set the VM.domain_type field of the given VM, which will take effect when it is next started Minimum allowed role: vm-admin First published in XenServer 7.5.void
setGroups
(Connection c, Set<VMGroup> value) Associate this VM with VM groups.setGroupsAsync
(Connection c, Set<VMGroup> value) Associate this VM with VM groups.void
setHaAlwaysRun
(Connection c, Boolean value) Deprecated.since XenServer 6.0void
setHardwarePlatformVersion
(Connection c, Long hardwarePlatformVersion) Set the hardware_platform_version field of the given VM.void
setHaRestartPriority
(Connection c, String value) Set the value of the ha_restart_priority field Minimum allowed role: pool-operator First published in XenServer 5.0.void
setHasVendorDevice
(Connection c, Boolean value) Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update.setHasVendorDeviceAsync
(Connection c, Boolean value) Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update.void
setHVMBootParams
(Connection c, Map<String, String> bootParams) Set the HVM/boot_params field of the given VM.void
setHVMBootPolicy
(Connection c, String value) Deprecated.since XenServer 7.5void
setHVMShadowMultiplier
(Connection c, Double value) Set the shadow memory multiplier on a halted VM Minimum allowed role: vm-power-admin First published in XenServer 5.6.void
setIsATemplate
(Connection c, Boolean isATemplate) Set the is_a_template field of the given VM.void
setMemory
(Connection c, Long value) Set the memory allocation of this VM.setMemoryAsync
(Connection c, Long value) Set the memory allocation of this VM.void
setMemoryDynamicMax
(Connection c, Long value) Set the value of the memory_dynamic_max field Minimum allowed role: vm-power-admin First published in XenServer 5.6.void
setMemoryDynamicMin
(Connection c, Long value) Set the value of the memory_dynamic_min field Minimum allowed role: vm-power-admin First published in XenServer 5.6.void
setMemoryDynamicRange
(Connection c, Long min, Long max) Set the minimum and maximum amounts of physical memory the VM is allowed to use.setMemoryDynamicRangeAsync
(Connection c, Long min, Long max) Set the minimum and maximum amounts of physical memory the VM is allowed to use.void
setMemoryLimits
(Connection c, Long staticMin, Long staticMax, Long dynamicMin, Long dynamicMax) Set the memory limits of this VM.setMemoryLimitsAsync
(Connection c, Long staticMin, Long staticMax, Long dynamicMin, Long dynamicMax) Set the memory limits of this VM.void
setMemoryStaticMax
(Connection c, Long value) Set the value of the memory_static_max field Minimum allowed role: vm-power-admin First published in XenServer 5.0.void
setMemoryStaticMin
(Connection c, Long value) Set the value of the memory_static_min field Minimum allowed role: vm-power-admin First published in XenServer 5.6.void
setMemoryStaticRange
(Connection c, Long min, Long max) Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.setMemoryStaticRangeAsync
(Connection c, Long min, Long max) Set the static (ie boot-time) range of virtual memory that the VM is allowed to use.void
setMemoryTargetLive
(Connection c, Long target) Deprecated.since XenServer 5.6setMemoryTargetLiveAsync
(Connection c, Long target) Deprecated.since XenServer 5.6void
setNameDescription
(Connection c, String description) Set the name/description field of the given VM.void
setNameLabel
(Connection c, String label) Set the name/label field of the given VM.void
setNVRAM
(Connection c, Map<String, String> value) Minimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.void
setOrder
(Connection c, Long value) Set this VM's boot order Minimum allowed role: pool-operator First published in XenServer 6.0.setOrderAsync
(Connection c, Long value) Set this VM's boot order Minimum allowed role: pool-operator First published in XenServer 6.0.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given VM.void
setPCIBus
(Connection c, String PCIBus) Deprecated.since XenServer 6.0void
setPlatform
(Connection c, Map<String, String> platform) Set the platform field of the given VM.void
setProtectionPolicy
(Connection c, VMPP value) Deprecated.since XenServer 6.2void
setPVArgs
(Connection c, String args) Set the PV/args field of the given VM.void
setPVBootloader
(Connection c, String bootloader) Set the PV/bootloader field of the given VM.void
setPVBootloaderArgs
(Connection c, String bootloaderArgs) Set the PV/bootloader_args field of the given VM.void
setPVKernel
(Connection c, String kernel) Set the PV/kernel field of the given VM.void
setPVLegacyArgs
(Connection c, String legacyArgs) Set the PV/legacy_args field of the given VM.void
setPVRamdisk
(Connection c, String ramdisk) Set the PV/ramdisk field of the given VM.void
setRecommendations
(Connection c, String recommendations) Set the recommendations field of the given VM.void
setShadowMultiplierLive
(Connection c, Double multiplier) Set the shadow memory multiplier on a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.setShadowMultiplierLiveAsync
(Connection c, Double multiplier) Set the shadow memory multiplier on a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.void
setShutdownDelay
(Connection c, Long value) Set this VM's shutdown delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.setShutdownDelayAsync
(Connection c, Long value) Set this VM's shutdown delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.void
setSnapshotSchedule
(Connection c, VMSS value) Set the value of the snapshot schedule field Minimum allowed role: pool-operator First published in XenServer 7.2.void
setStartDelay
(Connection c, Long value) Set this VM's start delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.setStartDelayAsync
(Connection c, Long value) Set this VM's start delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.void
setSuspendSR
(Connection c, SR suspendSR) Set the suspend_SR field of the given VM.void
setSuspendVDI
(Connection c, VDI value) Set this VM's suspend VDI, which must be indentical to its current one Minimum allowed role: pool-operator First published in XenServer 6.0.setSuspendVDIAsync
(Connection c, VDI value) Set this VM's suspend VDI, which must be indentical to its current one Minimum allowed role: pool-operator First published in XenServer 6.0.void
setTags
(Connection c, Set<String> tags) Set the tags field of the given VM.setUefiMode
(Connection c, Types.VmUefiMode mode) Set the UEFI mode of a VM Minimum allowed role: pool-admin Experimental.setUefiModeAsync
(Connection c, Types.VmUefiMode mode) Set the UEFI mode of a VM Minimum allowed role: pool-admin Experimental.void
setUserVersion
(Connection c, Long userVersion) Set the user_version field of the given VM.void
setVCPUsAtStartup
(Connection c, Long value) Set the number of startup VCPUs for a halted VM Minimum allowed role: vm-admin First published in XenServer 5.6.void
setVCPUsMax
(Connection c, Long value) Set the maximum number of VCPUs for a halted VM Minimum allowed role: vm-admin First published in XenServer 5.6.void
setVCPUsNumberLive
(Connection c, Long nvcpu) Set the number of VCPUs for a running VM Minimum allowed role: vm-admin First published in XenServer 4.0.setVCPUsNumberLiveAsync
(Connection c, Long nvcpu) Set the number of VCPUs for a running VM Minimum allowed role: vm-admin First published in XenServer 4.0.void
setVCPUsParams
(Connection c, Map<String, String> params) Set the VCPUs/params field of the given VM.void
setXenstoreData
(Connection c, Map<String, String> xenstoreData) Set the xenstore_data field of the given VM.void
Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it.snapshot
(Connection c, String newName) Snapshots the specified VM, making a new VM.snapshot
(Connection c, String newName, Set<VDI> ignoreVdis) Snapshots the specified VM, making a new VM.snapshotAsync
(Connection c, String newName) Snapshots the specified VM, making a new VM.snapshotAsync
(Connection c, String newName, Set<VDI> ignoreVdis) Snapshots the specified VM, making a new VM.snapshotWithQuiesce
(Connection c, String newName) Deprecated.since Citrix Hypervisor 8.1snapshotWithQuiesceAsync
(Connection c, String newName) Deprecated.since Citrix Hypervisor 8.1void
start
(Connection c, Boolean startPaused, Boolean force) Start the specified VM.startAsync
(Connection c, Boolean startPaused, Boolean force) Start the specified VM.void
startOn
(Connection c, Host host, Boolean startPaused, Boolean force) Start the specified VM on a particular host.startOnAsync
(Connection c, Host host, Boolean startPaused, Boolean force) Start the specified VM on a particular host.void
Suspend the specified VM to disk.Suspend the specified VM to disk.void
Resume the specified VM.Resume the specified VM.void
Recomputes the list of acceptable operations Minimum allowed role: pool-admin First published in XenServer 4.0.Recomputes the list of acceptable operations Minimum allowed role: pool-admin First published in XenServer 4.0.void
Deprecated.since XenServer 5.6Deprecated.since XenServer 5.6Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VM, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public VM.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static VM getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the VM instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
create
public static VM create(Connection c, VM.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- reference to the newly created object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createAsync
public static Task createAsync(Connection c, VM.Record record) throws Types.BadServerResponse, Types.XenAPIException, IOException NOT RECOMMENDED! VM.clone or VM.copy (or VM.import) is a better choice in almost all situations. The standard way to obtain a new VM is to call VM.clone on a template VM, then call VM.provision on the new clone. Caution: if VM.create is used and then the new VM is attached to a virtual disc that has an operating system already installed, then there is no guarantee that the operating system will boot and run. Any software that calls VM.create on a future version of this API may fail or give unexpected results. For example this could happen if an additional parameter were added to VM.create. VM.create is intended only for use in the automatic creation of the system VM templates. It creates a new VM instance, and returns its handle. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecord
- All constructor arguments- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Destroy the specified VM. The VM is completely removed from the system. This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByNameLabel
public static Set<VM> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Get all the VM instances with the given label. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlabel
- label of object to return- Returns:
- references to objects with matching names
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedOperations
public Set<Types.VmOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCurrentOperations
public Map<String,Types.VmOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameLabel
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/label field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNameDescription
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name/description field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPowerState
public Types.VmPowerState getPowerState(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the power_state field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUserVersion
public Long getUserVersion(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the user_version field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsATemplate
public Boolean getIsATemplate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_a_template field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsDefaultTemplate
public Boolean getIsDefaultTemplate(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_default_template field of the given VM. Minimum allowed role: read-only First published in XenServer 7.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSuspendVDI
public VDI getSuspendVDI(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the suspend_VDI field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getResidentOn
public Host getResidentOn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the resident_on field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getScheduledToBeResidentOn
public Host getScheduledToBeResidentOn(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the scheduled_to_be_resident_on field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAffinity
public Host getAffinity(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the affinity field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryOverhead
public Long getMemoryOverhead(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/overhead field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryTarget
@Deprecated(since="XenServer 5.6") public Long getMemoryTarget(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.6Get the memory/target field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryStaticMax
public Long getMemoryStaticMax(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/static_max field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryDynamicMax
public Long getMemoryDynamicMax(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/dynamic_max field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryDynamicMin
public Long getMemoryDynamicMin(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/dynamic_min field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMemoryStaticMin
public Long getMemoryStaticMin(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the memory/static_min field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVCPUsParams
public Map<String,String> getVCPUsParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VCPUs/params field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVCPUsMax
public Long getVCPUsMax(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VCPUs/max field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVCPUsAtStartup
public Long getVCPUsAtStartup(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VCPUs/at_startup field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getActionsAfterSoftreboot
public Types.OnSoftrebootBehavior getActionsAfterSoftreboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the actions/after_softreboot field of the given VM. Minimum allowed role: read-only Experimental. First published in 23.1.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getActionsAfterShutdown
public Types.OnNormalExit getActionsAfterShutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the actions/after_shutdown field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getActionsAfterReboot
public Types.OnNormalExit getActionsAfterReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the actions/after_reboot field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getActionsAfterCrash
public Types.OnCrashBehaviour getActionsAfterCrash(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the actions/after_crash field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getConsoles
public Set<Console> getConsoles(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the consoles field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVIFs
public Set<VIF> getVIFs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VIFs field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVBDs
public Set<VBD> getVBDs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VBDs field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVUSBs
public Set<VUSB> getVUSBs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VUSBs field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCrashDumps
public Set<Crashdump> getCrashDumps(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the crash_dumps field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVTPMs
public Set<VTPM> getVTPMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VTPMs field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVBootloader
public String getPVBootloader(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/bootloader field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVKernel
public String getPVKernel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/kernel field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVRamdisk
public String getPVRamdisk(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/ramdisk field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVArgs
public String getPVArgs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/args field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVBootloaderArgs
public String getPVBootloaderArgs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/bootloader_args field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPVLegacyArgs
public String getPVLegacyArgs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the PV/legacy_args field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHVMBootPolicy
@Deprecated(since="XenServer 7.5") public String getHVMBootPolicy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.5Get the HVM/boot_policy field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHVMBootParams
public Map<String,String> getHVMBootParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the HVM/boot_params field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHVMShadowMultiplier
public Double getHVMShadowMultiplier(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the HVM/shadow_multiplier field of the given VM. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPlatform
public Map<String,String> getPlatform(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the platform field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPCIBus
@Deprecated(since="XenServer 6.0") public String getPCIBus(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.0Get the PCI_bus field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOtherConfig
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the other_config field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDomid
public Long getDomid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the domid field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDomarch
public String getDomarch(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the domarch field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLastBootCPUFlags
public Map<String,String> getLastBootCPUFlags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_boot_CPU_flags field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsControlDomain
public Boolean getIsControlDomain(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_control_domain field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getMetrics
public VMMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the metrics field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGuestMetrics
public VMGuestMetrics getGuestMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the guest_metrics field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getLastBootedRecord
public String getLastBootedRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the last_booted_record field of the given VM. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRecommendations
public String getRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the recommendations field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getXenstoreData
public Map<String,String> getXenstoreData(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the xenstore_data field of the given VM. Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaAlwaysRun
@Deprecated(since="XenServer 6.0") public Boolean getHaAlwaysRun(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.0Get the ha_always_run field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHaRestartPriority
public String getHaRestartPriority(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the ha_restart_priority field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsASnapshot
public Boolean getIsASnapshot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_a_snapshot field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotOf
public VM getSnapshotOf(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_of field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshots
public Set<VM> getSnapshots(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshots field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotTime
public Date getSnapshotTime(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_time field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTransportableSnapshotId
public String getTransportableSnapshotId(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the transportable_snapshot_id field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBlobs
public Map<String,Blob> getBlobs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the blobs field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getTags
public Set<String> getTags(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the tags field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBlockedOperations
public Map<Types.VmOperations,String> getBlockedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the blocked_operations field of the given VM. Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotInfo
public Map<String,String> getSnapshotInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_info field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotMetadata
public String getSnapshotMetadata(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_metadata field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getParent
public VM getParent(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the parent field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getChildren
public Set<VM> getChildren(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the children field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getBiosStrings
public Map<String,String> getBiosStrings(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the bios_strings field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getProtectionPolicy
@Deprecated(since="XenServer 6.2") public VMPP getProtectionPolicy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the protection_policy field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsSnapshotFromVmpp
@Deprecated(since="XenServer 6.2") public Boolean getIsSnapshotFromVmpp(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Get the is_snapshot_from_vmpp field of the given VM. Minimum allowed role: read-only First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSnapshotSchedule
public VMSS getSnapshotSchedule(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the snapshot_schedule field of the given VM. Minimum allowed role: read-only First published in XenServer 7.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getIsVmssSnapshot
public Boolean getIsVmssSnapshot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the is_vmss_snapshot field of the given VM. Minimum allowed role: read-only First published in XenServer 7.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAppliance
public VMAppliance getAppliance(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the appliance field of the given VM. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getStartDelay
public Long getStartDelay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the start_delay field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getShutdownDelay
public Long getShutdownDelay(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the shutdown_delay field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getOrder
public Long getOrder(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the order field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVGPUs
public Set<VGPU> getVGPUs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the VGPUs field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAttachedPCIs
public Set<PCI> getAttachedPCIs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the attached_PCIs field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSuspendSR
public SR getSuspendSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the suspend_SR field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVersion
public Long getVersion(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the version field of the given VM. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGenerationId
public String getGenerationId(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the generation_id field of the given VM. Minimum allowed role: read-only First published in XenServer 6.2.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHardwarePlatformVersion
public Long getHardwarePlatformVersion(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the hardware_platform_version field of the given VM. Minimum allowed role: read-only First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHasVendorDevice
public Boolean getHasVendorDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the has_vendor_device field of the given VM. Minimum allowed role: read-only First published in XenServer 7.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getRequiresReboot
public Boolean getRequiresReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the requires_reboot field of the given VM. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getReferenceLabel
public String getReferenceLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the reference_label field of the given VM. Minimum allowed role: read-only First published in XenServer 7.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDomainType
public Types.DomainType getDomainType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the domain_type field of the given VM. Minimum allowed role: read-only First published in XenServer 7.5.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getNVRAM
public Map<String,String> getNVRAM(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the NVRAM field of the given VM. Minimum allowed role: read-only First published in Citrix Hypervisor 8.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPendingGuidances
public Set<Types.UpdateGuidances> getPendingGuidances(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances field of the given VM. Minimum allowed role: read-only First published in 1.303.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPendingGuidancesRecommended
public Set<Types.UpdateGuidances> getPendingGuidancesRecommended(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances_recommended field of the given VM. Minimum allowed role: read-only Experimental. First published in 24.10.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPendingGuidancesFull
public Set<Types.UpdateGuidances> getPendingGuidancesFull(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the pending_guidances_full field of the given VM. Minimum allowed role: read-only Experimental. First published in 24.10.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getGroups
public Set<VMGroup> getGroups(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the groups field of the given VM. Minimum allowed role: read-only Experimental. First published in 24.19.1.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameLabel
public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/label field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlabel
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNameDescription
public void setNameDescription(Connection c, String description) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the name/description field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ondescription
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUserVersion
public void setUserVersion(Connection c, Long userVersion) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the user_version field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onuserVersion
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setIsATemplate
public void setIsATemplate(Connection c, Boolean isATemplate) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the is_a_template field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onisATemplate
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setAffinity
public void setAffinity(Connection c, Host affinity) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the affinity field of the given VM. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onaffinity
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setVCPUsParams
public void setVCPUsParams(Connection c, Map<String, String> params) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the VCPUs/params field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onparams
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToVCPUsParams
public void addToVCPUsParams(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the VCPUs/params field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromVCPUsParams
public void removeFromVCPUsParams(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the VCPUs/params field of the given VM. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setActionsAfterSoftreboot
public void setActionsAfterSoftreboot(Connection c, Types.OnSoftrebootBehavior afterSoftreboot) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the actions/after_softreboot field of the given VM. Minimum allowed role: vm-admin Experimental. First published in 23.1.0.- Parameters:
c
- The connection the call is made onafterSoftreboot
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setActionsAfterShutdown
public void setActionsAfterShutdown(Connection c, Types.OnNormalExit afterShutdown) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the actions/after_shutdown field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onafterShutdown
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setActionsAfterReboot
public void setActionsAfterReboot(Connection c, Types.OnNormalExit afterReboot) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the actions/after_reboot field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onafterReboot
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVBootloader
public void setPVBootloader(Connection c, String bootloader) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/bootloader field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onbootloader
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVKernel
public void setPVKernel(Connection c, String kernel) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/kernel field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkernel
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVRamdisk
public void setPVRamdisk(Connection c, String ramdisk) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/ramdisk field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onramdisk
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVArgs
public void setPVArgs(Connection c, String args) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/args field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onargs
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVBootloaderArgs
public void setPVBootloaderArgs(Connection c, String bootloaderArgs) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/bootloader_args field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onbootloaderArgs
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPVLegacyArgs
public void setPVLegacyArgs(Connection c, String legacyArgs) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the PV/legacy_args field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onlegacyArgs
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHVMBootParams
public void setHVMBootParams(Connection c, Map<String, String> bootParams) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the HVM/boot_params field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onbootParams
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToHVMBootParams
public void addToHVMBootParams(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the HVM/boot_params field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromHVMBootParams
public void removeFromHVMBootParams(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the HVM/boot_params field of the given VM. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPlatform
public void setPlatform(Connection c, Map<String, String> platform) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the platform field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onplatform
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToPlatform
public void addToPlatform(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the platform field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromPlatform
public void removeFromPlatform(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the platform field of the given VM. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setPCIBus
@Deprecated(since="XenServer 6.0") public void setPCIBus(Connection c, String PCIBus) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.0Set the PCI_bus field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onPCIBus
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onotherConfig
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToOtherConfig
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the other_config field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromOtherConfig
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the other_config field of the given VM. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setRecommendations
public void setRecommendations(Connection c, String recommendations) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the recommendations field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onrecommendations
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setXenstoreData
public void setXenstoreData(Connection c, Map<String, String> xenstoreData) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the xenstore_data field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onxenstoreData
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToXenstoreData
public void addToXenstoreData(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to the xenstore_data field of the given VM. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- Value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromXenstoreData
public void removeFromXenstoreData(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given key and its corresponding value from the xenstore_data field of the given VM. If the key is not in that Map, then do nothing. Minimum allowed role: vm-admin First published in XenServer 4.1.- Parameters:
c
- The connection the call is made onkey
- Key to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setTags
public void setTags(Connection c, Set<String> tags) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the tags field of the given VM. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ontags
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addTags
public void addTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given value to the tags field of the given VM. If the value is already in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- New value to add- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeTags
public void removeTags(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Remove the given value from the tags field of the given VM. If the value is not in that Set, then do nothing. Minimum allowed role: vm-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- Value to remove- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSuspendSR
public void setSuspendSR(Connection c, SR suspendSR) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the suspend_SR field of the given VM. Minimum allowed role: vm-admin First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onsuspendSR
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHardwarePlatformVersion
public void setHardwarePlatformVersion(Connection c, Long hardwarePlatformVersion) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the hardware_platform_version field of the given VM. Minimum allowed role: vm-admin First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made onhardwarePlatformVersion
- New value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
snapshot
public VM snapshot(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VM- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.
-
snapshot
public VM snapshot(Connection c, String newName, Set<VDI> ignoreVdis) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VMignoreVdis
- A list of VDIs to ignore for the snapshot First published in 21.4.0.- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.
-
snapshotAsync
public Task snapshotAsync(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VM- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.
-
snapshotAsync
public Task snapshotAsync(Connection c, String newName, Set<VDI> ignoreVdis) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed Snapshots the specified VM, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VMignoreVdis
- A list of VDIs to ignore for the snapshot First published in 21.4.0.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.
-
snapshotWithQuiesce
@Deprecated(since="Citrix Hypervisor 8.1") public VM snapshotWithQuiesce(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.VmSnapshotWithQuiesceFailed, Types.VmSnapshotWithQuiesceTimeout, Types.VmSnapshotWithQuiescePluginDeosNotRespond, Types.VmSnapshotWithQuiesceNotSupported Deprecated.since Citrix Hypervisor 8.1Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VM- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmSnapshotWithQuiesceFailed
- The quiesced-snapshot operation failed for an unexpected reasonTypes.VmSnapshotWithQuiesceTimeout
- The VSS plug-in has timed outTypes.VmSnapshotWithQuiescePluginDeosNotRespond
- The VSS plug-in cannot be contactedTypes.VmSnapshotWithQuiesceNotSupported
- The VSS plug-in is not installed on this virtual machine
-
snapshotWithQuiesceAsync
@Deprecated(since="Citrix Hypervisor 8.1") public Task snapshotWithQuiesceAsync(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.VmSnapshotWithQuiesceFailed, Types.VmSnapshotWithQuiesceTimeout, Types.VmSnapshotWithQuiescePluginDeosNotRespond, Types.VmSnapshotWithQuiesceNotSupported Deprecated.since Citrix Hypervisor 8.1Snapshots the specified VM with quiesce, making a new VM. Snapshot automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the snapshotted VM- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmSnapshotWithQuiesceFailed
- The quiesced-snapshot operation failed for an unexpected reasonTypes.VmSnapshotWithQuiesceTimeout
- The VSS plug-in has timed outTypes.VmSnapshotWithQuiescePluginDeosNotRespond
- The VSS plug-in cannot be contactedTypes.VmSnapshotWithQuiesceNotSupported
- The VSS plug-in is not installed on this virtual machine
-
createClone
public VM createClone(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the cloned VM- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
createCloneAsync
public Task createCloneAsync(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Clones the specified VM, making a new VM. Clone automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write). This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the cloned VM- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
copy
public VM copy(Connection c, String newName, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the copied VMsr
- An SR to copy all the VM's disks into (if an invalid reference then it uses the existing SRs)- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
copyAsync
public Task copyAsync(Connection c, String newName, SR sr) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Copied the specified VM, making a new VM. Unlike clone, copy does not exploits the capabilities of the underlying storage repository in which the VM's disk images are stored. Instead, copy guarantees that the disk images of the newly created VM will be 'full disks' - i.e. not part of a CoW chain. This function can only be called when the VM is in the Halted State. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnewName
- The name of the copied VMsr
- An SR to copy all the VM's disks into (if an invalid reference then it uses the existing SRs)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
revert
public void revert(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.SrFull, Types.VmRevertFailed Reverts the specified VM to a previous state. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.VmRevertFailed
- An error occured while reverting the specified virtual machine to the specified snapshot
-
revertAsync
public Task revertAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.SrFull, Types.VmRevertFailed Reverts the specified VM to a previous state. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.VmRevertFailed
- An error occured while reverting the specified virtual machine to the specified snapshot
-
checkpoint
public VM checkpoint(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.VmCheckpointSuspendFailed, Types.VmCheckpointResumeFailed Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onnewName
- The name of the checkpointed VM- Returns:
- The reference of the newly created VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmCheckpointSuspendFailed
- An error occured while saving the memory image of the specified virtual machineTypes.VmCheckpointResumeFailed
- An error occured while restoring the memory image of the specified virtual machine
-
checkpointAsync
public Task checkpointAsync(Connection c, String newName) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.VmCheckpointSuspendFailed, Types.VmCheckpointResumeFailed Checkpoints the specified VM, making a new VM. Checkpoint automatically exploits the capabilities of the underlying storage repository in which the VM's disk images are stored (e.g. Copy on Write) and saves the memory image as well. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onnewName
- The name of the checkpointed VM- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmCheckpointSuspendFailed
- An error occured while saving the memory image of the specified virtual machineTypes.VmCheckpointResumeFailed
- An error occured while restoring the memory image of the specified virtual machine
-
provision
public void provision(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
provisionAsync
public Task provisionAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.SrFull, Types.OperationNotAllowed, Types.LicenceRestriction Inspects the disk configuration contained within the VM's other_config, creates VDIs and VBDs and then executes any applicable post-install script. Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.SrFull
- The SR is full. Requested new size exceeds the maximum sizeTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
start
public void start(Connection c, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.VmHvmRequired, Types.VmIsTemplate, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.BootloaderFailed, Types.UnknownBootloader, Types.NoHostsAvailable, Types.LicenceRestriction Start the specified VM. This function can only be called with the VM is in the Halted State. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onstartPaused
- Instantiate VM in paused state if set to true.force
- Attempt to force the VM to start. If this flag is false then the VM may fail pre-boot safety checks (e.g. if the CPU the VM last booted on looks substantially different to the current one)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.VmHvmRequired
- HVM is required for this operationTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.BootloaderFailed
- The bootloader returned an errorTypes.UnknownBootloader
- The requested bootloader is unknownTypes.NoHostsAvailable
- There were no servers available to complete the specified operation.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
startAsync
public Task startAsync(Connection c, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.VmHvmRequired, Types.VmIsTemplate, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.BootloaderFailed, Types.UnknownBootloader, Types.NoHostsAvailable, Types.LicenceRestriction Start the specified VM. This function can only be called with the VM is in the Halted State. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onstartPaused
- Instantiate VM in paused state if set to true.force
- Attempt to force the VM to start. If this flag is false then the VM may fail pre-boot safety checks (e.g. if the CPU the VM last booted on looks substantially different to the current one)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.VmHvmRequired
- HVM is required for this operationTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.BootloaderFailed
- The bootloader returned an errorTypes.UnknownBootloader
- The requested bootloader is unknownTypes.NoHostsAvailable
- There were no servers available to complete the specified operation.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
startOn
public void startOn(Connection c, Host host, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.VmIsTemplate, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.BootloaderFailed, Types.UnknownBootloader Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The Host on which to start the VMstartPaused
- Instantiate VM in paused state if set to true.force
- Attempt to force the VM to start. If this flag is false then the VM may fail pre-boot safety checks (e.g. if the CPU the VM last booted on looks substantially different to the current one)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.BootloaderFailed
- The bootloader returned an errorTypes.UnknownBootloader
- The requested bootloader is unknown
-
startOnAsync
public Task startOnAsync(Connection c, Host host, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.VmIsTemplate, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.BootloaderFailed, Types.UnknownBootloader Start the specified VM on a particular host. This function can only be called with the VM is in the Halted State. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The Host on which to start the VMstartPaused
- Instantiate VM in paused state if set to true.force
- Attempt to force the VM to start. If this flag is false then the VM may fail pre-boot safety checks (e.g. if the CPU the VM last booted on looks substantially different to the current one)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.BootloaderFailed
- The bootloader returned an errorTypes.UnknownBootloader
- The requested bootloader is unknown
-
pause
public void pause(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Pause the specified VM. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
pauseAsync
public Task pauseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Pause the specified VM. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
unpause
public void unpause(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Resume the specified VM. This can only be called when the specified VM is in the Paused state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
unpauseAsync
public Task unpauseAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Resume the specified VM. This can only be called when the specified VM is in the Paused state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
cleanShutdown
public void cleanShutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
cleanShutdownAsync
public Task cleanShutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
shutdown
public void shutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it. Minimum allowed role: vm-operator First published in XenServer 6.2.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
shutdownAsync
public Task shutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempts to first clean shutdown a VM and if it should fail then perform a hard shutdown on it. Minimum allowed role: vm-operator First published in XenServer 6.2.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
cleanReboot
public void cleanReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
cleanRebootAsync
public Task cleanRebootAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Attempt to cleanly shutdown the specified VM (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
hardShutdown
public void hardShutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Stop executing the specified VM without attempting a clean shutdown. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
hardShutdownAsync
public Task hardShutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Stop executing the specified VM without attempting a clean shutdown. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
powerStateReset
public void powerStateReset(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
powerStateResetAsync
public Task powerStateResetAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Reset the power-state of the VM to halted in the database only. (Used to recover from slave failures in pooling scenarios by resetting the power-states of VMs running on dead slaves to halted.) This is a potentially dangerous operation; use with care. Minimum allowed role: pool-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
hardReboot
public void hardReboot(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
hardRebootAsync
public Task hardRebootAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Stop executing the specified VM without attempting a clean shutdown and immediately restart the VM. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
suspend
public void suspend(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
suspendAsync
public Task suspendAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.OperationNotAllowed, Types.VmIsTemplate Suspend the specified VM to disk. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
resume
public void resume(Connection c, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onstartPaused
- Resume VM in paused state if set to true.force
- Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
resumeAsync
public Task resumeAsync(Connection c, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Awaken the specified VM and resume it. This can only be called when the specified VM is in the Suspended state. Minimum allowed role: vm-operator First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onstartPaused
- Resume VM in paused state if set to true.force
- Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
resumeOn
public void resumeOn(Connection c, Host host, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The Host on which to resume the VMstartPaused
- Resume VM in paused state if set to true.force
- Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
resumeOnAsync
public Task resumeOnAsync(Connection c, Host host, Boolean startPaused, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OperationNotAllowed, Types.VmIsTemplate Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The Host on which to resume the VMstartPaused
- Resume VM in paused state if set to true.force
- Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmIsTemplate
- The operation attempted is not valid for a template VM
-
poolMigrate
public void poolMigrate(Connection c, Host host, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.VmIsTemplate, Types.OperationNotAllowed, Types.VmBadPowerStateMigrate a VM to another Host. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The target hostoptions
- Extra configuration operations: force, live, copy, compress. Each is a boolean option, taking 'true' or 'false' as a value. Option 'compress' controls the use of stream compression during migration.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
poolMigrateAsync
public Task poolMigrateAsync(Connection c, Host host, Map<String, String> options) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.VmIsTemplate, Types.OperationNotAllowed, Types.VmBadPowerStateMigrate a VM to another Host. Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The target hostoptions
- Extra configuration operations: force, live, copy, compress. Each is a boolean option, taking 'true' or 'false' as a value. Option 'compress' controls the use of stream compression during migration.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
setVCPUsNumberLive
public void setVCPUsNumberLive(Connection c, Long nvcpu) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OperationNotAllowed, Types.LicenceRestriction Set the number of VCPUs for a running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnvcpu
- The number of VCPUs- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
setVCPUsNumberLiveAsync
public Task setVCPUsNumberLiveAsync(Connection c, Long nvcpu) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OperationNotAllowed, Types.LicenceRestriction Set the number of VCPUs for a running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onnvcpu
- The number of VCPUs- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
addToVCPUsParamsLive
public void addToVCPUsParamsLive(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- The keyvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToVCPUsParamsLiveAsync
public Task addToVCPUsParamsLiveAsync(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Add the given key-value pair to VM.VCPUs_params, and apply that value on the running VM Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- The keyvalue
- The value- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setNVRAM
public void setNVRAM(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionMinimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.- Parameters:
c
- The connection the call is made onvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToNVRAM
public void addToNVRAM(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.- Parameters:
c
- The connection the call is made onkey
- The keyvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromNVRAM
public void removeFromNVRAM(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: vm-admin First published in Citrix Hypervisor 8.0.- Parameters:
c
- The connection the call is made onkey
- The key- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHaRestartPriority
public void setHaRestartPriority(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the ha_restart_priority field Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHaAlwaysRun
@Deprecated(since="XenServer 6.0") public void setHaAlwaysRun(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.0Set the value of the ha_always_run Minimum allowed role: pool-operator First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
computeMemoryOverhead
public Long computeMemoryOverhead(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the virtualization memory overhead of a VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- the virtualization memory overhead of the VM.
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
computeMemoryOverheadAsync
public Task computeMemoryOverheadAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Computes the virtualization memory overhead of a VM. Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryDynamicMax
public void setMemoryDynamicMax(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the memory_dynamic_max field Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new value of memory_dynamic_max- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryDynamicMin
public void setMemoryDynamicMin(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the memory_dynamic_min field Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new value of memory_dynamic_min- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryDynamicRange
public void setMemoryDynamicRange(Connection c, Long min, Long max) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the minimum and maximum amounts of physical memory the VM is allowed to use. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onmin
- The new minimum valuemax
- The new maximum value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryDynamicRangeAsync
public Task setMemoryDynamicRangeAsync(Connection c, Long min, Long max) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the minimum and maximum amounts of physical memory the VM is allowed to use. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onmin
- The new minimum valuemax
- The new maximum value- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryStaticMax
public void setMemoryStaticMax(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HaOperationWouldBreakFailoverPlan Set the value of the memory_static_max field Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- The new value of memory_static_max- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.HaOperationWouldBreakFailoverPlan
- This operation cannot be performed because it would invalidate VM failover planning such that the system would be unable to guarantee to restart protected VMs after a Host failure.
-
setMemoryStaticMin
public void setMemoryStaticMin(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the memory_static_min field Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new value of memory_static_min- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryStaticRange
public void setMemoryStaticRange(Connection c, Long min, Long max) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the static (ie boot-time) range of virtual memory that the VM is allowed to use. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onmin
- The new minimum valuemax
- The new maximum value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryStaticRangeAsync
public Task setMemoryStaticRangeAsync(Connection c, Long min, Long max) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the static (ie boot-time) range of virtual memory that the VM is allowed to use. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onmin
- The new minimum valuemax
- The new maximum value- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryLimits
public void setMemoryLimits(Connection c, Long staticMin, Long staticMax, Long dynamicMin, Long dynamicMax) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the memory limits of this VM. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onstaticMin
- The new value of memory_static_min.staticMax
- The new value of memory_static_max.dynamicMin
- The new value of memory_dynamic_min.dynamicMax
- The new value of memory_dynamic_max.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryLimitsAsync
public Task setMemoryLimitsAsync(Connection c, Long staticMin, Long staticMax, Long dynamicMin, Long dynamicMax) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the memory limits of this VM. Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onstaticMin
- The new value of memory_static_min.staticMax
- The new value of memory_static_max.dynamicMin
- The new value of memory_dynamic_min.dynamicMax
- The new value of memory_dynamic_max.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemory
public void setMemory(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched. Minimum allowed role: vm-power-admin First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onvalue
- The new memory allocation (bytes).- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryAsync
public Task setMemoryAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the memory allocation of this VM. Sets all of memory_static_max, memory_dynamic_min, and memory_dynamic_max to the given value, and leaves memory_static_min untouched. Minimum allowed role: vm-power-admin First published in XenServer 7.1.- Parameters:
c
- The connection the call is made onvalue
- The new memory allocation (bytes).- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryTargetLive
@Deprecated(since="XenServer 5.6") public void setMemoryTargetLive(Connection c, Long target) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.6Set the memory target for a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ontarget
- The target in bytes- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setMemoryTargetLiveAsync
@Deprecated(since="XenServer 5.6") public Task setMemoryTargetLiveAsync(Connection c, Long target) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.6Set the memory target for a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ontarget
- The target in bytes- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
waitMemoryTargetLive
@Deprecated(since="XenServer 5.6") public void waitMemoryTargetLive(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.6Wait for a running VM to reach its current memory target Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
waitMemoryTargetLiveAsync
@Deprecated(since="XenServer 5.6") public Task waitMemoryTargetLiveAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 5.6Wait for a running VM to reach its current memory target Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCooperative
@Deprecated(since="XenServer 6.1") public Boolean getCooperative(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.1Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- true if the VM is currently 'co-operative'; false otherwise
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getCooperativeAsync
@Deprecated(since="XenServer 6.1") public Task getCooperativeAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.1Return true if the VM is currently 'co-operative' i.e. is expected to reach a balloon target and actually has done Minimum allowed role: read-only First published in XenServer 5.6.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHVMShadowMultiplier
public void setHVMShadowMultiplier(Connection c, Double value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the shadow memory multiplier on a halted VM Minimum allowed role: vm-power-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new shadow memory multiplier to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setShadowMultiplierLive
public void setShadowMultiplierLive(Connection c, Double multiplier) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the shadow memory multiplier on a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmultiplier
- The new shadow memory multiplier to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setShadowMultiplierLiveAsync
public Task setShadowMultiplierLiveAsync(Connection c, Double multiplier) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the shadow memory multiplier on a running VM Minimum allowed role: vm-power-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onmultiplier
- The new shadow memory multiplier to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setVCPUsMax
public void setVCPUsMax(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the maximum number of VCPUs for a halted VM Minimum allowed role: vm-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new maximum number of VCPUs- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setVCPUsAtStartup
public void setVCPUsAtStartup(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the number of startup VCPUs for a halted VM Minimum allowed role: vm-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onvalue
- The new maximum number of VCPUs- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
sendSysrq
public void sendSysrq(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- The key to send- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
sendSysrqAsync
public Task sendSysrqAsync(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState Send the given key as a sysrq to this VM. The key is specified as a single character (a String of length 1). This can only be called when the specified VM is in the Running state. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onkey
- The key to send- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
sendTrigger
public void sendTrigger(Connection c, String trigger) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState Send the named trigger to this VM. This can only be called when the specified VM is in the Running state. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ontrigger
- The trigger to send- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
sendTriggerAsync
public Task sendTriggerAsync(Connection c, String trigger) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState Send the named trigger to this VM. This can only be called when the specified VM is in the Running state. Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made ontrigger
- The trigger to send- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
maximiseMemory
public Long maximiseMemory(Connection c, Long total, Boolean approximate) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made ontotal
- Total amount of physical RAM to fit withinapproximate
- If false the limit is calculated with the guest's current exact configuration. Otherwise a more approximate calculation is performed- Returns:
- The maximum possible static-max
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
maximiseMemoryAsync
public Task maximiseMemoryAsync(Connection c, Long total, Boolean approximate) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns the maximum amount of guest memory which will fit, together with overheads, in the supplied amount of physical memory. If 'exact' is true then an exact calculation is performed using the VM's current settings. If 'exact' is false then a more conservative approximation is used Minimum allowed role: read-only First published in XenServer 4.1.- Parameters:
c
- The connection the call is made ontotal
- Total amount of physical RAM to fit withinapproximate
- If false the limit is calculated with the guest's current exact configuration. Otherwise a more approximate calculation is performed- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
migrateSend
public VM migrateSend(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Migrate the VM to another host. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a Host.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parameters- Returns:
- The reference of the newly created VM in the destination pool
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
migrateSend
public VM migrateSend(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Migrate the VM to another host. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a Host.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parametersvgpuMap
- Map of source vGPU to destination GPU group First published in XenServer 7.3.- Returns:
- The reference of the newly created VM in the destination pool
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
migrateSendAsync
public Task migrateSendAsync(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Migrate the VM to another host. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a Host.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parameters- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
migrateSendAsync
public Task migrateSendAsync(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Migrate the VM to another host. This can only be called when the specified VM is in the Running state. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a Host.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parametersvgpuMap
- Map of source vGPU to destination GPU group First published in XenServer 7.3.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
assertCanMigrate
public void assertCanMigrate(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Assert whether a VM can be migrated to the specified destination. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a VM.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parameters- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
assertCanMigrate
public void assertCanMigrate(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Assert whether a VM can be migrated to the specified destination. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a VM.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parametersvgpuMap
- Map of source vGPU to destination GPU group First published in XenServer 7.3.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
assertCanMigrateAsync
public Task assertCanMigrateAsync(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options) Assert whether a VM can be migrated to the specified destination. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a VM.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parameters- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
assertCanMigrateAsync
public Task assertCanMigrateAsync(Connection c, Map<String, String> dest, Boolean live, Map<VDI, throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.LicenceRestrictionSR> vdiMap, Map<VIF, Network> vifMap, Map<String, String> options, Map<VGPU, GPUGroup> vgpuMap) Assert whether a VM can be migrated to the specified destination. Minimum allowed role: vm-power-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ondest
- The result of a VM.migrate_receive call.live
- Live migrationvdiMap
- Map of source VDI to destination SRvifMap
- Map of source VIF to destination networkoptions
- Other parametersvgpuMap
- Map of source vGPU to destination GPU group First published in XenServer 7.3.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.LicenceRestriction
- This operation is not allowed because your license lacks a needed feature. Please contact your support representative.
-
getBootRecord
@Deprecated(since="XenServer 7.3") public VM.Record getBootRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.3Returns a record describing the VM's dynamic state, initialised when the VM boots and updated to reflect runtime configuration changes e.g. CPU hotplug Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- A record describing the VM
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDataSources
public Set<DataSource.Record> getDataSources(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- A set of data sources
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
recordDataSource
public void recordDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Start recording the specified data source Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to record- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
queryDataSource
public Double queryDataSource(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Query the latest value of the specified data source Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source to query- Returns:
- The latest value, averaged over the last 5 seconds
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
forgetDataSourceArchives
public void forgetDataSourceArchives(Connection c, String dataSource) throws Types.BadServerResponse, Types.XenAPIException, IOException Forget the recorded statistics related to the specified data source Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made ondataSource
- The data source whose archives are to be forgotten- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertOperationValid
public void assertOperationValid(Connection c, Types.VmOperations op) throws Types.BadServerResponse, Types.XenAPIException, IOException Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onop
- proposed operation- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertOperationValidAsync
public Task assertOperationValidAsync(Connection c, Types.VmOperations op) throws Types.BadServerResponse, Types.XenAPIException, IOException Check to see whether this operation is acceptable in the current state of the system, raising an error if the operation is invalid for some reason Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onop
- proposed operation- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
updateAllowedOperations
public void updateAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Recomputes the list of acceptable operations Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
updateAllowedOperationsAsync
public Task updateAllowedOperationsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Recomputes the list of acceptable operations Minimum allowed role: pool-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedVBDDevices
public Set<String> getAllowedVBDDevices(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns a list of the allowed values that a VBD device field can take Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The allowed values
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllowedVIFDevices
public Set<String> getAllowedVIFDevices(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns a list of the allowed values that a VIF device field can take Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The allowed values
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPossibleHosts
public Set<Host> getPossibleHosts(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return the list of hosts on which this VM may run. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- The possible hosts
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getPossibleHostsAsync
public Task getPossibleHostsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return the list of hosts on which this VM may run. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertCanBootHere
public void assertCanBootHere(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HostNotEnoughFreeMemory, Types.HostNotEnoughPcpus, Types.NetworkSriovInsufficientCapacity, Types.HostNotLive, Types.HostDisabled, Types.HostCannotAttachNetwork, Types.VmHvmRequired, Types.VmRequiresGpu, Types.VmRequiresIommu, Types.VmRequiresNetwork, Types.VmRequiresSr, Types.VmRequiresVgpu, Types.VmHostIncompatibleVersion, Types.VmHostIncompatibleVirtualHardwarePlatformVersion, Types.InvalidValue, Types.MemoryConstraintViolation, Types.OperationNotAllowed, Types.ValueNotSupported, Types.VmIncompatibleWithThisHost Returns an error if the VM could not boot on this host for some reason Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.HostNotEnoughFreeMemory
- Not enough server memory is available to perform this operation.Types.HostNotEnoughPcpus
- The host does not have enough pCPUs to run the VM. It needs at least as many as the VM has vCPUs.Types.NetworkSriovInsufficientCapacity
- There is insufficient capacity for VF reservationTypes.HostNotLive
- This operation cannot be completed as the server is not live.Types.HostDisabled
- The specified server is disabled.Types.HostCannotAttachNetwork
- Server cannot attach network (in the case of NIC bonding, this may be because attaching the network on this server would require other networks - that are currently active - to be taken down).Types.VmHvmRequired
- HVM is required for this operationTypes.VmRequiresGpu
- You attempted to run a VM on a host which doesn't have a pGPU available in the GPU group needed by the VM. The VM has a vGPU attached to this GPU group.Types.VmRequiresIommu
- You attempted to run a VM on a host which doesn't have I/O virtualization (IOMMU/VT-d) enabled, which is needed by the VM.Types.VmRequiresNetwork
- You attempted to run a VM on a host which doesn't have a PIF on a Network needed by the VM. The VM has at least one VIF attached to the Network.Types.VmRequiresSr
- You attempted to run a VM on a host which doesn't have access to an SR needed by the VM. The VM has at least one VBD attached to a VDI in the SR.Types.VmRequiresVgpu
- You attempted to run a VM on a host on which the vGPU required by the VM cannot be allocated on any pGPUs in the GPU_group needed by the VM.Types.VmHostIncompatibleVersion
- This VM operation cannot be performed on an older-versioned host during an upgrade.Types.VmHostIncompatibleVirtualHardwarePlatformVersion
- You attempted to run a VM on a host that cannot provide the VM's required Virtual Hardware Platform version.Types.InvalidValue
- The value given is invalidTypes.MemoryConstraintViolation
- The dynamic memory range does not satisfy the following constraint.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.ValueNotSupported
- You attempted to set a value that is not supported by this implementation. The fully-qualified field name and the value that you tried to set are returned. Also returned is a developer-only diagnostic reason.Types.VmIncompatibleWithThisHost
- The VM is incompatible with the CPU features of this host.
-
assertCanBootHereAsync
public Task assertCanBootHereAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.HostNotEnoughFreeMemory, Types.HostNotEnoughPcpus, Types.NetworkSriovInsufficientCapacity, Types.HostNotLive, Types.HostDisabled, Types.HostCannotAttachNetwork, Types.VmHvmRequired, Types.VmRequiresGpu, Types.VmRequiresIommu, Types.VmRequiresNetwork, Types.VmRequiresSr, Types.VmRequiresVgpu, Types.VmHostIncompatibleVersion, Types.VmHostIncompatibleVirtualHardwarePlatformVersion, Types.InvalidValue, Types.MemoryConstraintViolation, Types.OperationNotAllowed, Types.ValueNotSupported, Types.VmIncompatibleWithThisHost Returns an error if the VM could not boot on this host for some reason Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onhost
- The host- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.HostNotEnoughFreeMemory
- Not enough server memory is available to perform this operation.Types.HostNotEnoughPcpus
- The host does not have enough pCPUs to run the VM. It needs at least as many as the VM has vCPUs.Types.NetworkSriovInsufficientCapacity
- There is insufficient capacity for VF reservationTypes.HostNotLive
- This operation cannot be completed as the server is not live.Types.HostDisabled
- The specified server is disabled.Types.HostCannotAttachNetwork
- Server cannot attach network (in the case of NIC bonding, this may be because attaching the network on this server would require other networks - that are currently active - to be taken down).Types.VmHvmRequired
- HVM is required for this operationTypes.VmRequiresGpu
- You attempted to run a VM on a host which doesn't have a pGPU available in the GPU group needed by the VM. The VM has a vGPU attached to this GPU group.Types.VmRequiresIommu
- You attempted to run a VM on a host which doesn't have I/O virtualization (IOMMU/VT-d) enabled, which is needed by the VM.Types.VmRequiresNetwork
- You attempted to run a VM on a host which doesn't have a PIF on a Network needed by the VM. The VM has at least one VIF attached to the Network.Types.VmRequiresSr
- You attempted to run a VM on a host which doesn't have access to an SR needed by the VM. The VM has at least one VBD attached to a VDI in the SR.Types.VmRequiresVgpu
- You attempted to run a VM on a host on which the vGPU required by the VM cannot be allocated on any pGPUs in the GPU_group needed by the VM.Types.VmHostIncompatibleVersion
- This VM operation cannot be performed on an older-versioned host during an upgrade.Types.VmHostIncompatibleVirtualHardwarePlatformVersion
- You attempted to run a VM on a host that cannot provide the VM's required Virtual Hardware Platform version.Types.InvalidValue
- The value given is invalidTypes.MemoryConstraintViolation
- The dynamic memory range does not satisfy the following constraint.Types.OperationNotAllowed
- You attempted an operation that was not allowed.Types.ValueNotSupported
- You attempted to set a value that is not supported by this implementation. The fully-qualified field name and the value that you tried to set are returned. Also returned is a developer-only diagnostic reason.Types.VmIncompatibleWithThisHost
- The VM is incompatible with the CPU features of this host.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlob
public Blob createNewBlob(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- The reference of the blob, needed for populating its data
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
createNewBlobAsync
public Task createNewBlobAsync(Connection c, String name, String mimeType, Boolean _public) throws Types.BadServerResponse, Types.XenAPIException, IOException Create a placeholder for a named binary blob of data that is associated with this VM Minimum allowed role: vm-power-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onname
- The name associated with the blobmimeType
- The mime type for the data. Empty string translates to application/octet-stream_public
- True if the blob should be publicly available First published in XenServer 6.1.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertAgile
public void assertAgile(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertAgileAsync
public Task assertAgileAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns an error if the VM is not considered agile e.g. because it is tied to a resource local to a host Minimum allowed role: read-only First published in XenServer 5.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbRecommendations
public Map<Host,Set<String>> retrieveWlbRecommendations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- The potential hosts and their corresponding recommendations or errors
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
retrieveWlbRecommendationsAsync
public Task retrieveWlbRecommendationsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Returns mapping of hosts to ratings, indicating the suitability of starting the VM at that location according to wlb. Rating is replaced with an error if the VM cannot boot there. Minimum allowed role: read-only First published in XenServer 5.5.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setBiosStrings
public void setBiosStrings(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBiosStringsAlreadySet, Types.InvalidValueSet custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag' Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvalue
- The custom BIOS strings as a list of key-value pairs- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBiosStringsAlreadySet
- The BIOS strings for this VM have already been set and cannot be changed.Types.InvalidValue
- The value given is invalid
-
setBiosStringsAsync
public Task setBiosStringsAsync(Connection c, Map<String, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBiosStringsAlreadySet, Types.InvalidValueSet custom BIOS strings to this VM. VM will be given a default set of BIOS strings, only some of which can be overridden by the supplied values. Allowed keys are: 'bios-vendor', 'bios-version', 'system-manufacturer', 'system-product-name', 'system-version', 'system-serial-number', 'enclosure-asset-tag', 'baseboard-manufacturer', 'baseboard-product-name', 'baseboard-version', 'baseboard-serial-number', 'baseboard-asset-tag', 'baseboard-location-in-chassis', 'enclosure-asset-tag' Minimum allowed role: vm-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onvalue
- The custom BIOS strings as a list of key-value pairs- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBiosStringsAlreadySet
- The BIOS strings for this VM have already been set and cannot be changed.Types.InvalidValue
- The value given is invalid
-
copyBiosStrings
public void copyBiosStrings(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Copy the BIOS strings from the given host to this VM Minimum allowed role: vm-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onhost
- The host to copy the BIOS strings from- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
copyBiosStringsAsync
public Task copyBiosStringsAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException Copy the BIOS strings from the given host to this VM Minimum allowed role: vm-admin First published in XenServer 5.6.- Parameters:
c
- The connection the call is made onhost
- The host to copy the BIOS strings from- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setProtectionPolicy
@Deprecated(since="XenServer 6.2") public void setProtectionPolicy(Connection c, VMPP value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 6.2Set the value of the protection_policy field Minimum allowed role: pool-operator First published in XenServer 5.6 FP1.- Parameters:
c
- The connection the call is made onvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSnapshotSchedule
public void setSnapshotSchedule(Connection c, VMSS value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the value of the snapshot schedule field Minimum allowed role: pool-operator First published in XenServer 7.2.- Parameters:
c
- The connection the call is made onvalue
- The value- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setStartDelay
public void setStartDelay(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's start delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's start delay in seconds- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setStartDelayAsync
public Task setStartDelayAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's start delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's start delay in seconds- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setShutdownDelay
public void setShutdownDelay(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's shutdown delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's shutdown delay in seconds- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setShutdownDelayAsync
public Task setShutdownDelayAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's shutdown delay in seconds Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's shutdown delay in seconds- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOrder
public void setOrder(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's boot order Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's boot order- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setOrderAsync
public Task setOrderAsync(Connection c, Long value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's boot order Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- This VM's boot order- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSuspendVDI
public void setSuspendVDI(Connection c, VDI value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's suspend VDI, which must be indentical to its current one Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The suspend VDI uuid- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setSuspendVDIAsync
public Task setSuspendVDIAsync(Connection c, VDI value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set this VM's suspend VDI, which must be indentical to its current one Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The suspend VDI uuid- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
assertCanBeRecovered
public void assertCanBeRecovered(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmIsPartOfAnAppliance, Types.VmRequiresSr Assert whether all SRs required to recover this VM are available. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the VM is to be recovered.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmIsPartOfAnAppliance
- This operation is not allowed as the VM is part of an appliance.Types.VmRequiresSr
- You attempted to run a VM on a host which doesn't have access to an SR needed by the VM. The VM has at least one VBD attached to a VDI in the SR.
-
assertCanBeRecoveredAsync
public Task assertCanBeRecoveredAsync(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmIsPartOfAnAppliance, Types.VmRequiresSr Assert whether all SRs required to recover this VM are available. Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the VM is to be recovered.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmIsPartOfAnAppliance
- This operation is not allowed as the VM is part of an appliance.Types.VmRequiresSr
- You attempted to run a VM on a host which doesn't have access to an SR needed by the VM. The VM has at least one VBD attached to a VDI in the SR.
-
getSRsRequiredForRecovery
public Set<SR> getSRsRequiredForRecovery(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, IOException List all the SR's that are required for the VM to be recovered Minimum allowed role: read-only First published in XenServer 6.5.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the SRs of the VM have to be recovered.- Returns:
- refs for SRs required to recover the VM
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSRsRequiredForRecoveryAsync
public Task getSRsRequiredForRecoveryAsync(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, IOException List all the SR's that are required for the VM to be recovered Minimum allowed role: read-only First published in XenServer 6.5.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the SRs of the VM have to be recovered.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
recover
public void recover(Connection c, Session sessionTo, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException Recover the VM Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the VM is to be recovered.force
- Whether the VM should replace newer versions of itself.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
recoverAsync
public Task recoverAsync(Connection c, Session sessionTo, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException Recover the VM Minimum allowed role: read-only First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onsessionTo
- The session to which the VM is to be recovered.force
- Whether the VM should replace newer versions of itself.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
import_Convert
public static void import_Convert(Connection c, String type, String username, String password, SR sr, Map<String, String> remoteConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionImport using a conversion service. Minimum allowed role: vm-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ontype
- Type of the conversionusername
- Admin username on the hostpassword
- Password on the hostsr
- The destination SRremoteConfig
- Remote configuration options- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
import_ConvertAsync
public static Task import_ConvertAsync(Connection c, String type, String username, String password, SR sr, Map<String, String> remoteConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionImport using a conversion service. Minimum allowed role: vm-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made ontype
- Type of the conversionusername
- Admin username on the hostpassword
- Password on the hostsr
- The destination SRremoteConfig
- Remote configuration options- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setAppliance
public void setAppliance(Connection c, VMAppliance value) throws Types.BadServerResponse, Types.XenAPIException, IOException Assign this VM to an appliance. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The appliance to which this VM should be assigned.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setApplianceAsync
public Task setApplianceAsync(Connection c, VMAppliance value) throws Types.BadServerResponse, Types.XenAPIException, IOException Assign this VM to an appliance. Minimum allowed role: pool-operator First published in XenServer 6.0.- Parameters:
c
- The connection the call is made onvalue
- The appliance to which this VM should be assigned.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setGroups
public void setGroups(Connection c, Set<VMGroup> value) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OperationNotAllowed Associate this VM with VM groups. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.- Parameters:
c
- The connection the call is made onvalue
- The VM groups to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OperationNotAllowed
- You attempted an operation that was not allowed.
-
setGroupsAsync
public Task setGroupsAsync(Connection c, Set<VMGroup> value) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.OperationNotAllowed Associate this VM with VM groups. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.- Parameters:
c
- The connection the call is made onvalue
- The VM groups to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.OperationNotAllowed
- You attempted an operation that was not allowed.
-
queryServices
public Map<String,String> queryServices(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Query the system services advertised by this VM and register them. This can only be applied to a system domain. Minimum allowed role: pool-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made on- Returns:
- map of service type to name
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
queryServicesAsync
public Task queryServicesAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Query the system services advertised by this VM and register them. This can only be applied to a system domain. Minimum allowed role: pool-admin First published in XenServer 6.1.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
callPlugin
public String callPlugin(Connection c, String plugin, String fn, Map<String, String> args) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCall an API plugin on this vm Minimum allowed role: vm-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made onplugin
- The name of the pluginfn
- The name of the function within the pluginargs
- Arguments for the function- Returns:
- Result from the plugin
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
callPluginAsync
public Task callPluginAsync(Connection c, String plugin, String fn, Map<String, String> args) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCall an API plugin on this vm Minimum allowed role: vm-operator First published in XenServer 6.5 SP1.- Parameters:
c
- The connection the call is made onplugin
- The name of the pluginfn
- The name of the function within the pluginargs
- Arguments for the function- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHasVendorDevice
public void setHasVendorDevice(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start. Minimum allowed role: vm-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onvalue
- True to provide the vendor PCI device.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHasVendorDeviceAsync
public Task setHasVendorDeviceAsync(Connection c, Boolean value) throws Types.BadServerResponse, Types.XenAPIException, IOException Controls whether, when the VM starts in HVM mode, its virtual hardware will include the emulated PCI device for which drivers may be available through Windows Update. Usually this should never be changed on a VM on which Windows has been installed: changing it on such a VM is likely to lead to a crash on next start. Minimum allowed role: vm-admin First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onvalue
- True to provide the vendor PCI device.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
import_
public static Set<VM> import_(Connection c, String url, SR sr, Boolean fullRestore, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException Import an XVA from a URI Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onurl
- The URL of the XVA filesr
- The destination SR for the disksfullRestore
- Perform a full restoreforce
- Force the import- Returns:
- Imported VM reference
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
import_Async
public static Task import_Async(Connection c, String url, SR sr, Boolean fullRestore, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, IOException Import an XVA from a URI Minimum allowed role: pool-operator First published in XenServer 7.0.- Parameters:
c
- The connection the call is made onurl
- The URL of the XVA filesr
- The destination SR for the disksfullRestore
- Perform a full restoreforce
- Force the import- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setActionsAfterCrash
public void setActionsAfterCrash(Connection c, Types.OnCrashBehaviour value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the actions_after_crash parameter Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The new value to set- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setActionsAfterCrashAsync
public Task setActionsAfterCrashAsync(Connection c, Types.OnCrashBehaviour value) throws Types.BadServerResponse, Types.XenAPIException, IOException Sets the actions_after_crash parameter Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The new value to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setDomainType
public void setDomainType(Connection c, Types.DomainType value) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the VM.domain_type field of the given VM, which will take effect when it is next started Minimum allowed role: vm-admin First published in XenServer 7.5.- Parameters:
c
- The connection the call is made onvalue
- The new domain type- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setHVMBootPolicy
@Deprecated(since="XenServer 7.5") public void setHVMBootPolicy(Connection c, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Deprecated.since XenServer 7.5Set the VM.HVM_boot_policy field of the given VM, which will take effect when it is next started Minimum allowed role: vm-admin First published in XenServer 4.0.- Parameters:
c
- The connection the call is made onvalue
- The new HVM boot policy- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
restartDeviceModels
public void restartDeviceModels(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.VmIsTemplate, Types.OperationNotAllowed, Types.VmBadPowerState Restart device models of the VM Minimum allowed role: vm-power-admin Experimental. First published in 23.30.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
restartDeviceModelsAsync
public Task restartDeviceModelsAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException, Types.VmBadPowerState, Types.OtherOperationInProgress, Types.VmIsTemplate, Types.OperationNotAllowed, Types.VmBadPowerState Restart device models of the VM Minimum allowed role: vm-power-admin Experimental. First published in 23.30.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.Types.OtherOperationInProgress
- Another operation involving the object is currently in progressTypes.VmIsTemplate
- The operation attempted is not valid for a template VMTypes.OperationNotAllowed
- You attempted an operation that was not allowed.Types.VmBadPowerState
- You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call.
-
setUefiMode
public String setUefiMode(Connection c, Types.VmUefiMode mode) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the UEFI mode of a VM Minimum allowed role: pool-admin Experimental. First published in 24.17.0.- Parameters:
c
- The connection the call is made onmode
- The UEFI mode to set- Returns:
- Result from the varstore-sb-state call
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setUefiModeAsync
public Task setUefiModeAsync(Connection c, Types.VmUefiMode mode) throws Types.BadServerResponse, Types.XenAPIException, IOException Set the UEFI mode of a VM Minimum allowed role: pool-admin Experimental. First published in 24.17.0.- Parameters:
c
- The connection the call is made onmode
- The UEFI mode to set- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSecurebootReadiness
public Types.VmSecurebootReadiness getSecurebootReadiness(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return the secureboot readiness of the VM Minimum allowed role: pool-admin Experimental. First published in 24.17.0.- Parameters:
c
- The connection the call is made on- Returns:
- The secureboot readiness of the VM
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSecurebootReadinessAsync
public Task getSecurebootReadinessAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return the secureboot readiness of the VM Minimum allowed role: pool-admin Experimental. First published in 24.17.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setBlockedOperations
public void setBlockedOperations(Connection c, Map<Types.VmOperations, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionUpdate list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- Blocked operations- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
setBlockedOperationsAsync
public Task setBlockedOperationsAsync(Connection c, Map<Types.VmOperations, String> value) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionUpdate list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onvalue
- Blocked operations- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToBlockedOperations
public void addToBlockedOperations(Connection c, Types.VmOperations key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Blocked operationvalue
- Error code- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
addToBlockedOperationsAsync
public Task addToBlockedOperationsAsync(Connection c, Types.VmOperations key, String value) throws Types.BadServerResponse, Types.XenAPIException, IOException Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Blocked operationvalue
- Error code- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromBlockedOperations
public void removeFromBlockedOperations(Connection c, Types.VmOperations key) throws Types.BadServerResponse, Types.XenAPIException, IOException Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Blocked operation- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
removeFromBlockedOperationsAsync
public Task removeFromBlockedOperationsAsync(Connection c, Types.VmOperations key) throws Types.BadServerResponse, Types.XenAPIException, IOException Update list of operations which have been explicitly blocked and an error code Minimum allowed role: vm-admin First published in XenServer 5.0.- Parameters:
c
- The connection the call is made onkey
- Blocked operation- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<VM> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the VMs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<VM,VM.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VM references to VM records for all VMs known to the system. Minimum allowed role: read-only First published in XenServer 4.0.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-