1VIRT-WHO-CONFIG(5) File Formats Manual VIRT-WHO-CONFIG(5)
2
6 virt-who-config - configuration for virt-who
7
9 /etc/virt-who.conf /etc/virt-who.d/*.conf
10
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
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 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 interval
36 how often to check connected hypervisors for changes (seconds).
37 Also affects how often a mapping is reported.
38 reporter_id
40 The id of this virt-who instance, reported with all mappings.
41 Defaults to HOSTNAME-MACHINEID
42 debug Enable debugging output
44 oneshot
46 Send the list of guest IDs and exit immediately
47 log_per_config
49 Write a seperate log file per configuration in the config direc‐
50 tory
51 log_dir
53 The absolute path of the directory to write logs to.
54 log_file
56 The file name to write logs to (used only if log_per_con‐
57 fig=False)
58 configs
60 A list of files containing configurations for virt-who Used to
61 specify locations other than default
62 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 HTTPS_PROXY
69 Proxy hostname for all https requests
70 HTTP_PROXY
72 Proxy hostname for all http requests
73 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
82 Each section (or group), denoted by an arbitrary name for the configu‐
83 ration (in square brackets), is read in
84 Only required key is type that has to have one of the allowed virtual‐
86 ization backend names: libvirt, esx, rhevm, hyperv, fake, xen, or kube‐
87 virt.
88 Please note that special characters must not be escaped.
90 Other options that can be supplied are:
92 server Hostname, IP address or URL of the server that provides virtual‐
94 ization information (not applicable for kubevirt mode).
95 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 password
102 Password for authentication to the server (not applicable for
103 kubevirt mode).
104 encrypted_password
106 Alternative to the password option, encrypted password that is
107 generated by virt-who-password(8) utility.
108 owner Owner for use with Subscription Asset Manager, the Red Hat Cus‐
110 tomer Portal, or Satellite 6 (not applicable for Satellite 5)
111 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 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 rhsm_encrypted_password
123 Alternative to the rhsm_password option, encrypted password that
124 is generated by virt-who-password(8) utility.
125 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 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 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 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 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 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 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 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 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 sat_server
171 Hostname, IP address or URL of the Satellite 5 server.
172 sat_username
174 Username for authentication to the Satellite 5 server.
175 sat_password
177 Password for authentication to the Satellite 5 server.
178 sat_encrypted_password
180 Alternative to sat_password option, encrypted password that is
181 generated by virt-who-password(8) utility.
182 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 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 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 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 #kubeconfig
215 Path to Kubernetes configuration file which contains authentica‐
216 tion and connection details. Used by kubevirt option
217 #kubeversion
219 API version used to override kubevirt api version fetched from
220 the cluster. Used by kubevirt option
221 #insecure
223 Eliminate validation of tls certificates during connection to
224 kubevirt
225
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
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 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 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 RHEV-M BACKEND
262 server The default port number is 8443 (that was used the default in
263 RHEV-M <= 3.0). Newer RHEV-M installations uses port 443 by de‐
264 fault. Use correct value for your server in format:
265 server=<HOSTNAME_OR_IP_ADDRESS>:<PORT_NUMBER>
267 KUBEVIRT BACKEND
270 Kubevirt backend uses a Kubernetes configuration file where there are
271 cluster connection details and an authentication token. There is no
272 need to provide a hostname nor user credentials. Before using the
273 kubeconfig file please make sure to login to the cluster so the token
274 is written to the file. To login you need to run:
275 oc login --username=myuser --password=mypass
277 FAKE BACKEND
280 Fake backend reads host/guests associations from the file on disk, for
281 example:
282 [fake-virt]
284 type=fake
285 file=/path/to/json
286 is_hypervisor=True
287 type Must be always fake.
290 is_hypervisor
293 If true (default), the option determines that the fake data are
294 fetched from multihost environment.
295 file Absolute path to the JSON file that has the same structure as
298 file returned from virt-who --print command, for example:
299 {
300 "hypervisors": [
301 {
302 "uuid": "7e98b6ea-0af1-4afa-b846-919549bb0fe2",
303 "guests": [
304 {
305 "guestId":
306 "8ae19f08-2605-b476-d42e-4bd5a39f466c",
307 "state": 1
308 },
309 ...
310 ]
311 },
312 ...
313 ]
314 }
315
318 Previous versions of virt-who employed additional means of configura‐
319 tion:
320 Setting of environment variables [set in the user's profile script or
322 in the default global profile]
323 A service environment file [/etc/sysconfig/virt-who]
324 The new version of virt-who no longer supports setting most options via
326 the environment. In order to not lose previously valid configurations
327 that made use of environment variables, a migration script has been
328 added. That script will incorporate the known system environment vari‐
329 ables [VIRTWHO_INTERVAL, VIRTWHO_DEBUG, VIRTWHO_ONESHOT] and the en‐
330 tries in the service environment file into the general configuration
331 file. The known variables will land in the global section while any
332 others in the service environment file [i.e. HTTPS_PROXY] will land in
333 the system_environment section. This migration may result in multiple
334 entries for a specific field.
335 Each new entry in the general configuration file will come after a com‐
337 ment indicating that it was migrated. The service environment file will
338 be deleted after its entries are migrated, but the known system envi‐
339 ronment variables will need to be manually removed or they will be mi‐
340 grated again if the script is rerun. Those variables will not be recog‐
341 nized by virt-who even if they remain.
342 The migration script will be run when a new RPM is installed, but you
344 can run it manually with python after the RPM is installed:
345 [python_sitelib]/virtwho/migrate/migrateconfiguration.py
347
351 Radek Novacek <rnovacek at redhat dot com>
352 William Poteat <wpoteat at redhat dot com>
353
356 virt-who(8), virt-who-password(8)
357virt-who October 2015 VIRT-WHO-CONFIG(5)