Running software scans and gathering scan results (disconnected scenario)

9.2.5 Available from 9.2.5.

The scanner contains a script that collects results of software scans, the capacity scan, and the computer.yml file. It compresses these results into a single package that you need to import to License Metric Tool.

Before you begin

  • Follow this procedure in the following scenarios.
    • On IBM i, regardless of the application update that you are using.
    • On UNIX and Windows if you are using application update earlier than 9.2.24 or if you disabled automatic schedule of software scan during the installation of the disconnected scanner. Starting from application update 9.2.24, if you do not change the default setup, regular software scans are scheduled automatically during the scanner installation. The software scan is automatically scheduled to run weekly by default.
  • This procedure describes how to perform a single software scan and gather scan results once. To comply with the requirements of subcapacity licensing, the software scan needs to be scheduled to run periodically. If you need to run the software scan with different schedule than it is possible to be configured with automatic schedule or if the automatic schedule is not available, make sure the scans are manually scheduled to be run.
  • To perform this task, you must have the following privileges.
    • IBMi *ALLOBJ authority
    • UNIX root
    • Windows administrative privileges with elevation

About this task

Procedure

  1. Go to the directory where you uploaded the disconnected scanner package.
  2. To initiate the software scan, and pack software and capacity scan results, run the following script. The script performs the actions once. Use a method that is available on the particular operating system to schedule the action to run with the required frequency. For information about default and minimal scan frequency, see: Frequency of scans and uploads of data.
    • IBMi SBMJOB JOB(BFI_PKG) CMD(QSH CMD('/cit/run_sw_and_pack.sh'))
    • UNIX run_sw_and_pack.sh
    • Windows run_sw_and_pack.bat
    9.2.20 Starting from application update 9.2.20, you can run the software scan and pack scan results independently.
    • To run the software scan without creating the package with scan results, run the following script.
      • IBMi SBMJOB JOB(BFI_PKG) CMD(QSH CMD('/cit/automation/run_sw.sh'))
      • UNIX /automation/run_sw.sh
      • Windows \automation\run_sw.bat
    • To pack scan results, run the following script.
      • IBMi SBMJOB JOB(BFI_PKG) CMD(QSH CMD('/cit/automation/pack_results.sh'))
      • UNIX /automation/pack_results.sh
      • Windows \automation\pack_results.bat
      The script packs results of the software scan and capacity scan generated since the last time the package with scan results was created. On Linux and Windows, the script also packs results generated by the disconnected VM Manager Tool if it is installed. If no new scan results are available, the generated package contains only the computer.yml and scanner_status.yml file.
    Tip: 9.2.21 If the software scan fails, check the scanner_status.yml file. For more information, see: Content of the scanner_status.yml file (disconnected scenario).
  3. IBMi To monitor the progress of the scan, check the following files that are created during the scan in the directory where you installed the disconnected scanner, or monitor the scanner logs. For more information, see: Monitoring progress of disconnected scans on IBM i (disconnected scenario).
    • Starting from application update 9.2.21:
      • run_sw_console_std.log
      • pack_results_std.log
    • For application update 9.2.20 and lower: run_sw_and_pack_std.log

Results

A compressed package with scan results is created in the package output directory. By default:
  • IBMi /cit
  • UNIX Windows ./output
Names of results packages use the following naming convention.
  • IBMi Windows <YYYYMMDDHHMM>-<endpoint_ID>.zip
  • UNIX <YYYYMMDDHHMM>-<endpoint_ID>.tar.gz
Important: Do not change names of results packages. Otherwise, they will not be imported to License Metric Tool.

What to do next

Set up daily transfer of scan results to the License Metric Tool server.