1QEMU-GA(8)                           QEMU                           QEMU-GA(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   unix-listen,   virtio-serial,   or
40              isa-serial (virtio-serial is the default).
41
42       -p, --path=PATH
43              Device/socket  path  (the default for virtio-serial is /dev/vir‐
44              tio-ports/org.qemu.guest_agent.0, the default for isa-serial  is
45              /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 /var/run/qemu-ga.pid).
52
53       -F, --fsfreeze-hook=PATH
54              Enable  fsfreeze  hook. Accepts an optional argument that speci‐
55              fies script to run on freeze/thaw. Script will  be  called  with
56              'freeze'/'thaw'     arguments     accordingly     (default    is
57              /etc/qemu/fsfreeze-hook). If using -F with an argument,  do  not
58              follow  -F  with  a  space  (for  example:  -F/var/run/fsfreeze‐
59              hook.sh).
60
61       -t, --statedir=PATH
62              Specify the directory to store state information (absolute paths
63              only, default is /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, ? to list
76              available RPCs).
77
78       -D, --dump-conf
79              Dump the configuration in a format compatible with  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                            ┌──────────────┬─────────────┐
102                            │Key           │ Key type    │
103                            ├──────────────┼─────────────┤
104                            │daemon        │ boolean     │
105                            ├──────────────┼─────────────┤
106                            │method        │ string      │
107                            ├──────────────┼─────────────┤
108                            │path          │ string      │
109                            ├──────────────┼─────────────┤
110                            │logfile       │ string      │
111                            ├──────────────┼─────────────┤
112                            │pidfile       │ string      │
113                            ├──────────────┼─────────────┤
114                            │fsfreeze-hook │ string      │
115                            ├──────────────┼─────────────┤
116                            │statedir      │ string      │
117                            ├──────────────┼─────────────┤
118                            │verbose       │ boolean     │
119                            ├──────────────┼─────────────┤
120                            │blacklist     │ string list │
121                            └──────────────┴─────────────┘
122

SEE ALSO

124       qemu(1)
125

AUTHOR

127       Michael Roth <mdroth@linux.vnet.ibm.com>
128

130       2020, The QEMU Project Developers
131
132
133
134
1354.2.0                            Mar 17, 2020                       QEMU-GA(8)
Impressum