HP Service Manager Doctor

HP Service Manager

For the supported Windows® and UNIX® operating systems

Software Version: 9.33

SM Doctor User's Guide

Document Release Date: January 2014

Software Release Date: January 2014


Legal Notices

Warranty

The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

The information contained herein is subject to change without notice.

Restricted Rights Legend

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer

Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Copyright Notice

© Copyright 1994-2014 Hewlett-Packard Development Company, L.P.

Trademark Notices

Adobe® is a trademark of Adobe Systems Incorporated.

Java is a registered trademark of Oracle and/or its affiliates.

Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.

Oracle® is a registered US trademark of Oracle Corporation, Redwood City, California.

UNIX® is a registered trademark of The Open Group.

For a complete list of open source and third party acknowledgements, visit the HP Software Support Online web site and search for the product manual called HP

Service Manager Open Source and Third Party License Agreements.

Documentation Updates

The title page of this document contains the following identifying information:

l Software Version number, which indicates the software version.

l Document Release Date, which changes each time the document is updated.

l Software Release Date, which indicates the release date of this version of the software.

To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.com/selfsolve/manuals

This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html

Or click the New users - please register link on the HP Passport login page.

You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.

Support

Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport

This web site provides contact information and details about the products, services, and support that HP Software offers.

HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your business. As a valued support customer, you can benefit by using the support web site to:

l Search for knowledge documents of interest

l Submit and track support cases and enhancement requests

l Download software patches

l Manage support contracts

l Look up HP support contacts

l Review information about available services

l Enter into discussions with other software customers

l Research and register for software training

Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:

http://h20229.www2.hp.com/passport-registration.html

To find more information about access levels, go to:

http://h20230.www2.hp.com/new_access_levels.jsp

HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions to meet your business needs, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site is

http://h20230.www2.hp.com/sc/solutions/index.jsp

HP Service Manager (9.33)

Page 2 of 39


About this PDF Version of Online Help

This document is a PDF version of the online help. This PDF file is provided so you can easily print multiple topics from the help information or read the online help in

PDF format. Because this content was originally created to be viewed as online help in a web browser, some topics may not be formatted properly. Some interactive topics may not be present in this PDF version. Those topics can be successfully printed from within the online help.


Page 3 of 39


Contents

Contents

Contents

Introduction

Target audiences

Supported platforms

Supported Service Manager versions

Modes

Running Service Manager Doctor

Product Overview

Information collected

GUI mode

Service Manager Doctor Main window

Report window

Advanced Save window

Preference dialog box

Connect to Database dialog box

Connect to SM Server dialog box

Command-line mode

Command References

Service Manager Runtime commands (sm)

Extended Service Manager commands (esm)

Configuration commands (conf)

Database commands (db)

Operating System commands (os)

Web Service commands (ws)

Save commands (save)

Set commands (set)

Run commands (run)

Clear commands (clear)

Help command (help)


10

11

11

12

12

8

8

9

14

14

22

23

24

26

26

15

18

19

20

22

6

6

6

6

6

4

6

8

8

Page 4 of 39


Contents

'-dlog' parameter

Configuration Validation Rules

Configuration rule file

Considerations for updating the rule file

Validation results

CmdOnDemand.xml

HTML Log Snippets

Rule Configuration File Snippets

Error References

Troubleshooting

We appreciate your feedback!

26

27

27

27

28

29

31

32

34

37

38


Page 5 of 39

Introduction

Service Manager Doctor enables support engineers to collect configuration and diagnosis data from

Service Manager. This tool eliminates the need of excessive exchanges of emails between support engineers and customers before engineers can have all needed information to analyze a reported incident.

Target audiences

l

Service Manager customers l

Service Manager support engineers

Supported platforms

This tool supports platforms that are allowed in the Service Manager server compatibility matrix.

For details, see HP Support matrices on the Software Support Online site.

Supported Service Manager versions

7.1x and 9.x

Modes

The Service Manager Doctor Tool can run in two modes: l

Command-line l

Graphic user interface (only on Windows)

Running Service Manager Doctor

Run the following command in the smdoctor folder directly under the server installation directory to start the tool in GUI mode (only for Windows): smdoctor_gui.bat

Run one of the following commands in the smdoctor folder directly under the server installation directory to start the tool in command-line mode: smdoctor.bat

(for Windows) smdoctor.sh

(for UNIX/Linux)

When running Service Manager Doctor commands with logging enabled, the tool generates a

SMDoctor_Report_<hostname>.html

and SMDoctor_Report_<hostname>.txt

logs in the current


Page 6 of 39


Introduction

directory, where

<hostname>

is the host name of the Service Manager server. For example: run all -dlog or run -all -zip .


Page 7 of 39

Product Overview

This section describes the usage of the Service Manager Doctor Tool.

Information collected

This tool collects thefollowing types of information: l

SM server configurations and reports l

Operating system configurations l

Database configurations on the database server l

Service Manager server logs l

List of files in the %SM_HOME%RUN , %SM_HOME%RUN/lib/endorsed , and %SM_HOME%RUN/lib folders l

Additional configurable data collected by third-party tools, such as supportTool.sh

and generateSchema.sql

.

GUI mode

Follow these instructions when running the Service Manager Doctor Tool in GUI mode.

Service Manager Doctor Main window

The GUI mode of the Service Manager Doctor Tool allows you to easily perform a full health check with a simple click and then it displays a detailed health report in a new window. Additionally, you can use the Actions menu item to save certain files from the Service Manager server, including these options: l sm.ini

l sm.cfg

l

Service Manager logs l

List of files in the %SM_HOME%RUN folder l

List of files in the %SM_HOME%RUN/lib folder l

List of files in the %SM_HOME%RUN/lib/endorsed folder l

Iwssofmconf.xml


Page 8 of 39


Product Overview

l

SM client configuration l licfile.txt

l udp.xml

l udpcluster.xml

l

All these types of information (available with a “Save all above items” option)

In a complex, vertically-scaled configuration, the Service Manager Doctor Tool parses the sm.ini

and sm.cfg

files to locate all possible logs that are scattered on the server and packages them into a zip file.

You can click Health Check to perform health check multiple times. The latest report overwrites previously generated reports. However, the right pane of the main console window displays all check history.

The Service Manager Doctor Main window is shown in the screenshot below:

Report window

The GUI mode shows the report in the Report window:


Page 9 of 39


Product Overview

Advanced Save window

Advanced Save allows you to select specific data that you want to save. By default, all the items are selected. You can select the select all check box on the Advanced Save dialog box to select or clear all the items.

The Advanced Save option is available only after you run a health check. Additionally, the report and sm doctor logs save items are available only on the Advanced Save dialog box.

Note: If the total size of the server logs is too large for shipping, you can check a few items each time and save the log files in several small zip packages.

The Advanced Save window is shown in the screenshot below:


Page 10 of 39


Product Overview

Preference dialog box

The esm -appgloballistblobcount and db -schema commands are disabled by default because they may take a long time to respond. Each of these commands could take more than 10 minutes, depending on the actual environment. You can enable these commands by selecting the corresponding check boxes in the Preference dialog box.

The Preference dialog box is shown in the screenshot below:

Note: In command-line mode, you can run set -globallistcheck 1 and set -schemacheck

1

to enable these commands.

Connect to Database dialog box

Service Manager Doctor prompts you for the username and password of the Service Manager database if the sqllogin

parameter is encrypted in the sm.ini

file.

The Connect to Database dialog box is shown in the screenshot below:


Page 11 of 39


Product Overview

Connect to SM Server dialog box

Service Manager Doctor prompts you for the username and password of the Service Manager server if the esm -appgloballistblobcount command is enabled.

The Connect to SM Server dialog box is shown in the screenshot below:

Command-line mode

The command-line mode of the Service Manager Doctor Tool allows you to run the tool more flexibly. You can run specific commands or command groups to collect certain types of information.

You can also choose to type "run -all -zip" to package all data that is collected in the current directory. Eventually, the command-line mode generates SMDoctor_Report_<hostname>.html

and SMDoctor_Report_<hostname>.txt

logs in the current directory, where <hostname> is the host name of the Service Manager server.

The Command-line mode is shown in the screenshot below:


Page 12 of 39


Product Overview

Note: If the sm_doctor_saved.zip

file generated in command-line mode is too large for shipping, you can unzip the package and repackage them into smaller zip packages.

The sm_doctor_saved.zip

file has the following folder structure:


Page 13 of 39

Command References

This section describes the usage of commands when you are running the Service Manager Doctor

Tool in command-line mode. The command-line mode of Service Manager Doctor provides 10 groups of commands. When you try to run an invalid Service Manager Doctor command, the

command-line mode returns an error message. For more information, see "Error References" on page 34 .

Service Manager Runtime commands (sm)

Service Manager Runtime commands allow you to run regular Service Manager commands in the

Service Manager Doctor Tool. Therefore, you can use this command-line mode as a command-line console, except that it provides tool-specific commands. For example, you can run sm reportcache -reportlocks to check both the cache and locks in one single command.

We do not recommend that you run commands that require options or that return no command results, such as sm -version -log:version.txt

and sm -httpport:XXX

.

The timeout for Service Manager Runtime commands is 50 seconds.

Option

-reportstatus

-reportlbstatus

-reportcache

-reportipc

-reportlocks

-reportlic

-version

Description

Retrieves the Service Manager status.

Retrieves the Service Manager load balancer status.

sm -reportlbstatus

Retrieves the Service Manager cache data.

Retrieves the semaphore data.

Retrieves the lock status.

Retrieves the Service Manager license status.

Retrieves the Service Manager version.

Usage

sm -reportstatus sm -reportcache sm -reportipc sm -reportlocks sm -reportlic sm -version

-appversion

Note:

l

Always available regardless of whether the

Service Manager service is running or not.

l

Currently supports the reporting of versions

7.1x and 9.30

Retrieves the Service Manager application version.

sm -appversion


Page 14 of 39


Command References

Option Description

sqlverifyconnection

Verifies the database connection.

-reportshm

-reportsem

-all

-help

Retrieves the Service Manager shared memory.

Retrieves the Service Manager semaphore.

Runs all Service Manager Runtime commands at one time and returns the results in the output.

Displays Help information.

Note: If the -help option is used together with other options, only Help information is returned.

-dlog Outputs the command result to html and txt files.

Usage

sm sqlverifyconnection sm -reportshm sm -reportsem sm -all sm -help sm -all -dlog

Note: The sm commands listed in the table above, except the -all , -help , and -dlog options, are enabled by default and will be run when you run the sm -all or run -sm command. These sm commands are defined in the CmdOnDemand.xml

file. You can edit this file to enable additional commands to be run. The CmdOnDemand.xml

file can even include commands to launch external diagnostic tools. For example, the Service Manager Doctor tool is shipped with a shell script tool ( supportTool.sh

), which collects diagnostic information, such as stack traces of core system files, logs, and configuration files, and saves it in a

$HOSTNAME_ smsupport.tar

file. See "CmdOnDemand.xml" on page 29 for more information.

Extended Service Manager commands (esm)

Extended Service Manager commands return Service Manager specific information that the current

Service Manager Runtime commands may not return but is helpful for diagnosis.

The timeout for Extended Service Manager commands is 60 seconds.

Option

-javaversion

-apppatch

Description

Retrieves the Java runtime environment version of the Service Manager server (the

JRE version in the Service Manager RUN directory)

Retrieves Service Manager application patch information (in the patchrelversioninfo table).

Usage

esm -javaversion esm -apppatch


Page 15 of 39


Command References

Option

-apphotfix

-appbp

-port

-perf

-autopass

Description

Retrieves Service Manager application hotfix information (in the patchrelversioninfo table).

Usage

esm -apphotfix

Retrieves Service Manager Best Practice information (in the bpreleaseinfo table).

Retrieves Service Manager server ports (as returned by the 'netstat' command).

Retrieves Service Manager process CPU and memory information (as returned by the following system-specific commands).

esm -appbp esm -port esm -perf l

Windows: tasklist l

Linux: top -p l

Unix: ps -p)

Retrieves the Service Manager autopass version.

Pre-9.20:

…\Hewlett-Packard \HPOvLIC\About.txt

9.20 and later:

The AutoPassJ*.jar

version esm -autopass


Page 16 of 39


Command References

Option

-apprecordcount

Description Usage

Retrieves the record count for Service Manager tables: esm -apprecordcount l syslog l stathistory l eventin l systemperform l systemtotals l clocks l activity

Note: The threshold for validation is 10

KB.

-apptablemerge

-appfieldmigration

Retrieves Service Manager table merge information, such as whether M2 or M3 tables exist for the cm3r , cm3rpage , cm3t , and incidents tables.

Retrieves information about certain fields: l

The “approval” and “members” fields in the cm3groups table.

l

The “related_cis” field in the cirelations table.

appgloballistblobcount

Retrieves the length of the Service Manager application globallists value list.

esm -apptablemerge esm - appfieldmigration esm - appgloballistblobcount

Note: The threshold for validation is 1 KB.

-keystore Checks the Service Manager certificate, including these files: l

Server.keystore

l

Trustedclients.keystore

l cacerts esm -keystore


Page 17 of 39


Command References

Option

-pingclusternodes

-all

-help

-dlog

Description

Sends “ping” and “traceroute” messages to other Service Manager nodes in the current cluster.

Maximum ping times: 4

Maximum hops: 10

Runs all Extended Service Manager commands at one time and returns the results in the output.


Usage

esm pingclusternodes esm -all esm -help


Outputs the command result to html and txt files.

esm -all -dlog

Configuration commands (conf)

Configuration commands extract configuration items from the sm.cfg and sm.ini files, which will be used to diagnose server configuration issues against certain predefined validation rules.


dbtype

Retrieves database server type.

-dbinst Retrieves the database server instance.

-ini Retrieves the sm.ini content.

Usage

conf dbtype conf dbinst conf ini

Note: The sm.ini

content can also be captured in GUI mode, where the validation result is included in the command output.

-cfg Retrieves the sm.cfg content.

Note: The sm.cfg

content can also be captured in GUI mode, where the validation result is included in the command output.

conf cfg


Page 18 of 39


Command References


-env Retrieves system environment settings (returned by the system command) env operating

-all

-help

Runs all Configuration commands at one time and returns the results in the output.


Usage

conf env conf all conf help



conf all -dlog

Database commands (db)

Database commands collect information about the database that Service Manager uses.

The timeout for Database commands is 60 seconds.

Note: If you are running these commands with an Oracle database, you must create an

OJDBC_LIB environment variable on the system and set its value to the Oracle driver path for the driver to be loaded successfully.


-version Retrieves the database server version.

-info Retrieves the server information:

SQL Server: collation

Oracle: characterset information; case-sensitivity information

DB2: DB configuration

-list Retrieves the database (tablespace) list.

timezone

Retrieves the database time zone and returns the time offset from the

UTC/GMT time in hours.

Usage

db version db -info db -list db timezone


Page 19 of 39


Command References


-schema Retrieves the table and index schema of the Service Manager database and outputs the information into an SM_schema.sql

file.

Usage

db schema

Note: This command works only with Oracle databases and requires that the sqlplus utility is installed on the system.

-all

-help

Runs all Database commands at one time and returns the results in the output.


db -all db -help

Note: If the -help option is used together with other options, only

Help information is returned.


db -all dlog

Operating System commands (os)

Operating System commands collect basic information about the current operating system.

The timeout for Operating System commands is 180 seconds.

Option

-ip

-diskspace

-sys

Description

Retrieves the server IP addresses.

Retrieves the disk space on the server, including the total space and free space.

Retrieves server system information.

l

Windows: systeminfo l

AIX: prtconf l

HPUX PA-RISC: model l

HPUX ITATIUM: machinfo l

Solaris: isainfo -kv l

Linux: uname -a

Usage

os -ip os -diskspace os -sys


Page 20 of 39


Command References

Option

-openfile

Description

Retrieves the open file limit as returned by the ulimit -n command.

Note: Only for UNIX.

Usage

os -openfile process Retrieves all processes that are currently running.

l

Unix: ps -ef os -process l

Windows: wmic process get executablepath

-ipcs Retrieves the status of inter-process communication os -ipcs

sharedmemory

Retrieves the maximum size of shared memory and the count of shared memory segments.

os sharedmemory

-udpbuffer

-all

-help l

Solaris: sysdef l

Linux: sysctl -n l

HPUX: kctune -v l

AIX: Not available

Retrieves the UDP buffer size.

l

Solais: ndd -get l

Linux: sysctl -n l

AIX: no -o l

HPUX: ndd -get

Runs all Operating System commands at one time and returns the result in the output.


os -udpbuffer os -all os -help



os -all -dlog

Note: For Windows platforms, x86 represents the 32-bit version and x64 represents the 64-bit version.


Page 21 of 39


Command References

Web Service commands (ws)

Web Service commands determine the Service Manager status by sending a simple SOAP request to the http://localhost:13080/SM/ui endpoint (when run on the local server) and checking the response.

The timeout for Web Service commands is 60 seconds.


getpreferences

Returns the preference operation response.

Note: Returns responses through HTTP server ports.

Usage

ws getpreferences

-all

-help

-dlog

Runs all Web Service commands at one time and returns the result in the output.

ws -all

Note: Only one option is defined for the Web service command group now.

ws -help Displays Help information.


Outputs the command result to html and txt files.

ws -all -dlog

Save commands (save)

Save commands save required files on the Service Manager server. Service Manager Doctor can save up to 10 Service Manager Doctor logs, and each log can have a maximum of 1 megabyte in size.

The timeout for Save commands is 50 seconds.

Option

-report

-ini

-cfg

-lib

Description

Saves html and txt reports in the current directory.

Saves the ini file in the current directory.

Saves the cfg file in the current directory.

Saves the list of files in the lib folder in the current directory.

Usage

save -report save -ini save -cfg save -lib


Page 22 of 39


Command References

Option

-endorsed

Description

Saves the list of files in the endorsed folder in the current directory.

-run Saves the list of files in the RUN folder in the current directory.

-ssoconfig Saves the SSO configuration file in the RUN folder in the current directory.

Note: This file does not always exist.

Usage

save endorsed save -run save ssoconfig

-logs

-smdlog

Saves all logs generated for Service Manager

Saves all Service Manager Doctor logs.

Note: Service Manager Doctor logs are not collected by the run

-all command.

save -logs save smdlog

-udp Saves the udp.xml

file.

udpcluster

Saves the udpcluster.xml

file.

-licfile

Saves the

LicFile.txt

file.

-clientcfg Saves Windows client configurations if a Windows client is installed on this machine.

tnsnames

Saves the tnsname.ora

file for the Oracle database.

dbschema

Saves the output file (

SM_schema.sql

) of the db -schema

command for the Oracle database.

-all Runs all Save commands at one time and returns the result in the output.

-help Displays Help information.

save -help save -udp save udpcluster save -licfile save clientcfg save tnsnames save dbschema save -all

Note: If the -help option is used together with other options, only

Help information is returned.

Set commands (set)

The Set command group now includes only one command that sets the -dlog parameter.


Page 23 of 39


Command References

Option

-dlog

-schemacheck

Description

Enables or disables the -dlog option for all commands.

However, the -dlog option specified in each command overrides this setting.

Enables or disables database schema check for the all or esm -all commands.

run -

globallistcheck

Enables or disables globallist blob field check for the run all or esm -all

commands.


Usage

set -dlog true set -dlog 1 set -dlog false set -dlog 0 set schemacheck 1 set schemacheck true set schemacheck 0 set schemacheck false set - globallistcheck

1 set - globallistcheck true set - globallistcheck

0 set - globallistcheck false set -help


Run commands (run)

Run commands execute multiple commands or multiple command groups.


Page 24 of 39


Command References


-sm Runs all Service Manager Runtime commands in a sequence and returns the results in the output.

Usage

run sm -db

-os

Note: Equivalent to sm -all .

-esm Runs all Extended Service Manager commands in a sequence and returns the results in the output.

run esm db

Note: Equivalent to sm -all .

-db run -db Runs all Database commands at one time and returns the results in the output.

Note: Equivalent to db -all .

-conf Runs all Configuration commands at one time and returns the results in the output.

Note: Equivalent to conf -all .

-os

-ws run conf dlog

Runs all Operating System commands at one time and returns the results in the output.

run -os

.

Note: Equivalent to os -all .

Runs all Web Service commands at one time and returns the results in the output.

run ws

-all

Note: Equivalent to ws -all .

Runs all commands at one time and returns the results in the output.

Note: Peforms a full health check.

run -all

-zip

-help

Packages all data to an sm_doctor_saved.zip file, which include the SM log files, endorsed file list, lib file list, html report, txt report, sm.cfg and sm.ini.


run -all

-zip run help



Page 25 of 39


Command References

Clear commands (clear)

The Clear command group deletes log files Service Manager Doctor generated, and clears the content of the current log file if the tool is still running.


-dlog Clears Service Manager Doctor logs.


Usage

clear dlog clear help


Help command (help)

The Help command displays help information.

'-dlog' parameter

The -dlog parameter is available for all commands except the "help" command. Adding this parameter to a command is equivalent to running set -dlog true

or set -dlog 1

except that the parameter included in the command overrides the global setting configured by set -dlog false and set -dlog 0 .

Note: The reason why you may use the

-dlog

parameter instead of

-log

is that the

-log parameter itself is a valid parameter of Service Manager.


Page 26 of 39

Configuration Validation Rules

This section describes the usage of validation rules in the Service Manager Doctor Tool.

Configuration rule file

Caution: It is not recommended that you edit the configuration rule file manually in this version of the tool.

The configuration rule file is an XML file with predefined rules that are used to validate Service

Manager server configurations. All configuration information is based on the sm.ini

and sm.cfg

files, where sm.cfg

is prioritized higher than sm.ini

.

The elements of the configuration rule file include source, domain, rule, condition, conditonrule, operation, and output. Configuration rules for all configurations should be defined within the configuration source. Configuration rules used for specific validation should be defined within a specific domain. There can be multiple domains within each source, and multiple rules within each

domain. See "Rule Configuration File Snippets" on page 32 .

Considerations for updating the rule file

l

This tool includes an SM_Configuration_Rule.xsd

file to maintain the integrity of the rule file.

Detailed messages are displayed in the validation results, including information about the row, column, and other violation specifics.

l

If one rule serves as a condition for another rule, the first rule cannot have conditions of its own.

Or, a

TWO_LEVEL_CONDITION_FOUND

error is returned.

l

For operation elements within a rule element, the "param" and "action" attributes are required.

The "target" and "type" attributes are optional, but they are mutually dependent. If one parameter is defined, you must define the other one too. l

For condition elements, if "operator" and "target" are not defined, they default to and and true respectively.

l

In addition to customized rules, you can use the generic rules directly: is32OS, is64OS, isUnix, and isWindows.

l

An error 100018 is returned if the XML content cannot be parsed.

l

In the current version of the tool, only the configuration data source is editable, which includes both the sm.ini

and sm.cfg

files.


Page 27 of 39


Configuration Validation Rules

Validation results

Validation results are included as part of the command output for the conf -ini and conf -cfg commands in command-line mode. In GUI mode, a separate column is displayed next to the command results if a rule failure is detected.


Page 28 of 39

CmdOnDemand.xml

A typical CmdOnDemand.xml

file resembles the following codes:

<?xml version="1.0" encoding="UTF-8"?>

<commands>

<command name="sm" description="sm server commands" provider="hp">

<param name="-reportstatus" description="SM runtime status"/>

<param name="-reportcache" description="SM cache status"/>

<param name="-reportipc" description="SM semaphore use"/>

<param name="-reportlocks" description="SM lock information"/>

<param name="-reportlic" description="SM licence information"/>

<param name="-version" description="SM version"/>

<param name="-verifylic" description="SM verify license"/>

<param name="-appversion" description="SM application version"/>

<param name="-reportshm" description="SM shared memory"/>

<param name="-reportsem" description="SM semaphore"/>

<param name="-sqlverifyconnection" description="SM verify DB connection"/>

</command>



</commands>

To add a new command to the

CmdOnDemand.xml

file, follow these steps:

1. Open the CmdOnDemand.xml

file in a text editor.

2. Add more entries similar to <param name="-version" description="SM version"/>.

3. Add the required Service Manager command parameters in the "name" attribute.

4. Add the command description in the "description" attribute, which will be used for HTML/TEXT report generation.


Page 29 of 39


CmdOnDemand.xml

Note: To run external commands, make sure that the target scripts or executables reside in the RUN directory. Do not add "param" elements for additional command arguments.

Instead, include command arguments in the "name" attribute of the "command" element.

We do not recommend that you run external commands that work with background processes or I/O streams, such as uname -a &

and ls -lrt > 1.txt

.


Page 30 of 39

HTML Log Snippets

The Extended Service Manager report sample is shown in the screenshot below:

The Database report sample is shown in the screenshot below:


Page 31 of 39

Rule Configuration File Snippets

SM_Configuration_Rule.xml snippet

<?xml version="1.0" encoding="UTF-8"?>

<xml xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:noNamespaceSchemaLocation="SM_Configuration_Rule.xsd" version="1.0">

<source id="configuration" description="service mangaer configuration validation rules">

…

<domain id="StartUp" description="validate sm startup configuration" >

<rule id="sync" description="validate synch parameter" >

<operation param="sync" action="ValidateIsNotNull" />

</rule>

<rule id="systemstart" description="validate system.start" >

<operation param="system.start" action="ValidateIsNotNull" />

</rule>

<rule id="startuprule" description="validate startup by combination of sync and system.start" >

<condition operator="and" target="false">

<conditionrule id="sync" />

<conditionrule id="systemstart" />

</condition>

<output type="failed" message="failed: sync and system.start p rocesses should not be started at the same, the recommendation is to remove sync from configuration.

For further information, please refer to “Configuring a horizontal scaling environment” on help server."

/>

<output type="success" message="success: sync and system.start are not set both" />

</rule>

</domain>

……

SM_Configuration_Rule.xsd snippet

<xs:complexType name="rule_type">


Page 32 of 39


Rule Configuration File Snippets

<xs:sequence>

<xs:element name="condition" minOccurs="0" type="condition-type">

<xs:unique name="NoRepeatConditionRule">

<xs:selector xpath="conditionrule"/>

<xs:field xpath="@id"/>

</xs:unique>

</xs:element>

<xs:element name="operation" minOccurs="0" type="operation_type">

</xs:element>

<xs:element name="output" minOccurs="0" maxOccurs="unbounded" type=

"output_type">

</xs:element>

</xs:sequence>

<xs:attribute name="id" type="xs:string" use="required" />

<xs:attribute name="description" type="xs:string" use="optional" />

<xs:attribute name="mode" use="optional" >

<xs:simpleType>

<xs:restriction base="xs:string">

<xs:enumeration value="multiple" />

<xs:enumeration value="single" />

</xs:restriction>

</xs:simpleType>

</xs:attribute>

</xs:complexType>


Page 33 of 39

Error References

The following table lists the possible errors that the Service Manager Doctor commands may return.

Error

Code Description

100000 SYS_ERROR

Category

SYSERROR

100001 UNKNOWN_ERROR SYSERROR Unknown error, please try again later or reach SM Doctor admin for a solution.

100002 COMMAND_NOT_EXIT PARSEERROR This command <command> is not recognizable, please enter again.

100003 NO_SUCH_OPTION

100004 NO_SUCH_

PARAMETER

100005 ARGU_NOT_EXIT

PARSEERROR This option <option> is not recognizable for this command, please enter again

PARSEERROR Xxx is not passed to any parameter, please enter again.

100006 ONLY_LOG_ERROR

100007 HELP_LOG_ERROR

PARSEERROR This argument <argument> is not recognizable, please enter again.

PARSEERROR Log option <option> is only valid with another command line option, please enter again.

PARSEERROR Log option is not valid with help option, please enter again.

100008 HELP_ERROR

100009 DUPLICATE_ERROR

Error Message (partial)

System error, please reach support team…

PARSEERROR Help option is valid by <command> help without other options. Please enter again.

PARSEERROR Duplicate options are found, please remove the same ones and keep each unique.

100010 LOG_PARAM_ERROR PARSEERROR Only true(1) or false(0) is allowed for this option.

100011 NODATA NODATA No data is available for this command.

100012 DB_DRIVER_ERROR

100013 SQL_EXCEPTION

100014 TABLE_DOES_NOT_

EXIT

DBERROR

DBERROR

DBERROR

Database driver can not be loaded.

SQLException is caught …

This table <table_name> does not exit.


Page 34 of 39


Error References

Error


100015 SM_NOT_FOUND

100016 SM_NOT_RUNNING

Category

SYSERROR

SYSERROR


Service Manager is not found, please check.

Service Manager is not running, please check.

100017 COMMAND_TIMEOUT SYSERROR

100018 UNSATISFIED_LINK_

ERR OR

DBERROR

100019 RULE_PARSING_

ERROR

SYSERROR

Command execution timeout.

Unsatisfied link error.

Exception happened when parsing XML rule configuration file.

PARSEERROR Invalid input <input>.

100020 OTHER_PARSE_

ERROR

100021 INFO_NOT_

AVAILABLE

100022 RECORD_COUNT_

EXCEE D_

THRESHOLD

SYSERROR

DBERROR

Xxx information is not available.

The record count in table <table_name> exceeds threashold <threshold_value>, purge/ archive is needed.

100023 TABLE_MERGE_

NEEDED

100024 FIELD_NOT_

EXPECTED

100025 ORACLE_DRIVER_

NOT_F OUND

DBERROR

DBERROR

DBERROR

M2/M3 tables exist for xxx, table merge is needed.

This field xxx is not expected in table…

Oracle driver could not be loaded, please make sure driver's jar exists under xxx.

Valuelist length of xxx keys in globallists table exceeds threshold.

100026 GLOBALLISTS_

VALUELIS T_LENGTH_

EXCEED_THR SHOLD

DBERROR

100027 DATABASE_AUTH_

FAILED

DBERROR

100028 FILE_NOT_SAVED

100029 FILES_NOT_FULLY_

SAVED

100030 FILE_NOT_EXISTS

100031 FILES_NOT_EXIST

FILEERROR

FILEERROR

FILEERROR

FILEERROR

Username or password is invalid, database could not be connected.

File could not be saved.

Files could not be (fully) saved.

xxx does not exist.

xxx do not exist.


Page 35 of 39


Error References

Error


100032 NO_NEED_TO_SAVE_

TNS NAMES

Category

FILEERROR


No need to save tnsnames.ora for xxx.

100033 NO_CLIENT_CONF_

SAVED

FILEERROR

100034 WEBSERVICE_AUTH_

FAIL ED

WEBSERVICE

ERROR

Username or password is invalid, server could not be connected.

100035 WEBSERVICE_

TIMEOUT

WEBSERVICE

ERROR

Timeout for this soap request.

100036 UNSUPPORTED_OS

No running sm client is detected, no configuration files could be saved.

100037

100038

SSL_ENABLED

UNSUPPORTED_DB

100039 CMD_LIMITED_TO

100040 KEYTOOL_ERROR

100041 NO_LOCAL_PING

SYSERROR

WEBSERVICE

ERROR

Web service call is not done because

SSL is enabled, you can start a SSL disabled process to run this command.

DBERROR

SM Doctor does not support this operating system <system_name>.

SM Doctor does not support this database.

This command is limited to xxx.

SYSERROR

FILEERROR

SYSERROR

Keytool error happened by checking

xxx.

Only vertical scaling setting is found, local host ping/ tracert is skipped.

100042 KEYFILE_NOT_EXIST SYSERROR

100043 PARAMETER_NOT_

EXIST

SYSERROR

100044 SQLPLUS_NOT_

FOUND

DBERROR

Keyfile <filename> does not exist.

Parameter <parameter> is not configured.

Sql plus is not found, please set its path in <variable>.


Page 36 of 39

Troubleshooting

Issue 1: Environment setting issues leading to coredump

Symtoms

The coredump happens with the following error messages:

/usr/lib/dld.sl: Bad magic number for shared library: <library>

/usr/lib/dld.sl: Exec format error

Resolution

Verify that the database driver path is set correctly in the corresponding library path environment variable and that the driver exists in the specified path.

Issue 2: 'db -version' command returns wrong results on DB2

Symtoms

The following database connection error message is displayed when database connection fails for

'db -version' on DB2:

[100012]Database driver cannot be loaded, please double check LIBPATH, and make sure 32 bit lib exists and is ahead of 64 bit.

Resolution

Run db2level under db2 command shell directly to get database information if necessary. This is to be fixed in next release, since db2 version information could be returned when connection fails.


Page 37 of 39

We appreciate your feedback!

If you have comments about this document, you can contact the documentation team by email. If an email client is configured on this system, click the link above and an email window opens with the following information in the subject line:

Feedback on SM Doctor User's Guide (Service Manager 9.33)

Just add your feedback to the email and click send.

If no email client is available, copy the information above to a new message in a web mail client, and send your feedback to [email protected].


Page 38 of 39

No results