Configuration parameters of the disconnected scanner (disconnected scenario)

Edit online

9.2.5 Available from 9.2.5. You can customize the disconnected scanner behavior and the scans that it runs by editing the configuration files. For example, you can schedule scans and specify directories to exclude from scans.

Important: Do not change parameters that are not described.

setup_config.ini

Important: The file is not available on IBM i. Only default configuration is possible on IBM i.

The file contains general parameters for scheduling software and capacity scans. Every time you change a parameter in the setup_config.ini file, run the following script for the changes to take effect:

automation/configure.sh
automation\configure.bat

Table 1. Parameters in the setup_config.ini file.
Parameter	Default value	Possible values	Description
AUTO_UNINSTALL_ENABLED	TRUE	TRUE FALSE	Enables automatic uninstallation of the disconnected scanner from computers that were deleted from License Metric Tool. A computer can be deleted from the Computers panel or because the option to automatically decommission inactive computers is enabled in License Metric Tool. The scanner checks whether the computer was deleted from License Metric Tool daily. For the automatic uninstallation to work, the parameter AUTO_UNINSTALL_SCANNER_FROM_DELETED_COMPUTERS must be enabled in License Metric Tool. If that parameter is disabled, the scanner does not receive relevant information from the server and does not perform any action regardless of whether the AUTO_UNINSTALL_ENABLED setting is enabled or disabled on the disconnected scanner.
AUTO_UPGRADE_ENABLED	FALSE	TRUE FALSE	Enables automatic upgrade of the disconnected scanner. The scanner checks whether a new version is available daily. If a new version is available, it is downloaded and the scanner is upgraded. For the automatic upgrade to work, you must also set the following parameters. For application update 9.2.41: LMT_SERVER_URL and LMT_SERVER_API_TOKEN For application update 9.2.42 and later: DATA_UPLOAD_URL and DATA_UPLOAD_TOKEN
COLLECT_HOST_HOSTNAME	FALSE	TRUE FALSE	Enables collection of host names of virtualization hosts. The VIRTUALIZATION_HOST_SCAN_ENABLED parameter must be set to TRUE before you can enable collection of host names.
CURL_PARAMETERS	`-k -s`	String	cURL options that are used when the disconnected scanner communicates with the License Metric Tool server. For example, during the upload of disconnected scan results or when checking for the availability of a new version of the disconnected scanner. They are used to customize connection parameters that might be required in more secure environments. For more information, see the following links: Uploading disconnected scan results directly to the server (disconnected scenario) Increasing security of uploading disconnected scan results to the server
CURL_PATH	curl curl.exe	String	Full path to cURL if cURL is not located in the `PATH` environment variable. For more information, see: Uploading disconnected scan results directly to the server (disconnected scenario).
DAILY_PACK_RESULTS_CREATION_ENABLED	For application updates 9.2.22 - 9.2.23: FALSE Starting from application update 9.2.24: TRUE	TRUE FALSE	Enables daily creation of packages with scan results. When you set the value of this parameter to FALSE, you need to run one of the following scripts to create packages with scan results. run_sw_and_pack.sh or pack_results.sh run_sw_and_pack.bat or pack_results.bat
DOCKER_SCAN_ENABLED	FALSE	TRUE FALSE	Enables discovery of software that is installed in containers. For more information on how License Metric Tool reports software that is installed in containers, see: Discovering software in containers.
HW_SCAN_SCHEDULE_ENABLED	TRUE	TRUE FALSE	Enables scheduling capacity scans in cron. By default, the capacity scan is scheduled to run every 30 minutes. The frequency cannot be modified. When you set the value of this parameter to FALSE, a single capacity scan is run but no schedule is set.
LMT_SERVER_UPLOAD_METHOD Starting from application update 9.2.42, the parameter is called DATA_UPLOAD_METHOD	CURL	CURL POWERSHELL	Specifies the connection method. If you choose PowerShell, the built-in PowerShell script for communication with the License Metric Tool server is executed with the 'Bypass' execution policy.
LMT_SERVER_URL Starting from application update 9.2.42, the parameter is called DATA_UPLOAD_URL	The field is empty by default	{IP address or host name}:port	Depending on whether you upload scan results directly to the License Metric Tool server or through the Scans Relay, specify the following: IP address or host name, and port of the License Metric Tool server with which the disconnected scanner communicates. IP address or host name, and port of the Scans Relay with which the disconnected scanner communicates. Important: This parameter must be set together with the LMT_SERVER_API_TOKEN or DATA_UPLOAD_TOKEN parameter depending on your version of License Metric Tool. Otherwise, the following actions will not work: Upload of scan results Automatic upgrade of the disconnected scanner Automatic uninstallation of the disconnected scanner For more information, see: Uploading disconnected scan results directly to the server (disconnected scenario).
LMT_SERVER_API_TOKEN Starting from application update 9.2.42, the parameter is called DATA_UPLOAD_TOKEN	The field is empty by default	String	Depending on whether you upload scan results directly to the License Metric Tool server or through the Scans Relay, specify the following: API token that is used when the disconnected scanner communicates with the License Metric Tool server. It must belong to a user with the following permissions: Manage Scan Uploads (previously: Manage Uploads) Edit Endpoints if you want to use the automatic upgrade of the disconnected scanner API token that is used when the disconnected scanner communicates with the Scans Relay. The API token is kept in the obfuscated form. Important: This parameter must be set together with the LMT_SERVER_URL or DATA_UPLOAD_URL parameter depending on your version of License Metric Tool. Otherwise, the following actions will not work: Upload of scan results Automatic upgrade of the disconnected scanner Automatic uninstallation of the disconnected scanner For more information, see: Uploading disconnected scan results directly to the server (disconnected scenario).
MAX_HW_SCAN_DAYS	14	Any positive number	The number of days after which scan results are considered old. Such results are removed if the number of unique scan files exceeds the number that is set in the MAX_HW_SCAN_FILES parameter.
MAX_HW_SCAN_FILES	7	Any positive number	The maximum number of files with capacity scan results that can be stored on a computer. If the number is exceeded, files that are older than specified in the MAX_HW_SCAN_DAYS parameter are not included in the package with scan results.
NUMBER_OF_HISTORICAL_RESULTS_TO_KEEP	30	Any positive number	The number of files with scan results that can be stored in the output folder. If there are more files, the oldest ones are removed during packaging. If you specify 0, the number of stored files is not limited and no files are removed during packaging.
PACKAGE_OUTPUT_DIR	.\output	Directory name	Defines the directory in which scan results are stored. By default, the .\output directory is created in the installation directory of the disconnected scanner.
POWERSHELL_TRUST_ALL_CERTIFICATES	TRUE	TRUE FALSE	Specifies whether any SSL certificate that is presented when the disconnected scanner communicates with the License Metric Tool server is trusted. If you set the value of this parameter to FALSE, you need to install the License Metric Tool certificate on the Windows machine on which the disconnected scanner is installed. For more information, see: Increasing security of uploading disconnected scan results to the server.
PUBLIC_CLOUD_TYPE	The field is empty by default	Alibaba Elastic Compute Service Amazon EC2 Fujitsu Cloud IaaS Instance Note: For application updates 9.2.24 and 9.2.25, Fujitsu Cloud IaaS Instance indicates FJcloud-V. Starting from application update 9.2.26, it indicates both FJcloud-V and FJcloud-O. Google Compute Engine IBM Cloud LinuxONE VS IBM Cloud Virtual Server IBM Power Virtual Server IBM SoftLayer KDDI Virtual Server Microsoft Azure NEC Cloud IaaS Instance NTT Data NTT Data OpenCanvas NTT Enterprise Cloud Server NTT IaaS Powered by VMware Oracle Compute Instance Tencent Cloud Server Instance	Specifies the type of a public cloud on which the computer is running. It allows for properly counting the number of Processor Value Units (PVUs) per virtual core. Note: Ensure the name of the public cloud is enclosed in quotation marks. Alternatively, you can mark computers from the License Metric Tool user interface. For more information, see: Identifying disconnected computers as running on public clouds (disconnected scenario).
SW_SCAN_CPU_THRESHOLD_PERCENTAGE	The field is empty by default	Empty value Integer between 5 and 100	Limits the amount of processor resources that the scanner consumes. By default, the value is empty, which indicates that the scan can consume up to 100% of a single CPU that is available to the scanner. The higher value that you specify as the threshold, the higher is the consumption limit. For example, if you specify `75`, scanner processes use the average of 75% of a single CPU that is available on the target computer. Important: Setting the threshold does not guarantee that CPU consumption is always below the specified value. It fluctuates around that value, sometimes exceeding it and sometimes dropping below it. Temporary peaks are expected. The CPU threshold provides the process scheduler of the operating system with information for how long to keep the scanner thread idle. The scanner does not control how the threshold is mapped to the CPU resources that are available. The assignment of resources is determined by the operating system that decides on which processor (or core) to run the scanner thread. Setting the threshold might lengthen the time of the scan. If you set the CPU threshold in application update 9.2.26 or lower by editing the isotag_config.xml, slmtag_config.xml and sw_config.xml files, the empty value of the SW_SCAN_CPU_THRESHOLD_PERCENTAGE parameter preserves your previous settings. For more information, see: Optimizing processor utilization by disconnected scanner (disconnected scenario).
SW_SCAN_DAY_OF_WEEK	The field is empty by default	MON TUE WED THU FRI SAT SUN	Defines the day of the week on which the weekly scan will run. This parameter is relevant only if the SW_SCAN_FREQUENCY parameter is set to WEEKLY. By default, this parameter is empty which means that the weekly scan will be scheduled starting from the time when the setup.sh or setup.bat script was run.
SW_SCAN_FREQUENCY	WEEKLY	DAILY WEEKLY	Defines the frequency of software scans, either daily or weekly.
SW_SCAN_LOCAL_TIME	The field is empty by default	Time in the HH:MM format	Defines the time (hour and minutes) during the day in the local time zone when the scheduled software scan (weekly or daily) will run. By default, this parameter is empty which means that the scan will start at the time of the day when the setup.sh or setup.bat script was run.
SW_SCAN_SCHEDULE_ENABLED	For application updates 9.2.5 - 9.2.23: FALSE Starting from application update 9.2.24: TRUE TRUE	TRUE FALSE	Enables scheduling software scans in cron on UNIX or Task Scheduler on Windows. When you set the value of this parameter to TRUE, the first software scan is initiated after you install the scanner. Subsequent scans run with the frequency that is set in the SW_SCAN_FREQUENCY parameter.
VIRTUALIZATION_HOST_SCAN_ENABLED	FALSE	TRUE FALSE	Enables the capacity scan on virtualization hosts that retrieves capacity data from all virtual machines that are managed by these hosts. After this scan is enabled, it becomes a part of the regular capacity scan. Thus, the HW_SCAN_SCHEDULE_ENABLED parameter must be set to TRUE before you enable the scan on virtualization hosts. For more information, see: Collecting capacity data from virtualization hosts with disconnect scanner (disconnected scenario).

isotag_config.xml and slmtag_config.xml

Important: The files are not available on IBM i. Only default configuration is possible on IBM i.

The isotag_config.xml file contains parameters for tuning the software identification tags scan. The slmtag_config.xml contains parameters for tuning the resource utilization scan.

Table 2. Parameters in the isotag_config.xml and slmtag_config.xml files
Parameter	Default value	Possible values	Description
AssumeAutoFS	remote	local Recognizes disks mounted by autofs as local disks. remote Recognizes disks mounted by autofs as remote disks. other Recognizes disks mounted by autofs as disks of other types, for example: DVD.	Specifies how the scan recognizes disks that were mounted by the automatic mounting service (autofs).
ExcludeDirectory	Depends on the operating system	[`media_type`::]`drive`:`path` Where: `media_type` Specifies the media type. Possible values: $local Excludes local disks. $remote Excludes remote disks. $other Excludes other disk types, for example: DVD. This option is supported only on Windows. $all Excludes all disks that are listed above. If the `media_type` variable is not specified, the $local value is assumed. `drive` Specifies drives to be excluded. You can indicate one or more drives or you can use the $local, $remote, $other, and $all values. In the latter case, all drives of a particular type are excluded from the scan. This variable is optional on UNIX. `path` Specifies the path to be excluded. The following wildcards are supported: asterisks (*) and question mark (?).	Specifies directories that are excluded from software scans. For more information, see: Excluding directories from software scans (disconnected scenario).
ExcludeGuestDirectories	true	true false	Specifies whether catalogs that belong to zones or WPARs are scanned. When the value of the parameter is set to true, the catalogs are not scanned.
IncludeDirectory	$local::*	[`media_type`::]`drive`:`path` Where: `media_type` Specifies the media type. Possible values: $local Includes local disks. $remote Includes remote disks. $other Includes other disk types, for example: DVD. This option is supported only on Windows. $all Includes all disks that are listed above. If the `media_type` variable is not specified, the $local value is assumed. `drive` Specifies drives to be included. You can indicate one or more drives or you can use the $local, $remote, $other, and $all values. In the latter case, all drives of a particular type are included in the scan. This variable is optional on UNIX. `path` Specifies the path to be included. The following wildcards are supported: asterisks (*) and question mark (?).	Specifies directories to be included in the software scan. For more information about scanning remote shared disks, see: Scanning remote shared disks (disconnected scenario).
Timeout	43200	Any positive number	Specifies the number of seconds after which a query times out.

schedule_scans.sh

Replace the default user profile name QSECOFR with the name of the profile that you want to use to run capacity scans. The user profile must meet the following requirements:

Class set to *USER
Special authority set to *NONE

You can use the same user profile that is used to install the scanner and run the software scan. Set up the special authority to *ALLOBJ.

sw_config.xml

The file contains parameters for tuning the catalog-based scan. For more information about this scan, see: Types of software scans (BigFix scenario).

Table 3. Parameters in the sw_config.xml file.
Parameter	Default value	Possible values	Description
assumeAutoFS	remote	local Recognizes disks mounted by autofs as local disks. remote Recognizes disks mounted by autofs as remote disks. other Recognizes disks mounted by autofs as disks of other types, for example: DVD.	Specifies how the scan recognizes disks that were mounted by the automatic mounting service (autofs). The parameter is not available.
excludeDirectory	Depends on the operating system	Where: `media_type` Specifies the media type. Possible values: $local Excludes local disks. $remote Excludes remote disks. $other Excludes other disk types, for example: DVD. This option is supported only on Windows. $all Excludes all disks that are listed above. If the `media_type` variable is not specified, the $local value is assumed. `drive` Specifies drives to be excluded. You can indicate one or more drives or you can use the $local, $remote, $other, and $all values. In the latter case, all drives of a particular type are excluded from the scan. This variable is optional on UNIX. `path` Specifies the path to be excluded. The following wildcards are supported: asterisks (*) and question mark (?).	Specifies directories that are excluded from software scans. For more information, see: Excluding directories from software scans (disconnected scenario).
excludeGuestDirectories	true	true false	Specifies whether catalogs that belong to zones or WPARs are scanned. When the value of the parameter is set to true, the catalogs are not scanned.
includeDirectory	$local::*	[`media_type`::]`drive`:`path` Where: `media_type` Specifies the media type. Possible values: $local Includes local disks. $remote Includes remote disks. $other Includes other disk types, for example: DVD. This option is supported only on Windows. $all Includes all disks that are listed above. If the `media_type` variable is not specified, the $local value is assumed. `drive` Specifies drives to be included. You can indicate one or more drives or you can use the $local, $remote, $other, and $all values. In the latter case, all drives of a particular type are included in the scan. This variable is optional on UNIX. `path` Specifies the path to be included. The following wildcards are supported: asterisks (*) and question mark (?).	Specifies directories to be included in the software scan. The parameter is not available. For more information about scanning remote shared disks, see: Scanning remote shared disks (disconnected scenario).
maxQueryTime	43200	Any positive number	Specifies the number of seconds after which a query times out.

Configuration files that should not be modified

Do not modify any parameters in the following configuration files. Otherwise, the disconnected scanner might stop working.

tlm_hw_config.xml