Advanced server settings

9.2.3 Available from 9.2.3. Review to the list of parameters that you can use to configure the BigFix Inventory server. You can change the parameters on the Advanced Server Settings panel or through REST API.

To open the panel, go to Management > Advanced Server Settings. If the panel is not available in the menu, go to the following URL: https://hostname:port/management/sam/control_values. For information how to change the settings through REST API, see: Configuring advanced server settings.
Table 1. Server settings
Name & Parameter Type Default Minimum Maximum
Description
  • Name: Oracle auditing data files path
  • Parameter: oracleAuditingFilesPath
String ./data/sam/oracle

Specifies the folder where files generated and downloaded during Oracle auditing data are stored. The content of this folder is cleaned when you generate Oracle auditing data.

The default value indicates that the files are created in the <install_dir>/wlp/usr/servers/server1/data/sam/oracle folder.

Once you change the oracleAuditingFilesPath setting, delete the files from their previous locations. After you change the value of the parameter, restart the BigFix Inventory server for the change to take effect.
Note: Do not change the oracleAuditingFilesPath setting while the Oracle audit generation is in progress.

From version 10.0.16, the setting is available by default.

  • Name: Oracle Auditing Manually Uploaded Files Path
  • Parameter: oracleAuditingManuallyUploadedFilesPath
String ./data/sam/oracleAuditingManuallyUploaded
Specifies the folder where files with manually collected data for Oracle auditing are stored. The default value is ./data/sam/oracleAuditingManuallyUploaded and it indicates that the files are created in the install_dir/wlp/usr/servers/server1/data/sam/oracleAuditingManuallyUploaded folder.

Once you change this setting, delete the files from their previous locations. Backup the content of this folder before you reinstall or upgrade BigFix Inventory. Do not change this setting while the Oracle audit generation is in progress. This folder cannot be a subfolder of oracleAuditingFilesPath.

10.0.14
  • Name: Re-synchronize datasource computer groups
  • Parameter: resynchronize_datasource_computer_groups_once
Boolean False
Removes existing information about datasource computer groups from database and imports it from scratch, instead of doing incremental import. Such an import should be run only when there is inconsistent data about datasource computer groups. The option is disabled by default. When you enable the option, the import runs once and returns to the normal operation mode.
10.0.14
  • Name: Maximum number of deleted records to remove from persistent tables
  • Parameter:pruner_max_records
Integer 1 000 000 0 (disabled) 1 000 000 000
Specifies the maximum number of deleted records to be removed from persistent tables during single data import. Removing deleted records from persistent tables allows to recover from deleted data accumulation.
10.0.14
  • Name: Maximum number of CSV/PDF relation elements to select
  • Parameter:csvReportRelationElementsLimit
Integer 100 0 2000
This parameter specifies the number of values in multivalued fields for CSV/PDF export. The default value is 100. Put 0 to disable the limit.

This parameter limits the number of multivalued elements. In case of CVEs, it limits the number of elements shown in CSV/PDF export. By limiting the number of elements, you can limit the number of characters in a cell.

10.0.11
  • Name: Maximum Historical Data Lifetime
  • Parameter: maximum_data_lifetime
Integer 0 (disabled) 0 3650
This parameter control the period of time for which you can retain the historical data about detected computers and software. The default value is unlimited (value set to 0). When the range is set between 1-3650, the deleted records are retained for defined number of days before they are permanently deleted. Data deletion is done during Data Import. The amount of data that can be deleted is limited to 10,000 computers and an additional 50,000 software instances per data import to distribute the deletion of the larger sets over several imports.

Using the parameter permanently deletes the data.

10.0.10
  • Name: Delete unused tags automatically
  • Parameter: delete_unused_tags_automatically
Boolean False
When the value is set to true, the parameter automatically deletes all unused saved tags from the database during data import. Once the parameter is enabled, the inactive tags do not appear when you try to add or delete a tag from an instance or a component.
10.0.8
  • Name: Delete action after stopping in BigFix
  • Parameter: delete_stopped_actions
Enum Delete 'add & delete shared disk' actions (1)
Control the behavior of handling issued actions after stopping them by BigFix Inventory.
Possible values:
  • Keep stopped actions (0)
  • Delete add & delete shared disk actions (1) – current default
  • Delete all (2)
10.0.8
  • Name: Provide feedback email
  • Parameter: provide_feedback_email
String talk2sam@hcl.com
Allows you to provide your preferred email address in the sending feedback option. The email address should be within internal point of contact.
Notice: 10.0.9 This parameter has been removed.
10.0.6
  • Name: Deprecated Contracts Management enabled
  • Parameter: deprecated_contracts_mgmt_enabled
Boolean False
Allows you to enable and disable the deprecated reports. When you set the value to true:
  • it shows Contract Management reports, such as Software Installations, Software Exploration, Contracts Usage Data and Management Contracts.
  • it enables related import steps and calculations.
  • ETL steps are executed.

The parameter is disabled by default. You need to run data import after you change the value to true.

10.0.5
  • Name: new_contracts_max_computer_groups
  • Parameter: new_contracts_max_computer_groups
Integer 20 0 1000000
Defines maximum number of Computer Groups that can be used for new contracts management. Groups are selected according to their creation time (using the ID), in ascending order, unless 'new_contracts_selected_computer_groups' parameter is defined. Run data import after this value is changed.
Note: This parameter is hidden by default.
10.0.5
  • Name: new_contracts_selected_computer_groups
  • Parameter: new_contracts_selected_computer_groups
String
Allows you to manually select which Computer Groups for new contracts management. It should be a comma separated list of computer group IDs.
Run Data Import after this value is changed.
Note: This parameter is hidden by default.
10.0.5
  • Name: Catalog distribution - use the Skip Lock flag
  • Parameter: catalog_download_task_skip_lock
Boolean False
Enable the flag to skip locked endpoints in Catalog download fixlet. Helps is excluding locked endopints when automatically pushing the catalog. When the value is set to false, catalog download includes the locked endpoints. When activated, 'Skipped Locked Constraint' is added to the Catalog download fixlet.

The flag applies to actions that are executed in automated way.

10.0.4
  • Name: Allow end user to modify hidden parameters
  • Parameter: show_hidden_values
Boolean False
Enable the parameter to allow end users view all hidden parameters and allow them to perform required actions.
10.0.2
  • Name: Enable audit trail for user management
  • Parameter: user_mgmt_audit_trail_enabled
Boolean False
Enable the parameter to allow the audit trail to capture information, such as creation and deletion of users. It also captures any modification to the user role and user computer group.
10.0.1
  • Name: Maximum number of custom rules
  • Parameter: customRuleLimit
Number 10 0 100
Specifies the maximum number of custom rules that can be created to automate the process of software classification. Increasing the number of custom rules can prolong the duration of data import.
9.2.8
  • Name: Account lockout: enable account lockout
  • Parameter: user_lockout_enabled
Boolean (true/false) True
Specifies whether exceeding the specified number of failed login attempts locks the user account.
9.2.8
  • Name: Account lockout: lockout period
  • Parameter: user_lockout_length
Minutes 5 1 60
Specifies the period for which a user cannot log in to the application after exceeding the maximal number of failed login attempts.
9.2.8
  • Name: Account lockout: login attempts period
  • Parameter: user_retry_time_period
Minutes 5 1 60
Specifies the period during which the user can try to log in to the application. When the maximal number of failed login attempts is exceeded within this period, the account is locked.
9.2.8
  • Name: Account lockout: maximal number of failed login attempts
  • Parameter: user_max_login_retries
Integer 10 2 128
Specifies the maximum number of failed login attempts after which the user account is locked.
9.2.8
  • Name: Automatically decommission inactive computers
  • Parameter: decommission_inactive_computers
Boolean False
Enables the option to automatically remove inactive computers from BigFix Inventory after the period defined in the max_data_visibility_for_inactive_computers parameter. This option is disabled by default.
9.2.17
  • Name: Automatically delete the scan results after the successful import from the disconnected data source
  • Parameter: delete_successfully_imported_scans
Boolean False
Enables the option to automatically remove the scan results after they are successfully imported from the disconnected data source. After you set this option to true, automatic removal is applied after each subsequent import of data. You can manually remove any remaining files, such as older scan results or files that are skipped. The option is useful especially when you handle many scan results packages. The removal does not affect the report data and the scan results are included in the reports.
  • Name: CSV report separator
  • Parameter: csvReportSeparator
Character Comma (,)
Specifies the character that is used as a value separator during the creation of CSV files.
  • Name: Calculate metric consumption for incomplete computers
  • Parameter: calculateLicenseUsageForIncompleteComputers
Boolean (true/false) True
Specifies how PVU consumption on x86 virtual machines that have incomplete data is counted. If set to true, PVU consumption is counted based on the number of PVUs on the host. In this case, the reported PVU consumption might be higher than the real value, but configuration of VM managers is not required. If set to false, the reported PVU consumption is 0, and VM managers must be configured.
9.2.10
  • Name: Calculating usage per computer
  • Parameter: calculate_during_import/product_usage

    Previously: on_demand_sam/product_usage

Boolean (true/false) True
Specifies when the values that are displayed on the Usage per Computer report are calculated. By default, usage per computer is calculated during every import. If you change the setting to false, the usage is calculated on demand. To update the report on demand, open it and click Calculate.

After you change the value of the parameter, restart the BigFix Inventory server for the change to take effect.

9.2.3
  • Name: Catalog distribution waiting time
  • Parameter: catalog_download_task_stagger_interval
Minutes 0 0 10080 (1 week)
Specifies the maximum time for which the distribution of the software catalog to the endpoints is postponed to reduce network traffic.

The distribution of the catalog to each endpoint is postponed for a random amount of time that is within the specified waiting time. For example, if you set the waiting time to 1 week, the first computer can download the catalog after an hour since the import of the catalog, the second computer after a day, and the third computer after a week. The amount of time is randomly chosen by each computer.

9.2.7
  • Name: Collect VMware license metric utilization
  • Parameter: vmman_slm_tags_enabled
Boolean (true/false) False
Enables collection of VMware license metric utilization. The option is disabled by default. The setting applies only to the central VM.
9.2.10
  • Name: Computer approaching detachment from VM manager
  • Parameter: vmManagerDetachmentNotificationPeriod
Days 3 1 90
Specifies the maximum idle time after which data from the VM manager is considered to be outdated. After that time, the computer status changes to Outdated VM Manager Data. The value should be lower than the value of the vmManagerDetachmentPeriod parameter.
  • Name: Computer detachment from VM manager
  • Parameter:
    • 9.2.8 vmManagerDetachmentPeriod
    • Previously: computerVmManagerDetachmentPeriod

Days 9.2.10 30

Previously: 7

1 90
Specifies the maximum idle time after which a guest computer or a host computer is considered to be detached from the VM manager. After that time, the computer status changes to No VM Manager Data. The data that is sent by an agent is not augmented by the data that is retrieved from the VM manager.

9.2.8 Starting from application updated 9.2.8, if the host is a part of a cluster, it is also disconnected from that cluster.

The value of this parameter should be greater than the value of the vmManagerDetachmentNotificationPeriod parameter.

9.2.3
  • Name: Deploy tasks automatically
  • Parameter: enable_automatic_task_deployment
Boolean (true/false) True
Specifies whether tasks initiated by the BigFix Inventory server are automatically deployed to the BigFix server. The tasks include:
  • Import of the new software catalog to the BigFix server.
  • Configuration of scan frequency and schedule on the Scan Configurations panel.
  • Automatic configuration of the fixlet site on the BigFix server that is added as a new data source.
  • Installation and configuration of the main VM Manager tool on the BigFix server that is added as a new data source.
The option is enabled by default which is the recommended setting.
Warning: If you disable the automatic deployment of tasks, you need to perform a number of manual tasks to ensure that the data needed by BigFix Inventory is collected and that proper values are displayed on the reports.
9.2.11
  • Name: Display data from partial imports
  • Parameter: allow_partial_data_view
Boolean (true/false) False
Important: Use this parameter only when you are requested by HCL Support.

Enables displaying data from the last import regardless of whether the import was successful or partial. It might cause inconsistency or lack of results on some reports. By default, the parameter is disabled and only data from successful imports is displayed. To enable this parameter, first enable the enable partial imports parameter.

9.2.3
  • Name: Download software catalog automatically
  • Parameter: enable_automatic_catalog_download
Boolean (true/false) True
Specifies whether the new software catalog is automatically distributed to the endpoints. If you disable this option, you must distribute the catalog manually. For more information, see: Manually updating scanner catalogs.
9.2.3
  • Name: Enable debug level logging during data imports
  • Parameter: debug_logging_for_imports
Boolean (true/false) False
Specifies whether import logs contain debug level information. When the parameter is set to false, the default logging level is used.
Removed since 10.0.4
  • Name: Enable information about files and packages that cause software detection
  • Parameter: enable_caused_detection_data
Boolean (true/false) False
Enables the data that specifies whether a file or a package contained enough information to cause detection of the related software. After enabling the data, you can display the Cause Detection column on the Scanned File Data and Package Data reports. This option is disabled by default.
Note: The enable_caused_detection_data parameter is removed since BigFix Inventory version 10.0.4. You must re-create your saved reports in case you had used the Caused Detection column.
9.2.11
  • Name: Enable partial imports of data
  • Parameter: enable_partial_imports
Boolean (true/false) False
Enables skipping certain steps during the import of data. The import continues even if these steps fail. When the import finishes, it is marked as partial because only data from successfully completed steps is processed.
9.2.10
  • Name: Enabled schema next feature
  • Parameter: schema_next
Boolean (true/false) False
Optimizes the process of importing data from BigFix. The option is available for BigFix 9.5.5 and higher. If you upgraded the BigFix server from earlier versions, run at least one import of data before you enable the optimization to ensure data consistency.
  • Name: Location of temporary application files
  • Parameter: tempPathForGeneratedFiles
Path Period (.)
Specifies the path to the folder where temporary application files, such as the CSV reports during generation, are stored. The default value indicates that the files are created in the following location:
  • Linux install_dir/wlp/usr/servers/server1
  • Windows install_dir\wlp\usr\servers\server1
9.2.12
  • Name: Location of CVE files upload
  • Parameter: tempPathForCVEFiles
Path ../../../../cve_data
Specifies the path to the folder where temporary CVE files should be stored for an upload. The default value indicates that the files are stored in the cve_data folder that is in the installation directory of the BigFix Inventory server.
  • Name: Maximum VM manager inactivity
  • Parameter: maxVMManagerInactivity
Days 3 1 90
Specifies the maximum time after which a VM manager is considered inactive if the server receives no new data from this VM manager. After that time, the status of the VM manager changes to Inactive.
9.2.4
  • Name: Maximum VM manager visibility
  • Parameter: maxVMManagerVisibility
Days 90 1 2147483647
Specifies the number of days after which a VM manager is removed from the VM Managers panel if no data is collected from that VM manager.

VM manager is also filtered by using the api/sam/vmmanagers API.

9.2.7
  • Name: Maximum number of VMware .slmtag files
  • Parameter: vmman_slm_tags_files_per_software
Number 10 1 10
The maximum number of .slmtag files that are stored on the computer for each license key under VMware instance.
9.2.2
  • Name: Maximum number of aggregation threads
  • Parameter: maxAggregationThreads
Number 2 1 64
Specifies the maximum number of threads that can be run during the aggregation. If you increase their number, performance of aggregation improves. However, memory usage and database locking increase. You should provide two processor cores on the database server for each thread.

10.0.5 Aggregation algorithm now uses use all logical CPUs by default parameter. This number can be controlled using maxAggregationThreads. The default value of maxAggregationThreads has now changed to 64 (max). Number of threads can not be higher than number of logical CPUs on the system, regardless of the setting.​

MS SQL must have the VIEW SERVER STATE permission enabled. BigFix Inventory uses MS SQL to access temadb. Without this permission, the aggregation runs single threaded and does not apply the maxAeaggregationThreads parameter.

  • Name: Maximum number of import threads
  • Parameter: numberOfImportThreads
Number 0 0 32
Specifies the maximum number of threads that are used to process capacity scan data and VM manager scan data during the import of data from the BigFix server.

If the database user configured for BigFix Inventory can not execute the below queries:

DB2
SELECT min(value) FROM SYSIBMADM.ENV_SYS_RESOURCES where upper(name) in 
('CPU_TOTAL', 'CPU_ONLINE', 'CPU_CONFIGURED')
MS SQL
SELECT cpu_count FROM sys.dm_os_sys_info
  • There is an warning message in tema.log.
  • 10.0.10 Starting from version 10.0.10 there is information in the Data Import logs about the actual value.
  • Number of thread is set to 1.

When the configuration is set to 0, number of threads is automatically counted as double of cores reported by above queries, but not more than 32.

Tip: In environments with over 10000 endpoints that are running on high-performance machines, it can be beneficial to increase the number of threads to speed up the import.
  • Name: Maximum number of processed license metric files
  • Parameter: maximumNumberOfLicenseUseMetricFilesToProcessPerImport
Number -1 -1 2147483647
Specifies the maximum number of license metric tag files that can be processed during an import. The oldest unprocessed files are processed in the first place. Then, the specified number of newer files is consecutively processed with every import. The value -1 indicates that all files are processed in a single import.
9.2.2
  • Name: Maximum number of reaggregation threads
  • Parameter: maxReaggregationThreads
Number 4 1 64
Specifies the maximum number of threads that can be run during reaggregation. If you increase their number, performance of reaggregation improves. However, memory usage and database locking increase. You should provide two processor cores on the database server for each thread.

10.0.5 Reaggregation algorithm now uses use all logical CPUs by default parameter. This number can be controlled using maxReaggregationThreads. The default value of maxReaggregationThreads has now changed to 64. Number of threads can not be higher than number of logical CPUs on the system, regardless of the setting.​

MS SQL must have the VIEW SERVER STATE permission enabled. BigFix Inventory uses MS SQL to access temadb. Without this permission, the aggregation runs single threaded and does not apply the maxReaggregationThreads parameter.

9.2.4
  • Name: Maximum number of rows exported to PDF
  • Parameter: pdfReportRowLimit
Number 100 000 0 2147483647
Specifies the maximum number of rows that can be exported to a PDF file. If the number of rows in the report is larger than the specified limit, appropriate information is provided in the generated PDF file.
9.2.3
  • Name: Maximum number of rows in REST API for raw scan results
  • Parameter: raw_data_api_default_limit

    (removed since BigFix Inventory version 10.0.2)

Number 100 000 0 2147483647
Specifies the maximum number of rows to be retrieved in a single request when using REST API for retrieving raw scan results. This parameter applies only if the REST API limit parameter, which always takes precedence, is omitted in the request. The default value is 100 000. 0 indicates that all rows are retrieved.
9.2.7
  • Name: Maximum number of rows to select on the Software Classification report
  • Parameter: selectAllLimit
Number 250000 0 500000
Specifies the maximum number of rows that can be selected at once on the Software Classification report.
9.2.7
  • Name: Maximum size of VMware .slmtag files
  • Parameter: vmman_slm_tags_file_size_limit
Bytes 10240 10240 1048676
The maximum size of each .slmtag file that is used to collect VMware license metric utilization.
9.2.8
  • Name: Maximum visibility of data for inactive computers
  • Parameter: max_data_visibility_for_inactive_computers
Days 90 1 1000
Specifies the number of days after which the data from the inactive computer no longer influences metric calculation and is not visible in BigFix Inventory. To enable this feature change the decommission_inactive_computers parameter to true.
9.2.8
  • Name: Number of days to count Microsoft Windows Server metrics after VM migration
  • Parameter: historical_period_for_microsoft_metrics
Days 90 0 180
Specifies the number of days for which data from a VM contributes to metric calculation of Microsoft Windows Server after the VM is moved to a different host. Run an import after you change the value of this parameter to recalculate the data.
9.2.10
  • Name: Number of days to keep the removed raw scan results
  • Parameter: raw_data_api_history_keep_days
Days 7 -1 30
Specifies the number of days after which historical raw scan data is removed from the database. The data was used to discover software but cannot be used for this purpose again. It is not displayed on any reports. It can only be retrieved by using REST API. The data is no longer needed and can be safely removed from the database without any impact on the reports.

Set the value of the parameter to 0 to remove the data after every successful import. You can set it to -1 to never remove the data. However, such a setting is not recommended as it can generate lots of unnecessary data that impacts application performance.

9.2.10
  • Name: (Currently not used) Number of days to keep internal application data
  • Parameter: pruning_days_to_keep
Days 0 -1 2147483647
Specifies the number of days after which internal data that is used by the application is removed from the database. The data is not displayed on any reports and can be safely removed from the database.

Set the value of the parameter to 0 to remove the data after every successful import. You can set it to -1 to never remove the data. However, such a setting is not recommended as it can generate lots of unnecessary data that impacts application performance.

9.2.7
  • Name: Optimize migration from 7.x for large environments
  • Parameter: new_migration_mode_enabled
Boolean (true/false) True
Specifies whether the migration from version 7.x to 9.x is optimized for large environments.
9.2.12
  • Name: Optimized shared disks scan: CPU threshold
  • Parameter: autoscan_shared_disks_cpu_threshold
Integer 0 0 100
Limits the amount of processor resources that the scanner consumes during the optimized scan of shared disks. By default, the option is set to 0 which means that the limit is disabled.
9.2.12
  • Name: Optimized shared disks scan: enable
  • Parameter: autoscan_shared_disks_enable
Boolean (true/false) False
Enables optimized scan of shared disks. When the option is enabled, scanning of shared disks is automated. As a result, the following actions are performed automatically:
  • Computers are designated to scan shared disks that exist in your infrastructure
  • Software scans are scheduled on the designated computers
  • New computers are designated if problems occur with scanning the initially designated computers
The option is disabled by default. For more information, see: Discovering software on shared disks.
9.2.12
  • Name: Optimized shared disks scan: maximum inactivity time
  • Parameter: max_inactivity_of_designated_shared_disk_scanner
Days 14 1 365
Specifies the maximum time after which a computer that is designated to scan a shared disk and which already provided scan results is considered inactive. After that time, a new computer is automatically designated to scan the shared disk.
9.2.12
  • Name: Optimized shared disks scan: maximum waiting time
  • Parameter: max_waiting_for_share_disk_scan_for_new_designated_endpoint
Days 7 1 90
Specifies the maximum time to wait for the first results of the shared disk scan performed by a newly designated computer. If no results are collected for this period, a new computer is automatically designated to scan the shared disk.
9.2.12
  • Name: Optimized shared disks scan: scan interval
  • Parameter: autoscan_shared_disks_scan_interval_days
Days 7 1 30
Specifies the frequency of the optimized software scan on shared disks.
9.2.3
  • Name: Preserve Initiate Software Scan actions on the BigFix server
  • Parameter: scanConfig_preserve_InitiateScanAction
Boolean (true/false) False
Specifies whether Initiate Software Scan actions that are created on the BigFix server are preserved when the scan configuration is deleted on the Scan Configurations panel. If you set the value of this parameter to true, the actions are stopped but are not removed from the BigFix server.
9.2.13
  • Name: Remove information about current software users during next import
  • Parameter: remove_user_information
Boolean(true/false) False
Specifies whether information about current software users is removed during the next import. Historical aggregation data for Registered User metric will also be removed from the All Metrics report. This option is disabled by default.
9.2.4
  • Name: Re-synchronize datasources after database restoration
  • Parameter: resynchronize_datasources_once
Boolean (true/false) False
Enables an import that retrieves all software scan data from the restored BigFix database. Such an import is time-consuming and should be run only when problems with incomplete data occur after the database is restored. When you enable the option, the import runs once and returns to the normal operation mode.
9.2.11
  • Name: Re-synchronize Scan Data
  • Parameter: resync_imports
Integer 0 0 60

Defines the number of consecutive imports during which scan data is re-synchronized. By default, the option is set to 0 which means that resync_import is disabled, and scan data is not re-synchronized. It is recommended to re-synchronize the data during 7 to 14 imports to optimize the load on the BigFix server. To define the scope of the re-synchronized data, change the value of the resync_mode parameter.

Resynchronization is needed if you want to display detailed file version for software components that were discovered before you upgraded BigFix Inventory to version 9.2.11.
Note: This parameter is not used for regular tasks and actions. It is used only to import changes when there is a new feature or patch available. With subsequent <resync_imports> import, the scanned data is resynchronised as per the scope defined in resync_mode. During the process, each import 1/<resync_imports> of the compute is extended with regular updates coming from the endpoint itself.
Set the DB2 compatibility vector to MYS to allow the re-sync functionality work properly.
  • Use db2set | grep 'DB2_COMPATIBILITY_VECTOR' command to check if the value is correctly set. The command should return DB2_COMPATIBILITY_VECOTR=MYS.
  • If the value is not correctly set, use db2set DB2_COMPATIBILITY_VECTOR=MYS command to set the value.
9.2.11
  • Name: Re-synchronize Scan Data Mode
  • Parameter: resync_mode
Enum File Scan Only (0) All Scans (1) Catalog Scan Only (2)
Defines the scope of scan data that is re-synchronized.
Possible values:
  • File Scan Only (0) - Only results of the file system scan are resynchronized.
  • All Scans (1) - Results of the file system scan, catalog-based scan, and software identification tags scan are re-synchronized.
  • Catalog Scan Only (2) - Results of the CIT scans are re-synchronized.
Notice: 10.0.9 The parameter has been removed. 10.0.12

The parameter has been restored.

9.2.9
  • Name: Recompute unrecognized scan data aggregates
  • Parameter: recompute_unrecognized_scan_data
Enum Never (0)
Specifies how often unrecognized scan data is calculated. The data allows for determining the most effective ways of improving signature coverage, but slows down imports, particularly in larger deployments. The aggregated data is visible on the Unrecognized Files report.
Possible values:
  • Never (0) - Scan data aggregates are not calculated.
  • Next Import Only (1) - Scan data aggregates are calculated only during the next import. Then, the value of the parameter changes to Never (0).
  • Every Import (2) - Scan data aggregates are calculated during every import.
Note: Unrecognized Files report is provided for backward compatibility and is not recommended as a source of information about candidates for signatures.
  • Name:Reporting Missing Scan status

    Previously: Software scan interval

  • Parameter: scanHealthLastScanAttempt
Days 30 1 365
Specifies the number of days from the last software scan after which the computer is reported on the Software Scan Health widget as missing software scan.
  • Name: Scan files import waiting time
  • Parameter: scanFilesDownloadImportTimeout
Seconds 10 1 600
Specifies the maximum number of seconds to wait for a file with scan results to be read from the BigFix server during import.
9.2.3
  • Name: Server ID template for managed hosts
  • Parameter: managedServerTagTemplate
String %VENDOR %TYPE %HOSTNAME
Specifies the format of information about VM manager hosts that is displayed in the Server ID column on the reports. The parameter affects hosts from which data is collected by the VM Manager tool or by the Run Capacity Scan on Virtualization Hosts fixlet.
By default, the column contains information about the vendor, type and host name of the VM manager host. For example: IBM NC123456.IBM.COM. You can choose any combination of the following characteristics of a VM manager host to be displayed on the reports:
  • Host name (REST API value: %HOSTNAME)
    Important: To display this information for hosts from which data is collected by the Run Capacity Scan on Virtualization Hosts fixlet, you must first enable the collection of host names. To do this, select the Collect host names of virtualization hosts check box in the fixlet. Otherwise, a serial number is displayed instead of the host name for such VM manager hosts.
  • Identifier (REST API value: %ID)
  • Model (REST API value: %MODEL)
  • Serial number (REST API value: %SERIAL_NUMBER)
    Important: To display this information for hosts from which data is collected by the VM Manager tool, you must first enable the collection of serial numbers. To do this, set the value of the vmman_collecting_host_serials_enabled parameter to true.
  • Type (REST API value: %TYPE)
  • Vendor (REST API value: %VENDOR)
Note: Information is displayed in the new format after the next import.
To change the format of information through REST API, list the characteristics of the VM manager host that you want to display in the value parameter. The value must be URL-encoded. For example:
PUT http://localhost:9081/api/sam/configs?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa&name=managedServer
TagTemplate&value=%25VENDOR%20%25TYPE%20%25SERIAL_NUMBER
9.2.3
  • Name: Server ID template for unmanaged hosts
  • Parameter: standaloneServerTagTemplate
String %VENDOR %TYPE %SERIAL_NUMBER
Specifies the format of information about the host that is displayed in the Server ID column on the reports. The parameter affects hosts that are not affected by the managedServerTagTemplate parameter.
By default, the column contains information about the vendor, type and serial number of the host. For example: IBM Corp. 7946 99B7166. You can choose any combination of the following characteristics of a host to be displayed on the reports:
  • Identifier (REST API value: %ID)
  • Model (REST API value: %MODEL)
  • Serial number (REST API value: %SERIAL_NUMBER)
  • Type (REST API value: %TYPE)
  • Vendor (REST API value: %VENDOR)
Note: Information is displayed in the new format after the next import.
To change the format of information via REST API, list the characteristics of the host that you want to display in the value parameter. The value must be URL-encoded. For example:
PUT http://localhost:9081/api/sam/configs?
token=7adc3efb175e2bc0f4484bdd2efca54a8fa
&name=standaloneServerTagTemplate&value
=%25VENDOR%20%25MODEL%20%25SERIAL_NUMBER
9.2.8
  • Name: Size limit of Scan File to process
  • Parameter: scanFileSizeLimit
MB 20 0 100
Specifies the maximum size of the scan file that can be processed by BigFix Inventory. Files that exceed the limit are rejected. When you set the parameter to 0, the limit is disabled and all files are process regardless of their size.
  • Name: Sort bundling options alphabetically
  • Parameter: blockUiBundlingComputations
Boolean (true/false) False
Specifies whether bundling options that are displayed when you reassign a software component are sorted by confidence or alphabetically. By default, the options are sorted by confidence. If you set the value of the parameter to true, the options are sorted alphabetically and thus are displayed more quickly on the user interface.
9.2.8
  • Name: Split SQL query for inserting software facts
  • Parameter: split_ms_merge
Boolean (true/false) False
Important: Use this parameter only when you are requested by HCL Support.
Splits the SQL query that is used for inserting software facts into multiple queries to reduce usage of TEMPDB in a large-scale environment. Splitting the query lengthens the import. The parameter is applicable only on Windows.
  • Name: Store hardware data for VM manager nodes
  • Parameter: storeHwDataForAllVMManagerNodes
Boolean (true/false) False
Specifies whether information about nodes and clusters that is retrieved from VM managers is stored in the database, regardless of whether an agent is running on any virtual machine on such nodes or clusters.
9.2.7
  • Name: The default value of the Automatically confirm the affected components check box on the Software Classification panel
  • Parameter: automaticConfirm
Boolean (true/false) True
Specifies the default value of the Automatically confirm the affected components check box on the Software Classification. If the parameter is set to true, the check box is selected by default and components affected by an action are confirmed. Otherwise, affected component are not confirmed.
9.2.13
  • Name: To Do: Show that VM manager connection is missing
  • Parameter: todo_display_vm_managers_need
Boolean (true/false) True
Specifies whether the To Do List shows information about missing connections to VM managers. By default, the parameter is set to true which means that the item is displayed.
9.2.7
  • Name: User password: maximal number of characters
  • Parameter: user_password_max_length
Integer 0 0 1024
Specifies the maximum length of the user password. By default, the parameter is set to 0 which means that the requirement is disabled.
9.2.7
  • Name: User password: maximal number of the same characters in a row
  • Parameter: user_password_max_of_identical_characters_in_row
Number 0 0 32
Specifies the maximum number of the same characters that can be used in a row in the user password. By default, the parameter is set to 0 which means that the requirement is disabled.
9.2.7
  • Name: User password: minimal number of characters
  • Parameter: user_password_min_length
Number 8 0 128
Specifies the minimum length of the user password. Set the value to 0 to disable the requirement.
9.2.7
  • Name: User password: regular expression
  • Parameter: user_password_regular_expression
Regular Expression ^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$
Specifies the regular expression that must be matched by the user password. By default, the password must contain at least one uppercase character, one lowercase character, and one digit. Set the value to an empty string to disable this requirement.
9.2.7
  • Name: User password: required special characters
  • Parameter: user_password_special_characters
String 0
Specifies the list of special characters from which at least one must be used in the user password. By default, no special characters are required.
Note: Provide the characters one after another without any separators. For example: ?!&%. If you add a space, it is also treated as a special character.
9.2.3
  • Name: Validate VM manager data
  • Parameter: validateVMManagersData
Boolean (true/false) True
Specifies whether the XML schema of files with VM manager data is validated by the BigFix Inventory server.

Settings of the main VM Manager tool

The following parameters can be configured from the server only if you are using basic VM management. If you are using advanced VM management, you must edit the vmmmainconf.properties configuration file to change the parameters. For more information about changing the settings of an additional VM Manager tool, see: VM Manager Tool settings.
Table 2. Settings of the main VM Manager tool
Name & Parameter Type Default Minimum Maximum
Description
9.2.7
  • Name: Allow VM manager HTTP connection fallback
  • Parameter: vmman_http_connection_allowed
Boolean (true/false) True
Allows the VM manager to connect by using the HTTP protocol when the defined HTTPS connection is not available.
9.2.7
  • Name: Attempt to fix VM manager connection parameters
  • Parameter: vmman_fix_parameters_enabled
Boolean (true/false) False
Attempts to fix the most common problems with VM manager connection parameters, such as adding default URL suffix, correcting the user name format, and testing the WinRM and PowerShell protocols for Hyper-V VM managers.
  • Name: Check VM managers for uniqueness
  • Parameter: vmman_check_uniqueness_enabled
Boolean (true/false) False
Specifies whether unique VM managers are distinguished from duplicates.
9.2.3
  • Name: Collect serial numbers of VM manager hosts
  • Parameter: vmman_collecting_host_serials_enabled
Boolean (true/false) False
Specifies whether serial numbers of VM manager hosts are collected for VM managers from which data is collected by the VM Manager tool. Available for Hyper-V and VMware 5.0 and higher.

To display information about serial numbers in the Server ID column on the reports, adjust the Server ID template that is specified by the managedServerTagTemplate parameter.

9.2.2
  • Name: Collect virtual machines host names
  • Parameter: vmman_collecting_hostnames_enabled
Boolean (true/false) False
Specifies whether host names of virtual machines are collected by the VM Manager tool and saved in its log files. Available for VMware only.

You can enable this parameter to solve problems with duplicated UUIDs. If duplicates are found, the host names are written in the log files.

  • Name: Filter VM manager UUIDs
  • Parameter: vmman_uuid_filtering_enabled
Boolean (true/false) False
Enables UUID filtering of VM managers. For more information, see: UUID-based virtual machine filtering.
  • Name: Maximum number of subsequent login failures
  • Parameter: vmman_max_subsequent_login_failures
Number 3 0 100
Specifies the maximum number of failed attempts of logging in to the VM manager.
9.2.4
  • Name: Transfer VM manager credentials
  • Parameter: vmman_transfer_credentials_to_server
Boolean (true/false) True
Specifies whether VM manager credentials are transferred to the server. The option is enabled by default. If you disable the option, the credentials are not transferred and thus they are not displayed on the VM Managers panel when you edit the VM manager.
9.2.4
  • Name: Trust SSL certificates from all defined VM managers
  • Parameter: vmman_trust_all_vm_managers_certificates
Boolean (true/false) True
Specifies whether SSL certificates from all defined VM managers are trusted. If the option is disabled, certificates that are trusted must be placed in the truststore on the computer where the VM Manager Tool is installed. For more information, see: Configuring VM Manager tool to accept trusted VM manager certificates.
  • Name: VM manager connection timeout
  • Parameter: vmman_connection_time_out
Seconds 90 10 3600 (1 hour)
Specifies the time after which the connection with a VM manager is ended.
  • Name: VM manager data transfer period
  • Parameter: vmman_transfer_period
Minutes 720 30 10080 (1 week)
Determines how often scan data is transferred to the agent to be uploaded to the server if subsequent scans have the same results.
  • Name: VM manager pooling interval
  • Parameter: vmman_pooling_time_interval
Minutes 30 30 10080 (1 week)
Specifies the interval between the consecutive retrievals of data from VM managers.
Restriction: In case of subcapacity reporting, it is necessary to capture mobility of VMs. To ensure that it is captured, data from VM managers must be collected every 30 minutes. You can change the frequency of collecting data only if you use BigFix Inventory for purposes other than subcapacity reporting.
  • Name: VM manager thread pool size
  • Parameter: vmman_thread_pool_size
Number 10 1 50
Specifies the number of threads in the thread pool that is used for connections to VM managers.