1QEMU-GA.8(8)                                                      QEMU-GA.8(8)
2
3
4

NAME

6       qemu-ga - QEMU Guest Agent
7

SYNOPSIS

9       qemu-ga [OPTIONS]
10

DESCRIPTION

12       The QEMU Guest Agent is a daemon intended to be run within virtual
13       machines. It allows the hypervisor host to perform various operations
14       in the guest, such as:
15
16       ·   get information from the guest
17
18       ·   set the guest's system time
19
20       ·   read/write a file
21
22       ·   sync and freeze the filesystems
23
24       ·   suspend the guest
25
26       ·   reconfigure guest local processors
27
28       ·   set user's password
29
30       ·   ...
31
32       qemu-ga will read a system configuration file on startup (located at
33       /etc/qemu/qemu-ga.conf by default), then parse remaining configuration
34       options on the command line. For the same key, the last option wins,
35       but the lists accumulate (see below for configuration file format).
36

OPTIONS

38       -m, --method=method
39             Transport method: one of B<unix-listen>, B<virtio-serial>, or
40             B<isa-serial> (B<virtio-serial> is the default).
41
42       -p, --path=path
43             Device/socket path (the default for virtio-serial is
44             B</dev/virtio-ports/org.qemu.guest_agent.0>,
45             the default for isa-serial is B</dev/ttyS0>)
46
47       -l, --logfile=path
48             Set log file path (default is stderr).
49
50       -f, --pidfile=path
51             Specify pid file (default is B</var/run/qemu-ga.pid>).
52
53       -F, --fsfreeze-hook=path
54             Enable fsfreeze hook. Accepts an optional argument that specifies
55             script to run on freeze/thaw. Script will be called with
56             'freeze'/'thaw' arguments accordingly (default is
57             B</etc/qemu/fsfreeze-hook>). If using -F with an argument, do
58             not follow -F with a space (for example:
59             B<-F/var/run/fsfreezehook.sh>).
60
61       -t, --statedir=path
62             Specify the directory to store state information (absolute paths only,
63             default is B</var/run>).
64
65       -v, --verbose
66             Log extra debugging information.
67
68       -V, --version
69             Print version information and exit.
70
71       -d, --daemon
72             Daemonize after startup (detach from terminal).
73
74       -b, --blacklist=list
75             Comma-separated list of RPCs to disable (no spaces, B<?> to list
76             available RPCs).
77
78       -D, --dump-conf
79             Dump the configuration in a format compatible with F<qemu-ga.conf>
80             and exit.
81
82       -h, --help
83             Display this help and exit.
84

FILES

86       The syntax of the qemu-ga.conf configuration file follows the Desktop
87       Entry Specification, here is a quick summary: it consists of groups of
88       key-value pairs, interspersed with comments.
89
90               # qemu-ga configuration sample
91               [general]
92               daemonize = 0
93               pidfile = /var/run/qemu-ga.pid
94               verbose = 0
95               method = virtio-serial
96               path = /dev/virtio-ports/org.qemu.guest_agent.0
97               statedir = /var/run
98
99       The list of keys follows the command line options:
100
101       daemon= boolean
102       method= string
103       path= string
104       logfile= string
105       pidfile= string
106       fsfreeze-hook= string
107       statedir= string
108       verbose= boolean
109       blacklist= string list
110

SEE ALSO

112       qemu(1)
113

AUTHOR

115       Michael Roth <mdroth@linux.vnet.ibm.com>
116
117
118
119                                  2019-11-15                      QEMU-GA.8(8)
Impressum