Supported Installer Variables
All BMC TrueSight Pulse meter installer packages and scripts can modify their default behavior by setting various environment variables. These settings work the same whether one installs the meter package using a native package manager such as rpm, apt, yum, zypper, pkg_add, msiexec, or using the setup_meter.sh script. Supported installation variables are:
- INSTALLTOKEN: use to allow the installer to automatically provision itself with BMC TrueSight Pulse. The meter will additionally save a copy of the token in a private config file that can be used later for interacting with other Pulse services.
- METERPRODUCTDIR: (windows only) use when an alternative installation directory is required. This takes the place of the traditional msiexec INSTALLDIR.
- PROVISIONHOSTNAME: allows the user to provision the host with a different name than the default host name. Useful for distinguishing several machines with the same name.
- PROVISIONTAGS: allows the user to tag meters directly as part of the installation process, ex PROVISIONTAGS=webserver,internal,pulse
- PROVISIONDOMAIN: if not set, defaults to 'truesight.bmc.com', specify another value to provision in a private SaaS environment
- PROVISIONFEATURES: if not set, defaults to 'flow_metrics', specify a comma-separated list of the words 'server_metrics', 'flow_metrics' to specify particular features to enable with this meter.
- TLSSKIPVALIDATION: enable debugging SSL connectivity in a test environment
- COLLECTORPORT: override the default collector ports of 4740 and 443. You can either specify a single port, or a set of comma separated ports to try, e.g. COLLECTORPORT=4740,443
- DISABLENTP: disables the built-in NTP client. In meters 2.0.x and earlier, the NTP client is enabled by default. In meters 3.0.0 and later, the NTP client is disabled in favor of in-band time synchronization, so this option has no effect. (2.0.3 and later)
- ENABLESTUN: enables the built-in STUN client support. If this is enabled, the meter will use the STUN protocol to discover public IP addresses for each internal interface with a private address. (2.0.3 and later)
- HTTPS_PROXY: Specify a HTTPS-capable proxy to use when accessing the APIs to provision the meter. This supports the same syntax as the CURL utility, e.g. HTTPS_PROXY=proxy-server:8888 (3.0.0 and later)
Examples with various package installation methods
sudo PROVISIONHOSTNAME=host \ PROVISIONTAGS=server,blue \ HTTPS_PROXY=localproxy:8888 \ ENABLESTUN=1 \ ./setup_meter.sh -i api.0123456789-0123
sudo PROVISIONHOSTNAME=host \ PROVISIONTAGS=server,blue \ HTTPS_PROXY=localproxy:8888 \ ENABLESTUN=1 \ INSTALLTOKEN=api.0123456789-0123 \ rpm -i truesight-meter-*.rpm
sudo PROVISIONHOSTNAME=host \ PROVISIONTAGS=server,blue \ HTTPS_PROXY=localproxy:8888 \ ENABLESTUN=1 \ INSTALLTOKEN=api.0123456789-0123 \ dpkg -i truesight-meter-*.dpkg
Windows (Silent Install)
msiexec /l*v truesight-meter.log /qn /i truesight-meter-current.msi INSTALLTOKEN=api.0123456789-0123 PROVISIONHOSTNAME=host PROVISIONTAGS=server,blue HTTPS_PROXY=localproxy:8888 ENABLESTUN=1