libvirt 0.8.7

Virsh Command Reference

Edition 0

Justin Clift

Red Hat, Inc. Emerging Technologies - Virtualization

jclift@redhat.com

Nikunj A. Dadhania

Graciously provided the content for the memtune page 

Linux Developer
IBM Corporation

nikunj@linux.vnet.ibm.com

Legal Notice

Copyright © 2011 Red Hat, Inc.

Copyright © 2009-2010 Red Hat, Inc. and others.

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. The original authors of this document, and Red Hat, designate the libvirt Project as the "Attribution Party" for purposes of CC-BY-SA. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

All other trademarks are the property of their respective owners.

Abstract

This book is a work in progress (recently begun), to comprehensively document each command available in virsh, the libvirt command shell.

Preface

1. Document Conventions

This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.

1.1. Typographic Conventions

Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.

Mono-spaced Bold

Used to highlight system input, including shell commands, file names and paths. Also used to highlight keycaps and key combinations. For example:

To see the contents of the file my_next_bestselling_novel in your current working directory, enter the cat my_next_bestselling_novel command at the shell prompt and press Enter to execute the command.

The above includes a file name, a shell command and a keycap, all presented in mono-spaced bold and all distinguishable thanks to context.

Key combinations can be distinguished from keycaps by the hyphen connecting each part of a key combination. For example:

Press Enter to execute the command.

Press Ctrl+Alt+F1 to switch to the first virtual terminal. Press Ctrl+Alt+F7 to return to your X-Windows session.

The first paragraph highlights the particular keycap to press. The second highlights two key combinations (each a set of three keycaps with each set pressed simultaneously).

If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in mono-spaced bold. For example:

File-related classes include filesystem for file systems, file for files, and dir for directories. Each class has its own associated set of permissions.

Proportional Bold

This denotes words or phrases encountered on a system, including application names; dialog box text; labeled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:

Choose System → Preferences → Mouse from the main menu bar to launch Mouse Preferences. In the Buttons tab, click the Left-handed mouse check box and click Close to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).

To insert a special character into a gedit file, choose Applications → Accessories → Character Map from the main menu bar. Next, choose Search → Find… from the Character Map menu bar, type the name of the character in the Search field and click Next. The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the Copy button. Now switch back to your document and choose Edit → Paste from the gedit menu bar.

The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all distinguishable by context.

Mono-spaced Bold Italic or Proportional Bold Italic

Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:

To connect to a remote machine using ssh, type ssh username@domain.name at a shell prompt. If the remote machine is example.com and your username on that machine is john, type ssh john@example.com.

The mount -o remount file-system command remounts the named file system. For example, to remount the /home file system, the command is mount -o remount /home.

To see the version of a currently installed package, use the rpm -q package command. It will return a result as follows: package-version-release.

Note the words in bold italics above — username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.

Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:

Publican is a DocBook publishing system.

1.2. Pull-quote Conventions

Terminal output and source code listings are set off visually from the surrounding text.

Output sent to a terminal is set in mono-spaced roman and presented thus:

books        Desktop   documentation  drafts  mss    photos   stuff  svn
books_tests  Desktop1  downloads      images  notes  scripts  svgs

Source-code listings are also set in mono-spaced roman but add syntax highlighting as follows:

package org.jboss.book.jca.ex1;

import javax.naming.InitialContext;

public class ExClient
{
   public static void main(String args[])
       throws Exception
   {
      InitialContext iniCtx = new InitialContext();
      Object         ref    = iniCtx.lookup("EchoBean");
      EchoHome       home   = (EchoHome) ref;
      Echo           echo   = home.create();

      System.out.println("Created Echo");

      System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
   }
}

1.3. Notes and Warnings

Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.

Note

Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.

Important

Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring a box labeled 'Important' won't cause data loss but may cause irritation and frustration.

Warning

Warnings should not be ignored. Ignoring warnings will most likely cause data loss.

2. We Need Feedback!

If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a bug report at http://libvirt.org/bugs.html

Chapter 1. Commands listed by group

These are the commands presently available in virsh.

Command | Availability | Description
attach-device | From libvirt 0.2.3 | Attach device from an XML file
attach-disk | From libvirt 0.3.0 | Attach disk device
attach-interface | From libvirt 0.3.0 | Attach network interface
autostart | From libvirt 0.2.1 | Enable and disable the automatic starting of a guest domain when the libvirt daemon starts
console | From libvirt 0.2.0 | Connect the virtual serial console for the guest
cpu-baseline | From libvirt 0.7.7 | Compute baseline CPU
cpu-compare | From libvirt 0.7.5 | Compare host CPU with a CPU described by an XML file
create | From libvirt 0.1.0 | Create a guest domain from an XML file
define | From libvirt 0.1.6 | Define, but don't start, a guest domain from an XML file
destroy | From libvirt 0.0.1 | Immediately terminates a running guest domain, releasing any resources in use by it
detach-device | From libvirt 0.2.3 | Detach a device from an XML file
detach-disk | From libvirt 0.3.0 | Detach a disk device
detach-interface | From libvirt 0.3.0 | Detach a network interface
domid | From libvirt 0.1.0 Prior to version 0.1.0, this command was known as idof | Convert a domain name or UUID to domain id
domjobabort | From libvirt 0.7.7 | Aborts the currently running guest domain job
domjobinfo | From libvirt 0.7.7 | Returns information about jobs running on a domain
domname | From libvirt 0.1.0 Prior to version 0.1.0, this command was known as nameof | Convert a guest domain id or UUID to guest domain name
domuuid | From libvirt 0.1.1 | Convert a guest domain name or id to guest domain UUID
domxml-from-native | From libvirt 0.6.4 | Convert native guest configuration format to domain XML format
domxml-to-native | From libvirt 0.6.4 | Convert guest domain XML config to a native guest configuration format
dump | From libvirt 0.1.9 | Core dump a guest domain
dumpxml | From libvirt 0.0.1 | Output the guest domain information as an XML dump to stdout
edit | From libvirt 0.4.6 | Edit the XML configuration for a guest domain
managedsave | From libvirt 0.8.0 | Save and destroy a running guest domain, so it can be restarted from the same state at a later time. When the virsh start command is next run for the guest domain, it will automatically be started from this saved state
managedsave-remove | From libvirt 0.8.3 | Remove an existing managed save state file from a guest domain
maxvcpus | From libvirt 0.8.5 | Show maximum number of virtual CPUs for guest domains on this connection
memtune | From libvirt 0.8.5 | Gets or sets the current memory parameters for a guest domain
migrate | From libvirt 0.3.2 | Migrates a guest domain to another host
migrate-setmaxdowntime | From libvirt 0.8.0 | Set maximum tolerable downtime of a guest domain which is being live-migrated to another host
reboot | From libvirt 0.1.0 | Run a reboot command in a guest domain
restore | From libvirt 0.0.2 | Restore a guest domain
resume | From libvirt 0.0.1 | Resume a guest domain
save | From libvirt 0.0.2 | Save the running state of a guest domain to a file
schedinfo | From libvirt 0.2.3 | Show or set scheduler parameters
setmaxmem | From libvirt 0.1.4 | Change the maximum memory allocation limit in the guest domain
setmem | From libvirt 0.1.4 | Change the current memory allocation in the guest domain
setvcpus | From libvirt 0.1.4 | Change the number of virtual CPUs in the guest domain
shutdown | From libvirt 0.0.1 | Run shutdown in a guest domain
start | From libvirt 0.1.6 | Start a guest domain, either from the last managedsave state, or via a fresh boot if no managedsave state is present
suspend | From libvirt 0.0.1 | Suspend a running guest domain
ttyconsole | From libvirt 0.3.2 | Output the device for the TTY console
undefine | From libvirt 0.1.6 | Remove the configuration for an inactive guest domain
update-device | From libvirt 0.8.0 | Update device from an XML file
vcpucount | From libvirt 0.8.5 | Returns the number of virtual CPUs used by a guest domain
vcpuinfo | From libvirt 0.1.4 | Returns basic information about a guest domains virtual CPUs
vcpupin | From libvirt 0.1.4 | Pin guest domain virtual CPUs to physical host CPUs
version | From libvirt 0.0.1 | Display the system version information
vncdisplay | From libvirt 0.2.0 | Output the IP address and port number for the VNC display

Table 1.1. Domain management commands

Command | Availability | Description
domblkinfo | From libvirt 0.8.1 | Get block device size info for a guest domain
domblkstat | From libvirt 0.3.2 | Get device block stats for a running guest domain
domifstat | From libvirt 0.3.2 | Get network interface stats for a running guest domain
dominfo | From libvirt 0.1.0 | Returns basic information about a guest domain
dommemstat | From libvirt 0.7.5 | Get memory statistics for a runnng guest domain
domstate | From libvirt 0.1.0 Prior to version 0.1.0, this command was known as dstate | Returns state about a guest domain
list | From libvirt 0.0.1 | Returns a list of guest domains

Table 1.2. Domain monitoring commands

Command | Availability | Description
capabilities | From libvirt 0.2.1 | Returns capabilities of hypervisor/driver
connect | From libvirt 0.0.1 | Connect to local hypervisor
freecell | From libvirt 0.3.3 | Display available free memory for a NUMA cell
hostname | From libvirt 0.3.0 | Display the name of the hypervisor host
nodeinfo | From libvirt 0.1.0 | Returns basic information about the node
qemu-monitor-command | From libvirt 0.8.6 | Qemu monitor command
uri | From libvirt 0.3.0 | Display the hypervisor canonical URI

Table 1.3. Host and hypervisor commands

Command | Availability | Description
iface-define | From libvirt 0.7.0 | Define a physical host network interface
iface-destroy | From libvirt 0.7.0 | Shut down and disable a physical host network interface
iface-dumpxml | From libvirt 0.7.0 | Output information for a physical host network interface, as an XML dump to stdout
iface-edit | From libvirt 0.7.0 | Edit the XML configuration for a physical host network interface
iface-list | From libvirt 0.7.0 | Returns a list of physical host network interfaces
iface-mac | From libvirt 0.7.0 | Returns the MAC address for a physical host network interface
iface-name | From libvirt 0.7.0 | Returns the physical host interface name for a MAC address
iface-start | From libvirt 0.7.0 | Enables and starts a physical host network interface
iface-undefine | From libvirt 0.7.0 | Removes the configuration information for a physical host network interface

Table 1.4. Interface commands

Command | Availability | Description
nwfilter-define | From libvirt 0.8.0 | Define a new network filter or update an existing one
nwfilter-dumpxml | From libvirt 0.8.0 | Output the network filter information as an XML dump to stdout
nwfilter-edit | From libvirt 0.8.0 | Edit the XML configuration for a network filter
nwfilter-list | From libvirt 0.8.0 | Returns the list of network filters
nwfilter-undefine | From libvirt 0.8.0 | Undefine a network filter

Table 1.5. Network filter commands

Command | Availability | Description
net-autostart | From libvirt 0.2.1 | Enable or disable the automatic starting of a virtual network, when the libvirt daemon starts
net-create | From libvirt 0.2.0 | Creates a new transient virtual network from an XML file
net-define | From libvirt 0.2.0 | Adds a new permanent virtual network from an XML file, without starting it
net-destroy | From libvirt 0.2.0 | Shuts down a running virtual network
net-dumpxml | From libvirt 0.2.0 | Displays the XML configuration for a virtual network (to stdout)
net-edit | From libvirt 0.4.6 | Allows the user to edit the XML configuration of a virtual network, using their preferred editor
net-info | From libvirt 0.8.6 | Displays basic information for a virtual network
net-list | From libvirt 0.2.0 | Lists the virtual networks libvirt is aware of
net-name | From libvirt 0.2.0 | When given a network UUID, returns its corresponding network name
net-start | From libvirt 0.2.0 | Starts a (previously defined) inactive virtual network
net-undefine | From libvirt 0.2.0 | Removes an inactive virtual network from the libvirt configuration
net-uuid | From libvirt 0.2.0 | When given a network name, returns its corresponding UUID

Table 1.6. (Virtual) Networking commands

Command | Availability | Description
nodedev-create | From libvirt 0.6.5 | Create a device on the physical host, which can then be assigned to a guest domain
nodedev-destroy | From libvirt 0.6.5 | Destroys a device on a physical host
nodedev-dettach | From libvirt 0.6.1 | Dettach a node device from its device driver before assigning to a guest domain
nodedev-dumpxml | From libvirt 0.5.0 | Output the details for a node device as an XML dump to stdout
nodedev-list | From libvirt 0.5.0 | Enumerate devices on the host
nodedev-reattach | From libvirt 0.6.1 | Reattach a node device to its device driver, once released by the guest domain
nodedev-reset | From libvirt 0.6.1 | Reset a node device before or after assigning to a domain

Table 1.7. Node device commands

Command | Availability | Description
secret-define | From libvirt 0.7.1 | Define or modify a secret
secret-dumpxml | From libvirt 0.7.1 | Output attributes of a secret as an XML dump to stdout
secret-get-value | From libvirt 0.7.1 | Output a secret value to stdout
secret-list | From libvirt 0.7.1 | Returns a list of secrets
secret-set-value | From libvirt 0.7.1 | Set a secret value
secret-undefine | From libvirt 0.7.1 | Undefine a secret

Table 1.8. Secrets, commands for managing them

Command | Availability | Description
snapshot-create | From libvirt 0.8.0 | Creates a snapshot of a domain
snapshot-current | From libvirt 0.8.0 | Gets the current snapshot for a domain
snapshot-delete | From libvirt 0.8.0 | Removes a snapshot, and all of it's children, from a domain
snapshot-dumpxml | From libvirt 0.8.0 | Displays the XML fragment for a domain snapshot
snapshot-list | From libvirt 0.8.0 | Lists the snapshots for a domain
snapshot-revert | From libvirt 0.8.0 | Reverts a domain to a given snapshot

Table 1.9. (Domain) Snapshot commands

Command | Availability | Description
find-storage-pool-sources | From libvirt 0.4.6 | Discover potential storage pool sources
find-storage-pool-sources-as | From libvirt 0.4.6 | Discover potential storage pool sources
pool-autostart | From libvirt 0.4.1 | Enable or disable the automatic starting of a storage pool, when the libvirt daemon starts
pool-build | From libvirt 0.4.1 | Build a storage pool
pool-create | From libvirt 0.4.1 | Create and start a transient storage pool, that will not persist across system restarts, using settings from an XML file
pool-create-as | From libvirt 0.4.1 | Create and start a transient storage pool, that will not persist across system restarts, using settings passed as options
pool-define | From libvirt 0.4.1 | Add a new persistent storage pool to the configuration, without starting it, using settings from an XML file
pool-define-as | From libvirt 0.4.1 | Add a new persistent storage pool to the configuration, without starting it, using settings passed as options
pool-delete | From libvirt 0.4.1 | Delete a storage pool
pool-destroy | From libvirt 0.4.1 | Shuts down a storage pool (from the libvirt point of view), releasing any resources in use by it
pool-dumpxml | From libvirt 0.4.1 | Displays the XML configuration for a storage pool (to stdout)
pool-edit | From libvirt 0.4.6 | Allows the user to edit the XML configuration of a storage pool, using their preferred editor
pool-info | From libvirt 0.4.1 | Returns basic information about a storage pool
pool-list | From libvirt 0.4.1 | Displays a list of the storage pools libvirt is aware of
pool-name | From libvirt 0.4.1 | When given a pool UUID, returns the name of the corresponding storage pool
pool-refresh | From libvirt 0.4.1 | Re-examines the storage in a storage pool, updating the internal list of volumes present and their details
pool-start | From libvirt 0.4.1 | Starts a (previously defined) inactive storage pool
pool-undefine | From libvirt 0.4.1 | Removes an inactive storage pool from the libvirt configuration
pool-uuid | From libvirt 0.4.1 | When given a storage pool name, returns the corresponding storage pool UUID

Table 1.10. Storage pool commands

Command | Availability | Description
vol-clone | From libvirt 0.6.4 | Copies an existing storage volume, including data, to a new storage volume
vol-create | From libvirt 0.4.1 | Creates a new storage volume, on a given storage pool, using settings from an XML file
vol-create-as | From libvirt 0.4.1 | Creates a new storage volume, on a given storage pool, using settings passed as options
vol-create-from | From libvirt 0.6.4 | Create a new storage volume from an existing storage volume
vol-delete | From libvirt 0.4.1 | Removes a storage volume from a storage pool
vol-dumpxml | From libvirt 0.4.1 | Displays the XML configuration for a storage volume, to stdout
vol-info | From libvirt 0.4.1 | Returns basic information about a storage volume
vol-key | From libvirt 0.4.1 | When given a storage volume name or path, returns the corresponding key for that volume
vol-list | From libvirt 0.4.1 | Displays a list of the storage volumes libvirt is aware of, in a given storage pool
vol-name | From libvirt 0.4.1 | When given a storage volume path or key, returns the corresponding name for that volume
vol-path | From libvirt 0.4.1 | When given a storage volume name or key, returns the corresponding path for that volume
vol-pool | From libvirt 0.8.2 | Returns the storage pool name or UUID for a given storage volume
vol-wipe | From libvirt 0.8.0 | Ensure data previously on a volume is not accessible to future reads

Table 1.11. Storage volume commands

Command | Availability | Description
cd | From libvirt 0.7.0 | Change the current directory
echo | From libvirt 0.8.5 | Echo back arguments, possibly with quoting
exit | From libvirt 0.8.0 | Quit this interactive terminal. Alternative name for the quit command, doing exactly the same thing.
help | From libvirt 0.0.1 | Prints global help, command specific help, or help for a group of related commands
pwd | From libvirt 0.7.0 | Displays the current directory
quit | From libvirt 0.0.1 | Quit this interactive terminal. Alternative name for the exit command, doing exactly the same thing.

Table 1.12. Virsh commands

Chapter 2. Index of commands

2.1. attach-device

Attach device from an XML file

Usage

attach-device

Options

Needs to be written

Availability

Available from libvirt 0.2.3 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.2. attach-disk

Attach disk device

Usage

attach-disk

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.3. attach-interface

Attach network interface

Usage

attach-interface

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.4. autostart

Enable and disable the automatic starting of a guest domain when the libvirt daemon starts

Usage

autostart

Options

Needs to be written

Availability

Available from libvirt 0.2.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.5. capabilities

Returns capabilities of hypervisor/driver

Usage

capabilities

Options

Needs to be written

Availability

Available from libvirt 0.2.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.6. cd

Change the current directory

Usage

cd

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.7. connect

Connect to local hypervisor

Usage

connect

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.8. console

Connect the virtual serial console for the guest

Usage

console

Options

Needs to be written

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.9. cpu-baseline

Compute baseline CPU

Usage

cpu-baseline

Options

Needs to be written

Availability

Available from libvirt 0.7.7 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.10. cpu-compare

Compare host CPU with a CPU described by an XML file

Usage

cpu-compare

Options

Needs to be written

Availability

Available from libvirt 0.7.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.11. create

Create a guest domain from an XML file

Usage

create

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.12. define

Define, but don't start, a guest domain from an XML file

Usage

define

Options

Needs to be written

Availability

Available from libvirt 0.1.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.13. destroy

Immediately terminates a running guest domain, releasing any resources in use by it

Usage

destroy

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.14. detach-device

Detach a device from an XML file

Usage

detach-device

Options

Needs to be written

Availability

Available from libvirt 0.2.3 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.15. detach-disk

Detach a disk device

Usage

detach-disk

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.16. detach-interface

Detach a network interface

Usage

detach-interface

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.17. domblkinfo

Get block device size info for a guest domain

Usage

domblkinfo

Options

Needs to be written

Availability

Available from libvirt 0.8.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.18. domblkstat

Get device block stats for a running guest domain

Usage

domblkstat

Options

Needs to be written

Availability

Available from libvirt 0.3.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.19. domid

Convert a domain name or UUID to domain id

Usage

domid

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Prior to version 0.1.0, this command was known as idof

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.20. domifstat

Get network interface stats for a running guest domain

Usage

domifstat

Options

Needs to be written

Availability

Available from libvirt 0.3.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.21. dominfo

Returns basic information about a guest domain

Usage

dominfo

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.22. domjobabort

Aborts the currently running guest domain job

Usage

domjobabort

Options

Needs to be written

Availability

Available from libvirt 0.7.7 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.23. domjobinfo

Returns information about jobs running on a domain

Usage

domjobinfo

Options

Needs to be written

Availability

Available from libvirt 0.7.7 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.24. dommemstat

Get memory statistics for a runnng guest domain

Usage

dommemstat

Options

Needs to be written

Availability

Available from libvirt 0.7.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.25. domname

Convert a guest domain id or UUID to guest domain name

Usage

domname

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Prior to version 0.1.0, this command was known as nameof

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.26. domstate

Returns state about a guest domain

Usage

domstate

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Prior to version 0.1.0, this command was known as dstate

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.27. domuuid

Convert a guest domain name or id to guest domain UUID

Usage

domuuid

Options

Needs to be written

Availability

Available from libvirt 0.1.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.28. domxml-from-native

Convert native guest configuration format to domain XML format

Usage

domxml-from-native

Options

Needs to be written

Availability

Available from libvirt 0.6.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.29. domxml-to-native

Convert guest domain XML config to a native guest configuration format

Usage

domxml-to-native

Options

Needs to be written

Availability

Available from libvirt 0.6.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.30. dump

Core dump a guest domain

Usage

dump

Options

Needs to be written

Availability

Available from libvirt 0.1.9 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.31. dumpxml

Output the guest domain information as an XML dump to stdout

Usage

dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.32. echo

Echo back arguments, possibly with quoting

Usage

echo

Options

Needs to be written

Availability

Available from libvirt 0.8.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.33. edit

Edit the XML configuration for a guest domain

Usage

edit

Options

Needs to be written

Availability

Available from libvirt 0.4.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.34. exit

Quit this interactive terminal. Alternative name for the quit command, doing exactly the same thing.

Usage

exit

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.35. find-storage-pool-sources-as

Discover potential storage pool sources

Usage

find-storage-pool-sources-as

Options

Needs to be written

Availability

Available from libvirt 0.4.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.36. find-storage-pool-sources

Discover potential storage pool sources

Usage

find-storage-pool-sources

Options

Needs to be written

Availability

Available from libvirt 0.4.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.37. freecell

Display available free memory for a NUMA cell

Usage

freecell

Options

Needs to be written

Availability

Available from libvirt 0.3.3 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.38. help

Prints global help, command specific help, or help for a group of related commands

Usage

help

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.39. hostname

Display the name of the hypervisor host

Usage

hostname

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.40. iface-define

Define a physical host network interface

Usage

iface-define

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.41. iface-destroy

Shut down and disable a physical host network interface

Usage

iface-destroy

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.42. iface-dumpxml

Output information for a physical host network interface, as an XML dump to stdout

Usage

iface-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.43. iface-edit

Edit the XML configuration for a physical host network interface

Usage

iface-edit

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.44. iface-list

Returns a list of physical host network interfaces

Usage

iface-list

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.45. iface-mac

Returns the MAC address for a physical host network interface

Usage

iface-mac

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.46. iface-name

Returns the physical host interface name for a MAC address

Usage

iface-name

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.47. iface-start

Enables and starts a physical host network interface

Usage

iface-start

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.48. iface-undefine

Removes the configuration information for a physical host network interface

Usage

iface-undefine

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.49. list

Returns a list of guest domains

Usage

list

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.50. managedsave-remove

Remove an existing managed save state file from a guest domain

Usage

managedsave-remove

Options

Needs to be written

Availability

Available from libvirt 0.8.3 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.51. managedsave

Save and destroy a running guest domain, so it can be restarted from the same state at a later time. When the virsh start command is next run for the guest domain, it will automatically be started from this saved state

Usage

managedsave

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.52. maxvcpus

Show maximum number of virtual CPUs for guest domains on this connection

Usage

maxvcpus

Options

Needs to be written

Availability

Available from libvirt 0.8.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.53. memtune

Allows you to display or set the memory parameters for a guest domain

Usage

memtune --domain domain-identifier --hard-limit kb --soft-limit kb --swap-hard-limit kb --min-guarantee kb

Options

Name | Required? | Description
--domain domain-identifier | required | The name, id, or UUID of the guest domain The word "--domain" itself is optional.
--hard-limit kb | optional | Maximum memory the guest domain can use, in kilobytes. QEMU and LXC only.
--soft-limit kb | optional | Minimum memory guaranteed for the guest domain during contention, in kilobytes. QEMU and LXC only.
--swap-hard-limit kb | optional | Maximum swap memory the guest domain can use, in kilobytes. QEMU and LXC only.
--min-guarantee kb | optional | Minimum amount of memory required to start a guest domain, in kilobytes. VMware ESX and vSphere only.

Table 2.1. Options

Availability

Available from libvirt 0.8.5 onwards

Platform or Hypervisor specific notes

QEMU and LXC

The --hard-limit, --soft-limit, and --swap-hard-limit parameters are only used by QEMU and LXC.

VMware ESX and vSphere

The --min-guarantee parameter is only used by VMware ESX and vSphere.

Examples

Without flags the current settings are displayed:

virsh # memtune domain-id

This command sets the memory hard limit:

virsh # memtune domain-id --hard-limit kilobytes

This command sets the memory soft limit:

virsh # memtune domain-id --soft-limit kilobytes

This command sets the swap hard limit:

virsh # memtune domain-id --swap-hard-limit kilobytes

Adding the following lines to a guest domain xml file will set the given values for the memory tunables:

<memtune>
  <hard_limit>131072</hard_limit>
  <soft_limit>65536</soft_limit>
  <swap_hard_limit>262144</swap_hard_limit>
</memtune>

Example in context

We run the memtune command giving only a guest domain first, to see what the present values for the domain are:

virsh # memtune lxcbb1
hard_limit     : 131072
soft_limit     : 65536
swap_hard_limit: 262144

This shows the value for hard_limit is 131072, which means 128MB of memory. To change it to 256MB, we run the memtune command again giving it the new value (256 x 1024 = 262144):

virsh # memtune lxcbb1 --hard-limit 262144

Then verify the change has taken effect:

virsh # memtune lxcbb1
hard_limit     : 262144
soft_limit     : 65536
swap_hard_limit: 262144

See also

http://www.libvirt.org/formatdomain.html#elementsResources - Gives the details of the XML needed by memtune.

2.54. migrate-setmaxdowntime

Set maximum tolerable downtime of a guest domain which is being live migrated to another host

Usage

migrate-setmaxdowntime

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.55. migrate

Migrates a guest domain to another host

Usage

migrate

Options

Needs to be written

Availability

Available from libvirt 0.3.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.56. net-autostart

Enables or disables the automatic startup of a persistent virtual network, by the libvirt daemon.

Usage

net-autostart --network network-identifier --disable

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID for the virtual network being configured. The word "--network" itself is optional.
--disable  | optional | Disables the automatic starting of the virtual network.

Table 2.2. Options

Availability

Available from libvirt 0.2.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-autostart default --disable

Stops the virtual network named "default" from automatically starting when the libvirt daemon starts.

virsh # net-autostart --network default --disable

Same as the above example.

virsh # net-autostart bfbc4c69-7d6a-cc9a-904c-09910ce179c0 --disable

Stops the virtual network with UUID "bfbc4c69-7d6a-cc9a-904c-09910ce179c0" from automatically starting when the libvirt daemon starts.

virsh # net-autostart --network bfbc4c69-7d6a-cc9a-904c-09910ce179c0 --disable

Same as the above example.

virsh # net-autostart default

Enables the automatic starting of the virtual network named "default", by the libvirt daemon when it starts.

virsh # net-autostart --network default

Same as the above example.

Example in context

Starting with an XML file we've already created, using the required XML format:

<network>
  <name>examplenetwork</name>
  <bridge name="virbr100" />
  <forward mode="route" />
  <ip address="10.10.120.1" netmask="255.255.255.0" />
</network>

# ls -al /root/examplenetwork.xml
-rw-r--r--. 1 root root 162 Nov  7 16:43 /root/examplenetwork.xml

We start virsh interactively, then define a persistent virtual network:

# virsh
Welcome to virsh, the virtualization interactive terminal.

Type:  'help' for help with commands
       'quit' to quit

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes

virsh # net-define /root/examplenetwork.xml
Network examplenetwork defined from /root/examplenetwork.xml

Newly defined virtual networks aren't set to automatically be started, as can be seen here:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   no    <-- this is the important piece

We enable automatic starting for it:

virsh # net-autostart examplenetwork
Network examplenetwork marked as autostarted

Checking, to make sure:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   yes    <-- this is the important piece

From now on, whenever the libvirt daemon is started, it will automatically start this virtual network too (unless it's already running). If at some point we want to turn off automatic starting of the virtual network, we use the --disable option to the command:

# net-autostart --disable examplenetwork
Network examplenetwork unmarked as autostarted

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   no    <-- this is the important piece

See also

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout.

net-list - Lists the virtual networks libvirt is aware of.

2.57. net-create

Creates a running, transient virtual network, using settings from an XML file.

Usage

net-create --file file-name

Options

Name | Required? | Description
--file file-name | required | The full path (and file name) to an XML file containing the network settings required. The word "--file" itself is optional.

Table 2.3. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-create /root/examplenetwork.xml

Creates a new, transient, virtual network using the settings from /root/examplenetwork.xml.

virsh # net-create --file /root/examplenetwork.xml

Same as the above example.

Example in context

Starting with an XML file we've already created, using the required XML format:

<network>
  <name>examplenetwork</name>
  <bridge name="virbr100" />
  <forward mode="route" />
  <ip address="10.10.120.1" netmask="255.255.255.0" />
</network>

# ls -al /root/examplenetwork.xml
-rw-r--r--. 1 root root 162 Nov  7 16:43 /root/examplenetwork.xml

We start virsh interactively, then create the transient virtual network:

# virsh
Welcome to virsh, the virtualization interactive terminal.

Type:  'help' for help with commands
       'quit' to quit

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes

virsh # net-create /root/examplenetwork.xml
Network examplenetwork created from /root/examplenetwork.xml

Created. Now we confirm:

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     no

We check the details of the created network from virsh. This shows us the generated UUID, and anything else that may be in effect (ie Spanning Tree Protocol).

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>97ce3914-231e-4026-0a78-822e1e2e7226</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

Then, after exiting virsh, we check how it appears to the host Linux OS:

# ifconfig virbr100
virbr100  Link encap:Ethernet  HWaddr 02:95:C3:06:A5:BF
          inet addr:10.10.120.1  Bcast:10.10.120.255  Mask:255.255.255.0
          UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:11 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:0
          RX bytes:0 (0.0 b)  TX bytes:2653 (2.5 KiB)

See also

net-define - An alternative to net-create. Use this when you want a persistent virtual network that will last through reboots and shutdowns, rather than a transient one created using net-create.

net-destroy - Shuts down a running virtual network, as started with net-create or net-start.

http://libvirt.org/formatnetwork.html - Gives the details of the XML needed by net-create.

2.58. net-define

Adds a new persistent virtual network to libvirt, without starting it, using settings from an XML file.

You will need to manually start this virtual network when needed using net-start, unless you enable automatic starting for it. If you enable automatic starting, the virtual network will be started when the libvirt daemon starts.

To enable automatic starting of this virtual network, use the net-autostart command.

Usage

net-define --file file-name

Options

Name | Required? | Description
--file file-name | required | The full path (and file name) to an XML file containing the network settings required. The word "--file" itself is optional.

Table 2.4. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-define /root/examplenetwork.xml

Creates a new, persistent, virtual network using the settings from the XML file /root/examplenetwork.xml.

virsh # net-define --file /root/examplenetwork.xml

Same as the above example.

Example in context

Starting with an XML file we've already created, using the required XML format:

<network>
  <name>examplenetwork</name>
  <bridge name="virbr100" />
  <forward mode="route" />
  <ip address="10.10.120.1" netmask="255.255.255.0" />
</network>

# ls -al /root/examplenetwork.xml
-rw-r--r--. 1 root root 162 Nov  7 16:43 /root/examplenetwork.xml

We start virsh interactively, then create the transient virtual network:

# virsh
Welcome to virsh, the virtualization interactive terminal.

Type:  'help' for help with commands
       'quit' to quit

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes

virsh # net-define /root/examplenetwork.xml
Network examplenetwork defined from /root/examplenetwork.xml

Defined. Now we confirm:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   no

Newly defined virtual networks aren't automatically started, so we manually start it now:

virsh # net-start examplenetwork
Network examplenetwork started

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     no

We check the details of the started network from virsh. This shows us the generated UUID, and anything else that may be in effect (ie Spanning Tree Protocol).

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>97ce3914-231e-4026-0a78-822e1e2e7226</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

If the virtualisation server is running Linux, we can check how it appears to the host OS:

# ifconfig virbr100
virbr100  Link encap:Ethernet  HWaddr A6:45:97:AE:8E:08
          inet addr:10.10.120.1  Bcast:10.10.120.255  Mask:255.255.255.0
          UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:11 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:0
          RX bytes:0 (0.0 b)  TX bytes:2653 (2.5 KiB)

See also

net-autostart - Used to enable and disable the automatic starting of a virtual network.

net-create - An alternative to net-define. Use this when you want a transient virtual network that will disappear when the host is rebooted or shutdown, rather than a persistent one created using net-define.

net-destroy - Shuts down a running virtual network, as started with net-create or net-start.

net-start - Manually starts a virtual network that isn't running.

http://libvirt.org/formatnetwork.html - Gives the details of the XML needed by net-define.

2.59. net-destroy

Shuts down a virtual network, releasing any resources in use by it.

Usage

net-destroy --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the network to be shut down. The word "--network" itself is optional.

Table 2.5. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

Linux

If the virtualisation host is running Linux, the name the operating system uses for the network interface can be found using the net-dumpxml virsh command.

Look for the name value of the bridge line. virbr100 in this instance:

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

Using ifconfig, or a similar tool such as ip, the virbr100 interface will be seen on the host when the virtual network is running:

# ifconfig virbr100
virbr100  Link encap:Ethernet  HWaddr D2:43:D9:47:FA:AA
inet addr:10.10.120.1  Bcast:10.10.120.255  Mask:255.255.255.0
UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
RX packets:0 errors:0 dropped:0 overruns:0 frame:0
TX packets:7 errors:0 dropped:0 overruns:0 carrier:0
collisions:0 txqueuelen:0
RX bytes:0 (0.0 b)  TX bytes:1553 (1.5 KiB)

After shutting down a virtual network with the net-destroy command, the Linux OS will no longer show this interface:

# ifconfig virbr100
virbr100: error fetching interface information: Device not found

Examples

virsh # net-destroy mynetwork

Shuts down the virtual network named "mynetwork".

virsh # net-destroy --network mynetwork

Same as the above example.

virsh # net-destroy bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Shuts down the virtual network that has a UUID of "bfbc4c69-7d6a-cc9a-904c-09910ce179c0".

virsh # net-destroy --network bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Same as the above example.

Example in context

Starting with a virtual network named examplenetwork, already running on a virtualisation host server:

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     yes

The network is shut down by simply using the net-destroy command on it:

# net-destroy examplenetwork
Network examplenetwork destroyed

The command now shows it as inactive:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   yes

See also

net-create - Creates a running, transient virtual network, using settings from an XML file.

net-list - Displays a list of the virtual networks libvirt is aware of.

net-start - Manually starts a virtual network that isn't running.

2.60. net-dumpxml

Outputs the XML configuration for a virtual network, to stdout.

Usage

net-dumpxml --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the network whose XML configuration is to be displayed. The word "--network" itself is optional.

Table 2.6. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-dumpxml mynetwork

Outputs the XML configuration for the virtual network named "mynetwork".

virsh # net-dumpxml --network mynetwork

Same as the above example.

virsh # net-dumpxml bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Outputs the XML configuration for the virtual network that has a UUID of "bfbc4c69-7d6a-cc9a-904c-09910ce179c0".

virsh # net-dumpxml --network bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Same as the above example.

Example in context

Starting with a few virtual networks already defined:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     no

We use net-dumpxml to look at the XML configuration for "examplenetwork":

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

Done.

See also

net-list - Displays a list of the virtual networks libvirt is aware of.

2.61. net-edit

Allows the user to edit the XML configuration of a virtual network, using their preferred editor.

net-edit launches the command (or script) is defined in the users $EDITOR environment variable, passing it a temporary copy of the XML configuration for the virtual network.

When the user exits the editor, net-edit checks if the temporary file was changed.

If it was, then net-edit validates it to ensure it's error free. If no errors are found, net-edit then overwrites the existing saved virtual network configuration using it.

Usage

net-edit --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the virtual network whose XML configuration is to be edited. The word "--network" itself is optional.

Table 2.7. Options

Availability

Available from libvirt 0.4.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-edit mynetwork

Edits the XML configuration for the virtual network named "mynetwork".

virsh # net-edit --network mynetwork

Same as the above example.

virsh # net-edit bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Edits the XML configuration for the virtual network having UUID "bfbc4c69-7d6a-cc9a-904c-09910ce179c0".

virsh # net-edit --network bfbc4c69-7d6a-cc9a-904c-09910ce179c0

Same as the above example.

Example in context

Starting with a few virtual networks already defined:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     no

We use net-dumpxml to view the XML configuration for "examplenetwork":

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

We want to change one of the values, for example, the Spanning Tree Protocol delay of 0. Let's say want it to be 30 (seconds) instead.

Using net-edit, we launch an editor on the XML fragment. (vi is the editor shown):

virsh # net-edit examplenetwork

The editor window appears, and we make the change directly:

<network>
  <name>examplenetwork</name>
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='30' />      <-- changed to 30 here
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>
~
~
~
~
~
~
"/tmp/virsht2UZ6L" 8L, 238C

Then save the (temporary) file and exit the editor. net-edit automatically copies the temporary XML to the saved configuration, if no errors in it were detected.

Network examplenetwork XML configuration edited.

The next time the "examplenetwork" virtual network is started, it will use the new value.

See also

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout.

net-list - Displays a list of the virtual networks libvirt is aware of.

2.62. net-info

Displays basic information for a virtual network.

Usage

net-info --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the virtual network to display information for. The word "--network" itself is optional.

Table 2.8. Options

Availability

Available from libvirt 0.8.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-info default
Name            default
UUID            1c42888c-82c9-4dda-bc9c-4387962a0c0e
Active:         yes
Persistent:     yes
Autostart:      yes
Bridge: virbr0

Displays basic information for the virtual network named "default".

If the host server is running Linux, then the Bridge field gives the name of the Linux network bridge being for the virtual network.

virsh # net-info --network default
Name            default
UUID            1c42888c-82c9-4dda-bc9c-4387962a0c0e
Active:         yes
Persistent:     yes
Autostart:      yes
Bridge:         virbr0

Same as the above example.

Example in context

We begin with an existing virtual network, running on the host:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes

The virtual network "default" is active and enabled for automatic starting.

We use the net-info command to display further details:

# net-info default
Name            default
UUID            1c42888c-82c9-4dda-bc9c-4387962a0c0e
Active:         yes
Persistent:     yes
Autostart:      yes
Bridge:         virbr0

Some of the same information can also be retrieved using the net-dumpxml command, then looking through the output:

virsh # net-dumpxml default
<network>
  <name>default</name>
  <uuid>1c42888c-82c9-4dda-bc9c-4387962a0c0e</uuid>
  <forward mode='nat'/>
  <bridge name='virbr0' stp='on' delay='0' />
  <ip address='192.168.122.1' netmask='255.255.255.0'>
    <dhcp>
      <range start='192.168.122.2' end='192.168.122.254' />
    </dhcp>
  </ip>
</network>

See also

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout

net-list - Lists the virtual networks libvirt is aware of

2.63. net-list

Lists the virtual networks libvirt is aware of, along with basic status and autostart information.

Used without parameters, net-list displays information for only active virtual networks.

Usage

net-list --all --inactive

Options

Name | Required? | Description
--all  | optional | Instructs net-list to display both active and inactive virtual networks.
--inactive  | optional | Instructs net-list to only display inactive virtual networks.

Table 2.9. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-list

Displays the active libvirt virtual networks.

virsh # net-list --all

Displays all virtual networks libvirt knows of, both active and inactive.

virsh # net-list --inactive

Displays only the inactive libvirt virtual networks.

Example in context

Displaying all of the libvirt virtual networks on a host:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes      <-- this is a virtual network
examplenetwork       inactive   no       <-- this is a virtual network

See also

net-autostart - Used to enable and disable the automatic starting of a virtual network.

net-destroy - Shuts down a running virtual network, as started with net-create or net-start.

net-start - Manually starts a virtual network that isn't running.

2.64. net-name

When given a virtual network UUID, returns its corresponding virtual network name.

Usage

net-name --network network-UUID

Options

Name | Required? | Description
--network network-UUID | required | The UUID of the virtual network you want the name for. The word "--network" itself is optional.

Table 2.10. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-name b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Returns the name of the virtual network having a UUID of "b7005dec-be1a-fe9a-338a-0cb1301dfcfd".

virsh # net-name --network b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Same as the above example.

Example in context

Given a virtual network UUID, we can determine which virtual network it belongs to:

virsh # net-name b7005dec-be1a-fe9a-338a-0cb1301dfcfd
examplenetwork

We can confirm by using the net-dumpxml command on the returned network name:

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>                        <-- the name is here
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>  <-- the UUID is here
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='1' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

Using net-name is more efficient than dumping the XML for the virtual network and manually extracting the name value.

See also

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout

2.65. net-start

Starts an inactive, previously defined, virtual network.

Usage

net-start --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the virtual network to start. The word "--network" itself is optional.

Table 2.11. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-start examplenetwork

Starts the virtual network named "examplenetwork".

virsh # net-start --network examplenetwork

Same as the above example.

virsh # net-start b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Starts the virtual network that has a UUID of "b7005dec-be1a-fe9a-338a-0cb1301dfcfd".

virsh # net-start --network b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Same as the above example.

Example in context

Starting with an XML file we've already created, using the required XML format:

<network>
  <name>examplenetwork</name>
  <bridge name="virbr100" />
  <forward mode="route" />
  <ip address="10.10.120.1" netmask="255.255.255.0" />
</network>

# ls -al /root/examplenetwork.xml
-rw-r--r--. 1 root root 162 Nov  7 16:43 /root/examplenetwork.xml

We start virsh interactively, then define a persistent virtual network using the XML file:

# virsh
Welcome to virsh, the virtualization interactive terminal.

Type:  'help' for help with commands
       'quit' to quit

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes

virsh # net-define /root/examplenetwork.xml
Network examplenetwork defined from /root/examplenetwork.xml

Defined. Now we confirm:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       inactive   no    <-- new persistent networks start out inactive

Newly defined virtual networks aren't automatically started, so we manually start it now:

virsh # net-start examplenetwork      <-- this is net-start in action
Network examplenetwork started

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     no       <-- the persistent network is now running (active)

We check the details of the started network from virsh, using net-dumpxml. This shows us the name of the bridge network interface.

virsh # net-dumpxml examplenetwork
<network>
  <name>examplenetwork</name>
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid>
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='0' />      <-- the "virbr100" here
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

If the virtualisation server is running Linux, we can check how the bridge interface appears to the host OS:

# ifconfig virbr100
virbr100  Link encap:Ethernet  HWaddr A6:45:97:AE:8E:08
          inet addr:10.10.120.1  Bcast:10.10.120.255  Mask:255.255.255.0
          UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
          RX packets:0 errors:0 dropped:0 overruns:0 frame:0
          TX packets:11 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:0
          RX bytes:0 (0.0 b)  TX bytes:2653 (2.5 KiB)

See also

net-define - Adds a new persistent virtual network to libvirt, without starting it, using settings from an XML file.

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout

net-list - Displays a list of the virtual networks libvirt is aware of.

2.66. net-undefine

Removes an inactive virtual network from the libvirt configuration.

Usage

net-undefine --network network-identifier

Options

Name | Required? | Description
--network network-identifier | required | The name or UUID of the virtual network to remove. The word "--network" itself is optional.

Table 2.12. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-undefine examplenetwork

Undefines the virtual network named "examplenetwork".

virsh # net-undefine --network examplenetwork

Same as the above example.

virsh # net-undefine b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Undefines the virtual network having a UUID of "b7005dec-be1a-fe9a-338a-0cb1301dfcfd".

virsh # net-undefine --network b7005dec-be1a-fe9a-338a-0cb1301dfcfd

Same as the above example.

Example in context

Starting with a virtual network named examplenetwork, already running on a virtualisation host server:

virsh # net-list
Name                 State      Autostart
-----------------------------------------
default              active     yes
examplenetwork       active     yes

The virtual network is running (active), so we need to shut it down before removing it. We use the net-destroy command to shut it down:

# net-destroy examplenetwork
Network examplenetwork destroyed

Then remove it using net-undefine:

virsh # net-undefine examplenetwork       <-- this is net-undefine in action
Network examplenetwork has been undefined

Done. The net-list command no longer shows it listed:

virsh # net-list --all
Name                 State      Autostart
-----------------------------------------
default              active     yes

See also

net-define - Adds a new persistent virtual network to libvirt, without starting it, using settings from an XML file.

net-destroy - Shuts down a running virtual network, as started with net-create or net-start.

net-list - Displays a list of the virtual networks libvirt is aware of.

2.67. net-uuid

When given a network name, returns its corresponding UUID.

Usage

net-uuid --network network-name

Options

Name | Required? | Description
--network network-name | required | The name of the virtual network you want the UUID for. The word "--network" itself is optional.

Table 2.13. Options

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

virsh # net-uuid mynetwork
fa3642ab-e113-7eaa-528f-14ed78bca20

Returns the UUID of the virtual network named "mynetwork".

virsh # net-uuid --network mynetwork
fa3642ab-e113-7eaa-528f-14ed78bca20

Same as the previous example.

Example in context

Given a virtual network name, we can get its UUID:

virsh # net-uuid examplenetwork
bfbc4c69-7d6a-cc9a-904c-09910ce179c0

We can confirm by using the net-dumpxml command on the returned network UUID:

virsh # net-dumpxml bfbc4c69-7d6a-cc9a-904c-09910ce179c0
<network>
  <name>examplenetwork</name><-- the name is here
  <uuid>b7005dec-be1a-fe9a-338a-0cb1301dfcfd</uuid><-- the UUID is here
  <forward mode='route'/>
  <bridge name='virbr100' stp='on' delay='1' />
  <ip address='10.10.120.1' netmask='255.255.255.0'>
  </ip>
</network>

Using net-uuid is more efficient than dumping the XML for the virtual network and manually extracting the uuid value.

See also

net-dumpxml - Outputs the XML configuration for a virtual network, to stdout

net-list - Lists the virtual networks libvirt is aware of

2.68. nodedev-create

Create a device on the physical host, which can then be assigned to a guest domain

Usage

nodedev-create

Options

Needs to be written

Availability

Available from libvirt 0.6.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.69. nodedev-destroy

Destroys a device on a physical host

Usage

nodedev-destroy

Options

Needs to be written

Availability

Available from libvirt 0.6.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.70. nodedev-dettach

Detach a node device from its device driver before assigning to a guest domain

Usage

nodedev-dettach

Options

Needs to be written

Availability

Available from libvirt 0.6.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.71. nodedev-dumpxml

Output the details for a node device as an XML dump to stdout

Usage

nodedev-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.5.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.72. nodedev-list

Enumerate devices on the host

Usage

nodedev-list

Options

Needs to be written

Availability

Available from libvirt 0.5.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.73. nodedev-reattach

Reattach a node device to its device driver, once released by the guest domain

Usage

nodedev-reattach

Options

Needs to be written

Availability

Available from libvirt 0.6.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.74. nodedev-reset

Reset a node device before or after assigning to a domain

Usage

nodedev-reset

Options

Needs to be written

Availability

Available from libvirt 0.6.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.75. nodeinfo

Returns basic information about the node

Usage

nodeinfo

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.76. nwfilter-define

Define a new network filter or update an existing one

Usage

nwfilter-define

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.77. nwfilter-dumpxml

Output the network filter information as an XML dump to stdout

Usage

nwfilter-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.78. nwfilter-edit

Edit the XML configuration for a network filter

Usage

nwfilter-edit

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.79. nwfilter-list

Returns the list of network filters

Usage

nwfilter-list

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.80. nwfilter-undefine

Undefine a network filter

Usage

nwfilter-undefine

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.81. pool-autostart

Enable or disable the automatic starting of a storage pool, when the libvirt daemon starts

Usage

pool-autostart

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.82. pool-build

Build a storage pool

Usage

pool-build

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.83. pool-create-as

Create and start a transient storage pool, that will not persist across system restarts, using settings passed as options

Usage

pool-create-as

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.84. pool-create

Create and start a transient storage pool, that will not persist across system restarts, using settings from an XML file

Usage

pool-create

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.85. pool-define-as

Add a new persistent storage pool to the configuration, without starting it, using settings passed as options

Usage

pool-define-as

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.86. pool-define

Add a new persistent storage pool to the configuration, without starting it, using settings from an XML file

Usage

pool-define

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.87. pool-delete

Delete a storage pool

Usage

pool-delete

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.88. pool-destroy

Shuts down a storage pool (from the libvirt point of view), releasing any resources in use by it

Usage

pool-destroy

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.89. pool-dumpxml

Displays the XML configuration for a storage pool (to stdout)

Usage

pool-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.90. pool-edit

Allows the user to edit the XML configuration of a storage pool, using their preferred editor

Usage

pool-edit

Options

Needs to be written

Availability

Available from libvirt 0.4.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.91. pool-info

Returns basic information about a storage pool

Usage

pool-info

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.92. pool-list

Displays a list of the storage pools libvirt is aware of

Usage

pool-list

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.93. pool-name

When given a pool UUID, returns the name of the corresponding storage pool

Usage

pool-name

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.94. pool-refresh

Re-examines the storage in a storage pool, updating the internal list of volumes present and their details

Usage

pool-refresh

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.95. pool-start

Starts a (previously defined) inactive storage pool

Usage

pool-start

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.96. pool-undefine

Removes an inactive storage pool from the libvirt configuration

Usage

pool-undefine

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.97. pool-uuid

When given a storage pool name, returns the corresponding storage pool UUID

Usage

pool-uuid

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.98. pwd

Displays the current directory

Usage

pwd

Options

Needs to be written

Availability

Available from libvirt 0.7.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.99. qemu-monitor-command

Qemu monitor command

Usage

qemu-monitor-command

Options

Needs to be written

Availability

Available from libvirt 0.8.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.100. quit

Quit this interactive terminal. Alternative name for the exit command, doing exactly the same thing.

Usage

quit

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.101. reboot

Run a reboot command in a guest domain

Usage

reboot

Options

Needs to be written

Availability

Available from libvirt 0.1.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.102. restore

Restore a guest domain

Usage

restore

Options

Needs to be written

Availability

Available from libvirt 0.0.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.103. resume

Resume a guest domain

Usage

resume

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.104. save

Save the running state of a guest domain to a file

Usage

save

Options

Needs to be written

Availability

Available from libvirt 0.0.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.105. schedinfo

Show or set scheduler parameters

Usage

schedinfo

Options

Needs to be written

Availability

Available from libvirt 0.2.3 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.106. secret-define

Define or modify a secret

Usage

secret-define

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.107. secret-dumpxml

Output attributes of a secret as an XML dump to stdout

Usage

secret-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.108. secret-get-value

Output a secret value to stdout

Usage

secret-get-value

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.109. secret-list

Returns a list of secrets

Usage

secret-list

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.110. secret-set-value

Set a secret value

Usage

secret-set-value

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.111. secret-undefine

Undefine a secret

Usage

secret-undefine

Options

Needs to be written

Availability

Available from libvirt 0.7.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.112. setmaxmem

Change the maximum memory allocation limit in the guest domain

Usage

setmaxmem

Options

Needs to be written

Availability

Available from libvirt 0.1.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.113. setmem

Change the current memory allocation in the guest domain

Usage

setmem

Options

Needs to be written

Availability

Available from libvirt 0.1.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.114. setvcpus

Change the number of virtual CPUs in the guest domain

Usage

setvcpus

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.115. shutdown

Run shutdown in a guest domain

Usage

shutdown

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.116. snapshot-create

Creates a snapshot of a domain

Usage

snapshot-create

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.117. snapshot-current

Gets the current snapshot for a domain

Usage

snapshot-current

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.118. snapshot-delete

Removes a snapshot, and all of it's children, from a domain

Usage

snapshot-delete

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.119. snapshot-dumpxml

Displays the XML fragment for a domain snapshot

Usage

snapshot-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.120. snapshot-list

Lists the snapshots for a domain

Usage

snapshot-list

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.121. snapshot-revert

Reverts a domain to a given snapshot

Usage

snapshot-revert

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.122. start

Start a guest domain, either from the last managedsave state, or via a fresh boot if no managedsave state is present

Usage

start

Options

Needs to be written

Availability

Available from libvirt 0.1.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.123. suspend

Suspend a running guest domain

Usage

suspend

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.124. ttyconsole

Output the device for the TTY console

Usage

ttyconsole

Options

Needs to be written

Availability

Available from libvirt 0.3.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.125. undefine

Remove the configuration for an inactive guest domain

Usage

undefine

Options

Needs to be written

Availability

Available from libvirt 0.1.6 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.126. update-device

Update device from an XML file

Usage

update-device

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.127. uri

Display the hypervisor canonical URI

Usage

uri

Options

Needs to be written

Availability

Available from libvirt 0.3.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.128. vcpucount

Returns the number of virtual CPUs used by a guest domain

Usage

vcpucount

Options

Needs to be written

Availability

Available from libvirt 0.8.5 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.129. vcpuinfo

Returns basic information about a guest domains virtual CPUs

Usage

vcpuinfo

Options

Needs to be written

Availability

Available from libvirt 0.1.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.130. vcpupin

Pin guest domain virtual CPUs to physical host CPUs

Usage

vcpupin

Options

Needs to be written

Availability

Available from libvirt 0.1.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.131. version

Display the system version information

Usage

version

Options

Needs to be written

Availability

Available from libvirt 0.0.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.132. vncdisplay

Output the IP address and port number for the VNC display

Usage

vncdisplay

Options

Needs to be written

Availability

Available from libvirt 0.2.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.133. vol-clone

Copies an existing storage volume, including data, to a new storage volume

Usage

vol-clone

Options

Needs to be written

Availability

Available from libvirt 0.6.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.134. vol-create-as

Creates a new storage volume, on a given storage pool, using settings passed as options

Usage

vol-create-as

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.135. vol-create-from

Create a new storage volume from an existing storage volume

Usage

vol-create-from

Options

Needs to be written

Availability

Available from libvirt 0.6.4 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.136. vol-create

Creates a new storage volume, on a given storage pool, using settings from an XML file

Usage

vol-create

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.137. vol-delete

Removes a storage volume from a storage pool

Usage

vol-delete

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.138. vol-dumpxml

Displays the XML configuration for a storage volume, to stdout

Usage

vol-dumpxml

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.139. vol-info

Returns basic information about a storage volume

Usage

vol-info

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.140. vol-key

When given a storage volume name or path, returns the corresponding key for that volume

Usage

vol-key

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.141. vol-list

Displays a list of the storage volumes libvirt is aware of, in a given storage pool

Usage

vol-list

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.142. vol-name

When given a storage volume path or key, returns the corresponding name for that volume

Usage

vol-name

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.143. vol-path

When given a storage volume name or key, returns the corresponding path for that volume

Usage

vol-path

Options

Needs to be written

Availability

Available from libvirt 0.4.1 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.144. vol-pool

Returns the storage pool name or UUID for a given storage volume

Usage

vol-pool

Options

Needs to be written

Availability

Available from libvirt 0.8.2 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

2.145. vol-wipe

Ensure data previously on a volume is not accessible to future reads

Usage

vol-wipe

Options

Needs to be written

Availability

Available from libvirt 0.8.0 onwards

Platform or Hypervisor specific notes

None yet

Examples

Needs to be written

Example in context

Needs to be written

See also

Needs to be written

Revision History

Revision History

Revision 2-0 | Wed Jan 05 2011 | Justin Clift

Added the content for the memtune command, provided by Nikunj A. Dadhania.

Revision 1-0 | Wed Dec 07 2010 | Justin Clift

Added a description for every virsh command, along with the version of libvirt where it became available.

Revision 0-0 | Wed Nov 10 2010 | Justin Clift

Initial content added, covering the Virtual Networking commands.

Index

F

feedback1

contact information for this brand, We Need Feedback!