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/sysconfig/virt-who /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 contents  of  /etc/sysconfig/virt-who  are
14       environment  variables  to  be  used when virt-who is run as a service.
15       The configuration files located at  /etc/virt-who.d/*.conf  are  called
16       virtualization  backend  configurations.   All non-hidden files in this
17       directory (ending in '.conf') are considered configuration files. If no
18       section (name in square brackets) is present in the configuration file,
19       it will be ignored  and  warning  will  be  shown.   The  configuration
20       located  at  /etc/virt-who.conf is the main configuration for virt-who.
21       Below are descriptions of both the required and  optional  options  for
22       both kinds of configs and how they are used.
23

GENERAL CONFIGURATION

25       The general configuration file (located at /etc/virt-who.conf), has two
26       special sections global and defaults.  The settings that can be  speci‐
27       fied  in  defaults are any setting listed in the VIRTUALIZATION BACKEND
28       CONFIGURATION section of this manual. These  settings  are  applied  as
29       defaults to the configurations found in /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

VARIABLES UNIQUE TO SYSCONFIG

65       NO_PROXY
66              A comma-separated list of hostnames or domains or  ip  addresses
67              to ignore proxy settings for.  Optionally this may be set to '*'
68              to bypass  proxy  settings  for  all  hostnames  domains  or  ip
69              addresses.
70
71

VIRTUALIZATION BACKEND CONFIGURATION

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

EXAMPLE

205       [test-esx]
206       type=esx
207       server=1.2.3.4
208       username=admin
209       password=password
210       owner=test
211       env=staging
212       rhsm_username=admin
213       rhsm_password=password
214
215

BACKEND SPECIFIC OPTIONS

217   ESX BACKEND
218       filter_host_parents
219              Only hosts which cluster ID is specified in comma-separated list
220              in this option will be reported. Put the name into  the  double-
221              quotes  if it contains special characters (like comma). PowerCLI
222              command to find the domain names in VMware  `Get-Cluster  “Clus‐
223              terName” | Select ID`
224
225       exclude_host_parents
226              Exclude  hosts  which cluster ID is specified in comma-separated
227              list in this option will NOT be reported. Put the name into  the
228              double-quotes  if  it  contains special characters (like comma).
229              PowerCLI command to find the domain names in VMware `Get-Cluster
230              “ClusterName” | Select ID`
231
232       simplified_vim
233              virt-who  by  default  uses  stripped-down  version  of  vimSer‐
234              vice.wsdl file that contains vSphere SOAP  API  definition.  Set
235              this  option to false to use server provided wsdl file that will
236              be retrieved automatically.
237
238
239   RHEV-M BACKEND
240       server The default port number is 8443 (that was used  the  default  in
241              RHEV-M  <=  3.0).  Newer  RHEV-M  installations uses port 443 by
242              default. Use correct value for your server in format:
243
244              server=<HOSTNAME_OR_IP_ADDRESS>:<PORT_NUMBER>
245
246
247   FAKE BACKEND
248       Fake backend reads host/guests associations from the file on disk,  for
249       example:
250
251       [fake-virt]
252       type=fake
253       file=/path/to/json
254       is_hypervisor=True
255
256
257       type   Must be always fake.
258
259
260       is_hypervisor
261              If  true (default), the option determines that the fake data are
262              fetched from multihost environment.
263
264
265       file   Absolute path to the JSON file that has the  same  structure  as
266              file returned from virt-who --print command, for example:
267              {
268                  "hypervisors": [
269                      {
270                          "uuid": "7e98b6ea-0af1-4afa-b846-919549bb0fe2",
271                          "guests": [
272                              {
273                                  "guestId":
274              "8ae19f08-2605-b476-d42e-4bd5a39f466c",
275                                  "state": 1
276                              },
277                              ...
278                          ]
279                      },
280                      ...
281                  ]
282              }
283
284

AUTHOR

286       Radek Novacek <rnovacek at redhat dot com>
287
288

SEE ALSO

290       virt-who(8), virt-who-password(8)
291
292
293
294virt-who                         October 2015               VIRT-WHO-CONFIG(5)
Impressum