1VIRT-WHO-CONFIG(5)            File Formats Manual           VIRT-WHO-CONFIG(5)
2
3
4

NAME

6       virt-who-config - configuration for virt-who
7

SYNOPISIS

9       /etc/virt-who.conf /etc/virt-who.d/*.conf
10

DESCRIPTION

12       Configuration  format  is  ini-like  for  files  /etc/virt-who.conf and
13       /etc/virt-who.d/*.conf.  The configuration files located at  /etc/virt-
14       who.d/*.conf  are  called  virtualization  backend configurations.  All
15       non-hidden files in this directory (ending in '.conf')  are  considered
16       configuration files. If no section (name in square brackets) is present
17       in the configuration file, it will  be  ignored  and  warning  will  be
18       shown.   The  configuration  located  at /etc/virt-who.conf is the main
19       configuration for virt-who.  Below are descriptions  of  both  the  re‐
20       quired  and optional options for both kinds of configs and how they are
21       used.
22

GENERAL CONFIGURATION

24       The general configuration file  (located  at  /etc/virt-who.conf),  has
25       three  special  sections global, defaults, and system_environment.  The
26       settings that can be specified in defaults are any  setting  listed  in
27       the  VIRTUALIZATION BACKEND CONFIGURATION section of this manual. These
28       settings are  applied  as  defaults  to  the  configurations  found  in
29       /etc/virt-who.d/*.conf.
30
31       The settings in the global affect the overall operation of the applica‐
32       tion.  The following are options that can be specified  in  the  global
33       section:
34
35       interval
36              how  often to check connected hypervisors for changes (seconds).
37              Also affects how often a mapping is reported.
38
39       reporter_id
40              The id of this virt-who instance, reported  with  all  mappings.
41              Defaults to HOSTNAME-MACHINEID
42
43       debug  Enable debugging output
44
45       oneshot
46              Send the list of guest IDs and exit immediately
47
48       log_per_config
49              Write a seperate log file per configuration in the config direc‐
50              tory
51
52       log_dir
53              The absolute path of the directory to write logs to.
54
55       log_file
56              The file name to  write  logs  to  (used  only  if  log_per_con‐
57              fig=False)
58
59       configs
60              A  list  of files containing configurations for virt-who Used to
61              specify locations other than default
62
63              The settings in the system_environment are written to  the  sys‐
64              tem's  environment  and  are  available  for the duration of the
65              process execution.  Example options that can be specified in the
66              system_environment section:
67
68       HTTPS_PROXY
69              Proxy hostname for all https requests
70
71       HTTP_PROXY
72              Proxy hostname for all http requests
73
74       NO_PROXY
75              A  comma-separated  list of hostnames or domains or ip addresses
76              to ignore proxy settings for.  Optionally this may be set to '*'
77              to  bypass  proxy  settings  for all hostnames domains or ip ad‐
78              dresses.
79
80

VIRTUALIZATION BACKEND CONFIGURATION

82       Each section (or group), denoted by an arbitrary name for the  configu‐
83       ration (in square brackets), is read in
84
85       Only  required key is type that has to have one of the allowed virtual‐
86       ization backend names: ahv, libvirt, esx, rhevm, hyperv, fake, or kube‐
87       virt.
88
89       Please note that special characters must not be escaped.
90
91       Other options that can be supplied are:
92
93       server Hostname, IP address or URL of the server that provides virtual‐
94              ization information (not applicable for kubevirt mode).
95
96       username
97              Username for authentication to the server  (not  applicable  for
98              kubevirt  mode). May include domain. Do not escape the backslash
99              between domain and username.
100
101       password
102              Password for authentication to the server  (not  applicable  for
103              kubevirt mode).
104
105       encrypted_password
106              Alternative  to  the password option, encrypted password that is
107              generated by virt-who-password(8) utility.
108
109       owner  Owner for use with Subscription Asset Manager, the Red Hat  Cus‐
110              tomer Portal, or Satellite 6 (not applicable for Satellite 5)
111
112       rhsm_username
113              Optional  username to use to communicate with Subscription Asset
114              Manager or Satellite 6 instead of the registered system's  iden‐
115              tity certificate. (not applicable for Satellite 5)
116
117       rhsm_password
118              Optional  password to use to communicate with Subscription Asset
119              Manager or Satellite 6 instead of the registered system's  iden‐
120              tity certificate. (not applicable for Satellite 5)
121
122       rhsm_encrypted_password
123              Alternative to the rhsm_password option, encrypted password that
124              is generated by virt-who-password(8) utility.
125
126       rhsm_hostname
127              Optional hostname of the Subscription Asset Manager or Satellite
128              6  server  to  use  in place of the host defined in the system's
129              rhsm.conf.
130
131       rhsm_port
132              Optional port for the Subscription Asset Manager or Satellite  6
133              server  to  use  in  place  of  the port defined in the system's
134              rhsm.conf.
135
136       rhsm_prefix
137              Optional prefix for the Subscription Asset Manager or  Satellite
138              6  server  to use in place of the prefix defined in the system's
139              rhsm.conf.
140
141       rhsm_proxy_hostname
142              Optional proxy host name for the Subscription Asset  Manager  or
143              Satellite  6  server  to use in place of the proxy host name de‐
144              fined in the system's rhsm.conf.
145
146       rhsm_proxy_port
147              Optional proxy port for the Subscription Asset Manager or Satel‐
148              lite  6  server to use in place of the proxy port defined in the
149              system's rhsm.conf.
150
151       rhsm_proxy_user
152              Optional proxy username for the Subscription  Asset  Manager  or
153              Satellite 6 server to use in place of the proxy username defined
154              in the system's rhsm.conf.
155
156       rhsm_proxy_password
157              Optional proxy password for the Subscription  Asset  Manager  or
158              Satellite 6 server to use in place of the proxy password defined
159              in the system's rhsm.conf.
160
161       rhsm_encrypted_proxy_password
162              Alternative to the rhsm_proxy_password option;  encrypted  pass‐
163              word generated by the virt-who-password(8) utility.
164
165       rhsm_no_proxy
166              Optional  proxy  settings  for the Subscription Asset Manager or
167              Satellite 6 server to use in place of the no  proxy  filter  de‐
168              fined in the system's rhsm.conf.
169
170       sat_server
171              Hostname, IP address or URL of the Satellite 5 server.
172
173       sat_username
174              Username for authentication to the Satellite 5 server.
175
176       sat_password
177              Password for authentication to the Satellite 5 server.
178
179       sat_encrypted_password
180              Alternative  to  sat_password option, encrypted password that is
181              generated by virt-who-password(8) utility.
182
183       filter_hosts
184              Only hosts which uuid (or hostname or hwuuid, based on  hypervi‐
185              sor_id) is specified in comma-separated list in this option will
186              be reported. Wildcards and regular  expressions  are  supported.
187              Put  the  value  into  the  double-quotes if it contains special
188              characters (like comma). filter_host_uuids is  deprecated  alias
189              for this option.
190
191       exclude_hosts
192              Hosts which uuid (or hostname or hwuuid, based on hypervisor_id)
193              is specified in comma-separated list in this option will NOT  be
194              reported.  Wildcards and regular expressions are supported.  Put
195              the value into the double-quotes if it contains special  charac‐
196              ters  (like  comma).  exclude_host_uuids is deprecated alias for
197              this option.
198
199       filter_type
200              When this propery is not set,  then  virt-who  tries  to  detect
201              wildcards  or regular expression in value of filter_hosts or ex‐
202              clude_hosts. This option allows to specify usage of regular  ex‐
203              pression (value 'regex') or wildcards (value 'wildcards').
204
205       hypervisor_id
206              Property  that  should be used as identification of the hypervi‐
207              sor. Can be one of following: uuid, hostname, hwuuid. Note  that
208              some virtualization backends don't have all of them implemented.
209              Default is uuid. hwuuid is applicable to  esx  and  rhevm  only.
210              This  property is meant to be set up before initial run of virt-
211              who. Changing it later will result in duplicated entries in  the
212              subscription manager.
213
214       #kubeconfig
215              Path to Kubernetes configuration file which contains authentica‐
216              tion and connection details. Used by kubevirt option
217
218       #kubeversion
219              API version used to override kubevirt api version  fetched  from
220              the cluster. Used by kubevirt option
221
222       #insecure
223              Eliminate  validation  of  tls certificates during connection to
224              kubevirt
225
226

EXAMPLE

228       [test-esx]
229       type=esx
230       server=1.2.3.4
231       username=admin
232       password=password
233       owner=test
234       rhsm_username=admin
235       rhsm_password=password
236
237

BACKEND SPECIFIC OPTIONS

239   ESX BACKEND
240       filter_host_parents
241              Only hosts which cluster ID is specified in comma-separated list
242              in  this  option will be reported. Put the name into the double-
243              quotes if it contains special characters (like comma).  PowerCLI
244              command  to  find the domain names in VMware `Get-Cluster “Clus‐
245              terName” | Select ID`
246
247       exclude_host_parents
248              Exclude hosts which cluster ID is specified  in  comma-separated
249              list  in this option will NOT be reported. Put the name into the
250              double-quotes if it contains special  characters  (like  comma).
251              PowerCLI command to find the domain names in VMware `Get-Cluster
252              “ClusterName” | Select ID`
253
254       simplified_vim
255              virt-who  by  default  uses  stripped-down  version  of  vimSer‐
256              vice.wsdl  file  that  contains vSphere SOAP API definition. Set
257              this option to false to use server provided wsdl file that  will
258              be retrieved automatically.
259
260
261   NUTANIX BACKEND
262       prism_central
263              Any  value  set for this parameter will cause the application to
264              use Version 3 communication with the AHV API
265
266
267   RHEV-M BACKEND
268       server The default port number is 8443 (that was used  the  default  in
269              RHEV-M  <= 3.0). Newer RHEV-M installations uses port 443 by de‐
270              fault. Use correct value for your server in format:
271
272              server=<HOSTNAME_OR_IP_ADDRESS>:<PORT_NUMBER>
273
274
275   KUBEVIRT BACKEND
276       Kubevirt backend uses a Kubernetes configuration file where  there  are
277       cluster  connection  details  and  an authentication token. There is no
278       need to provide a hostname nor  user  credentials.   Before  using  the
279       kubeconfig  file  please make sure to login to the cluster so the token
280       is written to the file. To login you need to run:
281
282       oc login --username=myuser --password=mypass
283
284
285   FAKE BACKEND
286       Fake backend reads host/guests associations from the file on disk,  for
287       example:
288
289       [fake-virt]
290       type=fake
291       file=/path/to/json
292       is_hypervisor=True
293
294
295       type   Must be always fake.
296
297
298       is_hypervisor
299              If  true (default), the option determines that the fake data are
300              fetched from multihost environment.
301
302
303       file   Absolute path to the JSON file that has the  same  structure  as
304              file returned from virt-who --print command, for example:
305              {
306                  "hypervisors": [
307                      {
308                          "uuid": "7e98b6ea-0af1-4afa-b846-919549bb0fe2",
309                          "guests": [
310                              {
311                                  "guestId":
312              "8ae19f08-2605-b476-d42e-4bd5a39f466c",
313                                  "state": 1
314                              },
315                              ...
316                          ]
317                      },
318                      ...
319                  ]
320              }
321
322

CONFIGURATION MIGRATION

324       Previous versions of virt-who employed additional means  of  configura‐
325       tion:
326
327       Setting  of  environment variables [set in the user's profile script or
328       in the default global profile]
329       A service environment file [/etc/sysconfig/virt-who]
330
331       The new version of virt-who no longer supports setting most options via
332       the  environment.  In order to not lose previously valid configurations
333       that made use of environment variables, a  migration  script  has  been
334       added.  That script will incorporate the known system environment vari‐
335       ables [VIRTWHO_INTERVAL, VIRTWHO_DEBUG, VIRTWHO_ONESHOT]  and  the  en‐
336       tries  in  the  service environment file into the general configuration
337       file. The known variables will land in the  global  section  while  any
338       others  in the service environment file [i.e. HTTPS_PROXY] will land in
339       the system_environment section. This migration may result  in  multiple
340       entries for a specific field.
341
342       Each new entry in the general configuration file will come after a com‐
343       ment indicating that it was migrated. The service environment file will
344       be  deleted  after its entries are migrated, but the known system envi‐
345       ronment variables will need to be manually removed or they will be  mi‐
346       grated again if the script is rerun. Those variables will not be recog‐
347       nized by virt-who even if they remain.
348
349       The migration script will be run when a new RPM is installed,  but  you
350       can run it manually with python after the RPM is installed:
351
352       [python_sitelib]/virtwho/migrate/migrateconfiguration.py
353
354
355

AUTHOR

357       Radek Novacek <rnovacek at redhat dot com>
358       William Poteat <wpoteat at redhat dot com>
359
360

SEE ALSO

362       virt-who(8), virt-who-password(8)
363
364
365
366virt-who                         October 2015               VIRT-WHO-CONFIG(5)
Impressum