Skip to content

Latest commit

 

History

History
549 lines (523 loc) · 17.4 KB

doc_lmt_parameters.md

File metadata and controls

549 lines (523 loc) · 17.4 KB
Raw

Parameters used in playbooks

Before you run License Metric Tool playbooks, review default values of License Metric Tool parameters and adjust them according to your needs.

Parameter Available from Default value Applicable nodes Playbooks that use the parameter
Description
lmt_local_file_storage_path 9.2.22 ./lmt_file_storage
It is a subdirectory of the directory where the playbooks are located. 		All managed nodes collect_results
install_or_upgrade
collect_status
troubleshooting
Path on a control node where the License Metric Tool files are stored. It contains packages with disconnected scan results, troubleshooting data, installed scanner and status data retrieved from all computers.
Do not place the directory in a temporary location (for example, /tmp) as this is expected to be a persistent storage of License Metric Tool files.

Possible values: Path (string)
lmt_server_path 9.2.22 [Linux] /opt/ibm/LMT
[Windows] {{ansible_env['ProgramFiles']}}
\ibm\LMT 		lmt_server collect_results
install_or_upgrade
Path to the main directory of the License Metric Tool server on the lmt_server node.

Possible values: Path (string)
lmt_server_datasource_path 9.2.22 [Linux] {{lmt_server_path}}/datasource
[Windows] {{lmt_server_path}}\\datasource 		lmt_server collect_results
Path to a disconnected data source directory on the License Metric Tool server.

Possible values: Path (string)
lmt_scanner_path_unix 9.2.22 /var/opt/ibm/LMTScanner Managed nodes on UNIX/Linux collect_results
install_or_upgrade
collect_status
troubleshooting
uninstall
reconfigure
Path on the UNIX and Linux managed nodes where the scanner will be installed.

Possible values: Path (string)
lmt_scanner_output_path_unix 9.2.22 {{lmt_scanner_path_unix}}
  /output 		Managed nodes on UNIX/Linux collect_results
Path to a directory where packages with scan results are generated on UNIX/Linux.

Possible values: Path (string)
lmt_scanner_path_windows 9.2.22 {{ansible_env['ProgramFiles']}}
  \ibm\LMTScanner 		Managed nodes on Windows collect_results
install_or_upgrade
collect_status
troubleshooting
uninstall
reconfigure
Path on the Windows managed nodes where the scanner will be installed.

Possible values: Path (string)
lmt_scanner_output_path_windows 9.2.22 {{lmt_scanner_path_windows}}
  \output 		Managed nodes on Windows collect_results
Path to a directory where packages with scan results are generated on Windows.

Possible values: Path (string)
lmt_scanner_setup_timeout 9.2.22 300 All managed nodes install_or_upgrade
reconfigure
Number of seconds after which the scanner setup and uninstaller is terminated and reported as failed if it does not finish within the defined time.

Possible values: Number
lmt_scanner_solaris_dsd_mode 9.2.22 false Managed nodes on Solaris install_or_upgrade
reconfigure
Applicable only for Solaris. Information whether the Solaris system is in the DSD domain.

Possible values: true/false.
All starting with lmt_scanner_zlinux:
machine_type
processor_type
shared_pool_capacity
system_active_processors
 9.2.22 Not set. It assumes that automatic capacity configuration is supported. Otherwise, installation or reconfiguration fails. Managed nodes on Linux on System z install_or_upgrade
reconfigure
A set of parameters that describe underlying hardware of the System z host on which the scanner is going to be installed. The parameters need to be defined if the automatic capacity configuration is not supported. Remember to set all four parameters in such case otherwise the scanner installation or configuration may hang.

Automatic capacity configuration is supported on Linux on z/KVM and on System z10 starting from model E64 (type 2097) mainframes with z/VM 6.3 and later that supports the Store Hypervisor Information (STHYI) instruction.
Additionally, global performance data control option must be set in HMC for LPARs for the automatic capacity configuration to work.

Example:
On a z9 machine with 12 IFL processors running on a shared pool with the capacity of 20, set the variables as follows:
lmt_scanner_zlinux_machine_type: "z9"
lmt_scanner_zlinux_processor_type: "IFL"
lmt_scanner_zlinux_shared_pool_capacity: "20"
lmt_scanner_zlinux_system_active_processors: "12"

Possible values: Strings
lmt_scanner_software_scan_cpu_threshold_percentage 9.2.27 Empty (none) All managed nodes install_or_upgrade
reconfigure
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 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. Setting the threshold might lengthen the time of the scan.

Possible values: Empty, or integer between 5 - 100
lmt_scanner_software_scans_enabled 9.2.22 true All managed nodes install_or_upgrade
reconfigure
Enables scheduling software scans in cron. If you set the value of this parameter to true, the first software scan is initiated after you setup the scanner. Subsequent scans run with the frequency that is set in the lmt_scanner_software_scans_frequency parameter. After each execution of the software scan, packing results is automatically triggered.

Possible values: true/false.
lmt_scanner_software_scans_frequency 9.2.22 WEEKLY All managed nodes install_or_upgrade
reconfigure
Defines the frequency of software scans when the scheduled software scans are enabled by the lmt_scanner_software_scans_enabled parameter.

Possible values: DAILY/WEEKLY.
lmt_scanner_software_scan_day_of_week 9.2.26 Empty (none) All managed nodes install_or_upgrade
reconfigure
Defines the day of the week on which the weekly scan will run. This parameter is relevant only if the lmt_scanner_software_scans_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 install or upgrade or reconfigure playbook was run.

Possible values: EMPTY/MON/TUE/WED/THU/FRI/SAT/SUN.
lmt_scanner_software_scan_local_time 9.2.26 Empty (none) All managed nodes install_or_upgrade
reconfigure
Defines the time (hour and minutes) during the day in the LOCAL time zone of manage node 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 install or upgrade or reconfigure playbook was run.

Example:
lmt_scanner_software_scan_local_time: "20:30"
Note: Ensure the time string is enclosed in quotation marks.

Possible values: EMPTY or time in the "HH:MM" format.
lmt_scanner_daily_pack_results_enabled 9.2.22 true All managed nodes install_or_upgrade
reconfigure
Enables scheduling daily creation of the scan results package. If you set the value of this parameter to true, creation of the first scan results package is initiated 23 hours after you install the scanner. Subsequent packages are generated daily.

Possible values: true/false.
lmt_scanner_public_cloud_type 9.2.23 Empty (none) All managed nodes install_or_upgrade
reconfigure
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.

Example:
lmt_scanner_public_cloud_type: "Microsoft Azure"
Note: Ensure the name of the public cloud is enclosed in quotation marks.

Possible values include names of supported public clouds such as:
"IBM Cloud Virtual Server"
"IBM Power Virtual Server"
"IBM SoftLayer"
"IBM Cloud LinuxONE VS"
"Microsoft Azure"
"Amazon EC2"
"Google Compute Engine"
"Oracle Compute Instance"
"Alibaba Elastic Compute Service"
"Tencent Cloud Server Instance"
"NEC Cloud IaaS Instance"
"Fujitsu Cloud IaaS Instance"
"NTT Enterprise Cloud Server"
"NTT IaaS Powered by VMware"
"NTT Data"
"KDDI Virtual Server"

For more information about supported types of public clouds, see: Identifying disconnected computers as running on public clouds in License Metric Tool documentation.
lmt_scanner_virt_host_scan_enabled 9.2.24 false Managed nodes on Linux install_or_upgrade
reconfigure
Enables capacity scan on virtualization host to retrieve capacity data from all virtual machines that are managed by the specified host. Schedule the scan on every host that manages virtual machines which have the disconnected scanner installed.

Supported virtualization technologies:
  • Xen on Linux x86
  • KVM on Linux x86
  • KVM on Power Linux

Prerequisites on the KVM host:
  • Operating system: Linux x86 or ppc64
  • Libvirt-client library installed directly on the hypervisor or inside a container running within the hypervisor (virsh command available) or xl command available
  • Libxml2 library installed on the host (xmllint command available)
  • Bash shell available

Prerequisites on the Xen host:
It is recommended to collect capacity from Xen data by using the VM Manager Tool instead of this task. For more information, see the product documentation.

Possible values: true/false.
lmt_scanner_collect_host_hostname 9.2.24 false Managed nodes on Linux install_or_upgrade
reconfigure
Enable this option if you want to collect information about host names of virtualization hosts during virtualization host scan (the lmt_scanner_virt_host_scan_enabled parameter needs to be enabled).

Possible values: true/false.
lmt_scanner_docker_scan_enabled 9.2.26 false Managed nodes on Linux install_or_upgrade
reconfigure
Set the value of this parameter to TRUE to enable the scan of all Docker containers that are deployed on the target managed node.

Possible values: true/false.
lmt_server_token 9.2.24 Empty (none) All managed nodes uninstall
API token of the License Metric Tool server. If the token is defined, the disconnected computer is automatically decommissioned from the License Metric Tool server during scanner uninstallation.

Possible values: String
lmt_server_port 9.2.24 9081 All managed nodes uninstall
Port number of the License Metric Tool server. It is used to connect to the License Metric Tool server API while decommissioning computers.

Possible values: Number