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] [--sam|--satellite5|--satellite6]
11 [--libvirt|--vdsm|--esx|--rhevm|--hyperv|--kubevirt]
12
14 -h, --help
15 show this help message and exit
16 -d, --debug
18 Enable debugging output
19 -o, --one-shot
21 Send the list of guest IDs and exit immediately
22 -i INTERVAL, --interval=INTERVAL
24 Acquire and send guest information each N seconds; note that
25 this option is recommendation only, requested interval might not
26 been honoured and the actual interval might be longer or shorter
27 depending on backend that is used.
28 -p, --print
30 Print the host/guests association in JSON format to standard
31 output
32 -c, --config
34 Use configuration file directly (will override configuration
35 from other files. 'global' and 'default' sections are not read
36 in files passed in via this option, and are only read from
37 /etc/virt-who.conf). Can be used multiple times. See virt-who-
38 config(5) for details about configuration file format.
39 Virtualization backend
41 Choose virtualization backend that should be used to gather
42 host/guest associations
43 --libvirt
45 [Deprecated] Use libvirt to list virtual guests [default]
46 --vdsm [Deprecated] Use vdsm to list virtual guests
48 --esx [Deprecated] Register ESX machines using vCenter
50 --rhevm
52 [Deprecated] Register guests using RHEV-M
53 --hyperv
55 [Deprecated] Register guests using Hyper-V
56 --xen [Deprecated] Register XEN machines using XenServer
58 Subscription manager
60 Choose where the host/guest associations should be reported
61 --sam [Deprecated] Report host/guest associations to the Subscription
63 Asset Manager or Satellite 6 [default]
64 --satellite5
66 [Deprecated] Report host/guest associations to the Satellite 5
67 server
68 --satellite6 [Deprecated] Report host/guest associations to the
70 Satellite 6 server
71 Libvirt options
73 Use these options with --libvirt These should be defined in the
74 configuration file or in environment variables
75 --libvirt-owner=OWNER
77 [Deprecated] Organization who has purchased subscriptions of the
78 products, same as current system registration by default
79 --libvirt-env=ENV
81 [Deprecated] Environment where the libvirt server belongs to,
82 same as current system registration by default
83 --libvirt-server=SERVER
85 [Deprecated] URL of the remote libvirt server to connect to,
86 local server by default
87 --libvirt-username=USERNAME
89 [Deprecated] Username for connecting to libvirt, username of
90 current user by default
91 --libvirt-password=PASSWORD
93 [Deprecated] Password for connecting to libvirt. This option
94 doesn't work with ssh transport (default), copy your public ssh
95 key to the remote machine.
96 vCenter/ESX options
98 Use these options with --esx These should be defined in the con‐
99 figuration file or in environment variables
100 --esx-owner=OWNER
102 [Deprecated] Organization who has purchased subscriptions of the
103 products
104 --esx-env=ENV
106 [Deprecated] Environment where the vCenter server belongs to
107 --esx-server=SERVER
109 [Deprecated] URL of the vCenter server to connect to
110 --esx-username=USERNAME
112 [Deprecated] Username for connecting to vCenter
113 --esx-password=PASSWORD
115 [Deprecated] Password for connecting to vCenter
116 RHEV-M options
118 Use these options with --rhevm These should be defined in the
119 configuration file or in environment variables
120 --rhevm-owner=OWNER
122 [Deprecated] Organization who has purchased subscriptions of the
123 products
124 --rhevm-env=ENV
126 [Deprecated] Environment where the RHEV-M belongs to
127 --rhevm-server=SERVER
129 [Deprecated] URL of the RHEV-M server to connect to
130 --rhevm-username=USERNAME
132 [Deprecated] Username for connecting to RHEV-M
133 --rhevm-password=PASSWORD
135 [Deprecated] Password for connecting to RHEV-M
136 Hyper-V options
138 Use these options with --hyperv These should be defined in the
139 configuration file or in environment variables
140 --hyperv-owner=OWNER
142 [Deprecated] Organization who has purchased subscriptions of the
143 products
144 --hyperv-env=ENV
146 [Deprecated] Environment where the Hyper-V belongs to
147 --hyperv-server=SERVER
149 [Deprecated] URL of the Hyper-V server to connect to
150 --hyperv-username=USERNAME
152 [Deprecated] Username for connecting to Hyper-V
153 --hyperv-password=PASSWORD
155 [Deprecated] Password for connecting to Hyper-V
156 XenServer options
158 Use these options with --xen These should be defined in the con‐
159 figuration file or in environment variables
160 --xen-owner=OWNER
162 [Deprecated] Organization who has purchased subscriptions of the
163 products
164 --xen-env=ENV
166 [Deprecated] Environment where the XenServer belongs to
167 --xen-server=SERVER
169 [Deprecated] URL of the XenServer server to connect to
170 --xen-username=USERNAME
172 [Deprecated] Username for connecting to XenServer
173 --xen-password=PASSWORD
175 [Deprecated] Password for connecting to XenServer
176 Satellite 5 options:
178 Use these options with --satellite5 These should be defined in
179 the configuration file or in environment variables
180 --satellite-server=SAT_SERVER
182 [Deprecated] Satellite server URL
183 --satellite-username=SAT_USERNAME
185 [Deprecated] Username for connecting to Satellite server
186 --satellite-password=SAT_PASSWORD
188 [Deprecated] Password for connecting to Satellite server
189
191 virt-who also reads environmental variables. They have the same name as
192 command line arguments but upper-cased, with underscore instead of dash
193 and prefixed with VIRTWHO_ (e.g. VIRTWHO_ONE_SHOT). Empty variables are
194 considered as disabled, non-empty as enabled
195
197 MODE
198 virt-who has three modes how it can run:
199 1. one-shot mode
201 # virt-who -o
202 In this mode virt-who just sends the host to guest association
204 to the server once and then exits.
205 2. interval mode
207 # virt-who
208 This is default mode. virt-who will listen to change events (if
210 available) or do a polling with given interval, and will send
211 the host to guest association when it changes. The default
212 polling interval is 60 seconds and can be changed using "-i
213 INTERVAL" (in seconds).
214 3. print mode
216 # virt-who -p
217 This mode is similar to oneshot mode but the host to guest asso‐
219 ciation is not send to server, but printed to standard output
220 instead.
221 VIRTUALIZATION BACKEND
224 virt-who can use couple of virtualization backends.
225 1. libvirt
227 # virt-who
228 # virt-who --libvirt
230 Use libvirt as virtualization backend. This is default.
232 NOTE: virt-who can monitor for events only in this mode.
234 2. vdsm
236 # virt-who --vdsm
237 Use vdsm as virtualization backend.
239 3. ESX
241 # virt-who --esx --esx-owner=ESX_OWNER --esx-env=ESX_ENV --esx-
243 server=ESX_SERVER --esx-username=ESX_USERNAME --esx-pass‐
244 word=ESX_PASSWORD
245 Use ESX (vCenter) as virtualization backend and specify option
247 required to connect to ESX server.
248 4. RHEV-M
251 # virt-who --rhevm --rhevm-owner=RHEVM_OWNER --rhevm-
253 env=RHEVM_ENV --rhevm-server=RHEVM_SERVER --rhevm-user‐
254 name=RHEVM_USERNAME --rhevm-password=RHEVM_PASSWORD
255 Use RHEV-M as virtualization backend and specify option required
257 to connect to RHEV-M server.
258 5. Hyper-V
261 # virt-who --hyperv --hyperv-owner=HYPERV_OWNER --hyperv-
263 env=HYPERV_ENV --hyperv-server=HYPERV_SERVER --hyperv-user‐
264 name=HYPERV_USERNAME --hyperv-password=HYPERV_PASSWORD
265 Use Hyper-V as virtualization backend and specify option
267 required to connect to Hyper-V server.
268 6. XenServer
271 # virt-who --xen --xen-owner=XEN_OWNER --xen-env=XEN_ENV --xen-
273 server=XEN_SERVER --xen-username=XEN_USERNAME --xen-pass‐
274 word=XEN_PASSWORD
275 Use Citrix XenServer as virtualization backend and specify
277 option required to connect to XenServer server.
278 7. Fake
281 Fake virtualization backend fetches the host/guests association
283 from file. This can be useful in environments where the hypervi‐
284 sor is not accessible by virt-who. It's only available through
285 configuration file, see virt-who-config(5) for details about
286 configuration of this backend.
287 8. Kubevirt
290 # virt-who --kubevirt --kubevirt-owner=KUBEVIRT_OWNER --kube‐
292 virt-env=KUBEVIRT_ENV
293 Use Kubevirt as virtualization backend.
295 SUBSCRIPTION MANAGER
299 virt-who can report host/guest associations to Subscription Asset Man‐
300 ager (SAM), to Satellite 5, or to Satellite 6.
301 1. Subscription Asset Manager or Satellite 6
303 # virt-who
304 # virt-who --sam
306 System must be registered using subscription-manager prior to
308 using virt-who. Configuration for connecting to SAM is shared
309 between subscription-manager and virt-who. This is default.
310 2. Satellite 6
313 # virt-who --satellite6
315 System must be registered using subscription-manager prior to
317 using virt-who. Configuration for connecting to Satellite 6 is
318 shared between subscription-manager and virt-who.
319 2. Satellite 5
322 # virt-who --satellite5 --satellite-server=SAT_SERVER --satel‐
324 lite-username=SAT_USERNAME --satellite-password=SAT_PASSWORD
325 This option can't be used for monitoring local guests, use rhn-
327 virtualization-host instead.
328
331 virt-who always writes error output to file /var/log/rhsm/rhsm.log. It
332 also writes the same output to standard error output when started from
333 command line.
334 virt-who can be started with option "-d" in all modes and with all
336 backends. This option will enable verbose output with more information.
337
340 Virt-who may present security concerns in some scenarios because it
341 needs access to every hypervisor in the environment. To minimize secu‐
342 rity risk, virt-who is a network client, not a server. It only does
343 outbound connections to find and register new hypervisors and does not
344 need access to any virtual machines. To further reduce risk, deploy
345 virt-who in a small virtual machine with a minimal installation and
346 lock it down from any unsolicited inbound network connections.
347 Here is a list of ports that need to be open for different hypervisors:
349 VMWare ESX/vCenter: 443/tcp
351 Hyper-V: 5985/tcp
352 RHEV-M: 443/tcp or 8443/tcp (depending on version)
353 XenServer: 443/tcp
354 libvirt: depending on transport type, default (for remote connec‐
355 tions) is qemu over ssh on port 22
356 local libvirt and vdsm use local connections and don't need open
357 ports
358 kubevirt: 8443/tcp
359 virt-who also needs to have access to Subscription Asset Manager,
361 Satellite 5, or Satellite 6. Default port is 443/tcp. All the ports
362 might be changed by system administrators.
363 Using the same network for machine running virt-who as for hypervisor
365 management software instead of production VM networks is suggested.
366
369 Radek Novacek <rnovacek at redhat dot com>
370virt-who April 2016 VIRT-WHO(8)