doc_playbooks_list.md

License Metric Tool playbooks

License Metric Tool playbooks are supported on operating systems that are supported by the disconnected scanner except for IBM i. For a list of supported operating systems, see: IBM License Metric Tool 9.2 - Supported Operating Systems.

Name	Required access	Minimal set of targeted nodes
	Description
lmt_collect_results	Read, execute and write access to the scanner output directories	localhost lmt_server
	This playbook collects packages with disconnected scan results from the following scanner output directories: [UNIX/Linux] {{lmt_scanner_output_path_unix}} [Windows] {{lmt_scanner_output_path_windows}} and stores them in the {{lmt_local_file_storage_path}}/scan_result_packages temporary folder on the control node. Then, it uploads the packages to the {{lmt_server_datasource_path}} directory on the lmt_server node. Finally, it removes collected scan results from the scanner output directories and from the temporary folder on the control node.
lmt_install_or_upgrade_scanner	Root / Local Administrator rights	localhost lmt_server
	This playbook installs or upgrades the disconnected scanner to the same version as the version of your License Metric Tool server. NOTE: Before you run this playbook, review the default values of the Parameters used in playbooks and adjust them if needed. The following tasks are performed within this playbook: 1. The latest version of the disconnected scanner packages is downloaded from the {{lmt_server_path}}/disconnected_scanners directory on the lmt_server node and is stored in the {{lmt_local_file_storage_path}}/scanner_installers folder on the control node. 2. The playbook checks whether the scanner is already installed or whether its version is older than the latest version that is available. Then, it either continues the installation or upgrade, or exits. 3. In case of the upgrade, the currently installed scanner is uninstalled. Its configuration from the isotag_config.xml and sw_config.xml scanner settings files, and the endpoint_id.txt file are preserved in the config_backup subdirectory of the disconnected scanner directory. 4. It is verified whether a sufficient amount of free disc space is available on the partition on which the scanner is going to be installed. If not, the installation is stopped. The following amount of free disc space is required: [Linux] 60 MB [Windows] 80 MB [AIX] 100 MB [Solaris] 100 MB 5. The disconnected scanner package that is suitable for the operating system of the managed node is uploaded to the following directory: [UNIX/Linux] {{lmt_scanner_path_unix}} [Windows] {{lmt_scanner_path_windows}} 6. The scanner package is uncompressed by using the following method: [UNIX/Linux] gzip and tar commands that need to be present in the $PATH of the configured Ansible user. [Windows] win_unzip Ansible module. 7. In case of the upgrade, the scanner configuration and endpoint ID are restored from backup. 8. The setup_config.ini configuration file is configured according to the defined parameters and the following installation script is started: [UNIX/Linux] {{lmt_scanner_path_unix}}/setup.sh [Windows] {{lmt_scanner_path_windows}}\setup.bat 9. It is verified that the installation completed successfully and all temporary or backup files are removed.
lmt_uninstall_scanner	Root / Local Administrator rights	localhost
	This playbook uninstalls the disconnected scanner from the targeted managed nodes from the following locations: [UNIX/Linux] {{lmt_scanner_path_unix}} [Windows] {{lmt_scanner_path_windows}} If the {{lmt_scanner_token}} parameter is defined, the computer is automatically decommissioned from the License Metric Tool server after the scanner is unintstalled from that computer. NOTE: This playbook removes the entire folder in which the disconnected scanner is installed. Because it removes the internal endpoint ID, a new endpoint ID is generated if you install the scanner on the same computer. As a result, the computer is reported in License Metric Tool as a different computer than before.
lmt_reconfigure_scanner	Root / Local Administrator rights	localhost
	This playbook allows you to change the configuration of the existing disconnected scanners. It can be useful, for example when you want to change the software scan schedule, or modify extra settings on Solaris (DSD mode) or Linux on System z. Before you run this playbook, update Ansible parameters accordingly. NOTE: Every time you run this playbook, the schedule of hardware and software scans as well as the schedule of packing scan results is updated.
lmt_collect_status	Read rights to the config and iso-swid disconnected scanner folders	localhost
	This playbook collects information about the version of scanners that are installed on your managed nodes and the last status of the disconnected scanner configuration. The collected data in stored in the {{lmt_local_file_storage_path}}/scanner_statuses.csv file on the control node. The comma-separated values in the scanner_statuses.csv file are: Ansible Host - as defined in the Ansible inventory Scanner path - the value of the configured parameter [UNIX/Linux] lmt_scanner_path_unix [Windows] lmt_scanner_path_windows Endpoint ID - unique identifier of the disconnected scanner taken from the endpoint_id.txt file or Not available in case when scanner is not installed. Scanner Version - version of the installed scanner taken from .swidtag file or Not installed in case when scanner is not installed Installation status - The status of the disconnected scanner installation. The status is updated every time the lmt_install_or_upgrade_scanner or lmt_reconfigure_scanner playbook is run. Possible values: Successful - the last scanner installation or upgrade, or the last modification of configuration parameters was successful Failed - the last scanner installation or upgrade, or the last modification of configuration parameters failed Unknown - for scanners older than version 9.2.22 where the status information was not yet available Not available - the scanner is not installed The file is recreated during each run of the playbook and contains information only about managed nodes that were targeted in the last run of the playbook.
lmt_collect_troubleshooting_data	Read rights to entire disconnected scanner folder and write rights to the work subdirectory	localhost
	This playbook collects data that can be used to investigate potential problems. It creates the following package on all targeted managed nodes on which the disconnected scanner is installed: [UNIX/Linux] {{Ansible Host}}_{{Endpoint ID}}.tar.gz [Windows] {{Ansible Host}}_{{Endpoint ID}}.zip The package is compressed by using the following method: [UNIX/Linux] community.general.archive Ansible module. [Windows] zip.exe delivered together with disconnected scanner. Next, it downloads the files and stores them in the {{lmt_local_file_storage_path}}/troubleshooting_data/ directory on the control node. The package contains the following items: ansible_facts.txt file that contains a list of relevant information about the system in the JSON format content of the following directories: config logs iso-swid work output