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 ma‐
13       chines. It allows the hypervisor host to perform various operations  in
14       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  isa-se‐
40              rial, or vsock-listen (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).  Socket  addresses  for vsock-listen are written as
46              <cid>:<port>.
47
48       -l, --logfile=PATH
49              Set log file path (default is stderr).
50
51       -f, --pidfile=PATH
52              Specify pid file (default is /var/run/qemu-ga.pid).
53
54       -F, --fsfreeze-hook=PATH
55              Enable fsfreeze hook. Accepts an optional argument  that  speci‐
56              fies  script  to  run on freeze/thaw. Script will be called with
57              'freeze'/'thaw' arguments accordingly (default is  /etc/qemu/fs‐
58              freeze-hook).  If  using  -F  with an argument, do not follow -F
59              with a space (for example: -F/var/run/fsfreezehook.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, --block-rpcs=LIST
75              Comma-separated  list of RPCs to disable (no spaces, use help to
76              list available RPCs).
77
78       -a, --allow-rpcs=LIST
79              Comma-separated list of RPCs to enable (no spaces, use  help  to
80              list available RPCs).
81
82       -D, --dump-conf
83              Dump  the configuration in a format compatible with qemu-ga.conf
84              and exit.
85
86       -h, --help
87              Display this help and exit.
88

FILES

90       The syntax of the qemu-ga.conf configuration file follows  the  Desktop
91       Entry  Specification, here is a quick summary: it consists of groups of
92       key-value pairs, interspersed with comments.
93
94          # qemu-ga configuration sample
95          [general]
96          daemonize = 0
97          pidfile = /var/run/qemu-ga.pid
98          verbose = 0
99          method = virtio-serial
100          path = /dev/virtio-ports/org.qemu.guest_agent.0
101          statedir = /var/run
102
103       The list of keys follows the command line options:
104
105                            ┌──────────────┬─────────────┐
106                            │Key           │ Key type    │
107                            ├──────────────┼─────────────┤
108                            │daemon        │ boolean     │
109                            ├──────────────┼─────────────┤
110                            │method        │ string      │
111                            ├──────────────┼─────────────┤
112                            │path          │ string      │
113                            ├──────────────┼─────────────┤
114                            │logfile       │ string      │
115                            ├──────────────┼─────────────┤
116                            │pidfile       │ string      │
117                            ├──────────────┼─────────────┤
118                            │fsfreeze-hook │ string      │
119                            ├──────────────┼─────────────┤
120                            │statedir      │ string      │
121                            ├──────────────┼─────────────┤
122                            │verbose       │ boolean     │
123                            ├──────────────┼─────────────┤
124                            │block-rpcs    │ string list │
125                            └──────────────┴─────────────┘
126

SEE ALSO

128       qemu(1)
129

AUTHOR

131       Michael Roth <mdroth@linux.vnet.ibm.com>
132

134       2023, The QEMU Project Developers
135
136
137
138
1398.1.3                            Nov 28, 2023                       QEMU-GA(8)
Impressum