Advanced Configuration Variables
This section lists the configuration variables you can use in TrueSight.
Global Configuration Variables
This section lists the configuration variables used by Storage Analyzer globally, i.e that apply to all of the monitored hosts. These configuration variables are stored under /SENTRY/STORAGE in the PATROL Agent’s configuration and can be managed through the Configuration Variables pane.
These variables should only be set when instructed by Sentry Software Support.
To manage configuration variables:
- Log on to the TrueSight console.
- Edit your storage monitoring policy.
- Click the Configuration Variables tab.
- Click Add Configuration Variable.
| Variable | Description |
|---|---|
| /SENTRY/STORAGE/automaticReinitialization | If set to 1, will perform a KM reinitialization. /SENTRY/STORAGE/defaultReinitializationOptions may be used to indicate which options should be reinitialized. By default, no options are reinitialized. |
| /SENTRY/STORAGE/collectionErrorCountAutoAcknowledgeTime | Number of seconds after which the CollectionErrorCount parameter will be automatically set to 0, canceling any alerts. Default: 8100 seconds (2h15). |
| /SENTRY/STORAGE/collectionHubHeapSizeMax | Maximum heap size in megabytes allocated to the Java Collection Hub. Default: Not set (assumed 2048 MB). |
| /SENTRY/STORAGE/collectionHubHeapSizeMin | Minimum heap size in megabytes allocated to Java Collection Hub. Default: Not set (assumed 128 MB). |
| /SENTRY/STORAGE/collectionHubOverrideJavaCommandLine | Command line used by the KM to launch the Java Collection Hub. Default: Not set. This variable should only be set if instructed by Sentry Support. |
| /SENTRY/STORAGE/debugEndTime | Specifies when the debug mode will be disabled. Format required: YYYY/MM/DD HH:MM:SS. |
| /SENTRY/STORAGE/debugHostList | List of endpoint IDs for which the debug mode is enabled. This list is automatically deleted when the debug mode is set to Off (0). |
| /SENTRY/STORAGE/debugMode | When set to 1, enables the debug mode of Storage Analyzer KM for PATROL. Default: Not set. |
| /SENTRY/STORAGE/defaultCollectInterval | Interval between two collects of endpoint parameters if no custom collect interval has been set at the endpoint level. |
| /SENTRY/STORAGE/defaultDiscoveryInterval | Interval between two endpoint environment discoveries if no custom discovery interval has been set at the endpoint level. |
| /SENTRY/STORAGE/defaultReinitializationOptions | List of default options to be executed by the KM upon reinitialization:
Insert a colon “;” between the variable and its value (ex: resetTimeouts;1). Multiple variables need to be separated by a carriage return. |
| /SENTRY/STORAGE/disableJRECheck | To disable the validation tests of the JRE used by the KM to run Java code and therefore force the KM to use a non-Sun or non-Oracle JRE. |
| /SENTRY/STORAGE/disableMissingDeviceDetection | When set to 1, disables the missing device detection mechanism of the KM. By default, the KM raises an alarm for devices that were discovered and that are no longer discovered. |
| /SENTRY/STORAGE/forceClassicConfigMode | Makes the KM ignore policies sent by BMC TrueSight CA and retrieve the configuration through the /SENTRY/STORAGE path. To enable this mode, set the forceClassicConfigMode variable to 1. |
| /SENTRY/STORAGE/forceDiscovery | If set to 1, the KM will trigger a global discovery. It may take up to a minute for the discovery to start. |
| /SENTRY/STORAGE/globalDiscoveryTimeout | Maximum time in seconds the main discovery process waits for the previous discovery to complete. When this timeout is reached, it means the previous discovery did not complete in a timely fashion. A collection error is triggered and the discovery is canceled. Default: Not set (assumed 300 seconds). |
| /SENTRY/STORAGE/javaPassword | Password associated to the javaUsername variable. |
| /SENTRY/STORAGE/javaPath | Path to the folder containing the Java executable used by the Collection Hub. Default: Not set (The KM will search for a suitable JRE automatically). |
| /SENTRY/STORAGE/javaUsername | Username used to launch the Java Collection Hub. Default: Not set. |
| /SENTRY/STORAGE/messageAnnotate | Alert message annotations activation and content: <activation>;<content>. <activation> must be set to 1 for the annotation to be added to the graph when thresholds are breached. <content> is the text of the annotation which by default is “% {PROBLEM}%{NEWLINE}%{NEWLINE}%{RECOMMENDED_ACTIONS}”. |
| /SENTRY/STORAGE/messageEventCollectionError | Event triggered when a collection error is reported: The event type can be “none”, “standard” or “specific”. The default content is “Collection problem on %{ENDPOINT_ID} (%{ENDPOINT_HOSTNAME}): %{ENDPOINT_COLLECTIONSTATUSINFORMATION}%{NEWLINE}%{NEWLINE}%{PROBLEM}%{NEWLINE}%{NEWLINE}%{RECOMMENDED_ACTIONS}”. |
| /SENTRY/STORAGE/messageEventStorageError | Event triggered when parameter thresholds are breached: <event type>;<content>. The event type can be “none”, “standard” or “specific”. The default content is: %{OBJECT_TYPE} problem on %{DEVICE_HOSTNAME} with %{OBJECT_LABEL}. %{PARAMETER_TITLE} = %{PARAMETER_VALUE} %{PARAMETER_UNITS}%{NEWLINE}%{NEWLINE}%{PROBLEM}%{NEWLINE}%{NEWLINE}%{RECOMMENDED_ACTIONS}. |
| /SENTRY/STORAGE/messageLog | Filepath and content written to the file when parameter thresholds are breached: <path>;<content>. By default, the content is: % {TIME:%Y-%m-%d %H:%M:%S}%{SEMICOLON}%{ENDPOINT_ID}%{SEMICOLON}%{ENDPOINT_HOSTNAME}%{SEMICOLON}%{ENDPOINT_FQDN}%{SEMICOLON}%{ALARM_TYPE}%{SEMICOLON}%{OBJECT_TYPE}%{SEMICOLON}%{PARAMETER_NAME}%{SEMICOLON}%{PARAMETER_VALUE}. |
| /SENTRY/STORAGE/noMissingDeviceDetectionClasses | List of classes that will not trigger missing device alerts. Typically, the related classes are SKM_MAIN, SKM_ENDPOINT, SKM_STORAGEPOOL and SKM_VOLUME. |
| /SENTRY/STORAGE/rediscoverEndpoints | Comma separated list of endpoint IDs for which a rediscover should be performed. It may take up to a minute for the endpoints rediscovery to start. |
| /SENTRY/STORAGE/removeMissingDevicesOnStartup | When set to 1, deletes the list of previously discovered devices. This setting prevents false “missing device” alerts to be triggered on startup. Note: Devices that went missing during the startup (reboot) operation will not be reported as missing. Default: 0. |
| /SENTRY/STORAGE/startupDelay | Allows the administrator to specify the number of seconds that the KM will wait before starting the global discovery. Default: Not set (zero). |
Endpoint-Specific Configuration Variables
The configuration variables listed below are used by Storage Analyzer KM for PATROL for each monitored endpoint. They are stored under /SENTRY/STORAGE/<endpoint-id> in the PATROL Agent’s configuration.
| Variable | Description |
|---|---|
| /SENTRY/STORAGE/<endpoint-id>/associatedFQDN | Replaces the device MetaFQDN by the provided FQDN to attach the endpoint to a device in TrueSight. |
| /SENTRY/STORAGE/<endpoint-id>/clientTimeout | Duration in minutes after which the endpoint should be considered as not responding and a query stopped. |
| /SENTRY/STORAGE/<endpoint-id>/collectInterval | Data polling frequency, in minutes. |
| /SENTRY/STORAGE/<endpoint-id>/disableVolumeMonitoring | Disables the monitoring of volumes or the endpoint (0 = enabled; 1 = disabled). |
| /SENTRY/STORAGE/<endpoint-id>/discoveryInterval | Discovery frequency, in minutes, to discover new devices. |
| /SENTRY/STORAGE/<endpoint-id>/enableHardwareMonitoring | Enables (1) or disables (0) the monitoring of hardware components through Hardware Sentry KM. Default: Disabled (0). |
| /SENTRY/STORAGE/<endpoint-id>/hostname | Hostname or IP address to be used to communicate with the endpoint. |
| /SENTRY/STORAGE/<endpoint-id>/password | Encrypted password used to connect to the endpoint. |
| /SENTRY/STORAGE/<endpoint-id>/port | Port used by the KM to perform the queries to the endpoint. |
| /SENTRY/STORAGE/<endpoint-id>/protocol | Protocol (HTTP or HTTPs) used to communicate with the endpoint. Default: HTTPS. |
| /SENTRY/STORAGE/<endpoint-id>/si | Filename of the Storage Intelligence Adapter the KM should use to monitor the endpoint. |
| /SENTRY/STORAGE/<endpoint-id>/siliciumTimeout | Duration in minutes after which the engine should be stopped when querying the endpoint. |
| /SENTRY/STORAGE/<endpoint-id>/username | The username used to connect to the endpoint. |
Keywords:
storage km patrol
storage km patrol
Table of Contents