IBM Tivoli Monitoring for Applications: Siebel eBusiness ...publib.boulder.ibm.com/tividd/td/ITMAN/SC23-4818-00/en_US/PDF/S… · IBM Tivoli Monitoring for Applications: Siebel eBusiness

IBM Tivoli Monitoring for Applications: SiebeleBusiness Applications

Reference GuideVersion 5.1.0

SC23-4818-00

��

IBM Tivoli Monitoring for Applications: SiebeleBusiness Applications

Reference GuideVersion 5.1.0

SC23-4818-00

��

NoteBefore using this information and the product it supports, read the information in Appendix B, “Notices” on page 119.

First Edition (September 2002)

This edition applies to version 5.1.0 of IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications and toall subsequent releases and modifications until otherwise indicated in new editions.

© Copyright International Business Machines Corporation 2002. All rights reserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this guide . . . . . . . . . . . vWho should read this guide . . . . . . . . . vWhat this guide contains . . . . . . . . . . vPublications . . . . . . . . . . . . . . v

IBM Tivoli Monitoring for Applications, Version5.1.0: Siebel eBusiness Applications library . . . viRelated publications . . . . . . . . . . viAccessing softcopy publications . . . . . . viiOrdering Publications . . . . . . . . . . viiProviding feedback about publications . . . . vii

Accessibility . . . . . . . . . . . . . . viiiContacting customer support . . . . . . . . viiiConventions used in this book. . . . . . . . viii

Typeface conventions . . . . . . . . . . viiiTivoli command syntax . . . . . . . . . viii

Chapter 1. Introduction . . . . . . . . 1Running Tivoli commands . . . . . . . . . . 1

Running Tivoli commands on UNIX operatingsystems . . . . . . . . . . . . . . . 2Running Tivoli commands on Windows NT/2000operating systems . . . . . . . . . . . 2Where to find additional information about shells 2Establishing the Tivoli environment within a shell 3

Setting the Tivoli environment on UNIXoperating systems . . . . . . . . . . 3Setting the Tivoli environment on WindowsNT/2000 operating systems . . . . . . . 3

Establishing the Tivoli environment on anendpoint. . . . . . . . . . . . . . . 3

Tivoli command syntax . . . . . . . . . . . 4

Chapter 2. Resource models . . . . . . 7Siebel Component Availability . . . . . . . . 10Siebel Component Task Count . . . . . . . . 14Siebel Component Tasks Resource Use . . . . . 20Siebel Connection Broker Availability . . . . . . 26Siebel Gateway Availability . . . . . . . . . 29Siebel Server Availability . . . . . . . . . . 33Siebel Server File System Directory Size . . . . . 39Siebel Server Log File Directory Size . . . . . . 43Siebel Server Resource Use . . . . . . . . . 47

Chapter 3. IBM Tivoli Monitoring forApplications: Siebel eBusinessApplications task libraries . . . . . . 53Running tasks . . . . . . . . . . . . . 53Task authorization roles . . . . . . . . . . 54

Chapter 4. Siebel Event Tasks. . . . . 57List of Siebel Event Tasks by GUI and CLI Names 57

Configure_Event_Server . . . . . . . . . . 58Configure_Logfile_Broker_Message_Formats . . . 62Configure_Logfile_Server_Message_Formats . . . 65Control_Logfile_Adapter . . . . . . . . . . 68TBSM_Discover . . . . . . . . . . . . . 70

Chapter 5. Siebel Operational Tasks . . 71List of Siebel Operational Tasks by GUI and CLINames . . . . . . . . . . . . . . . . 71Archive_Siebel_Logs . . . . . . . . . . . 72Check_Server_Status . . . . . . . . . . . 75Control_Component_Groups . . . . . . . . 77Control_Siebel_Tasks . . . . . . . . . . . 79Run_List_Command . . . . . . . . . . . 81Run_Srvrmgr_Command . . . . . . . . . . 83Start_Connection_Broker . . . . . . . . . . 85Start_Siebel_Gateway . . . . . . . . . . . 86Start_Siebel_Server . . . . . . . . . . . . 87Stop_Connection_Broker . . . . . . . . . . 88Stop_Siebel_Gateway . . . . . . . . . . . 90Stop_Siebel_Server . . . . . . . . . . . . 92

Chapter 6. Siebel Utility Tasks. . . . . 95List of Siebel Utility Tasks by GUI and CLI Names 95Delete_Endpoint_Utilities . . . . . . . . . . 96Discover . . . . . . . . . . . . . . . 98

Chapter 7. wsiebel Command . . . . 101wsiebel . . . . . . . . . . . . . . . 102

Appendix A. Creating customresource models using CIM classes . 105Creating custom resource models using the IBMTivoli Monitoring Workbench . . . . . . . . 105Getting started with the Resource Model Wizard 107Classes and properties to use in resource models 108

Siebel_Server_10 . . . . . . . . . . . 109Siebel_Componentgroup_10 . . . . . . . 111Siebel_Component_10 . . . . . . . . . 112Siebel_Task_10 . . . . . . . . . . . . 114Siebel_Gateway_10 . . . . . . . . . . 115Siebel_ConnectionBroker_10 . . . . . . . 116Siebel_Parameters_10 . . . . . . . . . . 117Siebel_Statistics_10 . . . . . . . . . . 118

Appendix B. Notices . . . . . . . . 119Trademarks . . . . . . . . . . . . . . 121

Index . . . . . . . . . . . . . . . 123

© Copyright IBM Corp. 2002 iii

iv IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications: Reference Guide

About this guide

This guide describes the tasks and resource models that you use to manage theSiebel environment. Use this manual in conjunction with the IBM Tivoli Monitoringfor Applications, Version 5.1.0: Siebel eBusiness Applications User’s Guide.

Who should read this guideThis guide is for system architects and system administrators who use the IBMTivoli Monitoring for Applications: Siebel eBusiness Applications to manage andmonitor Siebel resources. This guide requires administrator-level knowledge ofTivoli management software, UNIX® and Windows® operating systems, databases,and Siebel products.

What this guide containsThis book contains the following chapters:v Chapter 1, “Introduction” on page 1

Describes how to run Tivoli commands.v Chapter 2, “Resource models” on page 7

Describes the resource models for the product.v Chapter 3, “IBM Tivoli Monitoring for Applications: Siebel eBusiness

Applications task libraries” on page 53Describes the task libraries for the product.

v Chapter 4, “Siebel Event Tasks” on page 57Describes the event tasks for the product.

v Chapter 5, “Siebel Operational Tasks” on page 71Describes the operational tasks for the product.

v Chapter 6, “Siebel Utility Tasks” on page 95Describes the utility tasks for the product.

v Chapter 7, “wsiebel Command” on page 101Describes the wsiebel command.

v Appendix A, “Creating custom resource models using CIM classes” on page 105Describes how you can use the Resource Model Wizard to create your ownresource models using the IBM Tivoli Monitoring for Applications: SiebeleBusiness Applications CIM classes.

v Appendix B, “Notices” on page 119Lists and describes the legal notices and trademarks for use of the guide.

PublicationsThis section lists publications in the IBM Tivoli Monitoring for Applications: SiebeleBusiness Applications library and any other related documents. It also describeshow to access Tivoli publications online, how to order Tivoli publications, and howto submit comments on Tivoli publications.

© Copyright IBM Corp. 2002 v

IBM Tivoli Monitoring for Applications, Version 5.1.0: SiebeleBusiness Applications library

The following documents are available in the IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications library:v IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness Installation and

Setup Guide, GC23-4810Describes how to install and deploy the IBM Tivoli Monitoring for Applicationsproduct.

v IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness ApplicationsUser’s Guide, SC23-4819Describes how to use IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications.

v IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness ApplicationsReference Guide, SC23-4818Provides information about resource models and task libraries for the IBM TivoliMonitoring for Applications: Siebel eBusiness Applications.

v IBM Tivoli Monitoring for Applications, Version 5.1.0 Siebel Limitations andWorkarounds Supplement, SC23-4817Provides the latest information about known product limitations andworkarounds. To ensure that the information is the latest available, thisdocument is provided only on the Web, where it is updated on a regular basis.You can access the Limitations and Workarounds document through the IBMTivoli Monitoring for Applications: Siebel eBusiness Applications link on theTivoli Information Center Web site:

http://www.tivoli.com/support/public/Prodman/public_manuals/td/TD_prod_list.html

v IBM Tivoli Monitoring for Applications, Version 5.1.0 Release Notes, GI11-0941Describes product features and provides information about the latest changes tothe installation requirements and procedures. The release notes also describeknown limitations related to installation and explain how to work around eachlimitation.

Related publicationsThe following documents provide other useful information:v Tivoli Software Installation Service User’s Guide

v Tivoli Framework User’s Guide

v Tivoli Framework Planning and Installation Guide

v Tivoli Framework Reference Manual

v Tivoli Enterprise Console User’s Guide

v Tivoli Enterprise Console Reference Manual

v Tivoli Enterprise Console Rule Builder’s Guide

v Tivoli Enterprise Console Event Integration Facility Guide

v IBM Tivoli Data Warehouse product documentationv IBM Tivoli Distributed Monitoring (Advanced Edition) product documentation

The Tivoli Glossary includes definitions for many of the technical terms related toTivoli software. The Tivoli Glossary is available, in English only, at the followingWeb site:

vi IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications: Reference Guide

http://www.tivoli.com/support/documents/glossary/termsm03.htm

Accessing softcopy publicationsThe publications for this product are available in PDF and HTML formats throughthe following media:v IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness

Applications Documentation CD, LK3T-8518The Documentation CD contains all of the English language publications for thisproduct, except for the Web-only Limitations and Workarounds supplements. Toaccess the publications, use a Web browser to open the start.html file, which islocated in the root directory of the CD.

v IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications NLV Documentation CD, LK3T-8615The NLV (national language version) Documentation CD contains both Englishand non-English language publications for this product, except for the Web-onlyLimitations and Workarounds supplements. To access the publications, use aWeb browser to open the start.html file, which is located in the root directory ofthe CD.

v Tivoli Information CenterIBM posts all publications for this and all other Tivoli products, as they becomeavailable and whenever they are updated, to the Tivoli Information Center Website. The Tivoli Information Center is located at the following Web address:http://www.tivoli.com/support/public/Prodman/public_manuals/td/TD_PROD_LIST.html

Click IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications to access the product library.

Ordering PublicationsYou can order hardcopy publications online from the IBM Publications CenterWebsite:

http://www.elink.ibmlink.ibm.c om/public/applications/publications/ \cgibin/pbi.cgi

You can also order by telephone by calling one of these numbers:v In the United States: 800-879-2755v In Canada: 800-426-4968

See the following Web site for a list of telephone numbers in other countries:

http://www.tivoli.com/inside/store/lit_order.html

Providing feedback about publicationsIf you have comments or suggestions about Tivoli products and documentation,complete the customer feedback survey at the following Web site:

http://www.tivoli.com/support/survey/

About this guide vii

http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

http://www.elink.ibmlink.ibm.com/public/applications/publications/cgibin/pbi.cgi

http://www.tivoli.com/inside/store/lit_order.html

AccessibilityAccessibility features help a user who has a physical disability, such as restrictedmobility or limited vision, to use software products successfully. With this product,you can use assistive technologies to hear and navigate the interface. You can alsouse the keyboard instead of the mouse to operate all features of the graphical userinterface. See the Accessibility Appendix in IBM Tivoli Monitoring for ApplicationsVersion 5.1.0: Siebel eBusiness Application User’s Guide for additional information.

Contacting customer supportIf you have a problem with any Tivoli product, you can contact IBM CustomerSupport for Tivoli products. See the Tivoli Customer Support Handbook at thefollowing Web site:

http://www.tivoli.com/support/handbook/

The handbook provides information about how to contact Customer Support,depending on the severity of your problem, and the following information:v Registration and eligibilityv Telephone numbers and e-mail addresses, depending on the country in which

you are locatedv What information you should gather before contacting support

Conventions used in this bookThis book uses several conventions for special terms and actions, operatingsystem-dependent commands and paths, and margin graphics.

Typeface conventionsThis book uses the following typeface conventions.

Bold Lowercase and mixed-case commands, command options, file and pathnames, and flags that appear within text appear like this, in bold type.Graphical user interface elements and names of keys also appear like this,in bold type.

Italic Variables, values you must provide, new terms, and words and phrasesthat are emphasized appear like this, in italic type.

MonospaceCommands, command options, and flags that appear on a separate line,code examples, output, and message text appear like this, in monospacetype.

Names of files and directories, text strings you must type when theyappear within text, names of Java methods and classes, and HTML andXML tags also appear like this, in monospace type.

Tivoli command syntaxThe commands in this book use the following special characters to define Tivolicommand syntax:

< > Indicates that the text enclosed in the angle brackets is a variable that yousupply.

viii IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications: Reference Guide

[ ] Identifies optional elements. Elements that do not have brackets aroundthem are required.

... Indicates you can specify multiple values for the previous element.Separate multiple values by a space, unless the command informationspecifies differently.

If the ellipsis for an element follows a closing bracket ( ] ), use the syntaxwithin the brackets to specify multiple values. For example, to specify twoadministrators for the option [–a admin]..., use –a admin1 –a admin2.

If the ellipsis for an element is within brackets, use the syntax of the lastelement to specify multiple values. For example, to specify two hosts forthe option [–h host...], use –h host1 host2.

| Indicates mutually exclusive information, meaning you can use the elementon either the left or right of the vertical bar, but not both.

{ } Delimits a set of mutually exclusive elements when a command requiresone of them, but not multiple elements. Brackets ([ ]) are around elementsthat are optional.

\ A backslash indicates that a command continues on the next line.

In addition to the special characters, Tivoli command syntax uses the typefaceconventions described in “Typeface conventions” on page viii.

The following examples illustrate the typeface conventions used in Tivolicommand syntax:v wcrtpr [–a admin]... [–s region] [–m resource]... name

The name argument is the only required element for the wcrtpr command. Thebrackets around the options indicate that they are optional. The ellipsis after the–a admin option means that you can specify multiple administrators multipletimes. The ellipsis after the –m resource option means that you can specifymultiple resources multiple times.

v wchkdb [–o outfile] [–u] [–x] {–f infile | –i | object...}The –f, –i, and object elements are mutually exclusive. The braces that surroundthe –f, –i, and object elements indicate that you are including required elements.If you specify the object argument, you can specify more than one object.

When you reference an object in a command issued from the command line, thereference is not an absolute object reference like those used in programming.Instead, the reference is a user-friendly name. This user-friendly name derives froma name given to the object by the user of the application, such as when creating apolicy region.

About this guide ix

x IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications: Reference Guide

Chapter 1. Introduction

This book is a reference guide designed for use with the procedures described inthe IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness ApplicationsUser’s Guide. It provides alphabetical listings and detailed descriptions of thefollowing:v Resource modelsv Tasksv The wsiebel command

Running Tivoli commandsTivoli commands enable you to perform system operations from a UNIX orWindows NT/2000 command line interface (CLI) instead of using the Tivolidesktop. The term, Tivoli CLI commands, is another way to refer to thesecommands.

It is often convenient or more appropriate to invoke a Tivoli managementapplication operation from the command line instead of from the graphical userinterface. This is the case in the following examples:v You do not have access to a graphical user interface, such as when you dial in

over a modem.v You are grouping a number of operations together inside a shell script.v You want to use accessibility tools that require text-based input of commands.

Tivoli CLI commands begin with the letter w to identify them as Tivoli commands.Command names use a w+verb+object syntax, which matches the way you wouldthink of the action. For example, to run a task, use the wruntask command.

Most Tivoli commands run within a bash shell on a managed node or on a Tivolimanagement region server. A shell is a command interpreter that enables theoperating system to process commands. You can run commands from a shellcommand line or include them in shell scripts, on either UNIX or WindowsNT/2000 operating systems. A Tivoli management region server is a Tivoli serverand the set of clients commands, you must set the Tivoli environment variablesthat it serves. A Tivoli management region addresses the physical node or Tivoliserver installation process supplies the connectivity of resources whereas a policyregion addresses the logical organization of resources.

Before running Tivoli commands, you must set the Tivoli environment variables forthe shell. The managed node or Tivoli management region server installationprocess supplies the scripts to set the Tivoli environment variables. The followingsections of this guide contain descriptions of the procedures to run these scripts:“Setting the Tivoli environment on UNIX operating systems” on page 3 and“Setting the Tivoli environment on Windows NT/2000 operating systems” onpage 3.

You must also have the appropriate Tivoli authorization role for running eachcommand. Refer to the reference information for each command to see the requiredauthorization role.

© Copyright IBM Corp. 2002 1

Note: A few Tivoli commands can run on an endpoint. To set the Tivolienvironment variables on an endpoint, see “Establishing the Tivolienvironment on an endpoint” on page 3.

Running Tivoli commands on UNIX operating systemsThe UNIX operating systems contain shells. Tivoli commands can run in theBourne, Korn, C, and bash shells. The Bourne shell is the standard UNIX shell.Every UNIX system includes the Bourne shell. The Korn shell supports the featuresof the Bourne shell and has extensions applicable only to the Korn shell. The Cshell name comes from the C programming language syntax. The bash shellsupports many features of the UNIX shells. Both UNIX and Windows NT/2000systems use the bash shell.

Running Tivoli commands on Windows NT/2000 operatingsystems

When you install a Windows NT/2000 managed node or Windows NT/2000 Tivolimanagement region server, the installation process copies the bash shell executablefile to the machine. The bash shell supports many UNIX commands and UNIXcommand syntax. An example is the forward slash (/) for the directory separator.The bash shell supports the features of the Bourne shell plus it has someextensions applicable only to the bash shell.

Note: You can use the Windows NT/2000 MS-DOS shell instead of the bash shellto run most Tivoli commands (after you set the Tivoli environment variableswith the %SystemRoot%\system32\drivers\etc\Tivoli\setup_envcommand). However, some commands and Tivoli tasks may require a bashshell to run successfully. All examples of Tivoli commands in Tivolipublications use bash shell syntax.

Where to find additional information about shellsThe following lists include resources where you can find additional informationabout the various shells. These resources were available at the time the lists werecreated. The lists do not show all of the material that is available, and Tivoli doesnot provide opinions or recommendations about any of these resources.

UNIX shells:

v UNIX in a Nutshell: A Desktop Quick Reference for System V Release 4 and Solaris 7(O’Reilly Nutshell handbook) by Arnold Robbins. ISBN: 1-56592-427-4.

v Portable Shell Programming: An Extensive Collection of Bourne Shell Examples byBruce Blinn. ISBN: 0-13-451494-7.

v Learning the Korn Shell (O’Reilly Nutshell handbook) by Bill Rosenblatt and MikeLoukides. ISBN: 1-56592-054-6.

v UNIX C Shell Desk Reference by Martin Arick. ISBN: 0-47-155680-7.

Bash shell:

v Learning the bash Shell (O’Reilly Nutshell handbook) by Cameron Newham andBill Rosenblatt. ISBN: 1-56592-347-2.

v Bash FAQ (GNU documentation). http://www.delorie.com/gnu/docs/bash/FAQv Bash Reference Manual (GNU documentation).

http://www.gnu.org/manual/bash/index.htmlv bash command reference information (GNU documentation).

http://www.delorie.com/gnu/docs/bash/bash.1.html

2 IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications: Reference Guide

Establishing the Tivoli environment within a shellWhen you install a managed node or Tivoli management region server, theinstallation process supplies shell setup scripts. You use these scripts to set theenvironment variables needed for running Tivoli commands.

Setting the Tivoli environment on UNIX operating systemsThe following steps describe how to set the Tivoli environment within a UNIXshell:1. Log in to a UNIX managed node or Tivoli management region server.2. Run the appropriate setup script for the shell.

For the Bourne, Korn, or bash shell, run the following command:. /etc/Tivoli/setup_env.sh

For the C shell, run the following command:source /etc/Tivoli/setup_env.csh

Setting the Tivoli environment on Windows NT/2000 operatingsystemsThe following steps describe how to set the Tivoli environment and start a bashshell on Windows NT/2000.1. Log in to a Windows NT/2000 managed node or Tivoli management region

server.2. Open a command window.3. Run the following command in the command window to set Tivoli

environment variables:%SystemRoot%\system32\drivers\etc\Tivoli\setup_env.cmd

4. Run one of the following commands in the command window to start the bashshell:sh

—OR—bash

Establishing the Tivoli environment on an endpointWhen you install an endpoint, the installation process supplies setup scripts. Usethese scripts to set the environment variables needed for running Tivoli commandson an endpoint.

The following steps describe how to set the Tivoli environment on an endpoint:1. Log in to an endpoint.2. Open a command window.3. Run the appropriate setup script in the command window. The following table

contains setup scripts for the different endpoint operating systems.

Chapter 1. Introduction 3

Table 1. Setup scripts for endpoint operating systems

OperatingSystem Setup Script Location Setup Script Name

AIX, Solaris /etc/Tivoli/lcf/n

where n is the number of theendpoint.

lcf_env.sh (for Bourne, Korn, andbash shells)

—OR—

lcf_env.csh (for C shell)

WindowsNT/2000

%SystemRoot%\Tivoli\lcf\n

where n is the number of theendpoint.

lcf_env.cmd (for MS-DOS) orlcf_env.sh (for bash shell)

Tivoli command syntaxThe commands in this book use the following special characters to define Tivolicommand syntax:

[ ] Identifies elements that are optional. Required elements do not havebrackets around them.

... Indicates that you can specify multiple values for the previous element.Separate multiple values by a space, unless otherwise directed bycommand information.

If the ellipsis for an element follows a closing bracket, use the syntaxwithin the brackets to specify multiple values. For example, to specify twoadministrators for the option [–a admin]..., use –a admin1 –a admin2.

If the ellipsis for an element is within the brackets, use the syntax of thelast element to specify multiple values. For example, to specify two hostsfor the option [–h host...], use –h host1 host2.

| Indicates mutually exclusive information. You can use the element oneither the left or right of the vertical bar.

{ } Delimits a set of mutually exclusive elements when a command requiresone of them. Include brackets ([ ]) around elements that are optional.

In addition to the special characters, Tivoli command syntax uses the typefaceconventions described in the Preface of this document.

The following examples illustrate the typeface conventions used in Tivolicommand syntax:v wcrtpr [–a admin]... [–s region] [–m resource]... name

The name argument is the only required element for the wcrtpr command. Thebrackets around the options indicate they are optional. The ellipsis after the –aadmin resource option means that you can specify multiple administratorsmultiple times. The ellipsis after the –m resource option means that you canspecify multiple resources multiple times.

v wchkdb [–o outfile] [–u] [–x] {–f infile | –i | object...}The –f, –i, and object elements are mutually exclusive. Braces that surroundelements indicate that you are including a required element. If you specify theobject argument, you can specify more than one object.When you reference an object in a command issued from the command line, thereference is not an absolute object reference like those used in programming.


Instead, a user-friendly name is used. This user-friendly name derives from aname given to the object by the user of the application, such as when a policyregion is created.

Chapter 1. Introduction 5


Chapter 2. Resource models

This chapter contains detailed information about the IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications resource models. IBM TivoliMonitoring for Applications: Siebel eBusiness Applications resource models captureand return information, such as database status and server availability, about aresource or software application in the Tivoli management environment. You canchange many of the settings for a resource model to customize it for yourmonitoring needs.

In this reference guide, a section for each resource model describes theconfiguration of the resource model by covering the following information,including the settings that you can change:

DescriptionPurpose of the resource model and a table that contains an overview of theresource model. The overview table contains the following informationabout the resource model:v Internal name

Name of the resource model as you use it in the command line.v Category

The category for all of the resource models is Siebel.v Indications

List of indications for the resource model. A resource model generates anindication if certain conditions implied by the resource model settingsare not satisfied in a given cycle. The resource model uses an algorithmto determine the combination of settings that generates an indication.

v Tasks and built-in actionsList of tasks and built-in actions for the resource model, if any. For anyevent, recovery actions, such as Tivoli Framework tasks or built-inactions, can be run automatically. The actions can take positive steps toremedy the situation, and can ensure that information about the event isdistributed to the appropriate authorities or entities.

v Default cycle timeSpecifies the default cycle time for the resource model. Cycle time is theduration of the interval within which a resource model gathers data.Each of the resource models supplied with the software has a defaultcycle time, which you can modify according to your needs.

Target managed resourceName of the managed resource (endpoint, server, and so on) to which thisresource model is relevant.

Indications and eventsInformation about all of the indications for the resource model in tableformat and a section of more specific information about each indication.

The table contains the following information for each indication:v Event

An event verifies the persistence of a given indication by eliminatingunrepresentative peaks and troughs for the indication.

v Default severity


Indicates how serious an event is if it is triggered, for example fatal,critical, warning, harmless, or minor.

v Clearing eventsSpecifies whether the resource model has clearing events: Yes or No. Aclearing event is a resource model function that, if enabled, allows IBMTivoli Monitoring to close an error event when the circumstances thatcaused the event are no longer present. Clearing events can be processedby the Tivoli Enterprise Console server and by Tivoli Business SystemsManager.

v PagePage number where the indication is described in this guide.

Each section about a specific indication contains the following information:v When the resource model sends the indication and whyv List of the attributes for the indication and notation regarding which

attributes are keysv Table that describes the following default settings for the indication:

– Send indications to Tivoli Enterprise ConsoleSpecifies whether the resource model sends indications to TivoliEnterprise Console: YES or NO. If YES and Tivoli Enterprise Consoleis installed, IBM Tivoli Monitoring sends indications to TivoliEnterprise Console. If Tivoli Business Systems Manager is installed,Tivoli Enterprise Console sends the indications to Tivoli BusinessSystems Manager.

– Send indications to Tivoli Business Systems ManagerSpecifies whether IBM Tivoli Monitoring sends indications to TivoliBusiness Systems Manager. The default is NO. Do not change theconfiguration of the indication to send events to Tivoli BusinessSystems Manager.

– OccurrencesThe number of occurrences refers to the number of cycles duringwhich an indication occurs for a given resource model.

– HolesThe number of holes refers to the number of cycles during which anindication does not occur for a given resource model. In other words,the number of cycles during which none of the conditions specifiedfor the generation of any indication are met.

– Associated tasks and built-in actionsList of tasks and built-in actions associated with the indication.

ThresholdsList of the thresholds, if any, for the resource model in a table format witha short description and default value for each threshold associated with theresource model. A threshold is a named property of the resource with adefault value that you can modify. Typically, the value of a thresholdrepresents a significant reference level of a performance-related entity,which, if exceeded or not reached, a system administrator might want toknow about.

ParametersList of parameters, if any, for the resource model in a table format with ashort description and default value for each threshold associated with theresource model. A parameter can take the form of a list of strings, a list of


numeric values, a list of predetermined Boolean values from which youcan make any combination of selections, or a choice list of mutuallyexclusive alternatives.

Tasks and built-in actionsList of tasks and built-in actions including a description of each one.

LoggingA table shows the name of the managed resource, context, and propertiesthat the resource model logs with key properties noted. The resourcemodel does not log data by default. You can enable logging to collect datafor any endpoint and write it in a local database. You can store raw oraggregated data and view it through the Web Health Console.

Return codesInformation that the resource model returns such as status or availability.

CLI exampleExample of the syntax for a resource model that illustrates the variableoptions of the wdmeditprf command that are specific to the resourcemodel such as the name of the resource model, thresholds, parameters,parameter values, and events.

See the Working with ITM resource models chapter of the IBM Tivoli Monitoring forApplications, Version 5.1.0: Siebel eBusiness Applications User’s Guide for moreinformation on resource models and resource model procedures.

Table 2 summarizes the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications resource models.

Table 2. Resource models

Resource model name Description

“Siebel Component Availability” on page 10 Monitors a Siebel eBusiness Applicationscomponent to report whether it is up ordown.

“Siebel Component Task Count” on page 14 Counts the number of currently runningtasks for a specified Siebel eBusinessApplications component.

“Siebel Component Tasks Resource Use” onpage 20

Monitors the CPU and memory usage of thetasks running for specified Siebel eBusinessApplications components.

“Siebel Connection Broker Availability” onpage 26

Monitors the Siebel Connection Broker toreport whether it is up or down.

“Siebel Gateway Availability” on page 29 Monitors the Siebel Gateway to reportwhether it is up or down.

“Siebel Server Availability” on page 33 Monitors the Siebel Server to report whetherits state is up, down, or warning.

“Siebel Server File System Directory Size” onpage 39

Monitors the size of the Siebel server filesystem.

“Siebel Server Log File Directory Size” onpage 43

Monitors the size of the directory thatcontains the log files for the Siebel Serverand its associated processes.

“Siebel Server Resource Use” on page 47 Monitors the Siebel Server CPU utilizationand process size.

Chapter 2. Resource models 9

Siebel Component Availability

DescriptionMonitors the availability of Siebel eBusiness Applications components. If a Siebelcomponent is not functioning as defined, Siebel tasks associated with thecomponent cannot start and user service can be interrupted. Run this resourcemodel regularly when your Siebel system must be available to end users. Youmight want to stop this resource model before you bring the Siebel server downfor scheduled maintenance. By default, this resource model runs every threeminutes.

This resource model has an indication that generates an event when a componentlisted in the Running Components parameter is not Running or when acomponent listed in the Online Components parameter is not Online.

Check the Siebel log files for more information indicating why the component isnot Running or Online. See Managing Siebel Logs in the IBM Tivoli Monitoring forApplications, Version 5.1.0: Siebel eBusiness Applications User’s Guide for moreinformation. Correct any problems you discover in the Siebel log and use one ofthe following IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications tasks to reset the component:v “Control_Component_Groups” on page 77v “Run_Srvrmgr_Command” on page 83

Resource model overview

Internal name Siebel_Component_Availability

Category Siebel

Indications The component is not running as desired occurs when amonitored component is not Online or Running.

Tasks and built-in actions None

Default cycle time 180 seconds

Target managed resourceSIEBELServer

Indications and eventsThe following table summarizes the indications for this resource model, the eventsassociated with the indications, the default severity of the events, whether theresource model has clearing events, and where to find a detailed description of theindication. The resource model generates an event based on the settings for theindications. See the Customizing indications procedure in the Working with IBMTivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness ApplicationsUser’s Guide.

Indication Generated event Defaultseverity

Clearingevents

Page

Thecomponent isnot runningas desired

Siebel_Component_RunState_invalid MINOR Yes 11


The component is not running as desired indicationGenerates an event when the monitored component is not Online or Running.When the indication exceeds the specified number of occurrences, the resourcemodel triggers an event. The triggered event delivers a message to the TivoliEnterprise Console in the following format:The Name component is not Running or Online. The state is State.

If you have Tivoli Business Systems Manager configured for your system, TivoliEnterprise Console forwards the message to Tivoli Business Systems Manager.

You can check the health of this resource model in the IBM Tivoli Monitoring WebHealth Console. For more information on the IBM Tivoli Monitoring Web HealthConsole, see the IBM Tivoli Monitoring documentation.

The indication has the following attributes:

EnterpriseNameSpecifies the Siebel enterprise name.

Name Specifies the name of the Siebel component.

RunStateSpecifies the value returned for the state of the component. An examplevalue of RunState is offline.

ServerNameSpecifies the Siebel server name.

State Specifies the value returned for the state of the component. An examplevalue of State is offline.

application_labelSpecifies the label of the SIEBELServer object.

application_versionSpecifies the application version of the SIEBELServer object.

application_oidSpecifies OID (object identifier) of the SIEBELServer object.

application_classSIEBELServer

The following table describes the default settings for this indication.

Setting Default value

Send indications to Tivoli Enterprise Console Yes

Send indications to Tivoli Business SystemsManager

No

Occurrences 1

Holes 0

Associated tasks and built-in actions None.

Note: If you have Tivoli Business Systems Manager configured for your systems,Tivoli Enterprise Console automatically forwards events to Tivoli BusinessSystems Manager. Do not change the configuration of the indications to sendevents to Tivoli Business Systems Manager.


ThresholdsNone.

ParametersThe following table lists the parameters that can be set for the this resource model.The table shows the name, a short description, and the default value for eachparameter:

Parameter Description Default value

RunningComponents

Lists the components that must be in theRunning state for the system to functionproperly.

ServerMgr

Online Components Lists the components that must be in theOnline state for the system to functionproperly.

SRMSynch or ReqProc

Tasks and built-in actionsNone.

LoggingYou can log data for properties of the managed resource that are listed in thefollowing table. The table shows the managed resource, context, and properties forwhich data can be logged.

Managed resource Context Properties

SiebelComponent AvailabilitySiebelServer.EnterpriseName*

Specifies the Siebel enterprise name.

Name* Specifies the name of the componentreferenced.

RunStateSpecifies the value returned for the stateof the component. An example value ofRunState is offline.

SiebelComponentGroup.Name*Specifies the name assigned to the Siebelcomponent group.

SiebelServer.Name*Specifies the name of the Siebel server

Siebel_availability_state_upSpecifies the numeric value representingstate of the component. If thecomponent is in the desired state it is100%. If it is not in the desired state it is0%.

Siebel_availability_state_downSpecifies the numeric value representingstate of down. If the component is in thedesired state it is 0%. If it is not in thedesired state it is 100%.

Note: An asterisk (*) denotes a key property.


Return CodesThe following table lists the return codes displayed in the IBM Tivoli MonitoringWeb Health Console and provides a description of each.

Return code Description Action

0 Conditions are normal. None.

950 The resource model wasdistributed to the wrongtarget managed resource.

Stop the resource model anddistribute it to the correctresource.

610 The server is not running. None. When the serverreturns to a functioning state,the resource model willresume monitoring thecomponents.

1 Required context variablesare not present.

Contact Tivoli Support.

CLI exampleThe following command line example updates the Siebel Component Availabilityresource model model within the specified profile in IBM Tivoli Monitoring. Thisexample configures the resource model to send theSiebel_Component_RunState_invalid event to Tivoli Enterprise Console, but not toTivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Component_Availability -c 180 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-AddPar RunningComponents "ServerMgr" \-AddPar OnlineComponents "SRMSynch" \-AddPar OnlineComponents "ReqProc" \-e Siebel_Component_RunState_invalid \-o 1 -h 0 -severity MINOR -NoSendTBSM -SendTec


Siebel Component Task Count

DescriptionCounts the number of currently running tasks for specified Siebel components. If atask stops that is configured to run continuously, the number of component taskscurrently running might fall below the specified threshold. If a Siebel componenttask that runs in response to a client session continues running when the usersession terminates, the number of running tasks might exceed the specifiedthreshold. Run this resource model regularly when you configured components torun a minimum number of tasks or when you want to prevent components fromrunning too many tasks. Do not run this resource model when the Siebel server isdown for scheduled maintenance. By default, this resource model runs every threeminutes.

Indications for this resource model generate events when the number of Siebelcomponent tasks currently running is higher or lower than the correspondingthreshold.

Check the Siebel log files for more information indicating why the number ofrunning Siebel tasks is too high or too low. See Managing Siebel Logs in the IBMTivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness Applications User’sGuide for more information. Correct any problems you discover in the Siebel logand if necessary, stop and restart the Siebel task or the Siebel server. See thefollowing tasks for more information:v “Control_Siebel_Tasks” on page 79v “Stop_Siebel_Server” on page 92v “Start_Siebel_Server” on page 87


Internal name Siebel_Component_Task_Count

Category Siebel

Indications Siebel Component Tasks Too High occurs when the numberof currently running Siebel component tasks exceeds thespecified threshold.

RunningTasks too low occurs when the number of runningSiebel component tasks is lower than the specified threshold.


Default cycle time 180 Seconds





Clearingevents

Page

SiebelComponentTasks TooHigh

SiebelComponent_RunningTasks_ Too_High WARNING Yes 15

RunningTasks TooLow

SiebelComponent_RunningTasks_Too_Low

WARNING Yes 16

Siebel Component Tasks Too High indicationGenerates an event when the number of currently running Siebel component tasksexceeds the Siebel High Running Tasks threshold. When the indication exceeds thespecified number of occurrences, the resource model triggers an event. Thetriggered event delivers a message to the Tivoli Enterprise Console in the followingformat:

The number of tasks running for component Name is too high. There areRunningTasks running and the threshold is TskCntMax.






ServerNameSpecifies the name of the Siebel server

RunningTasksSpecifies the number of tasks running.

TaskCntMaxSpecifies the allowed number of running tasks. Numeric value.


application_oidSpecifies the OID (object identifier) of the SIEBELServer object.

application_labelSpecifies the label applied to the SIEBELServer object.








No

Occurrences 2

Holes 1



RunningTasks too low indicationGenerates an event when the number of running Siebel component tasks is lowerthan the Running Tasks lower bound threshold. When the indication exceeds thespecified number of occurrences, the resource model triggers an event. Thetriggered event delivers a message to the Tivoli Enterprise Console in the followingformat:

The number of tasks running for component Name is too low. There areRunningTasks running tasks running and the threshold is LowerBound.





LowerBoundSpecifies the threshold by which lowest number of currently running tasksis measured.













No

Occurrences 2

Holes 1



ThresholdsThe following table lists the thresholds that can be set for the Siebel ComponentTask Count resource model. For each threshold it shows the name, a shortdescription, and the default value:

Threshold Description Defaultvalue

Siebel High RunningTasks

Specifies the highest number of tasks that a Siebelcomponent can run. The resource modelgenerates an event when the specified thresholdis exceeded for the number of tasks that a Siebelcomponent can run.

2

RunningTasks lowerbound

Specifies the least number of tasks that a Siebelcomponent must run. The resource modelgenerates an event when the specified thresholdfalls below the least number of tasks that a Siebelcomponent must run.

5

ParametersThe following table lists the parameters that can be set for the Siebel ComponentTask Count resource model. The table shows the name, a short description, and thedefault value for each parameter:

Parameter Description Defaultvalue

Component Names HighLimit

Lists the names of the components to monitor fortoo many running tasks. Each component ischecked against the threshold and an indicationis raised when the number of running tasks ishigher than the specified number.

(Emptystring list)

Components to Monitorfor minimum task count

Lists the names of the components to monitor fortoo few running tasks. Each component ischecked against the threshold and an indicationis raised when the number of running tasks islower than the specified number.

Listcontainingthe valueServerMgr





SiebelComponent AvailabilityComponentGroupName

Specifies the name assigned to the Siebelcomponent group name.

SiebelServerEnterpriseName*Specifies the name assigned to the Siebelenterprise

Name* Specifies the name assigned to the Siebelcomponent


SiebelComponentGroup.Name*Specifies the name assigned to the Siebelcomponent group name.

SiebelComponent.Name*Specifies the name assigned to the Siebelcomponent

Siebel_Component_Task_Maximum_ExceededNumber of tasks greater than thethreshold that are running for thiscomponent or 0 if the number is lessthan or equal to the threshold.

ServerNameSpecifies the name of the Siebel server

SiebelServer.Name*Specifies the name of the Siebel server

TaskCntMaxThreshold for the maximum number oftasks allowed to run for this component.




0 Conditions are normal None.





610 Server is not running None. When the serverreturns to a functioning state,the resource model willresume monitoring thecomponents.



CLI exampleThe following command line example updates the Siebel Component Task Countresource model model within the specified profile in IBM Tivoli Monitoring. Thisexample configures the resource model to send theSiebel_Component_Tasks_Too_High event to Tivoli Enterprise Console, but not toTivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Component_Task_Count -c 600 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-t Siebel_Low_Running_Tasks 5.000000 \-t Siebel_High_Running_Tasks 2.000000 \-AddPar Component_Low_Names "ServerMgr" \-e Siebel_Component_Tasks_Too_High \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec \-e SiebelComponent_RunningTasks_too_low \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec


Siebel Component Tasks Resource Use

DescriptionMonitors the CPU and memory usage of the tasks running for specifiedcomponents. A Siebel Component task that uses more memory or processing thanthe specified limit can indicate the following:v Not enough memory or processing resources for the number of users accessing

them.v A problem with the component task itself.

Run this resource model regularly when your Siebel system must be available toend users. You might want to stop this resource model before you bring the Siebelserver down for scheduled maintenance. By default, this resource model runsevery three minutes.

This resource model has an indication that generates an event when a task uses toomuch memory or when the task processing usage exceeds the specified threshold.

Check the Siebel log files for more information indicating why a component taskexceeded the specified memory and processing usage thresholds. See ManagingSiebel Logs in the IBM Tivoli Monitoring for Applications, Version 5.1.0: SiebeleBusiness Applications User’s Guide for more information. Correct any problems youdiscover in the Siebel log and if necessary, stop and restart the Siebel task or theSiebel server. See the following tasks for more information:v “Control_Siebel_Tasks” on page 79v “Stop_Siebel_Server” on page 92v “Start_Siebel_Server” on page 87


Internal name Siebel_Component_Tasks_Resource_Use

Category Siebel

Indications Siebel Task Max Memory Exceeded indication measuresSiebel component task’s memory usage and generates anevent when that usage exceeds the specified threshold.

Siebel Task CPU Utilization High indication measuresSiebel component task’s CPU usage and generates an eventwhen that usage exceeds the specified threshold.







Clearingevents

Page

Siebel Task MaxMemoryExceeded

Siebel_TaskMemoryHigh WARNING Yes 21

Siebel Task CPUUtilization High

Siebel_TaskCPUHigh WARNING Yes 22

Siebel Task Max Memory Exceeded indicationGenerates an event when a task uses more memory than the specified TaskMemory Usage threshold. When the indication exceeds the specified number ofoccurrences, the resource model triggers an event. The triggered event delivers amessage to the Tivoli Enterprise Console in the following format:The Siebel Component ComponentName task TaskName is using SiebelMemoryUsageMB memory. The maximum allowed is ProcessSizeThreshold MB.




ComponentNameSpecifies the name of the Siebel component.

EnterpriseNameSpecifies the enterprise name.

MemMaxSpecifies the maximum amount of memory allowed for a task inmegabytes.

ServerNameSpecifies the name of the Siebel server.

Siebel_Memory_UsageSpecifies the amount of memory the task is using in megabytes.

TaskNameSpecifies the numeric identifier of the Siebel task.

application_classSpecifies the application class of the SIEBELServer object.

application_labelSpecifies the label applied to SIEBELServer object.


application_versionSIEBELServer






No

Occurrences 2

Holes 1

Associated tasks and built-in actions None


Siebel Task CPU Utilization High indicationGenerates an event when the Siebel Server processing usage exceeds the Task CPUUsage threshold. When the indication exceeds the specified number of occurrences,the resource model triggers an event. The triggered event delivers a message to theTivoli Enterprise Console in the following format:

The TaskName task of component ComponentName is using Siebel_CPU_usage cpu.The maximum allowed is CPUMax threshold percent.




ComponentNameSpecifies the name of the Siebel component.

CPUMaxMaximum percentage CPU amount allowed for a task.


Siebel_CPU_usageSpecifies the percentage of CPU the task uses.


TaskNameSpecifies the name of the Siebel task.










No

Occurrences 2

Holes 1



ThresholdsThe following table lists the thresholds that can be set for the Siebel ComponentTasks Resource Usage resource model. For each threshold it shows the name, ashort description, and the default value:


Task CPU usage Specifies the maximum percentage of CPU a taskis allowed to use.

80

Task Memory Usage Specifies the maximum amount of memory a taskis allowed to use in megabytes.

20

ParametersThe following table lists the parameters that can be set for the Siebel ComponentTasks Resource Usage resource model. The table shows the name, a shortdescription, and the default value for each parameter:

Parameter Description Default value

List ofComponents

Lists the components for whichmemory and CPU are monitored.

String list of components thatcan be ServerMgr, SRMSynch,or ReqProc





SiebelComponent UtilizationCPUMax

Specifies the amount of memory a taskis allowed to use.

SiebelServer.EnterpriseName*Specifies the name assigned to the Siebelenterprise.

MemMaxSpecifies the Siebel_Server maximumprocess size

SiebelComponent.Name*Specifies the name of the Siebelcomponent.

SiebelComponentGroup.Name*Specifies the name assigned to the Siebelcomponent group

Siebel_CPU_usageSpecifies the percentage of memory atask is allowed to use.

Siebel_memory_usageSpecifies the Siebel Server process size.

SiebelServer.Name*Specifies the name assigned to the Siebelserver

Name* Specifies the name of the specific taskbeing referenced










CLI exampleThe following command line example updates the Siebel Component TasksResource Use resource model model within the specified profile in IBM TivoliMonitoring. This example configures the resource model to send the


Siebel_TaskMemoryHigh and Siebel_TaskCPUHigh events to Tivoli EnterpriseConsole, but not to Tivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Component_Tasks_Resource_Use -c 600 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-t Siebel_High_TaskCPUusage 80.000000 \-t Siebel_High_TaskMemoryUsage 20.000000 \-AddPar ComponentList "ServerMgr" \-AddPar ComponentList "SRMSynch" \-AddPar ComponentList "ReqProc" \-e Siebel_TaskMemoryHigh \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec \-e Siebel_TaskCPUHigh \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec


Siebel Connection Broker Availability

DescriptionMonitors the Siebel Connection Broker to report whether it is up or down. Whenthe Siebel Connection Broker is down, it is unavailable to process user requests.Run this resource model regularly when your Siebel system must be available toend users. Do not run this resource model when the Siebel environment is downfor scheduled maintenance. By default, this resource model runs every threeminutes.

This resource model has an indication that generates an event if the SiebelConnection Broker is down. When the status of the Connection Broker changes, theConnection Broker object icon is updated to reflect the current status.

Check the Connection Broker log files for more information indicating why theConnection Broker went down. See Managing Siebel Logs in the IBM TivoliMonitoring for Applications, Version 5.1.0: Siebel eBusiness Applications User’s Guide formore information on viewing logs. Correct any problems you discover in the logfiles. Restart the Connection Broker first and then restart the Siebel servers. See thefollowing tasks for more information on starting and stopping the Siebel Serverand starting the Connection Broker:v “Start_Connection_Broker” on page 85v “Stop_Siebel_Server” on page 92v “Start_Siebel_Server” on page 87


Internal name Siebel_ConnectionBroker_Availability

Category Siebel

Indications Siebel Connection Broker Down occurs when theConnection Broker is down.



Target managed resourceSIEBELBroker



Clearingevents

Page

SiebelConnectionBrokerDown

Siebel_ConnectionBroker_Down CRITICAL Yes 27


Siebel Connection Broker Down indicationGenerates an event when the Connection Broker is down. When the indicationexceeds the specified number of occurrences, the resource model triggers an event.The triggered event delivers a message to the Tivoli Enterprise Console in thefollowing format:

The Name Connection Broker is State.




EnterpriseNameSpecifies the name of the Siebel enterprise.

Name Specifies the name of the Connection Broker.

State Specifies the value returned for the state of the server. For instance up ordown.

application_classSIEBELBroker

application_labelSpecifies the label applied to SIEBELBroker object

application_oidSpecifies the OID (object identifier) of the SIEBELBroker object.

application_versionSpecifies the application version of the SIEBELBroker object.





No

Occurrences 1

Holes 0

ThresholdsNone.

ParametersNone.





SiebelConnectionBroker AvailabilityEnterpriseName*

Specifies the name assigned to the Siebelenterprise.

HostNameSpecifies the name assigned to the Siebelhost

Name* Specifies the name of the specific entitybeing referenced

Siebel_availability_state_downSpecifies the numeric value representingthe down state. If the value is 100, thestate is down. if the value if 0, the state isnot down.

Siebel_availability_state_upSpecifies the numeric value representingthe up state. If the value is 100, the state isup. if the value if 0, the state is not up.

State Specifies the state reported by the dataprovider









CLI exampleThe following command line example updates the Siebel Connection BrokerAvailability resource model model within the specified profile in IBM TivoliMonitoring. This example configures the resource model to send theSiebel_ConnectionBroker_Down event to Tivoli Enterprise Console, but not toTivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_ConnectionBroker_Availability -c 300 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-e Siebel_ConnectionBroker_Down \-o 1 -h 0 -severity CRITICAL -NoSendTBSM -SendTec


Siebel Gateway Availability

DescriptionMonitors the Siebel Gateway to verify whether it is up or down. The SiebelGateway serves as a single entry point for accessing the Siebel Application serversand stores component definitions and assignments, operational parameters andconnectivity information. When the Siebel Gateway is down, the informationstored in the Gateway is not available to the Siebel Server and end user service canbe interrupted. Run this resource model regularly when your Siebel system mustbe available to end users. You might want to stop this resource model beforebringing the Siebel gateway down for scheduled maintenance. By default, thisresource model runs every three minutes.

This resource model has an indication that generates an event if the SiebelGateway is down. When the Siebel Gateway status changes, the Siebel Gatewayobject icon on the Tivoli desktop is updated to reflect the current status.

Check the Siebel Gateway log files for more information indicating why theGateway went down. See Managing Siebel Logs in the IBM Tivoli Monitoring forApplications, Version 5.1.0: Siebel eBusiness Applications User’s Guide for moreinformation on viewing logs. Correct any problems you discover in the log filesand restart the Gateway first and then restart the Siebel servers. See the followingtasks for more information:v “Start_Siebel_Gateway” on page 86v “Stop_Siebel_Server” on page 92v “Start_Siebel_Server” on page 87


Internal name Siebel_Gateway_Availability

Category Siebel

Indications Siebel Gateway Down occurs when theGateway is down.

Tasks and built-in actions None.


Target managed resourceSIEBELGateway

Indications and eventsThe following table lists the events that the Siebel Gateway Availability resourcemodel can generate. These include the name of the indication from which eachevent is generated, the default severity of the event, and the location of a detaileddescription.


Clearingevents

Page

State Gateway Down Siebel_Gateway_Down CRITICAL Yes 30


Siebel Gateway Down indicationGenerates an event when the Gateway is down. When the indication exceeds thespecified number of occurrences, the resource model triggers an event. Thetriggered event delivers a message to the Tivoli Enterprise Console in the followingformat:

The Gateway Name is State.




EnterpriseNameSpecifies the enterprise name.

Name Specifies the name of the Siebel Gateway.

State Specifies the value returned for the state of the gateway. For instance, upor down.

application_classSIEBELGateway

application_labelSpecifies the label applied to SIEBELGateway.

application_oidSpecifies the OID (object identifier) of the SIEBELGateway object.

application_versionSpecifies the application version of the SIEBELGateway.





No

Occurrences 1

Holes 0



ThresholdsNone.


ParametersNone.




SiebelGateway AvailabilityEnterpriseName*

Specifies the name assigned tothe Siebel enterprise

HostNameSpecifies the name assigned tothe Siebel host

Name* Specifies the name of the specificentity being referenced

Siebel_availability_state_downSpecifies the numeric valuerepresenting the down state. Thevalue 100% represents that thestate is down. 0% represents thatthe state if not down.

Siebel_availability_state_upSpecifies the numeric valuerepresenting the up state. Thevalue 100% represents that thestate is up. 0% represents that thestate is not up.

State Specifies the state reported bythe data provider










CLI exampleThe following command line example updates the Siebel Gateway Availabilityresource model model within the specified profile in IBM Tivoli Monitoring. Thisexample configures the resource model to send the Siebel_Gateway_Down event toTivoli Enterprise Console, but not to Tivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Gateway_Availability -c 300 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-e Siebel_Gateway_Down \-o 1 -h 0 -severity CRITICAL -NoSendTBSM -SendTec


Siebel Server Availability

DescriptionMonitors the Siebel Server to report whether the state of the server is up, down, orwarning. If the server is up, this resource model checks to see if it is runningproperly. Run this resource model regularly when your Siebel system must beavailable to end users. You might want to stop this resource model before youbring the Siebel server down for scheduled maintenance. If you run this resourcemodel when you intend for the server to be down, the resource modelunnecessarily generates the Siebel_Server_State_Down event and attempts torestart the server. By default, this resource model runs every three minutes.

If the Siebel server is not returning expected data, user service might beinterrupted. If the Siebel server is down, it is not available to end users. Thisresource model has an indication that generates an event if the Siebel server isdown or not functioning properly. When the status of the server changes, theserver object icon on the Tivoli desktop is updated to reflect the changed status.

If the Siebel server is not returning expected data, run the Run Srvrmgr Commandtask with the list servers attribute to verify the state of the server. See“Run_Srvrmgr_Command” on page 83 for more information.

If the Siebel server is down, check the Siebel log files for more informationindicating why the Siebel Server went down. See Managing Siebel Logs in the IBMTivoli Monitoring for Applications, Version 5.1.0: Siebel eBusiness Applications User’sGuide for more information on viewing Siebel logs. Correct any problems youdiscover in the Siebel log and restart the Siebel server. You can run the Start SiebelServer task to bring the server back up. See “Start_Siebel_Server” on page 87 formore information.


Internal name Siebel_Server_Availability

Category Siebel

Indications Siebel Server is down occurs when the Server is notavailable.

Siebel server is degraded occurs the Siebel server is runningbut is not functioning properly.

Tasks and built-in actions Start_Siebel_Server task



Indications and eventsThe following table lists the events that the Siebel Server Availability resourcemodel can generate, the name of the indication from which each event isgenerated, the default severity of the event, and the location of a detaileddescription.



Clearingevents

Page

Siebel Server is down Siebel_Server_State_Down CRITICAL Yes 34

Siebel Server isdegraded

Siebel_Server_State_Warning MINOR Yes 35

Siebel Server is down indicationGenerates an event when the Siebel server is down. This resource modeldetermines the server is down when the srvrmgr command does not return therunning status for the server and the Siebel process is not running.

When the indication exceeds the specified number of occurrences, the resourcemodel triggers an event. The triggered event delivers a message to the TivoliEnterprise Console in the following format:

The Siebel server Name is down. The Siebel Server state is State.





Name Specifies the name of the Siebel Server.

ServerNameSpecifies the name of the Siebel Server.

State Specifies the value returned for the state of the server. For instance,running or down.


application_oidSpecifies the OID, or object identifier, of the SIEBELServer object.

application_classSIEBELServer.




Send indications to Tivoli Enterprise Console yes


no

Occurrences 1

Holes 0





Siebel Server is degraded indicationGenerates an event when the Siebel Server state is up but the srvrmgr commandcan not connect to it. When the indication exceeds the specified number ofoccurrences, the resource model triggers an event. The triggered event delivers amessage to the Tivoli Enterprise Console in the following format:

The Siebel Server Name is degraded. The state is State.





Name Specifies the name of the Siebel server.


State Specifies the value returned for the state of the server. For instance,running or down.



application_oidSpecifies the OID, or object identifier, of the SIEBELServer object.






No

Occurrences 1

Holes 0

Associated tasks and built-in actions Yes



ThresholdsNone.

ParametersThe following table lists the parameters that can be set for the Siebel ServerAvailability resource model. The table shows the name, a short description, and thedefault value for each parameter:

Parameter Description Defaultvalue

Values that areconsidered Down

Lists the values that indicate the server is down. Down

Values that areconsidered Running

Lists the values that indicate the server isrunning.

Running

Values indicatingWarning State

Lists the values that indicate that the server isfunctioning, but the srvrmgr command cannotconnect to it.

Warning

Tasks and built-in actionsThe following table lists the indications that trigger tasks or built-in actions, andwhere to find more information about those tasks or built-in actions.

Indication Task/Built-in action

Siebel Server is down “Start_Siebel_Server” on page 87




SiebelServer AvailabilityEnterpriseName*

Specifies the name assigned to theSiebel enterprise.

Name* Specifies the name of the specificentity being referenced.

Siebel_availability_state_downSpecifies the numeric valuerepresenting the down state. Thevalue 100% indicates the downstate. 0% indicates the state is notdown.

Siebel_availability_state_upSpecifies the numeric valuerepresenting the up state. Thevalue 100% indicates the up state.0% indicates the state is not up.

Siebel_availability_state_warningSpecifies the numeric valuerepresenting the warning state. Thevalue 100% indicates the warningstate. 0% indicates the state is notwarning.

Siebel_availability_state_ unknownSpecifies the numeric valuerepresenting unknown availabilitystat. The value 100% indicates theunknown state. 0% indicates thestate is not unknown.

State Specifies the reported state of theserver.

Version The version of the Siebel server.









CLI exampleThe following command line example updates the Siebel Server Availabilityresource model model within the specified profile in IBM Tivoli Monitoring. This


example configures the resource model to send the Siebel_Server_State_Down andSiebel_Server_State_Warning events to Tivoli Enterprise Console, but not to TivoliBusiness Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Server_Availability -c 300 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-AddPar WarningStateValues "Warning" \-AddPar DownStateValues "DOWN" \-AddPar RunningStateValues "Running" \-e Siebel_Server_State_Down \-o 1 -h 0 -severity CRITICAL -NoSendTBSM -SendTec \-e Siebel_Server_State_Warning \-o 1 -h 0 -severity MINOR -NoSendTBSM -SendTec


Siebel Server File System Directory Size

DescriptionMonitors the size of the Siebel server file system. The Siebel server file system is ashared directory that stores compressed files used by Siebel applications, includingcorrespondence, presentations, and files attachments. The Siebel server file systemcan fill up the directory and cause problems in your Siebel system. Use thisresource model to monitor the file system size. Run this resource model regularlywhen your Siebel system must be available to end users. You might want to stopthis resource model before you bring the Siebel server down for scheduledmaintenance. By default, this resource model runs every five minutes.

This resource model has an indication that generates an event if the Siebel ServerFile System Directory Size exceeds the specified threshold.

When this resource model indicates that the file system directory size exceeded thepredefined threshold, you can allocate additional space for the Siebel Server filesystem directory. Refer to your Siebel eBusiness Applications documentation formore information.


Internal name Siebel_Server_FileSystemSize

Category Siebel

Indications FileSystemSize too high occurs when the file systemdirectory size exceeds the specified threshold.






Clearingevents

Page

FileSystemSize toohigh

Siebel_Server_FileSystemSize_too_high WARNING No 39

FileSystemSize too high indicationGenerates an event when the size of the Siebel file system exceeds the valuespecified for the FileSystemSize upper bound threshold. When the indicationexceeds the specified number of occurrences, the resource model triggers an event.The triggered event delivers a message to the Tivoli Enterprise Console in thefollowing format:


The Siebel Server Name file system FileSystem is too large. FileSystemSizeMB is greater than UpperBound MB.




FileSystemSizeSpecifies the size of the Siebel file system directory in MB.



FileSystemThe name of the Siebel file system.

UpperBoundSpecifies the maximum size of the Siebel file system directory in MB.

Name Specifies the the name of the Siebel server.



application_oidSpecifies the the OID (object identifier) of the SIEBELServer object.






No

Occurrences 3

Holes 0




ThresholdsThe following table lists the thresholds that can be set for the Siebel Server FileSystem Directory Size resource model. For each threshold it shows the name, ashort description, and the default value:


FileSystemSizeupper bound

Specifies the size limit in megabytes that thedirectory containing the Siebel file system cannotexceed.

1,000

ParametersNone.




SiebelServer UtilizationEnterpriseName*


FileSystemSizeSpecifies the size of the file system.

HostNameSpecifies the name assigned to the Siebelhost.

Name* Specifies the name of the specific entitybeing referenced.

UpperBoundSpecifies the maximum size of the Siebelfile system directory.










CLI exampleThe following command line example updates the Siebel Server File SystemDirectory Size resource model model within the specified profile in IBM TivoliMonitoring. This example configures the resource model to send theSiebel_Server_FileSystemSize_too_high event to Tivoli Enterprise Console, but notto Tivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Server_FileSystemSize -c 900 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-t Siebel_High_FileSystemSize 1000 \-e Siebel_Server_FileSystemSize_too_high \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec


Siebel Server Log File Directory Size

DescriptionMonitors the size of the Siebel log file directory. Because each user session createslog files that consume directory space, the log file directory can fill up and causeproblems in your Siebel system. Use this resource model to check the log filedirectory size. Run this resource model regularly when your Siebel system must beavailable to end users. You might want to stop this resource model before youbring the Siebel server down for scheduled maintenance. By default, this resourcemodel runs every five minutes.

This resource model has an indication that generates an event if the Siebel Serverlog file directory size exceeds the specified threshold.

When this resource model indicates that the log file directory size is too high youcan do one of the following to correct the problem:v Delete log files to free up space. See Managing Siebel Logs in the IBM Tivoli

Monitoring for Applications, Version 5.1.0: Siebel eBusiness Applications User’s Guidefor more information.

v Allocate additional space for the directory.v Alter the Siebel configuration to create fewer or smaller log files.

See the IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications User’s Guide for more information.


Internal name Siebel_Server_LogFilesSize

Category Siebel

Indications LogFileSystemSize too high occurs when the log filedirectory size exceeds the specified threshold.






Clearingevents

Page

LogFileSystemSize toohigh

Siebel_Server_LogFileSystemSize_too_high WARNING Yes 44


LogFileSystemSize too high indicationGenerates an event when the size of the Siebel Server log file directory exceeds thevalue specified for the LogFileSystemSize upper bound threshold. When theindication exceeds the specified number of occurrences, the resource model triggersan event. The triggered event delivers a message to the Tivoli Enterprise Consolein the following format:

The Siebel Server Name log file directory LogFileSystem is too large.LogFileSystemSize MB is greater than UpperBound MB.





LogFileSystemSpecifies the directory containing the Siebel log files.

LogFileSystemSizeSpecifies the size of the Siebel Log file directory in MB.

Name Specifies the the name of the Siebel server.

ServerNameSpecifies the name of the Siebel server name.

UpperBoundSpecifies the maximum size of the Siebel Log file directory in MB.



application_oidSpecifies the the OID (object identifier) of the SIEBELServer object.






No

Occurrences 3

Holes 0




ThresholdsThe following table lists the thresholds that can be set for the Siebel Server LogFile Directory Size resource model. For each threshold it shows the name, a shortdescription, and the default value:


LogFileSystemSizeupper bound

Specifies the size limit in megabytes that thedirectory containing the log files cannot exceed.

500

ParametersNone.




SiebelServer UtilizationEnterpriseName*


HostNameSpecifies the name assigned to the Siebelhost.

Name* Specifies the name of the Siebel server.

LogFileSystemSizeSpecifies the size in megabytes of thedirectory containing Siebel log files.

UpperBoundSpecifies size in megabytes that thedirectory containing the log files can notexceed.











CLI exampleThe following command line example updates the Siebel Server Log File DirectorySize resource model model within the specified profile in IBM Tivoli Monitoring.This example configures the resource model to send theSiebel_Server_LogFileSystemSize_too_high event to Tivoli Enterprise Console, butnot to Tivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Server_LogFilesSize -c 900 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-t Siebel_High_LogFileSystemSize 500 \-e Siebel_Server_LogFileSystemSize_too_high \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec


Siebel Server Resource Use

DescriptionMonitors the Siebel Server CPU utilization and process size. A Siebel server thatuses more memory or processing than the specified threshold can indicate thefollowing:v Not enough memory or processing resources for the number of users accessing

them.v A problem with the server itself.

Run this resource model regularly when your Siebel system must be available toend users. You might want to stop this resource model before you bring the Siebelserver down for scheduled maintenance. If you run this resource model when youintend for the server to be down, the resource model unnecessarily generatesevents. By default, this resource model runs every three minutes.

This resource model has an indication that generates an event when the Siebelserver CPU utilization exceeds a specified percent of the processor or when aSiebel process exceeds a specified size.

Check the log files for more information indicating why the Siebel server exceededthe specified memory and processing usage thresholds. See Managing Siebel Logsin the IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications User’s Guide for more information. Correct any problems you discoverin the Siebel log and if necessary, stop and restart the Siebel server. You can use thefollowing tasks to stop and restart the Siebel server:v “Stop_Siebel_Server” on page 92v “Start_Siebel_Server” on page 87


Internal name Siebel_Server_Resource_Use

Category Siebel

Indications SiebelServer High CPU utilization occurs when CPU usageexceeds the specified threshold.

SiebelServer Max Process Size Exceeded occurs whenprocess sizes exceed the specified threshold.


Default cycle time 180 Seconds





Clearingevents

Page

SiebelServerHigh CPUutilization

Siebel_Server_CPU WARNING Yes 48

SiebelServerMax ProcessSize Exceeded

Siebel_Server_ProcessSize WARNING Yes 49

SiebelServer high CPU utilization indicationGenerates an event when CPU usage exceeds the Maximum Allowed CPU Percentthreshold. When the indication exceeds the specified number of occurrences, theresource model triggers an event. The triggered event delivers a message to theTivoli Enterprise Console in the following format:

The Siebel Server Name exceeded the allowed processor utilization. It isusing Siebel_CPU_usage percent of the processor. The maximum allowed isCPUMax percent.




CPUMaxThe Maximum percentage of the CPU the Siebel server is allowed to use.


Name Specifies the name assigned to the Siebel Server.

Siebel_CPU_usageSpecifies the percentage of CPU utilized by the Siebel server.

ServerNameSpecifies the name assigned to the Siebel Server.




application_versionSpecifies the application version SIEBELServer object.







No

Occurrences 2

Holes 1



SiebelServer Max Process Size Exceeded indicationGenerates an event when the size of the Siebel Server process exceeds theMaximum Allowed Process Size threshold. When the indication exceeds thespecified number of occurrences, the resource model triggers an event. Thetriggered event delivers a message to the Tivoli Enterprise Console in the followingformat:

The Siebel Server Name process is too big. The size is Siebel_memory_usageMB. The maximum allowed is MemMax MB.





MemMaxSpecifies the maximum size of the Siebel server process in MB.

Name Specifies the name assigned to the Siebel Server.

Siebel_Memory_UsageSpecifies the amount of memory in MB used by the server process.

ServerNameSpecifies the name assigned to the Siebel Server.










No

Occurrences 2

Holes 1



ThresholdsThe following table lists the thresholds that can be set for theSiebel_Server_Resource_Use resource model. For each threshold it shows the name,a short description, and the default value:


Maximum allowedprocess size

Specifies the maximum size in megabytesallowed for the Siebel Server process.

10

Maximum allowed CPUPercent

Specifies the maximum percent of CPU the serverprocess can use.

70

ParametersNone.





Siebel Server UtilizationCPUMax

Specifies the maximum allowed percentof CPU the process can use.

EnterpriseName*Specifies the name assigned to the Siebelenterprise.

Host Specifies the name assigned to the Siebelhost.

MemMaxSpecifies the maximum allowed size ofthe process.

Name* Specifies the name of the specific entityreferenced.

Siebel_CPU_UsageSpecifies the actual percent of CPU theprocess uses.

Siebel_Memory_UsageSpecifies the actual size of the process.

Version Specifies the version of Siebel server.










CLI exampleThe following command line example updates the Siebel Server Resource Useresource model model within the specified profile in IBM Tivoli Monitoring. Thisexample configures the resource model to send the Siebel_Server_CPU event toTivoli Enterprise Console, but not to Tivoli Business Systems Manager.wdmeditprf -P $PROFILE -add Siebel_Server_Resource_Use -c 600 \-Log -LogDisable -p 12:00 -Agg no -ap 00:15 -NoMin -NoMax -Avg \-t Siebel_High_MemoryUsage 10.00 \-t Siebel_High_CPUusage 70.000000 \-e Siebel_Server_ProcessSize \


-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec \-e Siebel_Server_CPU \-o 1 -h 0 -severity WARNING -NoSendTBSM -SendTec


Chapter 3. IBM Tivoli Monitoring for Applications: SiebeleBusiness Applications task libraries

The IBM Tivoli Monitoring for Applications, version 5.1.0: Siebel eBusinessApplications task libraries contain a set of predefined Siebel tasks. A task is anoperation or set of operations that is performed routinely, such as starting andstopping Siebel servers, connection brokers, and gateways, or running the srvrmgrcommand directly from the product. Running, scheduling, or automaticallyexecuting these predefined tasks helps ease the overall management workload inyour Siebel environment. The Siebel tasks are grouped into the following threelibraries based on function:v Siebel Event Tasksv Siebel Operational Tasksv Siebel Utility Tasks

This chapter provides information on the following topics:v “Running tasks” on page 53v “Task authorization roles” on page 54

See the Working with Tasks and Jobs chapter of the IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications User’s Guide for more information onrunning and customizing tasks. Refer to the IBM Tivoli Management FrameworkReference Manual for information on the wruntask command.

Running tasksYou can run the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications tasks from the Tivoli command line, from the Tivoli desktop, or froman IBM Tivoli Monitoring for Applications, version 5.1.0: Siebel eBusinessApplications monitoring source. See the IBM Tivoli Monitoring for Applications,Version 5.1.0: Siebel eBusiness Applications User’s Guide for information about runningtasks from the desktop and monitoring source. For additional information aboutusing the wruntask command, see the Tivoli Management Framework ReferenceManual.

The section for each task describes how to configure and run each task by coveringthe following information:

DescriptionPurpose of the task.

Authorization roleRole required to run the task.

Target managed resourceThe Tivoli resource to which the task is distributed.

GUI data entry fieldsDesktop fields to specify arguments for the task.


CLI syntaxSyntax for the wruntask command that you use to run every task from thecommand line. All tasks that you run from the command line contain thefollowing syntax:wruntask -t <"Task Name"> -l <"Task Library Name"> -h <"Object Name"> \-a <"Additional Parameters">

where:

-t <Task Name>Name of the task to run.

-l <Task Library Name>Name of the task library that contains the task.

-h <Object Name>Name of the object about which the task gathers data.

-a <Additional Parameters>Additional parameters for the task, such as Date or DatabaseName. Some of the additional parameters might be required andsome might be optional. The parameters must be typed in theorder in which they appear in the syntax. If you do not want tospecify a parameter, use empty quotation marks like the following:-a ""

Use quotation marks around the name of a variable that contains spaces.

CLI exampleThe example for the task contains a brief description of the example andan example of the syntax, such as the following:

The task in the following example stops the server siebel03 in the SiebelOperational Tasks library:wruntask-t Stop_Siebel_Server-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@siebel03-a "y"

Usage notesAdditional notes relevant to using the task.

See the Working with Tasks and Jobs chapter of the IBM Tivoli Monitoring forApplications, Version 5.1.0: Siebel eBusiness Applications User’s Guide for moreinformation on creating task libraries, tasks, and jobs.

Task authorization rolesTasks run from the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications task libraries are controlled by the authorization roles. Table 3 lists theSiebel roles and what they authorize.

Table 3. Siebel authorization roles

Role Authorization

siebel_senior Configuration authority including discovery.

siebel_admin General management authority includingpotentially disruptive actions such asstopping servers or deleting debug logs.


Table 3. Siebel authorization roles (continued)

Role Authorization

siebel_user General view privileges, but no potentiallydisruptive actions.

Chapter 3. IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications task libraries 55


Chapter 4. Siebel Event Tasks

The Siebel Event Tasks task library contains a set of predefined Siebel tasks. Atask is an operation or set of operations that is performed routinely.

This chapter includes the following information:v Tasks listed by GUI name and CLI namev A description of each task in the task library

Refer to the IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications User’s Guide for information on running tasks.

Refer to the Tivoli Management Framework Reference Manual for information on thewruntask command.

List of Siebel Event Tasks by GUI and CLI NamesThe following table lists the tasks by their GUI and CLI names.

GUI Name CLI Name

Configure_Event_Server Configure_Event_Server

Configure_Logfile_Broker_Message Formats Configure_Logfile_Broker_Message_ Formats

Control_Logfile_Adapter Control_Logfile_Adapter

Configure_Logfile_Server_Message Formats Configure_Logfile_Server_Message_ Formats

TBSM_Discover TBSM_Discover


Configure_Event_Server

DescriptionProvides Tivoli Enterprise Console configuration options. Using this task, you cando the following:v Clone a Tivoli Enterprise Console rule base.v Import the Siebel baroc files and rules.v Import the Tivoli Business Systems Manager rules when appropriate.v Compile the rule base.v Load the rule base.v Restart the event server.

If the class and rule set definitions are not already defined in the specified rulebase, this task adds the class and rule set definitions of the selected configurationoption to a valid rule base. For detailed information , see the IBM Tivoli Monitoringfor Applications, Version 5.1.0: Siebel eBusiness Applications User’s Guide.

The following software must be installed before you run this task:v Tivoli Enterprise Console Event Serverv IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications (which

you must install on the Tivoli management region server where you want to runthis task)

Authorization rolesenior

Target managed resourceTivoli Enterprise Console server (Managed node)


GUI data entry fieldsThe following shows the Configure_Event_Server dialog; a description of eachfield follows.

where:

Rule Base ConfigurationThis group of fields enables you to specify the type of rule baseconfiguration to be done. You can create a new rule base or update anexisting rule base. This can be the new name for a rule base that you wantto create or the name of an existing rule base. If you check the UpdateExisting Rule Base box, Configure_Event_Server checks to make sure bothits class and rule set files are defined correctly. A rule base consists of a setof expressions (rule set files) used by the event server to determine if anevent meets the rule conditions. The rules may also define a set of actionsthat are taken when an event meets the specified rule conditions.

Update Existing Rule BaseSpecifies that you want to update an existing rule base. You must select therule base to be updated from the Rule Bases field. You cannot update thedefault rule base.

Create New Rule Base from ExistingSpecifies that you want to create a new rule base, but that you want thatrule base to be initialized with a copy of an existing rule base. You musttype the name of the new rule base in the New Rule Base Name field, andyou must type the path to the new rule base in the New Rule Base Pathfield. You must select the initializing rule base from the Rule Bases field.

Create New Rule BaseSpecifies that you want to create a new rule base but that you do not want

Chapter 4. Siebel Event Tasks 59

that rule base to be initialized with an existing rule base. You must typethe name of the new rule base in the New Rule Base Name field, and youmust type the path to the new rule base in the New Rule Base Path field.You cannot select a rule base in the Rule Bases field.

Rule BasesLists the existing rule bases. You can select one rule base from this listwhen you check the Update Existing Rule Base or when you check theCreate New Rule Base from Existing box.

New Rule Base NameSpecifies the name of a new rule base in this field. If you type the name ofan existing rule base, this task issues a message and it does not update theexisting rule base.

New Rule Base PathSpecifies the path in which you want to create the new rule base. The taskappends the name of the new rule base, as typed in the New Rule BaseName field, to this field value to determine the complete path of the newrule base.

Rule Base ActivationThe following Rule Base Activation selections enable you to control whenyour updated rule base becomes active.

Compile Rule Base OnlyEnables you to create or update the rule base, but the new rulebase is not loaded into the event server. This option is useful if youwant to review rule base changes before activating them or tocreate the rule base in preparation for later activation.

Compile and Load Rule Base OnlyEnables you to create or update the rule base, import rules andclasses, and load a new rule base. The new rule base is activewhen you restart the event server.

Compile, Load Rule Base and Restart ServerEnables you to create or update the rule base, import rules andclasses, load a new rule base, and restart the server.

Set and ExecuteConfigures the event server.

CLI syntaxConfigure_Event_Server–a {CREATE | CLONE | UPDATE}–a <clonerulebasename>–a <newrulebasename>–a <newrulebasepath>–a {LOADONLY | RESTART | “” }

where:

CREATECreates a new rule base.

CLONECopies an existing rule base.

UPDATEUpdates a current rule base.


<clonerulebasename>Specifies the name of the rule base you are copying.

<newrulebasename>Specifies the name of the new rule base you are creating.

<newrulebasepath>Specifies the path of the rule base. The default is tec_install_location.

LOADONLYCreates or updates the rule base, imports rules and classes, and loads anew rule base. The new rule base is active when you restart the eventserver.

RESTARTCreates or updates the rule base, imports rules and classes, loads a newrule base, and restarts the server.

“” Creates or updates the rule base, imports rules and classes, and compilesthe rule base.

CLI examplewruntask-t Configure_Event_Server-l "Siebel Event Tasks"-h @ManagedNode:nemuchay-a CLONE-a Default-a Siebel-a /opt/tivoli/bin/aix4-r/TME/TEC-a LOADONLY

Usage notesThis task generates the following trace log file on the Tivoli Enterprise Consoleserver for debug purposes:$DBDIR/GMS/logs/trace_siebel_config_evtsvr.log

See alsoThe following commands are documented in the Tivoli Management FrameworkReference Manual: wruntask, wcrtjob and wgettask.


Configure_Logfile_Broker_Message_Formats

DescriptionInstalls or uninstalls message formats in the Tivoli Enterprise Console LogfileAdapter format file for the Siebel Broker. The Tivoli Logfile Adapter reads log filemessages and forwards them to the Tivoli Enterprise Console. Examples of thetype of messages the Logfile Adapter forwards to the Tivoli Enterprise Consoleinclude messages logged as a result of a broker starting or stopping. The TivoliEnterprise Console Logfile Adapter format file must be updated to include theConnection Broker message formats so it can generate events for ConnectionBroker log messages. After installing or uninstalling the messages, the TivoliLogfile Adapter does the following:v generates a new Class Definition statement file for the adapter.v updates the adapter configuration file with the name of the log file to be

monitored.v stops and restarts the adapter if it is currently running.

See IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications User’s Guidefor more information on installing the log file adapter message formats.

The adapter forwards connection broker log messages from the following log file:<ConnectionBrokerInstallDirectory>/log/agent-dir.<hostname>/agent-log

where:

<ConnectionBrokerInstallDirectory>Specifies the directory where the Connection Broker was installed.

<hostname>Specifies the name of the machine on which the connection broker isinstalled.

The following software must be installed before you run this task:v Tivoli Enterprise Console Event Serverv Tivoli Enterprise Console Adapter Configuration Facility

Refer the IBM Tivoli Monitoring for Applications: Siebel eBusiness ApplicationsUser’s Guide for more information on the Tivoli Enterprise Console.

Authorization rolesiebel_senior



GUI data entry fieldsThe following shows the Configure_Logfile_Broker_Message_Formats dialog; adescription of each field follows.

where:

Install Message FormatsThis option loads the message formats for the Connection Broker into theTivoli Logfile Adapter, regenerates the Class Definition statement file, andrestarts the adapter if it is running.

Uninstall Message FormatsThis option removes the message formats for the Connection Broker fromthe Tivoli Logfile Adapter, regenerates the Class Definition statement file,and restarts the adapter if it is running.

CLI syntaxConfigure_Logfile_Broker_Message_Formats–a {INSTALLBROKER | UNINSTALLBROKER}

where:

INSTALLBROKERLoads the message formats for the Connection Broker into the TivoliLogfile Adapter, regenerates the Class Definition statement file, and restartsthe adapter if it is running.

UNINSTALLBROKERRemoves the message formats for the Connection Broker from the TivoliLogfile Adapter regenerate the Class Definition statement file and restartsthe adapter if it is running.

CLI examplewruntask-t Control_Logfile_Broker_Message_Formats-l "Siebel Event Tasks"-h @SIEBELBroker:Broker@pinball-a INSTALLBROKER

Usage notesThis task generates the following trace log files on the endpoint for debugpurposes:


$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_broker_ \install_message_formats_xxx.log$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_broker_ \uninstall_message_formats_xxx.log



Configure_Logfile_Server_Message_Formats

DescriptionInstalls or uninstalls message formats in the Tivoli Enterprise Console LogfileAdapter format file for the Siebel Server. The Tivoli Logfile Adapter reads log filemessages and forwards them to the Tivoli Enterprise Console. Examples of thetype of messages the Logfile Adapter forwards to the Tivoli Enterprise Consoleinclude messages logged as a result of a broker starting or stopping.

The Tivoli Enterprise Console Logfile Adapter format file must be updated toinclude the Siebel Server message formats so the Tivoli Logfile Adapter cangenerate events for Siebel Server log messages. After the messages are installed oruninstalled, the Tivoli Logfile Adapter does the following:v generates a new Class Definition statement file for the adapter.v updates the adapter configuration file with the name of the log file to be

monitored.v stops and restarts the adapter if it is currently running.

The log files to be monitored for NT and Unix are, respectively:

NT <$SIEBELROOT>/log/<enterprisename>.<servername>.log

Unix <$SIEBELROOT>/enterprises/<enterprisename> /<servername>/log/<enterprisename>.<servername>.log

where:

enterprisenameSpecifies the Siebel enterprise.

servernameSpecifies the Siebel server running on the Siebel enterprise.

The following software must be installed before you run this task:v Tivoli Enterprise Console Event Serverv Tivoli Enterprise Console Logfile Adapter





GUI data entry fieldsThe following shows the Configure_Logfile_Server_Message_Formats dialog; adescription of each field follows.

where:

Install Message FormatsLoads the message formats for the Siebel Server into the Tivoli LogfileAdapter, regenerates the Class Definition statement file, and restarts theadapter if it is running.

Uninstall Message FormatsRemoves the message formats for the Siebel Server from the Tivoli LogfileAdapter, regenerates the Class Definition statement file, and restarts theadapter if it is running.

CLI syntaxConfigure_Logfile_Server_Message_Formats–a {INSTALLSERVER | UNINSTALLSERVER}

where:

INSTALLSERVERLoads the message formats for the Siebel Server into the Tivoli LogfileAdapter, regenerate the Class Definition statement file, and restart theadapter if it is running.

UNINSTALLSERVERRemoves the message formats for the Siebel Server from the Tivoli LogfileAdapter, regenerate the Class Definition statement file, and restart theadapter if it is running.

CLI examplewruntask-t Control_Logfile_Server_Message_Formats-l "Siebel Event Tasks"-h @SIEBELServer:server@siebel@pinball-a INSTALLSERVER


Usage notesDo not run the Configure_Logfile_Server_Message_Formats task against more thanone Siebel server on the same endpoint because the task supports forwarding ofevents from a single Siebel server on an endpoint.

This task generates the following trace log files on the endpoint for debugpurposes:

$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_server_ \install_message_formats_xxx.log$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_server_ \uninstall_message_formats_xxx.log



Control_Logfile_Adapter

DescriptionStarts, stops or returns the status of the Tivoli Logfile Adapter on an endpoint. TheTivoli Logfile Adapter reads log file messages and forwards them to the TivoliEnterprise Console. Examples of the type of messages the Logfile Adapterforwards to the Tivoli Enterprise Console include messages logged as a result of abroker starting or stopping.

Note: When you stop the Tivoli Logfile Adapter, it does not forward log messagesfrom any logs for which the adapter was configured.

The following software must be installed before you run this task:v Tivoli Enterprise Console Event Serverv Tivoli Enterprise Console Adapter Configuration Facility


Authorization rolesiebel_senior or siebel_admin

Target managed resourceEndpoint

GUI data entry fieldsThe following shows the Control_Logfile_Adapter dialog; a description of eachfield follows.

where:

Status Returns the status of the Tivoli Logfile Adapter. The status indicates thatthe Tivoli Logfile Adapter is either running or not running.

Start Starts the Tivoli Logfile Adapter.

Stop Stops the Tivoli Logfile Adapter.


CLI syntaxControl_Logfile_Adapter–a {STATUS | START | STOP}

where:

STATUSReturns the status of the Tivoli Logfile Adapter. The status indicates thatthe Tivoli Logfile Adapter is either running or not running.

STARTStarts the Tivoli Logfile Adapter.

STOP Stops the Tivoli Logfile Adapter.

CLI examplewruntask-t Control_Logfile_Adapter-l "Siebel Event Tasks"-h @Endpoint:pinball-a STATUS

Usage notesThis task generates the following trace log files on the endpoint for debugpurposes:

$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_adapter_status_.log

$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_adapter_start_.log

$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_logfile_adapter_stop_.log



TBSM_Discover

DescriptionSends a DISCOVER event to Tivoli Business Systems Manager for each Siebelserver, gateway and connection broker that IBM Tivoli Monitoring for Applications:Siebel eBusiness Applications discovers (or is currently managing). For anyresources that were removed since the last time this task was run, this task sends aGONE event to Tivoli Business Systems Manager. If the task completessuccessfully, you receive a list of resources for which DISCOVER and GONEevents were sent to Tivoli Business Systems Manager.

You must install the Tivoli Enterprise Console Event Server software must bebefore you run this task.

For more information on discovery or Tivoli Business Systems Manager, see theIBM Tivoli Monitoring for Applications: Siebel eBusiness Applications User’s Guide.


Target managed resourceTivoli Enterprise Console server (managed node)

GUI data entry fieldsNone

CLI syntaxTBSM_Discover

CLI examplewruntask-t TBSM_Discover-l "Siebel Event Tasks"-h nemuchay

Usage notesThis task generates the following trace log files on the Tivoli Enterprise Consoleserver for debug purposes:$DBDIR/GMS/logs/trace_siebel_tbsm_discover.log



Chapter 5. Siebel Operational Tasks

The Siebel Operational Tasks task library contains a set of predefined Siebel tasks.A task is an operation or set of operations that is performed routinely.

This chapter includes the following information:v Tasks listed by GUI name and CLI namev Task dialogs used by all tasksv A description of each task in the task library

Refer to the IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications User’sGuide for information on running tasks.


List of Siebel Operational Tasks by GUI and CLI NamesThe following table lists the tasks by their GUI and CLI names.

GUI Name CLI Name

Archive_Siebel_Logs Archive_Siebel_Logs

Check_Server_Status Check_Server_Status

Control_Component_Groups Control_Component_Groups

Control_Siebel_Tasks Control_Siebel_Tasks

Run_List_Command Run_List_Command

Run_Srvrmgr_Command Run_Srvrmgr_Command

Start_Connection_Broker Start_Connection_Broker

Start_Siebel_Gateway Start_Siebel_Gateway

Start_Siebel_Server Start_Siebel_Server

Stop_Connection_Broker Stop_Connection_Broker

Stop_Siebel_Gateway Stop_Siebel_Gateway

Stop_Siebel_Server Stop_Siebel_Server


Archive_Siebel_Logs

DescriptionEnables administrators to do the following:v View a listing of the archived Siebel Server log directories.v Tar, compress, and remove old Siebel log archive directories.

This task enables a Siebel administrator to store old Siebel log archive directories.For example, you can tar, compress, and move the log files to a different filesystem.

For more information, see the IBM Tivoli Monitoring for Applications, Version 5.1.0:Siebel eBusiness Applications User’s Guide.

Before you run this task, you must install IBM Tivoli Monitoring for Applications,version 5.1.0: Siebel eBusiness Applications on the Tivoli Management Regionserver of the Tivoli Management Region from which you want to run this task.



GUI data entry fieldsThe following shows the Archive_Siebel_Logs dialog; a description of each fieldfollows.

where:

List Log ArchivesLists the log archive directories with their size in kilobytes, the timestampon the directory, and the free space on the file system containing the logarchives in kilobytes.

Create ArchiveCreates an archive file. When you select this option, you must also specifythe following:


Archive directory/filenameSpecifies the directory and filename where the archive log file iscreated. Examples:C:/temp/archive or/opt/oldlogs/siebellogs.tar.Z If you only specify a file, such as″name.tar.Z″, the file is created in the logarchive directory. You donot have to specify ″.tar.Z″ on the archive filename. The currenttime and date is appended to the name of the file that you specify.

Archive Age ’x’Specify an integer that is equal to the number of log archivedirectories you want to add to the archive file and delete from theSiebel Server log archive directory. The number specified must beless than or equal to the present number of archived Siebel Serverlog directories.

CLI syntaxArchive_Siebel_Logs–a {list | archive}–a <archive_file_name>–a <minimum_age_of_dirs_to_archive>

where:

list Lists the log archive directories along with their size in kilobytes, thetimestamp on the directory, and the free space on the file systemcontaining the log archives in kilobytes.

archive Creates an archive file. If you select this option, you must also specify thefollowing:

archive_dir_file_nameSpecifies the directory and filename where the archive log file iscreated. Examples:C:/temp/archive or/opt/oldlogs/siebellogs.tar.Z If you only specify a file, such as″name.tar.Z″, the file is created in the logarchive directory. You donot have to specify ″.tar.Z″ on the archive filename. The currenttime and date is appended to the name of the file that you specify.

minimum_age_of_dirs_to_archiveSpecifies an integer that is equal to an age

CLI exampleThe following example creates the file /tmp/archive_200204160823.tar.Z. It containsany log archive directories from the Siebel Server named server in enterpriseenterprise that are 4 days old or older. The archived directories are removed fromthe Siebel Server’s ″logarchive″ directory.wruntask-t Archive_Siebel_Logs-l "Siebel Operational Tasks"-h @SIEBELServer:server@enterprise@hostname-a archive-a /tmp/archive-a 4

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_archive_logs_xxx.log

Chapter 5. Siebel Operational Tasks 73

See alsoThe following commands in the Tivoli Management Framework Reference Manual:wruntask, wcrtjob and wgettask.


Check_Server_Status

DescriptionReturns the status of the Siebel Server, Gateway Server, or Siebel ConnectionBroker. The status returned depends on which object you run the task against.Table 4 provides a summary of returned object status and recommended action.

Table 4. Siebel Object Status

Siebel Object Status/Recommended Action

SIEBELBrokerUP Available to process user requests.

DOWNUnavailable to process userrequests. Check the ConnectionBroker log files for moreinformation indicating why theConnection Broker went down.Correct any problems you discoverin the Connection Broker log andrestart the Connection Broker,gateway and the Siebel server asnecessary.

SIEBELGatewayUP Available as the single entry point

for accessing the Siebel Applicationserver and storing informationneeded by end users

DOWNUnavailable to end users. Check theSiebel Gateway log files for moreinformation indicating why theGateway went down. Correct anyproblems you discover in the Siebelgateway log, and restart theGateway and, if necessary restartthe Siebel server.

SIEBELServerUp Available to end users.

Down Unavailable to end users. Check theSiebel log files for more informationindicating why the Siebel Serverwent down, correct any problemsand restart the server.

WarningThe Siebel server is up, but notfunctioning properly. Run theRun_Srvrmgr_Command task withthe list servers attribute to verifythe state of the server. See“Run_Srvrmgr_Command” on page83 for more information.

When the status of an object changes, this task also updates the associated icon toreflect the object’s current status.


Authorization rolesiebel_senior, siebel_admin, or siebel_user

Target managed resourceSIEBELServer, SIEBELBroker, SIEBELGateway

GUI data entry fieldsNone.

CLI syntaxCheck_Server_Status

CLI examplewruntask-t Check_Server_Status-l "Siebel Operational Tasks"-h @SIEBELBroker:Broker@pinball

Usage notesThis task generates the following trace log files on the endpoint for debugpurposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_check_gateway_status_xxx.log$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_check_broker_status_xxx.log$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_check_server_status_xxx.log

See also“Siebel Connection Broker Availability” on page 26, “Siebel Gateway Availability”on page 29, “Siebel Server Availability” on page 33.


Control_Component_Groups

DescriptionAllows a component group to be brought online or taken offline. A Siebelcomponent is an executable program on a Siebel Server that performs a specificfunction or job, such as importing and exporting data or configuring the databaseto monitor for user-defined conditions. A Siebel Component Group is a collectionof one or more Siebel components. If a component, or component group is offline,it is unavailable to end users.



GUI data entry fieldsThe following shows the Control_Component_Groups dialog; a description ofeach field follows.

where:

OnlineBrings a Siebel component group on a Siebel server online.

OfflineTakes a Siebel component group on a Siebel server offline.

Component Group AliasSpecifies the alias of a Siebel Component Group. The Component GroupAlias is case senstitive.

CLI syntaxControl_Component_Groups–a {online | offline}–a <componentgroupname>

where:

online Brings a Siebel component group on a Siebel server online.


offlineTakes a Siebel component group on a Siebel server offline.

componentgroupnameSpecifies the alias of a Siebel Component Group.

CLI examplewruntask-t Control_Component_Groups-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball-a online-a componentgroupname

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_control_compgrps_xxx.log

See alsoSee “Siebel Component Availability” on page 10 for information on checkingavailability of a Siebel component.

The following commands in the Tivoli Management Framework Reference Manual:wruntask, wcrtjob and wgettask.


Control_Siebel_Tasks

DescriptionStarts, stops, pauses and resumes Siebel tasks. The following are some examples ofwhen you might want to run this task:v The Siebel Component Task Count resource model indicates that the number of

Siebel component tasks currently running is too high. Use this task to stop aSiebel component task that ran in response to a client session but continuedrunning when the user session terminated.

v The Siebel Component Tasks Resource Use resource model indicates a problemwith a Siebel component task that is using too much memory or processingresources. Use this task to stop the Siebel component task so you can fix theproblem. Then use this task to restart the Siebel component task.



GUI data entry fieldsThe following shows the Control_Siebel_Tasks dialog; a description of each fieldfollows.

where:

Pause Pauses a running task.

ResumeResumes a paused task.

Start Starts a new task as an instance of the specified component.

Stop Stops a running task.

Task NumberSpecifies the task number for the running task. This option is required forthe Pause, Resume, and Stop options and is valid only for these options.


Start Component NameSpecifies the name of the component to start as a task. This function isrequired for the Start option and is valid only for this option.

Start Task ParametersSpecifies the parameters for the task. This function is valid only for theStart option.

CLI syntaxControl_Siebel_Tasks–a {pause | resume| start| stop }–a <TaskNumber>| ″″–a <TaskName>| ″″–a <TaskParameters>| ″″

where:

pause Pauses a running task.

resumeResumes a paused task.

start Starts a new task as an instance of the specified component.

stop Stops a running task.

TaskNumberSpecifies the task number for the running task. This option is required forthe pause, resume, and stop options and is valid only for these options.

TaskNameSpecifies the name of the component to start as a task. This function isrequired for the Start option and is valid only for this option.

TaskParametersSpecifies the parameters for the task. This function is valid only for thestart option.

CLI examplewruntask-t Control_Siebel_Tasks-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball-a stop-a 1234

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_control_tasks_xxx.log

See alsoThe following resource models: “Siebel Component Task Count” on page 14 and“Siebel Component Tasks Resource Use” on page 20.



Run_List_Command

DescriptionLists current data for components, component groups, or Siebel tasks for a Siebelserver. You might use this task to verify what tasks are running on a Siebel server.



GUI data entry fieldsThe following shows the Run_List_Command dialog; a description of each fieldfollows.

where:

ComponentsLists the current components defined for the Siebel server.

Component GroupsLists the current component groups defined for the Siebel server.

Tasks Lists current data about tasks for a Siebel server.

CLI syntaxRun_List_Command–a {components | compgrps | tasks }

where:

componentsLists the current components defined for the Siebel server.

compgrpsLists the current component groups defined for the Siebel server.

tasks Lists current data about tasks for a Siebel server.


CLI examplewruntask-t Run_List_Command-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball-a components

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_run_list_xxx.log



Run_Srvrmgr_Command

DescriptionRuns any valid srvrmgr command, such as list servers and enablecompgrpcomponent_group, from the Siebel command line interface on a Siebelserver. The Siebel help command lists all available commands.



GUI data entry fieldsThe following shows the Run_Srvrmgr_Command dialog; a description of eachfield follows.

where:

Svrmgr CommandSpecifies any valid command string that can be executed at the srvrmgrprompt

CLI syntaxRun_Srvrmgr_Command–a <SrvrmgrCommand>

where:

SrvrmgrCommandSpecifies any valid command string that can be executed at the srvrmgrprompt

CLI examplewruntask-t Run_Srvrmgr_Command-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball-a "list servers"


Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_run_srvrmgr_xxx.log



Start_Connection_Broker

DescriptionStarts the specified Siebel Connection Broker and updates the broker object icon.The Connection Broker is the Resonate Central Dispatch Agent and is an optionalservice for the Siebel server. The advantages of using the Siebel Connection Brokerinclude the following:v High availability – clients do not depend on the availability of any one specific

Siebel server.v Scalability – load is distributed evenly across multiple Siebel Servers within an

Enterprise, making full use of available resources.

If the Siebel Connection Broker goes down, the Siebel Connection BrokerAvailability resource model can notify the Siebel administrator with a message sentto the Tivoli Enterprise Console. When the Siebel Connection Broker is down, it isunavailable to process user requests. You can use this task to bring the SiebelConnection Broker back up.




CLI syntaxStart_Connection_Broker

CLI examplewruntask-t Start_Connection_Broker-l "Siebel Operational Tasks"-h @SIEBELBroker:Broker@pinball

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_start_broker_xxx.log

See alsoThe following resource model: “Siebel Connection Broker Availability” on page 26.



Start_Siebel_Gateway

DescriptionStarts the specified Siebel Gateway and updates the gateway object icon. The SiebelGateway serves as a single entry point for accessing the Siebel Application Serverand stores component definitions and assignments, operational parameters andconnectivity information.

If the Siebel Gateway goes down, the Siebel Gateway Availability resource modelcan notify the Siebel administrator with a message sent to the Tivoli EnterpriseConsole. When the Siebel Gateway is down, the information stored in the Gatewayis not available to the Siebel Server and end user service can be interrupted. Youcan use this task to bring the Siebel Gateway back up.




CLI syntaxStart_Siebel_Gateway

CLI examplewruntask-t Start_Siebel_Gateway-l "Siebel Operational Tasks"-h @SIEBELGateway:Gateway@pinball

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_start_gateway_xxx.log

See alsoThe following resource model: “Siebel Gateway Availability” on page 29



Start_Siebel_Server

DescriptionStarts the specified Siebel Server on an endpoint and updates the server objecticon. Siebel servers manage business data and provide batch and interactiveservices for clients.

If the Siebel server is not functioning properly or if it goes down, the Siebel ServerAvailability resource model can notify the Siebel administrator with a message sentto the Tivoli Enterprise Console. End user service is interrupted when the Siebelserver is down or not functioning properly. You can use this task to start the Siebelserver.




CLI syntaxStart_Siebel_Server

CLI examplewruntask-t Start_Siebel_Server-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_start_server_xxx.log

See alsoThe following resource model: “Siebel Server Availability” on page 33.



Stop_Connection_Broker

DescriptionStops the specified Siebel Connection Broker and updates the broker object icon.Connection Brokering, the Resonate Central Dispatch Agent, is an optional servicefor the Siebel Server. The advantages of using the Siebel Connection Broker includethe following:v High availability – clients do not depend on the availability of any one specific

Siebel server.v Scalability – load is distributed evenly across multiple Siebel Servers within an

Enterprise, making full use of available resources.

When you run this task, you stop any gateways and servers running on the samesystem as the specified Connection Broker.



GUI data entry fieldsThe following shows the Stop_Connection_Broker dialog; a description of eachfield follows.

where:

Yes Confirms that you want to run the task to stop the specified Siebel Brokers.

No Cancels the request to stopping the specified Siebel Brokers.

CLI syntaxStop_Connection_Broker–a {y | n}

where:

y Confirms that you want to stop the specified Siebel Brokers.

n Cancels the request to stop the specified Siebel Brokers.


CLI examplewruntask-t Stop_Connection_Broker-l "Siebel Operational Tasks"-h @SIEBELBroker:Broker@pinball-a "y"

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_stop_broker_xxx.log



Stop_Siebel_Gateway

DescriptionStops the specified Siebel Gateway and updates the gateway object icon. The SiebelGateway serves as a single entry point for accessing the Siebel Application Serverand stores component definitions and assignments, operational parameters, andconnectivity information. You might want to stop a gateway for scheduledmaintenance. When you stop a Siebel Gateway, the Siebel servers using thegateway cannot access the information stored in the Gateway and those SiebelServers are not accessible to end users.



GUI data entry fieldsThe following shows the Stop_Siebel_Gateway dialog; a description of each fieldfollows.

where:

Yes Confirms running of the task stopping the Siebel Gateway targeted.

No Cancels running of the task stopping the Siebel Gateway targeted.

CLI syntaxStop_Siebel_Gateway–a {y | n}

CLI examplewruntask-t Stop_Siebel_Gateway-l "Siebel Operational Tasks"-h @SIEBELGateway:Gateway@pinball-a "y"


Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_stop_gateway_xxx.log



Stop_Siebel_Server

DescriptionStops the specified Siebel Server and updates the server object icon. Siebel serversmanage business data and provide batch and interactive services for clients. Youcan use this task to stop the Siebel server if the Siebel Server Availability indicatesthe server is not functioning properly so you can correct any problems and restartthe server. Use this task when you want to stop the Siebel server for maintenance.



GUI data entry fieldsThe following shows the Stop_Siebel_Server dialog; a description of each fieldfollows.

where:

Yes Confirms that you want to stop the specified the Siebel servers.

No Cancels the request to stop the specified Siebel servers targeted.

CLI syntaxStop_Siebel_Server–a {y | n}

where:

y Confirms that you want to stop the specified Siebel servers.

n Cancels the request to stop the specified Siebel server.


CLI examplewruntask-t Stop_Siebel_Server-l "Siebel Operational Tasks"-h @SIEBELServer:Server@enterprise@pinball-a "y"

Usage notesThis task generates the following trace log file on the endpoint for debug purposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_stop_server_xxx.log




Chapter 6. Siebel Utility Tasks

The Siebel Utility Tasks task library contains a set of predefined Siebel tasks. A taskis an operation or set of operations that is performed routinely.

This chapter includes the following information:v Tasks listed by GUI name and CLI namev Task dialogs used by all tasksv A description of each task in the task library

Refer to the IBM Tivoli Monitoring for Applications, Version 5.1.0: Siebel eBusinessApplications User’s Guide for information on running and customizing tasks.


List of Siebel Utility Tasks by GUI and CLI NamesThe following table lists the tasks by their GUI and CLI names.

GUI Name CLI Name

Delete_Endpoint_Utilities Delete_Endpoint_Utilities

Discover Discover


Delete_Endpoint_Utilities

DescriptionRemoves the Siebel dependencies and log files placed on the endpoint by the IBMTivoli Monitoring for Applications: Siebel eBusiness Applications software. Usetask when you no longer want to manage Siebel eBusiness Applications on theendpoint.


Target managed resourceEndpoint

GUI data entry fieldsThe following shows the task dialog; a description of each field follows.

where:

Yes Confirms deleting the endpoint utilities.

No Cancels deleting the endpoint utilities.

CLI syntaxDelete_Endpoint_Utilities–a {y | n}

where:

y Confirms deleting the endpoint utilities.

n Cancels deleting the endpoint utilities.

CLI examplewruntask-t Delete_Endpoint_Utilities-l "Siebel Utility Tasks"-h @EndPoint:pinball-a y


Usage notesThis task generates the following trace log files on the endpoint for debugpurposes:$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_delete_utils.log

See alsoYou can refer to the following commands in the Tivoli Management FrameworkReference Manual: wruntask, wcrtjob and wgettask.

Chapter 6. Siebel Utility Tasks 97

Discover

DescriptionLocates Siebel servers, gateways, and connection brokers that you want to managewith IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications. Thesoftware captures the server configuration information, and configures it as anobject. When the software discovers a server it can manage, it creates an object andicon for it. The software subscribes each discovered object to a profile manager. Forexample, if the software discovers a gateway, that gateway is subscribed to theSiebel Gateways profile manager.

IBM Tivoli Monitoring for Applications: Siebel eBusiness Applications sets the stateof the discovered object as UP, DOWN, or WARNING. When you run theDiscover task, it runs on a managed node against an endpoint. When you run thetask, you must specify the managed node on which the task is to run and theendpoints against which you want to run the task. When you run a Discover job,the managed node has already been specified in the definition of the job; youspecify the endpoints against which you want to run the task.


Target managed resourceTivoli management region server

GUI data entry fieldsThe following shows the task dialog; a description of each field follows.

where:

Endpoint NamesSpecifies one or more endpoints where discovery is to be run. This field isrequired.

Siebel Administrator User NameSpecifies the name of the administrative userid to initiate server


management commands and queries with the srvrmgr command. Anexample of a user name might be sadmin. This field is required.

Siebel Administrator PasswordSpecifies the Administrator password. This password is encrypted andstored for use by the tasks and resource models that invoke the srvrmgrcommand. This field is required.

Managed Node NameSpecifies the managed node on which you want to create the TivoliSIEBELServer, SIEBELBroker, or SIEBELGateway objects. By default, thismanaged node is the one currently hosting the Tivoli gateway managingthe specified endpoint. If you want to override this default assignment,you can select the Tivoli managed node on which you want the object tobe created.

Siebel Server PathSpecifies the directory path $SIEBEL_ROOT where the Siebel Server isinstalled. The following are examples of specified paths:

/siebel/siebsrvr

/sea621/siebsrvr

This field is required for Unix endpoints and ignored for Windowsendpoints. The registry is used to obtain information about the Siebelserver for Windows endpoints.

Siebel Gateway PathSpecifies the directory path $SIEBEL_ROOT where the Siebel Gateway isinstalled. The following are examples of specified paths:

/siebel/gtwysrvr

/sea621/gtwysrvr

This field is required for Unix endpoints and ignored for Windowsendpoints. The registry is used to obtain information about the Siebelgateway for Windows endpoints.

CLI syntaxDiscover

–a <Endpoint>–a <SiebelAdministratorUserName>–a <SiebelAdministratorPassword>–a <ManagedNodeName>–a <ServerPath>–a <GatewayPath>

where:

Server PathSpecifies the directory path $SIEBEL_ROOT where the Siebel Server isinstalled. The following are examples of specified paths:

/siebel/siebsrvr

/sea621/siebsrvr

This field is required for Unix endpoints and ignored for Windowsendpoints. The registry is used to obtain information about the Siebelserver for Windows endpoints.

Chapter 6. Siebel Utility Tasks 99

Gateway PathSpecifies the directory path $SIEBEL_ROOT where the Siebel Gateway isinstalled. The following are examples of specified paths:

/siebel/gtwysrvr

/sea621/gtwysrvr

This field is required for Unix endpoints and optional for Windowsendpoints. The registry is used to obtain information about the Siebelgateway for Windows endpoints.

Endpoint NamesSpecifies one or more endpoints on which to run discovery This field isrequired.

Siebel User NameSpecifies the name of the administrative userid to initiate servermanagement commands and queries with the srvrmgr command. Anexample of a user name might be sadmin. This field is required.

Siebel Administrator PasswordSpecifies the administrative password. This field is required.

CLI examplewruntask-t Discover-l "Siebel Utility Tasks"-h @ManagedNode:nemuchay-a pinball siebelsun-a /opt/siebel/server-a pinball-a SUSER-a SPASSWORD

Usage notesThis task generates the following trace log files for debug purposes:

(created on the managed node)$DBDIR/GMS/logs/trace_siebel_discover.log

(created on the endpoint)$LCF_DATDIR/LCFNEW/GMS/logs/trace_siebel_discover_ep.log

See alsoFor more information on discovering objects, see the IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications User’s Guide.

You can refer to the following commands in the Tivoli Management FrameworkReference Manual: wruntask, wcrtjob and wgettask.


Chapter 7. wsiebel Command

You can use the wsiebel command to create, view, or delete Siebel objects. Whenyou create a Siebel object, it is added as a subscriber to a profile manager in theMonitoring for Siebel policy region by default. For instance, Siebel Gatewayobjects are subscribed to the Siebel Gateways profile manager. You can specify amanaged node where you want to create the object. If you do not specify amanaged node, the object is created on the managed node acting as the TivoliGateway for the specified endpoint.

When you use the wsiebel command to create objects, the object creation is notautomatically verified. You must verify object creation manually. However, whenyou use the Discover task or run the Discover_Job to create Siebel objects, objectcreation is verified automatically. See Discovering Objects in the IBM TivoliMonitoring for Applications: Siebel eBusiness Applications User’s Guide and “Discover”on page 98 task for more information.

Note: The recommended method for creating objects is to run the Discover taskbecause it automatically verifies the object creation.

If you use the wsiebel command to create objects, you can run theRun_Srvrmgr_Command task and specify the Siebel List Servers command toverify the server object creation. See the “Run_Srvrmgr_Command” on page 83 formore information. If you use the wsiebel command to create a connection brokeror gateway object, you can do the following to verify creation:1. Right-click the object to display the drop-down menu.2. Select Diagnostics from the drop-down menu.3. Select one of the following:

v Siebel Gateway Logs

—OR—v Siebel Broker Logs

If the Log Files window lists one or more log files, the object was createdsuccessfully

If the server object, gateway or broker displays in the Monitoring for Siebel policyregion after you run the wsiebel command to create the object, the object wascreated. If you receive an error, the object is not functional.

You might use the wsiebel command when the Discover task does not work.


wsiebel

DescriptionTo create, delete, or view Siebel objects.

Authorization Rolesiebel_senior for the create or delete commands

siebel_senior, siebel_admin, or siebel_user for the get (view) command

CLI SyntaxThe syntax for the wsiebel create commands is:

wsiebel –create –broker–e <endpoint>–a <broker_installation_path>–s <siebel_enterprise_name>–p [policy_region]–m [managed node]

wsiebel –create –gateway–e <endpoint>–a <siebel_gateway_installation_path>–v <siebel_gateway_version>–s <siebel_enterprise_name>–p [policy_region]–m [managed node]

wsiebel –create –server–e <endpoint>–a <siebel_server_installation_path>–u <siebel_admin_user_id>–w <siebel_admin_password>–n <siebel_server_name>–g <siebel_gateway_name>–s <siebel_enterprise_name>–v <siebel_server_version–p [policy_region]–m [managed node]

The syntax for the wsiebel command to delete Siebel objects is:

wsiebel –delete {–broker | –gateway | –server} <label>

The syntax for the wsiebel command to view Siebel objects is

wsiebel –get {–broker | –gateway | –server} <label>

where:

endpointSpecifies the name of the Tivoli endpoint which has the Siebel productinstalled. The command fails if you do not specify a valid Tivoli endpoint.


siebel_gateway_installation_pathSpecifies the directory where the Siebel Gateway on the endpoint wasinstalled. This option is required when creating a Siebel Gateway object.

siebel_server_installation_pathSpecifies the directory where the Siebel Server on the endpoint wasinstalled. This option is required when creating a Siebel Server object.

broker_installation_pathSpecifies the directory where the Connection Broker software on theendpoint was installed. This option is required when creating a SiebelConnection Broker object.

siebel_administrator_user_idSpecifies the Siebel Administrator User ID. This option is required whencreating a Siebel Server object.

siebel_admin_passwordSpecifies the Siebel Administrator password. This option is required whencreating a Siebel Server object.

siebel_gateway_nameSpecifies the name of the Siebel Gateway. This option is required whencreating a Siebel server object.

siebel_gateway_versionSpecifies the version of the Siebel Gateway. This option is required whencreating a Siebel Gateway object.

siebel_server_nameSpecifies the name of the Siebel Server. This option is required whencreating a Siebel Server object.

siebel_server_versionSpecifies the version of the Siebel Server. This option is required whencreating a Siebel Server object.

siebel_enterprise_nameSpecifies the name of the Siebel enterprise to which the server belongs.This option is required.

policy_regionSpecifies the Tivoli policy region in which the object is placed as amanaged resource. If you do not specify a policy region, the defaultMonitoring for Siebel policy region is specified. The command fails if youspecify an incorrect policy region or if the policy region does not considerSiebel classes managed resources.

managed_nodeSpecifies the managed node where you want to create a new object. If youdo not specify a managed node when you create an object it is created, bydefault, on the managed node hosting the gateway that manages thespecified endpoint.

label Specifies the name that has been assigned to the SIEBELServer,SIEBELBroker, or SIEBELGateway object.

CLI ExampleThe following example creates a connection broker:wsiebel –create -broker e myname-ep -a /siebel/resonate \–s myenterprisename –p itmsiebel –m mymachine

Chapter 7. wsiebel Command 103

The following example creates a Siebel Gateway:wsiebel –create -gateway –e myname-ep –a /siebel/gtwysrvr \–v 6.3 –s myenterprisename –p itmsiebel \–m mymachine

The following example creates a Siebel server:wsiebel –create -server –e myname-ep a /siebel/siebsrvr \–u jbdennis –w myid –n myservername –g \siebelgate –v 6.3 –s myenterprisename –p itmsiebel –m mynode

The following example deletes a Siebel gateway:wsiebel –delete –gateway Gateway@myname–ep

The following example retrieves the properties of a Siebel server:wsiebel –get –server myservername@myenterprisename@myname

See the Tivoli Management Framework Reference Manual for more information.

Return ValuesA return code of 0 indicates that the command was successful.

A return code of 1 indicates that the command was unsuccessful.


Appendix A. Creating custom resource models using CIMclasses

This section briefly describes how you can use the Resource Model Wizard tocreate your own resource models using the IBM Tivoli Monitoring for Applications:Siebel eBusiness Applications CIM classes. Refer to the IBM Tivoli MonitoringWorkbench documentation for more information on how to create resource models.

Creating custom resource models using the IBM Tivoli MonitoringWorkbench

ObjectiveTo create customized resource models in the Workbench using IBM TivoliMonitoring for Applications: Siebel eBusiness Applications CIM classes and theResource Model Wizard to guide you through the process.

Background informationThe IBM Tivoli Monitoring Workbench is a programming tool for creating,modifying, debugging, and packaging resource models for use with IBM TivoliMonitoring products. Samples of the Best Practice Resource Models have beenprovided for you to use within the IBM Tivoli Monitoring Workbench. The sampleresource models are intended to be used as working examples for creating newresource models.

The Tivoli Maintenance and Support Contract covers assistance with problemsrelating to the operation of the IBM Tivoli Monitoring Workbench, but does notcover assistance for new or modified resource models other than the ones that areincluded in the IBM Tivoli Monitoring Workbench.

The Resource Model Wizard guides you through the process of creating resourcemodels using IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications CIM classes. Refer to the IBM Tivoli Monitoring Workbenchdocumentation for more information on how to create resource models.

Required authorization roleadmin

Before you beginBefore you begin, you must perform the following steps:1. Install and configure Windows Management Instrumentation.

Additional Information: You can download Windows ManagementInstrumentation from http://msdn.microsoft.com/downloads/.

2. Install and configure IBM Tivoli Monitoring Workbench.3. Load each IBM Tivoli Monitoring for Applications: Siebel eBusiness

Applications CIM class you want to use.Additional Information: Load the classes by running the mofcomp commandfrom the Workbench/w32–ix86 directory in the IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications installation CD. For more informationabout the mofcomp command, refer to the Windows ManagementInstrumentation documentation.


http://msdn.microsoft.com/downloads/

After you finishRefer to IBM Tivoli Monitoring Workbench documentation for instructions on howto build and deploy your new resource model. Resource models created to use theIBM Tivoli Monitoring for Applications: Siebel eBusiness Applications CIM classesmust be distributed to a SIEBELServer object.

Procedure1. Open the IBM Tivoli Monitoring Workbench.2. Select File to display the File drop-down menu.3. Select New from the File drop-down menu to display the New window.4. Select Java Script Resource Model.5. Click OK to display the New Resource Model Workspace window.6. Select the Resource Model Wizard radio button.7. Click OK.8. Select the CIM/WMI data source type.9. Select all of the available operating systems on which you want the resource

model to run.10. Click Next.11. Type ROOT\CIMV2 in the Connect to namespace field.

Additional Information: ROOT\CIMV2 is the destination where the IBM TivoliMonitoring for Applications: Siebel eBusiness Applications specific CIMclasses are stored.

12. Optional: Type your password.13. Click OK to display the Select a Class window.

Additional Information: The Selected Class field displays all available CIMclasses for use in your custom resource models. All IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications CIM classes begin with “Siebel”.

14. Select one or more CIM classes.15. Select the CIM class properties to monitor from the Class Properties group

box.16. Click Next.17. Follow the Resource Model Wizard instructions to complete your resource

model. See the IBM Tivoli Monitoring Workbench documentation for detailedinstructions.

18. After the wizard is complete, add the CIM classes as platform-specificdependencies to the resource model by doing the following:a. Open the IBM Tivoli Monitoring Workbench dialog box containing the

decision tree for your new resource model.b. In the decision tree on the left side of the dialog box, click ″+″ to expand

the tree list for the newly created resource model.c. Click ″+″ to the left of Dependencies to expand the Dependencies tree.d. Right-click on a platform-specific dependency element to display the Add

pop-up box.e. Click Add to display the Open dialog box.f. For the Look in: field, scroll to select the IBM Tivoli Monitoring for

Applications: Siebel eBusiness Applications installation CD.g. Click one of the following directories for the operating system on which

the resource models will run:v Windows: Workbench/w32–ix86.


—OR—v UNIX (including Linux-ix86, aix4–r1, HP–UX10, solaris2):

Workbench/UNIX.h. Click Open to add the classes to the Dependencies folder.i. Repeat steps 18d to 18h until all platform-specific dependencies have been

updated with the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications CIM classes.

Note: Some string properties have numeric values. These properties are markedwith a ″+″ in the CIM Class appendix. To compare these values againstnumeric thresholds, you must convert the string to an integer using theparseInt() function, then write the code manually.

Getting started with the Resource Model WizardThe Resource Model Wizard guides you through the process of creating resourcemodels. Perform the following steps to create a customized resource model usingIBM Tivoli Monitoring for Applications: Siebel eBusiness Applications CIM classes:1. Open the IBM Tivoli Monitoring Workbench.2. Select File to display the File drop-down menu.3. Select New from the File drop-down menu to display the New window.4. Select Java Script Resource Model.5. Click OK to display the New Resource Model Workspace window.6. Select the Resource Model Wizard radio button.7. Click OK.8. Select the CIM/WMI data source type.9. Select all of the available operating systems on which you want the resource

model to run.10. Click Next.11. Type ROOT\CIMV2 in the Connect to namespace field.

Additional Information: ROOT\CIMV2 is the destination that stores the IBMTivoli Monitoring for Applications: Siebel eBusiness Applications specific CIMclasses.

12. Optional: Type your password.13. Click OK to display the Select a Class window.

Additional Information: The Selected Class field displays all available CIMclasses for use in your custom resource models. All IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications CIM classes begin with “Siebel”.

14. Select one or more CIM classes.Additional Information: Refer to “Classes and properties to use in resourcemodels” on page 108 for a complete listing of IBM Tivoli Monitoring forApplications: Siebel eBusiness Applications CIM classes and properties.

15. Select the CIM class properties to monitor from the Class Properties groupbox.

16. Click Next.17. Follow the Resource Model Wizard instructions to complete your resource

model. See the IBM Tivoli Monitoring Workbench documentation for detailedinstructions.

18. After the wizard is complete, add the CIM classes as platform-specificdependencies to the resource model by doing the following:

Appendix A. Creating custom resource models using CIM classes 107

a. Open the IBM Tivoli Monitoring Workbench dialog box containing thedecision tree for your new resource model.

b. In the decision tree on the left side of the dialog box, click ″+″ to expandthe tree list for the newly created resource model.

c. Click ″+″ to the left of Dependencies to expand the Dependencies tree.d. Right-click on a platform-specific dependency element to display the Add

pop-up box.e. Click Add to display the Open dialog box.f. For the Look in: field, scroll to select the IBM Tivoli Monitoring for

Applications: Siebel eBusiness Applications installation CD.g. Click one of the following directories for the operating system on which

the resource models will run:v Windows: Workbench/w32–ix86.

—OR—v UNIX (including Linux-ix86, aix4–r1, HP–UX10, solaris2):

Workbench/UNIX.h. Click Open to add the classes to the Dependencies folder.i. Repeat steps 18d to 18h until all platform-specific dependencies have been

updated with the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications CIM classes.

19. Refer to IBM Tivoli Monitoring Workbench documentation for instructions onhow to build and deploy your new resource model. Resource models createdto use the IBM Tivoli Monitoring for Applications: Siebel eBusinessApplications CIM classes need to be distributed to the endpoints.

Note: Some string properties have numeric values. To compare these valuesagainst numeric thresholds, you must convert the string to an integer usingthe parseInt() function, then write the code manually.

Classes and properties to use in resource models

To create resource models, you need to use providers and their commoninformation model (CIM) classes, properties, and dependencies. A provider is thecomponent of a resource model that delivers the status of the monitored object.Use the following providers to create resource models for Siebel objects:


Siebel_Server_10

DescriptionThe following tables detail the CIM Class, properties, and dependencies of thisprovider.

Table 5. CIM Class

CIM Name ROOT\CIMV2: Siebel_Server_10

MOF File Name Siebel.mof

Description Siebel eBusiness Applications System Servermanagement object.

Table 6. Properties

Property TYPE Description

Name string The name of the Siebel Server.

HostName string The name of the IP host on which the serveris running. This will be the fully-qualifiedname.

EnterpriseName string The name of the Siebel enterprise. There isone gateway for each enterprise. Anenterprise is a grouping of servers that sharea gateway, database and file system.

InstallLocation string The location on the local file system wherethe Siebel files are installed. This can benecessary to find Siebel environment files,log files and execute Siebel commands.

State string The state of the server. This will return thevalue that is reported by the srvrmgrcommand (normally Running), or it willreturn up, down, warning or unknown.)

StartTime string The time the Siebel Server was started.

PID uint32 The process id of the process running theSiebel Server. this can be used to allowmonitoring or management of the server atan operating system level.

LogFileSystemSize uint32 The size (in K bytes) of the file system thatstores the log files for this server. Thelocation of this file system is different onWindows and Unix - the appropriate one ismonitored. This will tell you how muchspace is being used by the log files. It doesnot check the capacity of the file system.





Table 6. Properties (continued)






FileSystemSize uint32 The size (in K bytes) of the shared filesystem that is used to store shared files inthe Siebel system.

Version string The version of Siebel that is running.

LogFileSystem string The name of the logging directory.

FileSystem string The name of the directory used to storeshared files within the Siebel Enterprise.

Table 7. Dependencies

All haredIlt.jar

SiebelIlt.jar

aix4-r1 SiebelUnix.mof

solaris2 SiebelUnix.mof

w32-ix86 SiebelWMI.mof


Siebel_Componentgroup_10


Table 8. CIM Class

CIM Name ROOT\CIMV2: Siebel_ComponentGroup_10


Description Siebel eBusiness Applications System ComponentGroup object.

Table 9. Properties


Name string The name of the Siebel Component Group.

Description string The description of this component group asit would be displayed by the srvrmgrcommand.

DispatchState string

NumberOfComponents uint32 The number of components in thiscomponent group.

RunState string The state of the component group.

ServerName string The name of the server on which thiscomponent group is deployed.


All SharedIlt.jar

SiebelIlt.jar




Note: There is also a dependency that has been placed on the SIEBELObject classin the Framework using a DependencyMgr that will makeDataCollectorFactory.jar available. This must be available on the endpoint inthe $LCFDAT_DIR/LCFNEW/ITM/PACS for the ILT to function.


Siebel_Component_10


Table 11. CIM Class

CIM Name ROOT\CIMV2: Siebel_Server_10


Description Siebel eBusiness Applications Component object.

Table 12. Properties


Name string The name of the Siebel Component

ComponentGroupName string The name of the Component Group thatcontains this component.

EndTime string The time the component was ended. Thiswill normally be an empty string if thecomponent is still running.

FullName string The full name of the component. Normallythis is formed of complete words andcontains spaces. It is a good choice for adisplayable name, but the short name isbetter applied to programmatic applications.The srvrmgr components full name is ServerManager.

MaxTasks uint32 The maximum number of components thatis allowed to run at the same time. TheSiebel server will not allow more than thisnumber of tasks to run for this component.

RunMode string The mode in which tasks run for thiscomponent. An example is batch

RunningTasks uint32 The number of tasks that are currentlyrunning for this component.

RunState uint32 The state of the component. For componentsthat are currently running it will beRunning

ServerName string The name of the server on which thecomponent is deployed.

StartTime string The time the component was started.


All SharedIlt.jar

SiebelIlt.jar







Siebel_Task_10


Table 14. CIM Class

CIM Name ROOT\CIMV2: Siebel_Task_10


Description Siebel eBusiness Applications Task object. Thisrepresents an instance of a running component.



Name string The name of the Siebel Component

ComponentGroupName string The name of the Component Group thatcontains this component.

ComponentName string This task represents an instance of acomponent that is actually running. This isthe component functionality that is beingperformed by this task.

EndTime string The time when the task ended. If the task isstill running this will be blank.

Name string The name of the task. This is the numericidentifier assigned to the task when it isstarted.

PID uint32 The operating system process identifier forthe process running this task. This can beused to correlate information with operatingsystem monitors, or to manipulate theprocess directly.

RunMode string How this task is running (some run in batchmode).

RunState string The state of the task as viewed by the Siebelsystem.

StartTime string The time the task was started.

Status string


All SharedIlt.jar

SiebelIlt.jar






Siebel_Gateway_10


Table 17. CIM Class

CIM Name ROOT\CIMV2: Siebel_Gateway_10


Description Siebel eBusiness Applications Gateway object.This represents the state of the Siebel Gateway.The Gateway must be running for the Siebelsystem to function correctly.



Name string The name of the Siebel Gateway. This isnormally the same as the unqualified hostname.

EnterpriseName string The name of the Siebel Enterprise. There isone gateway for each enterprise. Anenterprise is a grouping of servers that sharea gateway, database and file system.

HostName string The hostname of the machine on which theGateway is running. This will be a fullyqualified hostname.

State string The state of the Gateway. This will be UP orDOWN. It is set based on the existence ofthe gateway process.


All SharedIlt.jar

SiebelIlt.jar






Siebel_ConnectionBroker_10


Table 20. CIM Class

CIM Name ROOT\CIMV2: Siebel_ConnectionBroker_10


Description Resonate Connection Broker Object. Thisrepresents the Resonate process that is(optionally) used by Siebel to provide loadbalancing between servers using a virtual IPaddress and mapping to underlying realaddresses. The Resonate Connection Broker canbe used outside the scope of Siebel, but it isinstrumented to allow the functionality used bySiebel to be monitored.



Name string The name of the Connection Broker. This isalways Broker because they do not have aname and there can only be one on an IPhost.

EnterpriseName string The name of the Siebel Enterprise. There isone gateway for each enterprise. Anenterprise is a grouping of servers that sharea gateway, database and file system. AResonate Connection Broker is used withinthe context of an enterprise to provide loadbalanced requests to the servers within theenterprise.

HostName string The hostname of the machine on which theConnection Broker is running. This will be afully qualified hostname.

State string The state of the Connection Broker. This willbe UP or DOWN. It is set based on theexistence of the broker process.


All SharedIlt.jar

SiebelIlt.jar






Siebel_Parameters_10


Table 23. CIM Class

CIM Name ROOT\CIMV2: Siebel_Parameters_10


Description This object represents the raw data that can becollected from the list parameters option on thesrvrmgr command.



Name string The name of the parameter. This is the valueof the PA_ALIAS column in the listparameters table.

DataType string The data type of the parameter (allparameters are returned as strings, thisdescribes the logical type of theinformation).

ParamScope string The scope of the parameter. This can beServer or Subsystem.

SubSystem string The name of the subsystem to which theparameter applies. This will be blank for allparameters that have a System scope. It willbe the full name of the subsystem to whichit applies if the scope is SubSystem.

Value string The value of the parameter.


All SharedIlt.jar

SiebelIlt.jar





Siebel_Statistics_10


Table 26. CIM Class

CIM Name ROOT\CIMV2: Siebel_Parameters_10


Description This object represents the raw data that can be collectedfrom the list statistics option on the srvrmgr command.



Name string The name of the statistic. This is the valueof the STAT_NAME column in the liststatistics table.

DataType string The data type of the statistic (all statisticsare returned as strings, this describes thelogical type of the information).

StatScope string The scope of the statistic. This can be Serveror Subsystem.

SubSystem string The name of the subsystem to which thestatistic applies. This will be blank for allstatistics that have a System scope. It will bethe full name of the subsystem to which itapplies if the scope is SubSystem.

Description string The description of the statistic.

SvcName string The Svc associated with this statistic.

TaskNumber string The task number (which is its Name whenusing the Siebel_Task_10 CIM class)associated with this statistic.

ServerName string The server associated with this statistic.

Value string The value of the statistic.


All SharedIlt.jar

SiebelIlt.jar






Appendix B. Notices

This information was developed for products and services offered in the U.S.A.IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user’s responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation

Licensing

2-31 Roppongi 3-chome, Minato-ku

Tokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION ″AS IS″ WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certaintransactions, therefore, this statement might not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.


Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Corporation

2Z4A/101

11400 Burnet Road

Austin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM’s future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:


This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. You may copy,modify, and distribute these sample programs in any form without payment toIBM for the purposes of developing, using, marketing, or distributing applicationprograms conforming to IBM’s application programming interfaces.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rightsreserved.

If you are viewing this information in softcopy form, the photographs and colorillustrations might not appear.

TrademarksIBM, the IBM logo, Tivoli, the Tivoli logo, and Tivoli Enterprise Console aretrademarks or registered trademarks of International Business MachinesCorporation in the United States or other countries, or both.

Siebel and Siebel eBusiness Applications are trademarks of Siebel Systems, Inc inthe United States, other countries, or both.

Microsoft and Windows NT are registered trademarks of Microsoft Corporation inthe United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Other company, product, and service names may be trademarks or service marksof others.

Appendix B. Notices 121


Index

Aaccessibility features viiiArchive_Siebel_Logs task 72Authorization role

defined 53authorization roles, Siebel task 54, 55

Bbash shell 2books

feedback vonline vordering v

Bourne shell 2

CC shell 2Category

defined 7Check_Server_Status task 75Classes and properties for resource

models 108Clearing events

defined 8CLI example

defined 54CLI syntax

defined 54commands

running 1running on UNIX 2running on Windows NT 2special characters viii, 4syntax viii, 4

commands, IBM Tivoli Monitoring forApplications, version 5.1.0: SiebeleBusiness Applications

wsiebel 102component groups

controlling the state of 77list data for 81

componentslist data for 81

Configure_Event_Server task 58Configure_Logfile_Broker_Message_

Formats task 62Configure_Logfile_Server_Message_

Formats task 65Connection Broker messages formats 62Control_Component_Groups task 77Control_Logfile_Adapter task 68Control_Siebel_Tasks task 79creating objects 101

verification of 101Customer Support viii

DDefault cycle time

defined 7Default severity

defined 7Delete_Endpoint_Utilities task 96deleting objects 101Discover job 98Discover task 98

creating objects with the 101Discover_Job

creating objects with the 101

Ee-mail contact viienable compgrp command 83endpoint

setting up the Tivoli environmenton 3

Eventdefined 7

Event tasks, Siebel 57

Ffeedback about publications viiFileSystemSize too high indication

default settings 40list of attributes 40message delivered to Tivoli Enterprise

Console 39

GGateway Server

check status of 75glossary, online viGUI data entry fields

defined 53

HHoles

defined 8

IIBM Tivoli Monitoring Workbench

creating custom resource modelsusing 105

indicationsdefined 7FileSystemSize too high indication 39LogFileSystemSize too high

indication 44RunningTasks too low 16Siebel Component Tasks Too High 15

indications (continued)Siebel Connection Broker Down

indication 27Siebel Gateway Down indication 30Siebel Server is degraded

indication 35Siebel Server is down indication 34Siebel Task CPU Utilization High 22Siebel Task Max Memory

Exceeded 21SiebelServer high CPU utilization

indication 48SiebelServer Max Process Size

Exceeded indication 49The component is not running as

desired 11Internal name

defined 7

KKorn shell 2

Llist data for components, component

groups, or Siebel tasks 81list servers command 83log files

remove from an endpoint 96LogFileSystemSize too high indication


Console 44

Mmanuals


message formats, installing anduninstalling for the Siebel Broker 62

message formats, installing anduninstalling for the Siebel server 65

Oobjects

creating, deleting, or viewing 101Occurrences

defined 8online publications viiordering publications vii


Pprofile manager

subscribe objects to 98providers

to create resource models 108publications


RResource Model Wizard

creating custom resource modelsusing 105

resource modelsclasses and properties to use in 108creating of using CIM classes 105providers to create 108Siebel Component Availability 10Siebel Component Task Count 14, 79Siebel Component Tasks Resource

Use 20, 79Siebel Connection Broker

Availability 26Siebel Gateway Availability 29Siebel Server Availability 33Siebel Server File System Directory

Size 39Siebel Server Log File Directory

Size 43Siebel Server Resource Use 47

resource status, recommended action 75Rule Base Configuration 59Run_List_Command task 81Run_Srvrmgr_Command task 83RunningTasks too low indication


Console 16

Sshells

bash 2Bourne 2C 2establishing the Tivoli environment

in 3Korn shell 2UNIX 2

Siebel Component Availability resourcemodel 10

command line example 13cycle time 10logging properties 12parameters 12return codes 13thresholds 12

Siebel Component Task Count resourcemodel 14, 79

command line example 19cycle time 14logging properties 18parameters 17

Siebel Component Task Count resourcemodel (continued)

return codes 18, 19thresholds 17

Siebel Component Tasks Resource Useresource model 20, 79


Siebel Component Tasks Too Highindication

default settings 15, 16list of attributes 15message delivered to Tivoli Enterprise

Console 15Siebel Connection Broker

check status of 75Siebel Connection Broker Availability

resource model 26command line example 28cycle time 26logging properties 28parameters 27return codes 28thresholds 27

Siebel Connection Broker Downindication


Console 27Siebel Event Tasks 57

task CLI names 57, 95task GUI names 57, 95

Siebel Gateway Availability resourcemodel 29


Siebel Gateway Down indicationdefault settings 30list of attributes 30message delivered to Tivoli Enterprise

Console 30Siebel log archive directories

tar, compress, remove 72view a list of 72

Siebel Operational Tasks 71task CLI names 71task GUI names 71

Siebel resourceslocating to manage 98

Siebel serververifying what tasks are running on

a 81Siebel Server

check status of 75Siebel Server Availability resource

model 33command line example 38cycle time 33

Siebel Server Availability resource model(continued)

logging properties 36parameters 36return codes 37tasks and built-in actions 36thresholds 36

Siebel Server File System Directory Sizeresource model 39


Siebel Server is degraded indicationdefault settings 35list of attributes 35message delivered to Tivoli Enterprise

Console 35Siebel Server is down indication


Console 34Siebel Server Log File Directory Size

resource model 43command line example 46cycle time 43logging properties 45parameters 45return codes 45, 46thresholds 45

Siebel server message formats 65Siebel Server Resource Use resource

model 47command line example 51cycle time 47logging properties 50parameters 50return codes 51thresholds 50

Siebel task authorization roles 54, 55Siebel Task CPU Utilization High

indicationdefault settings 23list of attributes 22message delivered to Tivoli Enterprise

Console 22Siebel Task Max Memory Exceeded


Console 21Siebel tasks 79

list data for 81Siebel Utility Tasks 95Siebel_Component_10 112

CIM classes 112dependencies 112properties 112

Siebel_Componentgroup_10 111CIM classes 111dependencies 111properties 111

Siebel_ConnectionBroker_10 116


Siebel_ConnectionBroker_10 (continued)CIM classes 116dependencies 116properties 116

Siebel_Gateway_10 115CIM classes 115dependencies 115properties 115

Siebel_Parameters_10 117CIM classes 117dependencies 117properties 117

Siebel_Server_10 109CIM classes 109dependencies 110properties 109

Siebel_Statistics_10 118CIM classes 118dependencies 118properties 118

Siebel_Task_10 114CIM classes 114dependencies 114properties 114

SiebelServer high CPU utilizationindication


Console 48SiebelServer Max Process Size Exceeded


Console 49srvrmgr command 83Start_Connection_Broker task 85Start_Siebel_Gateway task 86Start_Siebel_Server task 87Stop_Connection_Broker task 88Stop_Siebel_Gateway 90Stop_Siebel_Server task 92subscribing objects to a profile

manger 98

TTarget managed resource

defined 7, 53Task libraries

Siebel Event Tasks 57tasks

Stop_Siebel_Gateway 90Tasks and built-in actions

defined 7TBSM_Discover task 70The component is not running as desired


Console 11Tivoli Customer Support viiiTivoli Enterprise Console Adapter

Configuration Facility software 62, 65,68

Tivoli Enterprise Console Event Serversoftware 62, 65, 68, 70

Tivoli Enterprise Console eventsDISCOVER 70GONE 70

Tivoli Enterprise Console Logfile Adapterformat file 62, 65

Tivoli environmentestablishing in a shell 3establishing on an endpoint 3establishing on UNIX 3establishing on Windows NT/2000 3

Tivoli Logfile Adapter status, display onan endpoint 68

typeface conventions viii

UUNIX

running commands on 2setting up the Tivoli environment 3shell 2

Usage notesdefined 54

Vviewing objects 101

WWindows NT

running commands on 2Windows NT/2000

setting up the Tivoli environment 3wsiebel command 102

creating, deleting, or viewing objectswith the 101

Index 125


��

Printed in U.S.A.

SC23-4818-00

Documents

IBM Tivoli Monitoring for Applications: Siebel eBusiness ...publib.boulder.ibm.com/tividd/td/ITMAN/SC23-4818-00/en_US/PDF/S… · IBM Tivoli Monitoring for Applications: Siebel eBusiness