qemu-ga(8)

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, 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
58              /etc/qemu/fsfreeze-hook).  If  using -F with an argument, do not
59              follow  -F  with  a  space  (for  example:  -F/var/run/fsfreeze‐
60              hook.sh).
61
62       -t, --statedir=PATH
63              Specify the directory to store state information (absolute paths
64              only, default is /var/run).
65
66       -v, --verbose
67              Log extra debugging information.
68
69       -V, --version
70              Print version information and exit.
71
72       -d, --daemon
73              Daemonize after startup (detach from terminal).
74
75       -b, --blacklist=LIST
76              Comma-separated list of RPCs to disable (no spaces,  ?  to  list
77              available RPCs).
78
79       -D, --dump-conf
80              Dump  the configuration in a format compatible with qemu-ga.conf
81              and exit.
82
83       -h, --help
84              Display this help and exit.
85

FILES

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

AUTHOR

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

COPYRIGHT

131       2021, The QEMU Project Developers
132
133
134
135
1365.1.0                            Jan 11, 2021                       QEMU-GA(8)