Using Hardware Sentry

This section describes the most common operations that can be performed with Hardware Sentry.

Scheduling Automatic Reports

Hardware Sentry can automatically produce text reports about the monitored systems.

To schedule automatic reports:

  1. Create a policy or edit an existing policy.
  2. Click Add Monitoring Configuration and scroll down to the Reporting section.

    Scheduling Automatic Reports

  3. In the Schedule section, specify the time at which the report(s) must be generated.

  4. Check the:

    • Energy Usage report type to automatically generate an Energy Usage report that will be saved as MS_HW_energyUsage*.csv in the %PATROL_HOME%\log or $PATROL_HOME/log folder of the PATROL Agent
    • Ethernet/Fiber Port Activity report type to automatically generate an Ethernet/Fiber Port Activity report that will be saved as MS_HW_networkActivity*.csv in the %PATROL_HOME%\log or $PATROL_HOME/log folder
    • Hardware Inventory report type to automatically generate a Hardware Inventory report that will be saved as MS_HW_hardwareInventory*.csv in the %PATROL_HOME%\log or $PATROL_HOME/log folder
  5. Click OK to save your settings.

Updating a policy that sets the scheduling options of a report purges the report configuration variables and stops the report process

The history retention period can be set using a configuration variable. The default collection (retention) period is one day. Whenever a stored parameter value exceeds its retention period, it is automatically deleted from the parameter history file. Refer to the BMC user documentation for details.

Running PSL Commands With Agent Queries

This chapter explains how to run PSL commands on PATROL Agents by using the Agent Query Tool for operations that cannot be performed from the standard TrueSight user interface.

To perform an Agent Query:

  1. In the navigation pane of the TrueSight console, click Configuration and select Managed Devices.
  2. Click a PATROL Agent menu inline and select Query PATROL Agent. The Agent Query Tool opens in a new browser window.
  3. In the Command box, specify the query and click Execute.

Available PSL Commands

All text arguments should be delimited by quotes (ex: “text argument”). If a backslash character (\) is used, it must be doubled (ex: \\).

about()

requires MS_HW_q; about();

This command returns information that help precisely identify the Hardware Sentry version in use.

acknowledge()

requires MS_HW_q; acknowledge(devicePath);

This command acknowledges alerts for the selected device. The following argument is required:

  • devicePath: The device path is composed of: /<class name>/<PATROL ID>.

classReport()

requires MS_HW_q; classReport(objectType/classname,hostID);

This command displays the list of devices for the specified object type/class. The following arguments can be used:

  • objectType/classname: Object type or class name for which instances should be listed (Battery, Blade, CPU Core, Connector, Disk Controller, Disk Enclosure, Enclosure, Fan, LED, LUN, Logical Disk, Memory Module, Network Interface, Other Device, Physical Disk, Power Supply, Processor, Robotics, Tape Library, Temperature, Voltage).
  • hostID: Host PATROL ID. When the hostID is provided, this command reports instances of the class for the specified host. If left empty, it reports all instances.

dumpNamespace()

requires MS_HW_q; dumpNamespace(filename);

This command reports on the product namespace information. The following argument can be used:

  • filename: Path to the filename on the PATROL Agent where the report will be saved. If not provided, this command displays the report in the Agent Query window.

pause()

requires MS_HW_q; pause(devicePath);

This command pauses the monitoring of a device. The following argument is required:

  • devicePath: The device path is composed of: /<class name>/<PATROL ID>.

productReport()

requires MS_HW_q; productReport(filename);

This command generates the product report information (Product version, KM version, libraries and connectors, etc.). The following argument can be used:

  • filename: Path to the filename on the PATROL Agent where the report will be saved. If not provided, this command displays the report in the Agent Query window.

rediscover()

requires MS_HW_q; rediscover(hostID);

This command rediscovers a host by deleting all its related objects (including the missing ones) and performs a new discovery. The following argument is required:

  • hostID: Host PATROL ID.

refresh()

requires MS_HW_q; refresh(hostID, objectType/classname);

This command refreshes the parameters by performing a collect of the provided object type for the specified host. The following arguments are required:

  • hostID: Host PATROL ID.
  • objectType/classname: Object type or class name to be refreshed (Battery, Blade, CPU Core, Connector, Disk Controller, Disk Enclosure, Enclosure, Fan, LED, LUN, Logical Disk, Memory Module, Network Interface, Other Device, Physical Disk, Power Supply, Processor, Robotics, Tape Library, Temperature, Voltage).

reinitialize()

requires MS_HW_q; reinitialize(useDefault, resetSecuritySettings, resetPreselectedConnectors, resetDebugMode, resetThresholds, resetRemovedPausedObjectList, resetAlertActions, resetOtherAlertSettings, resetReportSettings, resetLocalhostMonitoring, resetJavaSettings, resetAlertAfterNTimes, resetAdvancedVariableList);

This command reinitializes the monitoring solution and performs a new discovery. The following arguments can be used:

  • useDefault: Set to ‘1’ to use the default reinitialize settings (resetThresholds, resetRemovedPausedObjectList and resetPreselectedConnectors). Set to ‘0’ or leave empty to provide the following additional arguments.
  • resetSecuritySettings: Set to ‘1’ to remove localhost security settings (usernames, passwords, SNMP community, sudo information, etc.)
  • resetPreselectedConnectors: Set to ‘1’ to remove the list of pre-selected connectors for the localhost. A new detection of connectors will be performed.
  • resetDebugMode: Set to ‘1’ to turn off the debug mode.
  • resetThresholds: Set to ‘1’ to delete all product thresholds and collect intervals from the configuration. The discovery sets default thresholds back.
  • resetRemovedPausedObjectList: Set to ‘1’ to remove the list of paused objects and the list of deleted objects.
  • resetAlertActions: Set to ‘1’ to remove any existing alert action and set the default ones (Trigger a PATROL Event and Annotate the parameter’s graph).
  • resetOtherAlertSettings: Set to ‘1’ to set the default settings for missing objects, intrusion detection, error messages, unexpected status management and Error Count parameters reset
  • resetReportSettings: Set to ‘1’ to delete all report scheduling settings.
  • resetLocalhostMonitoring: Set to ‘1’ to enable the localhost monitoring if it has been disabled.
  • resetJavaSettings: Set to ‘1’ to reset Collection Hub settings. An automatic detection of Java will be performed.
  • resetAlertAfterNTimes: Set to ‘1’ to remove all N Times settings and updates existing thresholds with the default N Time value.
  • resetAdvancedVariableList: List of variables, separated by carriage return, that should be deleted from the configuration.

removeDevice()

requires MS_HW_q; removeDevice(devicePath);

This command removes a device from your monitored environment. The following argument is required:

  • devicePath: Full path to the device to remove.

removeMissing()

requires MS_HW_q; removeMissing();

This command removes missing devices.

restoreDevice()

requires MS_HW_q; restoreDevice(devicePath);

This command restores the monitoring of a previously removed device. The following argument is required:

  • devicePath: Full path to the device to restore.

You can use “all” to restore all currently removed devices (ex: requires MS_HW_q; restore("all");).

resume()

requires MS_HW_q; resume(devicePath);

This command resumes the monitoring of a device. The following argument is required:

  • devicePath: Full path to the device to resume.

You can use “all” to resume the monitoring of all currently paused devices (ex: requires MS_HW_q; resume("all");).