MLVIRSH(1)
NAME
mlvirsh - management user interface for virsh guest domain.
SYNOPSIS
mlvirsh [-c URI] [-r] [[-help] | [--help]] [command]
DESCRIPTION
This manual page documents briefly the mlvirsh command.
This manual page was written for the Debian GNU/Linux distribution
because the original program does not have a manual page.
mlvirsh is an almost complete reimplementation of virsh, which is
mostly command compatible (there are a very few commands missing, and
some commands have a slightly different syntax, but broadly speaking
they are equivalent programs except that one is written in C and the
other in OCaml)
- -c URI
- Hypervisor connection URI.
- -r
- Read-only connection.
- command
- Virsh command.
- -help, --help
- Display an help message.
COMMANDS
There is an extensive list of possible virsh commands. You can get a
list of it by using the special command help without arguments. Using
the same command with another command as argument will give you the
help for the command.
- attach-device
- Attach device to domain.
- autostart
- Set whether a domain autostarts at boot.
- capabilities
- Returns capabilities of hypervisor/driver.
- close
- Close an existing hypervisor connection.
- connect
- Open a new hypervisor connection.
- create
- Create a domain from an XML file.
- define
- Define (but don't start) a domain from an XML file.
- detach-device
- Detach device from domain.
- destroy
- Destroy a domain.
- domblkpeek
- Peek into a block device of a domain.
- domblkstat
- Display the block device statistics for a domain.
- domid
- Print the ID of a domain.
- domifstat
- Display the network interface statistics for a domain.
- dominfo
- Print the domain info.
- dommaxmem
- Print the max memory (in kilobytes) of a domain.
- dommaxvcpus
- Print the max VCPUs of a domain.
- dommempeek
- Peek into memory of a device.
- domname
- Print the name of a domain.
- domostype
- Print the OS type of a domain.
- domstate
- Print the domain state.
- domuuid
- Print the UUID of a domain.
- dump
- Core dump a domain to a file for analysis.
- dumpxml
- Print the XML description of a domain.
- freecell
- Display free memory for machine, NUMA cell or range of cells
- get-autostart
- Print whether a domain autostarts at boot.
- hostname
- Print the hostname.
- list
- List the running domains.
- list-defined
- List the defined but not running domains.
- quit
- Quit the interactive terminal.
- maxvcpus
- Print the max VCPUs available.
- net-autostart
- Set whether a network autostarts at boot.
- net-bridgename
- Print the bridge name of a network.
- net-create
- Create a network from an XML file.
- net-define
- Define (but don't start) a network from an XML file.
- net-destroy
- Destroy a network.
- net-dumpxml
- Print the XML description of a network.
- net-get-autostart
- Print whether a network autostarts at boot.
- net-list
- List the active networks.
- net-list-defined
- List the defined but inactive networks.
- net-name
- Print the name of a network.
- net-start
- Start a previously defined inactive network.
- net-undefine
- Undefine an inactive network.
- net-uuid
- Print the UUID of a network.
- nodeinfo
- Print node information.
- reboot
- Reboot a domain.
- restore
- Restore a domain from the named file.
- resume
- Resume a domain.
- save
- Save a domain to a file.
- schedparams
- Get the current scheduler parameters for a domain.
- schedparamset
- Set the scheduler parameters for a domain.
- schedtype
- Get the scheduler type.
- setmem
- Set the memory used by the domain (in kilobytes).
- setmaxmem
- Set the maximum memory used by the domain (in kilobytes).
- shutdown
- Gracefully shutdown a domain.
- start
- Start a previously defined inactive domain.
- suspend
- Suspend a domain.
- type
- Print the driver name
- undefine
- Undefine an inactive domain.
- uri
- Print the canonical URI.
- vcpuinfo
- Pin domain VCPU to a list of physical CPUs.
- vcpupin
- Pin domain VCPU to a list of physical CPUs.
- vcpus
- Set the number of virtual CPUs assigned to a domain.
- version
- Print the driver version
LICENSE
This manual page was written by Sylvain Le Gall gildor@debian.org for
the Debian GNU/Linux system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under the terms
of the GNU Lesser General Public License, Version 2.1 or any later
version published by the Free Software Foundation; considering as
source code all the file that enable the production of this manpage.
AUTHOR
- Sylvain Le Gall <gildor@debian.org>
- Author.
COPYRIGHT
- Copyright (C) 2008 Sylvain Le Gall