Difference between revisions of "Virsh"

From wikieduonline
Jump to navigation Jump to search
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
<code>virsh</code><ref>http://manpages.ubuntu.com/manpages/xenial/man1/virsh.1.html</ref><ref> https://github.com/libvirt/libvirt/blob/master/tools/virsh.c</ref> is a command line utility for managing virsh guest domains/virtual machines and the hypervisor<ref>https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/5/html/virtualization/chap-virtualization-managing_guests_with_virsh</ref>. Can be used to operate vm like create, list, start, [[shutdown]] or suspend and to manage storage, [[Virsh Snapshots|snapshots]] and [[checkpoints]]<ref>https://github.com/libvirt/libvirt/commit/689beaa47c51fb49fafa992dd468116b8f6b0782#diff-f41fa7374ab97c527387ea4ce48fd04e</ref> among other actions. <code>[[virt-manager]]</code> is a graphical alternative to virsh. It supports Xen, QEMU, [[KVM]], LXC, OpenVZ, VirtualBox and VMware ESX.
+
{{lowercase}}
 +
<code>virsh</code><ref>http://manpages.ubuntu.com/manpages/xenial/man1/virsh.1.html</ref><ref> https://github.com/libvirt/libvirt/blob/master/tools/virsh.c</ref> is a command line utility for managing virsh guest domains/virtual machines and the hypervisor<ref>https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/5/html/virtualization/chap-virtualization-managing_guests_with_virsh</ref>. Can be used to operate vm like create, list, start, [[shutdown]] or suspend and to manage [[Virsh storage information|storage]], [[Virsh Snapshots|snapshots]] and [[checkpoints]]<ref>https://github.com/libvirt/libvirt/commit/689beaa47c51fb49fafa992dd468116b8f6b0782#diff-f41fa7374ab97c527387ea4ce48fd04e</ref> among other actions. <code>[[virt-manager]]</code> is a graphical alternative to virsh. It supports Xen, QEMU, [[KVM]], [[LXC]], [[OpenVZ]], VirtualBox and VMware ESX.
  
 
<code>virsh</code>  is include in <code>[[libvirt|libvirt-client]]</code>  package in [[RHEL]] and [[Ubuntu]] and uses [[libvirt]] management API. Binaries included:
 
<code>virsh</code>  is include in <code>[[libvirt|libvirt-client]]</code>  package in [[RHEL]] and [[Ubuntu]] and uses [[libvirt]] management API. Binaries included:
* virsh
+
*<code>virsh</code>
* [[virt-admin]]
+
*<code>[[virt-admin]]</code>
* [[virt-host-validate]]
+
*<code>[[virt-host-validate]]</code>
* [[virt-login-shell]]
+
*<code>[[virt-login-shell]]</code>
* [[virt-pki-validate]]
+
*<code>[[virt-pki-validate]]</code>
* [[virt-xml-validate]]
+
*<code>[[virt-xml-validate]]</code>
  
 
== Basic Commands ==
 
== Basic Commands ==
Line 16: Line 17:
 
* <code>[[virsh --connect]]</code>
 
* <code>[[virsh --connect]]</code>
 
** <code>[[virsh -c]] qemu:///system list</code>
 
** <code>[[virsh -c]] qemu:///system list</code>
 +
*<code>[[virsh attach-device]]</code>
 
* <code>[[virsh autostart]] VM_NAME</code> or <code>[[virsh autostart]] VM_NAME --disable</code> (Related: <code>[[virsh start]]</code> and <code>[[virsh pool-autostart]]</code>)
 
* <code>[[virsh autostart]] VM_NAME</code> or <code>[[virsh autostart]] VM_NAME --disable</code> (Related: <code>[[virsh start]]</code> and <code>[[virsh pool-autostart]]</code>)
 
* <code>[[virsh blockcommit]]</code>. Allows Live-disk-backup-with-active-blockcommit <ref> https://wiki.libvirt.org/page/Live-disk-backup-with-active-blockcommit</ref>
 
* <code>[[virsh blockcommit]]</code>. Allows Live-disk-backup-with-active-blockcommit <ref> https://wiki.libvirt.org/page/Live-disk-backup-with-active-blockcommit</ref>
Line 22: Line 24:
 
* <code>[[virsh blockresize]]</code>
 
* <code>[[virsh blockresize]]</code>
 
* <code>[[virsh change-media]]</code>
 
* <code>[[virsh change-media]]</code>
* <code>[[virsh create]] [[/MY_XML_VM_DEFINITION.XML/]]</code>
+
* <code>[[virsh create]] [[MY_XML_VM_DEFINITION.XML/]]</code>
* <code>[[virsh define]] [[/MY_XML_VM_DEFINITION.XML/]]</code> (define machine but do not start it)
+
* <code>[[virsh console]] YOUR_VM</code>
 +
* <code>[[virsh define]] [[MY_XML_VM_DEFINITION.XML]]</code> (define machine but do not start it)
 
** <code>[[virsh define]] xmlfile.xml --validate</code>
 
** <code>[[virsh define]] xmlfile.xml --validate</code>
 
** <code>[[virsh destroy]] VM_MACHINE_NAME </code> (Ungraceful Shutdown but do not destroy data or VM but you can corrupt guest file systems)
 
** <code>[[virsh destroy]] VM_MACHINE_NAME </code> (Ungraceful Shutdown but do not destroy data or VM but you can corrupt guest file systems)
Line 38: Line 41:
 
* <code>[[virsh dommemstat]]</code>
 
* <code>[[virsh dommemstat]]</code>
 
* <code>[[virsh domname]]</code>
 
* <code>[[virsh domname]]</code>
 +
* <code>[[virsh domrename]]</code> (since 2015)
 
* <code>virsh dump --memory-only --verbose</code>
 
* <code>virsh dump --memory-only --verbose</code>
 
* <code>[[virsh dumpxml]] VMNAME</code> - domain information in XML (Can be used to move VMs between hosts <ref>https://serverfault.com/questions/434064/correct-way-to-move-kvm-vm</ref>)
 
* <code>[[virsh dumpxml]] VMNAME</code> - domain information in XML (Can be used to move VMs between hosts <ref>https://serverfault.com/questions/434064/correct-way-to-move-kvm-vm</ref>)
Line 54: Line 58:
 
* <code>[[virsh reboot]]</code>
 
* <code>[[virsh reboot]]</code>
 
* <code>virsh restore</code>
 
* <code>virsh restore</code>
* <code>virsh resume</code>
+
* <code>[[virsh resume]]</code>
* <code>virsh save</code>
+
* <code>[[virsh save]]</code>
 
* <code>virsh set-lifecycle-action</code>. Added in November 2017 (v.3.9.0)<ref>https://libvirt.org/news.html</ref>
 
* <code>virsh set-lifecycle-action</code>. Added in November 2017 (v.3.9.0)<ref>https://libvirt.org/news.html</ref>
 
* <code>[[virsh setmaxmem]]</code>
 
* <code>[[virsh setmaxmem]]</code>
Line 64: Line 68:
 
* <code>[[virsh start]]</code>
 
* <code>[[virsh start]]</code>
 
* <code>[[virsh suspend]]</code>
 
* <code>[[virsh suspend]]</code>
* <code>virsh save</code>
 
 
* <code>[[virsh shutdown]]</code>
 
* <code>[[virsh shutdown]]</code>
 
* <code>[[virsh undefine]]</code>
 
* <code>[[virsh undefine]]</code>
Line 70: Line 73:
 
* <code>[[virsh vcpuinfo]]</code>
 
* <code>[[virsh vcpuinfo]]</code>
 
* <code>[[virsh vncdisplay]]</code>
 
* <code>[[virsh vncdisplay]]</code>
 +
* <code>[[virsh backup-begin]]</code>
 +
* <code>[[virsh checkpoint-create]]</code>
 +
* <code>[[virsh nodedev-list --tree]]</code>
 +
* <code>[[virsh nodedev-dumpxml]]</code>
 +
* <code>[[virsh nodedev-dettach]]</code>
  
 
== Getting Information ==
 
== Getting Information ==
Line 102: Line 110:
 
* <code>[[virsh vol-info]] <vol></code>
 
* <code>[[virsh vol-info]] <vol></code>
  
 +
[[Virsh display|Display info]]:
 +
* <code>[[virsh vncdisplay]] VM_NAME</code>
 +
* <code>[[virsh domdisplay]] VM_NAME</code>
  
 
Guest info:
 
Guest info:
Line 109: Line 120:
  
 
* <code>[[virsh version]]</code>
 
* <code>[[virsh version]]</code>
 +
 +
* <code>[[virsh capabilities]]</code>
  
 
== Operations ==
 
== Operations ==
Line 177: Line 190:
  
 
== See also ==
 
== See also ==
* <code>[[virtinst]]</code> package<ref>https://github.com/virt-manager/virt-manager/tree/master/virtinst</ref>, includes following python binaries: <code>virt-clone</code>, <code>virt-convert</code>, <code>[[virt-install]]</code><ref>https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_virtualization/getting-started-with-virtualization-in-rhel-8_configuring-and-managing-virtualization</ref>
+
* <code>[[virtinst]]</code> package<ref>https://github.com/virt-manager/virt-manager/tree/master/virtinst</ref>, includes following python binaries: <code>[[virt-clone]]</code>, <code>virt-convert</code>, <code>[[virt-install]]</code><ref>https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_virtualization/getting-started-with-virtualization-in-rhel-8_configuring-and-managing-virtualization</ref>
 
* [[virt-top]] 'top'-like utility for virtualization stats
 
* [[virt-top]] 'top'-like utility for virtualization stats
 
* [[ovirt-RHV module]]
 
* [[ovirt-RHV module]]
* [[KVM]] and [[libvirt]]
 
 
* [[virt-admin]]
 
* [[virt-admin]]
 +
* {{libvirtd}}
 +
* {{KVM}}
 +
* {{virsh}}
  
 
== References ==
 
== References ==

Latest revision as of 20:45, 26 May 2022

virsh[1][2] is a command line utility for managing virsh guest domains/virtual machines and the hypervisor[3]. Can be used to operate vm like create, list, start, shutdown or suspend and to manage storage, snapshots and checkpoints[4] among other actions. virt-manager is a graphical alternative to virsh. It supports Xen, QEMU, KVM, LXC, OpenVZ, VirtualBox and VMware ESX.

virsh is include in libvirt-client package in RHEL and Ubuntu and uses libvirt management API. Binaries included:

Basic Commands[edit]

  • virsh
  • virsh -r

All Commands[edit]

Getting Information[edit]

  • View configuration:
    • virsh dumpxml {guest-id, VM_NAME or uuid} > yourfilename.xml[14]
    • Virtual interfaces: virsh domiflist VM_NAME

Network info:

Storage info:

Display info:

Guest info:

Operations[edit]

Changing VM running status operations:

Snapshots:

Migrations:

  • virsh migrate --live GuestName DestinationURL
  • virsh migrate --offline[17] (copying non-shared storage or other file based storages (e.g. UEFI variable storage) is not supported during offline migration)

Configuration:

Virsh Storage commands[edit]

Virsh Storage Information[edit]

All Storage commands[edit]

Virsh Snapshots[edit]

Virsh CPU Commands[edit]

Virsh Memory Commands[edit]

virsh Memory Commands: virsh setmaxmem, virsh setmem, virsh dommemstat

QEMU[edit]

  • virsh qemu-attach QEMU Attach
  • virsh qemu-monitor-command QEMU Monitor Command
  • virsh qemu-monitor-event QEMU Monitor Events
    • virsh qemu-monitor-event VM_MACHINE_NAME
  • virsh qemu-agent-command QEMU Guest Agent Command

Networking[edit]

Activities[edit]

  1. Review virsh command cheatsheet https://computingforgeeks.com/virsh-commands-cheatsheet/
  2. Read https://github.com/libvirt/libvirt/blob/master/tools/virsh.c source code.
  3. Enable access to your VM Machines via virsh console command
  4. Learn difference between virsh define and virsh create
  5. Create Live backups with active virsh blockcommit[20]
  6. Offline Migrate or move a virtual machine between two KVM servers without shared storage[21]: virsh dumpxml and virsh define

See also[edit]

References[edit]

  1. http://manpages.ubuntu.com/manpages/xenial/man1/virsh.1.html
  2. https://github.com/libvirt/libvirt/blob/master/tools/virsh.c
  3. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/5/html/virtualization/chap-virtualization-managing_guests_with_virsh
  4. https://github.com/libvirt/libvirt/commit/689beaa47c51fb49fafa992dd468116b8f6b0782#diff-f41fa7374ab97c527387ea4ce48fd04e
  5. https://wiki.libvirt.org/page/Live-disk-backup-with-active-blockcommit
  6. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-using_the_qemu_guest_virtual_machine_agent_protocol_cli-libvirt_commands
  7. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-using_the_qemu_guest_virtual_machine_agent_protocol_cli-libvirt_commands
  8. https://serverfault.com/questions/434064/correct-way-to-move-kvm-vm
  9. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_virtualization/index#creating-storage-for-virtual-machines-using-the-cli_managing-storage-for-virtual-machines-using-the-cli
  10. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_virtualization/index#creating-storage-for-virtual-machines-using-the-cli_managing-storage-for-virtual-machines-using-the-cli
  11. https://libvirt.org/news.html
  12. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/5/html/virtualization/chap-virtualization-managing_guests_with_virsh
  13. https://help.ubuntu.com/community/KVM/Managing
  14. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/virtualization_deployment_and_administration_guide/sect-domain_commands-creating_a_virtual_machine_xml_dump_configuration_file
  15. https://fossies.org/linux/libvirt/NEWS
  16. https://libvirt.org/news.html
  17. https://libvirt.org/migration.html#offline
  18. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_virtualization/index#creating-storage-for-virtual-machines-using-the-cli_managing-storage-for-virtual-machines-using-the-cli
  19. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_virtualization/index#creating-storage-for-virtual-machines-using-the-cli_managing-storage-for-virtual-machines-using-the-cli
  20. https://wiki.libvirt.org/page/Live-disk-backup-with-active-blockcommit
  21. https://serverfault.com/questions/434064/correct-way-to-move-kvm-vm
  22. https://github.com/virt-manager/virt-manager/tree/master/virtinst
  23. https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/configuring_and_managing_virtualization/getting-started-with-virtualization-in-rhel-8_configuring-and-managing-virtualization

Script error: No such module "Check for unknown parameters".

Advertising: