Running Prerequisite Scanner manually

You can run Prerequisite Scanner manually from the command line and enter the relevant input parameters for the script.

Before you begin

Prerequisite Scanner uses a multicharacter code, Product_Code, to identify the integration services for which to run the scan. The JazzSM_Image_Home/PrereqScanner/codename.cfg file contains the name value pairs to represent the product code for the integration service. This table outlines the product codes for the integration services.
Table 1. Product codes for integration services
Integration service Product code
Dashboard Application Services Hub DSH
Tivoli® Common Reporting TCR
Common Jazz® for Service Management requirements, for example, temp directory disk space or libraries for Installation Manager.
Remember: Specify the product code for the common requirements in addition to one or more product codes for the integration services.
ODP

About this task

Prerequisite Scanner uses environment variables to indicate which set of prerequisite properties to check for based on the integration service’s component being installed the target system, or whether it is a fresh installation or an update to an existing environment.

Table 2. Prerequisite Scanner environment variables for Jazz for Service Management
Integration service Scenario Environment variable
All integration services in Jazz for Service Management Version 1.1.0.2 Fresh installation or update existing installation JazzSM_FreshInstall

Procedure

  1. On each target machine, open the command window and change to the JazzSM_Image_Home/PrereqScanner directory.
  2. Set the value for the JazzSM_FreshInstall environment variable; for example to scan an existing Jazz for Service Management before applying Fix Pack 2:
    • Linux operating systemAIX operating systemsLinux on System z operating systemsexport JazzSM_FreshInstall=False
    • Windows operating systemsset JazzSM_FreshInstall=False
  3. Run the Prerequisite Scanner script file, prereq_checker, as follows:
    prereq_checker.bat|sh 
    "Product_Code [Product_Version][,Product_CodeN [Product_VerN]]..." 
    [detail] [xmlResult] [outputDir="ips_output_dir"]
    "Product_Code [Product_Version][,Product_CodeN] Product_VersionN]]"
    Specify at least one required Product_Code parameter to identify the integration service for which to run the scan and the associated configuration file, as specified in Table 1.
    Only specify the Product_Version parameter, which is associated with the Product_Code parameter, when you want to scan the target environment for an earlier version of the integration service. The Product_Version parameter is the 8-digit code to represent the version, release, modification, and level, with two digits for each part of the code; for example, 3.1.3.0 is 03010300.
    When you want to scan the environment for multiple integration services, specify the associated Product_Code parameters each separated by a comma.
    Important: When you set more than one Product_Code parameter with the optional Product_Version parameter, enclose the parameters in quotation marks. If you do not, the scan fails.
    detail
    Specify this optional parameter to display detailed results of the scan in the command window.
    Important: Do not enclose this parameter in quotation marks.
    Prerequisite Scanner also saves these results to the ips_output_dir/result.txt file. It saves the results to the text file regardless of whether you set the detail parameter.
    outputDir="ips_output_dir"
    Specify this optional parameter when you want to specify the output directory for the result.txt, result.xml, and precheck.log files. If you do not set this parameter, the default output location is JazzSM_Image_Home/PrereqScanner directory.
    You must use the parameter to specify a location, if you choose to run Prerequisite Scanner from a CD, DVD, or read-only network drive. You must have write permissions to write to the ips_output_dir directory; otherwise, Prerequisite Scanner fails.
    Important: If the output directory does not exist, or Prerequisite Scanner creates the directory. You must have write permissions to create or write to the output directory in which or Prerequisite Scanner saves the files.
    xmlResult
    Specify this optional parameter when you want to output the results to the ips_output_dir/result.XML file.

Results

Possible results from running Prerequisite Scanner in the target environment are as follows:

Fail

If the target environment does not meet any of the prerequisite checks, Prerequisite Scanner returns an overall FAIL result for the environment. The tool displays the scan results for the individual prerequisite properties in the command window.

If Prerequisite Scanner returns this result, take the appropriate actions; for example, install the missing operating system packages, increase disk space for the file systems, or modify the configuration settings of the target environment to match the expected values in the scan results.

Pass

If the target environment meets all prerequisite checks, Prerequisite Scanner returns an overall PASS result for the environment.

If Prerequisite Scanner returns this result, you can install Jazz for Service Management.

Example

The following example runs Prerequisite Scanner to check for Tivoli Common Reporting Version 3.1.3.0 requirements and common Jazz for Service Management requirements. Linux operating systemAIX operating systemsLinux on System z operating systems
./prereq_checker.sh 
"ODP,TCR" detail xmlResult outputDir="$HOME/prslogs"
Windows operating systems
./prereq_checker.sh 
"ODP,TCR" detail xmlResult outputDir="%USERPROFILE%\prslogs"