qemu-ga.texi

   1 @example
   2 @c man begin SYNOPSIS
   3 @command{qemu-ga} [@var{OPTIONS}]
   4 @c man end
   5 @end example
   6
   7 @c man begin DESCRIPTION
   8
   9 The QEMU Guest Agent is a daemon intended to be run within virtual
  10 machines. It allows the hypervisor host to perform various operations
  11 in the guest, such as:
  12
  13 @itemize
  14 @item
  15 get information from the guest
  16 @item
  17 set the guest's system time
  18 @item
  19 read/write a file
  20 @item
  21 sync and freeze the filesystems
  22 @item
  23 suspend the guest
  24 @item
  25 reconfigure guest local processors
  26 @item
  27 set user's password
  28 @item
  29 ...
  30 @end itemize
  31
  32 qemu-ga will read a system configuration file on startup (located at
  33 @file{/etc/qemu/qemu-ga.conf} by default), then parse remaining
  34 configuration options on the command line. For the same key, the last
  35 option wins, but the lists accumulate (see below for configuration
  36 file format).
  37
  38 @c man end
  39
  40 @c man begin OPTIONS
  41 @table @option
  42 @item -m, --method=@var{method}
  43   Transport method: one of @samp{unix-listen}, @samp{virtio-serial}, or
  44   @samp{isa-serial} (@samp{virtio-serial} is the default).
  45
  46 @item -p, --path=@var{path}
  47   Device/socket path (the default for virtio-serial is
  48   @samp{/dev/virtio-ports/org.qemu.guest_agent.0},
  49   the default for isa-serial is @samp{/dev/ttyS0})
  50
  51 @item -l, --logfile=@var{path}
  52   Set log file path (default is stderr).
  53
  54 @item -f, --pidfile=@var{path}
  55   Specify pid file (default is @samp{/var/run/qemu-ga.pid}).
  56
  57 @item -F, --fsfreeze-hook=@var{path}
  58   Enable fsfreeze hook. Accepts an optional argument that specifies
  59   script to run on freeze/thaw. Script will be called with
  60   'freeze'/'thaw' arguments accordingly (default is
  61   @samp{/etc/qemu/fsfreeze-hook}). If using -F with an argument, do
  62   not follow -F with a space (for example:
  63   @samp{-F/var/run/fsfreezehook.sh}).
  64
  65 @item -t, --statedir=@var{path}
  66   Specify the directory to store state information (absolute paths only,
  67   default is @samp{/var/run}).
  68
  69 @item -v, --verbose
  70   Log extra debugging information.
  71
  72 @item -V, --version
  73   Print version information and exit.
  74
  75 @item -d, --daemon
  76   Daemonize after startup (detach from terminal).
  77
  78 @item -b, --blacklist=@var{list}
  79   Comma-separated list of RPCs to disable (no spaces, @samp{?} to list
  80   available RPCs).
  81
  82 @item -D, --dump-conf
  83   Dump the configuration in a format compatible with @file{qemu-ga.conf}
  84   and exit.
  85
  86 @item -h, --help
  87   Display this help and exit.
  88 @end table
  89
  90 @c man end
  91
  92 @c man begin FILES
  93
  94 The syntax of the @file{qemu-ga.conf} configuration file follows the
  95 Desktop Entry Specification, here is a quick summary: it consists of
  96 groups of key-value pairs, interspersed with comments.
  97
  98 @example
  99 # qemu-ga configuration sample
 100 [general]
 101 daemonize = 0
 102 pidfile = /var/run/qemu-ga.pid
 103 verbose = 0
 104 method = virtio-serial
 105 path = /dev/virtio-ports/org.qemu.guest_agent.0
 106 statedir = /var/run
 107 @end example
 108
 109 The list of keys follows the command line options:
 110 @table @option
 111 @item daemon= boolean
 112 @item method= string
 113 @item path= string
 114 @item logfile= string
 115 @item pidfile= string
 116 @item fsfreeze-hook= string
 117 @item statedir= string
 118 @item verbose= boolean
 119 @item blacklist= string list
 120 @end table
 121
 122 @c man end
 123
 124 @ignore
 125
 126 @setfilename qemu-ga
 127 @settitle QEMU Guest Agent
 128
 129 @c man begin AUTHOR
 130 Michael Roth <mdroth@linux.vnet.ibm.com>
 131 @c man end
 132
 133 @c man begin SEEALSO
 134 qemu(1)
 135 @c man end
 136
 137 @end ignore