diff --git a/content/product/operation_references/configuration_references/vm_update_methods.md b/content/product/operation_references/configuration_references/vm_update_methods.md new file mode 100644 index 000000000..f1639a03a --- /dev/null +++ b/content/product/operation_references/configuration_references/vm_update_methods.md @@ -0,0 +1,997 @@ +--- +title: 'Updating Virtual Machine Configuration' +linkTitle: 'Updating VM Configuration' +--- + + + + + + + + +OpenNebula provides a powerful set of tools through the GUI, CLI and API that allow you to update Virtual Machine configuration on the fly, even while the VM is running. This flexibility enables you to optimize performance, adjust resource allocation, and manage your virtual infrastructure with ease. The following table details all the VM configuration update methods available with interface coverage and notes. Use the filter to find the methods relevant to your use case. + +## VM Configuration Update Methods Reference + + +{{< vm-methods-table >}} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SectionTrackerMethodAttributeDescriptionUpdating in Running stateUpdating in POWEROFF stateAPICLIGUILimitations/Notes
Computeone.vm.resizeVM/TEMPLATE/CPUChanges VM CPU allocation factorNOYESYES YESYESScheduler/resource allocation attribute; changes applied after power cycle for effective runtime impact
Computeone.vm.resizeVM/TEMPLATE/VCPUChanges VM virtual CPU countPartialYESYES YESYESVCPU hotplug support required for live effect; otherwise applied after reboot
Computeone.vm.resizeVM/TEMPLATE/MEMORYChanges VM memory allocationPartialYESYES YESYESMemory hotplug support required for live effect; otherwise applied after reboot
Diskone.vm.attachVM/TEMPLATE/DISKAttaches a disk to the VMPartialYESYES YESYESDisk hotplug support depends on disk bus/controller
Diskone.vm.detachVM/TEMPLATE/DISKDetaches a disk from the VMPartialYESYES YESYESMay fail for active/system disks or unsupported buses
Diskone.vm.diskresizeVM/TEMPLATE/DISKResizes VM diskPartialYESYES YESYESMay fail for active/system disks or unsupported buses
Diskone.vm.disksaveasVM/TEMPLATE/DISKSaves VM disk as imageYESYESYES YESYES
NICone.vm.attachnicVM/TEMPLATE/NICAttaches NIC to the VMYESYESYES YESYES
NICone.vm.detachnicVM/TEMPLATE/NICDetaches NIC from the VMYESYESYES YESYES
NICone.vm.updatenicVM/TEMPLATE/NICUpdates VM NIC configurationYESYESYES YESYES
NICone.vm.attachsgVM/TEMPLATE/NIC/SECURITY_GROUPSAttaches security group to VM NICYESYESYES YESYES
NICone.vm.detachsgVM/TEMPLATE/NIC/SECURITY_GROUPSDetaches security group from VM NICYESYESYES YESYES
PCIone.vm.attachpciVM/TEMPLATE/PCIAttaches PCI device to the VMNOYESYES YESYESOnly in POWER OFF state
PCIone.vm.detachpciVM/TEMPLATE/PCIDetaches PCI device from the VMNO YESYES YESYESOnly in POWER OFF state
Snapshotsone.vm.snapshotcreateVM/TEMPLATE/SNAPSHOTCreates VM snapshotYESYESYES YESYES
Snapshotsone.vm.snapshotrevertVM/TEMPLATE/SNAPSHOTReverts VM to snapshot stateNOYESYES YESYESOnly in POWER OFF state
Snapshotsone.vm.snapshotdeleteVM/TEMPLATE/SNAPSHOTDeletes VM snapshotYESYESYES YESYES
Snapshotsone.vm.disksnapshotcreateVM/SNAPSHOTS/SNAPSHOTCreates disk snapshotYESYESYES YESYES
Snapshotsone.vm.disksnapshotdeleteVM/SNAPSHOTS/SNAPSHOTDeletes disk snapshotYESYESYES YESYES
Snapshotsone.vm.disksnapshotrevertVM/SNAPSHOTS/SNAPSHOTReverts disk to snapshot stateNOYESYES YESYESOnly in POWER OFF state
Snapshotsone.vm.disksnapshotrenameVM/SNAPSHOTS/SNAPSHOTRenames disk snapshotYESYESYES YESYES
Backupsone.vm.backupVM/BACKUPSCreates VM backupYESYESYES YESYES
Backupsone.vm.backupcancelVM/BACKUPSCancels running VM backup jobYESYESYES YESYES
Backupsone.vm.restoreVM/BACKUPSRestores VM disks/state from backupNOYESYES YESYESOnly in POWER OFF state
VM attributesone.vm.updateVM/USER_TEMPLATEUpdates VM user templateNOYESYES YESNOUpdates on the next power cycle
VM attributesone.vm.renameVM/NAMERenames VMYESYESYES YESYES
VM attributesone.vm.chownVM/UID, VM/GID, VM/UNAME, VM/GNAMEChanges VM ownershipYESYESYES YESYES
VM attributesone.vm.chmodVM/PERMISSIONSChanges VM permissionsYESYESYES YESYES
VM scheduled actionsone.vm.schedaddVM/TEMPLATE/SCHED_ACTIONAdds scheduled VM actionYESYESYES YESYES
VM scheduled actionsone.vm.schedupdateVM/TEMPLATE/SCHED_ACTIONUpdates scheduled VM actionYESYESYES YESYES
VM scheduled actionsone.vm.scheddeleteVM/TEMPLATE/SCHED_ACTIONDeletes scheduled VM actionYESYESYES YESYES
Otherone.vm.lockVM/LOCKLocks VM actionsYESYESYES YESYES
Otherone.vm.unlockVM/LOCKUnlocks VM actionsYESYESYES YESYES
Otherone.vm.execVM/TEMPLATE/QEMU_GA_EXECExecutes command inside guestYESNOYES YESNORequires guest agent
Otherone.vm.retryexecVM/TEMPLATE/QEMU_GA_EXECRetries guest commandYESNOYES YESNORequires guest agent
Otherone.vm.cancelexecVM/TEMPLATE/QEMU_GA_EXECCancels guest commandYESNOYES YESNORequires guest agent
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/ARCHDefines guest CPU architectureNOYESYES YESYESEffectively immutable for existing VM
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/MACHINEDefines machine/chipset type used by hypervisorNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/KERNELDefines kernel image for direct kernel bootNOYESYES YESNOApplied after poweroff/resume; direct kernel boot only
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/INITRDDefines initrd image for direct kernel bootNOYESYES YESNOApplied after poweroff/resume; direct kernel boot only
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/BOOTLOADERDefines external bootloaderNOYESYES YESYESNot applicable/ignored in KVM
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/BOOTLOADERDefines VM boot deviceYESYESYES YESYESReflected in OpenNebula UI; libvirt may resolve as default disk boot
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/KERNEL_CMDDefines kernel command line parametersNOYESYES YESNOApplied after poweroff/resume; direct kernel boot only
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/ROOTDefines guest root deviceNOYESYES YESNOApplied after poweroff/resume; direct kernel boot only
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/SD_DISK_BUSDefines bus type for SD disksNOYESYES YESYESApplied after poweroff/resume;
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/UUIDDefines VM UUIDNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/FIRMWAREDefines VM firmware/UEFI loaderNOYESYES YESNOApplied after poweroff/resume; requires valid OVMF path
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/OS/FIRMWARE_FORMATDefines firmware image formatNOYESYES YESNOApplied after poweroff/resume with firmware
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/CPU_MODEL/MODELDefines guest CPU model exposed to VMNOYESYES YESNOApplied after poweroff/resume if CPU model is valid for host
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/CPU_MODEL/FEATURESDefines guest CPU feature flagsNOYESYES YESNOApplied after poweroff/resume if features are supported by host CPU
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/ACPIEnables ACPI supportNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/PAEEnables Physical Address Extension supportNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/APICEnables APIC supportNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/LOCALTIMEConfigures guest RTC clock modeNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/HYPERVEnables Hyper-V enlightenmentsNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/GUEST_AGENTEnables QEMU guest agent channelNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/VIRTIO_SCSI_QUEUESConfigures virtio-scsi queue countNOYESYES YESNOApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/VIRTIO_BLK_QUEUESConfigures virtio-blk queue countNOYESYES YESNOApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/FEATURES/IOTHREADSConfigures disk IO threadsNOYESYES YESNOApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/INPUT/TYPEDefines guest input device typeNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/INPUT/BUSDefines guest input device busNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/GRAPHICS/TYPEDefines graphics protocol/backendNOYESYES YESNOTemplate changes while running; applied after poweroff/resume. SPICE works with external clients, not FireEdge/Guacamole in this setup
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/GRAPHICS/LISTENDefines graphics listen addressNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/GRAPHICS/PASSWDDefines graphics console passwordNOYESYES YESYESApplied after poweroff/resume; password prompt works with external VNC/SPICE clients, not via FireEdge/Guacamole
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/GRAPHICS/KEYMAPDefines keyboard layout for graphics consoleNOYESYES YESYESApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/GRAPHICS/COMMANDDefines graphics command parametersNOYESYES YESNOStored in template but not passed to libvirt domain XML in KVM
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/VIDEO/TYPEDefines virtual video adapter typeYESYESYES YESYESLive-applied; without VRAM/related options may fall back to default model such as cirrus
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/VIDEO/IOMMUEnables IOMMU support for video deviceYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/VIDEO/ATSEnables Address Translation Service for video deviceYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/VIDEO/VRAMDefines virtual video memory sizeYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/VIDEO/RESOLUTIONDefines guest display resolutionYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/RAW/DATADefines raw hypervisor XML snippetNOYESYES YESNOApplied after poweroff/resume
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/RAW/DATA_VMXDefines VMX-specific raw configurationDefines VMX-specific raw configurationNOYESYES YESNONot applicable to KVM; template-only/no effect
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/RAW/TYPEDefines hypervisor backend typeNOYESYES YESNOActs as driver selector; for KVM must be kvm
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/RAW/VALIDATEEnables raw XML validationNOYESYES YESNOTemplate/validation behavior; not a live libvirt change
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/BACKUP_CONFIG/FS_FREEZEEnables filesystem freeze during backupYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/BACKUP_CONFIG/KEEP_LASTDefines number of retained backupsYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/BACKUP_CONFIG/BACKUP_VOLATILEIncludes volatile disks in backupYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/BACKUP_CONFIG/MODEDefines backup modeYESYESYES YESYES
one.vm.updateconfone.vm.updateconfVM/TEMPLATE/BACKUP_CONFIG/INCREMENT_MODEDefines incremental backup modeYESYESYES YESYES
+{{< /vm-methods-table >}} \ No newline at end of file diff --git a/content/product/virtual_machines_operation/virtual_machines/vm_instances.md b/content/product/virtual_machines_operation/virtual_machines/vm_instances.md index e28343e99..32a901804 100644 --- a/content/product/virtual_machines_operation/virtual_machines/vm_instances.md +++ b/content/product/virtual_machines_operation/virtual_machines/vm_instances.md @@ -492,7 +492,7 @@ Some of the VM configuration attributes defined in the VM template can be update | `BACKUP_CONFIG` | `FS_FREEZE`, `KEEP_LAST`, `BACKUP_VOLATILE`, `MODE`,
`INCREMENT_MODE` | | `CONTEXT` | Any value, except `ETH*`. **Variable substitution will be made** | -Visit the [Virtual Machine Template reference]({{% relref "product/operation_references/configuration_references/template#template" %}}) for a complete description of each attribute. +Visit the [Virtual Machine Template reference]({{% relref "product/operation_references/configuration_references/template#template" %}}) for a complete description of each attribute. Visit the [VM Update Methods Reference]({{% relref "product/operation_references/configuration_references/vm_update_methods/" %}}) for additional details on all available VM configuration update methods. {{< alert title="Warning" type="warning" >}} This action might not be supported for `RUNNING` VMs depending on the hypervisor. Please check the limitation section of the specific virtualization driver.{{< /alert >}} diff --git a/layouts/shortcodes/vm-methods-table.html b/layouts/shortcodes/vm-methods-table.html new file mode 100644 index 000000000..f15be9ae1 --- /dev/null +++ b/layouts/shortcodes/vm-methods-table.html @@ -0,0 +1,212 @@ + + + + + + + + + +
+
+ + +
+ + {{ .Inner }} +
+ + \ No newline at end of file