Subversion Repositories configs

Rev

Rev 203 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
204 - 1
# Copyright (c) 2019-2021 VMware, Inc.  All rights reserved.
192 - 2
 
3
# "CAUTION: tools.conf is highly syntax sensitive file. Use extreme caution
4
# while editing it. If modified, it is automatically re-loaded by
5
# VMware Tools services every 5 seconds."
6
#
7
# Lines must not end with trailing white space.
8
 
9
[unsetenvironment]
10
# Defines environment variables to be removed from the service reading
11
# the configuration file. Supported formats are:
12
#
13
# 1. <variableName>=
14
# 2. <serviceName>.<variableName>=
15
#
16
# Where <serviceName> refers to the 'vmsvc' and 'vmusr',
17
# <variableName> refers to the name of the environment
18
# variable to be removed. '=' sign after <variableName>
19
# is mandatory to maintain the configuration file syntax.
20
# However, anything after '=' is ignored.
21
#
22
# Case-sensitive behavior is defined by the operating system.
23
#
24
# Note: unsetenvironment group is processed before setenvironment group.
25
# As the service environment is setup at start up time, any changes
26
# in this group require service to be restarted in order to take effect.
27
#
28
# Unsetting PATH for all services:
29
# PATH=
30
#
31
# Unsetting PATH for vmsvc only:
32
# vmsvc.PATH=
33
#
34
# Unsetting PATH for vmusr only:
35
# vmusr.PATH=
36
 
37
[setenvironment]
38
# Defines environment variables to be set for the service reading
39
# the configuration file. Supported formats are:
40
#
41
# 1. <variableName>=<variableValue>
42
# 2. <serviceName>.<variableName>=<variableValue>
43
#
44
# Where <serviceName> refers to the 'vmsvc' and 'vmusr',
45
# <variableName> refers to the name of the environment
46
# variable to be set, and <variableValue> refers to the
47
# value to be assigned to the environment variable.
48
#
49
# Case-sensitive behavior is defined by the operating system.
50
#
51
# Note: setenvironment group is processed after unsetenvironment group.
52
# As the service environment is setup at start up time, any changes
53
# in this group require service to be restarted in order to take effect.
54
#
55
# Setting TMPDIR for all services:
56
# TMPDIR=/vmware/temp
57
#
58
# Setting TMPDIR for vmsvc only:
59
# vmsvc.TMPDIR=/vmware/vmsvc/temp
60
#
61
# Setting TMPDIR for vmusr only:
62
# vmusr.TMPDIR=/vmware/vmusr/temp
63
 
64
[logging]
65
# set to false to disable logging
66
#log = true
67
 
68
# Log destinations for various services
69
# By default, logs go to
70
# %windir%/temp/vmware-<servicename>.log
71
# for Windows, and
72
# /var/log/vmware-<servicename>-<username>.log
73
# for Linux, MacOS and Solaris.
74
 
75
# Possible values for handler are:
76
# file: logs to a file. Set *.data to the file name
77
# file+: same as 'file', but appends to the file
78
#  All file paths used in *.data value need to be in Unix
79
#  format (forward slashes) and in utf-8, for all operating
80
#  systems.
81
# vmx: logs to the host (ESXi, Workstation, Fusion)
82
# std: Logs to stdout for level >= 'message',
83
# and to stderr for more severe than 'message'.
84
# syslog: logs to syslog
85
# outputdebugstring: uses OutputDebugString (Windows only)
86
 
87
# If handler is 'syslog' and the OS is Linux, the facility
88
# can be set with <domain>.facility. The facility value can be one of
89
# 'local0'..'local7', 'daemon' or 'user'. The default is 'user'.
90
#vmtoolsd.facility = user
91
 
92
# possible values for level are:
93
# debug, info, message, warning, critical, error
94
# Note that "debug" level logs generate huge amounts of logs and may also
95
# include sensitive data required for diagnosis. Therefore, this level should
96
# be used only for the duration of diagnosis of an issue and reverted back to
97
# default setting post diagnosis.
98
 
99
# Enable tools service logging to a file.
100
#vmtoolsd.level = debug
101
#vmtoolsd.handler = file
102
#vmtoolsd.data = c:/tmp/vmtoolsd-${USER}.log
103
 
104
# Enable 'vmsvc' service logging to a file.
105
#vmsvc.level = debug
106
#vmsvc.handler = file
107
#vmsvc.data = c:/tmp/vmsvc.log
108
 
109
# Enable VMwareResolutionSet.exe logging to a file.
110
# Comment this for Linux guest, sometimes vmusr logs are not generated due
111
# to this being uncommented
112
#vmresset.level = debug
113
#vmresset.handler = file+
114
#vmresset.data = c:/tmp/vmresset.log
115
 
116
# Enable new "vmusr" service logging to a file.
117
#vmusr.level = debug
118
#vmusr.handler = file
119
#vmusr.data = c:/tmp/vmusr.${USER}.log
120
 
121
# Set the following configuration if you want to collect the logs for
122
# vmware-toolbox-cmd utility
123
#toolboxcmd.level = debug
124
#toolboxcmd.handler = file
125
#toolboxcmd.data = c:/tmp/vmtoolboxcmd-${USER}.log
126
 
204 - 127
# With no explicit logging configuration for deployPkg, its default log path in
128
# Linux is /var/log/vmware-imc/toolsDeployPkg.log, and in Windows is
129
# %WINDIR%/Temp/vmware-imc/toolsDeployPkg.log
130
# Set the following configuration if you want to redirect the deployPkg log to
131
# any existing location other than the default.
132
#deployPkg.level = debug
133
#deployPkg.handler = file
134
#deployPkg.data = c:/tmp/toolsDeployPkg-${USER}.log
135
 
136
# Redirecting the deployPkg log to the vmx log file. Please note that
137
# "log = true" and the vmsvc log handler setting to vmx are also neccessary
138
# if you want to redirect the deployPkg log to vmx.
139
#log = true
140
#vmsvc.level = debug
141
#vmsvc.handler = vmx
142
#deployPkg.level = debug
143
#deployPkg.handler = vmx
144
 
192 - 145
# Enable old VMwareUser/vmware-user logging to file.
146
#log.file = c:/tmp/vmtools.log
147
 
148
# Enable "hgfsServer" request handling logging to the appropriate service file.
149
#hgfsServer.level = debug
150
 
151
# Enable  "hgfs" manager and transport logging to the appropriate service file.
152
#hgfsd.level = debug
153
 
154
#vmbackup.level = debug
155
#vmbackup.handler = vmx
156
 
157
#vmvss.level = debug
158
#vmvss.handler = vmx
159
 
160
# Default 4096, 0=> disable log caching
161
#maxCacheEntries=4096
162
 
204 - 163
 
164
# Set the following configurations for modifying network script logging file.
165
# Only for Linux, Mac OS X, Solaris, and FreeBSD
166
#network.handler = file
167
#network.data = /tmp/network.log
168
#network.maxOldLogFiles = 9
169
 
170
# Redirect network script logs to vmx
171
#network.handler = vmx
172
 
192 - 173
[powerops]
174
# Custom scripts for power operations
175
# This can be an absolute path, or a path relative to the tools
176
# install path (/etc/vmware-tools/ for Linux).
177
# For more information on configuring and querying custom scripts with
178
# VMware Tools, see the "Use Custom VMware Tools Scripts" section of the
179
# "VMware Tools Configuration Utility User's Guide".
180
 
181
# Runs when the virtual machine is being powered on rather than resumed.
182
# Also runs after virtual machine restarts.
183
# The default script has no effect on networking for the virtual machine.
184
#poweron-script=poweron-vm-default
185
 
186
# Runs when the virtual machine is being powered off or reset.
187
# The default script has no effect on networking for the virtual machine.
188
#poweroff-script=poweroff-vm-default
189
 
190
# Runs when the virtual machine is resumed after it was suspended.
191
# On Windows guest operating systems, if the virtual machine is configured to
192
# use DHCP, the default script renews the IP address of the virtual machine.
193
# On Linux, Mac OS X, Solaris, and FreeBSD guest operating systems,
194
# this script starts networking for the virtual machine.
195
#resume-script=resume-vm-default
196
 
197
# Runs when the virtual machine is being suspended.
198
# On Windows guest operating systems, if the virtual machine is configured
199
# to use DHCP, the default script releases the IP address of the virtual
200
# machine.
201
# On Linux, Mac OS X, Solaris, and FreeBSD, this script stops networking for
202
# the virtual machine.
203
#suspend-script=suspend-vm-default
204
 
205
[guestinfo]
206
 
207
# Set to true to disable the perf monitor.
208
#disable-perf-mon=false
209
 
210
# Set to true to disable DiskInfo.
211
#disable-query-diskinfo=false
212
 
213
# User-defined poll interval in seconds. Set to 0 to disable polling.
214
#poll-interval=30
215
 
216
# User-defined stats interval in seconds. Set to 0 to disable stats collection.
217
#stats-interval=20
218
 
219
# Whether stat results should be written to the log.
220
#enable-stat-logging=false
221
 
222
# Set a comma separated list of network interface names that can be the
223
# primary ones. These will be sorted to the top. Interface names can use
224
# wildcards like '*' and '?'. Default is no value.
225
#primary-nics=
226
 
227
# Set a comma separated list of network interface names that have low priority
228
# (so they will be sorted to the end). Interface names can use wildcards like
229
# '*' and '?'. Default is no value.
230
#low-priority-nics=
231
 
232
# Set a comma separated list of network interface names that shall be ignored.
233
# Interface names can use wildcards like '*' and '?'.
234
# Default for Linux and all non-Windows:
235
#exclude-nics=veth*,docker*,virbr*
236
# Default for Windows:
237
#exclude-nics=vEthernet*
238
 
239
# max umber of IPv4 routes to gather.
240
#max-ipv4-routes=100
241
 
242
# max umber of IPv6 routes to gather.
243
#max-ipv6-routes=100
244
 
245
# whether to include reserved space in diskInfo space metrics on Linux
246
#diskinfo-include-reserved=false
247
 
248
[appinfo]
249
 
250
# This plugin collects info about running applications in guest OS.
251
 
252
# Set to true to disable the appinfo plugin.
253
#disabled=false
254
 
255
# User-defined poll interval in seconds. Set to 0 to disable the plugin.
256
#poll-interval=21600
257
 
258
# For Windows guest, set to true to use WMI for getting the application
259
# version info, otherwise native Win32 API is used.
260
#useWMI=false
261
 
262
[servicediscovery]
263
 
264
# This plugin provides admins with additional info for better VM management.
265
 
266
# Set to true to disable the servicediscovery plugin.
267
#disabled=false
268
 
269
[unity]
270
#
271
# Unity is available for Windows only.
272
#
273
 
274
# Set to true to override system decisions about whether unity should be available.
275
#forceEnable=false
276
 
277
# Override the desktop background color when in Unity mode.
278
#desktop.backgroundColor=
279
 
280
# The socket type can be 'ipsocket' or 'vsocket':
281
#pbrpc.socketType
282
 
283
[resolutionKMS]
284
 
285
# Default is true if tools finds an xf86-video-vmware driver with
286
# version >= 13.2.0. If you don't have X installed, set this to true manually.
287
# This only affects tools for Linux.
288
#enable=true
289
 
290
[guestosinfo]
291
 
292
# Override the short OS name sent by tools.
293
#short-name=
294
 
295
# Override the long OS name sent by tools.
296
#long-name=
297
 
298
[vmbackup]
299
 
204 - 300
# enableSyncDriver is Linux only.
192 - 301
#enableSyncDriver=true
302
 
204 - 303
# enableVSS is Windows only.
192 - 304
#enableVSS=true
305
 
204 - 306
# vss.disableAppQuiescing is Windows only.
307
# This setting can be used to force file system quiescing on Windows systems
308
# having problems with application quiescing.
192 - 309
# See https://kb.vmware.com/s/article/2146204
310
#vss.disableAppQuiescing=false
311
 
312
# Linux:
313
# The value of excludedFileSystems is a comma-separated list of glob-style
204 - 314
# patterns specifying the file system mount points to be excluded from
315
# quiescing operation. The patterns may use '*' (wildcard) to represent
316
# any string of characters and '?' (joker) to represent any single character.
317
# The characters represented by the patterns '*' and '?' may include any
318
# characters, including '/'.
192 - 319
#
320
# Windows:
321
# The value of excludedFileSystems is a comma-separated list of mount points
322
# specifying the volumes to be excluded from quiesced snapshots.
323
# Each mount point must be a full path separated and ended with "\\".
204 - 324
# For example, to exclude volumes with drive letter 'E' or mount point
325
# "F:\mount\", use:
326
# excludedFileSystems=E:\\,F:\\mount\\
327
# This setting is ignored when application quiescing is used.
192 - 328
 
329
#excludedFileSystems=
330
 
204 - 331
# execScripts specifies whether to execute scripts as part of the quiescing
332
# operation. Scripts are executed from the scripts directory along with the
333
# legacy scripts.
192 - 334
#
204 - 335
# Scripts directory:
336
# Linux: /etc/vmware-tools/backupScripts.d
337
# Windows: <Install-Path>\backupScripts.d
192 - 338
#
204 - 339
# Legacy scripts:
340
# Linux: /usr/sbin/pre-freeze-script and /usr/sbin/post-thaw-script
341
# Windows: C:\windows\pre-freeze-script.bat and C:\windows\post-thaw-script.bat
342
#
343
# On each quiescing operation, scripts are invoked before quiescing and
344
# either after a quiescing failure or after thawing.
345
# The first argument passed to each script is
346
# "freeze", when invoked before quiescing;
347
# "freezefail", when invoked after a quiescing failure; or
348
# "thaw", when invoked after thawing.
349
# When invoked before quiescing, scripts from the directory are invoked in
350
# alphabetically ascending order; when invoked following a quiescing failure
351
# or thawing, they are invoked in the reverse order. Any subdirectories are
352
# ignored.
353
# Note that the legacy pre-freeze-script is invoked only before quiescing as
354
# the first script and post-thaw-script is invoked after a quiescing failure
355
# as well as after thawing as the last script.
192 - 356
 
357
#execScripts=true
358
 
204 - 359
# Additional argument to be passed to scripts
192 - 360
#scriptArg=
361
 
362
[guestoperations]
363
 
364
# to disable all guest ops
365
#disabled=false
366
 
367
# Whether to use vgauth for guest op authentication
368
#useVGAuth=true
369
 
370
[autoupgrade]
371
 
372
# The autoupgrade plugin is only available for Windows.
373
 
374
# The "allow-upgrade" option controls whether automatic upgrades (or reinstalls)
375
# are allowed. The two options "allow-add-feature" and "allow-remove-feature"
376
# control whether adding or removing a feature will be allowed. The two latter
377
# ones only affect Windows tools.
378
 
379
#allow-upgrade=true
380
#allow-add-feature=true
381
#allow-remove-feature=true
382
 
383
[deployPkg]
384
 
385
# to disable guest customization
386
#enable-customization=false
387
 
388
[cbhelper]
389
 
390
# The carbonblack helper plugin is only available for Windows.
391
 
392
# User-defined poll interval in seconds. Set to 0 to disable polling.
393
#poll-interval=60
203 - 394
 
395
[gueststoreupgrade]
396
 
397
# The guestStoreUpgrade plugin is only available for Windows.
398
 
399
# The policy value is one of the settings listed below.
400
# off         = no VMware Tools upgrade from GuestStore. Feature is
401
#               disabled.
402
# manual      = (Default) VMware Tools upgrade from GuestStore is
403
#               manually started.
404
# powercycle  = VMware Tools upgrade from GuestStore on system
405
#               power on.
406
 
407
#policy=manual
408
 
409
# Time interval for periodically checking available VMware Tools package
410
# version in the GuestStore.
411
# User-defined poll interval in seconds. Set to 0 to disable polling.
412
# Minimum valid value is 900 seconds (15 minutes)
413
# Default value is 3600 seconds (60 minutes)
414
#poll-interval=3600
415
 
416
# VMware Tools package version metadata key to specify a VMware Tools
417
# package version in the GuestStore.
418
# User-defined key for VMware Tools package version.
419
# Default value is "vmtools" which points to the latest version of
420
# VMware Tools package in the GuestStore.
421
#vmtools-version-key=vmtools
204 - 422
 
423
[devicehelper]
424
 
425
# The deviceHelper plugin is only available for Windows.
426
 
427
# Set to true to disable the deviceHelper plugin.
428
#disabled=false