Configuration Variables

Home  Previous  Next

This section lists the configuration variables used by IBM XiV 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 recapitulate 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_XIV in the PATROL Agent’s configuration.

Variables

Default Value

Description

AlertActions

n/a

List of alert actions to be executed by IBM XiV KM for PATROL upon a problem with the managed IBM XiV storage system.

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.

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

None

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.

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 IBM XiV 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.

disableMissingDeviceDetection

None

When set to "1", disables the missing device detection mechanism of IBM XiV KM. By default, IBM XiV KM raises an alarm for devices that were discovered and that are no longer discovered.

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 Virtual Volumes Mapping Table reports will be generated. Format required: HH:MM:SS

forceClassicConfigMode

0 = disabled

When the KM is used with BMC ProactiveNet, 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

n/a

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.

Note: 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.

scheduledReports

n/a

List of reports that will be automatically generated. Possible values:

ACTIVITY to generate storage systems, nodes, physical disks, ports and volumes activity reports
VIRTUAL_VOLUMES_MAPPING_TABLE to list mapped and unmapped virtual volumes.

 

Values must be delimited by \n.

startupDelay

0 seconds

To specify the number of seconds that IBM XiV 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 Thresholds, Alerts and Notifications chapter for more information on this topic.

Possible values:

‘as’ (through PATROL for Event Management)
‘tuning’ (through the standard "Override parameter" mechanism)
‘none’ (No threshold is set by the KM)

unknownStatusManagement

1= Warning

Status value to map when received the unknown status.

0 -> Set the status parameter to OK

1 -> Trigger a WARNING (default)

2 -> trigger an Alarm

The following configuration variables are specific to the SMI-S Provider and require the use of the SMI-S Provider ID as a prefix. When set, the following variables override the global configuration variables.

Variable

Default Value

Description

collectOperationTimeout

6000 minutes

To customize the timeout of the collect process. When the timeout is reached, the CollectionStatus parameter of the related SEN_XIV_SMISPROVIDER application class is set to 2 (Failure) and triggers an alert.

discoveryOperationTimeout

6000 minutes

To customize the timeout of the discovery process. When the timeout is reached, the CollectionStatus parameter of the SEN_XIV_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 SMI-S provider.

includeVolumes

None

Filter to keep only volumes whose names match the specified regular expression.

password

None

Password used to perform queries.

port

5989

Port used to perform queries.

protocol

HTTPS

Protocol. By default HTTPS.

userName

None

Username used to perform queries.