1. Manuals
  2. Brands
  3. IBM Manuals
  4. Scanner
  5. Prerequisite Scanner
  6. User manual

IBM Prerequisite Scanner User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Prerequisite Scanner
Version 1.1.1.10
User's Guide

Advertisement

Table of Contents
loading

Related Manuals for IBM Prerequisite Scanner

Summary of Contents for IBM Prerequisite Scanner

  • Page 1 Prerequisite Scanner Version 1.1.1.10 User's Guide...
  • Page 3 Prerequisite Scanner Version 1.1.1.10 User's Guide...
  • Page 4 Before using this information and the product it supports, read the information in “Notices” on page 151. This edition applies to Version 1.1.1.10 of IBM Prerequisite Scanner and to all subsequent releases and modifications until otherwise indicated in new editions.

  • Page 5: Table Of Contents

    UNIX network data properties . 105 Scanner ....39 Before you run Prerequisite Scanner . . 39 Appendix D. Predefined collectors for Required checks and extension tasks for UNIX systems .
  • Page 6 . . 138 mes4Path1() . . 138 Index ....157 findOSInfo() . . 139 telnetNFS() . . 139 NFScheck() . . 140 Prerequisite Scanner: User's Guide...

  • Page 7: Figures

    . 70 result.txt file on Windows systems . . 30 prs.trc file on UNIX systems . . 71 result.txt file on UNIX systems . . 31 Prerequisite Scanner architecture and scanning process . . 32 © Copyright IBM Corp. 2009, 2012...
  • Page 8 Prerequisite Scanner: User's Guide...

  • Page 9: Tables

    . 141 properties . . 83 Common functions in TAD722_impl.sh Common data prerequisite properties . . 84 Parent functions calling versionCompare Autonomic Deployment Engine data Logging utility functions on UNIX systems properties . . 88 © Copyright IBM Corp. 2009, 2012...
  • Page 10 Prerequisite Scanner: User's Guide...

  • Page 11: Chapter 1. Prerequisite Scanner Overview

    If any of the individual checks for prerequisites fail, the overall scan fails. You can run the Prerequisite Scanner after an installation or at any time to confirm your current environment. The Prerequisite Scanner does not require that you run the installation program of the software for which you want to check prerequisites.

  • Page 12: Special Characters To Represent Types Of Ranges

    Table 4 on page 6. v qualifier_name is an optional attribute for the prerequisite property. IBM Prerequisite Scanner uses it to qualify the prerequisite property or type of check to perform on the prerequisite property. Note: You can have multiple qualifiers, each separated by a comma. The set of qualifiers must be enclosed by [] square brackets.
  • Page 13 You can add or edit predefined prerequisite properties for each product for which you want to run the Prerequisite Scanner. You can also create custom prerequisite properties and use Prerequisite Scanner collectors and evaluators as required to scan for and compare the prerequisite properties.
  • Page 14 Related concepts: “Predefined qualifiers for prerequisite properties” on page 8 IBM Prerequisite Scanner provides a set of basic qualifiers for some prerequisite properties in a predefined category. Qualifiers represent attributes of the prerequisite property that Prerequisite Scanner uses to qualify the prerequisite property or type of check to perform on that prerequisite property.

  • Page 15: Basic Prerequisite Properties Categories

    SQL Server 2008 R2 Developer Edition: mssql.Server=10.50.1600.1 Predefined subtypes for prerequisite properties IBM Prerequisite Scanner provides a set of basic subtypes for some prerequisite properties in a predefined category. Subtypes further categorize a prerequisite property such as categorization by application, utility, or service subtype.
  • Page 16 Windows Use this naming convention String to represent isService for checking whether the service_name, for example: Running. service_name service is v remoteRegistry service_name running on the machine. v DNSClient v terminalServices Prerequisite Scanner: User's Guide...

  • Page 17: Predefined Subtypes

    {str}, a regular expression with the input parameter,str, representing the search pattern for the library name, for example: regex {.*libgcc.*} Checks whether a version of the GCC low-level runtime library, libgcc, for that operating system exists. Chapter 1. Prerequisite Scanner overview...
  • Page 18 Predefined qualifiers for prerequisite properties IBM Prerequisite Scanner provides a set of basic qualifiers for some prerequisite properties in a predefined category. Qualifiers represent attributes of the prerequisite property that Prerequisite Scanner uses to qualify the prerequisite property or type of check to perform on that prerequisite property.
  • Page 19 IBM Prerequisite Scanner uses to qualify the prerequisite property or type of check to perform on the prerequisite property. v qualifier_value is the value for the optional attribute.

  • Page 20: Predefined Qualifiers

    True|False v nosuid attribute, to determine whether the mount option is set if For example, to check whether /home the file system is mounted directory is mounted and the nosuid option is not set: os.mountcheck=[drive:/home, nosuid:false]True Prerequisite Scanner: User's Guide...
  • Page 21 ALL, checks all limits v corefilesizelimit v datasegmentlimit v filedescriptorlimit v filesizelimit v hardlimit v processlimit v maxmemorysizelimit v maxprocesseslimit v stacksizelimit v threadlimit Common category without predefined subtype Chapter 1. Prerequisite Scanner overview...

  • Page 22: Product Codes

    COK=Tivoli Provisioning Manager for HP-UX COX=Tivoli Provisioning Manager for Windows 2008 When you run the Prerequisite Scanner, you pass the product code and optionally the product version as input parameters. The Scanner automatically detects the operating system of the machine. It then checks the operating system against the operating system listed for that product code in the codename.cfg file.

  • Page 23: Prerequisite Scanner Configuration Files

    The IBM Prerequisite Scanner configuration files for individual platforms contain the prerequisite properties and their expected values for each platform that is supported by the product. Prerequisite Scanner provides a predefined set of configuration files that you can edit. You must create configuration files for new products and platforms to be supported.

  • Page 24: Unix Systems

    For example, to exclude Windows Server 2003 R2 variant, the combination of section titles is: [OSType:Windows Server 2003][!OSType:Windows Server 2003 R2] Table 6 on page 15 outlines the supported data type categories and associated allowed values. Prerequisite Scanner: User's Guide...

  • Page 25: Supported Data Type Categories And Values

    Indicates that all properties in this category are common to all SUSE Linux Enterprise Server operating system variants, for example: [OSType:SUSELinuxEnterpriseServer] v Solaris Indicates that all properties in this category are common to all Solaris operating system variants, for example: [OSType:Solaris] Chapter 1. Prerequisite Scanner overview...
  • Page 26 Windows Server 2003 R2 (Version 5.2.* and other type of OS description is R2) Indicates that all properties in this category are common to the Windows Server 2003 R2 operating system variant only, for example: [OSType:Windows Server 2003 R2] Prerequisite Scanner: User's Guide...
  • Page 27 This example uses sections to categorize prerequisite properties for any Windows machine and then machines running specific versions of Windows. #Properties for all Windows operating systems, that is, Windows XP and above [OSType:Windows] os.versionNumber=5.1+ network.pingSelf=True network.pingLocalhost=True network.availablePorts.Derby=4130 env.CIT.homeExists=True env.classpath.derbyJAR=False # Disk space properties commonPath=10MB installPath=200MB Chapter 1. Prerequisite Scanner overview...

  • Page 28: Scanned Sections Of A Configuration File For Windows

    [OSType:Windows Vista] os.servicePack=2+ When you run Prerequisite Scanner, it scans and checks for different prerequisite properties depending upon the operating system and version that is installed on the machine. For example, Table 7 outlines the different sections containing the prerequisite properties that are checked based on the example.

  • Page 29: Scanned Sections Of A Configuration File For Unix

    # are set to ’True’ [OSType:AIX5.3.0.0][@TPAE_DB_FEATURE:True|@TPAE_DIR_FEATURE:True] os.lib.xlC.aix50.rte=xlC.aix50.rte.9.0.0.8+ When you run Prerequisite Scanner, it scans and checks for different prerequisite properties depending upon the operating system and version that is installed on the machine. For example, Table 7 on page 18 outlines the different sections containing the prerequisite properties that are checked based on the example.

  • Page 30: Prerequisite Scanner Collectors

    When you run the Prerequisite Scanner, it runs the collectors in the following order: predefined VBScript collectors; the custom common VBScript collectors in the ips_root/lib directory; and the custom product-specific VBScript collectors by searching for the product_code[_<version>].vbs file in the ips_root/Windows directory.
  • Page 31 Each collector, predefined or custom, is called in the ips_root/UNIX_Linux/packageTest.sh file. When you run the Prerequisite Scanner, it runs the collectors in the following order: predefined collectors with _plug in the file name in the ips_root/lib directory; predefined collectors in the ips_root/UNIX_Linux directory; and the custom UNIX collectors in the ips_root/UNIX_Linux directory.

  • Page 32: Prerequisite Scanner Evaluators

    "\`wrlTrace "Done" "installedSoftware.TCR.version"\`" >>/tmp/prs.check Prerequisite Scanner evaluators IBM Prerequisite Scanner evaluators are scripts that compare the actual data from the collectors and the expected data for the same properties that are in the configuration files. Evaluations can be: platform-specific; based on simple operators, such as, less than, equal to, or greater than;...

  • Page 33: Output Formats

    Prerequisite Scanner saves the scan results and log files to the ips_output_dir directory. You can set this directory by using the outputDir input parameter when you run the Scanner.
  • Page 34 Command-line interface output When you run the Prerequisite Scanner script and set the optional detail parameter, Prerequisite Scanner displays detailed results of the scan in the command-line interface. The detailed results contain: v The version of Prerequisite Scanner v The version of the operating system on which the Scanner was run...

  • Page 35: Output To The Command-Line Interface On

    Figure 1. Output to the command-line interface on Windows systems If you do not set the detail parameter, the Scanner displays only the PASS or FAIL result on the screen. Chapter 1. Prerequisite Scanner overview...

  • Page 36: Output To The Command-Line Interface On

    These return codes are written to the log files. For example, if the Prerequisite Scanner fails to run the scan because cannot read the configuration file, it generates return code of 2.

  • Page 37: Precheck.log File

    Figure 3. precheck.log file Trace and debugging log file output on UNIX systems When you run the Prerequisite Scanner script and set the optional debug parameter, Prerequisite Scanner outputs detailed processing information, warning and error messages, and the scan results in the ips_output_dir/temp/prs.debug file.

  • Page 38: Prs.debug File On Unix Systems

    Figure 4. prs.debug file on UNIX systems When you run the Prerequisite Scanner script and set the optional trace parameter, Prerequisite Scanner outputs trace information in the ips_output_dirtemp/prs.trc file. Prerequisite Scanner: User's Guide...

  • Page 39: Prs.trc File On Unix Systems

    Figure 5. prs.trc file on UNIX systems Text file output Prerequisite Scanner outputs detailed scan results in the ips_output_dir/result.txt file. It saves the results to the text file regardless of whether you set the detail parameter. Chapter 1. Prerequisite Scanner overview...

  • Page 40: Result.txt File On Windows Systems

    Figure 6. result.txt file on Windows systems Prerequisite Scanner: User's Guide...

  • Page 41: Scanning Process

    Scanner. Scanning process When you run IBM Prerequisite Scanner, it performs a set of tasks in each stage of the scanning process. The user opens a command-line interface and runs the Prerequisite Scanner script with the set of input parameters including a product code.

  • Page 42: Prerequisite Scanner Architecture And Scanning Process

    Figure 8. Prerequisite Scanner architecture and scanning process The scanning process in Figure 8 is summarized as follows: 1. Prerequisite Scanner verifies the format of the input parameters that are passed to the Scanner. 2. The Scanner determines whether the product code that is passed as one of the input parameters is a valid product code in the codename.cfg file.

  • Page 43: New In This Release

    Scanner uses the latest version of the configuration file that it finds in the ips_root/Windows|UNIX_Linux directory. If the platform is not supported, Prerequisite Scanner exits and displays a message to state that the platform is not supported. 5. The Scanner collects the actual prerequisite properties for the prerequisite checks by using the Prerequisite Scanner collectors.

  • Page 44: Defects Fixed In This Release

    Prerequisite Scanner script in Prerequisite Scanner Version 1.1.1.10. You can use it to specify the directory that will contain the scan results and log files when you run the Scanner, as specified by ips_output_dir. If you do not set this parameter, the default output location is ips_root.
  • Page 45 See “Operating system data properties” on page 93. 24793 On UNIX platforms only: Prerequisite Scanner incorrectly displays 0 MB in the Expected Result value for os.space.dir_name or Memory prerequisite properties in the TOTAL ALL SPECIFIED COMPONENTS section of the output, even if these prerequisite properties do not exist in the configuration file.
  • Page 46 Prerequisite Scanner: User's Guide...

  • Page 47: Chapter 2. Installing Prerequisite Scanner

    Chapter 2. Installing Prerequisite Scanner There is no installation program for IBM Prerequisite Scanner. When you extract the contents of the compressed file, the core files are in the root directory, with the following subdirectories: /lib for the collectors and common scripts; /Windows for the evaluators and configuration files on Windows;...

  • Page 48: Installing The Compressed File

    You must have write permissions to the root directory in which you extract the contents of the compressed file. Procedure 1. Open your web browser and enter the URL to IBM Fix Central. Ensure that you sign into IBM.com or IBM Support Portal. 2. From the Product Group list, select Tivoli.

  • Page 49: Chapter 3. Extending Prerequisite Scanner

    Required checks and extension tasks for Windows systems You should perform a set of checks and tasks before you run the IBM Prerequisite Scanner. These checks determine whether you can edit and use existing configuration files or you must extend Prerequisite Scanner.

  • Page 50: Required Checks And Extension Tasks For Unix Systems

    Required checks and extension tasks for UNIX systems You should perform a set of prerequisite checks and tasks before you run the IBM Prerequisite Scanner. These checks determine whether you can edit and use existing configuration files or you must extend Prerequisite Scanner.

  • Page 51: Adding Product Codes

    Adding product codes IBM Prerequisite Scanner provides a set of predefined product version codes in the codename.cfg file. You can add product codes if the file does not contain them for the product version, its supported platforms, and versions of the operating systems.
  • Page 52 Important: You must adhere to the naming conventions and formatting rules that govern the creation and editing of a custom configuration file. If you do not, Prerequisite Scanner cannot successfully run a scan by using this file. Procedure 1. If necessary add product codes for the product to the codename.cfg file.

  • Page 53: Adding Prerequisite Properties

    Table 4 on page 6. v qualifier_name is an optional attribute for the prerequisite property. IBM Prerequisite Scanner uses it to qualify the prerequisite property or type of check to perform on the prerequisite property, as outlined in “Predefined qualifiers for prerequisite properties”...
  • Page 54 Table 4 on page 6. v qualifier_name is an optional attribute for the prerequisite property. IBM Prerequisite Scanner uses it to qualify the prerequisite property or type of check to perform on the prerequisite property, as outlined in “Predefined qualifiers for prerequisite properties”...

  • Page 55: Editing Prerequisite Properties

    You might want to check another limit such as the stack size. Change the following qualifier's value for the prerequisite property from: os.ulimit=[type:filedescriptorlimit]8192+,unlimited os.ulimit=[type:stacksizelimit]512+,unlimited Important: You can use the predefined qualifiers only with specific predefined prerequisite properties, as outlined in Table 5 on page 9. Chapter 3. Extending Prerequisite Scanner...

  • Page 56: Creating Custom Collectors For Windows Systems

    [prefix_identifier.]property_name.vbs where: prefix_identifier is the prefix identifier for a predefined category of prerequisite properties as outlined in Table 3 on page 4. v property_name is the prerequisite property name and is used in the collector name. Prerequisite Scanner: User's Guide...
  • Page 57 3. Run the VBScript collector to ensure that there are no runtime errors and debug as necessary. 4. Create a custom evaluator only if the standard compare functions cannot compare the actual and expected values. Chapter 3. Extending Prerequisite Scanner...

  • Page 58: Creating Custom Vbscript Collectors Specific To A Product And Product Version

    3. If you must use the values of the PATH and -p flag passed from the Prerequisite Scanner, then use Wscript.Arguments() where Wscript.Arguments(0) is the value for PATH. Wscript.Arguments(1) is the -p flag and its values. Prerequisite Scanner: User's Guide...
  • Page 59 CMD_LINE_ARGS= :setArgs if ""%1""=="""" goto doneSetArgs set CMD_LINE_ARGS=%CMD_LINE_ARGS% %1 shift goto setArgs :doneSetArgs cscript.exe //nologo collector_file_name.vbs %CMD_LINE_ARGS% 7. Create a custom evaluator only if the standard compare functions cannot compare the actual and expected values. Chapter 3. Extending Prerequisite Scanner...

  • Page 60: Creating Custom Collectors For Unix Systems

    2. Using an editor, open the file and include the path to the common_function.sh if you must use common functions, as follows: . ../lib/common_function.sh Prerequisite Scanner: User's Guide...

  • Page 61: Editing The Package Test Script For Unix Systems

    PATH variable, and then searches its value for the JRE path. envJRE=`env | grep "PATH" | grep -w "/opt/IBM/Java60/jre/bin"` 4. Ensure the check returns standard output: echo "True"|"False" ’If the scan checks for the existence of the prerequisite property echo $res ’If the scan checks returns the value, for example, product version,...
  • Page 62 "echo \"[prefix_identifier.]property_name [.suffix_identifier]=\$ss\"" >>/tmp/prs.check echo "\`wrlDebug "Finished" "[prefix_identifier.]property_name [.suffix_identifier]"\`" >>/tmp/prs.check echo "\`wrlDebug "OutPutValueIs" \$ss\`" >/tmp/prs.check echo "\`wrlTrace "Done" "[prefix_identifier.]property_name [.suffix_identifier]"\`" >>/tmp/prs.check In the example: echo "ss=\`./env.path.jar\`" >>/tmp/prs.check echo "\`wrlTrace "Finished" "env.path.jar"\`" >>/tmp/prs.check echo "echo \"env.path.jar=\$ss\"" >>/tmp/prs.check Prerequisite Scanner: User's Guide...

  • Page 63: Creating Custom Evaluators For Windows Systems

    "FAIL" when the expected value for the prerequisite property does not equal the actual value for the prerequisite property 3. Run the custom evaluator to ensure that there are no runtime errors and debug as necessary. Chapter 3. Extending Prerequisite Scanner...
  • Page 64 ’ as if there was a zero there. If any non-numeric characters are ’ included in a version part, those corresponding parts will be compared ’ asstrings and not parsed into numeric form ’ ’ Returns ’ 1 version1 > version2 Prerequisite Scanner: User's Guide...
  • Page 65 = v1Size to v2Size ver1Parts(i) = "*" next end if end if Dim i i = 0 Do While (i&#60;=ubound(ver1Parts) or i&#60;=ubound(ver2Parts)) Dim v1, v2, v1Str, v2Str v1Str = UNASSIGNED v2Str = UNASSIGNED Chapter 3. Extending Prerequisite Scanner...
  • Page 66 (v2 > v1) Then versionCompare = -1 exit function end if end if i = i + 1 Loop ’ If we got here, versions must be equal versionCompare = 0 end function Prerequisite Scanner: User's Guide...

  • Page 67: Creating Custom Evaluators For Unix Systems

    There are two script files that you can use as a starting point, that is, ._compare.sh and _compare.sh in the /Unix_Linux subdirectory. Important: Do not create custom evaluators if your custom collectors return True or False. IBM Prerequisite Scanner uses predefined evaluators for any collector that returns boolean values. Procedure 1.
  • Page 68 Prerequisite Scanner: User's Guide...

  • Page 69: Chapter 4. Running Prerequisite Scanner

    Chapter 4. Running Prerequisite Scanner You can use a command-line interface to run the IBM Prerequisite Scanner. The Prerequisite Scanner script, prereq_checker, takes a set of required and optional parameters and a command flag for additional optional parameters. Table 14 explains the special characters that are used in the syntax of the Prerequisite Scanner script.
  • Page 70 ./prereq_checker.sh KMS If you set a Product_Code parameter that does not have a corresponding configuration file, the Prerequisite Scanner ignores it without error. The log file contains a message that no configuration file was found. The Product_Version parameter for the associated Product_Code parameter indicates the version of the product.
  • Page 71 PASS or FAIL result, the actual value, and expected value v The overall PASS or FAIL result 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.

  • Page 72: Running The Script And Setting The Detail Parameter On Unix Systems

    Figure 9. Running the script and setting the detail parameter on UNIX systems If you do not set the detail parameter, the Scanner displays only the PASS or FAIL result in the command-line interface. Prerequisite Scanner: User's Guide...

  • Page 73: Running The Script Without Setting The Detail

    This optional parameter indicates that you want to set the output directory for the scan results and log files for Prerequisite Scanner. When you run the Prerequisite Scanner script and set the optional outputDir parameter, Prerequisite Scanner outputs the results text and log files to the directory specified by the parameter’s value.

  • Page 74: Running Prerequisite Scanner From The Command Line

    This optional parameter indicates that you want to turn on debugging while running the Prerequisite Scanner. When you run the Prerequisite Scanner script and set the optional debug parameter, Prerequisite Scanner outputs detailed processing information, warning and error messages, and the scan results in the log file. It is the ips_output_dir/prs.debug file on UNIX systems and the ips_output_dir/precheck.log file on Windows systems.
  • Page 75 Important: You must use the outputDir 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 ips_output_dir; otherwise, Prerequisite Scanner fails.

  • Page 76: Common Directory Locations

    Prerequisite Scanner output directory ips_output_dir describes the location where the scan results and log files for Prerequisite Scanner are saved. This location can be specified by using the outputDir input parameter when you run the Scanner. If you do not set this parameter, the default output location is ips_root.

  • Page 77: Chapter 5. Troubleshooting Prerequisite Scanner

    2. Troubleshooting on Windows systems When you run IBM Prerequisite Scanner, it creates a log file by default. It contains detailed information with each step and function that the Scanner performs in sequence.

  • Page 78: Precheck.log File With The Debug Data

    Figure 11. precheck.log file with the debug data Prerequisite Scanner: User's Guide...

  • Page 79: Troubleshooting On Unix Systems

    Debugging log file When you run the Prerequisite Scanner script and set the optional debug parameter, Prerequisite Scanner outputs detailed processing information, warning and error messages, and the scan results in the ips_output_dir/temp/prs.debug file. It contains detailed information with each step and function that the Scanner performs in sequence.

  • Page 80: Prs.debug File On Unix Systems

    Figure 13. prs.debug file on UNIX systems Trace log file When you run the Prerequisite Scanner script and set the optional trace parameter, Prerequisite Scanner outputs trace information in the ips_output_dir/temp/prs.trc file. It contains information with each function that the Scanner performs in sequence.

  • Page 81: Execution Problems

    ERROR: Cannot create files in output directory ips_output_dir. Exit. Before you run Prerequisite Scanner, ensure that disk to which you want to run Prerequisite Scanner and save the results to the output directory is not full;...

  • Page 82: Return Codes

    Prerequisite Scanner generates returns codes dependent on the results of the scan and whether it must exit because of errors. These return codes are written to the log files. Prerequisite Scanner generates return codes based on a set of defined outcomes as follows: Return code...

  • Page 83: Other Errors

    The collector’s script file did not execute correctly. Other errors Prerequisite Scanner can exit, because the user does not have write permission to the ips_output_dir output directory. Related concepts: IBM Prerequisite Scanner produces output for the following screen and human-readable file formats: output to the command-line interface, debugging and trace log files, and a simple text file for the results.
  • Page 84 Prerequisite Scanner: User's Guide...

  • Page 85: Appendix A. Product Codes Reference

    Restriction: IBM Tivoli Monitoring and Tivoli Composite Application Manager have predefined product codes that Prerequisite Scanner considers as reserved. These codes must not be used as Prerequisite Scanner product codes unless they refer to their associated IBM Tivoli Monitoring and Tivoli Composite Application Manager agents.

  • Page 86: Predefined Product Codes

    Tivoli Composite Application Manager (ITCAM) for Transactions: Internet Service Monitoring UNIX Tivoli Monitoring Operating System Agent for Linux Windows IBM Tivoli Composite Application Manager Agent for WebSphere MQ File Transfer Edition Windows Tivoli Enterprise Monitoring Server UNIX Tivoli Enterprise Monitoring Server for UNIX...
  • Page 87 Table 16. Predefined product codes (continued) Predefined product code Platform Product version, platform, operating system Tivoli Netcool/OMNIbus desktop component Tivoli Netcool/OMNIbus server components Tivoli Process Automation Engine Windows Tivoli Asset Discovery for Distributed UNIX Tivoli Asset Discovery for Distributed for UNIX Tivoli Common Reporting Tivoli Provisioning Manager Appendix A.
  • Page 88 Prerequisite Scanner: User's Guide...

  • Page 89: Appendix B. Configuration Files Reference

    Appendix B. Configuration files reference The IBM Prerequisite Scanner provides a predefined set of configuration files that you can edit. These files are in either ips_root/UNIX_Linux or ips_root/Windows. The files have a.cfg extension. Table 17 lists the currently supported predefined configuration files.
  • Page 90 Tivoli Composite Application Manager (ITCAM) for Transactions: Web Response Time Version 7.3 KT6_07300000.cfg Tivoli Composite Application Manager (ITCAM) for Transactions: Robotic Response Time Version 7.3 KUD_06100000.cfg Windows Tivoli Monitoring Agent for DB2 Version 6.1 KUD_06200000.cfg Tivoli Monitoring Agent for DB2 Version 6.2 Prerequisite Scanner: User's Guide...
  • Page 91 Table 17. Predefined configuration files (continued) Configuration file Platform Product version, platform, operating system KUD_06210000.cfg Tivoli Monitoring Agent for DB2 Version 6.2.1 KUD_06220000.cfg Tivoli Monitoring Agent for DB2 Version 6.2.2 KZE_06020300.cfg Tivoli zEnterprise Monitoring Agent Version 6.2.3 LCM_01000000.cfg Tivoli License Compliance Manager Version 1.0 LCM_02300000.cfg Tivoli License Compliance Manager Version 2.3 NCI_06100000.cfg...
  • Page 92 Prerequisite Scanner: User's Guide...

  • Page 93: Appendix C. Prerequisite Properties Reference

    NetBIOS and DHCP are enabled on the machine, and pinging properties. Internet The Microsoft Internet Explorer data “Internet Explorer data internetExplorer Explorer properties check Internet Explorer properties” on page 90 prerequisites such as the version. © Copyright IBM Corp. 2009, 2012...

  • Page 94: Common Data Properties

    Common data properties The common data properties check common prerequisites such as CPU speed, RAM, disk, and temporary space. For Windows systems, it uses the primary IBM Prerequisite Scanner script. For UNIX systems, it uses the primary Prerequisite Scanner script and the common collector, ips_root/Unix_Linux/common.sh.
  • Page 95 Table 19. Common data prerequisite properties (continued) Prerequisite property Platforms Description Valid values DBType Checks the types of database server The value can be any of the following installed on the machine. types: v String representing any type of the For Oracle on UNIX systems only: The database server, for example: collector expects the ORACLE_BASE and...
  • Page 96 Numeric format in GBs or MBs, for that is currently available on the machine example: Note: You can separately check for the 300MB amount of physical and virtual memory available by the using predefined prerequisite properties in the operating system category. Prerequisite Scanner: User's Guide...
  • Page 97 Table 19. Common data prerequisite properties (continued) Prerequisite property Platforms Description Valid values OS Version The full name and version of the The value can be any of the following operating system that is running on the types: machine; alternatively, you can use a v String that can represent multiple regular expression to pass a string that versions, with each version separated...

  • Page 98: Autonomic Deployment Engine Data Properties

    Table 20 outlines the prerequisite properties. This category of prerequisite properties require the de prefix identifier. Table 20. Autonomic Deployment Engine data properties Prerequisite property Platform Description Valid values de.installed Checks whether the is Boolean, for example: installed true|false Prerequisite Scanner: User's Guide...

  • Page 99: Connectivity Data Properties

    Telnet is running and to which IP addresses and ports the Scanner can connect. For Windows systems, it uses the connectivity collector, ips_root/lib/ connectivity_plug.vbs. For UNIX systems, it uses the primary IBM Prerequisite Scanner script and the connectivity collector, prs_root/Unix_Linux/ connectivity_plug.sh.

  • Page 100: Ms Sql Server Data Properties

    The Microsoft Internet Explorer data properties check Internet Explorer prerequisites such as the version. It uses the Internet Explorer collector, ips_root/lib/internetExplorer_plug.vbs. Table 23 on page 91 outlines the Internet Explorer prerequisite properties. This category of prerequisite properties require the internetExplorer prefix identifier. Prerequisite Scanner: User's Guide...

  • Page 101: Network Data Properties

    Table 23. Internet Explorer data properties Prerequisite property Description Valid values internetExplorer. The version of the Internet Numeric format, for example, 7.0+ version Explorer installed on the Note: The values can use the special machine characters as outlined in Table 1 on page 2.

  • Page 102: Oracle Data Properties

    Expected string value can be is currently installed on the machine multiple versions, separated by a comma, for example: 10.2.0.4g,11g R1 Note: The values can use the special characters as outlined in Table 1 on page 2. Prerequisite Scanner: User's Guide...

  • Page 103: Operating System Data Properties

    Table 25. Oracle data properties (continued) Prerequisite property Platform Description Valid values oracle.Server.Location Checks the home directory of the String, for example: Oracle database server /opt/oracle/product/10.1.0/Db_1 Operating system data properties The operating system data properties check operating system prerequisites such as version, architecture, total memory, available memory, and total physical memory.

  • Page 104: Operating System Data Properties

    I/O operation performance; returns Available if it has an available status os.is8dot3File Windows Checks whether 8.3 file name formats Boolean value, for example: FormatEnabled are being automatically applied; True returns True if they are applied Prerequisite Scanner: User's Guide...
  • Page 105 Table 26. Operating system data properties (continued) Prerequisite property Platform Description Valid values os.isService Windows Use this naming convention for Boolean value, for example: Running.service_name checking whether the service_name is True running on the machine. service_name can represent for example: v remoteRegistry for the Remote Registry Service v DNSClient for the DNS Client...
  • Page 106 Checks for a specific version of Numeric format, for example, Mozilla Firefox on the machine unlike 3.0+ the os.Firefox prerequisite property Note: The values can use the special characters as outlined in Table 1 on page 2. Prerequisite Scanner: User's Guide...
  • Page 107 Table 26. Operating system data properties (continued) Prerequisite property Platform Description Valid values os.mountcheck UNIX Checks whether the file system is String with the following mounted based on the following qualifier format: qualification attributes: [drive:dir_name, mount_option: v drive attribute, to determine which false|true] directory is the mounted file True|False...
  • Page 108 2+ Note: The values can use the special characters as outlined in Table 1 on page 2. os.shell.default UNIX Checks whether the default shell String to represent the shell script is installed script, for example, bash Prerequisite Scanner: User's Guide...
  • Page 109 You can specify os.space.dir_name_nonroot and os.space.dir_name_root variants in the same configuration file. Prerequisite Scanner outputs NOT_REQ_CHECK_ID in the actual results cell for the non-applicable variant. For example, if the logged in user is root, Prerequisite Scanner outputs NOT_REQ_CHECK_ID for the os.space.dir_name_nonroot variant.
  • Page 110 Use a combination one qualifier: of the os.space.dir_name_nonroot [dir:<dir_path>] and os.space.dir_name_root variants. <disk_space> MB For example: os.space.home= [dir:/home/sat]250MB Numeric format in MB or GBs, for example: os.space.opt=11GB Prerequisite Scanner: User's Guide...
  • Page 111 [dir:non_root=dir_path] disk_spaceGB|MB For example: os.space.opt_nonroot= [dir:non_root=/opt/IBM/ITM] 1024MB os.space.dir_name_root UNIX Checks the available disk space for String with the following the dir_name file system of the root qualifier format for the file...
  • Page 112 The total amount of physical memory Numeric format in MBs or that the operating system can access, GBS, for example: 2030MB but it does not indicate the true amount of physical memory on the target computer Prerequisite Scanner: User's Guide...
  • Page 113 Table 26. Operating system data properties (continued) Prerequisite property Platform Description Valid values os.ulimit UNIX Checks whether an unlimited number The value can be any of the of processes can be run based on the following types: following qualification attributes: v String with the following v type attribute, to determine which qualifier format:...

  • Page 114: Installed Software Data Properties

    Description Valid values user.userID Windows The ID of the currently logged on user String, for example, smithj user.isAdmin Checks whether the logged on user is a Boolean value, for member of the Administrator group example, True Prerequisite Scanner: User's Guide...

  • Page 115: Windows Network Data Properties

    Windows network data properties The Windows network data properties check network prerequisites such as whether NetBIOS and DHCP are enabled on the machine, and pinging properties. It uses the Windows network collectors in the ips_root/lib directory, with the network prefix identifier in their file names. . Table 29 outlines the network prerequisite properties that are common across all Windows platforms.
  • Page 116 Prerequisite Scanner: User's Guide...

  • Page 117: Appendix D. Predefined Collectors For Unix Systems

    For example, to check whether the v home dir_name directory, that is, the home directory has drwxr-xr-x permissions: [dir:/home, type:permission]755+ os.diskquota os.diskquota None os.expectLink os.expectLink None © Copyright IBM Corp. 2009, 2012...

  • Page 118: Unix Collectors

    ISO code fileset for the AIX base operating system regex{str}, a regular expression with the input parameter,str, representing the search pattern for the library name, for example, .*libgcc.* os.loginVariable os.loginVariable None os.maximoDirectory os.maximoDirectory None Prerequisite Scanner: User's Guide...
  • Page 119 Table 31. UNIX collectors (continued) Collector For prerequisite property Inputs os.maximoDirOwner os.maximoDirOwner None os.maximumProcesses os.maximumProcesses None os.MozillaVersion os.MozillaVersion None os.mountcheck os.mountcheck String with the following qualifier format: [drive:dir_name, mount_option: false|true] True|False For example, to check whether /home directory is mounted and the nosuid option is not set: os.mountcheck=[drive:/home, nosuid:false]True...
  • Page 120 [dir:non_root=dir_path, unit:unit_name] disk_space For example: os.space.home= [dir:non_root=USERHOME/ .acsi_HOST, unit:MB]200 String with the following qualifier format, using only one qualifier: [dir:dir_path] disk_space MB For example: os.space.home= [dir:/home/sat]250MB os.sshdConfig os.sshdConfig None os.swapSize os.swapSize None os.tmpdir os.tmpdir None Prerequisite Scanner: User's Guide...
  • Page 121 Table 31. UNIX collectors (continued) Collector For prerequisite property Inputs os.ulimit os.ulimit String with the following qualifier format: [type:limit_name] limit_value, limited|unlimited For example, to check whether the file descriptor limit is greater than 8192, with unlimited number of processes: os.ulimit= [type:filedescriptorlimit] 8192+,unlimited Valid types of limits to check,...
  • Page 122 Prerequisite Scanner: User's Guide...

  • Page 123: Appendix E. Common Functions For Windows Systems

    Appendix E. Common functions for Windows systems Prerequisite Scanner has a set of common functions in the/lib/ common_function.vbs file for running checks on Windows systems. Table 32. Functions in common_function.vbs Function Description “allFiles()” on page 114 Reads the file names in a specified directory into an array.

  • Page 124: Allfiles()

    Input parameters String filepath The path to the directory that contains the files. Return values Array fileNames Returns the array containing the file names in the specified directory. arrayToString() Creates a string representation for the array. Prerequisite Scanner: User's Guide...

  • Page 125: Bigthan()

    Purpose This function takes the array that is passed as an input parameter and returns a string representation of the contents of that array. Syntax arrayToString(arr) Input parameters Array arr Contains the array. Return values String result Returns a string representation of the array, with each item separated by a comma.

  • Page 126: Checkitemtostring()

    Creates a string representation for the scripting dictionary object. Purpose This function takes the dictionary object that is passed as an input parameter and returns a string representation of the contents of that dictionary object. Prerequisite Scanner: User's Guide...

  • Page 127: Execommand()

    Syntax dictionaryToString(dic) Input parameters Dictionary dic Contains the dictionary object. Return values String result Returns a string representation of the dictionary object, with each key and item separated by an equals symbol. exeCommand() Executes the specified command and returns the result from that command's execution.

  • Page 128: Filterfile()

    Returns thedic dictionary object with the filtered lines from the file. findNewest() Finds the latest configuration file in an array. Purpose This function loops through the array and determines which file in the array is the latest configuration file. It returns the name of the file. Prerequisite Scanner: User's Guide...

  • Page 129: Findsuitablefile()

    Syntax findNewest(arr) Input parameters Array arr Contains the set of configuration files to check. Return values String result Returns the name of the latest configuration file. findSuitableFile() Finds the relevant configuration file for a product and version. Purpose This function calls the “getFirstMatch()” on page 121 function to get the set of files that has the extension input parameter as the file extension from the list of files returned by the “allFiles()”...

  • Page 130: Fmt()

    %0s!",array("Mr. Anderson")) returns "Hello Mr. Anderson!" formatForDisplay() Formats the input parameter to make it readable. Purpose This function calls the “formatSizeForDisplay()” on page 121 function to format the input parameter. Syntax formatForDisplay(val) Input parameters Variable val The variable to format. Prerequisite Scanner: User's Guide...

  • Page 131: Formatsizefordisplay()

    Return values String vartoString Returns the result of the called “formatSizeForDisplay()” function. formatSizeForDisplay() Takes the input parameter and appends or trims the fractional part of the input parameter to two decimal points, for example, 123MB to 123.00MB or 12.123MBs to 12.12MBs.

  • Page 132: Ismatch()

    Filters the first array to determine whether the content is in the second array. Depending upon the value of the in_or_not input parameter, the function returns the contents of first array including or excluding what matched with the second array. Prerequisite Scanner: User's Guide...

  • Page 133: Passorfail()

    Purpose Syntax notInLatter(arr1, arr2, in_or_not) Input parameters Array arr1 copy from somewhere Array arr2 to somewhere else String in_or_out Contains either "in" or "not" depending whether the function should return the contents of the first array filtered to return only the contents that matched the second array ("in") or the contents that did not match the second array ("not").

  • Page 134: Ppread()

    This function opens the file and reads each line of the file into an index entry of the array. It returns the array. Syntax readFile(fileName) Input parameters String fileName The name of the file to read into the array. Return values Array fileContents Returns the array with the contents of the file. Prerequisite Scanner: User's Guide...

  • Page 135: Unitmgtog()

    unitMGTOG() Adds together the contents of an array to obtain the total number of MBs. Purpose This function converts the value of each index in the array to MBs and adds them together. Syntax unitMGTOG(arr) Input parameters Array arr Contains the array. Return values String unitMGTOG Returns the total of the contents of the array in MBs and appends "MB"...
  • Page 136 Prerequisite Scanner: User's Guide...

  • Page 137: Appendix F. Logging Utility Sub Routines For Windows Systems

    Appendix F. Logging utility sub routines for Windows systems IBM Prerequisite Scanner has a set of common logging sub routines in the preq.vbs file for displaying messages on screen or writing to the log file. Table 34 describes the logging utilities.
  • Page 138 Prerequisite Scanner: User's Guide...

  • Page 139: Appendix G. File Utility Sub Routines For Windows Systems

    Appendix G. File utility sub routines for Windows systems Prerequisite Scanner has a set of common file sub routines in the/lib/ common_function.vbs file to handle files. It also has a set of functions for handling files. Table 35 describes the file utilities.
  • Page 140 Prerequisite Scanner: User's Guide...

  • Page 141: Appendix H. Other Common Functions And Sub Routines For Windows Systems

    Appendix H. Other common functions and sub routines for Windows systems Prerequisite Scanner has a set of other common functions and sub routines that are used in various files.. outlines the other common functions and sub routines. Table 37. Other common functions and sub routines for Windows systems...

  • Page 142: Getvalue()

    Instance of the file system object. String sKey Contains a string with the name of the prerequisite property and the equals symbol. String drvPath Contains the path for which to obtain the available disk space. Return values None Prerequisite Scanner: User's Guide...

  • Page 143: Removespecialcharacters()

    removeSpecialCharacters() Removes the trademark or other special characters to make comparisons easier. The function is in the /lib/common.vbs file. Purpose This function calls the Replace() function to replace the trademark, copyright, and registered symbols with "". Syntax removeSpecialCharacters(s) Input parameters String s Contains the string from which the characters must be removed Return values...
  • Page 144 Returns the 1 return code if the first input parameter is greater than the second input parameter. The parent function returns "PASS". Special case: Returns the 1 return code and exits if the second input parameter is empty. Prerequisite Scanner: User's Guide...

  • Page 145: Appendix I. Common Functions For Unix Systems

    Appendix I. Common functions for UNIX systems Prerequisite Scanner has a set of common functions in the/lib/common_function.sh file for running checks on UNIX-based systems. Table 41. Functions in common_function.sh Function Description “AddMG()” on page 136 Checks whether the input parameters are in MBs or GBs and adds the parameters.

  • Page 146: Addmg()

    Returns the added values in MBs or GBs. compare() Parses the input parameters that represent the actual and expected values for a prerequisite property and compares them to determine whether the first value (real) is less than the second value (expected). Prerequisite Scanner: User's Guide...

  • Page 147: Cutdown()

    Purpose This function checks first that the function receives two input parameters. If it receives them and they are not both false, it determines whether the values are in MBs or GBs and then compares the two values to check whether the first value is less than the second value.

  • Page 148: Mes4Path()

    Solaris. It next calls the df command to determine the free disk space for each mount on the system. It returns the value for the free disk space. Syntax mes4Path1 path Input parameters String $path Path to the system to check for free disk space. Prerequisite Scanner: User's Guide...

  • Page 149: Findosinfo()

    Return values Integer 1 Returns return code 1 if the function does not receive an input parameter. Integer 2 Returns return code 2 if the input parameter is not a path. String $NF Returns the free disk space for each mount. findOSInfo() Finds the operating system version, OS release level and version, and hardware implementation data for the system.

  • Page 150: Nfscheck()

    This example of its usage is from the mes4Path() function: # check if it’s a path path=`echo "$1" | sed -n ’/^\//p’` if [ -z "$path" ];then return 2; else nfs_check_status=`NFScheck $path` if [ "$nfs_check_status" = "TRUE" ]; then case `uname` in Prerequisite Scanner: User's Guide...

  • Page 151: Appendix J. Other Functions For Unix Systems

    Appendix J. Other functions for UNIX systems Prerequisite Scanner has a set of common functions in various files. Table 42 outlines the set of functions in multiple files. Table 42. Common functions in multiple files Function Description “formatSizeDisplay()” on page 142...

  • Page 152: Formatsizedisplay()

    It uses awk to parse and split each version into its parts where "." is the delimiter for splitting the value into parts. It then performs a loop to compare each part of the first version against the same part of the second version and see whether they are equal. Prerequisite Scanner: User's Guide...

  • Page 153: Parent Functions Calling Versioncompare

    Parent functions Table 44. Parent functions calling versionCompare Parent Function, Script Description db2.home_compare.sh Compares the real and expected values for the disk space for DB2 HOME prerequisite property. oracle.Client_compare.sh Compares the real and expected values for the Oracle client prerequisite property. os.locale_compare.sh Compares the real and expected values for the OS locale prerequisite property.

  • Page 154: Checkhpux()

    Checks whether the version of the Solaris operating system is for SPARC or X86 platforms. Purpose This function uses the -p flag of the uname command to determine whether the Solaris operating system is for SPARC or X86 platforms. Syntax checkSunOS Input parameters Prerequisite Scanner: User's Guide...

  • Page 155: Getvalue()

    Return values String SOLARISSPARC|SOLARISX86 Returns "SOLARISSPARC" if the -p flag is "sparc"; otherwise, it returns "SOLARISX86". getValue() Gets the value for a key in a specified file if the key exists. Purpose Syntax getValue key file Input parameters String $key Contains the key to set.

  • Page 156: Getsystemid()

    Gets the closest parent directory or itself. Purpose Syntax getClosestExistingParentDir dirpath Input parameters String $dirpath Contains the path to obtain its parent directory or itself. Return values String dirpath Returns the parent directory or itself Prerequisite Scanner: User's Guide...

  • Page 157: Parsedirparameter()

    parseDirParameter() Parses the parameter from the parameter list for the scanner's -p flag and puts its value in the list. Purpose Syntax Input parameters String Return values printDirSize() Checks the NFS status of the mounted file system and then gets the disk space of the file system or its parent directory.
  • Page 158 Prerequisite Scanner: User's Guide...

  • Page 159: Appendix K. Logging Utility Functions For Unix Systems

    Appendix K. Logging utility functions for UNIX systems Prerequisite Scanner has a set of common logging functions in the/lib/common_function.sh file for writing debugging and trace data to log files. Table 45 describes the logging utilities. Table 45. Logging utility functions on UNIX systems...
  • Page 160 For example: `wrlLogFuncStart "main()"` Passes the str input parameter to str, string that represents data to log, that wrlLogFuncExit str wrlTraceFuncExit() and is, the name of the function being exited. For example: wrlDebugFuncExit() `wrlLogFuncExit "main()"` Prerequisite Scanner: User's Guide...

  • Page 161: Notices

    Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk...
  • Page 162 IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created...
  • Page 163 International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at www.ibm.com/legal/copytrade.shtml.
  • Page 164 Prerequisite Scanner: User's Guide...

  • Page 165: Support Information And Feedback

    Support information and feedback If you have a problem with your IBM software, you want to resolve it quickly. IBM provides different ways for you to obtain the support you need, such as online or IBM Support Assistant. You can also provide feedback or submit product requests for enhancements.
  • Page 166 Prerequisite Scanner: User's Guide...

  • Page 167: Index

    Index command-line interface detail parameter output format 23, 59 description 59 access permissions qualifiers running Prerequisite Scanner 59, 64 output formats 23, 59 description 8, 93 common directory subtypes adding collectors, UNIX 50 description 5, 93 prerequisite properties, custom 43...
  • Page 168 5, 93 parameter 12, 59 collectors, Windows 20, 46 packageTest.sh predefined 75 evaluators, UNIX 22, 57 collectors, UNIX 21 Prerequisite Scanner script 12, 59 evaluators, Windows 22, 53 updating 51 product versions log file path names 66 configuration files 13, 42...
  • Page 169 Windows Script Host 20, 22 description 5, 93 Software Support 155 special characters prerequisite properties 1 Prerequisite Scanner script 59 standard output collectors, UNIX 21 collectors, Windows 20 configuration files 13, 42 evaluators, UNIX 22 evaluators, Windows 22...
  • Page 170 Prerequisite Scanner: User's Guide...
  • Page 172 Printed in USA...

Table of Contents