File discovery and classification GIM parameters
Use these GIM parameters to configure file discovery and classification, for each collector.
Configure file discovery and classification per collector. These parameters can be configured during installation, or at a later time using GIM (gim_update_client_params. You can only update one collector at a time when using the GuardAPI.
) or using the GuardAPI commandGIM Parameter | Default | Description | GUI |
---|---|---|---|
FAM_CLASSIFICATION_LANGUAGES | English | Set to GenericLanguage for automatic language detection.
For Linux, ensure that your Linux server has the required language support installed. For example, to support Chinese document classification, Chinese support should be installed on Linux. |
X |
FAM_DEBUG | 0 | Logs on the file server are collected and sent to the Guardium
appliance. 0=OFF |
X |
FAM_ENABLED | 1 | Enables FAM
discovery. 0 = FAM Discovery agent is disabled. The S-TAP parameter fam_enable must be enabled for the discovery agent to function. Windows:The FAM service restarts, as shown in the Event viewer (Windows logs > System The IBM Guardium FAM service entered the stopped state and The IBM Guardium FAM service entered the running state). There is no new entry in the pre-defined GUI report "Files Crawler Configuration" and the configuration stays at 2 in the GIM GUI. For next restart, change the parameter to 1. |
X |
FAM_ICM_CLASS_DECISION_PLANS | Enable the decision plans by including their Plan names and their
classification
entities. DecisionPlanName1{Entity1.1,Entity1.2,..}:DecisionPlanName2{Entity2.1,Entity2.2,..} |
X | |
FAM_ICM_CLASS_THREAD_COUNT | 5 | Number of threads for the classifier to use. The default is 5 and is the recommended value. | X |
FAM_ICM_URL | http://localhost:18087 | The URL of the IBM Content Classification Server. | X |
FAM_INSTALLER | The path to the installer package. Windows only. | ||
FAM_INSTALL_DIR | The location in which the File Activity Monitoring software is installed. Windows only. | ||
FAM_IS_DEEP_ANALYSIS | Controls
classification False=classification is disabled. Basic scan of metadata and access permission only. |
X | |
FAM_SCAN_EXCLUDE_DIRECTORIES | NULL | Directories to exclude from discovery and
classification. Format: full path to directory |
X |
FAM_SCAN_EXCLUDE_REMOTE_DIRECTORIES | true | Remote directories to exclude from discovery and classification.
true: do not scan remote directories. |
X |
FAM_SCAN_EXCLUDE_EXTENSIONS |
NULL | Excludes the specified file extension(s) or documents without extensions from
the FAM scan. Relevant for both Windows and Linux.
Format: semicolon delimited list |
X |
FAM_SCAN_EXCLUDE_FILES |
NULL | Files to exclude from discovery and classification.
Format: valid filename. |
X |
FAM_SCAN_MAX_DEPTH | Limit the depth for the scan relative to the specified starting directories (FAM_SOURCE_DIRECTORIES). | X | |
FAM_SCHEDULER_HOUR_TIME_INTERVAL | 12 | Frequency, in hours, at which the discovery and classification scan is
run. Format: integer |
X |
FAM_SCHEDULER_MINUTE_TIME_INTERVAL |
Along with the hour interval, this is the time interval between scans. For example, if you want scans to occur 12 hours and 30 minutes apart, specify 12 for the hour and 30 here for the minute. |
X | |
FAM_SCHEDULER_REPEAT | True = Repeat the discovery process at the specified time interval. |
X | |
FAM_SCHEDULER_START_TIME | NULL | Time of initial activation of the discovery and classification processes. Format: MM-DD-YYYY HH:mm |
X |
FAM_SERVER_PORT | 16022 | The Guardium collector port, 16022. | X |
FAM_SOURCE_DIRECTORIES | NULL | The directory or directories to start scanning from.
Wild cards are not supported. Example: /home/test. |
X |