dirscan (File and Directory Scan) Release Notes

The File and Directory Scan (dirscan) probe monitors files in specified directories. Alarms can be sent on the number, age, and space that is used by files.
uimpga-ga
dirscan_RN
The File and Directory Scan (dirscan) probe monitors files in specified directories. Alarms can be sent on the number, age, and space that is used by files.
This probe monitors files and directories for the following:
  • Existence of directories
  • Shared directories (Windows systems only)
  • Named files or file patterns in a directory (option to include subdirectories)
The probe is configured by defining one or more profiles. Each profile identifies a particular directory and the required files. You can configure different parameters that can be checked. All the following parameters can generate alarm messages if the specified threshold is breached:
  •  
    Number of files
    The number of files that are found in the specified directory matching the specified pattern.
  •  
    Age of file
    The age of the files that are found in the specified directory matching the specified pattern.
  •  
    Space that is used by files
    The space that is used by all files that are found in the specified directory matching the specified pattern.
  •  
    Size of files
    The size of the files that are found in the specified directory matching the specified pattern.
  •  
    Read response time
    The time that is required to read the specified file.
  •  
    Directory check
    Verifies if the specified directory is present.
  •  
    Directory age
    The time that has passed from the previous change in the directory.
  •  
    File integrity
    Verifies if the files that are specified for file integrity monitoring have changed.
The probe also generates QoS data for the following parameters:
  • Number of matching files
  • Age of oldest/newest matching file
  • Space that is used by matching files
  • File read response time
  • File integrity
 
Contents
 
 
 
Revision History
This section describes the history of the revisions for the dirscan probe.
 Support case(s) may not be viewable to all customers.
 
Version
 
 
Description
 
 
State
 
 
Date
 
3.17
 
What's New:
 
  •  
    (May 2019) 
    The dirscan MCS template (version 3.17 onwards) has been updated to address the common vulnerabilities and exposures by updating the jackson-databind libraries. For more information and CVE numbers, see Addressing Jackson Vulnerabilities.
  • Updated this probe as part of removing dependency on the end-of-life (EOL) Microsoft Visual C++ Redistributable in CA UIM 9.0.2. CA UIM 9.0.2 now uses Microsoft Visual C++ Redistributable for Visual Studio 2017. If you are installing this probe on machines running Windows operating system, we recommend you to download the appropriate Microsoft Visual C++ Redistributable for Visual Studio 2017 package from the Nimsoft archive (x86/x64) to stop the machine from auto-restarting: 
    • vs2017_vcredist_x86 1.01
    • vs2017_vcredist_x64 1.01
     When deploying a probe that is dependent on the Microsoft Visual C++ Redistributable for Visual Studio 2017 package version 1.0 (vs2017_vcredist_x86 1.0 and vs2017_vcredist_x64 1.0), Windows operating system restart occurs on the robot where the probe is deployed. In the VS2017 package version 1.0, there is no "norestart" option specified in the Post Install command. Therefore, the Post Install might trigger OS reboot as part of the package installation. For a workaround, see the KB Article kb000120656.
    For more information see the Upgrading to Microsoft Visual C++ Redistributable for Visual Studio 2017 section in CA UIM 9.0.2 DocOps.
  • (December 2018) Added support for monitoring Amazon Linux 2.
  • (February 2019) Added support for monitoring Windows 2019.
GA
October 2018
3.15
 
What's New:
 
  • Added support for monitoring zLinux platforms.
  • Added support for monitoring Windows 10 (x64).
  • (July 2018) Added support for monitoring RHEL 7.4 x86 and x86 64-bit, and zLinux 64-bit.
  • (September 2018) Added support for monitoring Ubuntu 18.04. Apply robot 7.93HF10 for this support. 
    Support Case: 01184423
     
     
 
Fixed Defects:
 
  • The probe reported incorrect Message Pool entries for alarms due to incorrect case ($Watcher) for the variable $watcher in the MCS template. For more information, see the 
    Troubleshooting
     section. 
    Support case number: 00836230
     
  • The probe crashed when viewing a folder with large number of files. For more information, see the 
    Troubleshooting
     section.
     Support case number: 00951093
     
GA
March 2018
3.14
 
What's New:
 
  • Added support for IBM iSeries version V7R2.
  • The probe supports monitoring within an IPv6 environment.
 
Fixed Defects:
 
  • Updated information about file naming conventions used by the probe. 
    Support case number 307816
     
  • Updated information about tokens. 
    Support case number 256723
     
For more information about the defects, see the AC or IM Configuration articles.
 GA
September 2015 
3.13
 
What's New
:
  • Added 
    sendresponsetime 
    key in 
    Raw Configure
     > 
    Setup
     to send QoS value in seconds instead of byes/seconds for QOS_DIR_RESPONSE_TIME. Refer 
    Upgrade Considerations
     for more information.
 
Fixed Defects
:
  • The probe adds a '\' at the end of directory path and cannot identify the directory. 
    Salesforce case: 00160487
     
  • The probe does not save pattern configurations for file monitoring. 
    Salesforce cases: 00167616, 00165924, 00164986, 00163884
     
GA
July 2015
3.12
 
What's New
:
  • The probe can be migrated to standard static thresholds using the threshold_migrator probe. The Admin Console GUI will be configurable using the standard static threshold block and the Infrastructure Manager GUI will no longer be available.
  • Added support for factory templates.
GA
March 2015
3.11
Fixed a defect where the probe was unable to generate the Used Space Delta alarm.
GA
October 2014
3.10
Fixed Metric Id defects
June 2014
3.09
Fixed the defect of scheduler by allowing user to clear specific hours of one particular day of a week. Earlier the probe can select or clear the specific hours for an entire week.
April 2014
3.08
Added Probe Defaults
June 2013
3.07
Directory search with % parameters without directory exist check issue fixed
May 2013
3.06
Directory search test with % parameters issue fixed
April 2013
3.05
  • Fixed issue with fetch current in GUI.
  • Improved error handling.
  • Removed clear on restart.
  • Fixed alarm message defaults in the configuration tool.
May 2012
3.04
  • Corrected NISTOKEN string for Used Space Delta Alarm Message.
  • Fixed Directory variable expansion for directory check.
  • Fixed NULL QOS value for age of file when their is no file in the directory.
March 2011
3.03
  • Removed dirScan file integrity profile file number limit.
  • Fixed the defect of sending NULL QoS for number of files in a directory, when zero files are found.
  • File Integrity : Added Support for run time pattern matching.
  • Addition of schedular functionality to the dirscan probe on per watcher basis.
  • Monitoring directory/file size change (say x unit) in last number of cycles (say y cyles) and sending appropriate alarms.
  • Added feature to monitor the probe on the basis of current time stamping for windows.
March 2011
3.02
Added fixes to web-based Service Oriented Configuration.
January 2011
2.91
Made changes to libraries with respect to configuration locking.
June 2010
2.90
Added support for extended NIS database information.
March 2010
2.81
Fixed the problem which would sometimes cause the probe to crash when running multiple profiles.
March 2010
2.80
Added support for Linux systems with glibc 2.2.
September 2009
2.73
Changed the behavior for the integrity profiles: If the MD5 signature for a file is not set, it will be generated and stored in the configuration file during the probe startup or restart process.
July 2009
2.72
  • Fixed directory variable for file age alarms.
  • Fixed clear for file size, file age and file response alarms.
  • Fixed crash situation on stop and restart.
  • Disabled 'Fetch' button in configuration tool for settings not supported by the test command.
  • Fixed token for 'DirAge' alarm message.
  • Cleanup of code for mapping/unmapping shares.
  • Added option for Quality of Service message on directory existance.
  • Reorganized configuration tool, separating directory scan and file integrity profiles.
  • Fixed directory scan problem on shares introduced in version 2.43.
  • Fixed file and directory variables for clear messages so that these are consistent with other alarm situations.
  • Added scan type for file size: largest, smallest or individual file.
  • Added scan type for response time: longest, shortest or individual.
  • Modified browse/doubleclick behaviour.
  • Improved error handling on memory allocation situations.
  • Added support for Windows on Itanium 2 systems (IA64).
June 2009
2.53
Rebuild following NimBUS library fixes.
December 2008
2.52
  • Problem with generated directory names containing the '/' character as directory separator on Windows is resolved.
  • Configuration tool fixed to disallow empty profile name.
  • Configuration tool crash on profile copy fixed.
  • The default messages in the message pool are no longer overwritten on redistribution of the probe. For upgrade from version 2.22 and earlier, see the installation notes.
  • Added support for 64-bit Windows (x64)
  • Added support for LINUX on 64bit PowerPC (glibc = 2.3)
  • Added support for 64bit platforms on AIX, HP-UX, SOLARIS and LINUX.
  • Please note that, for version 2.52 and higher of this probe, Robot version 3.00 (or higher) is a prerequisite. You are advised to carefully read the document "Upgrading the NimBUS Robot" before installing/upgrading.
September 2008
2.43
  • Fixed variable expansion in command strings.
  • Fixed problem with passwords that where corrupted on profile edit.
  • This version turns off profile monitoring if directory does not exist.
  • Clear messages are now sent for file read response.
  • Added cluster probe support.
  • Clear messages are sent on response time within limit and also when the file no longer exists.
  • Modified logic in the directory browser so that the '[..]' entry will not appear at the share level.
  • Fixed handling of more than one directory specified and of directory recursion.
  • Added new alarm message used for alerting when unable to open a file for obtaining a response time.
October 2007
2.42
  • Fixed a number of minor memory leaks.
  • Fixed problem with uninitialized memory causing occasional program failure.
  • Modified algorithm for clearing of age and size alarms, also changed suppression keys and format of dirscan.file.
  • Fixed problem with Recurse into subdirectories.
  • Fixed problem when changing option of Age of file from checking All files to only check Newest file.
  • UNIX: Added new versions to supported platform list
  • AIX_5: 64bit
  • HPUX_11: 64bit (PA-RISC & Itanium)
  • LINUX: 64bit (Glibc >=2.3)
  • SOLARIS_8: 64bit (Sparc)
  • SOLARIS_10: 64bit (x86_64)
  • SOLARIS_10: 32bit (x86)
  • GUI changed for Age of file constraint. Added radio button for Age of all files. This replaces checkbox for 'Send alarm for each breaching file'. Choosing Age of all files disables the button for Fetch current values. Fixed clearing of alarms if multiple files recover from breaching Age of file constraint. Breaching files that no longer exist will also send clear with reported age 0 min.
May 2007
2.29
Age constraint alarm can now be sent either for each breaching file, or oldest/newest if only a single alarm is desired.
November 2006
2.27
  • Alarm messages fix.
  • Added extra log information at loglevel 2 during file scanning.
August 2006
2.26
  • Remove clear flag for the messages section in the cfx file which would clear out custom messages.
  • The flag was added in v2.22 because of a change in the message format.
  • See Installation Notes below if upgrading from a version prior to 2.22 for information on what to change in the cfx file to upgrade the messages correctly.
July 2006
2.25
  • Windows: Fix problem with username/password not being set correctly when testing a connection
  • Age constraint alarm is sent for each file breaching the threshold (not just oldest/newest). QoS data is still for the oldest/newest however.
  • Solaris, AIX and Linux: Added utility (stat64) for reading file sizes over 2GB.
  • GUI: user and password information for shared drives would not show up when editing an existing profile.
July 2006
2.22
  • New GUI layout.
  • Regenerates MD5 digest from GUI.
  • Fixed problem with the "Fetch current values" button on "Read Reponse Time".
  • Changed description of QoS for file age.
April 2006
2.21
Added support for file integrity check using MD5 digest. Added support for using Date/Time primitives (strftime parameters) when specifying directory names.Support for customizing alarms and "Clear" messages.
November 2005
2.20
Changed QoS definition for file age to use unit "s". Added support for file size alarms on large files on Windows.
November 2004
Threshold Configuration Migration
The probe (version 3.12 or later) can be migrated to standard static thresholds using the threshold_migrator probe. You can refer the threshold_migrator probe document for information about how to migrate a probe.
 The IM GUI of the probe is not available if the probe is migrated using threshold_ migrator. Opening the IM GUI then displays a message that the probe can only be configured using the Admin Console and redirects you to the Release Notes of the probe.
Changes After Migration
The changes in the probe after migration are:
  • Dynamic values in alarms and automated rollback will not be available.
  • The Infrastructure Manager GUI of the probe will not be available and the probe will only be configured using Admin Console.
  • Some probe specific alarm configurations in the probe monitors will be replaced by 
    Static
     alarms and 
    Time over Threshold
     configurations.
    Refer 
    dirscan Metrics
     for details.
  • The static message variables will also be migrated and only the standard variables such as value and threshold will be used.
  • The variable syntax will change from 
    $<variableName>
     to 
    ${<variableName>}
    .
  • The alarms will be sent by the 
    baseline_engine
     probe.
  • Any relational operators in the probe configuration will be reversed.
  •  
    QOS_DIR_AGE
    : Alarm is generated for the 
    newest file
     after migration if configuration is set to 
    individual file
     before migration.
  •  
    QOS_DIR_RESPONSE_TIME
    : Alarm is generated for the 
    longest file
     after migration if configuration is set to 
    individual file
     before migration.
  • Dynamic variables, such as 
    $File
     and 
    $Number
     are only available in dirscan version 3.13 or later.
    Dynamic variables are available when you upgrade a migrated 3.12 version of the probe to a later version. You must manually add the variables to the custom alarm messages to use them. 
Probe Specific Hardware Requirements
The dirscan probe is installed on systems with the following minimum resources:
  • Memory: 2-4 GB of RAM. The OOB configuration of the probe requires 256 MB of RAM
  • CPU: 3-GHz dual-core processor 32, or 64 bit
Probe Specific Software Requirements
The dirscan probe requires the following software environment:
  • Nimsoft Monitor Server 7.6 or CA Unified Infrastructure Management 8.0 or later
  • Robot 7.6 or later (recommended)
  • Probe Provisioning Manager (PPM) probe version 2.38 or later (required for Admin Console)
  • Java JRE version 6 or later (required for Admin Console)
  •  
    (From version 3.14)
     IPv6
The 3.12 version or later of the probe (for migration with threshold_migrator probe) requires the following software environment:
  • CA UIM 8.31 or later
  • Robot 7.5 or later (recommended)
  • Probe Provisioning Manager (PPM) probe version 3.22 or later
  • baseline_engine probe version 2.60 or later
  • Java JRE version 7 or later 
Installation Considerations
Version 2.22 implemented a new layout of the message pool. If upgrading from a version prior to 2.22, you need to modify the dirscan.cfx file in the package.
 
Follow these steps:
 
  1. Get the latest version of the probe from the Internet Archive
  2. Double-click the dirscan package in the Archive node of the Nimsoft Infrastructure Manager
  3. Select the tab for your platform and click on dirscan.cfx
  4. Right-click and select Edit file.
  5. Locate the <messages> section and add the 'clear' keyword after the closing bracket. Click OK
  6. Repeat for each platform you intend to distribute the updated probe to
  7. Distribute the update to all systems running v2.22 or older
 All custom messages will be cleared and default messages in the new format will be inserted.
The description of the QoS for file age, QOS_DIR_AGE was previously defined as Age of oldest/newest matching file. In version 2.22, this has been changed to Age of matching file.
Upgrade Considerations
The probe has the following upgrade considerations:
  • The 3.13 and later versions of the probe have a key 
    sendresponsetime 
    key in 
    Raw Configure
     > 
    Setup
     with the default value as '0'. You can set this key to '1' to send the QoS value in seconds instead of bytes/seconds for 
    QOS_DIR_RESPONSE_TIME
    .
Troubleshooting
 
The probe generates incorrect message pool entries for Clear Alarm in the MCS template.
 
 
Symptom:
 
The probe reports entries for Clear Alarm with an error state of the variable $Watcher in message pool entries.
 
Solution:
 
To resolve this issue, deploy the new template and create a new profile.
 
Follow these steps:
 
  1. Upgrade the template and make this new template Active.
  2. Delete the old profile.
  3. Create a new profile.
  4. Save your profile for changes to take effect.
 
The probe (v3.14) crashes when viewing folders with files more than 32767, which is fixed in v3.15, but IM GUI response time is quite high (~7 minutes).
 
 
Symptom:
 
The probe's response time increases when viewing folders with large number of files ~10k using IM configuration window.
 
Solution:
 
CA recommends using AC GUI for viewing folders containing files more than 5k.
Known Issues
The dirscan probe has the following limitations:
  • You cannot to run batch files from a mapped drive using dirscan probe. This is FAD (Functioning as Designed) and there is no workaround. 
  • The log file incorrectly displays a logon failed message when the probe fails to authenticate the specified user credentials. In this scenario, the probe applies the user credentials used for probe deployment.
The dirscan probe has the following limitations in the Admin Console GUI:
  • Schedules are not supported.
  • Existing profile(s) cannot be copied to create new profiles.
  • Recalculation of checksum using Recalculate checksum is not available for pattern based files.
  • Non Windows remote directories cannot be monitored. (applicable to both Admin Console and Infrastructure Manager GUI)