Configuration parameters of the disconnected scanner (disconnected scenario)
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.
setup_config.ini
- automation/configure.sh
- automation\configure.bat
Parameter | Default value | Possible values | Description |
---|---|---|---|
COLLECT_HOST_HOSTNAME | 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 during the upload of disconnected scan results to the License Metric Tool server. They are used to customize connection parameters that might be required in more secure environments. For more information, see the following links:
|
CURL_PATH |
|
String |
Full path to cURL if cURL is not located in the PATH environment variable. For more information, see: Uploading disconnected scan results (disconnected scenario). |
DAILY_PACK_RESULTS_ CREATION_ENABLED |
|
|
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.
|
DOCKER_SCAN_ENABLED | 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 |
|
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_URL | The field is empty by default | {IP address or host name}:port |
IP address or host name, and port of the License Metric Tool server to which packages with disconnected scan result will be uploaded. For more information, see: Uploading disconnected scan results (disconnected scenario). |
LMT_SERVER_API_TOKEN | The field is empty by default | String |
API token to be used to upload disconnected scan results to the License Metric Tool server. It must belong to a user with the Manage Scan Uploads (previously: Manage Uploads) permission. For more information, see: Uploading disconnected scan results (disconnected scenario). The API token is kept in obfuscated form. |
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. |
PUBLIC_CLOUD_TYPE | The field is empty by default |
|
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 |
|
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 |
|
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 |
|
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 |
|
|
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 |
|
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
Parameter | Default value | Possible values | Description |
---|---|---|---|
AssumeAutoFS | remote |
|
Specifies how the scan recognizes disks that were mounted by the automatic mounting service (autofs). |
ExcludeDirectory | Depends on the operating system For more information, see: Excluding directories from software scans (disconnected scenario). |
[media_type::]drive:path Where:
|
Specifies directories that are excluded from software scans. For more information, see: Excluding directories from software scans (disconnected scenario). |
ExcludeGuestDirectories | true |
|
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:
|
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
sw_config.xml
Parameter | Default value | Possible values | Description |
---|---|---|---|
assumeAutoFS | remote |
|
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 For more information, see: Excluding directories from software scans (disconnected scenario). |
Where:
|
Specifies directories that are excluded from software scans. For more information, see: Excluding directories from software scans (disconnected scenario). |
excludeGuestDirectories | true |
|
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:
|
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
- tlm_hw_config.xml