Skip to content

Commit

Permalink
Merge pull request #25 from IBM/dariuszglocki
Browse files Browse the repository at this point in the history
Dariuszglocki
  • Loading branch information
DariuszGlocki authored Jun 20, 2022
2 parents f1e09b0 + e58c2c9 commit a5edbbc
Show file tree
Hide file tree
Showing 13 changed files with 186 additions and 123 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Disconnected scans allow for discovering software and hardware inventory by running scripts that are provided in the disconnected scanner package. The scripts initiate software and capacity scans, and create a package with scan results that you later need to upload to the License Metric Tool server. You can automate management of disconnected scans by using [Ansible](https://docs.ansible.com/ansible/latest/index.html#about-ansible).

The current version of License Metric Tool playbooks is **9.2.27**
The current version of License Metric Tool playbooks is **9.2.28**


## Prerequisites
Expand All @@ -13,7 +13,7 @@ The current version of License Metric Tool playbooks is **9.2.27**

- **Supported version of the disconnected scanner**

The minimal supported version of License Metric Tool disconnected scanner to use with Ansible automation is **9.2.22**.
The minimal supported version of License Metric Tool disconnected scanner to use with Ansible automation is **9.2.22**.

- **Supported operating systems**

Expand Down Expand Up @@ -48,4 +48,4 @@ After you configure Ansible, run the `lmt_install_or_upgrade_scanner` playbook t
<br>

## Other resources
- [Installing License Metric Tool with Ansible](https://www.ibm.com/docs/en/license-metric-tool?topic=installing-disconnected-scanners-ansible-lite)
- [Installing License Metric Tool with Ansible](https://www.ibm.com/docs/en/license-metric-tool?topic=installing-disconnected-scanners-ansible-lite)
10 changes: 5 additions & 5 deletions docs/doc_automating_with_ansible_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ If Ansible is not yet implemented in your organization, start by installing and

>**Note:** The minimal supported version of Ansible is **2.10.2**. However, it is recommended to use the latest version of Ansible that is available.
2. Clone or download the Github repository.
2. Clone or download this Github repository.

3. Configure connections to your managed nodes.
- **\[UNIX/Linux\]** For more information, see: [Connecting to remote nodes](https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html#connecting-to-remote-nodes) in the Ansible documentation.
- **\[Windows\]** For more information, see: [Setting up a Windows Host](https://docs.ansible.com/ansible/latest/user_guide/intro_getting_started.html#remote-connection-information) and [Windows WinRM configuration](https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html) in the Ansible documentation.
- **\[Windows\]** For more information, see: [Setting up a Windows Host](https://docs.ansible.com/ansible/latest/user_guide/windows_setup.html) and [Windows WinRM configuration](https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html) in the Ansible documentation.


4. To create an inventory of your managed nodes, you can use the [lmt_inventory_template.yml](../lmt_inventory_template.yml) template.

a. In the `lmt_server` parameter, define connection settings to the host where the License Metric Tool server is installed.
- If you are running the playbook on the host where the License Metric Tool server is installed, use the default settings.
- If you are running the playbook on a different host, define the host connection parameters and remove the `ansible_connection: local` line.
- If you are running the playbooks on the host where the License Metric Tool server is installed, use the default settings.
- If you are running the playbooks on a different host, define the host connection parameters and remove the `ansible_connection: local` line.

**Example**
```
Expand Down Expand Up @@ -75,7 +75,7 @@ If Ansible is not yet implemented in your organization, start by installing and
# not recommended, ignores certificate validation for self-signed certificates (test environments only)
ansible_winrm_server_cert_validation: ignore

# It an example for a test purposes only - Windows endpoints can be configured in a more secure manner, refer to the existing documentation for details:
# It is an example for test purposes only - Windows endpoints can be configured in a more secure manner, refer to the existing documentation for details:
#https://docs.ansible.com/ansible/latest/user_guide/windows_setup.html#winrm-setup
#https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html
Expand Down
2 changes: 1 addition & 1 deletion docs/doc_automating_with_awx_tower.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Managing disconnected scans with AWX or Tower

[AWX]((https://github.com/ansible/awx)) is an open source, easy-to-use UI, dashboard and REST API for Ansible. [Ansible Tower](https://www.ansible.com/products/tower) is a commercial version of AWX supported by Red Hat. To manage the disconnected scans with either of these tools, perform the following steps.
[AWX]((https://github.com/ansible/awx)) is an open source, easy-to-use UI, dashboard and REST API for Ansible. [Ansible Tower](https://access.redhat.com/products/ansible-tower-red-hat ) is a commercial version of AWX supported by Red Hat. To manage the disconnected scans with either of these tools, perform the following steps.

1. Install AWX or Tower.

Expand Down
8 changes: 4 additions & 4 deletions docs/doc_configure_ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To use Ansible for automation, you need a control node where you can run Ansible


<details>
<summary>Supported version of ANsible</summary>
<summary>Supported version of Ansible</summary>

The minimal supported version of Ansible is 2.10.2. However, it is recommended to use the latest version of Ansible that is available.

Expand All @@ -19,7 +19,7 @@ The minimal supported version of Ansible is 2.10.2. However, it is recommended t

- Python 2.7, or Python 3.5 or a higher 3.x version.
- [`pywinrm`](https://docs.ansible.com/ansible/latest/user_guide/windows_winrm.html#what-is-winrm) package installed to communicate with Windows servers over WinRM.
- For a full list of control nodes requirements and the most up-to-date information, see: [Control node requirements](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) in the Ansible documentation.
- For a full list of control node requirements and the most up-to-date information, see: [Control node requirements](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements) in the Ansible documentation.
>**Note:** Control node is not officially supported on Windows.
</details>

Expand All @@ -29,14 +29,14 @@ The minimal supported version of Ansible is 2.10.2. However, it is recommended t
**\[UNIX/Linux\]**
- A way to communicate which usually is SSH. By default, this uses SFTP. If that is not available, you can switch to SCP in the `ansible.cfg`.
- Python 2.6 or a higher 2.x version, or Python 3.5 or a higher 3.x version.
- The `lmt_install_or_upgrade_scanner` and `lmt_collect_troubleshooting_data` playbooks requires the `gzip` and `tar` commands to be present in the <code>$PATH</code> of the configured Ansible user.
- The `lmt_install_or_upgrade_scanner` and `lmt_collect_troubleshooting_data` playbooks require the `gzip` and `tar` commands to be present in the <code>$PATH</code> of the configured Ansible user.
- For a full list of managed nodes requirements and the most up-to-date information, see: [Managed node requirements](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#managed-node-requirements) in the Ansible documentation.

>**Note:** If you have SELinux enabled on the License Metric Tool server (the `lmt_server` host) and the server is on a managed node, install `libselinux-python` to be able to copy the disconnected scan results. For more information, see: [Managed node requirements](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#managed-node-requirements) in the Ansible documentation.
**\[Windows\]**
- Ansible can generally manage Windows versions that are under current and extended support from Microsoft. Ansible can manage desktop operating systems including Windows 7, 8.1, and 10, and server operating systems including Windows Server 2008, 2008 R2, 2012, 2012 R2, 2016, and 2019.
- PowerShell 3.0 or higher and at least .NET 4.0 must be installed on the Windows host.
- PowerShell 3.0 or higher and at least .NET 4.0 must be installed on the host.
- A WinRM listener must be created and activated.
- The user must be a member of the local Administrators group or must be explicitly granted access.
- For a full list of managed nodes requirements and the most up-to-date information, see: [Managed node requirements on Windows](https://docs.ansible.com/ansible/latest/user_guide/windows_setup.html#windows-setup) in the Ansible documentation.
Expand Down
34 changes: 29 additions & 5 deletions docs/doc_lmt_parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,28 @@ Before you run License Metric Tool playbooks, review default values of License M
</td>
</tr>

<tr>
<td rowspan="2">
<code>lmt_scanner_software_scan_cpu_threshold_percentage</code>
</td>
<td>9.2.27</td>
<td>Empty (none)</td>
<td>All managed nodes</td>
<td>
<code>install_or_upgrade</code><br/>
<code>reconfigure</code>
</td>
</tr>
<tr>
<td colspan="4">
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.
<br/><br/>
<b>Important:</b> 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.
<br/><br/>
Possible values: Empty, or integer between 5 - 100
</td>
</tr>

<tr>
<td rowspan="2">
<code>lmt_scanner_software_scans_enabled</code>
Expand Down Expand Up @@ -389,6 +411,7 @@ Before you run License Metric Tool playbooks, review default values of License M
Possible values include names of supported public clouds such as:<br>
<code>"IBM Power Virtual Server"</code><br>
<code>"IBM SoftLayer"</code><br>
<code>"IBM Cloud LinuxONE VS"</code><br>
<code>"Microsoft Azure"</code><br>
<code>"Amazon EC2"</code><br>
<code>"Google Compute Engine"</code><br>
Expand All @@ -398,8 +421,9 @@ Before you run License Metric Tool playbooks, review default values of License M
<code>"NEC Cloud IaaS Instance"</code><br>
<code>"Fujitsu Cloud IaaS Instance"</code><br>
<code>"NTT Enterprise Cloud Server"</code><br>
<code>"NTT IaaS Powered by VMware"</code><br>
<br/>
For more information about supported types of public clouds, see: [Identifying disconnected computers as running on public clouds](https://ibm.biz/LMT_public_clouds_disconnected) in License Metric Tool documentation.
For more information about supported types of public clouds, see: <a href="https://ibm.biz/LMT_public_clouds_disconnected">Identifying disconnected computers as running on public clouds</a> in License Metric Tool documentation.
</td>
</tr>

Expand All @@ -418,7 +442,7 @@ Before you run License Metric Tool playbooks, review default values of License M
<tr>
<td colspan="4">
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 BigFix client installed.
Schedule the scan on every host that manages virtual machines which have the disconnected scanner installed.
<br/><br/>
Supported virtualization technologies:<br/>
<ul>
Expand Down Expand Up @@ -495,7 +519,7 @@ Before you run License Metric Tool playbooks, review default values of License M
</tr>
<tr>
<td colspan="4">
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.
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.
<br/><br/>
Possible values: String
</td>
Expand All @@ -516,7 +540,7 @@ Before you run License Metric Tool playbooks, review default values of License M
<td colspan="4">
Port number of the License Metric Tool server. It is used to connect to the License Metric Tool server API while decommissioning computers.
<br/><br/>
Possible values: Number.
Possible values: Number
</td>
</tr>
</table>
</table>
4 changes: 2 additions & 2 deletions docs/doc_maintain_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ After you successfully configure your environment, monitor it on an ongoing basi

## Procedure
- You can monitor the environment on the License Metric Tool dashboard. For more information, see: [Dashboard](https://ibm.biz/LMT_dashboard) in the License Metric Tool documentation. Pay special attention to the `Delayed Data Upload` status on the [Deployment Health](https://ibm.biz/LMT_deployment_health) widget and the Outdated Scan status on the [Capacity Scan Health](https://ibm.biz/LMT_capacity_scan_health) widget.
- In case of problems with the disconnected scanner, you can use the [`lmt_collect_troubleshooting_data`](doc_playbooks_list.md#lmt_collect_troubleshooting_data) playbook to collect data such as logs or raw scan data for troubleshooting purposes.
- Keep your environment up to date and upgrade the scanner to the latest version by using the [`lmt_install_or_upgrade_scanner`](doc_playbooks_list.md#lmt_install_or_upgrade_scanner) playbook after you upgrade the License Metric Tool server.
- In case of problems with the disconnected scanner, you can use the `lmt_collect_troubleshooting_data` playbook to collect data such as logs or raw scan data for troubleshooting purposes.
- Keep your environment up to date and upgrade the scanner to the latest version by using the `lmt_install_or_upgrade_scanner` playbook after you upgrade the License Metric Tool server.

For detailed list of all playbooks with description and information which parameters are relevant for them, see: [Playbooks](doc_playbooks_list.md).
6 changes: 3 additions & 3 deletions docs/doc_schedule_collection.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 3. Schedule daily collection of scan results
After you install and configure the disconnetced scanner, schedule daily collection of scan results to ensure fresheness of data that is available in License Metric Tool.
After you install and configure the disconnetced scanner, schedule daily collection of scan results to ensure freshness of data that is available in License Metric Tool.

<br>

Expand All @@ -10,9 +10,9 @@ After you install and configure the disconnetced scanner, schedule daily collect

- **\[Windows\]** Ensure that the following requirements are met.
- The user has the `List folder contents`, `Read` and `Write` privileges in the directory with scan results packages (the `lmt_scanner_output_path_windows` directory). To verify that the user has the right privileges, select the user, open the `Advanced Security Settings` tab and click `View`.
- The directory with scan result packages (the `lmt_scanner_output_path_windows` directory) has inheritance enabled. To enable inheritance, open the `Advanced Security Settings` tab, and click `Enable inheritance`. The inheritance should apply to `This folder, subfolder and files`.
- The directory with scan results packages (the `lmt_scanner_output_path_windows` directory) has inheritance enabled. To enable inheritance, open the `Advanced Security Settings` tab, and click `Enable inheritance`. The inheritance should apply to `This folder, subfolders and files`.

2. To run the playbook that collects scan results daily, issue the following command:
2. To run the playbook that collects scan results, issue the following command:

`ansible-playbook lmt_collect_results.yml -i lmt_inventory.yml`

Expand Down
2 changes: 1 addition & 1 deletion docs/doc_updating_lmt_playbooks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Updating playbooks

To update License Metric Tool playboks, keep your current invetory file. Then, download the latest version of playbooks from the Github repository.
To update License Metric Tool playbooks, keep your current invetory file. Then, download the latest version of playbooks from the Github repository.

<br>

Expand Down
Loading

0 comments on commit a5edbbc

Please sign in to comment.