docs/interop/qemu-ga.rst

1 QEMU Guest Agent
5 --------
7 **qemu-ga** [*OPTIONS*]
10 -----------
12 The QEMU Guest Agent is a daemon intended to be run within virtual
16 - get information from the guest
17 - set the guest's system time
18 - read/write a file
19 - sync and freeze the filesystems
20 - suspend the guest
21 - reconfigure guest local processors
22 - set user's password
23 - ...
25 qemu-ga will read a system configuration file on startup (located at
26 |CONFDIR|\ ``/qemu-ga.conf`` by default), then parse remaining
46 -------
48 .. program:: qemu-ga
50 .. option:: -c, --config=PATH
52   Configuration file path (the default is |CONFDIR|\ ``/qemu-ga.conf``,
55 .. option:: -m, --method=METHOD
57   Transport method: one of ``unix-listen``, ``virtio-serial``, or
58   ``isa-serial``, or ``vsock-listen`` (``virtio-serial`` is the default).
60 .. option:: -p, --path=PATH
62   Device/socket path (the default for virtio-serial is
63   ``/dev/virtio-ports/org.qemu.guest_agent.0``,
64   the default for isa-serial is ``/dev/ttyS0``). Socket addresses for
65   vsock-listen are written as ``<cid>:<port>``.
67 .. option:: -l, --logfile=PATH
71 .. option:: -f, --pidfile=PATH
73   Specify pid file (default is ``/var/run/qemu-ga.pid``).
75 .. option:: -F, --fsfreeze-hook=PATH
80   |CONFDIR|\ ``/fsfreeze-hook``). If using -F with an argument, do
81   not follow -F with a space (for example:
82   ``-F/var/run/fsfreezehook.sh``).
84 .. option:: -t, --statedir=PATH
89 .. option:: -v, --verbose
93 .. option:: -V, --version
97 .. option:: -d, --daemon
101 .. option:: -b, --block-rpcs=LIST
103   Comma-separated list of RPCs to disable (no spaces, use ``--block-rpcs=help``
106 .. option:: -a, --allow-rpcs=LIST
108   Comma-separated list of RPCs to enable (no spaces, use ``--allow-rpcs=help``
111 .. option:: -D, --dump-conf
113   Dump the configuration in a format compatible with ``qemu-ga.conf``
116 .. option:: -h, --help
121 -----
124 The syntax of the ``qemu-ga.conf`` configuration file follows the
126 groups of key-value pairs, interspersed with comments.
130     # qemu-ga configuration sample
133     pidfile = /var/run/qemu-ga.pid
135     method = virtio-serial
136     path = /dev/virtio-ports/org.qemu.guest_agent.0
149 fsfreeze-hook  string
152 block-rpcs     string list
153 allow-rpcs     string list
157 --------
159 :manpage:`qemu(1)`