1VIRT-WHO(8) System Manager's Manual VIRT-WHO(8)
2
6 virt-who - Agent for reporting virtual guest IDs to Subscription Asset
7 Manager, Satellite 6, or Satellite 5.
8
10 virt-who [-d] [-i INTERVAL] [-o]
11
13 -h, --help
14 show this help message and exit
15 -d, --debug
17 Enable debugging output
18 -o, --one-shot
20 Send the list of guest IDs and exit immediately
21 -i INTERVAL, --interval=INTERVAL
23 Acquire and send guest information each N seconds; note that
24 this option is recommendation only, requested interval might not
25 been honoured and the actual interval might be longer or shorter
26 depending on backend that is used.
27 -p, --print
29 Print the host/guests association in JSON format to standard
30 output
31 -c, --config
33 Use configuration file directly (will override configuration
34 from other files. 'global' and 'default' sections are not read
35 in files passed in via this option, and are only read from
36 /etc/virt-who.conf). Can be used multiple times. See virt-who-
37 config(5) for details about configuration file format.
38
40 virt-who also reads environmental variables. They have the same name as
41 command line arguments but upper-cased, with underscore instead of dash
42 and prefixed with VIRTWHO_ (e.g. VIRTWHO_ONE_SHOT). Empty variables are
43 considered as disabled, non-empty as enabled
44
46 MODE
47 virt-who has three modes how it can run:
48 1. one-shot mode
50 # virt-who -o
51 In this mode virt-who just sends the host to guest association
53 to the server once and then exits.
54 2. interval mode
56 # virt-who -i INTERVAL
57 This is default mode. virt-who will listen to change events (if
59 available) or do a polling with given interval, and will send
60 the host to guest association when it changes. The default
61 polling interval is 60 seconds and can be changed using "-i
62 INTERVAL" (in seconds).
63 3. print mode
65 # virt-who -p
66 This mode is similar to oneshot mode but the host to guest asso‐
68 ciation is not send to server, but printed to standard output
69 instead.
70
73 virt-who always writes error output to file /var/log/rhsm/rhsm.log. It
74 also writes the same output to standard error output when started from
75 command line.
76 virt-who can be started with option "-d" in all modes and with all
78 backends. This option will enable verbose output with more information.
79
82 Virt-who may present security concerns in some scenarios because it
83 needs access to every hypervisor in the environment. To minimize secu‐
84 rity risk, virt-who is a network client, not a server. It only does
85 outbound connections to find and register new hypervisors and does not
86 need access to any virtual machines. To further reduce risk, deploy
87 virt-who in a small virtual machine with a minimal installation and
88 lock it down from any unsolicited inbound network connections.
89 Here is a list of ports that need to be open for different hypervisors:
91 VMWare ESX/vCenter: 443/tcp
93 Hyper-V: 5985/tcp
94 RHEV-M: 443/tcp or 8443/tcp (depending on version)
95 XenServer: 443/tcp
96 libvirt: depending on transport type, default (for remote connec‐
97 tions) is qemu over ssh on port 22
98 local libvirt and vdsm use local connections and don't need open
99 ports
100 kubevirt: 8443/tcp
101 virt-who also needs to have access to Subscription Asset Manager,
103 Satellite 5, or Satellite 6. Default port is 443/tcp. All the ports
104 might be changed by system administrators.
105 Using the same network for machine running virt-who as for hypervisor
107 management software instead of production VM networks is suggested.
108
111 Radek Novacek <rnovacek at redhat dot com>
112virt-who April 2016 VIRT-WHO(8)