Skip to content

Virsh Commands Implementation Tracker

YsuOS edited this page Oct 23, 2024 · 74 revisions

virsh v10.1.0

  • - means not-implement

  • Domain Management (help keyword 'domain'):

    • attach-device attach device from an XML file
    • attach-disk attach disk device
    • attach-interface attach network interface
    • autostart -> autostart/noautostart
    • blkdeviotune Set or query a block device I/O tuning parameters.
    • blkiotune Get or set blkio parameters
    • blockcommit Start a block commit operation.
    • blockcopy Start a block copy operation.
    • blockjob Manage active block operations
    • blockpull Populate a disk from its backing image.
    • blockresize Resize block device of domain.
    • change-media Change media of CD or floppy drive
    • console
    • cpu-stats show domain cpu statistics
    • create
    • define
    • desc -
    • destroy -> poweroff
    • detach-device detach device from an XML file
    • detach-device-alias detach device from an alias
    • detach-disk detach disk device
    • detach-interface detach network interface
    • domdisplay domain display connection URI
    • domfsfreeze Freeze domain's mounted filesystems.
    • domfsthaw Thaw domain's mounted filesystems.
    • domfsinfo Get information of domain's mounted filesystems.
    • domfstrim Invoke fstrim on domain's mounted filesystems.
    • domhostname -
    • domid
    • domif-setlink set link state of a virtual interface
    • domiftune get/set parameters of a virtual interface
    • domjobabort abort active domain job
    • domjobinfo domain job information
    • domlaunchsecinfo Get domain launch security info
    • domsetlaunchsecstate Set domain launch security state
    • domname convert a domain id or UUID to domain name
    • domrename rename a domain
    • dompmsuspend suspend a domain gracefully using power management functions
    • dompmwakeup wakeup a domain from pmsuspended state
    • domuuid
    • domxml-from-native -
    • domxml-to-native -
    • dump dump the core of a domain to a file for analysis
    • dumpxml
    • edit edit XML configuration for a domain
    • get-user-sshkeys list authorized SSH keys for given user (via agent)
    • inject-nmi Inject NMI to the guest
    • iothreadinfo view domain IOThreads
    • iothreadpin control domain IOThread affinity
    • iothreadadd add an IOThread to the guest domain
    • iothreadset modifies an existing IOThread of the guest domain
    • iothreaddel delete an IOThread from the guest domain
    • send-key Send keycodes to the guest
    • send-process-signal Send signals to processes
    • lxc-enter-namespace LXC Guest Enter Namespace
    • managedsave managed save of a domain state
    • managedsave-remove Remove managed save of a domain
    • managedsave-edit edit XML for a domain's managed save state file
    • managedsave-dumpxml Domain information of managed save state file in XML
    • managedsave-define redefine the XML for a domain's managed save state file
    • memtune Get or set memory parameters
    • perf Get or set perf event
    • metadata show or set domain's custom XML metadata
    • migrate migrate domain to another host
    • migrate-setmaxdowntime set maximum tolerable downtime
    • migrate-getmaxdowntime get maximum tolerable downtime
    • migrate-compcache get/set compression cache size
    • migrate-setspeed Set the maximum migration bandwidth
    • migrate-getspeed Get the maximum migration bandwidth
    • migrate-postcopy Switch running migration from pre-copy to post-copy
    • numatune Get or set numa parameters
    • qemu-attach QEMU Attach
    • qemu-monitor-command QEMU Monitor Command
    • qemu-monitor-event QEMU Monitor Events
    • qemu-agent-command QEMU Guest Agent Command
    • guest-agent-timeout Set the guest agent timeout
    • reboot
    • reset
    • restore restore a domain from a saved state in a file
    • resume
    • save save a domain state to a file
    • save-image-define redefine the XML for a domain's saved state file
    • save-image-dumpxml saved state domain information in XML
    • save-image-edit edit XML for a domain's saved state file
    • schedinfo show/set scheduler parameters
    • screenshot take a screenshot of a current domain console and store it into a file
    • set-lifecycle-action change lifecycle actions
    • set-user-sshkeys manipulate authorized SSH keys file for given user (via agent)
    • set-user-password set the user password inside the domain
    • setmaxmem change maximum memory limit
    • setmem change memory allocation
    • setvcpus change number of virtual CPUs
    • shutdown
    • start
    • suspend
    • ttyconsole tty console
    • undefine
    • update-device update device from an XML file
    • update-memory-device update memory device of a domain
    • vcpucount domain vcpu counts
    • vcpuinfo detailed domain vcpu information
    • vcpupin control or query domain vcpu affinity
    • emulatorpin control or query domain emulator affinity
    • vncdisplay vnc display
    • guestvcpus query or modify state of vcpu in the guest (via agent)
    • setvcpu attach/detach vcpu or groups of threads
    • domblkthreshold set the threshold for block-threshold event for a given block device or it's backing chain element
    • guestinfo query information about the guest (via agent)
    • domdirtyrate-calc Calculate a vm's memory dirty rate
    • dom-fd-associate associate a FD with a domain
  • Domain Monitoring (help keyword 'monitor'):

    • domblkerror Show errors on block devices
    • domblkinfo domain block device size information
    • domblklist list all domain blocks
    • domblkstat get device block stats for a domain
    • domcontrol domain control interface state
    • domif-getlink get link state of a virtual interface
    • domifaddr Get network interfaces' addresses for a running domain
    • domiflist list all domain virtual interfaces
    • domifstat get network interface stats for a domain
    • dominfo
    • dommemstat get memory statistics for a domain
    • domstate
    • domstats get statistics about one or multiple domains
    • domtime domain time
    • list
  • Domain Events (help keyword 'events'):

    • event Domain Events
  • Host and Hypervisor (help keyword 'host'):

    • allocpages - Manipulate pages pool size
    • capabilities - capabilities
    • cpu-baseline - compute baseline CPU
    • cpu-compare - compare host CPU with a CPU described by an XML file
    • cpu-models - CPU models
    • domcapabilities - domain capabilities
    • freecell - NUMA free memory
    • freepages - NUMA free pages
    • hostname
    • hypervisor-cpu-baseline - compute baseline CPU usable by a specific hypervisor
    • hypervisor-cpu-compare - compare a CPU with the CPU created by a hypervisor on the host
    • maxvcpus - connection vcpu maximum
    • node-memory-tune - Get or set node memory parameters
    • nodecpumap - node cpu map
    • nodecpustats - Prints cpu stats of the node.
    • nodeinfo -> hostinfo
    • nodememstats - Prints memory stats of the node.
    • nodesevinfo - node SEV information
    • nodesuspend - suspend the host node for a given time duration
    • sysinfo - print the hypervisor sysinfo
    • uri
    • version
  • Checkpoint (help keyword 'checkpoint'):

    • checkpoint-create - Create a checkpoint from XML
    • checkpoint-create-as -
    • checkpoint-delete - Delete a domain checkpoint
    • checkpoint-dumpxml - Dump XML for a domain checkpoint
    • checkpoint-edit - edit XML for a checkpoint
    • checkpoint-info - checkpoint information
    • checkpoint-list - List checkpoints for a domain
    • checkpoint-parent - Get the name of the parent of a checkpoint
  • Interface (help keyword 'interface'):

    • iface-begin - create a snapshot of current interfaces settings, which can be later committed (iface-commit) or restored (iface-rollback)
    • iface-bridge - create a bridge device and attach an existing network device to it
    • iface-commit - commit changes made since iface-begin and free restore point
    • iface-define - define an inactive persistent physical host interface or modify an existing persistent one from an XML file
    • iface-destroy - destroy a physical host interface (disable it / "if-down")
    • iface-dumpxml - interface information in XML
    • iface-edit - edit XML configuration for a physical host interface
    • iface-list - list physical host interfaces
    • iface-mac - convert an interface name to interface MAC address
    • iface-name - convert an interface MAC address to interface name
    • iface-rollback - rollback to previous saved configuration created via iface-begin
    • iface-start - start a physical host interface (enable it / "if-up")
    • iface-unbridge - undefine a bridge device after detaching its device(s)
    • iface-undefine - undefine a physical host interface (remove it from configuration)
  • Network Filter (help keyword 'filter'):

    • nwfilter-define - define or update a network filter from an XML file
    • nwfilter-dumpxml - network filter information in XML
    • nwfilter-edit - edit XML configuration for a network filter
    • nwfilter-list - list network filters
    • nwfilter-undefine - undefine a network filter
    • nwfilter-binding-create - create a network filter binding from an XML file
    • nwfilter-binding-delete - delete a network filter binding
    • nwfilter-binding-dumpxml - network filter information in XML
    • nwfilter-binding-list - list network filter bindings
  • Networking (help keyword 'network'):

    • net-autostart -> net-autostart/noautostart
    • net-create
    • net-define
    • net-desc -
    • net-destroy -> net-stop
    • net-dhcp-leases - print lease info for a given network
    • net-dumpxml
    • net-edit - edit XML configuration for a network
    • net-event - Network Events
    • net-info
    • net-list
    • net-metadata - show or set network's custom XML metadata
    • net-name -
    • net-start
    • net-undefine
    • net-update - update parts of an existing network's configuration
    • net-uuid
    • net-port-list -
    • net-port-create -
    • net-port-dumpxml -
    • net-port-delete -
  • Node Device (help keyword 'nodedev'):

    • nodedev-create - create a device defined by an XML file on the node
    • nodedev-destroy - destroy (stop) a device on the node
    • nodedev-detach - detach node device from its device driver
    • nodedev-dumpxml - node device details in XML
    • nodedev-list - enumerate devices on this host
    • nodedev-reattach - reattach node device to its device driver
    • nodedev-reset - reset node device
    • nodedev-event - Node Device Events
    • nodedev-define - Define or modify a device by an XML file on a node
    • nodedev-undefine - Undefine an inactive node device
    • nodedev-start - Start an inactive node device
    • nodedev-autostart - autostart a defined node device
    • nodedev-info - node device information
    • nodedev-update - Update an active and/or inactive node device
  • Secret (help keyword 'secret'):

    • secret-define - define or modify a secret from an XML file
    • secret-dumpxml - secret attributes in XML
    • secret-event - Secret Events
    • secret-get-value - Output a secret value
    • secret-list - list secrets
    • secret-set-value - set a secret value
    • secret-undefine - undefine a secret
  • Snapshot (help keyword 'snapshot'):

    • snapshot-create
    • snapshot-create-as -
    • snapshot-current
    • snapshot-delete
    • snapshot-dumpxml
    • snapshot-edit - edit XML for a snapshot
    • snapshot-info
    • snapshot-list
    • snapshot-parent
    • snapshot-revert
  • Backup (help keyword 'backup'):

    • backup-begin - Start a disk backup of a live domain
    • backup-dumpxml - Dump XML for an ongoing domain block backup job
  • Storage Pool (help keyword 'pool'):

    • find-storage-pool-sources-as - find potential storage pool sources
    • find-storage-pool-sources - discover potential storage pool sources
    • pool-autostart -> pool-autostart/pool-noautostart
    • pool-build - build a pool
    • pool-create-as -
    • pool-create
    • pool-define-as -
    • pool-define
    • pool-delete
    • pool-destroy -> pool-stop
    • pool-dumpxml
    • pool-edit - edit XML configuration for a storage pool
    • pool-info
    • pool-list
    • pool-name -
    • pool-refresh
    • pool-start
    • pool-undefine
    • pool-uuid
    • pool-event - Storage Pool Events
    • pool-capabilities - storage pool capabilities
  • Storage Volume (help keyword 'volume'):

    • vol-clone
    • vol-create-as -
    • vol-create
    • vol-create-from -
    • vol-delete
    • vol-download - download volume contents to a file
    • vol-dumpxml
    • vol-info
    • vol-key
    • vol-list
    • vol-name -
    • vol-path
    • vol-pool
    • vol-resize - resize a vol
    • vol-upload - upload file contents to a volume
    • vol-wipe
  • Virsh itself (help keyword 'virsh'):

    • cd -
    • echo -
    • exit -
    • help
    • pwd -
    • quit -
    • connect -

Clone this wiki locally