How to customize the service tool
The default behavior of the service tool is to collect data about all IBM Spectrum Control components, but you can use the service tool to collect data about specific components. You can also use command-line parameters to specify a location to place the data that is collected, specify that the data is compressed, or to specify both.
Specifying help and output command-line parameters
To obtain information about the service tool usage, use the -help command-line parameter.
To specify the data that is collected by the service
tool, use the following command-line parameters when you run service
tool:
- -output directory_path
- Places the files that contain the data that was collected in a
directory that you specify. If you specify a directory that does not
exist on your system, that directory is created. If you do not use
the -output directory_path parameter,
the files are placed in the default directory:
- Windows operating systems
- installation_dir\service\data
- Linux® or AIX® operating systems
- installation_dir/service/data
Restriction: If you specify a directory, the directory path cannot contain spaces. This restriction refers to the -output option. - -pmr
- The number of the PMR to which the support information is related. Use the following format to enter the number: nnnnn,nnn,nnn where n represents a number, such as 12345,123,123. If you enter a value for the -pmr parameter, the service tool automatically uses FTP to upload the service information to IBM®. If the service tool cannot upload the service information to IBM from the IBM Spectrum Control server, the generated file must be uploaded manually. The -pmr parameter is ignored if the -nozip parameter is used.
- -nozip
- When you use this parameter, the compressed collected data archives are no longer created. The service tool creates separate directories for each component for which data was collected. You can then create compressed archives for the collected files. In this way, you can control the size and content of each compressed file. To specify a directory other than the default directory, use the -output directory_path parameter.
Tip: You can specify more than one parameter,
for example,
C:\Program Files\IBM\TPC\service>service -install
-nozip.Specifying Javacore, Java heap dump. snap trace, and Java core dump file collection
By default, the service tool collects all Java™core files, the most recent Java heap dump file, and the most recent snap trace file for the Data server, Device server, Alert server, web server, and data collector. The service tool can collect Java core dump files for these IBM
Spectrum Control components, but it does not by default. You can edit the
following parameters in the
installation_dir/service/service.properties file in order to control which
types of files and how many of each file type are collected by the service tool:
- coreFiles=0
- Specifies how many Java core dump files are collected. The default value is 0 because Java core dump files are generally very large. The valid values for this parameter are 0 or a positive integer. Any other value results in the default behavior.
- javaCoreFiles=-1
- Specifies how many Javacore txt files are collected. The default value of -1 means that all Javacore txt files are collected. The valid values for this parameter are 0 or a positive integer. Any other value results in the default behavior.
- heapDumpFiles=1
- Specifies how many Java heap dump files are collected. The default is to collect the most recent Java heap dump file. The valid values for this parameter are 0 or a positive integer. Any other value results in the default behavior.
- snapFiles=1
- Specifies how many snap trace files are collected. The default is to collect the most recent snap trace file. The valid values for this parameter are 0 or a positive integer. Any other value results in the default behavior..
Collecting data for specific IBM Spectrum Control components
You can use the service tool to collect data about specific IBM Spectrum Control components.
Use the following parameters to specify the components:
- -all
- All components. The default behavior is to collect data about all components.
- -install
- Installation component files.
- -data
- Data server component files.
- -device
- Device server component files.
- -datacollector
- Data collector component files.
- -alert
- Alert server component files.
- -export
- Export server component files.
- -sra
- Storage Resource agent component files.
- -db
- Db2® files.
- -cli
- Command-line interface files.
- -gui
- Collects data about GUI files.
If you collect information about a particular component, and you do not specify the -nozip parameter, you can identify the contents of a compressed service file from its name. For example, if you specify the -db -gui parameters but did not specify the -nozip parameter, a file named SCServiceFiles_db_gui.zip is created.
Warning: An existing compressed file is overwritten when another file of the same name
is created. For example, if you run
C:\Program Files\IBM\TPC\service>service -db
-gui, a file named SCServiceFiles_db_gui.zip is created. If
you rerun the tool with the same component options, a new file named
SCServiceFiles_db_gui.zip is created. This new file overwrites the previously
created file unless you specify the -nozip parameter, or use the
-output parameter to specify a different path.If you specify the -nozip parameter,
a directory is created for the components that you specified in the
parameter. If you did not specify a specific component, data is collected
for all installed components, and the data is placed in files in the
following directory:
- Windows operating systems:
- installation_dir\service\data
- Linux or AIX operating systems:
- installation_dir/service/data
- Windows operating systems:
- installation_dir\service\data
- Linux or AIX operating systems:
- installation_dir/service/data
Restriction: You cannot specify a specific
component as a command-line parameter when you specify the -all parameter.
Also, when you specify a component that is not installed on the computer,
the service tool displays an error message.