.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.31)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VIRT-ADMIN 1"
.TH VIRT-ADMIN 1 "2015-12-02" "libvirt-1.3.0" "Virtualization Support"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
virt\-admin \- daemon administration interface
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBvirt-admin\fR [\fI\s-1OPTION\s0\fR]... [\fI\s-1COMMAND_STRING\s0\fR]
.PP
\&\fBvirt-admin\fR [\fI\s-1OPTION\s0\fR]... \fI\s-1COMMAND\s0\fR [\fI\s-1ARG\s0\fR]...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBvirt-admin\fR program is the main administration interface for modifying
the libvirt daemon configuration at runtime, changing daemon behaviour as well
as for monitoring and managing all clients connected to the daemon.
.PP
The basic structure of most virt-admin usage is:
.PP
.Vb 1
\& virt\-admin [OPTION]... <command> [ARG]...
.Ve
.PP
Where \fIcommand\fR is one of the commands listed below.
.PP
The \fBvirt-admin\fR program can be used either to run one \fI\s-1COMMAND\s0\fR by giving the
command and its arguments on the shell command line, or a \fI\s-1COMMAND_STRING\s0\fR
which is a single shell argument consisting of multiple \fI\s-1COMMAND\s0\fR actions
and their arguments joined with whitespace, and separated by semicolons
between commands. Within \fI\s-1COMMAND_STRING\s0\fR, virt-admin understands the
same single, double, and backslash escapes as the shell, although you must
add another layer of shell escaping in creating the single shell argument.
If no command is given in the command line, \fBvirt-admin\fR will then start a minimal
interpreter waiting for your commands, and the \fBquit\fR command will then exit
the program.
.PP
The \fBvirt-admin\fR program understands the following \fI\s-1OPTIONS\s0\fR.
.IP "\fB\-c\fR, \fB\-\-connect\fR \fI\s-1URI\s0\fR" 4
.IX Item "-c, --connect URI"
Connect to the specified \fI\s-1URI\s0\fR, as if by the \fBconnect\fR command,
instead of the default connection.
.IP "\fB\-d\fR, \fB\-\-debug\fR \fI\s-1LEVEL\s0\fR" 4
.IX Item "-d, --debug LEVEL"
Enable debug messages at integer \fI\s-1LEVEL\s0\fR and above. \fI\s-1LEVEL\s0\fR can
range from 0 to 4 (default). See the documentation of \fB\s-1VIRT_ADMIN_DEBUG\s0\fR
environment variable below for the description of each \fI\s-1LEVEL\s0\fR.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Ignore all other arguments, and behave as if the \fBhelp\fR command were
given instead.
.IP "\fB\-l\fR, \fB\-\-log\fR \fI\s-1FILE\s0\fR" 4
.IX Item "-l, --log FILE"
Output logging details to \fI\s-1FILE\s0\fR.
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
.IX Item "-q, --quiet"
Avoid extra informational messages.
.IP "\fB\-v\fR, \fB\-\-version[=short]\fR" 4
.IX Item "-v, --version[=short]"
Ignore all other arguments, and prints the version of the libvirt library
virt-admin is coming from
.IP "\fB\-V\fR, \fB\-\-version=long\fR" 4
.IX Item "-V, --version=long"
Ignore all other arguments, and prints the version of the libvirt library
virt-admin is coming from.
.SH "NOTES"
.IX Header "NOTES"
Running \fBvirt-admin\fR requires root privileges due to the
communications channels used to talk to the daemon. Consider changing the
\&\fIunix_sock_group\fR ownership setting to grant access to specific set of users
or modifying \fIunix_sock_rw_perms\fR permissions. Daemon configuration file
provides more information about setting permissions.
.SH "GENERIC COMMANDS"
.IX Header "GENERIC COMMANDS"
The following commands are generic.
.IP "\fBhelp\fR [\fIcommand-or-group\fR]" 4
.IX Item "help [command-or-group]"
This lists each of the virt-admin commands. When used without options, all
commands are listed, one per line, grouped into related categories,
displaying the keyword for each group.
.Sp
To display detailed information for a specific command, use its name as the
option.
.IP "\fBquit\fR, \fBexit\fR" 4
.IX Item "quit, exit"
quit this interactive terminal
.IP "\fBversion\fR" 4
.IX Item "version"
Will print out the version info about which libvirt library was this client
built from. As opposed to \fIvirsh\fR client, the output already includes
the version of the daemon.
.Sp
\&\fBExample\fR
.Sp
.Vb 4
\& $ virt\-admin version
\& Compiled against library: libvirt 1.2.21
\& Using library: libvirt 1.2.21
\& Running against daemon: 1.2.20
.Ve
.IP "\fBcd\fR [\fIdirectory\fR]" 4
.IX Item "cd [directory]"
Will change current directory to \fIdirectory\fR. The default directory
for the \fBcd\fR command is the home directory or, if there is no \fI\s-1HOME\s0\fR
variable in the environment, the root directory.
.Sp
This command is only available in interactive mode.
.IP "\fBpwd\fR" 4
.IX Item "pwd"
Will print the current directory.
.IP "\fBconnect\fR [\fI\s-1URI\s0\fR]" 4
.IX Item "connect [URI]"
(Re)\-Connect to a daemon's administrating server. The \fI\s-1URI\s0\fR parameter
specifies how to connect to the administrating server.
If \fI\s-1LIBVIRT_ADMIN_DEFAULT_URI\s0\fR or \fIadmin_uri_default\fR (see below) were set,
\&\fIconnect\fR is automatically issued every time a command that requires an
active connection is executed. Note that this only applies if there is no
connection at all or there is an inactive one.
.Sp
To find the currently used \s-1URI,\s0 check the \fIuri\fR command documented below.
.Sp
For remote access see the documentation page at
<http://libvirt.org/uri.html> on how to make URIs.
.IP "\fBuri\fR" 4
.IX Item "uri"
Prints the administrating server canonical \s-1URI,\s0 can be useful in shell mode. If
no \fIuri\fR was specified, neither \fI\s-1LIBVIRT_ADMIN_DEFAULT_URI\s0\fR or
\&\fIadmin_uri_default\fR were set, libvirtd:///system is used.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The following environment variables can be set to alter the behaviour
of \f(CW\*(C`virt\-admin\*(C'\fR
.IP "VIRT_ADMIN_DEBUG=<0 to 4>" 4
.IX Item "VIRT_ADMIN_DEBUG=<0 to 4>"
Turn on verbose debugging of virt-admin commands. Valid levels are
.RS 4
.IP "\(bu" 4
VIRT_ADMIN_DEBUG=0
.Sp
\&\s-1DEBUG \-\s0 Messages at \s-1ALL\s0 levels get logged
.IP "\(bu" 4
VIRT_ADMIN_DEBUG=1
.Sp
\&\s-1INFO \-\s0 Logs messages at levels \s-1INFO, NOTICE, WARNING\s0 and \s-1ERROR\s0
.IP "\(bu" 4
VIRT_ADMIN_DEBUG=2
.Sp
\&\s-1NOTICE \-\s0 Logs messages at levels \s-1NOTICE, WARNING\s0 and \s-1ERROR\s0
.IP "\(bu" 4
VIRT_ADMIN_DEBUG=3
.Sp
\&\s-1WARNING \-\s0 Logs messages at levels \s-1WARNING\s0 and \s-1ERROR\s0
.IP "\(bu" 4
VIRT_ADMIN_DEBUG=4
.Sp
\&\s-1ERROR \-\s0 Messages at only \s-1ERROR\s0 level gets logged.
.RE
.RS 4
.RE
.ie n .IP "VIRT_ADMIN_LOG_FILE=""LOGFILE""" 4
.el .IP "VIRT_ADMIN_LOG_FILE=\f(CWLOGFILE\fR" 4
.IX Item "VIRT_ADMIN_LOG_FILE=LOGFILE"
The file to log virt-admin debug messages.
.IP "\s-1LIBVIRT_ADMIN_DEFAULT_URI\s0" 4
.IX Item "LIBVIRT_ADMIN_DEFAULT_URI"
The daemon whose admin server to connect to by default. Set this to a \s-1URI,\s0 in
the same format as accepted by the \fBconnect\fR option. This overrides the
default \s-1URI\s0 set in any client config file.
.IP "\s-1VIRT_ADMIN_HISTSIZE\s0" 4
.IX Item "VIRT_ADMIN_HISTSIZE"
The number of commands to remember in the command history. The
default value is 500.
.IP "LIBVIRT_DEBUG=LEVEL" 4
.IX Item "LIBVIRT_DEBUG=LEVEL"
Turn on verbose debugging of all libvirt \s-1API\s0 calls. Valid levels are
.RS 4
.IP "\(bu" 4
LIBVIRT_DEBUG=1
.Sp
Messages at level \s-1DEBUG\s0 or above
.IP "\(bu" 4
LIBVIRT_DEBUG=2
.Sp
Messages at level \s-1INFO\s0 or above
.IP "\(bu" 4
LIBVIRT_DEBUG=3
.Sp
Messages at level \s-1WARNING\s0 or above
.IP "\(bu" 4
LIBVIRT_DEBUG=4
.Sp
Messages at level \s-1ERROR\s0 or above
.RE
.RS 4
.Sp
For further information about debugging options consult \f(CW\*(C`http://libvirt.org/logging.html\*(C'\fR
.RE
.SH "BUGS"
.IX Header "BUGS"
Report any bugs discovered to the libvirt community via the mailing
list \f(CW\*(C`http://libvirt.org/contact.html\*(C'\fR or bug tracker \f(CW\*(C`http://libvirt.org/bugs.html\*(C'\fR.
Alternatively report bugs to your software distributor / vendor.
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 1
\& Please refer to the AUTHORS file distributed with libvirt.
\&
\& Based on the virsh man page.
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2015 Red Hat, Inc., and the authors listed in the
libvirt \s-1AUTHORS\s0 file.
.SH "LICENSE"
.IX Header "LICENSE"
virt-admin is distributed under the terms of the \s-1GNU LGPL\s0 v2+.
This is free software; see the source for copying conditions. There
is \s-1NO\s0 warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR
PURPOSE\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIvirsh\fR\|(1), \fIvirt\-xml\-validate\fR\|(1), \fIvirt\-host\-validate\fR\|(1),
<http://www.libvirt.org/>