1VIRT-WHO-CONFIG(5) File Formats Manual VIRT-WHO-CONFIG(5)
2
6 virt-who-config - configuration for virt-who
7
9 /etc/sysconfig/virt-who /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 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
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 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
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
73 Each section (or group), denoted by an arbitrary name for the configu‐
74 ration (in square brackets), is read in
75 Only required key is type that has to have one of the allowed virtual‐
77 ization backend names, see virt-who(8).
78 Please note that special characters must not be escaped (opposed to
80 /etc/sysconfig/virt-who).
81 Other options that can be supplied are:
83 server Hostname, IP address or URL of the server that provides virtual‐
85 ization information (not applicable for kubevirt mode).
86 username
88 Username for authentication to the server (not applicable for
89 kubevirt mode). May include domain. Do not escape the backslash
90 between domain and username.
91 password
93 Password for authentication to the server (not applicable for
94 kubevirt mode).
95 encrypted_password
97 Alternative to the password option, encrypted password that is
98 generated by virt-who-password(8) utility.
99 owner Owner for use with Subscription Asset Manager, the Red Hat Cus‐
101 tomer Portal, or Satellite 6 (not applicable for Satellite 5)
102 rhsm_username
104 Optional username to use to communicate with Subscription Asset
105 Manager or Satellite 6 instead of the registered system's iden‐
106 tity certificate. (not applicable for Satellite 5)
107 rhsm_password
109 Optional password to use to communicate with Subscription Asset
110 Manager or Satellite 6 instead of the registered system's iden‐
111 tity certificate. (not applicable for Satellite 5)
112 rhsm_encrypted_password
114 Alternative to the rhsm_password option, encrypted password that
115 is generated by virt-who-password(8) utility.
116 rhsm_hostname
118 Optional hostname of the Subscription Asset Manager or Satellite
119 6 server to use in place of the host defined in the system's
120 rhsm.conf.
121 rhsm_port
123 Optional port for the Subscription Asset Manager or Satellite 6
124 server to use in place of the port defined in the system's
125 rhsm.conf.
126 rhsm_prefix
128 Optional prefix for the Subscription Asset Manager or Satellite
129 6 server to use in place of the prefix defined in the system's
130 rhsm.conf.
131 rhsm_proxy_hostname
133 Optional proxy host name for the Subscription Asset Manager or
134 Satellite 6 server to use in place of the proxy host name
135 defined in the system's rhsm.conf.
136 rhsm_proxy_port
138 Optional proxy port for the Subscription Asset Manager or Satel‐
139 lite 6 server to use in place of the proxy port defined in the
140 system's rhsm.conf.
141 rhsm_proxy_user
143 Optional proxy username for the Subscription Asset Manager or
144 Satellite 6 server to use in place of the proxy username defined
145 in the system's rhsm.conf.
146 rhsm_proxy_password
148 Optional proxy password for the Subscription Asset Manager or
149 Satellite 6 server to use in place of the proxy password defined
150 in the system's rhsm.conf.
151 rhsm_encrypted_proxy_password
153 Alternative to the rhsm_proxy_password option; encrypted pass‐
154 word generated by the virt-who-password(8) utility.
155 rhsm_no_proxy
157 As per the NO_PROXY parameter in SYSCONFIG.
158 sat_server
160 Hostname, IP address or URL of the Satellite 5 server.
161 sat_username
163 Username for authentication to the Satellite 5 server.
164 sat_password
166 Password for authentication to the Satellite 5 server.
167 sat_encrypted_password
169 Alternative to sat_password option, encrypted password that is
170 generated by virt-who-password(8) utility.
171 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 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 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 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 #kubeconfig
204 Path to Kubernetes configuration file which contains authentica‐
205 tion and connection details. Used by kubevirt option
206 #kubeversion
208 API version used to override kubevirt api version fetched from
209 the cluster. Used by kubevirt option
210
213 [test-esx]
214 type=esx
215 server=1.2.3.4
216 username=admin
217 password=password
218 owner=test
219 rhsm_username=admin
220 rhsm_password=password
221
224 ESX BACKEND
225 filter_host_parents
226 Only hosts which cluster ID is specified in comma-separated list
227 in this option will be reported. Put the name into the double-
228 quotes if it contains special characters (like comma). PowerCLI
229 command to find the domain names in VMware `Get-Cluster “Clus‐
230 terName” | Select ID`
231 exclude_host_parents
233 Exclude hosts which cluster ID is specified in comma-separated
234 list in this option will NOT be reported. Put the name into the
235 double-quotes if it contains special characters (like comma).
236 PowerCLI command to find the domain names in VMware `Get-Cluster
237 “ClusterName” | Select ID`
238 simplified_vim
240 virt-who by default uses stripped-down version of vimSer‐
241 vice.wsdl file that contains vSphere SOAP API definition. Set
242 this option to false to use server provided wsdl file that will
243 be retrieved automatically.
244 RHEV-M BACKEND
247 server The default port number is 8443 (that was used the default in
248 RHEV-M <= 3.0). Newer RHEV-M installations uses port 443 by
249 default. Use correct value for your server in format:
250 server=<HOSTNAME_OR_IP_ADDRESS>:<PORT_NUMBER>
252 KUBEVIRT BACKEND
255 Kubevirt backend uses a Kubernetes configuration file where there are
256 cluster connection details and an authentication token. There is no
257 need to provide a hostname nor user credentials. Before using the
258 kubeconfig file please make sure to login to the cluster so the token
259 is written to the file. To login you need to run:
260 oc login --username=myuser --password=mypass
262 FAKE BACKEND
265 Fake backend reads host/guests associations from the file on disk, for
266 example:
267 [fake-virt]
269 type=fake
270 file=/path/to/json
271 is_hypervisor=True
272 type Must be always fake.
275 is_hypervisor
278 If true (default), the option determines that the fake data are
279 fetched from multihost environment.
280 file Absolute path to the JSON file that has the same structure as
283 file returned from virt-who --print command, for example:
284 {
285 "hypervisors": [
286 {
287 "uuid": "7e98b6ea-0af1-4afa-b846-919549bb0fe2",
288 "guests": [
289 {
290 "guestId":
291 "8ae19f08-2605-b476-d42e-4bd5a39f466c",
292 "state": 1
293 },
294 ...
295 ]
296 },
297 ...
298 ]
299 }
300
303 Radek Novacek <rnovacek at redhat dot com>
304
307 virt-who(8), virt-who-password(8)
308virt-who October 2015 VIRT-WHO-CONFIG(5)