1VIRT-WHO(8)                 System Manager's Manual                VIRT-WHO(8)
2
3
4

NAME

6       virt-who  - Agent for reporting virtual guest IDs to Subscription Asset
7       Manager, Satellite 6, or Satellite 5.
8

SYNOPSIS

10       virt-who [-d] [-i INTERVAL] [-o]
11

OPTIONS

13       -h, --help
14              show this help message and exit
15
16       -d, --debug
17              Enable debugging output
18
19       -o, --one-shot
20              Send the list of guest IDs and exit immediately
21
22       -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
28       -p, --print
29              Print  the  host/guests  association  in JSON format to standard
30              output
31
32       -c, --config
33              Use configuration file  directly  (will  override  configuration
34              from  other files. 'global', 'default', and 'system_environment'
35              sections are not read in files passed in via  this  option,  and
36              are  only  read  from  /etc/virt-who.conf). Can be used multiple
37              times. See virt-who-config(5) for  details  about  configuration
38              file format.
39

USAGE

41   MODE
42       virt-who has three modes how it can run:
43
44       1. one-shot mode
45              # virt-who -o
46
47              In  this  mode virt-who just sends the host to guest association
48              to the server once and then exits.
49
50       2. interval mode
51              # virt-who -i INTERVAL
52
53              This is default mode. virt-who will listen to change events  (if
54              available)  or  do  a polling with given interval, and will send
55              the host to guest  association  when  it  changes.  The  default
56              polling  interval  is  3600 seconds and can be changed using "-i
57              INTERVAL" (in seconds).
58
59       3. print mode
60              # virt-who -p
61
62              This mode is similar to oneshot mode but the host to guest asso‐
63              ciation  is  not  send to server, but printed to standard output
64              instead.
65
66

LOGGING

68       virt-who always writes error output to file /var/log/rhsm/rhsm.log.  It
69       also  writes the same output to standard error output when started from
70       command line.
71
72       virt-who can be started with option "-d" in  all  modes  and  with  all
73       backends. This option will enable verbose output with more information.
74
75

SECURITY

77       Virt-who  may  present  security  concerns in some scenarios because it
78       needs access to every hypervisor in the environment. To minimize  secu‐
79       rity  risk,  virt-who  is  a network client, not a server. It only does
80       outbound connections to find and register new hypervisors and does  not
81       need  access  to  any  virtual machines. To further reduce risk, deploy
82       virt-who in a small virtual machine with  a  minimal  installation  and
83       lock it down from any unsolicited inbound network connections.
84
85       Here is a list of ports that need to be open for different hypervisors:
86
87           VMWare ESX/vCenter: 443/tcp
88           Hyper-V: 5985/tcp
89           RHEV-M: 443/tcp or 8443/tcp (depending on version)
90           XenServer: 443/tcp
91           libvirt:  depending  on transport type, default (for remote connec‐
92       tions) is qemu over ssh on port 22
93           local libvirt uses a local connection and doesn't need an open port
94           kubevirt: 8443/tcp
95
96       virt-who also needs to have access to Subscription Asset Manager,  Sat‐
97       ellite  5, or Satellite 6. Default port is 443/tcp. All the ports might
98       be changed by system administrators.
99
100       Using the same network for machine running virt-who as  for  hypervisor
101       management software instead of production VM networks is suggested.
102
103

AUTHOR

105       Radek Novacek <rnovacek at redhat dot com>
106
107
108
109virt-who                          April 2016                       VIRT-WHO(8)
Impressum