Configuration Variables

This section describes the configuration variables you can use in:

  • PATROL
  • TrueSight.

as well as those which are specific to the Pure Storage REST API.

For PATROL

This section lists the configuration variables used by Pure Storage KM for PATROL. Configuration variables are stored in the PATROL Agent configuration and can be managed through:

  • PATROL Configuration Manager (PCM)
  • wpconfig (Windows)
  • xpconfig (UNIX/Linux)

The following tables list the configuration variables used by the KM, i.e that apply to all of the monitored hosts.

These following configuration variables are stored under /SENTRY/SEN_PURE in the PATROL Agent’s configuration.

Variables Default Value Description
automaticReinitialization 0 = disabled If set to 1, triggers a re-initialization of the KM, as if the “Reinitialize KM” KM Command had been invoked. The discovery checks this variable every minute and deletes it before performing the re-initialization.
AlertActions n/a List of alert actions to be executed by Pure Storage KM for PATROL upon a problem with the managed Pure Storage system.
collectionHubAdditionalArgs n/a To add arguments to the command line when launching the Java Collection Hub via the Java settings KM Command. For example, enter Xdebug -Xrunjdwp:transport=dt_socket address=4711 server=y suspend=n to launch the KM in debug on a specific port).
collectionHubHeapSizeMax 512 Maximum heap size in megabytes allocated to the Java Collection Hub.
collectionHubHeapSizeMin 128 Minimum heap size in megabytes allocated to Java Collection Hub.
collectionHubOverrideJavaCommandLine None Command line used by the KM to launch the Java Collection Hub. This variable should only be set if instructed by Sentry Support.
debugEndTime None Specifies when the debug mode will be disabled. Format required: YYYY/MM/DD HH:MM:SS
debugMode 0 = disabled When set to ‘1’, enables the debug mode of the KM. Default: Not set
defaultReinitializationOptions None List of default options to be executed by Pure Storage KM for PATROL on reinitialization (resetThresholds, resetThresholdManagementMode, resetAlertActions, resetOtherAlertSettings, resetDebugMode, resetRemovedPausedObjectList, resetReport,resetSecuritySettings, resetJavaSettings). Insert a colon “;” between the variable and its value: “resetThresholds;1”; and if you enter multiple variables, they need to be separated by a carriage return. Example: “resetThresholds;1” will display the remove thresholds option selected by default in the Reinitialize KM wizard.
disableJavaInformationMessage 0 = activated When set to “1”, deactivates the pop-up information message displayed when the Java settings are modified.
disableJRECheck 0 = JRE validation tests enabled When set to 1, disable the validation tests of the JRE used by the KM to run Java code. This can be used to force the KM to use a non-Sun or non-Oracle JRE.
disablePslExecuteBugWorkaround 0 = activated When set to “1”, deactivates the workaround in the KM for a bug in the PslExecute() PSL function. If the KM detects that the version of the PATROL Agent is affected by the PslExecute() bug, it uses an alternate technique to create asynchronous threads with the event_trigger() function and the RemPsl standard event. The disablePslExecuteBugWorkaround variable disables this workaround.
disableVolumeMonitoring 0 = Volume Monitoring enabled When set to 1, deactivates volumes monitoring. When the volumes monitoring is disabled, discovery and collect requests and operations are no longer performed.
exportScheduling None Time when the activity and/or LUNs Mapping Table reports will be generated. Format required: HH:MM:SS
forceClassicConfigMode 0 = disabled When the KM is used with BMC TrueSight Operations Management, all the KM configuration menus are disabled in the PATROL Consoles. To enable them, set the forceClassicConfigMode variable to 1.
javaPassword None Password associated to the javaUsername variable.
javaPath None Path to the folder containing the Java executable used by the Collection Hub.
javaUsername None Username used to launch the Java Collection Hub.
pausedObjectList n/a List of the PATROL object path of the paused objects. (i.e. for which no collection will be performed).
productVersion Automatically set by the KM during its initialization Identifies the current version of the KM in the configuration. Do not alter this value.
psCommand n/a Command used on UNIX/Linux systems to retrieve the list of the currently running processes. Please note that this command is used for debug purpose.
removedObjectList n/a List of instances that have been removed from the monitoring environment through the Remove KM Command.
retryDiscoveryAfterNTimes 5 Specifies the maximum number of retries when the discovery fails.
scheduledReports n/a List of reports that will be automatically generated. Possible values: ACTIVITY to generate storage systems and volumes reports; LUNS_MAPPING_TABLE to list mapped and unmapped LUNs. Values must be delimited by carriage returns.
startupDelay 0 second To specify the number of seconds that Pure Storage KM for PATROL will wait before starting its discovery.
ThresholdsManagementMode Retrieved from the KM configuration Specifies how the KM should manage the alert thresholds on parameters. Please read carefully the Managing Thresholds section for more information on this topic. Possible values: empty (automatic detection of the suitable threshold management); as (through PATROL for Event Management); tuning (through the standard “Override parameter” mechanism); none (No threshold is set by the KM)

For TrueSight

Variable Default Value Description
collectionHubAdditionalArgs n/a To add arguments to the command line when launching the Java Collection Hub via the Java settings KM Command. For example, enter Xdebug -Xrunjdwp:transport=dt_socket address=4711 server=y suspend=n to launch the KM in debug on a specific port.
collectionHubHeapSizeMax 1024 Maximum heap size in megabytes allocated to the Java Collection Hub.
collectionHubHeapSizeMin None Minimum heap size in megabytes allocated to Java Collection Hub.
collectionHubOverrideJavaCommandLine None Command line used by the KM to launch the Java Collection Hub. This variable should only be set if instructed by Sentry Support.
defaultReinitializationOptions None List of default options to be executed by Pure Storage KM for PATROL on reinitialization (resetThresholds, resetThresholdManagementMode, resetAlertActions, resetOtherAlertSettings, resetDebugMode, resetRemovedPausedObjectList, resetReport,resetSecuritySettings, resetJavaSettings). Insert a colon “;” between the variable and its value: “resetThresholds;1”; and if you enter multiple variables, they need to be separated by a carriage return. Example: “resetThresholds;1” will display the remove thresholds option selected by default in the Reinitialize KM wizard.
disableJRECheck 0 = JRE validation tests enabled When set to 1, disable the validation tests of the JRE used by the KM to run Java code. This can be used to force the KM to use a non-Sun or non-Oracle JRE.
disablePslExecuteBugWorkaround 0 = activated When set to “1”, deactivates the workaround in the KM for a bug in the PslExecute() PSL function. If the KM detects that the version of the PATROL Agent is affected by the PslExecute() bug, it uses an alternate technique to create asynchronous threads with the event_trigger() function and the RemPsl standard event. The disablePslExecuteBugWorkaround variable disables this workaround.
forceClassicConfigMode 0 = disabled When the KM is used with BMC TrueSight Operations Management, all the KM configuration menus are disabled in the PATROL Consoles. To enable them, set the forceClassicConfigMode variable to 1.
javaPassword None Password associated to the javaUsername variable.
javaPath None Path to the folder containing the Java executable used by the Collection Hub.
javaUsername None Username used to launch the Java Collection Hub.
pausedObjectList n/a List of the PATROL object path of the paused objects. (i.e. for which no collection will be performed).
psCommand n/a Command used on UNIX/Linux systems to retrieve the list of the currently running processes. Please note that this command is used for debug purpose.
removedObjectList n/a List of instances that have been removed from the monitoring environment through the Remove KM Command.
retryDiscoveryAfterNTimes 5 Specifies the maximum number of retries when the discovery fails.
startupDelay 0 second To specify the number of seconds that Pure Storage KM for PATROL will wait before starting its discovery.

Adding Configuration Variables to a Policy

  1. Edit your Pure Storage monitoring policy:

    Editing the Pure Storage Monitoring Policy

    • Log on to the TrueSight console.
    • In the navigation pane, expand Configuration and select Infrastructure Policies.
    • In the Infrastructure Policies page, locate the monitoring policy you wish to modify, click its action button inline and click Edit.

  2. Edit the Monitoring Configuration and scroll down to the Advanced Configuration Variables section:

    Adding a configuration variable

  3. Click Add to open the Configuration Variables panel. Enter the name of the configuration variable and enter the value to be set. Refer to the table above to learn about all the configuration variables you can use to perform operations you cannot complete with the console standard user interface (The Name field is case sensitive).

    Adding a configuration variable

  4. Click OK.

    Viewing the configuration variables list

  5. The configuration variable is then listed in the Additional Configuration Variables section.

Editing a Configuration Variable in a Policy

  1. Edit your Pure Storage monitoring policy:

    Editing the Pure Storage Monitoring Policy

    • Log on to the TrueSight console.
    • In the navigation pane, expand Configuration and select Infrastructure Policies.
    • In the Infrastructure Policies page, locate the monitoring policy you wish to modify, click its action button inline and click Edit.

  2. Edit the Monitoring Configuration, scroll down to the Advanced Configuration Variables section, click the action button inline next to the configuration variable you wish to modify and click Edit.

    Adding a configuration variable

  3. Make the modifications required.

  4. Click OK.
  5. Click Save.

Deleting a Configuration Variable from a Policy

  1. Edit your Pure Storage monitoring policy:

    Editing the Pure Storage Monitoring Policy

    • Log on to the TrueSight console.
    • In the navigation pane, expand Configuration and select Infrastructure Policies.
    • In the Infrastructure Policies page, locate the monitoring policy you wish to modify, click its action button inline and click Edit.

  2. Edit the Monitoring Configuration, scroll down to the Advanced Configuration Variables section, click the action button inline next to the configuration variable you wish to delete and click Delete.

    Deleting a configuration variable

  3. Click Yes

  4. Click OK
  5. Click Save.

For the Pure Storage REST API

The following configuration variables are specific to the Pure Storage REST API. When set, the following variables override the global configuration variables.

Variable Default Value Description
apiToken None API Token to be used to connect to the Pure Storage system and perform queries.
collectOperationTimeout 6000 minutes To customize the timeout of the collect process. When the timeout is reached, the CollectionStatus parameter of the related SEN_PURE_STORAGESYSTEM application class is set to 2 (Failure) and triggers an alert.
disableVolumeMonitoring 0 = Volume Monitoring enabled When set to 1, deactivates volumes monitoring. When the volumes monitoring is disabled, discovery and collect requests and operations are no longer performed.
discoveryOperationTimeout 6000 minutes To customize the timeout of the discovery process. When the timeout is reached, the collectionStatus parameter of the SEN_PURE_MAIN application class is set to 2 (Failure) and triggers an alert.
excludeVolumes None Filter to exclude all volumes whose names match the specified regular expression.
hostname None Hostname of the Pure Storage system. This variable is MANDATORY and should therefore NEVER be removed.
Keywords:
storage pure km patrol
Table of Contents