Thanks to visit codestin.com
Credit goes to www.scribd.com

0% found this document useful (0 votes)
27 views186 pages

Leamst

Uploaded by

cyougokichi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
27 views186 pages

Leamst

Uploaded by

cyougokichi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 186

IBM Z NetView

6.4

User's Guide: NetView Management


Console

IBM

SC27-2868-04
Note
Before using this information and the product it supports, read the information in “Notices” on page
159.

This edition applies to version 6, release 4 of IBM Z NetView (product number 5697-NV6 ) and to all subsequent
versions, releases, and modifications until otherwise indicated in new editions.
This edition replaces SC27-2868-03.
© Copyright International Business Machines Corporation 1997, 2022.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
Contents

Figures................................................................................................................. ix
About this publication...........................................................................................xi
Intended audience...................................................................................................................................... xi
Publications................................................................................................................................................. xi
IBM Z NetView library............................................................................................................................ xi
Related publications ............................................................................................................................ xii
Terminology in this Library....................................................................................................................xii
Using IBM Z NetView online help........................................................................................................ xiv
Accessing publications online............................................................................................................. xiv
Ordering publications ..........................................................................................................................xiv
Accessibility .............................................................................................................................................. xiv
Support information.................................................................................................................................. xiv
Conventions used in this publication......................................................................................................... xv
Typeface conventions .......................................................................................................................... xv
Operating system-dependent variables and paths..............................................................................xv
Syntax diagrams....................................................................................................................................xv

Part 1. Overview....................................................................................................1

Chapter 1. Introduction to the NetView Management Console..................................................................3


What You Can Do with NetView Management Console......................................................................... 3
How the NetView Management Console Works.................................................................................... 3
Topology Server................................................................................................................................ 4
Topology Console.............................................................................................................................. 4
Real and Aggregate Resources......................................................................................................... 4

Part 2. Installing and Customizing the NetView Management Console..................... 5

Chapter 2. Installing the NetView Management Console........................................................................... 7


Defining the IBM Z NetView User ID and Password on the Topology Server....................................... 7

Chapter 3. Customizing the NetView Management Console Topology Server...........................................9


Modifying the Server Properties File......................................................................................................9
Auditing Functions and the Server.Properties File................................................................................ 9
Customizing the Functions to be Audited........................................................................................ 9
Customizing the Audit Log for Viewing...........................................................................................10
Customizing the Size of the Audit Log............................................................................................ 11
Customizing the Length of Command Responses within the Audit Log........................................12
Customizing Special Characters to be Browsed............................................................................ 12
Customizing the Replacement Character for Carriage Returns and Line Feeds........................... 13

Chapter 4. Customizing the NetView Management Console Topology Console...................................... 15


Customizing Topology Console Functions........................................................................................... 15
Adding and Customizing Topology Console Icons......................................................................... 15
Adding and Customizing Topology Console Backgrounds.............................................................15
Customizing Your Online Help Facility........................................................................................... 16
Configuring a Web Browser to Display Views................................................................................ 16
Customizing Double-click Mouse Actions......................................................................................18
Advanced Topology Console Customization........................................................................................18
Displaying Customized Help...........................................................................................................18

iii
Enabling User Flags........................................................................................................................ 18
Adding a Flag to the Context Menu................................................................................................ 20
Running a Console Class.................................................................................................................24
Customizing Web Server Enablement............................................................................................ 24
Customizing the View Bar Layout................................................................................................... 25
Customizing the Automatic Download of Files At Log On............................................................. 26
Overriding the Default Date and Time Format............................................................................... 26
Customizing Data1, Data2, and Data3 Field Labels for RODM Resources....................................29
Customizing Line Thickness........................................................................................................... 30

Chapter 5. Topology Console Java Applications and Plug-ins................................................................. 33


Supplied Support Files......................................................................................................................... 33
Installing the Examples........................................................................................................................33
Enabling the Examples.........................................................................................................................34
Compiling the Examples.......................................................................................................................34
Tracing the Examples........................................................................................................................... 34
Problem Determination........................................................................................................................35
Java Applications................................................................................................................................. 35
Java Application Examples.............................................................................................................36
Java Application Development Process......................................................................................... 36
Defining the Example Java Applications........................................................................................ 36
Running the Example Java Applications........................................................................................ 37
Java Plug-Ins........................................................................................................................................ 38
Supported Plug-Ins.........................................................................................................................38
Plug-In Definitions File................................................................................................................... 39
Plug-In Examples............................................................................................................................40
Plug-In Development Process........................................................................................................40
Defining the Example Java Plug-Ins.............................................................................................. 41
Running the Example Java Plug-Ins ..............................................................................................41

Chapter 6. Configuring Property Files for Locally Launched Applications............................................... 43


Defining the Pop-up Menu Items.........................................................................................................43
Response File Input........................................................................................................................43
Creating a Response File for Browser............................................................................................ 44
Defining the Properties File..................................................................................................................44

Part 3. Using NetView Management Console.........................................................49

Chapter 7. Operating the NetView Management Console........................................................................ 51


Starting the Topology Server................................................................................................................51
Starting the Topology Server from the Desktop Icon.................................................................... 51
Manually Starting the Topology Server.......................................................................................... 51
Starting the Topology Server as a Windows Service......................................................................52
Starting the Topology Server as a Daemon.................................................................................... 52
Establishing Communication Between the NetView Host and the Topology Server.................... 52
Starting the Topology Console............................................................................................................. 53
Selecting the Desktop Icon in Windows.........................................................................................53
Using a Line Command................................................................................................................... 53
Using the Topology Console Sign On Window................................................................................53
Topology Console Window................................................................................................................... 55
View Area........................................................................................................................................ 57
Filter Bar..........................................................................................................................................57
NetView Management Console Online Help........................................................................................57
NetView Management Console Functions...........................................................................................58
Issuing IP Commands.....................................................................................................................58
The NetView Resource Manager.................................................................................................... 58
Using RODM Collection Manager With NetView Management Console........................................ 59

iv
NetView Management Console Topology Server Databases.............................................................. 59
Writing Server Information to the Topology Server Databases.....................................................60
Handling Corrupted Topology Server Databases........................................................................... 61
Creating and Importing Backup Copies of Customized Topology Server Databases................... 62
Stopping the Topology Console........................................................................................................... 63
Stopping the Topology Server.............................................................................................................. 63
With the Service Version on Windows............................................................................................63
Using a Line-mode Command........................................................................................................ 63

Chapter 8. Understanding Views............................................................................................................... 65


RODM-Based Views..............................................................................................................................65
Network Views................................................................................................................................ 65
Exception Views.............................................................................................................................. 65
Configuration Views........................................................................................................................ 66
More Detail Views........................................................................................................................... 69
Locate Failing Resources................................................................................................................ 70
Customized Views................................................................................................................................ 70
Views Containing Resources for Which You Are Not Authorized........................................................ 71
Views Containing Scheduled Resources..............................................................................................71
Displaying Views in a Web Browser..................................................................................................... 71

Chapter 9. Open Topology Interface Network Operation.........................................................................73


Open Topology Interface View Objects............................................................................................... 73
Finding Resources................................................................................................................................ 74
Navigating Network Views................................................................................................................... 74
Viewing Open Networks....................................................................................................................... 74
Open Networks View...................................................................................................................... 74

Chapter 10. Using NetView Management Console Command Profiles.................................................... 77


Understanding Command Profiles....................................................................................................... 77
Resource Manager Objects.............................................................................................................77
Commands and Command Set Objects......................................................................................... 77
Profile Objects.................................................................................................................................78
Operator Objects.............................................................................................................................78
Using the Command Profile Editor Batch Utility..................................................................................78
Starting the Command Profile Batch Utility................................................................................... 79
Input and Output Files of the Response File................................................................................. 79

Chapter 11. Using the Topology Server Command Exits.......................................................................... 85


Command Profiles................................................................................................................................ 85
Understanding Topology Server Command Exits................................................................................ 85
Using Topology Server Command Exits............................................................................................... 85
IHSDGENE Command Exit..............................................................................................................86
IHSDNATV Command Exit.............................................................................................................. 86
IHSXTHCE Command Exit.............................................................................................................. 87
IHSXTJAM Command Exit.............................................................................................................. 87
IHSXTJAV Command Exit............................................................................................................... 87
Substitution Variables.....................................................................................................................87

Appendix A. Topology Server Commands..............................................................91


config..........................................................................................................................................................91
cpebatch.....................................................................................................................................................91
dbtransfer...................................................................................................................................................93
getpd.......................................................................................................................................................... 93
hostcmd..................................................................................................................................................... 94
hostcmdoper.............................................................................................................................................. 95
ihszfmt........................................................................................................................................................96

v
ihszset........................................................................................................................................................ 96
ihszsett....................................................................................................................................................... 97
service........................................................................................................................................................ 97
start............................................................................................................................................................ 98
stop.............................................................................................................................................................99
tcpipkey......................................................................................................................................................99
tserver...................................................................................................................................................... 100
utility........................................................................................................................................................ 101

Appendix B. Topology Console Commands..........................................................103


tconsolexx................................................................................................................................................103
tappxx...................................................................................................................................................... 105

Appendix C. Creating a Demonstration............................................................... 107


Capturing Live Views from your NetView Management Console System.............................................. 107
Using Basic Data Files........................................................................................................................ 109
Integrating Captured Views into the Demonstration..............................................................................114
Updating the Business Tree............................................................................................................... 114
Renaming Navigation Views...............................................................................................................116
Defining New Resource Types in Saved Views....................................................................................... 116
Finding the Resource ID.......................................................................................................................... 117
Defining a Node Resource in a View........................................................................................................118
Defining a Link Resource in a View..........................................................................................................119
Defining View Information.......................................................................................................................120
Defining a Demonstration View............................................................................................................... 121

Appendix D. Launching and Using the NetView Management Console from Other
Applications.................................................................................................. 123
Servlets.................................................................................................................................................... 123
Setup ....................................................................................................................................................... 123
Using the Servlets....................................................................................................................................124
IhsLocRes Servlet.............................................................................................................................. 124
IhsRunning Servlet.............................................................................................................................125
locRes Java Class............................................................................................................................... 125
nmcRunning Java Class..................................................................................................................... 126
tlocResxx Script..................................................................................................................................127

Appendix E. Sending Commands to Multiple NetView Domains........................... 129

Appendix F. Auditing and the ihsaudit.xml File................................................... 131


Elements in the ihsaudit.xml file.............................................................................................................131
action ELEMENT................................................................................................................................. 132
admin ELEMENT................................................................................................................................. 132
aggPri ELEMENT................................................................................................................................. 132
aggregation ELEMENT........................................................................................................................132
auditEntry ELEMENT.......................................................................................................................... 133
auditLog ELEMENT............................................................................................................................. 133
cmd ELEMENT.................................................................................................................................... 133
cmdResp ELEMENT............................................................................................................................134
command ELEMENT...........................................................................................................................134
corrId ELEMENT................................................................................................................................. 135
cpe ELEMENT..................................................................................................................................... 135
date ELEMENT.................................................................................................................................... 135
extSearch ELEMENT...........................................................................................................................135
flag ELEMENT..................................................................................................................................... 136
flagMask ELEMENT.............................................................................................................................136

vi
flagValue ELEMENT............................................................................................................................ 136
fromHostname ELEMENT...................................................................................................................137
fromId ELEMENT................................................................................................................................ 137
fromIpAddr ELEMENT........................................................................................................................ 137
hostname ELEMENT...........................................................................................................................137
id ELEMENT........................................................................................................................................ 138
initRes ELEMENT................................................................................................................................ 138
ipAddr ELEMENT................................................................................................................................ 138
locateName ELEMENT....................................................................................................................... 138
lu62name ELEMENT...........................................................................................................................139
menuText ELEMENT........................................................................................................................... 139
msg ELEMENT.................................................................................................................................... 140
netconv ELEMENT.............................................................................................................................. 140
nmcConsole ELEMENT.......................................................................................................................140
nmcServer ELEMENT......................................................................................................................... 141
note ELEMENT....................................................................................................................................141
noteMask ELEMENT........................................................................................................................... 141
nvDomain Element............................................................................................................................. 141
res ELEMENT...................................................................................................................................... 142
rodmId ELEMENT............................................................................................................................... 142
sendMsg ELEMENT.............................................................................................................................142
thresholdDeg ELEMENT..................................................................................................................... 142
thresholdSevDeg ELEMENT............................................................................................................... 143
thresholdUnsat ELEMENT..................................................................................................................143
toHostname ELEMENT....................................................................................................................... 143
toId ELEMENT.................................................................................................................................... 143
toIpAddr ELEMENT............................................................................................................................ 144
viewCust ELEMENT............................................................................................................................ 144
viewName ELEMENT.......................................................................................................................... 144
viewNav ELEMENT............................................................................................................................. 145
viewType ELEMENT............................................................................................................................ 145
Audit Entry Actions.................................................................................................................................. 145
aggregation ELEMENT........................................................................................................................145
command ELEMENT...........................................................................................................................146
cpe ELEMENT..................................................................................................................................... 147
flag ELEMENT..................................................................................................................................... 148
netconv ELEMENT.............................................................................................................................. 149
nmcConsole ELEMENT.......................................................................................................................149
nmcServer ELEMENT......................................................................................................................... 150
sendMsg ELEMENT.............................................................................................................................151
viewCust ELEMENT............................................................................................................................ 152
viewNav ELEMENT............................................................................................................................. 153

Appendix G. Automatic File Download at Console Log On.................................... 157


During Installation................................................................................................................................... 157
During Initial Sign On...............................................................................................................................157
During Subsequent Sign On.....................................................................................................................158

Notices..............................................................................................................159
Programming Interfaces..........................................................................................................................160
Trademarks.............................................................................................................................................. 160
Privacy policy considerations.................................................................................................................. 160

Index................................................................................................................ 163

vii
viii
Figures

1. Sign On Window.......................................................................................................................................... 54

2. Topology Console Window.......................................................................................................................... 56

3. RODM Collection Manager main menu....................................................................................................... 59

4. Network View.............................................................................................................................................. 65

5. Exception View............................................................................................................................................ 66

6. Configuration Parents View.........................................................................................................................66

7. Configuration Children View........................................................................................................................67

8. Configuration Peers View............................................................................................................................ 67

9. Configuration Logical View..........................................................................................................................68

10. Configuration Physical View......................................................................................................................68

11. Configuration Logical and Physical View.................................................................................................. 69

12. Configuration Backbone View...................................................................................................................69

13. More Detail Views......................................................................................................................................70

14. Locate Failing Resource View................................................................................................................... 70

15. Types of Open View Objects..................................................................................................................... 73

16. NetView Management Console Default Network View (MultiSysView) Example....................................74

17. NetView Management Console Open Networks View (Open_Networks) Example................................ 75

18. NetView Management Console Open Topology Interface Resource Properties Window Example....... 76

19. Multiple Domain Dialog Box Example.................................................................................................... 129

ix
x
About this publication
The IBM Z® NetView® product provides advanced capabilities that you can use to maintain the highest
degree of availability of your complex, multi-platform, multi-vendor networks and systems from a single
point of control. This publication, the IBM Z NetView User's Guide: NetView Management Console, provides
information about the NetView management console interface to the NetView product. For more detailed
information about specific functions, see the NetView management console online help.

Intended audience
This publication is for operators and system programmers who use or are responsible for the NetView
management console.

Publications
This section lists publications in the IBM Z NetView library and related documents. It also describes how
to access NetView publications online and how to order NetView publications.

IBM Z NetView library


The following documents are available in the IBM Z NetView library:
• Administration Reference, SC27-2869, describes the NetView program definition statements required
for system administration.
• Application Programmer's Guide, SC27-2870, describes the NetView program-to-program interface
(PPI) and how to use the NetView application programming interfaces (APIs).
• Automation Guide, SC27-2846, describes how to use automated operations to improve system and
network efficiency and operator productivity.
• Command Reference Volume 1 (A-N), SC27-2847, and Command Reference Volume 2 (O-Z), SC27-2848,
describe the NetView commands, which can be used for network and system operation and in
command lists and command procedures.
• Installation: Configuring Additional Components, GC27-2851, describes how to configure NetView
functions beyond the base functions.
• Installation: Configuring the NetView Enterprise Management Agent, GC27-2853, describes how to
install and configure the IBM Z NetView Enterprise Management Agent.
• Installation: Getting Started, GI11-9443, describes how to install and configure the base NetView
program.
• Installation: Migration Guide, GC27-2854, describes the new functions that are provided by the current
release of the NetView product and the migration of the base functions from a previous release.
• IP Management, SC27-2855, describes how to use the NetView product to manage IP networks.
• Messages and Codes Volume 1 (AAU-DSI), GC27-2856, and Messages and Codes Volume 2 (DUI-IHS),
GC27-2857, describe the messages for the NetView product, the NetView abend codes, the sense
codes that are included in NetView messages, and generic alert code points.
• Programming: Pipes, SC27-2859, describes how to use the NetView pipelines to customize a NetView
installation.
• Programming: REXX and the NetView Command List Language, SC27-2861, describes how to write
command lists for the NetView product using the Restructured Extended Executor language (REXX) or
the NetView command list language.
• Security Reference, SC27-2863, describes how to implement authorization checking for the NetView
environment.

© Copyright IBM Corp. 1997, 2022 xi


• Troubleshooting Guide, GC27-2865, provides information about documenting, diagnosing, and solving
problems that occur in the NetView product.
• Tuning Guide, SC27-2874, provides tuning information to help achieve certain performance goals for the
NetView product and the network environment.
• User's Guide: Automated Operations Network, SC27-2866, describes how to use the NetView
Automated Operations Network (AON) component, which provides event-driven network automation,
to improve system and network efficiency. It also describes how to tailor and extend the automated
operations capabilities of the AON component.
• User's Guide: NetView, SC27-2867, describes how to use the NetView product to manage complex,
multivendor networks and systems from a single point.
• User's Guide: NetView Enterprise Management Agent, SC27-2876, describes how to use the NetView
Enterprise Management Agent.
• Licensed Program Specifications, GC31-8848, provides the license information for the NetView product.
• Program Directory for IBM Z NetView US English, GI11-9444, contains information about the material
and procedures that are associated with installing the NetView product.
• Program Directory for IBM Z NetView Japanese, GI11-9445, contains information about the material and
procedures that are associated with installing the NetView product.
• Program Directory for IBM Z NetView Enterprise Management Agent, GI11-9446, contains information
about the material and procedures that are associated with installing the IBM Z NetView Enterprise
Management Agent.
The following books are archived:
• Customization Guide, SC27-2849, describes how to customize the NetView product and points to
sources of related information.
• Data Model Reference, SC27-2850, provides information about the Graphic Monitor Facility host
subsystem (GMFHS) and MultiSystem Manager data models.
• Installation: Configuring Graphical Components, GC27-2852, describes how to install and configure the
NetView graphics components.
• Programming: Assembler, SC27-2858, describes how to write exit routines, command processors, and
subtasks for the NetView product using assembler language.
• Programming: PL/I and C, SC27-2860, describes how to write command processors and installation exit
routines for the NetView product using PL/I or C.
• Resource Object Data Manager and GMFHS Programmer's Guide, SC27-2862, describes the NetView
Resource Object Data Manager (RODM), including how to define your non-SNA network to RODM and
use RODM for network automation and for application programming.
• User's Guide: NetView Management Console, SC27-2868, provides information about the NetView
management console interface of the NetView product.

Related publications
You can find additional product information on the IBM Z NetView web site at https://www.ibm.com/
products/z-netview.
For information about the NetView Bridge function, see Tivoli NetView for OS/390® Bridge Implementation,
SC31-8238-03 (available only in the V1R4 library).

Terminology in this Library


The following terms are used in this library:
CNMCMD
For the CNMCMD member and the members that are included in it using the %INCLUDE statement
CNMSTYLE
For the CNMSTYLE member and the members that are included in it using the %INCLUDE statement

xii IBM Z NetView: User's Guide: NetView Management Console


DSIOPF
For the DSIOPF member and the members that are included in it using the %INCLUDE statement
IBM® Tivoli® Netcool®/OMNIbus
For either of these products:
• IBM Tivoli Netcool/OMNIbus
• IBM Tivoli OMNIbus and Network Manager
MVS™
For z/OS® operating systems
MVS element
For the base control program (BCP) element of the z/OS operating system
NetView
For the following products:
• IBM Z NetView version 6 release 4
• IBM Z NetView version 6 release 3
• IBM Tivoli NetView for z/OS version 6 release 2 modification 1
• NetView releases that are no longer supported
PARMLIB
For SYS1.PARMLIB and other data sets in the concatenation sequence
VTAM®
For Communications Server - SNA Services
Unless otherwise indicated, topics to programs indicate the latest version and release of the programs. If
only a version is indicated, the topic is to all releases within that version.
When a topic is made about using a personal computer or workstation, any programmable workstation
can be used.
Table 1 on page xiii defines the Windows and UNIX terms as they are used with the NetView
management console topology console and NetView management console topology server.

Table 1. NetView Management Console Topology Server and Topology Console Platforms*
Term NetView Management Console NetView Management Console
Topology Console Topology Server
Windows • Windows 7 Professional • Windows Server 2008 R2 (Datacenter,
• Windows 8 Professional and Enterprise Enterprise, Standard)

• Windows Server 2008 R2 (Datacenter, • Windows Server 2012 (Datacenter,


Enterprise, Standard) Standard, Essentials, Foundation)

• Windows Server 2012 (Datacenter,


Standard, Essentials, Foundation)

AIX® and Linux® • Red Hat Enterprise Linux 5 • AIX


• Red Hat Enterprise Linux 6 • Red Hat Enterprise Linux 5.0 for
• Red Hat Enterprise Linux Desktop 5 System z®

• Red Hat Enterprise Linux Desktop 6 • Red Hat Enterprise Linux 6.0 for
System z
• SUSE Linux Enterprise Server 10
• SUSE Linux Enterprise Server 10 for
• SUSE Linux Enterprise Server 11 System z
• SUSE Linux Enterprise Desktop 10 • SUSE Linux Enterprise Server 11 for
• SUSE Linux Enterprise Desktop 11 System z

* Windows Server 2012 version: Essentials and Foundation editions do not have virtualization rights.

About this publication xiii


Using IBM Z NetView online help
The following types of IBM Z NetView mainframe online help are available, depending on your installation
and configuration:
• General help and component information
• Command help
• Message help
• Sense code information
• Recommended actions

Accessing publications online


IBM posts publications for this and all other products, as they become available and whenever they
are updated, to the IBM Documentation at https://www.ibm.com/docs/en. You can find IBM Z NetView
documentation on IBM Z NetView Documentation.
Note: If you print PDF documents on other than letter-sized paper, set the option in the Print window that
enables Adobe Reader to print letter-sized pages on your local paper.

Ordering publications
You can order many IBM publications online at http://www.ibm.com/e-business/linkweb/publications/
servlet/pbi.wss
You can also order by telephone by calling one of these numbers:
• In the United States: 800-426-4968
• In Canada: 800-879-2755
In other countries, contact your software account representative to order IBM publications. To locate the
telephone number of your local representative, perform the following steps:
1. Go to http://www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss.
2. Select your country from the list and click the grey arrow button beside the list.
3. Click About this site to see an information page that includes the telephone number of your local
representative.

Accessibility
Accessibility features help users with a physical disability, such as restricted mobility or limited vision, to
use software products successfully. Standard shortcut and accelerator keys are used by the product and
are documented by the operating system. Refer to the documentation provided by your operating system
for more information.
For additional information, see the Accessibility appendix in the User's Guide: NetView.

Support information
If you have a problem with your IBM software, you want to resolve it quickly. IBM provides the following
ways for you to obtain the support you need:
Online
Please follow the instructions located in the support guide entry: https://www.ibm.com/support/
home/pages/support-guide/?product=4429363.
Troubleshooting information
For more information about resolving problems with the IBM Z NetView product, see the IBM Z
NetView Troubleshooting Guide. You can also discuss technical issues about the IBM Z NetView
product through the NetView user group located at https://groups.io/g/NetView. This user group is for

xiv IBM Z NetView: User's Guide: NetView Management Console


IBM Z NetView customers only, and registration is required. This forum is also monitored by interested
parties within IBM who answer questions and provide guidance about the NetView product. When a
problem with the code is found, you are asked to open an official case to obtain resolution.

Conventions used in this publication


This section describes the conventions that are used in this publication.

Typeface conventions
This publication uses the following typeface conventions:
Bold
• Lowercase commands and mixed case commands that are otherwise difficult to distinguish from
surrounding text
• Interface controls (check boxes, push buttons, radio buttons, spin buttons, fields, folders, icons,
list boxes, items inside list boxes, multicolumn lists, containers, menu choices, menu names, tabs,
property sheets), labels (such as Tip:, and Operating system considerations:)
• Keywords and parameters in text
Italic
• Citations (examples: titles of publications, diskettes, and CDs
• Words defined in text (example: a nonswitched line is called a point-to-point line)
• Emphasis of words and letters (words as words example: "Use the word that to introduce a
restrictive clause."; letters as letters example: "The LUN address must start with the letter L.")
• New terms in text (except in a definition list): a view is a frame in a workspace that contains data.
• Variables and values you must provide: ... where myname represents...
Monospace
• Examples and code examples
• File names, programming keywords, and other elements that are difficult to distinguish from
surrounding text
• Message text and prompts addressed to the user
• Text that the user must type
• Values for arguments or command options

Operating system-dependent variables and paths


For workstation components, this publication uses the UNIX convention for specifying environment
variables and for directory notation.
When using the Windows command line, replace $variable with %variable% for environment variables
and replace each forward slash (/) with a backslash (\) in directory paths. The names of environment
variables are not always the same in the Windows and UNIX environments. For example, %TEMP% in
Windows environments is equivalent to $TMPDIR in UNIX environments.
Note: If you are using the bash shell on a Windows system, you can use the UNIX conventions.

Syntax diagrams
The following syntax elements are shown in syntax diagrams. Read syntax diagrams from left-to-right,
top-to-bottom, following the horizontal line (the main path).
• “Symbols” on page xvi
• “Parameters” on page xvi

About this publication xv


• “Punctuation and parentheses” on page xvi
• “Abbreviations” on page xvii
For examples of syntax, see “Syntax examples” on page xvii.

Symbols
The following symbols are used in syntax diagrams:

Marks the beginning of the command syntax.

Marks the end of the command syntax.

Indicates that the command syntax is continued on the next line.

Indicates that a statement is continued from the previous line.


|
Marks the beginning and end of a fragment or part of the command syntax.

Parameters
The following types of parameters are used in syntax diagrams:
Required
Required parameters are shown on the main path.
Optional
Optional parameters are shown below the main path.
Default
Default parameters are shown above the main path. In parameter descriptions, default parameters
are underlined.
Syntax diagrams do not rely on highlighting, brackets, or braces. In syntax diagrams, the position of
the elements relative to the main syntax line indicates whether an element is required, optional, or the
default value.
When you issue a command, spaces are required between the parameters unless a different separator,
such as a comma, is specified in the syntax.
Parameters are classified as keywords or variables. Keywords are shown in uppercase letters. Variables,
which represent names or values that you supply, are shown in lowercase letters and are either italicized
or, in NetView help, displayed in a differentiating color.
In the following example, the USER command is a keyword, the user_id parameter is a required variable,
and the password parameter is an optional variable.
USER user_id
password

Punctuation and parentheses


You must include all punctuation that is shown in the syntax diagram, such as colons, semicolons,
commas, minus signs, and both single and double quotation marks.
When an operand can have more than one value, the values are typically enclosed in parentheses and
separated by commas. For a single value, the parentheses typically can be omitted. For more information,
see “Multiple operands or values” on page xviii.

xvi IBM Z NetView: User's Guide: NetView Management Console


If a command requires positional commas to separate keywords and variables, the commas are shown
before the keywords or variables.
When examples of commands are shown, commas are also used to indicate the absence of a positional
operand. For example, the second comma indicates that an optional operand is not being used:

COMMAND_NAME opt_variable_1,,opt_variable_3

You do not need to specify the trailing positional commas. Trailing positional and non-positional commas
either are ignored or cause a command to be rejected. Restrictions for each command state whether
trailing commas cause the command to be rejected.

Abbreviations
Command and keyword abbreviations are listed in synonym tables after each command description.

Syntax examples
The following examples show the different uses of syntax elements:
• “Required syntax elements” on page xvii
• “Optional syntax elements” on page xvii
• “Default keywords and values” on page xvii
• “Multiple operands or values” on page xviii
• “Syntax that is longer than one line” on page xviii
• “Syntax fragments” on page xviii

Required syntax elements


Required keywords and variables are shown on the main syntax line. You must code required keywords
and variables.
REQUIRED_KEYWORD required_variable

A required choice (two or more items) is shown in a vertical stack on the main path. The items are shown
in alphanumeric order.
REQUIRED_OPERAND_OR_VALUE_1

REQUIRED_OPERAND_OR_VALUE_2

Optional syntax elements


Optional keywords and variables are shown below the main syntax line. You can choose not to code
optional keywords and variables.

OPTIONAL_OPERAND

A required choice (two or more items) is shown in a vertical stack below the main path. The items are
shown in alphanumeric order.

OPTIONAL_OPERAND_OR_VALUE_1

OPTIONAL_OPERAND_OR_VALUE_2

Default keywords and values


Default keywords and values are shown above the main syntax line in one of the following ways:

About this publication xvii


• A default keyword is shown only above the main syntax line. You can specify this keyword or allow it
to default. The following syntax example shows the default keyword KEYWORD1 above the main syntax
line and the rest of the optional keywords below the main syntax line.
• If an operand has a default value, the operand is shown both above and below the main syntax line. A
value below the main syntax line indicates that if you specify the operand, you must also specify either
the default value or another value shown. If you do not specify the operand, the default value above the
main syntax line is used. The following syntax example shows the default values for operand OPTION=*
above and below the main syntax line.

KEYWORD1 OPTION=*
COMMAND_NAME
KEYWORD1 OPTION= *
KEYWORD2 VALUE1

KEYWORD3 VALUE2

Multiple operands or values


An arrow returning to the left above a group of operands or values indicates that more than one can be
selected or that a single one can be repeated.
KEYWORD= (
,

REPEATABLE_OPERAND_OR_VALUE_1

REPEATABLE_OPERAND_OR_VALUE_2

REPEATABLE_OPERAND_OR_VALUE_3

value_n )

Syntax that is longer than one line


If a diagram is longer than one line, each line that is to be continued ends with a single arrowhead and the
following line begins with a single arrowhead.
OPERAND1 OPERAND2 OPERAND3 OPERAND4 OPERAND5 OPERAND6

OPERAND7 OPERAND8

Syntax fragments
Some syntax diagrams contain syntax fragments, which are used for lengthy, complex, or repeated
sections of syntax. Syntax fragments follow the main diagram. Each syntax fragment name is mixed case
and is shown in the main diagram and in the heading of the fragment. The following syntax example
shows a syntax diagram with two fragments that are identified as Fragment1 and Fragment2.

COMMAND_NAME Fragment1

Fragment2

Fragment1
KEYWORD_A= valueA KEYWORD_B KEYWORD_C

Fragment2
KEYWORD_D KEYWORD_E= valueE KEYWORD_F

xviii IBM Z NetView: User's Guide: NetView Management Console


Part 1. Overview

© Copyright IBM Corp. 1997, 2022 1


2 IBM Z NetView: User's Guide: NetView Management Console
Chapter 1. Introduction to the NetView Management
Console

The NetView management console of Z NetView graphically displays the resources that represent a
network, a portion of a network, or a group of networks at various levels of detail. These views show the
network and systems resources that you are monitoring. When you monitor a network, resource status
changes are reflected graphically in the views.

What You Can Do with NetView Management Console


You can use the NetView management console to perform the following tasks:
• Monitor and control large portions of complex business systems.
• View the topology and connectivity of your network graphically.
• Monitor the overall state of a network or a portion of a network through aggregates, which represent the
combined status of a group of related applications and resources.
• Navigate easily from an aggregate to a real resource that is failing.
• Mark resources for your own purposes; for example, to show that they are being serviced.
• Display a list of events or status changes received for a selected resource.
• Issue predefined commands from context menus, or issue your own commands.
• Stop and restart selected resources.
• Monitor and manage multiple NetView programs.
• Cycle through open views automatically, at intervals.
• Build custom view and aggregate resource collections.
• Monitor resources by exception, to show on the screen only when the resources need the attention of
the operator.
• Mark resources for your own purposes; for example, to show that they are being serviced.
NetView management console provides the added capability to create demonstrations from your live
NetView management console views. These demonstrations can be used to aid in a variety of activities
including:
• Operator training within your corporate setting
• Showing your customers what you can offer them
• NetView management console advocacy
You can create these demonstrations by capturing live NetView management console views and
integrating them into the demonstration. This makes your demonstrations look and feel like your real
NetView management console system. For complete information about creating demonstrations, see
Appendix C, “Creating a Demonstration,” on page 107.

How the NetView Management Console Works


The NetView management console consists of a server and a Java-based console, which are generically
referred to in this book and the online help as the topology server and topology console.
The topology console graphically displays systems and networking information provided by Z NetView.
This information is displayed as Resource Object Data Manager (RODM) based views and is only available
if a conversation is set up between the topology server and the NetView host. See Chapter 7, “Operating
the NetView Management Console,” on page 51 for information about setting up this conversation using
the NETCONV command.

© Copyright IBM Corp. 1997, 2022 3


Topology Server
The topology server interacts with Graphic Monitor Facility host subsystem (GMFHS) and RODM and
provides information for display on the topology console.
The topology server furnishes the topology console with a set of tasks that are applicable for a resource.
These tasks are shown in context-sensitive menus on the topology console.
The topology server also stores files on behalf of the topology console, including icons, backgrounds, help
files, log files, customized views, and settings.
Note that you must have a conversation between the topology server and the NetView host set up using
the NETCONV command. See Chapter 7, “Operating the NetView Management Console,” on page 51 for
information about setting up communications with the NetView host.

Topology Console
The topology console graphically displays network information from the topology server. It displays
systems and networking views. It uses color to indicate the status of each resource, and the status of
the entire network. As the topology server receives configuration and status updates about the network,
it updates the topology console. This enables the topology console to always display the real-time
configuration of the network.

Real and Aggregate Resources


The topology console can display both real and aggregate resources. A real resource is a single
component or link (connection) in a network. An aggregate resource represents a collection of real or
aggregate resources. When displayed on the topology console, the icon for an aggregate resource or an
aggregate link has a plus (+) sign. The status of an aggregate resource is a reflection of the status of its
underlying real resources. When you monitor an aggregate resource, you are monitoring the overall status
of a portion of the network.
You can define real resources as critical and noncritical using aggregation priority. Critical resources
are resources that are considered important to the operation of the network and are assigned a high
aggregation priority (1 or greater). If the status of a critical resource changes to unsatisfactory, for
example, the status of the aggregate resource also changes to degraded. Noncritical resources have low
aggregation priorities (0).
You can set the aggregation priority on a resource from the Resource Properties notebook for a selected
resource.
When a real resource changes status, the status of an aggregate of which the resource is a part is
determined in the following way:
• The status of the parent aggregate of the resource is determined by the statuses of the real resource
and its siblings.
• The status of the grandparent aggregate of the resource is determined by the statuses of the real
resources under the parent.

4 IBM Z NetView: User's Guide: NetView Management Console


Part 2. Installing and Customizing the NetView
Management Console

© Copyright IBM Corp. 1997, 2022 5


6 IBM Z NetView: User's Guide: NetView Management Console
Chapter 2. Installing the NetView Management
Console

Installation instructions are provided in the installation README files. This chapter provides information
on selecting the correct README file based on whether you are installing the topology server or
topology console and information about configuring some parts of the NetView management console.
For additional installation information about the various features of the NetView management console,
see IBM Z NetView Installation: Configuring Graphical Components.
The README files contain installation instructions, hardware and software requirements, and late-
breaking news. They are available in the following locations:
• The NetView CD-ROM in the README directory under the ENU or JPN subdirectories, where ENU
represents English and JPN represents Japanese.
• IBM Fix Central web page. From the Fix Central web page (https://www.ibm.com/support/fixcentral/
options), you can find IBM Z NetView from either the “Find product” column or “Select product”
column. On the “Identify fixes” page that opens, you can either search for fixes for your specific
product, type, and platform or search for a fix by ID.
For complete installation instructions for the topology console, see the EGVREAD1 README file (English)
or the EGVREAD3 README file (Japanese).
For complete installation instructions for the topology server, see the EGVREAD2 README file (English) or
the EGVREAD4 README file (Japanese).

Defining the IBM Z NetView User ID and Password on the Topology


Server
Using the optional hostcmd command to send commands from the topology server (using a command
prompt on the topology server workstation) to the z/OS environment requires a Z NetView operator
ID and password or password phrase. If the operator ID and password or password phrase can be
determined in any of the following three ways and in the following order, the hostcmd command does not
prompt you for them:
1. The tserver hostcmd command is issued with the -u and -p options, which specify the user (operator)
ID and password or password phrase. This method overrides the other 2 methods.
2. The tserver hostcmdoper command is used to set the operator ID and password or password phrase.
This command encrypts the password or or password phrase and stores it on disk. This method is
overridden by the previous method and overrides the following method.
3. The ihsshstc.cfg file is customized by using the following steps. This method is overridden by
either of the other 2 methods.
a. In a workstation command window, change to one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\config
• For AIX or Linux systems: $BINDIR/TDS/server/config
b. Edit the ihsshstc.cfg file to specify the operator ID and the password or password phrase of the
NetView operator for which the commands are to be run.
• Specify the NetView operator ID in the OPER_ID parameter.
• Specify the password or password phrase for that operator ID in the OPER_PW parameter.

© Copyright IBM Corp. 1997, 2022 7


8 IBM Z NetView: User's Guide: NetView Management Console
Chapter 3. Customizing the NetView Management
Console Topology Server

This chapter describes customization of the NetView management console topology server to perform
specific functions.

Modifying the Server Properties File


You can customize the NetView management console topology server by modifying the
server.properties file, which is provided with the topology server. One reason to customize this
file is to set the defaults for the audit log, as described in “Auditing Functions and the Server.Properties
File” on page 9.
The server.properties file is a plain text configuration file that enables control of the following
functions:
• Communications timeouts
• Performance tuning
• View appearance
• Audit log attributes
These functions are used by the server at run time and affect all consoles attached to the server. Usually,
the settings in the server.properties file should be left at the default levels. The file contains a
detailed description of the items available for configuration. The server.properties file is located in one of
the following directories:
• For Windows systems: %BINDIR%\TDS\server\config
• For AIX or Linux systems: $BINDIR/TDS/server/config
To customize topology server functions, perform the following steps:
1. Make a backup copy of the server.properties file.
2. Open the server.properties file in a text editor and make the necessary changes.
3. Restart the topology server so that the changes can take effect.

Auditing Functions and the Server.Properties File


The server.properties file contains auditing function specifications that can be set to control the
output and format of the auditing log.

Customizing the Functions to be Audited


You can determine which functions to audit in the server.properties file. The attribute for each of
the functions that can be audited can have two possible values. If the attribute value is 1, the auditing is
performed. If the attribute value is 0 (zero) then auditing is not performed. If a value that is not valid is
assigned to the attribute, then the default value is used. Table 2 on page 9 describes the attributes and
gives the default value for each.

Table 2. Auditing function attributes.


Attribute in server.properties file Description of function to be (or not to Default
be) audited value
auditAggregationChange Aggregation priority and threshold 0
change requests

© Copyright IBM Corp. 1997, 2022 9


Table 2. Auditing function attributes. (continued)
Attribute in server.properties file Description of function to be (or not to Default
be) audited value
auditCommand Listing commands to be run 1
auditCommandResponse Listing responses to commands 0
auditConsoleSignonSignoff Signing on and off of the NetView 1
management console topology console
auditCPESignonSignoff Signing on and off of the command profile 1
editor (CPE) batch utility
auditFlagChange Flag change and list suspended 0
resources requests
auditNetconvUpDown Running the NETCONV command to start 1
and stop communication between the
host and server
auditSendMessage Sending messages 0
auditServerStartStop Starting and stopping the NetView 1
management console topology server
auditViewClose Closing views 0
auditViewCustomizationSaveRemove Saving, removing, and deleting 0
customized views
auditViewOpenRequest Requesting views from the NetView host 0
auditViewOpenResponse Opening views 0

Customizing the Audit Log for Viewing


The ihsaudit.xml file is the log file which contains the data specified by the attributes in the
server.properties file as described in the section “Customizing the Functions to be Audited” on
page 9.
For example, an ihsaudit.xml file can contain audit entries indicating the start and initialization of a
NetView management console topology server, netconv communication from the NetView management
console topology server to a host, and a NetView management console topology console signing on to the
NetView management console topology server. The following example contains such audit entries:

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


<?xml-stylesheet href="../sample/ihsaudit.css" type="text/css" ?>

<auditLog>

<auditEntry>
<date>2001-12-11 15:22:24</date>
<nmcServer>
<action>start</action>
</nmcServer>
</auditEntry>

<auditEntry>
<date>2001-12-11 15:23:09</date>
<netconv>
<action>up</action>
<nvDomain>CNM01</nvDomain>
<ipAddr>1.2.3.4</ipAddr>
<hostname>netview.hostname</hostname>
</netconv>
</auditEntry>

<auditEntry>

10 IBM Z NetView: User's Guide: NetView Management Console


<date>2001-12-11 15:23:10</date>
<nmcServer>
<action>initialized</action>
</nmcServer>
</auditEntry>

<auditEntry>
<date>2001-12-11 15:23:22</date>
<nmcConsole>
<action>signon</action>
<id>netop1</id>
<ipAddr>5.6.7.8</ipAddr>
<hostname>server.hostname</hostname>
<admin>yes</admin>
</nmcConsole>
</auditEntry>

</auditLog>

Refer to Appendix F, “Auditing and the ihsaudit.xml File,” on page 131 for information about elements in
the ihsaudit.xml file.
The audit log can be viewed by a Web browser, or other application, which supports XML. To enable a Web
browser or other XML application to display the contents of the audit log properly, header lines must be
inserted in the ihsaudit.xml log file. These lines are set in the server.properties file and determine
the appropriate style sheet to be used for the browser. The header lines are inserted only when the
topology server creates a new ihsaudit.xml file, not every time an audit entry is written to the file.
Note: Ensure that your Web browser or XML application supports the format of the style sheet that you
choose.
The audit log file is located in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\log
• For AIX or Linux systems: $BINDIR/TDS/server/log
Table 3 on page 11 describes the XML attributes in the server.properties file.

Table 3. XML attributes set in the server.properties file.


Attribute in Description of function Default value
server.properties file
auditLogHeaderLine.1 Sets the XML version 1.0
auditLogHeaderLine.2 Sets the style sheet to be used to enable the ihsaudit.css
appropriate Web browser or XML application

Example:

auditLogHeaderLine.1 =<?xml version="1.0" encoding="utf-8" ?>


auditLogHeaderLine.2 =<?xml -stylesheet href="../sample/ihsaudit.css"
type="text/css" ?>

Customizing the Size of the Audit Log


When the audit log file reaches the size specified with the auditLogFileMaxSize attribute in the
server.properties file, it is renamed ihsaudit.bak. A new ihsaudit.xml file is then created. It is
possible for the audit log to be slightly greater in size than specified by the auditLogFileMaxSize
attribute. Audit entries are written to the log until the file size is equal to or greater than the
value of auditLogFileMaxSize. For example, if the actual size of the file is 999 999 and the
auditLogFileMaxSize is set to 1 000 000, then one more audit log entry is written to the file. Table 4
on page 12 describes the auditLogFileMaxSize attribute in the server.properties file.

Chapter 3. Customizing the NetView Management Console Topology Server 11


Table 4. Audit log size attribute set in the server.properties file.
Attribute in Description Default Valid values
server.properties file value
auditLogFileMaxSize Determines the size of the audit log file, in 20 1–1000 (1
megabytes megabyte to 1
gigabyte)

If the value for the auditLogFileMaxSize attribute is set to 20, then the maximum file size is actually
20 000 000 bytes.
Notes:
1. If an incorrect value is entered for the auditLogFileMaxSize attribute, the default value is used.
2. If there was a previous ihsaudit.bak file, that file is deleted and replaced with the most current
ihsaudit.xml backed up and renamed ihsaudit.bak.

Customizing the Length of Command Responses within the Audit Log


Audit log entries for command responses are written to the audit log if the auditCommandResponse
value specified in the server.properties file is set to 1. The auditCommandResponse attribute
is described in “Customizing the Functions to be Audited” on page 9. The maximum line
length of these command responses can be specified in the server.properties file with the
auditCommandResponseMaxSize attribute. When command responses exceed the length specified
by this attribute, they are truncated in the audit log. Table 5 on page 12 describes the
auditCommandResponseMaxSize attribute in the server.properties file.

Table 5. Command response length attribute set in the server.properties file.


Attribute in server.properties file Description Default Valid values
value
auditCommandResponseMaxSize Determines the maximum 1000 0–10 000
line length of command
responses, in bytes, written
to the audit log.

Notes:
1. The 0 (zero) value indicates that the command response is not truncated.
2. If an incorrect value is entered, the default value 1 000, is used.
3. If the command response contains an ampersand, (&), then the truncated string can be a few
characters shorter or longer than the auditCommandResponseMaxSize indicates. If an ampersand
(&) has been translated to a string of characters that can be browsed (&amp;), for example, then the
complete string is included in the truncated command response, regardless of the length of the string.

Customizing Special Characters to be Browsed


Without using the auditTranslateToBrowseableChars attribute in the server.properties file,
the following set of characters can cause an error so that the ihsaudit.xml file cannot be opened in a
browser:
• & (ampersand)
• < (less than)
• > (greater than)
The auditTranslateToBrowseableChars changes these characters to a string of characters that can
be browsed within the following XML tags:

12 IBM Z NetView: User's Guide: NetView Management Console


• <cmd>
• <cmdResp>
• <locateName>
• <menuText>
• <msg>
• <note>
• <viewName>
The auditTranslateToBrowseableChars attribute in the server.properties file translates
these characters so that the ihsaudit.xml file can be viewed by a browser. The
auditTranslateToBrowseableChars attribute in the server.properties file is described in Table
6 on page 13.

Table 6. Characters to be browsed attribute set in the server.properties file.


Attribute in server.properties file Description Default Valid values
value
auditTranslateToBrowseableChars When set to 1, this attribute 1 0 or 1
translates the characters in the
following way:
• & to &amp;
• < to &lt;
• > to &gt;
When set to 0, these characters
are not translated.

Note: If a value other than 0 or 1 is entered for this attribute, the default (1) is used.

Customizing the Replacement Character for Carriage Returns and Line Feeds
Command responses often contain carriage return and line feed characters. Some browsers are
unable to display an audit entry that contains these characters. However, you can choose to
replace the carriage return and line feed characters with a character or multiple characters
of your choice. To insert characters for the carriage return and line feed characters, use the
auditCarriageReturnReplacement attribute and specify the characters to be used for delineation
with the auditCarriageReturnReplacementValue attribute in the server.properties file as
described in Table 7 on page 13.

Table 7. Line return delineation attribute set in the server.properties file.


Attribute in server.properties file Description Default Valid
value values
auditCarriageReturnReplacement Determines if the carriage 1 0 and 1
returns and line feeds are
to be replaced with a
character or characters
auditCarriageReturnReplacementValue If the value null (this 0 to 25
of auditCarriage field is bytes
ReturnReplacement is empty)
1, determines the
characters with which
to replace the carriage
returns and line feeds.

Chapter 3. Customizing the NetView Management Console Topology Server 13


When the auditCarriageReturnReplacement value is set to 1, the
auditCarriageReturnReplacementValue is examined and the value assigned to the
auditCarriageReturnReplacementValue attribute is used as the delimiter between lines.
If the auditCarriageReturnReplacementValue attribute is not assigned a value (but the
auditCarriageReturnReplacement attribute value is set to 1) then the carriage return and line feed
characters are replaced with a single blank character.
When the value of auditCarriageReturnReplacement is set to 0, then no replacements occur and
the auditCarriageReturnReplacementValue is ignored.
Notes:
1. The value assigned to the auditCarriageReturnReplacementValue field is not interpreted but is
used as it occurs. For example, if the auditCarriageReturnReplacementValue value is set to /n,
then the two characters /n replace the carriage return and line feed characters; this does not cause a
line return.
2. If the value assigned to the auditCarriageReturnReplacementValue attribute is longer than 25
characters, the string is truncated to the first 25 characters.

14 IBM Z NetView: User's Guide: NetView Management Console


Chapter 4. Customizing the NetView Management
Console Topology Console

This chapter describes basic customization of the NetView management console topology console and
the advanced customization that can be performed to change the look, feel, and function.

Customizing Topology Console Functions


You can customize the NetView management console topology console by adding or changing any of the
following items:
• Topology console icons
• Topology console backgrounds
• Topology console help facility
• Web browser for displaying views
• Double-click mouse actions for real or aggregate resources
Customization is performed at the topology server so that it automatically deploys to each topology
console that subsequently signs on.

Adding and Customizing Topology Console Icons


To add a new icon to the topology console, create an icon in one of the following graphical interchange
formats (GIFs):
32x32 pixels
This size is required. The file must be named 32_xxxx.gif (using only lowercase letters).
24x24 pixels
This size is optional and is used for the medium view sizes. If this size is not provided, the 32_xxxx.gif
version is automatically scaled. The file must be named 24_xxxx.gif (using only lowercase letters).
16x16 pixels
This size is optional and is used for the smaller view sizes. If this size is not provided, the 32_xxxx.gif
version is automatically scaled. The file must be named 16_xxxx.gif (using only lowercase letters).
Note: Animated GIFs are not supported.
Place the GIF files in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\db\current\icons
• For AIX or Linux systems: $BINDIR/TDS/server/db/current/icons
You can also change existing icons in these directories using any tool that enables GIF file manipulation.
One example of a customized icon is the company icon. To customize this icon, use the Console Properties
notebook. For details, see the icon customization procedures in the NetView management console online
help.

Adding and Customizing Topology Console Backgrounds


To add a new background image to the topology console, create an image file following these guidelines:
• The name of the file must contain only lowercase letters.
• For a GIF image, use gif for the extension (or file type).
• For a JPEG image, use jpg for the extension (or file type).
• Use a size of 300x500 pixels.

© Copyright IBM Corp. 1997, 2022 15


Store the image file in the appropriate topology server directory:
• For Windows systems: %BINDIR%\TDS\server\db\current\backgrounds
• For AIX or Linux systems: $BINDIR/TDS/server/db/current/backgrounds
You can also change the existing backgrounds in these directories using any tool that enables GIF or JPG
manipulation.
Customized backgrounds are associated with a view. See the NetView management console online help
for specific steps on how to customize a view background.
Note: Removing unused backgrounds reduces the install download time for the topology console.

Customizing Your Online Help Facility


As an alternative to using the built-in NetView management console help facility, you can specify your
own web browser to display HTML help pages. Select the General tab on the Console Properties
notebook. In the group box labeled Configure help facility, select one of the following options:
• Use the built-in help facility.
• Use my default web browser.
• Let me specify my own browser.
To specify your own web browser, use lower case only, and specify the full drive and path name for the
web browser executable file. Click Browse to navigate to the directory and locate the executable file. If
you specify $URL anywhere in the specified path, the web address of the help is substituted for $URL
automatically. If you do not specify a $URL, the web address of the help is appended to the end of the
given command path. If you use a blank in your path name, enclose the entire command in quotation
marks.
When online help is selected from the menu, the corresponding HTML help pages are sent to your
browser. An HTML message is displayed in either case (if problems occur either in launching the web
browser or after successfully launching the web browser).
Note: If you request help at the Sign On dialog box, the help is displayed in the NetView management
console help facility, regardless of your choice of help facility in this Console Properties settings page. At
the time you sign on, the values specified on the console settings page are not yet available.

Configuring a Web Browser to Display Views

Designating a Console as a Web Server


When you first install the NetView management console, the web server function is not enabled. Use the
Web Server page in the Console Properties notebook to designate the console as a web server. Click the
Help button on the Web Server page for detailed descriptions of the page settings.

Designating Multiple Consoles as Web Servers


You can designate multiple consoles on the same system as web servers, so that each console can set
up its own set of views. Supply the data on the Web Server page in the Console Properties notebook
to designate each console as a web server, ensuring that you set the port number ranges so that each
console on the same system can have a unique port number. Web servers on different systems can have
the same port number.

Using the Web Browser


After designating the console system as a web server, enter the fully qualified host name or IP address of
the console system as a web address in the web browser. You do not need to add prefixes (http, www, and
so on), although you might need to fully qualify the host name. If the port number for the web server is not
80, follow the host name with a colon (:) and also the port number in the browser. The port number for the

16 IBM Z NetView: User's Guide: NetView Management Console


web server is displayed on the Web Server page of the Console Properties notebook. If the port number is
80, the web address looks like this:

Clientname

If the port number is not 80, the web address looks like this:

Clientname:Port number

You cannot see a view in the web browser until you add that view to the set of available views on the
console. The view is displayed in the web browser after the next web browser refresh interval and the
following information is displayed for the view:
• The number of available views
• The name of the current view
• The time and date that the view was captured
The refresh interval is also displayed.
Web browser views are not dynamic: they are snapshots in time of a view that is opened on the console
system. If the status of a view changes, the change is shown in the browser after the next browser refresh
interval. As views are captured for the web server by the console system, they are added to a list of views.
To capture the view, it must be visible on the console.
If your console is configured to use the Cycle Views function, the views on the console are automatically
displayed for a certain time interval, enabling the views to be captured for the web server automatically.
To use the Cycle Views function to select the views and define the time interval to display them, from the
Windows menu, select Cycle Views.
Topology views in the web browser are the same size as the views captured on the console system. To
change the size of a topology view in the web browser, resize the view on the console and click Add View
to Web Server or Update View to Web Server on the pop-up menu. The re-sized view is shown in the
web browser at the next refresh, or you can manually reload the view in the web browser by clicking the
Reload button.
A list of available views is provided in the browser window. Select a view, and click Open. As additional
views are added to the set of available views on the console, they are added to the view list. Both
Topology and Details views can be displayed as they are displayed on the console. Icons in the Details
view do not contain flags, background color, or an aggregate symbol.
You can manually refresh a view by right-clicking the view background on the console. From the pop-up
menu, select one of the following actions:
• Add View to Web Server
• Update View on Web Server
• Refresh Now (if the view was added)
The view is captured and sent to the browser. Click Reload from the web browser or wait for the next
refresh interval to see the refreshed view. If you did not select Make Views Available When They Are
Opened from the Web Server page, you must manually add views to the web browser. To do this,
right-click the view background and select Add View To Web Server from the pop-up menu. The view is
shown in the list of views available to the web browser at the next browser refresh interval.

Logging Web Server Messages


You can indicate on the Web Server page in the Console Properties notebook to create a record of each
view that is opened on the web browser and send the record to the console log. Do this only if you need
to closely track your views, since it creates a record every time a view is refreshed from the attached
browsers.

Chapter 4. Customizing the NetView Management Console Topology Console 17


Customizing Double-click Mouse Actions
You can customize the double-right-click and double-left-click mouse actions for real or aggregate
resources using the Console Properties notebook. Open the notebook by clicking Console Properties
on the Options menu item, and go to the Mouse page. For details about the page settings, click the Help
button on the Mouse page.
Note: When you use the console in demonstration mode, the customized mouse actions are not in effect.

Advanced Topology Console Customization


Several advanced customization tasks can be used for the topology console. Most of these tasks can be
performed without using the topology console interface.

Displaying Customized Help


You can create context menu help that displays a Hypertext Markup Language (HTML) document at the
topology console using the following instructions.
1. Create your document file using basic HTML tags.
Note: Use only lowercase characters in the file name and extension.
2. Place the help file into the appropriate directory on the topology server workstation:
• For Windows systems: %BINDIR%\TDS\server\db\current\help
• For AIX or Linux systems: $BINDIR/TDS/server/db/current/help
Note: You can also change existing help files which are located in these directories.
3. Add the new context command to the topology server using the command profile editor batch utility.
Create the command with the following values:
Command string field: com.tivoli.ihs.client.action.IhsShowDocument
document_file_name
Command exit field: IHSXTJAM
Add the command to the default profile. For an example of a command profile editor batch utility
response file, see sample ihsscp.xxx.rsp (where xxx is a country code indicator such as en_US)
in the sample topology server directory.

Enabling User Flags


Thirty-two flags are shipped with the NetView management console; eight of these can be customized.
When they are shipped from the factory, the values for all of them are disabled. Therefore, if one of
these flags is set for a resource, it does not display on any NetView management console user interface
component. To display these flags, they must first be enabled. After a customized flag is enabled, it
displays on the appropriate NetView management console user interface component (such as, in the
Resource Properties window, or the Filter Bar).
To enable any of the flags that can be customized, update the default operational scheme by performing
the following steps from the server workstation:
1. Make a backup copy of the NetView management console default operational scheme files with one
of the following methods:
• Use a packaging tool such as PKZip, WinZip, or tar.
• Create a backup directory and copy the default scheme files to it.
2. Determine the hexadecimal value of the specific user flag that you want to enable by using the
following steps:
a. Open the defaultscheme.properties file in a text editor.
b. Search for the string f1 to locate the section of the file where the flags are defined.

18 IBM Z NetView: User's Guide: NetView Management Console


c. Scroll down until you find the comment for the flag you want to enable.
For example:

* User 1
f25.value =0x00000080

The corresponding value of the attribute is the hexadecimal value for the flag. In this example,
0x00000080 is the User 1 flag value.
3. In the defaultscheme.properties file, search for the string FLAG values to locate the section of the
file where the flags are defined. The flags are defined in descending order.
4. Scroll down until you see the value for the user flag that you want to enable.
5. To enable this flag, change the value of the defDefine attribute from false to true.
Depending on how you want this flag to work, you might need to define additional attributes. All
flag attributes are documented by the com.tivoli.ihs.client.view.IhsUserStatus class as
shown in the following example.

# "Flag" Definition Values:


#
# fX.tag Reference tag (required).
# fX.defDefine Is this item defined? (optional, true).
# Set to false to disable this item.
# fX.isDefault Does this item contain default values for all other items?
# (optional, false).
# fX.weight Orders an item relative to other items by "weight"
# (optional, 100).
# fX.value Status value (required, only 1 bit can be on).
# fX.defFilter Currently not used.
# fX.defDisplay Currently not used.
#
# fX.onView Display sub-icon on topology view? (optional, false)
# fX.color Color of sub-icon on topology view. Flag with highest
# weight is used. (optional, gray)
# fX.reqAdmin Administrator required to set/clear (optional, false).
# fX.canSet Is this flag allowed to be set (turned on)? (optional,
# true)
# fX.canClear Is this flag allowed to be cleared (turned off)? (optional,
# true)
# fX.forAgg Applicable for an aggregate resource? (optional, false)
# fX.forReal Applicable for a real resource? (optional, true)
# fX.relatedTo Mask of "related" flags (optional, none).
#

For more information about self-documenting data classes for the NetView management console
topology console, see “Running a Console Class” on page 24.
6. Save your changes.
7. To define the wording for this user flag, open the defaultschemetext.properties file in a text editor.
8. Search for the f.xxxxxxx string where xxxxxxx is the hexadecimal value of the specific user flag you
are enabling.
9. Change the value of the f.xxxxxxx.label attribute to include all text for this flag.
10. Change the value of the f.xxxxxxx.abbrev attribute to the abbreviation you are assigning to this
flag.
11. Save the changes.
To verify that the flag you have enabled exists, perform the following steps:
1. Start an NetView management console topology console.
2. Open a view.
3. Select a resource and right-click to display the context menu.
4. Click Resource Properties.
5. Verify that the user flag is present on the Resource window.
6. Open the Console Properties notebook, select the Status page, and verify that the flag is present.

Chapter 4. Customizing the NetView Management Console Topology Console 19


The example in Table 8 on page 20 shows the changes that enable the User 1 flag and name it
Retired.

Table 8. Changing the User 1 Flag to Retired


File Before After
defaultscheme.properties * User 1 * User 1
f25.value =0x00000080 f25.value = 0x00000080
f25.weight =2000 f25.weight = 2000
f25.defDefine =false f25.defDefine = true

defaultschemetext.properties f.00000080.label = User 1 f.00000080.label =Retired


f.00000080.abbrev = User1 f.00000080.abbrev =Retd

Adding a Flag to the Context Menu


The following flags can be directly manipulated from resource specific context menus:
• Suspend, Manually Clear
• Suspend, Automatically Clear
• Clear Suspended
• Clear Child Suspended
You can enable context menu items for additional flags. From the server workstation, add a new flag
context menu item to the NetView management console default operational scheme. The properties files,
in which the NetView management console operational scheme is defined, are described briefly in Table 9
on page 20.

Table 9. NetView Management Console Properties Files


Scheme File Name Description
defaultscheme.properties Provides most of the operational definitions (except
required multicultural support enabled text).
1. COLOR Definitions (Not currently used)
2. FLAG Definitions
3. FLAG (User status) menu items
4. STATUS SCHEME values
5. STATUS values
6. STATUS MAPPING values (Not currently used)
7. MODE values (NetView management console only
supports Control mode)
8. LAYER values
9. Miscellaneous Control Values

defaultschemetext.properties Provides the English language set of multicultural


support enabled text that is required by the
defaultscheme.properties file. (Status text and colors
not currently used.)

20 IBM Z NetView: User's Guide: NetView Management Console


Table 9. NetView Management Console Properties Files (continued)
Scheme File Name Description
defaultschemetext_ja.properties Provides the Japanese language set of multicultural
support enabled text that is required by
defaultscheme.properties file. (Colors not currently
used.)

The disk location of the scheme properties files is determined by the NetView management console
operational mode (as shown in Table 10 on page 21).

Table 10. Location of Scheme Files


NetView Management Location of Scheme Files
Console Operational Mode
Signed on to a server <installRoot>\bin\<interp>\TDS\Server\db\current\settings
Demonstration <installRoot>\bin\generic_unix\TDS\client\settings

To add a new flag context menu item to the NetView management console default operational scheme,
perform the following steps:
1. Make a backup copy of the NetView management console default operational scheme with one of the
following methods:
• Use a packaging tool such as PKZip, WinZip, or tar.
• Create a backup directory and copy the default scheme files to it.
2. Determine the hexadecimal value of the specific user flag that you want to enable by performing the
following steps.
a. Open the defaultscheme.properties file in a text editor.
b. Search for the string f1 to locate the section of the file where the flags are defined.
c. Scroll down until you find the comment for the flag.
For example:

* Marked
f1.value =0x80000000

The corresponding value for the attribute is the hexadecimal value for the flag. In this example,
0x80000000 is the Marked flag value.
3. In the defaultscheme.properties file, search for the string User status menu items to locate the
section of the file where the context menu items for the flag are defined.
4. The menu items are defined in the order they are displayed in a context menu, so scroll to the end of
the list of menu items.
5. Create a new set of menu item attributes with a menux prefix (where x is the next sequence number).
For example:

menux.tag = <unique identifier for this menu item>


menux.value = <hex value of the flag that you want to enable>
menux.setTo = <true=set flag -or- false=Clear flag>

6. Depending on how you want this context menu item to work, you might also have to define additional
attributes.
The com.tivoli.ihs.client.view.IhsFlagMenuScheme class documents all menu item
attributes, as shown in the following example.

# "User Status Menu Item" Definition Values:


#

Chapter 4. Customizing the NetView Management Console Topology Console 21


# defaultscheme.properties:
# menuX.tag Reference tag (required).
# menuX.defDefine Is this item defined? (optional, true).
# Set to false to disable this item.
# menuX.isDefault Does this item contain default values for all other
# items?
# (optional, false).
# menuX.weight Orders an item relative to other items by "weight"
# (optional, 100).
# menuX.value Associated flag value (required, only 1 bit can be on).
# menuX.setTo When selected, set flag on (true) or off (false)
# (required).
# menuX.setRel If this flag is set, should a related flag also be set?
# (optional, false).
# See flag definitions relatedTo setting for the related
# flag.
# menuX.setRelTo If the related flag is to be set, set it on (true) or
# off (false) (optional).
# defaultschemetext.properties:
# menuX.text Menu text (required)
# menuX.help Menu help file (required)
#

For more information about self-documenting data classes for the NetView management console
topology console, see “Running a Console Class” on page 24.
7. Save the changes.
8. Open the defaultschemetext.properties file in a text editor and search for the string User
status menu items text to locate the section of the file where the flag menu items are defined.
9. Scroll down to the end of the list of menu items which are currently defined.
10. Create a new attribute with prefix that is the same as the menux value you used in the
defaultscheme.properties file.
For example:

menux.text= <text displayed for this menu item>

11. Save the changes.


To verify these changes, perform the following steps:
1. Start an NetView management console topology console.
2. Verify that the new context menu is displayed properly:
a. Open a view.
b. Locate a resource for which your new menu item should be available.
c. Right click on that resource and verify that your new menu item is present.
d. Select the menu item and verify that the flag was updated.
3. Verify that the definition of the default note was updated:
a. Open the Console Properties notebook and select the Notes® tab.
b. Verify that the new menu item is present.
For Resource Object Data Manager (RODM)-based resources, the NetView management console flags are
the 4-byte UserStatus fields. For details, see the IBM Z NetView Data Model Reference.
The example in Table 11 on page 23 shows the changes made to enable context menu items for
Markedflag in the defaultscheme.properties file.

22 IBM Z NetView: User's Guide: NetView Management Console


Table 11. The Markedflag Item in the defaultscheme.properties File
Before After

********************** *********************

* User status menu items * User status menu items

********************** *********************

menu1.setRelTo = false menu1.setRel = true

menu2.tag = SuspAut menu1.setRelTo = false

menu2.value = 0x40000000 menu2.tag = SuspAut

menu2.setTo = true menu2.value = 0x40000000

menu2.setRel = true menu2.setTo = true

menu2.setRelTo = true menu2.setRel = true

menu3.tag = ClearSusp menu2.setRelTo = true

menu3.value = 0x40000000 menu3.tag = ClearSusp

menu3.setTo = false menu3.value = 0x40000000

menu3.setRel = true menu3.setTo = false

menu3.setRelTo = false menu3.setRel = true

menu4.tag = ClearChildSusp menu3.setRelTo = false

menu4.value = 0x00800000 menu4.tag = ClearChildSusp

menu4.setTo = false menu4.value = 0x00800000

menu4.setTo = false

menu5.tag = SetMarked

menu5.value = 0x80000000

menu5.setTo = true

menu6.tag = ClearMarked

menu6.value = 0x80000000

menu6.setTo = false

The example in Table 12 on page 24 shows the changes that were made to enable context menu items
for the Markedflag in the defaultschemetext.properties file.

Chapter 4. Customizing the NetView Management Console Topology Console 23


Table 12. The Markedflag Item in the defaultschemetext.properties File
Before After

******************************* *********************************
* User status menu items text * User status menu items text
******************************* *********************************
menu1.text = Suspend, Manually Clear menu1.text = Suspend, Manually Clear
menu1.help = ihs_mi_clermansusp_xxx.html menu1.help = ihs_mi_clermansusp_xxx.html
menu2.text = Suspend, Automatically Clear menu2.text = Suspend, Automatically Clear
menu2.help = ihs_mi_clerautosusp_xxx.html menu2.help = ihs_mi_clerautosusp_xxx.html
menu3.text = Clear Suspended menu3.text = Clear Suspended
menu3.help = ihs_mi_clersuspended_xxx.html menu3.help = ihs_mi_clersuspended_xxx.html
menu4.text = Clear Child Suspended menu4.text = Clear Child Suspended
menu4.help = ihs_mi_clerchldsusp_xxx.html menu4.help = ihs_mi_clerchldsusp_xxx.html
menu5.text = Set Marked
menu6.text = Clear Marked

Running a Console Class


Many of the NetView management console topology console data classes are self-documenting. This
means that if you run the data class, it tells you all of the attributes that you can define in a properties file
to create an instance of the class. All of the NetView management console topology console classes are
contained in the \bin\generic_unix\tds\client\lib\ihseuc.jar file. To obtain information for a
specific data class, issue the following command from a console workstation:

java -classpath %classpath%;<installRoot>\bin\generic_unix\tds\client\lib\ihseuc.jar


<package qualified class name>

This command generates all the attributes for a flag, for example:

java -classpath %classpath%;<installRoot>\bin\generic_unix\tds\client\lib\ihseuc.jar


com.tivoli.ihs.client.view.IhsUserStatus

Customizing Web Server Enablement


You can enable or disable the web server function (as a tab on the Console Properties notebook). Table 13
on page 24 shows the values for enabling or disabling the web browser function; these values are set in
the defaultscheme.properties file.

Table 13. Enabling and Disabling the Web Server Function in the defaultscheme.properties File
defaultscheme.properties Attribute Default Value Other Valid Value
webServerPage.enable true false

To customize the web server enablement, the NetView management console operational scheme must be
updated, as shown in Table 13 on page 24. To customize web server enablement, perform the following
steps.
1. Make a backup copy of the default NetView management console operational scheme.
2. Open the defaultscheme.properties file in a text editor.
3. Search for the string webServerPage.

24 IBM Z NetView: User's Guide: NetView Management Console


4. Change the value on this line to false if you want to disable the Web Server function.
5. Save the changes.
To verify this change, perform the following steps:
1. Start an NetView management console topology console
2. Open the Console Properties notebook.
3. Verify that the Web Server tab is no longer displayed on the Console Properties notebook page.
Note: Setting the attribute in the defaultscheme.properties file overrides the automatic start
setting. For example, if you previously set the Web Server to automatically start and then set
webServerPage.enable=false, then the Web Server does not automatically start.
For more information about the NetView management console operational scheme, see Table 9 on page
20.

Customizing the View Bar Layout


You can adjust the number of rows or columns of view buttons displayed on the View Bar of the main
NetView management console window. The minimum size of the view buttons can also be adjusted.
Table 14 on page 25 shows the attributes used to adjust these settings. These attributes are set in the
defaultscheme.properties file.
Note: Either the number of rows or the number of columns can be customized, but not both. The value for
one of these settings must remain 0. The 0 value indicates that no maximum value exists for the attribute.

Table 14. Changing View Bar Attributes and Values in the defaultscheme.properties File
Attribute Description Default Minimum Maximum
Value Value Value
viewbar_max_rows = <int> Maximum number of 0 None
rows in the view bar grid.
New columns are added
to display additional
views.
viewbar_ max_columns = Maximum number of 0 None
<int> columns in the view
bar grid. New rows
are added to display
additional views.
viewbar_min_view_size = Minimum size to make 100 100
<int> a view when sizing the
views to fit on the view
bar.

To change the view buttons on the View Bar, update the NetView management console operational
scheme from the console or server workstation, depending on the mode in which you are running. See
Table 10 on page 21 to determine if the updates need to be performed from the server or console
workstation. To customize the view bar layout, perform the following steps:
1. Make a backup copy of the default NetView management console operational scheme.
2. Open the defaultscheme.properties file in a text editor.
3. Search for the string viewbar and locate the attribute to be changed.
4. Change the value of the attribute.
5. Save the changes.
The example in Table 15 on page 26 shows the changes made to the maximum number of rows in the
View Bar grid from 0 to 5.

Chapter 4. Customizing the NetView Management Console Topology Console 25


Table 15. Changing the Number of Rows in a View Bar in the defaultscheme.properties File
Before After

viewbar_max_rows = 0 viewbar_max_rows = 5

For more information about the NetView management console operational scheme, see Table 9 on page
20.

Customizing the Automatic Download of Files At Log On


When the console logs on to the server, the time stamp of the files (as stored on the console) and
the time stamp of the files on the server are compared. If the console consistently logs on to the
same server, these time stamps are the same and the files are not downloaded. See Appendix G,
“Automatic File Download at Console Log On,” on page 157 for more information. If the console logs
on to servers on different platforms, however, then these time stamps are slightly different. Use the
defaultscheme.properties file to set the tolerance level of the time difference between time stamps. The
tolerance level is a value, in minutes, between the times on the time stamps. If it is set to 0 (zero), for
example, then the files are automatically downloaded from the server unless the server and console time
stamps match exactly. Table 16 on page 26 shows the attribute and the range of valid values for this
attribute.

Table 16. Changing the Tolerance for Time Stamp Differences in the defaultscheme.properties File
defaultscheme.properties attribute Default Minimum Maximum
Value Value Value
file_download_timestamp_tolerance = int 720 (12 0 43,200 (30
hours) days)

The example in Table 17 on page 26 shows two scenarios in which the time stamp tolerance can be used
and the associated values.

Table 17. Time Stamp Tolerance Settings in the defaultscheme.properties File


Scenario Value to Use
The console is logging on to the same server Set the value to 0 (zero) in the following way:
and you want to automatically download any file_download_timestamp_tolerance = 0
files that have changed each time you log on.
You are logging on to multiple servers on Perform one of the following actions:
various platforms and you do not want the files
• Leave the default value of 12 hours:
to download each time you log on
file_download_timestamp_tolerance = 720
• Set the value higher, 3 days in this example:
file_download_timestamp_tolerance =
4320
• Set the value lower, 6 hours in this example:
file_download_timestamp_tolerance = 360

Overriding the Default Date and Time Format


By default, the Java™ run time obtains display formats for the date and time from the operating system.
On Windows systems, for example, the date and time display formats are defined by selecting Control
Panel, then Regional Settings. Unfortunately, certain changes, such as the time format, that are made
to these values are not propagated to Java 2 Runtime Environment, Standard Edition (J2RE). If you
change the Time format in Regional Settings in Windows, to display in 24-hour format, this change is not

26 IBM Z NetView: User's Guide: NetView Management Console


propagated to the J2RE. The topology console, therefore, seems to be out of sync with the rest of the local
applications.
You can force the console to override the use of the operating system formats and display the dates and
times you want. Table 18 on page 27 shows the attributes (in the defaultschemetext.properties file)
used to make this change.

Table 18. Changing the Date and Time Format in the defaultschemetext.properties File
Attributes Description

override.date = <format> Format used for formatting a date

override.time = <format> Format used for formatting a time

override.datetime = <format> Format used for formatting a composite date and time

The example in Table 19 on page 27 shows how a time stamp of 6:45:07 p.m. on March 30, 2001
displays for various format specifications.

Table 19. Example of Time Stamp Format Specifications.


Format Specification Resulting Display Text
yyyy.MM.dd 2001.03.30
yyyy.MMM.dd 2001.Mar.30
yyyy.MMMM.dd 2001.March.30
hh:mm:ss a 06:45:07 PM
hh:mm:ssa z 06:45:07PM EST
HH:mm:ss z 18:45:07 EST

To customize the date and time format, update the default operational scheme from the console or
the server workstation, depending on the mode in which you are running. See Table 10 on page 21 to
determine if the updates need to be performed from the server or console workstation. To customize the
date/time format, perform the following steps.
1. Make a backup copy of the default NetView management console operational scheme.
2. Open the defaultschemetext.properties file in a text editor.
3. Search for the string override.date.
4. Uncomment the override item by removing the leading * from the beginning of the line.
5. Change the value on the <value> line to the format specification you want.
The <value> field defines the format of the displayed item. It can contain both literal and substitution
symbols.
6. Save the changes.
To verify the changes, perform the following steps:
1. Start an NetView management console topology console.
2. Open a view.
3. Verify the override.datetime attribute change by checking the view information area in the status
bar.
4. Verify the override.date and override.time attribute changes by placing the view in details
mode and checking the Time/Date column.

Chapter 4. Customizing the NetView Management Console Topology Console 27


The example in Table 20 on page 28 shows the changes made to override all of the date and time display
formats. These changes were made in the defaultschemetext.properties file.

Table 20. Overriding the Date and Time Display Formats in the defaultschemetext.properties File
Before After

*************************** ***************************
* Date/Time Overrides Formats * Date/Time Overrides Formats
*************************** ***************************
* override.date =yyyy.MMM.dd override.date =yyyy.MMM.dd
* override.time =HH:mm:ss z override.time =HH:mm:ss z
* override.datetime=yyyy.MMM.dd @ HH:mm:ss z override.datetime=yyyy.MMM.dd @ HH:mm:ss z

For more information about the NetView management console operational scheme, see Table 9 on page
20.

Time Format Syntax


Table 21 on page 28 is an excerpt from the javadoc of the java.text.SimpleDateFormat class. It
provides details about all of the possible formatting capabilities. To specify the time format, use a time
pattern string. In this pattern, all ASCII letters are reserved as pattern letters, which are defined in Table
21 on page 28.

Table 21. Time Format Syntax


Symbol Meaning Presentation Example
G era designator (Text) AD
y year (Number) 2001
M month in year (Text & Number) April & 01
d day in month (Number) 10
h hour in a.m./p.m. (1-12) (Number) 12
H hour in day (0-23) (Number) 0
m minute in hour (Number) 30
s second in minute (Number) 55
S millisecond (Number) 978
E day in week (Text) Tuesday
D day in year (Number) 189
F day of week in month (Number) 2 (2nd Wed in July)
w week in year (Number) 27
W week in month (Number) 2
a a.m./p.m. marker (Text) PM
k hour in day (1-24) (Number) 24
K hour in a.m./p.m. (0-11) (Number) 0
z time zone (Text) Pacific Standard Time

28 IBM Z NetView: User's Guide: NetView Management Console


Table 21. Time Format Syntax (continued)
Symbol Meaning Presentation Example
' escape for text (Delimiter)
'' single quotation mark (Literal) '

The count of pattern letters determines the format in the following way:
• Text: If the presentation is in text and 4 or more pattern letters exist, then use the full form. If fewer
than 4 pattern letters exist, then use the short or abbreviated form, if one exists.
• Numeric: If the presentation is numeric, then the field contains the minimum number of digits. Shorter
numbers are zero-padded to this amount.
Note: The year is handled differently. If the count of contents of the y field is 2, then the year is
truncated to 2 digits.
• Text and numeric: If the presentation contains 3 or more bytes, use text, otherwise use numerics.
Any characters in the pattern that are not in the ranges of 'a' - 'z' and 'A' - 'Z'] are treated as quoted text.
For example, the following characters are displayed in the resulting time text (even if they are not within
single quotation marks):
• ':'
• '.'
• ''
• '#'
• '@'
Patterns containing a pattern letter that is not valid result in a thrown exception during formatting or
parsing.
The examples in Table 22 on page 29 use a US Location.

Table 22. Examples of Time and Date Formatting.


Format Pattern Result
"yyyy.MM.dd G 'at' hh:mm:ss z" 2001.04.01 AD at 15:08:56 PDT
"EEE, MMM d, ''yy" Sun, April 01, '01
"h:mm a" 12:08 PM
"hh 'o''clock' a, zzzz" 12 o'clock PM, Pacific Daylight Time
"K:mm a, z" 0:00 PM, PST
"yyyyy.MMMMM.dd GGG hh:mm aaa" 2001.April.01 AD 12:08 PM

Customizing Data1, Data2, and Data3 Field Labels for RODM Resources
You can customize the labels for the Data1, Data2, and Data3 fields for RODM resources, both real and
aggregate. The labels are defined in the defaultschemetext.properties file and the defaults are shown in
Table 23 on page 29.

Table 23. Default Text for Optional Data Fields for RODM Resources
defaultschemetext.properties Attribute Default Text
Data1.RODM.Resource Other Data
Data2.RODM.Resource User Data

Chapter 4. Customizing the NetView Management Console Topology Console 29


Table 23. Default Text for Optional Data Fields for RODM Resources (continued)
defaultschemetext.properties Attribute Default Text
Data3.RODM.Resource IP Address

The updates are made from the topology server or the topology console, depending on the mode in which
you are running; to determine where to make the updates, see Table 10 on page 21. To customize the
labels, follow these steps:
1. Make a backup copy of the default NetView management console operational scheme.
2. Open the defaultschemetext.properties file in a text editor.
3. For each attribute you want to change (Data1.RODM.Resource, Data2.RODM.Resource, or
Data3.RODM.Resource), find the attribute and change the attribute value to the text you want to use.
4. Save your changes.
Verify your changes in the following way:
1. Start the topology console.
2. Open a view.
3. Right-click a RODM resource, and click Resource Properties.
4. Verify that the label text you defined is shown.

Customizing Line Thickness


You can adjust the thickness of lines in a topology view. Table 24 on page 30 shows the values for line
thickness; these values are set in the defaultscheme.properties file.

Table 24. Changing Line Thickness (in Pixels)


defaultscheme.properties Attribute Default Value (in Minimum Value Maximum Value
Pixels) (in Pixels) (in Pixels)
line_thickness 2 1 4

To customize the line thickness, the NetView management console operational scheme must be updated,
as shown in Table 24 on page 30. This can be done from the console or the server workstation, depending
on the mode in which you are running. See Table 10 on page 21 to determine if the updates need to
be performed from the server or console workstation. To customize line thickness, perform the following
steps.
1. Make a backup copy of the default NetView management console operational scheme.
2. Open the defaultscheme.properties file in a text editor.
3. Search for the string line_thickness.
4. Change the value on this line to the line thickness (in pixels). The valid range is from 1 to 4.
5. Save the changes.
To verify this change, perform the following steps:
1. Start an NetView management console topology console.
2. Open a view.
3. Verify the line thickness while in the topology view.
The example in Table 25 on page 31 shows the changes made to the line thickness from two pixels to
one pixel.

30 IBM Z NetView: User's Guide: NetView Management Console


Table 25. Changing the Line Thickness in the defaultscheme.properties File
Before After

************************* *************************
* Thickness of connection lines in pixels * Thickness of connection lines in pixels
************************* *************************
line_thickness = 2 line_thickness = 1

For more information about the NetView management console operational scheme, see Table 9 on page
20.

Chapter 4. Customizing the NetView Management Console Topology Console 31


32 IBM Z NetView: User's Guide: NetView Management Console
Chapter 5. Topology Console Java Applications and
Plug-ins

This chapter contains Programming Interface information.


This chapter describes the Java applications and plug-ins provided with the NetView management
console. You can write applications or plug-ins to enhance topology console operation.
The example Java applications and plug-ins are installed as part of the NetView Management Console
Productivity Kit (on the Windows platform, only). Be sure to perform a custom installation of the NetView
management console topology console and select the NetView Management Console Productivity Kit.
Because the technical information about these applications and plug-ins is dynamically created using
javadoc, the applications and plug-ins cannot be described in their entirety. References to these examples
are made here. The NetView Management Console Productivity Kit contains more detailed technical
information (such as methods, fields, syntax and Java class hierarchy). To access this information, in
the Windows environment, double-click the NMC Productivity Kit icon on the desktop.
Note: Though the NetView Management Console Productivity Kit can be installed only on the Windows
platform, Java application and plug-in functions are available on any supported NetView management
console topology console platform.

Supplied Support Files


The files shown in Table 26 on page 33 provide additional support for the Java application and Java
plug-in examples.

Table 26. Files that Support the Java Examples


File Description
examples\java\ExampleJavaApp.jar This Java ARchive (JAR) file contains the
compiled class files of the examples, so they are
immediately usable.
examples\support\ExampleJavaApp.rsp This server Command Profile Editor (CPE) response
file is used to create the context menu command
definitions for the example Java applications so
that the server can include them in context menus.
examples\support\plugins.properties This is a plug-in definition file that loads all of the
example plug-ins.
examples\javadoc This is the starting point for the console API
documentation.

To access these files, see the Supplied Support Files section of the NetView Management Console
Productivity Kit.

Installing the Examples


The examples and support files are installed as part of the NetView Management Console Productivity
Kit. Currently, the NetView Management Console Productivity Kit can be installed only on the Windows
platform. See the Supplied Support Files section of the NetView Management Console Productivity Kit for
more information.

© Copyright IBM Corp. 1997, 2022 33


Enabling the Examples
Although the examples have been installed, certain steps are required to enable their use. The exact
steps vary, depending on how you want to access the examples. You can access the examples either while
connected to a server or while running the console in demonstration mode.
To run the examples while signed on to a server, perform these steps:
1. From the server workstation, access the console workstation where you have installed the example
files.
2. Change to the lib directory: cd %BINDIR%\TDS\server\db\current\lib where the BINDIR
environment variable defines the installation root of the server.
3. Copy the
<console_system_install_path>\bin\generic_unix\TDS\client\examples\java\ExampleJavaApp.jar file
to this directory. The ExampleJavaApp.jar file is now automatically downloaded to each console that
subsequently signs on to this server.
To run the examples in demonstration mode, perform these steps:
1. From the console workstation, change to the <install
path>\bin\generic_unix\TDS\client\examples\support directory.
2. Issue the following command:

copy plugins.properties ..\..\settings

Compiling the Examples


It is not necessary to compile the examples before they are used. A provided JAR file,
examples\java\ExampleJavaApp.jar contains the compiled examples. See Table 26 on page 33 for a brief
description of this file.
If you change an example, you need to recompile the example. Before you recompile the examples,
perform the following steps from a console workstation:
1. Install the console code.
2. Install Java™2 SDK, Standard Edition, v4.2 (J2SDK).
To recompile the examples after you have changed them, perform the following steps:
1. Change to the <install path>\bin\generic_unix\TDS\client\examples\java directory.
2. Compile the examples by issuing the following command:

javac -classpath %CLASSPATH%;..\..\lib\ihseuc.jar *.java

Note: To compile cleanly, the CLASSPATH environment variable must include the console code and the
J2SDK classes.
3. Create a new JAR file (to contain the compiled classes) using the following command:

jar -cfv ExampleJavaApp.jar *.class

4. Make the new JAR file available. For more information about this process, see “Enabling the
Examples” on page 34.

Tracing the Examples


The examples have been instrumented with RAS tracing. You can enable this tracing from the Service
page of the Console Properties notebook. To enable tracing, perform the following steps:
1. Select the Options menu item and then Console Properties to open the Console Properties
notebook.

34 IBM Z NetView: User's Guide: NetView Management Console


2. Select the Service tab, which is the last tab in the notebook.
3. Select the Customer component.
4. In the Trace types section, click one or more of the following check boxes:
• Constructors
• Public methods
• Callback methods
5. In the Additional Tracing Controls section, check the Details box so that all of the traced data is
displayed.
6. Click OK.

Problem Determination
Message IHS1011W is used to report problems encountered while loading a plug-in. Because plug-ins
are loaded before the console window has been created, this message cannot be displayed in a pop up
window or recorded in the Log window. Therefore, it is written to stderr.
The following errors are reported in the Why field that is specific to the plug-in:

The specified plug-in class does not exist


WARNING: Could not instantiate bean "PlugIn.Does.Not.Exist"
from JAR "d:\Tivoli\bin\w32-ix86\..\generic_unix\TDS\client\lib\ExampleJavaApp.jar"
We couldn't open the class file "PlugIn/Does/Not/Exist.class" in the JAR
IHS1011W: Unable to start a Java application.
Class: PlugIn.Does.Not.Exist
Why: Plug-in class not found
Phase: 1

Note: The first 3 lines of the preceding example are generated by the dynamic Java class loading
mechanism of the console.

The specified plug-in class exists but does not implement the IhsIPlugIn interface
IHS1011W: Unable to start a Java application.
Class: com.tivoli.ihs.client.IhsClientArgs
Why: Plug-in does not implement IhsIPlugIn interface
Phase: 2

Java Applications
A Java application consists of customer-written code that is initiated from a context menu item (as a
context menu item). The Application is defined in the command profile editor and runs on the topology
console (a Java virtual machine).
The context menu is defined to the topology server using the CPEBATCH batch utility.
Java applications can be either resource dependent or resource independent.
Dependent Java applications provide information about each selected resource. The
com.tivoli.ihs.client.action.IhsResInfo class, for example, provides this information.
Java applications provide information about their associated context menu items. The
com.tivoli.ihs.client.action.IhsCmdInfo class, for example, shows this. A Java application
extends the IhsJavaApplicationAdapter class.
After it is launched, the application can access any services provided by Java, certain topology console
services, or any additional customer or third party services. A command can be generated and issued
using any of the command exits provided by the topology server. For more information about command
exits, see Chapter 10, “Using NetView Management Console Command Profiles,” on page 77.
Note: For more details about any of the following items, see the Java Applications section of the NetView
Management Console Productivity Kit:
• The com.tivoli.ihs.client.action.IhsResInfo class
• The com.tivoli.ihs.client.action.IhsCmdInfo class

Chapter 5. Topology Console Java Applications and Plug-ins 35


• The IhsJavaApplicationAdapter class
• Topology console services

Java Application Examples


The example Java applications shown and described in Table 27 on page 36 are provided with NetView
management console.

Table 27. Available Java Application Examples


File Description
examples\java\ExampleGUIJavaApp.java Displays context in a window. It shows all of
the available information about the selected
resources. It can be used as either a resource
dependent or resource independent command.
examples\java\ExampleCmdWithResponse.java Illustrates sending a command to the IBM Z
NetView program and receiving all response
lines for subsequent processing.
examples\java\ExampleGUItoIML.java Illustrates writing a complex graphical
interface. It displays the data required to start
a 3174 device so that the user can select
appropriate options. A command is constructed
from the user input and sent to the IBM
Z NetView program. The results from the
command are displayed in the console Log
window.

Note: For detailed information about these Java classes, see the Java Application Examples section of the
NetView Management Console Productivity Kit.

Java Application Development Process


Use the following software development steps when developing a Java application:
1. Edit your application:
a. Use one of the provided Java application examples as a starting point.
b. Customize the example to meet your specific requirements.
2. Compile, package, and deploy your application. For more information about this process, see
“Compiling the Examples” on page 34.
3. Enable the new Java application. For more information about this process, see “Defining the Example
Java Applications” on page 36.
4. Test the Java application in the following way:
a. Sign on to the server containing the new code.
b. Display the Java application in a context menu.
c. Select the menu item and verify that it is working properly.
d. If necessary, enable service tracing options to help diagnose problems. For more information about
tracing, see “Tracing the Examples” on page 34.

Defining the Example Java Applications

From the Server


To run the example Java applications while signed on to a server, perform the following steps:

36 IBM Z NetView: User's Guide: NetView Management Console


1. Go to the command prompt of a workstation on which the NetView management console topology
server and console are both installed.
2. Use the server CPEBATCH program to define the example Java application so that it is displayed in the
context pop-up menu for a resource.
3. Change to the bin directory (where the BINDIR environment variable defines the installation root of
the server): cd %BINDIR%\TDS\server\bin.
4. Issue the following command:

cpebatch <console machine install path>\bin\generic_unix\TDS\client\examples


\support\ExampleJavaApp.rsp -i -g

In Demonstration Mode
To run the application examples in demonstration mode, from the console workstation, perform the
following steps:
1. Change to the <install path>\bin\generic_unix\TDS\client\settings directory.
2. Edit the basicdata.nmc file, locating the set.5.debug key (which is part of the @exJavaApps
group) and changing the value from true to false.

Running the Example Java Applications

From the Server


To run the example Java applications from the server, perform the following steps:
1. Start the console using the standard desktop icon.
2. Sign on to the appropriate server.
• For resource independent examples, perform the following steps:
a. Position the cursor over any white space in the business tree.
b. Right-click to display a context menu.
c. Select an example menu item.
Note: The context menu items for the example Java applications are named Example:
<application>.
• For resource dependent examples, perform the following steps:
a. Open a view that contains at least one real resource.
b. Right-click the real resource to display a context menu.
c. Select an example menu item.
Note: The context menu items for the example Java applications are named Example:
<application>.

In Demonstration Mode
To run the example Java applications in demonstration mode, perform the following steps:
1. Start the console in demonstration mode using the standard desktop icon.
• For resource independent examples, perform the following steps:
a. Position the cursor over any white space in the business tree.
b. Right-click to display a context menu.
c. Select an example menu item.
• For resource dependent examples, perform the following steps:

Chapter 5. Topology Console Java Applications and Plug-ins 37


a. Select Tasks → Locate Resource to open the Locate Resource window.
b. Type NTFFPU20 in the entry field and then click the Locate button.
c. In the view that opens, position the mouse over one of the nodes.
d. Right-click to display a context menu.
e. Select an example menu item.

Java Plug-Ins
Use plug-in code to control various aspects of console operation. Like a Java application, a plug-in is also
Java code that runs within the topology console Java virtual machine, but differs from a Java application
in that plug-ins have the following characteristics:
• Are not related to any view or resource.
• Are loaded each time you sign on to a topology server (after the plug-ins definition properties file is
downloaded from the server). For more information about the definition properties file see “Plug-In
Definitions File” on page 39.
• Remain loaded and active as long as the operator is signed on.
• Have call-back methods that are driven as many times as necessary.

Supported Plug-Ins
The topology console currently supports the following plug-ins:
• View label formatter plug-in
• Log window filter plug-in

View Label Formatter Plug-In


Use the view label formatter plug-in to programmatically control the label text displayed on a topology
view, a details view, or selected data windows. This plug-in must implement the IhsIPlugInViewLabel
interface. To see detailed specifications, see the Java Plug-ins section of the NetView Management
Console Productivity Kit.
Built-in console function provides some control over the displayed label text (for example, it might be
truncated at the beginning or at the end), but the number of displayed characters cannot be controlled by
this console function. This plug-in can be useful if you are adhering to resource naming conventions that
include fixed prefixes or suffixes.
Some possibilities for customization with this plug-in include the following actions:
• Displaying the first N characters (where N is a number you specify)
• Removing common prefix or suffix text
• Combinations of removing and displaying text
The following windows are examples of data windows that use this plug-in when displaying resource
names:
• Command for a Multi-owned Resource
• Event Viewer
• List Suspended Resources
• Session Data
• Status History
Note: The Resource Properties window intentionally does not use this plug-in so that the full resource
name is always available.

38 IBM Z NetView: User's Guide: NetView Management Console


Log Window Filter Plug-In
Commands, their generated responses, and console generated messages are centrally collected and
displayed in the console Log window. Use the log window filter plug-in to programmatically control
the Log window contents. This plug-in must implement the IhsIPlugInLog interface. For detailed
information about the IhsIPlugInLog interface, see the Java Plug-ins section of the NetView
Management Console Productivity Kit. A new Log window entry can be handled in the following way:
• It can be added as is.
– The standard Log window display color is automatically used.
• It can be added with changes:
– The text can be modified.
– An override to the standard Log window display color can be specified.
• It can be suppressed.
You can also use this plug-in to initiate customer specific processing that results from a particular
command.

Additional Plug-In Support


To determine which plug-ins are loaded, see the Environment Information window. The information
shown in Table 28 on page 39 is displayed for each active plug-in. For more information, see the Java
Plug-Ins section of the NetView Management Console Productivity Kit.

Table 28. Values for Plug-ins as Shown in the Environment Information Window
Field Column Value Column
<plug-in class name>:data Initialization data passed to the
setPlugInData() method.
<plug-in class name>:desc Description as provided by the
getPlugInDescription() method.
<plug-in class name>:version Version as provided by the getPlugInVRM()
method.
<plug-in class name>:debug Debug information as provided by the
toString() method.
Note: If the string returned by toString()
contains dynamic information, the Refresh button
can be used to update this value without closing
the window. The example plug-ins provide a
template for this.

Notes:
1. The -noPlugin command-line argument overrides automatic plug-in loading as each console calls
the plug-in.
2. When specified, the plug-in properties file is not processed after sign on.

Plug-In Definitions File


The plugins.properties file defines the console plug-ins that are to be loaded. This file is downloaded,
after sign on, from the db\current\settings directory of the server.
Syntax for the plugins.properties file is shown in the following example:

****************************************************************************
* Define the plug-ins to be loaded during Console initialization

Chapter 5. Topology Console Java Applications and Plug-ins 39


* for every console that signs on to this server
****************************************************************************
plugin.1.class = required full package qualified class name
plugin.1.data = optional data passed to the setPlugInData() method for runtime use
plugin.2.class = <another>
plugin.3.class = <another>
...

Plug-In Examples
The example Java plug-ins shown in Table 29 on page 40 can be used to enhance base console
operation.

Table 29. Java Plug-in Examples


File Description
examples\java\ExampleLogPlugIn.java Provides control over items (commands,
responses, or messages) that are added to the
console Log window
Also see “Log Window Filter Plug-In” on page
39.

examples\java\ExampleViewLabelPlugIn.java Provides control over the label that is displayed


for a resource
Also see “View Label Formatter Plug-In” on
page 38.

Notes:
1. To use these example plug-ins to meet your specific requirements, specify the parameters in the data
definition of the appropriate plug-in.
2. More information about all of the following items is available in the Java Plug-Ins section of the
NetView Management Console Productivity Kit:
• Log window filter
• com.tivoli.ihs.extern.plugin.IhsIPlugInLog interface
• View label formatter
• com.tivoli.ihs.extern.plugin.IhsIPlugInViewLabel interface
• ExampleLogPlugIn class
• ExampleViewLabelPlugIn class

Plug-In Development Process


To develop a plug-in, use the following steps:
1. Edit an example in the following way:
a. Use one of the provided plug-in examples as a starting point.
b. Customize the example to meet your specific requirements.
2. Compile, package, and deploy your plug-in. For more information about this process, see “Compiling
the Examples” on page 34.
3. Enable the plug-in. For more information about this process, see “Defining the Example Java Plug-Ins”
on page 41.
4. Test the plug-in using the following steps:
a. Sign on to the server where the plug-in code resides.
b. From the Environment Information window, perform the following steps:

40 IBM Z NetView: User's Guide: NetView Management Console


i) Verify that the plug-in has been successfully loaded.
ii) Examine any debugging information externalized by the toString() method.
c. Generate a scenario in which the function for the plug-in code should be performed and verify that
it is working properly.
d. If necessary, enable service tracing to help diagnosis problems. For more information about tracing,
see “Tracing the Examples” on page 34.

Defining the Example Java Plug-Ins

From the Server


To run the example plug-ins while signed on to a server, perform the following steps:
1. Go to the command prompt of a workstation on which the NetView management console topology
server and console are both installed.
2. Change to the settings directory (where the BINDIR environment variable defines the installation root
of the server): cd %BINDIR%\TDS\server\db\current\settings
3. Copy the following file to the %BINDIR%\TDS\server\db\current\settings directory: <console machine
install path>\bin\generic_unix\TDS\client\examples\support\plugins.properties.

In Demonstration Mode
To run the example plug-ins in demonstration mode, from the console workstation, perform the following
steps:
1. Change to directory <install path>\bin\generic_unix\TDS\client\examples\support.
2. Issue the following command: copy plugins.properties ..\..\settings

Running the Example Java Plug-Ins

Running the Log Window Filter Plug-In: In a Live NetView Management


Console System
Start the console by double clicking the standard desktop icon.
• To suppress message IHS2267:
1. Select Tasks → Send Message... from the server or another console to broadcast a message to this
console.
The broadcast message entered is displayed (prefixed by IHS2267) in a message box. The example
plug-in suppresses the addition of this message to the Log window.
• To suppress message IHS1107:
1. Select Tasks → Locate Resource to open the Locate Resource window.
2. Type NEVER in the entry field and then click the Locate button.
Message IHS1107 is displayed in a message box. The example plug-in suppresses the addition of
this message to the Log window.
Note: Locate Resource generates message IHS1080 in demonstration mode.

Running the View Label Plug-In: In Demonstration Mode


To begin, start the console in demonstration mode by double clicking the NMC Demo desktop icon and
perform the following steps:
1. Select Tasks → Locate Resource to open the Locate Resource window.

Chapter 5. Topology Console Java Applications and Plug-ins 41


2. Type NTFFPU20 in the entry field and click the Locate button.
• A view is displayed.
• The names of the three nodes in this view are network qualified with USIBMNT.
• The example plug-in suppresses the display of the network qualifier on the view (in either topology
or details mode).
3. Position the cursor over the label of a node to display the fully qualified name in the fly-over section of
the status bar.

42 IBM Z NetView: User's Guide: NetView Management Console


Chapter 6. Configuring Property Files for Locally
Launched Applications

The NetView management console provides the capability to launch local applications on the NetView
management console topology console workstation, such as a web browser, to view a specific web
address in context or to start a Telnet session to the host where a managed resource resides. A properties
file associated with these locally launched applications defines the specific executable file to launch for
each supported platform. The web browser and Telnet commands are already configured. However, you
can check the properties file to ensure that the commands specified can be successfully run without a
specific dependency on the current drive and directory. For all other local applications, define appropriate
entries in the properties file.
Configure the local applications in the following way:
1. Define which application executable file is to be used on each platform where the topology console
runs. This can be configured on a user basis or on a server-wide basis. This configuration is done at the
topology server.
2. Define the command entries that are to be added to the topology console pop-up menu. This
configuration is done at the topology server.

Defining the Pop-up Menu Items


The cpebatch utility, on the NetView management console topology server workstation, can be used to
define commands that appear on the topology console pop-up menu. This is done by creating a response
file and using it as input to the cpebatch utility. You can generate response files manually, with a standard
text editor. To define an application to the NetView management console command menu, define the
following variables in the command response file:
• EXIT_NAME to be IHSXTJAM
• COMMAND_STRING to be com.tivoli.ihs.nmc.cmd.IhsCommandInvoker cmdname
var1=value1 var2=value2...
Although the command name is arbitrary, the properties file needs a matching entry (cmdname) for the
command name to be resolved. If no match exists, then the command name is run as is.

Response File Input


To enable the application, command information must be added to the commands database through the
command profile editor utility.
The following example shows an entry in a command response file:

COMMAND = (
NAME = CISCO_BLUE
MENU_STRING = "CISCO APPN node detail view"
RESOURCE_INDEP=NO
HTML_HELP_FILE =
HTML_HELP_ANCHOR =
MIN_RESOURCES = 1
MAX_RESOURCES = 1
VERIFY = NO
PAGE = (
COMMAND_STRING = "com.tivoli.ihs.nmc.cmd.IhsCommandInvoker browser
URL=http://%RODM.ManagementURL%/cgibin/cw-blue/snamaps\?rqx=9&a;=nd&ip;=
%ipaddress%&rc;=public"
EXIT_NAME = IHSXTJAM
MANAGER_NAME = ANY
HTML_HELP_FILE =
HTML_HELP_ANCHOR =
CLIENT_PLATFORM_LIST = GENERIC
TARGET_PLATFORM_LIST = GENERIC

© Copyright IBM Corp. 1997, 2022 43


)
)

Note: This is only an example. Specify the web address for your own environment in this section:

URL=http://%RODM.ManagementURL%/cgibin/cw-blue/snamaps\?rqx=9&a;=nd&ip;=
%ipaddress%&rc;=public

The entry for COMMAND_STRING determines how the command is called. For
example, COMMAND_STRING for the browser command must start with the keyword
com.tivoli.ihs.nmc.cmd.IhsCommandInvoker followed by browser.
COMMAND_STRING contains a definition for the web address field. A variable can be included in the web
address field that pulls data from Resource Object Data Manager (RODM). The following example shows
the syntax of the variable name:

%RODM.ManagementURL%

This variable is not allowed on resource independent commands. For more detailed information about
RODM variables, see Table 32 on page 45.

Creating a Response File for Browser


You can create response files manually, with a standard text editor. In addition, when creating a response
file for the browser command, you can use the registration file conversion utility if a Distributed NetView
registration file was provided by an equipment vendor. To manually create a response file, see “Response
File Input” on page 43.
If you received a Distributed NetView Navigation Bar Registration file, you can use the registration file
conversion utility to convert that file to a response file. Change to one of the following directories:
• For Windows systems: cd %BINDIR%\..\generic_unix\TDS\client\bin
• For AIX or Linux systems: cd $BINDIR/../generic_unix/TDS/client/bin
The following syntax is for the registration file OEMNAVBAR.REG:

tappxx .. com.tivoli.ihs.nmc.server.IhsHttpParse <path>OEMNAVBAR.REG

Where xx is the appropriate platform from which the topology console is running. See Appendix B,
“Topology Console Commands,” on page 103 for more information about the tappxx command.
Note: The default output is device dependent, but the menu entry is shown for any manager. Any changes
to the response file need to be made before running the cpebatch command.
The previous syntax generates an OEMNAVBAR.REG.rsp file. The generated response file is used as input
to the cpebatch utility in the following way:

cpebatch OEMNAVBAR.REG.rsp -i -g

Changes to the right-click pop-up menu take effect immediately.

Defining the Properties File


The properties file has a heading section that defines generic information followed by sections defining
a specific executable file and command string for each platform. Any line starting with a semicolon is
considered a comment line. Comments cannot be on the same line as command text.
The following list shows file name types:
• Default File Name: %BINDIR%\TDS\server\db\current\settings\defaultcmdinv.properties
• User File Name: %BINDIR%\TDS\server\db\current\settings\<user_name>cmdinv.properties
Note: The file name must be lowercase regardless of the user name.

44 IBM Z NetView: User's Guide: NetView Management Console


In the properties file, define the generic and operating system sections. Table 30 on page 45 displays
the information for the generic section of the properties file.

Table 30. Generic Section of Properties File


Field Description
command.desc Defines the application entry. You can define as many different
application specifications as necessary. This information is not
used outside this file.
In these examples, replace command with the name of the
command you are defining.

Table 31 on page 45 displays the information for the browser section of the properties file.

Table 31. Browser Section of Properties File


Field Description
browser.usebuiltin If set to TRUE, the built-in NetView management console
browser is used. All operating system entries are ignored.
This field is specific to the browser command and is not used
for others.

Table 32 on page 45 displays the information for the operating system section of the properties file.

Table 32. Operating System Section of Properties File


Field Description
command.x.platform Identifies the operating system for which this entry is valid. The
following operating systems are valid:
• Windows
Note: The Java os.name system property contains the operating
system name.
• Linux
You can use wild cards (? or *) to specify multiple versions of an
operating system. The file is processed from beginning to end until the
first acceptable match is found. You can use the ? wild card to specify
a one-character wild card and the * wild card to specify a multiple-
character wild card.

Chapter 6. Configuring Property Files for Locally Launched Applications 45


Table 32. Operating System Section of Properties File (continued)
Field Description
command.x.run Identifies the command used to run the executable file that is to run
on this operating system. This executable file must be configured to run
from the command line of the system on which it is to operate.
For example, if a user's system has a Windows platform and the user
must be in the c:\firefox directory to launch the web browser, their
properties file might define the browser.x.run field as:

browser.1.run = c: & cd \\firefox & firefox

This example uses the (&) to string command-line operations together,


changing to the c:\firefox directory before issuing the netscape
command. The & string concatenation technique is supported on
Windows platforms only. You can use the batch file approach on
other platforms which do not support stringing multiple command-line
operations together.
Notes:
1. Notice that you must specify a double back slash (\\) in the
command line. In these properties files, the back slash is treated
as an escape character similar to the way a C compiler treats a back
slash. So when you need a back slash character in your path name,
use two back slashes.
2. Avoid using environment variables, as they might not be resolved in
the final command string.
3. You might want to specify a directory greater than eight characters in
length, such as Program Files in the following example:

browser.1.run = cmd /c start


/Dc:\\Program Files\\Mozilla Firefox\\firefox.exe

To be sure you run the preferred application, enclose your full path
name in quotation marks, prefaced with a back slash, as in the
following example:

browser.1.run = cmd /c start


/D\"c:\\Program Files\\Mozilla Firefox\\firefox.exe\"

You can also create a script file in a known directory and specify the
script file as the executable file. Then the contents of the script file can
be written to change to the proper directory and start the browser.

46 IBM Z NetView: User's Guide: NetView Management Console


Table 32. Operating System Section of Properties File (continued)
Field Description
command.x.args Identifies the argument to be passed to the specified executable file.
Anything enclosed in percent (%) signs is considered a substitution
variable that can later be resolved by NetView management console or
RODM, or passed in from the command response file.
For example, the %url% substitution variable in the browser.x.arg field
defines a specific web address to be displayed when the browser is
started. The specific web address is defined in the command response
file.
The substitution variables are gathered from three locations:
• in the command string keyword of the CPE response file, where
the variable and value are defined as var=value. For example, see
“Response File Input” on page 43 for the web address variable.
• %ihs.xxx% substitution variables. The character strings (xxx)
following the period are the keys in the IhsCmdInfo.java and
IhsResInfo.java objects. The substitution variable is the value in
these objects. See the NetView Management Console Productivity Kit
for more information.
• %RODM.xxx% prefix substitution variables. The character strings (xxx)
following the period are the field names in RODM for the selected
objects. Use these only for resource specific commands.
You can optionally specify a colon (:) and a token number to retrieve
a single period-delimited token. For example, the MyName field of a
NetView Resource Manager aggregate object in RODM is in the form:
NRM.CNM01.AUTO1. If you want to extract just "AUTO1", you can
specify: %RODM.Myname:3% This extracts the third period-delimited
token.

The following example illustrates a properties file:

;-------------------------------------------------------------------------
; Your comments go here.
;-------------------------------------------------------------------------

browser.desc = Open Web browser and show URL


browser.usebuiltin = false

browser.1.platform = Windows *
browser.1.run = cmd /c start
browser.1.args = %url%

browser.2.platform = *
browser.2.run = firefox
browser.2.args = %url%

;----------------------------------------

ping.1.platform = Windows *
ping.1.run = cmd /c start ping -t
ping.1.args = %d2cmdargs%

ping.2.platform = Linux
ping.2.run = xterm -e ping -s
ping.2.args = %d2cmdargs%

ping.3.platform = *
ping.3.run = xterm -e ping
ping.3.args = %d2cmdargs%

;----------------------------------------

Chapter 6. Configuring Property Files for Locally Launched Applications 47


telnet.1.platform = Windows *
telnet.1.run = cmd /c start telnet
telnet.1.args = %d2cmdargs%

telnet.2.platform = *
telnet.2.run = xterm -e telnet
telnet.2.args = %d2cmdargs%

Notes:
1. The Telnet definitions are shipped as a default in the properties file. You might need to override these
definitions to customize the command for your operating system.
2. The %d2 cmdargs% variable is needed to support the RunData2 command. The RunData2 command
uses the Remote Console support in RODM that might define the Telnet command to run. See
“%REMOTECONSOLE%” on page 89 for more information. The d2cmdargs variable is assumed to
contain an IP address.
3. The Telnet support in NetView management console also defines %d2cmdargs% when launching a
Telnet session. The Telnet command appears in the right-click pop-up menu in a view. The d2cmdargs
variable is assumed to contain an IP address.
You can define as many different application specifications as necessary. Number each one incrementally.
For example, the previous example shows three specifications for Telnet, numbered incrementally from 1
to 3. The number of specifications you can create is not limited; however, no numbers can be skipped.

48 IBM Z NetView: User's Guide: NetView Management Console


Part 3. Using NetView Management Console

© Copyright IBM Corp. 1997, 2022 49


50 IBM Z NetView: User's Guide: NetView Management Console
Chapter 7. Operating the NetView Management
Console

This chapter includes the following information:


• Starting the topology server
• Starting the topology console
• Signing on from the topology console window
• Using the HOSTCMD command
• Stopping the topology server and topology console
• Retrieving inventory data on IP resources
• Writing server information to the NetView management console databases
• NetView functions available through NetView management console

Starting the Topology Server


The following sections describe how to start the topology server either manually or automatically. This
task is usually completed by a system administrator for all topology console operators. If you do not need
to start the topology server, skip to “Starting the Topology Console” on page 53.
Note: If you receive messages about the topology server, see the topology console help index for
information about the messages.

Starting the Topology Server from the Desktop Icon


For Windows operating systems, double-click the Start NMC Server icon on the desktop.

Manually Starting the Topology Server


Perform the following steps to start the server and to activate the TCP/IP or LU 6.2 connection to the IBM
Z NetView environment:
1. Open a workstation command window or shell prompt, depending on your operating system.
2. Change to one of the following directories:
• For Windows: %BINDIR%\TDS\server\bin
• For AIX or Linux: $BINDIR/TDS/server/bin
Note: BINDIR is an environment variable used by the Tivoli Framework to define path information used
by Tivoli applications. For both Windows systems and AIX or Linux systems, if the Tivoli Framework is
not installed on the platform from which the topology server is run, the installation process installs the
setup_env.cmd command file or setup_env.sh script file that defines BINDIR.
For Windows, AIX, and Linux for z Systems®, you might want to update the PATH environment
variable to make running topology server commands from any directory in a command prompt more
convenient.
Depending on the path used during installation, the Framework for the topology server typically has
one of the following BINDIR values:
• usr\local\Tivoli\bin\interp
• local\Tivoli\bin\interp
• Tivoli\bin\interp
In these BINDIR values, interp has one of the following values:

© Copyright IBM Corp. 1997, 2022 51


• For Windows, w32-ix86
• For AIX, aix4-r1
• For Linux for z Systems, linux-s390
3. Enter one of the following commands to start the topology server:
• For Windows: tserver start
• For AIX: ./tserver start
• For Linux for zSeries: ./tserver start
Because Linux for z Systems has no display, perform the following steps before issuing this
command to start the server:
a. Telnet to the host.
b. From the workstation used to perform the Telnet, export the display to the workstation. To do
this, use the following command:

export DISPLAY=ip_addr:0.0

where ip_addr is the IP address of the workstation.


Notes:
a. You must be the root user to start the topology server.
b. On a AIX or Linux system, if the topology server has been manually stopped and cannot be
restarted, see Step “4” on page 63.

Starting the Topology Server as a Windows Service


If the topology server is configured to start manually, select the Control Panel → Services control applet:
1. Select Topology Communication Server and click Start.
2. Select Topology Server and click Start.
If the topology server is configured to start automatically, it starts when the system is started.

Starting the Topology Server as a Daemon


For AIX or Linux systems, issue the following command to start the topology server processes at system
startup and have them run as daemons:

$BINDIR/TDS/server/bin/config -d

Note: You must be the root user to issue this command.

Establishing Communication Between the NetView Host and the Topology


Server
If communication between the NetView management console topology server and the NetView
program is not active, you can issue the NETCONV command to start the communication. Usually this
communication is defined to start automatically during NetView initialization. To start communication
using TCP/IP, that was defined to start automatically but is not currently active, enter:

NETCONV STARTCON=ip_sysdef

To start communication using SNA, that was defined to start automatically but is not currently active,
enter

NETCONV STARTCON=lu_sysdef

52 IBM Z NetView: User's Guide: NetView Management Console


These NETCONV commands cause the connection to be established under the autotask that is defined by
the function.autotask.NetConv statement in the CNMSTYLE member.
If you did not define communication to start automatically, you can use the NETCONV command with the
ACTION=START keyword or with the STARTCON=ip_sysdef / lu_sysdef keyword to start communication
under the task issuing the NETCONV command.
Note: If the task under which communication is established ends for any reason, the connection is
broken. This is true for both the autotask that is specified in the CNMSTYLE member or the task under
which the NETCONV command (with ACTION=START or STARTCON=ip_sysdef / lu_sysdef ) was issued.
For more information about the NETCONV command, see the online help.

Starting the Topology Console


You can start the topology console by selecting a desktop icon in Windows operating systems, or you can
start it by issuing the command in line mode from any operating system, or from the Tivoli Desktop.
Note: You can also launch the NetView management console from other applications. For information,
see Appendix D, “Launching and Using the NetView Management Console from Other Applications,” on
page 123.

Selecting the Desktop Icon in Windows


For Windows operating systems, an icon is created on the desktop. To start the topology console using a
Windows operating system, double-click the icon.

Using a Line Command


Change to the appropriate directory for your environment:
• For Windows systems: \usr\local\Tivoli\bin\generic_unix\TDS\client\bin
• For AIX or Linux systems: /usr/local/Tivoli/bin/generic_unix/TDS/client/bin
From the directory, issue the appropriate operating system specific command to start the topology
console:
• For Windows systems: tconsoleNT .. -key nmc
• For AIX or Linux systems: tconsole.sh .. -key nmc
See Appendix B, “Topology Console Commands,” on page 103 for complete information about all of the
tconsole command-line arguments and supported environment variables.
Note: To avoid problems when starting the topology console on AIX or Linux systems, add the directory
that contains the xhost command to the PATH environment variable.

Using the Topology Console Sign On Window


Figure 1 on page 54 shows the topology console Sign On window.

Chapter 7. Operating the NetView Management Console 53


Figure 1. Sign On Window

Follow these steps to sign on to the topology server:


1. Type a user name in the User Name entry field of the topology console Sign On window.
Notes:
a. The user ID must match your NetView user ID.
b. To restrict access to selected NetView operators to sign on to the topology console, use the
DUILOGON command with the NMC keyword. This can be protected by command security (NetView
command authorization table or SAF), and permitted to particular operators or groups. An example
of this is commented out in the sample command authorization table CNMSCAT2 and the sample
SAF command authorization table CNMSAF2. For more information, refer to the IBM Z NetView
Security Reference.
2. Type a password or password phrase in the Password field.
This password or password phrase must match your IBM Z NetView password or password phrase.
3. In the Host Machine field, type the IP host name or IP address of the topology server that you want to
sign on to . Either specify a new host name or IP address, or select a host name or IP address from the
list of topology servers. The list shows the topology servers that you have used.

54 IBM Z NetView: User's Guide: NetView Management Console


If you reassign the topology server console port, specify the port number in this field the first time
you sign on using this new port. However, the topology console retains the server:port setting on
subsequent sign-ons and uses that setting as the default. See “Establishing Communication Between
the NetView Host and the Topology Server” on page 52 for more information.
4. If you previously signed on to NetView management console and saved the settings for the
appearance of the topology console windows, you can select Restore console preferences.
5. To use administrative functions, such as customizing settings and applying them to all topology
consoles of this topology server, select Administrator access. More than one person can sign on
with administrative access. In this case, one administrator can overwrite changes made by another
administrator. The values saved last apply to all topology consoles.
Note: For more information about authorization, see IBM Z NetView Administration Reference;
specifically, see the information about the NGMFADMN keyword.
6. Click OK to sign on to NetView management console. The topology console window, which is shown in
Figure 2 on page 56, is displayed.
Note: The first time you start the NetView management console, expect a delay as support files are
downloaded to the topology console. On subsequent calls of the topology console, only files that have
been updated on the topology server are downloaded.
7. If a later level of the NetView management console is available, a message is displayed asking if you
want to update the code.
• If you choose Yes, the sign-on window takes a short time while the latest level of code is
downloaded. Then, the NetView management console is restarted and you can sign on again with the
updated code.
• If you choose No, signon is stopped.
Notes:
1. If you want to run commands, ensure that the NGMFCMDS keyword is set to YES (NGMFCMDS=YES). The
default is YES. For more information about the NGMFCMDS keyword, see IBM Z NetView Administration
Reference.
2. For more information about how files are automatically downloaded from the server at sign-on, see
Appendix G, “Automatic File Download at Console Log On,” on page 157.

Topology Console Window


Figure 2 on page 56 shows the topology console window. The following list describes the areas on the
topology console window:
• In addition to the menu bar, the toolbar contains selectable icons that provide a quick way to perform
the most commonly used functions.
• The progress indicator is on the toolbar. It shows Loading... when the topology console is
communicating with the topology server. To cancel a request that is still in progress, click the progress
indicator.
• The business tree shows all views. Each node represents a view. You can click the plus (+) or minus (-)
sign for a node to expand or collapse the node. Double-click a node to open a view for that node.
Note: The icons in the business tree display actual status only in certain cases. The Business Systems
branch of the business tree displays accurate status. The other branches of the business tree display
a satisfactory status, though this is not an accurate representation of the status of the resources they
contain. When a node that represents a resource is dynamically added to the business tree as a result of
more-detail navigation, the status represents that of the resource. It does not represent the aggregate
status of all resources in the view.
• The work space contains the view area and the filter bar. See “View Area” on page 57 and “Filter Bar”
on page 57 for details. You can detach the work space to view several different views at the same time.

Chapter 7. Operating the NetView Management Console 55


• The log contains messages, issued commands, and command responses. Although command
responses can be received asynchronously, they are always displayed following the issued command.
Note: The log is not displayed by default. To display the log, click Options > Show Log.
When the visible portion of the log is full, the log begins to automatically scroll. To change this option so
that you can manually scroll the log, right-click the log window and clear Automatic Scrolling.
To save the log, click File > Save Log. You can save the log to a file on the server or on the console. If
you click Save Log to Console, a window is displayed so that you can specify the name and location of
the file. For additional information, see the online help for the menu choices.
Note: To clear the console log, use the context menu.
• The view bar displays buttons for all open views in the order that they were opened. You can click any of
the buttons in the bar to re-display a previously opened view.
• The status area displays the following information:
– The text about the resource or business tree item under the cursor, or the status of any action in
progress
– The name of the topology server connection, your host name, the sign-on time and date, the mode
you are currently using, NETCONV status, and the topology console IP address
– Information about the displayed view

Figure 2. Topology Console Window

56 IBM Z NetView: User's Guide: NetView Management Console


View Area
The view area of the topology console window contains a notebook that displays different types of views
of your resources. Resources can be displayed in topology or details views.
• Topology views display resources and their statuses in a graphical format. Topology views are especially
useful in displaying the relationships between resources, for example, displaying connectivity.
Resources in a topology view are often placed on a background image, such as a building map or
geographical map, which shows their general location and proximity to each other.
• Details views display resources and their statuses in a list format. Details views contain additional
information about resources, such as type and description. You can also use them to control the order
in which resources are displayed, such as by time stamp or status. Null nodes and null links are never
displayed.
Within a view, context menus contain various commands and functions that are available for a resource.
To access a context menu, right-click a resource. A menu is displayed with a list of the available actions
for that resource. To access a context menu for the view, right-click in any area of the view that is not over
a resource. (If your details view is full, right-click any column heading.) A menu that shows the available
actions for the view is displayed.
You can print a topology or details view by clicking File > Print or the Print button on the menu bar. Note
that you cannot zoom in on a topology view and print it. To print a larger picture of a view, resize your
window and then print the view.

Filter Bar
The filter bar displays the number of resources in the current view at each status or by flag set. This status
is indicated in views by the color of the resource.
Note: The filter bar is not displayed by default. To display the filter bar, click Options > Show View Filter.
You can use the filter bar to prevent resources with particular statuses from being displayed in the current
view. To filter resources with a particular status, click the corresponding button to that status on the filter
bar.
• In topology views, filtered nodes are displayed as empty boxes and filtered links are displayed as
dashed lines.
• In details views, filtered resources are not displayed.
The filter bar continues to display the number of resources in each status. To temporarily re-display a
filtered resource in a topology view, including its status, icon, and so on, position your cursor on the
resource without clicking.
You can customize the statuses that are displayed on the filter bar in the Status page of the Console
Properties notebook.

NetView Management Console Online Help


NetView management console provides the following kinds of online help from the topology console:
• Menus
• Dialog boxes and notebook pages
• Windows
• Overview
• Messages for the topology server and topology console
• Commands
• A Legend function that displays a window containing descriptions of all resource that are types defined
to the topology server.
• The ability to display a web site

Chapter 7. Operating the NetView Management Console 57


• Help Index, which you can use to search the help facility. Use a task index to find help on specific tasks.
If you receive messages about the topology server, look in the Help Index for information about the
messages.

NetView Management Console Functions


This section describes some of the functions of the NetView management console.

Issuing IP Commands
The following IP commands can be issued from the NetView management console interfaces:
• Ping
• Tracerte (trace route)
• Netstat (Network host status)
You can issue the available IP commands from the NetView management console topology console
screen in one of two ways:
• Right-click a resource and select IP Commands from the context menu. This is available for any
resource that contains an IP address.
• From the view background, right-click the background and select IP Commands from the pop-up menu.
From the IP Commands menu, the following items are available:
• onetstat
• ping
• tracerte
When you select ping, onetstat, or tracerte, a dialog box is displayed. If the menu was accessed from
a resource and you select ping or tracerte, the IP address for that resource is inserted into the Host
Machine field of the dialog box. The ping command can also be started without opening a dialog box when
the menu is accessed from a resource.

The NetView Resource Manager


Use the NetView Resource Manager to manage all NetView programs in an enterprise with the NetView
management console. The NetView Resource Manager collects task information and forwards this
information to a manager NetView for processing. The processed information is stored in RODM.
Use the NetView management console interface and the NetView Resource Manager to build views to
monitor your enterprise. After RODM is populated, you can use the NetView management console to
monitor the NetView program. The views created by the NetView Resource Manager are network views
represented in the view tree as NetView Task views. Selecting a NetView Task view results in a view of
NetView domains. This view of NetView domains is the first NetView Resource Manager network object
that can be selected from the NetView management console and it is an aggregate. Selecting More
Details from this view opens a view containing aggregate objects which represent NetView tasks. Each
NetView task aggregate can then contain real objects representing the following items:
• CPU
• STG
• MQIN
• MQOUT
• MSGCT
• IO
• status (active/inactive)
Sample views are provided to monitor and manage NetView tasks.

58 IBM Z NetView: User's Guide: NetView Management Console


If you want information about... Refer to...
Sample views IBM Z NetView Resource Object Data Manager and
GMFHS Programmer's Guide
Using the NetView Resource Manager IBM Z NetView User's Guide: NetView and IBM Z
NetView Installation: Getting Started

Using RODM Collection Manager With NetView Management Console


RODM Collection Manager enables arbitrary grouping of objects into views or aggregates. Unlike
BLDVIEWS which are static, the RODM Collection Manager dynamically manages the views or aggregates.
This means that RODM Collection Manager continually updates the views or aggregates, so that you can
add, change, or delete collections. To access RODM Collection Manager from the NetView management
console, you must be signed on as an administrator.
Figure 3 on page 59 shows the RODM Collection Manager main menu.

Figure 3. RODM Collection Manager main menu

NetView Management Console Topology Server Databases


The topology server databases are used to save server information between restarts of the server. The
server information contained in these databases includes the following kinds of data:
• Resource data for all resource types
• Operator data for all operators that have logged on
• View data for all saved views
• Command data for all customized commands
When the topology server starts, it loads the data from the first server database directory that contains a
database that can be loaded. Table 33 on page 60 lists the topology server databases, in the order that
they are searched for databases that can be loaded.

Chapter 7. Operating the NetView Management Console 59


Table 33. Topology Server Databases
Name Location
Current® For Windows systems:

%BINDIR%\TDS\server\db\current\datab

For AIX or Linux systems:

$BINDIR/TDS/server/db/current/datab

Backup For Windows systems:

%BINDIR%\TDS\server\db\backup\datab

For AIX or Linux systems:

$BINDIR/TDS/server/db/backup/datab

Custom Backup For Windows systems:

%BINDIR%\TDS\server\db\custom_backup\datab

For AIX or Linux systems:

$BINDIR/TDS/server/db/custom_backup/datab

Default For Windows systems:

%BINDIR%\TDS\server\db\default\datab

For AIX or Linux systems:

$BINDIR/TDS/server/db/default/datab

The default database contains the initial (default) server information. When the server is started for the
first time after installation, the default database is loaded. The current and backup databases do not
contain server information when the server is loaded for the first time after installation.
The current and backup databases contain the most recent copy of the server information after the
server is stopped or checkpointed. Generally, the current and backup databases contain identical server
information, but, in some cases, only the current database is updated with server information. For more
information, see “Writing Server Information to the Topology Server Databases” on page 60.
The custom_backup database is used to save a customized version of the server information at a known
level of customization. This database is not continuously updated by stopping or checkpointing the server.
Use this database to protect your server information from undetected database corruption.

Writing Server Information to the Topology Server Databases


Writing server information to the topology server databases is also known as checkpointing. Server
information is written to the topology server databases either manually or automatically.
The default database is never written during a database checkpoint and serves as a starting database if
one or all of the other databases become corrupted. The other databases are written based on the type
of checkpoint requested. Server information is written to the topology server databases automatically for
the following reasons:
• The autoCheckpointInterval or autoCheckpointDaily properties of the server.properties file are
enabled. These properties are explained in the server.properties file. For more information about
this file, see “Modifying the Server Properties File” on page 9. All server information is checkpointed to

60 IBM Z NetView: User's Guide: NetView Management Console


the current database. If the checkpoint completes successfully, the current database is then copied to
the backup database.
Note: The default setting for these properties result in automatic checkpoints at 1 a.m. every day.
• A view is customized and saved to the topology server. Only the files that were changed for the view
customization are written, and they are written only to the current database.
• The command profile editor batch utility is run. Only the files that were changed for the command
customization are written, and they are written only to the current database.
• The topology server is shut down. All server information is checkpointed to the current database. The
backup database is not copied until the server is restarted. If the current database is successfully
loaded during the subsequent server startup, the current database is then copied to the backup
database.
To manually write information to the topology server database, use either the tserver utility -c
command or the tserver utility -cc command.
The tserver utility -c command manually checkpoints all server information to the current
database. If the checkpoint completes successfully, the current database is then copied to the backup
database.
The tserver utility -cc command manually checkpoints all server information to the
custom_backup database. The custom_backup database is used to save a customized version of the
server information at a known level of customization. The custom_backup database is meant to override
the default database if the current and backup databases become corrupted. For more information about
how to use the custom_backup database, see “Creating and Importing Backup Copies of Customized
Topology Server Databases” on page 62.
If your installation has a large number of customized views or commands, it is recommended that you use
the tserver utility -cc command whenever you make significant changes to the customized views
or commands. When you have used this command, you can restore the server information to a known
good copy of the database that contains your recent customization if the current and backup databases
become corrupted.

Handling Corrupted Topology Server Databases


One or more of the topology server databases can become corrupted, causing the server to fail to start or
to behave abnormally after it starts. Corrupted databases can cause either or both of the server processes
(the topology data server and the topology communications server) to end.
Topology server databases can become corrupted for the following or other reasons:
• The topology server process is incorrectly stopped; for example, stopping a topology server process by
closing the topology server window instead of using the tserver stop command. Abruptly stopping
the topology server in this manner prevents it from properly updating the databases before it stops.
• The file system used by the topology server runs out of space, preventing the topology server from
updating its databases.
• The topology server encounters an internal failure, which results in the topology server stopping
abnormally.
The default and custom_backup databases are not likely to be corrupted. Most database corruptions are
the result of a corruption in the in-storage copy of the database. Because the in-storage database is
written only to the current and backup databases, the default and custom_backup databases can be used
as your recovery databases.
If you suspect a database corruption problem, perform the following steps:
1. If the server is running, stop the server.
2. Make a backup copy of the current and backup databases. You might want to recover these databases
if the problem is not a database corruption problem.

Chapter 7. Operating the NetView Management Console 61


3. Restart the topology server. The topology server attempts to detect database corruption on
initialization. If it detects database corruption, the server attempts to restore the database from the
next database that can be loaded. See Table 33 on page 60 for the database recovery order.
4. If the server successfully starts, then your database has been recovered. If the server does not start,
continue with the next step.
5. Erase the current database.
6. Restart the topology server. This automatically copies the backup database to the current database.
If the server successfully starts, then your database has been recovered. If the server does not start,
continue with the next step.
7. Erase both the current and backup databases.
8. Restart the topology server. At this point, the database has been recovered either from the default
database or, if you are using a custom backup, from the custom_backup database.
If the topology server successfully starts, then the problem was that the original contents of both the
backup and current database directories were corrupted. If you previously saved a copy of the databases,
you can optionally use the saved copy to restore the topology server databases, as described in “Creating
and Importing Backup Copies of Customized Topology Server Databases” on page 62.
If the topology server does not start, then the problem is not because of corrupted databases. To continue
problem determination, see the IBM Z NetView Troubleshooting Guide for information about diagnosing
NetView management console and Graphic Monitor Facility host subsystem (GMFHS) problems.

Creating and Importing Backup Copies of Customized Topology Server


Databases
If you plan to customize many views or commands, you should create a backup copy of the database to
insure that your customization is not lost if the server database becomes corrupted.

Customization recommendations
• Perform customization first on a test, or non-production, server.
• Start (or restart) the server before performing any customization. Having a freshly started server
reduces the risk of any corruption to the in-storage database; a server that has been active for many
weeks or months can have an in-storage corruption that has not yet been detected.
After you perform the customization, create a backup copy of the server databases that contain the
customization using the following steps.
Note: This procedure requires stopping and restarting the server.
1. To manually write (checkpoint) the topology server databases to the custom_backup directory, enter
the following command and wait for it to complete successfully before proceeding to the next step:

tserver utility -cc

2. Stop the server.


3. Delete all the files in the current database directory, but do not delete the directory itself.
4. Copy all the files from the custom_backup database directory to the current database directory.
5. Start the server. Verify that the server does not issue an error message indicating that the database is
corrupted.
To import the custom_backup database directory to other servers, perform the following steps:
1. Stop the server to which the database is to be imported (the import server).
2. Copy the custom_backup directory from the test server to the custom_backup and current directories
on the import server.
3. Restart the import server.

62 IBM Z NetView: User's Guide: NetView Management Console


Stopping the Topology Console
To stop the topology console, select File → Exit from the topology console window. The topology console
and all windows are closed.

Stopping the Topology Server


The procedure for stopping the topology server depends on the platform on which the topology server
is running. For Windows, you can stop the topology server by selecting an icon or entering a line-mode
command. For AIX, you can stop the topology server only with a line-mode command. The following
sections describe the steps for stopping the topology server on each type of platform. For Linux for
zSeries, you can stop the topology server one of two ways: with a line-mode command or by clicking the X
in an X Window System window if the server was started with tserver start.
Attention: Do not stop the topology server by clicking the X unless the topology server is running
on the Linux for zSeries platform and was started with tserver start.

With the Service Version on Windows


To stop the topology server in this environment, select the Control Panel → Services control applet,
or enter the ihsxsrv stop command from the %BINDIR%\TDS\server\bin directory on the topology
server.

Using a Line-mode Command


To stop the topology server when it is running without problems, complete the following steps:
1. Open a workstation command window.
2. Change to one of the following directories:
• For AIX or Linux systems: $BINDIR/TDS/server/bin
• For Windows systems: $BINDIR%\TDS\server\bin
3. Enter the tserver stop command to stop the topology server.
The tserver stop command, with no flags, stops the topology server. For AIX or Linux systems, only
root users can stop the topology server.
4. For AIX or Linux systems only, if the topology server is suspended, or if a daemon has trapped, issue
the tserver stop command a second time with the -f flag in the following way:

tserver stop -f

The tserver stop -f command forces running daemons to stop, and cleans up any remaining inter-
process communication resources that were used by the daemons.

Chapter 7. Operating the NetView Management Console 63


64 IBM Z NetView: User's Guide: NetView Management Console
Chapter 8. Understanding Views

The NetView management console graphically displays systems and networking information provided by
the NetView host. This information is displayed as Resource Object Data Manager (RODM) based views
and is available only if a conversation is set up between the topology server and the NetView host.

RODM-Based Views
RODM-based views are predefined in RODM or are dynamically built based on definitions in RODM. The
Graphic Monitor Facility host subsystem (GMFHS) must be available to display RODM-based views and
can include the following views:
• Network views
• Exception views
• Configuration views
• More detail views
• Locate failing resource views
RODM-based views contain resources which are defined by the user applications, loader files, and more.

Network Views
Network views and the resources displayed in them are defined in RODM. Figure 4 on page 65 shows a
network view.

Figure 4. Network View

Exception Views
An exception view is a view that typically shows only resources that are not functioning properly, as
defined by the exception criteria you defined in RODM. Figure 5 on page 66 shows an exception view.

© Copyright IBM Corp. 1997, 2022 65


Figure 5. Exception View

Configuration Views
You can request these types of configuration views: parents, children, peers, logical, physical, logical and
physical, and backbone. All relationships must have been previously defined in RODM.

Configuration Parents View


Figure 6 on page 66 displays the configuration of a resource (not the entire connectivity) to its owning
node.

Figure 6. Configuration Parents View

Configuration Children View


Figure 7 on page 67 shows the selected resource and all of its children.

66 IBM Z NetView: User's Guide: NetView Management Console


Figure 7. Configuration Children View

Configuration Peers View


Figure 8 on page 67 shows a view containing resources in the network that are arranged in a
configuration based on a peer relationship between resources.

Figure 8. Configuration Peers View

Configuration Logical View


Figure 9 on page 68 shows a view containing resources in the network that are arranged in a
configuration based on a logical relationship between resources.

Chapter 8. Understanding Views 67


Figure 9. Configuration Logical View

Configuration Physical View


Figure 10 on page 68 shows a view containing resources in the network that are arranged in a
configuration based on a physical relationship between resources.

Figure 10. Configuration Physical View

Configuration Logical and Physical


Figure 11 on page 69 shows a view containing resources in the network that are arranged in a
configuration based on a logical and physical relationship between resources.

68 IBM Z NetView: User's Guide: NetView Management Console


Figure 11. Configuration Logical and Physical View

Configuration Backbone View


Figure 12 on page 69 shows a view containing resources in the network that are arranged in a
configuration based on a subarea backbone relationship.

Figure 12. Configuration Backbone View

More Detail Views


When you request more detail about a selected resource, the view that is displayed shows lower-level
resources that are related to the selected resource. You can use the More Detail function to navigate from
high-level views to lower-level views. Figure 13 on page 70 shows the contents of a resource, or more
details about the resource.

Chapter 8. Understanding Views 69


Figure 13. More Detail Views

Locate Failing Resources


Figure 14 on page 70 shows a view which was created by selecting Locate Failing Resources on
the context menu of an aggregate resource. This view displays all child real resources currently in an
exception status.

Figure 14. Locate Failing Resource View

Customized Views
A customized view is a view that has been opened, changed, and saved using the Save View
Customization function. You can use this function to save changes to views that are created dynamically
in response to certain requests and to predefined RODM-based network views. If you are signed on as
administrator, this function is available for the following types of views:
• Network views (predefined)
• Configuration views (both predefined and dynamically-built)
• More detail views (both predefined and dynamically-built)
• Locate failing resource views (dynamically-built)
If sign on as administrator, and dynamic views are customized, the Customized Dynamic Views node is
displayed in the business tree.

70 IBM Z NetView: User's Guide: NetView Management Console


Double-clicking a customized dynamic view in the business tree opens a snapshot of the view, but this
snapshot is not an active view with real status and the latest topology changes. You can use it to see how
dynamic views have been customized and to change the customization.
Note: Customized network views are shown in the business tree under Network Views.

Views Containing Resources for Which You Are Not Authorized


If you have defined span of control, some views can contain resources that you are not authorized to
display because of your span authorization. When this occurs, the view is affected in one of the following
ways, depending on your NetView customization:
• The unauthorized resources are not visible.
• The unauthorized resources are displayed as null nodes or null links, or both.
For more information about span of control, refer to the IBM Z NetView Resource Object Data Manager and
GMFHS Programmer's Guide.

Views Containing Scheduled Resources


If you have defined NMCSTATUS policy definitions, a view can contain resources that are suspended from
aggregation or are no longer receiving system status updates at the NetView management console. For
more information about NMCSTATUS policy definitions, see the IBM Z NetView Administration Reference.
A resource that is suspended from aggregation because of a NMCSTATUS policy definition has a textual
note attached to the suspend flag indicating why the resource was suspended. The note is displayed
when either a Resource Properties or List Suspended Resources request is made.
A resource that is no longer receiving system status updates at the NetView management console
topology console has a scheduled system status. The resource continues to receive system status
updates in RODM but they are not sent to the NetView management console topology console while
the resource is scheduled. As with other system statuses, you can customize the color of the scheduled
system status on the Console Properties window.

Displaying Views in a Web Browser


You can configure the NetView management console topology console to function as a web server. This
enables the console to capture Topographic or Details NetView management console views and convert
them into HTML and GIF files, which you can view in any web browser.
Note: You can only display views that are open on the console.

If you want information about... Refer to...


Displaying views in a web browser “Configuring a Web Browser to Display Views” on
page 16.

Chapter 8. Understanding Views 71


72 IBM Z NetView: User's Guide: NetView Management Console
Chapter 9. Open Topology Interface Network
Operation

You can use the MultiSystem Manager Open topology feature to create your own topology agents and
to manage diverse network resources, those resources not managed by other MultiSystem Manager
topology features, for example.
You can also obtain applications from Tivoli Partner organizations that use the Open Topology Interface.
Partner applications, that extend IBM Z NetView management to network and systems resources that are
not managed by Tivoli features, are available.
This chapter explains using the views and command support to manage open networks. See IBM
Z NetView Installation: Configuring Graphical Components for more information about creating Open
topology agents. After you initialize network topology and status in RODM, the NetView management
console provides views of your Open networks. Using the NetView management console pull-down
menus, you can navigate among the views to isolate failures and send commands to resolve problems.

Open Topology Interface View Objects


The Open Topology Interface can be used to display views containing any object in the IBM Z NetView
Data Model Reference. The following Open objects are displayed in various Open views:
• A group of Open networks
• A single Open network
• A collection of resources grouped by location, business organization, or network systems topology
• Aggregate nodes
• Real nodes
• Aggregate links
• Real links
Figure 15 on page 73 shows the various types of objects that are displayed when using the Open Data
Model.

Figure 15. Types of Open View Objects

© Copyright IBM Corp. 1997, 2022 73


Finding Resources
To find resources, access the Locate Resource window. From the NetView management console Tasks
menu, select Locate Resource to open the Locate Resource window. From the Locate Resource window,
you can locate a resource by its display name.

Navigating Network Views


How you navigate an Open network depends on the views that are provided by your application. Open
views can consist of different levels, as defined by the application used. By default, MultiSystem Manager
creates 3 high-level objects for every Open Topology Interface application and displays them in two
views. This topic illustrates the default set of views that are displayed when you navigate an example
Open network. In this example, the application is named Open. The following GETTOPO command, sent
to a topology agent with an LU name of NTB6I133, was used to build this set of views:

GETTOPO OPENRES, SP=NTB6I133, APPL=OPEN

To navigate the views, begin by selecting the default MultiSystem Manager network view, MultiSysView, in
the NetView management console business tree. Figure 16 on page 74 shows the NetView management
console network view named MultiSysView.

Figure 16. NetView Management Console Default Network View (MultiSysView) Example

The MultiSysView view consists of an aggregate object that represents all the Open networks that are
defined in the initialization file that is used to initialize MultiSystem Manager. The name of this aggregate
object is Open_Networks and the resource type is Group. From MultiSysView, you can select more
detailed views that display your Open networks.

Viewing Open Networks


The networks object is displayed in its own view, as shown in Figure 16 on page 74. One or more pairs of
network and manager objects are created as children of the networks object. A pair of these objects are
shown in Figure 17 on page 75.

Open Networks View


MultiSystem Manager displays a separate Open network for each one defined in your initialization file. To
view your Open networks on the NetView management console, select the OPEN_Networks object that is

74 IBM Z NetView: User's Guide: NetView Management Console


shown in Figure 16 on page 74 and click More Detail. The resulting NetView management console view
in this example, which is shown in Figure 17 on page 75, shows one Open networks object that contains
one Open network object.

Figure 17. NetView Management Console Open Networks View (Open_Networks) Example

MultiSystem Manager represents each Open network with two connected symbols:
• A node aggregate object called a network aggregate, for example, NTB6I133_OPEN_Network.
• An application real object called a manager, for example, NTB6I133_OPEN_Mgr.
The network aggregate, NTB6I133_OPEN_Network, represents all the resources that are monitored by
the Open application. The manager, NTB6I133_OPEN_Mgr, represents the topology agent residing in the
Open application. The name of the agent is composed of the SNA service point address and the type of
network the agent is managing (Open network).
To view additional information about the Open network, select the Open manager and click Resource
Properties. Figure 18 on page 76 shows the resulting NetView management console Resource
Properties window for the selected Open object.

Chapter 9. Open Topology Interface Network Operation 75


Figure 18. NetView Management Console Open Topology Interface Resource Properties Window Example

An Open Topology Interface application consists of one or more additional levels of views. These views
can consist of real objects and aggregate objects with any of these objects shown linked together. See
the information with each of your Open Topology Interface applications for a description of navigating the
views that are contained in a network aggregate object.

76 IBM Z NetView: User's Guide: NetView Management Console


Chapter 10. Using NetView Management Console
Command Profiles

This chapter contains Programming Interface information.


When operators use the topology console, available commands are displayed in the context menu for a
selected resource. Also, resource independent commands are shown in a context menu if you right-click
the view background. Because operators have different areas of responsibility, levels of authority, and
preferences, you might want to customize the command menus. Use the command profile editor batch-
utility to control the content, order, and capabilities of these menus for an individual operator or group of
operators.
The NetView management console provides a command profile editor batch-utility on both Windows and
AIX or Linux platforms.

Understanding Command Profiles


Command profiles contain the following objects:
• Resource managers
• Commands and command sets
• Profiles
• Operators

Resource Manager Objects


Resource manager objects represent applications that manage specific resources. The properties of a
resource manager define a unique range of command indicators and specify the values in that range that
are enabled for commands. You can use the command profile editor to add, change, or delete resource
managers.
A command indicator is a numeric identifier assigned to a resource by its controlling resource manager.
Each resource manager is assigned a unique range of values that it can define. Unless you are creating
a resource management application or performing actions on behalf of such an application, you probably
never need to alter the properties of a resource manager.
Note: The first 32767 command indicators are available for customer use. Command indicators 32768 to
65534 are not defined and they are reserved for current and future Tivoli use. For a detailed description of
these command indicators, see the IBM Z NetView Data Model Reference.

Commands and Command Set Objects


Command objects represent menu items that can be displayed in the context menus for selected
resources. Command set objects also represent menu items, but command set items have submenus
of commands or other command sets associated with them. The command set object specifies the
order and content of the submenu. You can use the command profile editor to add, change, and delete
commands and command sets.
Commands consist of the following items:
• A command definition page that defines the purpose and behavior of the command
• One or more implementation pages that describe the command exits that are responsible for carrying
out the command
Command sets are composed of one or more commands or command sets.

© Copyright IBM Corp. 1997, 2022 77


Many commands have a common meaning for a wide variety of resource types. However, the mechanics
of carrying out this command can vary from one resource type to another.
For example, a Lotus® Notes resource is started differently than a NetView resource, which is activated
differently than a Tivoli Enterprise Console® resource. This is because a variety of syntaxes and command
exits are used; therefore command objects are composed of multiple implementation pages. When a
command is issued, a single page is selected (based on the command indicator of the target resource).
For example, you can create a Stop Tasks command that is enabled for Lotus Notes resources, but not
for Tivoli Enterprise Console resources. You can do this by defining a command called Stop Tasks and
defining a page for Lotus Notes resources but not defining a page for Tivoli Enterprise Console resources.

Profile Objects
Profile objects represent a collection of commands. Through the commands, command sets, and
separators, the profile objects define the content and order of the items on the context menus. You
can use the command profile editor to add, change, and delete command profiles.
A profile can be shared by multiple operators. An operator object is created for each operator who does
not want to use the default profile. The operator object is then assigned a profile object. Changes to a
profile affect all operators using that profile. This method makes it easier to maintain profiles and ensures
that operators are using the same commands.
Note: A profile named <default> is used for all operators who do not have a specific operator definition.
The <default> profile is appended by the topology server during initialization when processing component
description files or business description files (CDF/BDF) of instrumented applications. This is done for the
Topology Display Subsystem view.

Operator Objects
An operator object represents a topology console operator and is associated with that operator by a
common name. An operator object specifies the profile object assigned to the operator. You can use the
command profile editor to add, change, or delete operators.
When an operator right-clicks a resource, the profile object used to populate the context menus for that
operator is identified in the following ways:
• If an operator object exists with the same name, its specified profile object is used.
• If an operator object does not exist with the same name, but a profile object with the name <default>
exists, the profile object is used.
• Otherwise, no commands from the command profile editor are displayed on the context menu.
Note: When you delete or rename the <default> profile, only operators with operator objects assigned
to them have access to commands from the NetView management console. You can use this to provide
security for a topology server.

Using the Command Profile Editor Batch Utility


You can use the command profile editor batch utility program to add, change, or delete commands in
the command profile editor database. The batch utility runs on the Windows and AIX or Linux platforms
that are supported by the topology server. The utility uses a text file (the response file), which contains
responses to all the parameters used in creating commands.
The command profile editor batch utility can do the following things:
• Create a response file from the information currently in the command profile editor database of the
topology server. Note that the response file can be used as a backup for the command profile editor
database or for synchronizing your topology servers.
• Update the command profile editor database of the topology server from a response file.
Any program can provide a response file and run the batch utility to add commands to the command
profile editor database.

78 IBM Z NetView: User's Guide: NetView Management Console


Two sample response files are provided with the command profile editor. These are available from the
databases of the NetView management console topology server. The following samples are provided for
customizing the commands:
ihsscpe
Base commands that are shipped with the NetView management console topology server
flccpe
Commands for MultiSystem Manager (MSM) resources
These files are located in the following directories:
• ihsscpe, for Windows systems: %BINDIR%\TDS\server\sample\ihsscpe.xxx.rsp
• ihsscpe, for AIX or Linux systems: $BINDIR/TDS/server/sample/ihsscpe.xxx.rsp
• flccpe, for Windows systems: %BINDIR%\TDS\server\sample\flccpe.xxx.rsp
• flccpe, for AIX or Linux systems: $BINDIR/TDS/server/sample/flccpe.xxx.rsp
Note: xxx is a country code indicator, such as en_US.
Depending on the parameters specified on the command line, the utility adds, modifies, or deletes
commands. The command profile editor utility does not save information to the topology server until
the entire response file is processed and verified. If the entire file cannot be processed successfully, no
updates are made in the topology server database.

Starting the Command Profile Batch Utility


To run the command profile editor batch utility, issue the cpebatch command from one of the following
directories:
• For Windows systems: %BINDIR%\TDS\server\bin
• For AIX or Linux systems: $BINDIR/TDS/server/bin
For more information about the cpebatch command, see “cpebatch” on page 91.

Input and Output Files of the Response File


The format for the input and output of the response file is identical. The response file is a standard ASCII
file containing assignment statements that are generally in the form of keyword = value. The keyword is on
the left side of the statement and identifies the parameter. The value is on the right side of the statement
and either assigns a value to the keyword, or contains a block of keyword and value assignments.
Lines in which the first nonblank character is an asterisk (*) are comments and are ignored by the utility.
Comments can be either inside a block or outside a block, for example:

MANAGER = (
* This is a comment inside of the manager block
NAME = SNA
INDICATOR_HIGH = 10
INDICATOR_LOW = 5
INDICATOR.INDICATOR_LOW+0 = PU 2.1
INDICATOR.INDICATOR_LOW+1 = PU 2.0
INDICATOR.INDICATOR_LOW+2 = 3274
Communications Controller
COMMENT = Defines manager SNA
)
* This is a comment outside of the manager block

The preceding example creates a manager named SNA and assigns it a range of command indicators from
5 to 10. It also creates three indicators for that manager, the lowest indicator defined is 5. For an example
input file, see:
• For Windows systems: %BINDIR%\TDS\server\Sample\ihsscpe.xxx.rsp
• For AIX or Linux systems: $BINDIR/TDS/server/Sample/ihsscpe.xxx.rsp
Note: XXX is a country code indicator, such as en_US.

Chapter 10. Using NetView Management Console Command Profiles 79


The response file is processed in a single pass; therefore, the order of the main blocks of keywords is
important. Use the following order:
1. Manager
2. Command
3. Command_Set
4. Profile
5. Operator
You cannot use items before they are defined in the response file. For example, if command set A embeds
command set B, command set B must be defined first.
You can omit any block as long as all the required keywords are already defined in the topology server. For
example, if you add a command and the resource manager is already defined in the topology server, it is
not necessary to define the manager in the response file.
You can delete a block from the current database by placing the DELETE keyword inside the block.
Note: Before deleting a command or command set, it must first be removed from any profiles or
command sets that contain it. To do this, use the REMOVE_COMMAND or REMOVE_COMMAND_SET option
of the MENU keyword for each profile or command set that contains the command or command set.
You can delete the following types of blocks:
• Manager
• Command
• Command_Set
• Profile
• Operator

Manager Keywords
The manager block defines a manager and the command indicators that this manager controls. The
keywords to define managers in command blocks are shown in Table 34 on page 80.

Table 34. Manager command block keywords


Keyword Explanation
Name Uniquely defines the manager to the command profile editor.
INDICATOR_HIGH High end of the range of indicators controlled by this
manager.
INDICATOR_LOW Low end of the range of indicators controlled by the manager.
INDICATOR_n n must be the indicator value followed by the description
string. The indicator value can be either a fixed number or
can be relative to the INDICATOR_LOW+x, when x is the
offset of this indicator from the low range.
COMMENT Comment string. Limit of 256 characters.

Command Keywords
The command block defines a complete command, including general information and each of the
command pages. The keywords used in command blocks are shown in Table 35 on page 81.

80 IBM Z NetView: User's Guide: NetView Management Console


Table 35. Command block keywords
Keyword Explanation
NAME Uniquely identifies the command to the command profile
editor.
MENU_STRING The string that is displayed on the context menu.
COMMENT Comment string. Limit of 256 characters.
HTML_HELP_FILE The name of the HTML file that contains the help for this
command.
HTML_HELP_ANCHOR The anchor, if applicable, to a particular location in the HTML
file that contains the help for this command. The pound sign
(#) in the first position is optional; when HTML is displayed
by the NetView management console topology console, # is
inserted, if necessary.
MIN_RESOURCES Minimum number of resources that must be selected in a
view before this command is enabled. The range is 1 to 10.
MAX_RESOURCES Maximum number of resources that can be selected in a view
before this command is disabled. The range for this is value of
the minimum resources–100, or an infinite number. An infinite
number is denoted by the keyword INFINITY.
Note: Specifying too many resources can cause system
resources to become overburdened and, therefore cause the
system to hang.

PAGE Defines the characteristics of a page for an individual


command. See “Page Keywords in the Command Block” on
page 81 for the items you can specify here.
RESOURCE_INDEP YES or NO. Indicates whether this command is enabled
regardless of whether resources are selected. If the value
of RESOURCE_INDEP is YES, then MIN_RESOURCES and
MAX_RESOURCES values are ignored.
Resource dependent commands are displayed when you
right-click a resource. Resource independent commands are
displayed when you right-click the view background.

VERIFY YES or NO. Indicates whether to issue a confirmation


message before the command is sent to the manager.

Page Keywords in the Command Block


The page keywords in the command block define the characteristics of a page for an individual command.
The keywords to define pages in command blocks are shown in Table 36 on page 81.

Table 36. Page command block keywords


Page Characteristic Explanation
CLIENT_PLATFORM_LIST The topology console platform or platforms associated with
this command page.Use the following syntax for all platforms:

CLIENT_PLATFORM_LIST = GENERIC

Chapter 10. Using NetView Management Console Command Profiles 81


Table 36. Page command block keywords (continued)
Page Characteristic Explanation
TARGET_PLATFORM_LIST The target platform or platforms where the selected resource
is located. Use the following syntax for all platforms:

TARGET_PLATFORM_LIST = GENERIC

MANAGER_NAME The name of the manager to which the page applies. This
must be previously defined in the response file. If this
command is not associated with particular resource types,
specify the string ANY. An ANY manager command can
have only one command page, which can not specify an
INDICATOR_LIST or PAGE_ID.
PAGE_ID Uniquely identifies this command page by specifying one
indicator from the indicator list. When updating a command
page, the PAGE_ID must be in the indicator list of the existing
page in CPE.
INDICATOR_LIST Defines the indicators that call this page. Specify single
indicators by separating each with a comma. Specify a range
by connecting numbers with a dash (for example, 1–100).
You can replace real numbers with relative numbers using
INDICATOR_LOW+x. INDICATOR_LOW denotes the lowest
defined indicator for this manager.
If the indicator list spans multiple lines, you can use the
following format:

INDICATOR_LIST = (
VALUE.0 = INDICATOR_LOW + 0
VALUE.1 = INDICATOR_LOW + 1
)

COMMAND_LIST The command string to be sent to the command exit specified


by EXIT_NAME.
EXIT_NAME The name of the command exit to call for this page. See
“Using Topology Server Command Exits” on page 85 for
information.
LU_NAME Currently, this field is ignored by NetView management
console. All exits are run on the topology server.
HTML_HELP_FILE The name of the HTML file that contains the help for this
command.
HTML_HELP_ANCHOR The anchor, if applicable, to a particular location in the HTML
file that contains the help for this command. The pound sign
(#) in the first position is optional; when HTML is displayed by
the topology console, # is inserted, if necessary.
IP_RESOURCE IP Resource commands are displayed In the NetView
management console when a resource with an IP address is
right-clicked. Valid values are YES or NO. The default value is
NO.

82 IBM Z NetView: User's Guide: NetView Management Console


Command Set Keywords
The command set block defines what a command set looks like. Order is important in the menu block. The
keywords used in command set blocks are shown in Table 37 on page 83.

Table 37. Command set block keywords


Keyword Explanation
NAME Uniquely identifies the command set to the command profile
editor.
COMMENT Comment string. Limit of 256 characters.
MENU_STRING The string that is displayed on the Context menu.
HTML_HELP_FILE The name of the HTML file that contains the help for this
command set. This file must be installed on the topology
server.
HTML_HELP_ANCHOR The anchor, if applicable, to a particular location in the HTML
file that contains the help for this command. The pound sign
(#) in the first position is optional; when HTML is displayed by
the topology console, # is inserted, if not already there.
MENU Defines the commands that this command set contains and
their order. You can specify one or more of the following
options:
• COMMAND_NAME - Specifies the name of a command to
add.
• COMMAND_SET_NAME - Specifies the name of a command
set to add.
• SEPARATOR - Specifies that a separator is to be placed on
the menu.
• REMOVE_COMMAND - Specifies the name of a command to
remove.
• REMOVE_COMMAND_SET - Specifies the name of a
command set to remove.

To add a new command to a command set or profile, first identify the command set or the profile to which
you want to add the command, then specify the command you want to add inside the MENU block. The
new command must already be defined in the database or must have been defined earlier in the response
file.
The following example shows how to add My command to the Network command set:

COMMAND_SET = (
NAME = Network (identifies the
command set)
MENU = (
COMMAND_NAME = My command (identifies
the command to add)
)
)

This example places My command at the end of the Network command set. Make sure you use the -G
option on the cpebatch command when adding the command.
To insert My command after an existing command in the command set, specify the following lines:

COMMAND_SET = (
NAME = Network
MENU = (

Chapter 10. Using NetView Management Console Command Profiles 83


COMMAND_NAME = NetView command line (existing
command)
COMMAND_NAME = My command
)
)

To remove My command from the Network command set, specify the following lines:

COMMAND_SET = (
NAME = Network (identifies the
command set)
MENU = (
REMOVE_COMMAND = My command (identifies
the command to remove)
)
)

Profile Keywords
The profile block defines individual profiles. Order is important in the menu block. The keywords used in
the profile command block are shown in Table 38 on page 84.

Table 38. Profile command block keywords


Keyword Explanation
NAME Uniquely identifies the profile to the command profile editor.
COMMENT Comment string. Limit of 256 characters.
MENU Defines the commands that this profile contains and their
order. You can specify one or more of the following options:
• COMMAND_NAME - Specifies the name of a command to
add.
• COMMAND_SET_NAME - Specifies the name of a command
set to add.
• SEPARATOR - Specifies that a separator is to be placed on
the menu.
• REMOVE_COMMAND - Specifies the name of a command to
remove.
• REMOVE_COMMAND_SET - Specifies the name of a
command set to remove.

Operator Keywords
The operator block defines operators to the command database. The keywords used in the operator
command block are shown in Table 39 on page 84.

Table 39. Operator command block keywords


Keyword Explanation
NAME Uniquely defines the operator to the command profile
editor
COMMENT Comment string. Limit of 256 characters
PROFILE_NAME The name of the profile that this operator is to use

84 IBM Z NetView: User's Guide: NetView Management Console


Chapter 11. Using the Topology Server Command
Exits

This chapter contains Programming Interface information.


This chapter contains information about topology server command exits. The command exit facility
enables commands defined in the context menus for selected resources to call specific functions when
those commands are selected. These specific functions are known as command exits and are processed
as remote procedure calls. When a command is selected, its corresponding command exit procedure is
driven by the topology server.

Command Profiles
Command profiles define the commands available from the context menus for a particular operator. When
an operator right-clicks a resource or the view background, the command profile for that operator is used
if it exists; otherwise, the default command profile is used.
A default command profile is shipped with NetView management console. You can add command
definitions to the default command profile or modify existing definitions. You can create new command
profiles for individual operators or groups of operators. Commands are also automatically defined by
component instrumentation.

Understanding Topology Server Command Exits


The topology server provides a set of command exits to send commands from the workstation to the
NetView host as described in “Using Topology Server Command Exits” on page 85. The command exit
facility supports exit-to-exit communication, which enables a command exit to modify a command and to
pass the data to another command exit for processing.
When a command exit returns, control is given to its caller. Eventually, the first exit called by the
command selection returns.
Note: Some events take place when a command exit is driven. If an exit procedure is not yet registered,
then an executable file with the same file name as the exit name is sought using the defined path. If
found, this executable file is started in a separate session.
For example, if the exit is called TESTEXIT, the topology server searches for and starts the TESTEXIT.EXE
(for Windows platforms) or TESTEXIT (for AIX or Linux platforms). This program registers a procedure
within itself as a command exit procedure.
When a command is issued from the topology console, the command exit indicated in the command
profile is driven by the topology server. For a resource dependent command, the command exit that is
driven is based on the command indicator of the resource. A parameter block is passed to the command
exit procedure containing information about the command in the command profile editor and information
about a resource (if selected) when the command was called. The command exit procedure can pass a
return code to its caller when processing of the command is complete.

Using Topology Server Command Exits


The command exits that are supplied with the topology server for general use are shown in Table 40 on
page 86.

© Copyright IBM Corp. 1997, 2022 85


Table 40. Command exits supplied by the topology server
Command exit Use to... For information about...
IHSDGENE Send a fixed set of generic commands Using with the command profile editor,
to the NetView Graphic Monitor see “IHSDGENE Command Exit” on
Facility host subsystem (GMFHS) for page 86.
processing.
IHSDNATV Send commands to GMFHS, which Using with the command profile editor,
forwards the command to the service see “IHSDNATV Command Exit” on
point for the specified resource. page 86.
IHSXTHCE Send a command to the NetView host. Using with the command profile editor,
see “IHSXTHCE Command Exit” on
page 87.
IHSXTJAM Launch a single Java class on Using with the command profile editor,
the topology console for multiple see “IHSXTJAM Command Exit” on
resources. page 87.
IHSXTJAV Start a Java class on the topology Using with the command profile editor,
console. see “IHSXTJAV Command Exit” on
page 87.

IHSDGENE Command Exit


For resources managed by GMFHS and MultiSystem Manager (MSM), use the IHSDGENE exit to send a
fixed set of generic commands to NetView GMFHS for processing. Examples of the generic commands
you can send include Activate, Inactivate, and Recycle. This exit supports only the commands listed in
the default command profile and cannot be extended. To determine the commands supported by this exit
and their syntax, look at the default command profile shipped with the topology server as defined in the
ihsscpe.xxx.rsp and flccpe.xxx.rsp response files, where xxx is a country code indicator, such as en_US.
Note that you do not have to define the generic commands to the command profile editor as they are
already defined in the response file.
For more information, see the IBM Z NetView Resource Object Data Manager and GMFHS Programmer's
Guide.

IHSDNATV Command Exit


IHSDNATV is used to send a command to GMFHS, which forwards the command to the service point for
the specified resource. A resource must be selected before IHSDNATV is called.
When defining a command that uses this exit, specify the following information in the Commands
notebook.
1. In the Command string field, specify the command to send to a network management gateway
that manages the selected resource. GMFHS performs substitution for the following symbols in the
command string:
%appl%
Substitutes the value of the TransactionProgram field of the Non_SNA_Domain_Class instance.
%domain%
Substitutes the value of the EMDomain field of the Non_SNA_Domain_Class instance.
%resource%
Substitutes the resource name portion of the MyName field of the
GMFHS_Managed_Real_Objects_Class or a subclass of the GMFHS_Managed_Real_Objects_Class
instance.
For example, (EMDomain.Resource = SPI6E69.MINI69A) causes MINI69A to be substituted.

86 IBM Z NetView: User's Guide: NetView Management Console


%spname%
Substitutes the value of the MyName field of the NMG_Class instance.
%type%
Substitutes the value of the TypeName field of the Display_Resource_Type_Class instance
associated with a resource.
2. In the Exit name field, enter IHSDNATV.

IHSXTHCE Command Exit


IHSXTHCE sends a command to the NetView host. If a resource is not selected when the command
is called, IHSXTHCE can send resource-independent commands to the NetView host. If a resource is
selected, the IHSXTHCE command exit can substitute resource specific information.
When defining a command that uses this exit, specify the following information in the Commands
notebook:
1. In the Command string field, specify the command to run on the Z NetView program. If you selected
Resource dependent, you can optionally specify substitution variables in the Command string field.
See “Substitution Variables” on page 87 for a list of valid substitution variables.
2. In the Exit name field, enter IHSXTHCE.
The following substitution variables are unique to the IHSXTHCE command exit:
%noresponse%
Directs the command response back to the NetView session.
%response%
Directs the command response back to the topology console.

IHSXTJAM Command Exit


The IHSXTJAM command exit starts a Java class on the topology console. The Java class name to
be started must be the first blank delimited token in the command string field. Unlike the IHSXTJAV
command exit, the IHSXTJAM command exit launches only one instance of the Java class when several
resources are selected on the topology console. Thus, one instance of the Java class has access to
information about every selected resource. The IHSXTJAM command exit can be specified in a resource
independent or a resource dependent command. See Chapter 5, “Topology Console Java Applications and
Plug-ins,” on page 33 for information about installing this Java class.

IHSXTJAV Command Exit


The IHSXTJAV command exit starts a Java class on the topology console. The Java class name to
be started must be the first blank delimited token in the command string field. Unlike the IHSXTJAM
command exit, the IHSXTJAV command exit launches multiple instances of the Java class, when several
resources are selected on the topology console. For example, when two resources are selected, and
a command is selected that calls the IHSXTJAV command exit, two instances of the class specified
in the command string launched are on the topology console, with each instance of the Java class
having information about one of the selected resources. The IHSXTJAV command exit can be specified
in a resource independent or a resource dependent command. See Chapter 5, “Topology Console Java
Applications and Plug-ins,” on page 33 for information about installing this Java class.

Substitution Variables
Table 41 on page 88 lists the common variables that are substituted by the topology server in the
command string for the command exits. Note that the substitution variables are not case-sensitive. These
variables are common across all command exits.

Chapter 11. Using the Topology Server Command Exits 87


Table 41. Common substitution variables
Substitution Variable Description
%data1% Resource specific data1. For RODM resources, this is data from the
DisplayResourceOtherData field. For RODM predefined views in the
tree view, this data is from the Annotation field.
%data2% Resource specific data2. For RODM resources, this data is from the
DisplayResourceUserData field.
%data3% Resource specific data3. For RODM resources, this data is from the
iPAddress field.
%data4% Resource specific data4.
%hb_hostname% In the distributed environment, the value must be the TCP/IP
host name of the system. In the z/OS environment, it is the
NetView domain name (non-network qualified). Each of these is
used to direct the processing of commands to the correct system:
distributed using Tivoli tasks or host using NetView command
support. Does not apply to RODM resources. Valid only for
instrumented resources.
%hb_origin% An enum value pair list used to identify the system on which
the component resides. The enumerations are listed in the
AMS document in relation to the Discover Connections task in
the Connection Type group (Primary). Does not apply to RODM
resources. Valid only for instrumented resources.
%hb_primary% First key value pair of the value of the %hb_origin% variable. Valid
only for instrumented resources.
%hb_secondary% First key value pair of the value of the %hb_sub_origin% variable.
Valid only for instrumented resources.
%hb_source% Contains a semicolon-delimited triplet with information from the
ComponentID group in the applications global description file (GDF)
(manufacturer;product;version). Does not apply to RODM resources.
Valid only for instrumented resources.
%hb_sub_origin% An enum value pair list used to differentiate between components
on the same system that support the same relationship. Also
described with discover connections (secondary). Does not apply to
RODM resources. Valid only for instrumented resources.
%hb_sub_source% Same format and attribute use as source, but from the component
description file (CDF). The topology server uses this value to locate
the correct CDF. Does not apply to RODM resources. Valid only for
instrumented resources.
%ipaddress% The value of the %data3% variable. Valid only for RODM resources.
%label% The display name, which is the resource name assigned by the
manager of the resource. This is the name that is displayed
in the view. For RODM resources, this data is from the
DisplayResourceName field.
%monitor% The monitor name from the topology server database. Valid only for
instrumented resources.
%objectid% The NetView RODM object ID, if applicable.
%remoteconsole% See “%REMOTECONSOLE%” on page 89 for more information.

88 IBM Z NetView: User's Guide: NetView Management Console


Table 41. Common substitution variables (continued)
Substitution Variable Description
%RODM.xxx% The variable to be pulled from RODM. The character string following
the period (xxx) is the field name to be pulled from RODM for the
selected object. Use these only for resource specific commands.
To extract just a period-delimited token from a field, append a colon
(:) and a token number in the following way: %RODM.xxx:3%
This extracts the third period-delimited token from the field.

%REMOTECONSOLE%
The %REMOTECONSOLE% command-line substitution variable applies only to RODM resources. The
value for %REMOTECONSOLE% comes from the resource specific data2 value, which comes from the
DisplayResourceUserData field in RODM. This substitution variable calls a command or application on the
topology console workstation.
For an example of how this substitution variable works with the Command Profile Editor and
the topology console, see the command definition for Run Data2 Command in the %BINDIR%
\TDS\server\sample\ihsscpe.xxx.rsp, where xxx is the country code, such as en_US. If
syntax RemoteConsole=/(can be anything)/ exists in the resource specific data2 value, then
%REMOTECONSOLE% is substituted using the following rules:
• Syntax: "RemoteConsole = /the_command the_args(0-n)/"
• Fixed portions of this syntax are not case sensitive (such as RemoteConsole).
• Spaces around the equals sign are optional.
• Spaces between the first delimiter and the the_command are optional.
• The delimiter / can be any character. The first nonblank character after the equals sign becomes the
delimiter.
• A second occurrence of the delimiter character must exist after the first occurrence.
• There must be a nonblank character between the delimiters.
• The command is assumed to be a valid command on any topology console workstation that runs this
menu item. To map a command to an appropriate command for the platform of the topology console
workstation, update the usercmdinv.properties file on the console. See Chapter 6, “Configuring Property
Files for Locally Launched Applications,” on page 43 for more information.
• This syntax can occur anywhere inside the resource specific data2 value; that is, other characters can
come before or after this syntax.
The %REMOTECONSOLE% substitution variable is converted to the following string:

the_command d2cmdargs="the_arg1 the_arg2 the_arg3"

The fixed characters are d2cmdargs=" and the second double quotation mark after the last arg. All
other values are obtained from between the two delimiters.

Chapter 11. Using the Topology Server Command Exits 89


90 IBM Z NetView: User's Guide: NetView Management Console
Appendix A. Topology Server Commands

The topology server commands provided in this appendix are intended to be used as reference material.
Syntax diagrams are provided for each command.

config
Format
config
tserver config
-d

-h xx

-f xx.xx.xx.xx

Purpose
Use the config command to specify that the topology server processes are to be started as daemons. Also
use this command to specify the heartbeat interval for the topology server.

Parameters
-d
Specifies that the topology server processes be started as daemons. Updates are made to the
appropriate system files so processes start automatically when the system is started.
This operand can be used only on the AIX or Linux platform.
-h xx
Specifies the heartbeat interval for the topology server, where xx is the interval, in minutes, for
generating heartbeats, such that the topology server resource in the topology display subsystem view
remains in satisfactory status. The minimum is 5 minutes; the default value is 60 minutes unless it is
overridden in the server.properties file.
-f xx.xx.xx.xx
Specifies an additional address by which your system is known. This can be used if you are using
network address translation (NAT) and the topology server is being accessed by this method.
The variable, xx.xx.xx.xx, is the TCP/IP address in dot notation.
Note: The server must be rebooted after issuing this command in order for it to take effect.

cpebatch
Format
cpebatch
cpebatch filename -O

-I -U: loginID -P: password

-L1: logfile -V -M

-G

© Copyright IBM Corp. 1997, 2022 91


Purpose
Starts the command profile editor batch utility. For additional information about the command profile
editor, see Chapter 10, “Using NetView Management Console Command Profiles,” on page 77.

Parameters
filename
If the -O option is specified, this is the name of the output file that is created by the utility. If the
-I option is specified, this is the name of the input file that is read by the utility. This parameter is
required with the –I option.
-O
Generates a response file from the current commands database. The filename specifies the name of
the file generated by the utility. If this is not a fully-qualified name, the file is generated in the current
directory. If no name is specified, the default name of IHSECPED.RSP is used. The -O or -I parameter
must be specified.
-I
Specifies a response file to be used to update the current commands database. Unless the filename
is fully-qualified, it is assumed to reside in the current directory. The -O or -I parameter must be
specified.
-U loginID

If the user ID is not present in the command line, you are prompted to provide this information. The
user ID must match your NetView user ID.
The login user ID must have administrative authority.
-P password
The password or password phrase for the login user ID that is specified by the -U parameter. There
is no default value. If a password or password phrase is not in the command line, you are prompted
to provide this information. This password or password phrase must match your NetView password or
password phrase. If a value is not specified, the command profile editor utility tries to sign on to the
topology server with a null password. This is an optional parameter.
-L1 log file
The name of the error log file to which you want to log informational and error messages. The default
is IHSECPED.LOG. If the file is not fully-qualified, it is put in the following directories:
• For Windows systems: %BINDIR%\TDS\server\log
• For AIX or Linux systems: $BINDIR⁄TDS⁄server⁄log
The error log file is continually appended, so that multiple runs of the utility are logged in the same
file.
This is an optional parameter.
-V
Forces the utility into verify mode. The response file is processed and compared with the data in the
topology server, but no changes are made to the actual topology server database. This is an optional
parameter.
-M
Overrides the default add mode of the utility and forces the utility into modify mode. This enables
information to be replaced in or deleted from the existing database. This is an optional parameter.
-G
Overrides the default add mode of the utility and forces the utility into modify mode. This enables
updates to be made to command sets and profiles by adding to them without replacing existing
information. This is an optional parameter.

92 IBM Z NetView: User's Guide: NetView Management Console


Return codes

The command profile editor utility program generates the following return codes:
RC
Explanation
0
Successful. The utility completed successfully. Unless -V was specified in the cpebatch command, the
database was updated.
4
Warning. The database was updated (unless -V specified) and warning messages were logged.
8
Error. The database was not updated and error messages were logged.
12
Severe Error. The database was not updated and a severe error ended the program immediately.

dbtransfer
Format
dbtransfer
tserver dbtransfer

Purpose
The dbtransfer command copies the topology server databases from the default installation directories
to the location defined by the TSERVER_DB variable. After the TSERVER_DB variable is defined on the
topology server workstation, this utility must be run before the topology server is started. This command
does not change the contents of the topology server databases in the default installation directories.

getpd
Format
getpd
getpd

Purpose
Gathers information about your system environment, error logs, and trace files and stores them in the
following file. You can send this file to IBM Software Support to help with problem determination.
• For AIX or Linux systems: $BINDIR/TDS/server/tmp/toposerv.xx.tar.Z
• For Linux for zSeries systems: $BINDIR/TDS/server/tmp/toposerv.xx.tar.gz
This command can be used only on the AIX or Linux platform.

Appendix A. Topology Server Commands 93


hostcmd
Format
hostcmd
tserver hostcmd "../comm/command_string"
-h NetView_hostname

-d NetView_domain_name -u NetView_operator_id

-p NetView_password

Purpose
Issues commands to the NetView host from a command prompt on the topology server.

Parameters
"../comm/command string"
The command to be sent to the NetView host.
-h NetView_hostname
The IP address or host name of the NetView host where you want to issue the command.
-d NetView_domain_name
NetView domain name where you want to issue the command.
-u
Specifies the NetView operator ID where you want to issue the command. This ID overrides any
preset NetView operator ID (such as the ID that is set in the ihsshstc.cfg file or the hostcmdoper
command).
If the -u operand is specified without the -p operand, you are prompted to enter the NetView
password or password phrase.
-p
Specifies the NetView password or password phrase where you want to issue the command. This
password or password phrase overrides any preset NetView password or password phrase (such as
the password or password phrase set in the ihsshstc.cfg file or hostcmdoper command).
If the -p operand is specified without the -u operand, you are prompted to enter the NetView
operator ID.

Usage
The default is to run the command on the NetView host where the NETCONV session was initiated. See
“Establishing Communication Between the NetView Host and the Topology Server” on page 52 for more
information about setting up a NETCONV session.
The hostcmd command is issued from the command line or a script file. The response to the hostcmd
command is displayed in the same command window you use to issue the command.
The hostcmd command is located in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\bin
• ForAIX or Linux systems: $BINDIR/TDS/server/bin
For AIX, Linux, or Windows systems, you can either change to this directory before running the hostcmd
command, or add the directory path to your PATH environment variable.

94 IBM Z NetView: User's Guide: NetView Management Console


For more information about presetting the NetView operator ID and password or password phrase, see
“Defining the IBM Z NetView User ID and Password on the Topology Server” on page 7.
If you want to route command responses to a file or log, or to automate actions based on the command
responses, you can customize the command exit source file, ihsshstc.c, located in one of the following
directories:
• For Windows systems: %BINDIR%\TDS\server\sample
• For AIX or Linux: $BINDIR/TDS/server/sample

hostcmdoper
Format
hostcmdoper
tserver hostcmdoper
-u NetView_operator_ID -p NetView_password

-k encryption_key -a -s -d

Purpose
Issue this command before issuing the hostcmd command to set the NetView operator ID and password
or password phrase. The hostcmdoper command can also be used to display or delete the NetView
operator ID and password or password phrase in the ihsshiccc.cfg file.

Parameters
-u
Specifies the NetView operator ID where you want to issue a hostcmd command.
-p
Specifies the NetView password or password phrase where you want to issue the hostcmd command.
-k
Specifies the new key for encrypting the NetView password or password phrase. This encryption key
must be 32 characters or 64 hexadecimal characters in length.
Note: This operand cannot be specified with any other operand.
-a
Specifies to migrate the password file to the new encryption level.
Note: This operand cannot be specified with any other operand.
-s
Displays the NetView operator ID that is stored in the ihsshiccc.cfg file. This operand cannot be
specified with any other operand.
-d
Deletes the ihsshiccc.cfg file, which stores the NetView operator ID and password or password
phrase. This operand cannot be specified with any other operand.

Usage
If the hostcmdoper command is never issued or if the -d option is run, and then the hostcmd command
is run, the hostcmd command either uses the operator ID and password or password phrase that is
stored in the ihsshstc.cfg file or prompts the user for the operator ID and password or password phrase.
The password or password phrase is not encrypted in the ihsshstc.cfg file.

Appendix A. Topology Server Commands 95


ihszfmt
Format
ihszfmt
tserver ihszfmt logFileName
-b >outputFileName

Purpose
Formats the topology server error and trace logs. The output from the command is directed to stdout.
The error logs and trace files are located in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\log
• For AIX or Linux systems: $BINDIR/TDS/server/log

Parameters
logFileName
Specifies the topology server error log or trace file to format. To format the error log, specify
either ihserror.log or ihserror.bak. To format the trace log, specify either ihstrace.log
or ihstrace.bak.
-b
Specifies to suppress the formatting of the log in EBCDIC. This parameter does not affect the
formatting of the log in ASCII. Formatting of the log in EBCDIC is important because the log contains
data being sent between the topology server and the NetView host; thus, do not suppress this
formatting.
outputFileName
Specifies the file name for the formatted error log or trace file.

ihszset
Format
ihszset
tserver ihszset
-help

-?

-h

Purpose
Starts the command-line interface so that you can set the trace options for the topology server. If you do
not specify an option and if the system is not a Linux system, ihszset starts the GUI interface so that you
can set the trace options for the topology server.

Parameters
-help | -? | -h
Specifies a help menu to be displayed describing all the options you can specify with the ihszset
command.

96 IBM Z NetView: User's Guide: NetView Management Console


ihszsett
Format
ihszsett
tserver ihszsett

Purpose
Starts the graphical user interface so that you can set the trace options for the topology server.
Note: This command is not available on the Linux for zSeries platform.

service
Format
service
service account_name password

Purpose
Sets up the topology server to run as a Windows service.

Parameters
account_name
If the service type is SERVICE_WIN32_OWN_PROCESS, this name is the account name in
the form of ‘DomanName\Username’, which the service process logs on as when it runs.
If the account belongs to the built-in domain, ‘.Username’ can be specified. Services of
type SERVICE_WIN32_SHARE_PROCESS are not a valid specification of an account other than
LocalSystem. If NULL is specified, the service logs on as the ‘LocalSystem’ account, in which
case the password parameter must be null.
If the service type is SERVICE_KERNAL_DRIVER or SERVICE_FILE_SYSTEM_DRIVER, this name is
the driver object name (that is, ‘\FileSystem\Rdr’ or ‘\Driver\Xns’), which the input and output
(I/O) system uses to load the device driver. If NULL is specified, the driver is run with a default object
name created by the I/O system, based on the service name.
password
Contains the password to the account name specified by the IpServiceStartName parameter, if
the service type is SERVICE_WIN32_OWN_PROCESS or SERVICE_WIN32_SHARE_PROCESS. If the
pointer is NULL or if it points to an empty string, the service has no password. If the service type is
SERVICE_KERNAL_DRIVER or SERVICE_FILE_SYSTEM_DRIVER, this parameter is ignored.

Appendix A. Topology Server Commands 97


start
Format
start
tserver start
-d -y -b -i -p portnumber

-s

Purpose
Starts the topology server and communications server, then displays a topology server window and a
communications server window. If the topology server is already running either in the background as a
service or daemon or in a Windows system, an additional instance of the topology server is not started.

Parameters
-d
Specifies that the topology server be run in debug mode. Additional information is written to both the
topology server window and to the topology server message log.
-y
Generates the default topology server databases if no databases exist. Do not use unless requested
by IBM Software Support.
-b
Writes additional information to the message log when event data is received. This is helpful if
instrumentation is being developed, since it displays the data received along with the information as it
is processed.
-i
Runs the topology server in IP mode only. Communications through LU 6.2 is not attempted.
Note: The server on a Linux for zSeries systems runs only in IP mode.
-p portnumber
Specifies which port is to be used for communications with the topology consoles. This does not
override what is specified in the services file.
-s
Starts the server processes in the background for a AIX or Linux system. On a Windows system, this
starts the server processes as a Windows service, assuming the server has been set up to run as a
service.
Note: This parameter must be specified first.

Usage
The topology server and communications server windows only display messages. Use the utility
command to manually write the topology server databases to disk, dump the server databases, dump
the server semaphores, and so on.

98 IBM Z NetView: User's Guide: NetView Management Console


stop
Format
stop
tserver stop
-f

Purpose
Stops the topology server processes.

Parameters
-f
Use the force flag if one of the topology server processes ended abnormally or if the topology server is
hung. The force flag stops any remaining topology server processes and then cleans up any remaining
interprocess communications (IPC) resources.
Note: This is applicable only to the AIX or Linux platform.

tcpipkey
Format
tcpipkey
tserver tcpipkey
-d

-o [xxsendxx | xxrecvxx]

-v [xxsendxx | xxrecvxx]

-?

Purpose
Specifies the send and receive keys used for encrypting and decrypting data sent or received by the
workstation on the IP connection with the NetView host.

Parameters
-d
Resets the keys to their default values.
-o
Sets the keys used for the NETCONV connection with the NetView host. Enter the keys in the same
format as they were entered in DSITCPRF. The first key is used to encrypt data sent from the
workstation to the NetView host. The second key is used to decrypt data received by the workstation
from the NetView host.
xxsendxx
Used to encrypt data sent from the topology server to the NetView host.
xxrecxx
Used to decrypt data received by the topology server.

Appendix A. Topology Server Commands 99


-v
Compares the two keys provided against the two NetView keys that are stored. If the keys match, Yes
is returned. If the keys do not match, No is returned. If only one key is provided on the command line,
both keys are prompted. If no keys are provided, the user is prompted for both keys.
xxsendxx
Used to encrypt data sent from the topology server to the NetView host.
xxrecxx
Used to decrypt data received by the topology server.
-?
Displays the command syntax.

Usage
This command is used only for non-SSL (Secure Sockets Layer) connections.
The keys for this command must be either eight or sixteen characters long. If a sixteen-character key is
entered, it is assumed to be a hexadecimal representation of the key and it is compressed down to eight
bytes. If only one key is provided on the command line, then prompts are issued for both keys. If no keys
are provided, then the user is prompted for both keys. The keys are stored in an encrypted format in the
following file:
• For Windows systems: %BINDIR%\TDS\server\config\ihssckey.cfg
• For AIX or Linux systems: $BINDIR/TDS/server/config/ihssckey.cfg

tserver
Format
tserver
tserver

Purpose
Use tserver before some of the topology server commands (for example, tserver stop). The commands
that require the tserver prefix are documented in this appendix. On the Windows platform, the topology
server commands are a combination of command files and shell scripts. The tserver prefix ensures that
the appropriate environment is set up and then starts the requested command.

100 IBM Z NetView: User's Guide: NetView Management Console


utility
Format
utility
tserver utility
-b [on|off]
-c
-cc

-d

-f

-m [username] ["the_message"]

-p

-s

Purpose
Use this command to manually write the topology server databases to disk, dump the server databases,
dump the server semaphores, or send a message to topology consoles signed on to the same topology
server.

Parameters
-b [on|off]
Turns the instrumentation-related topology server message logging on or off.
-c
Manually writes (checkpoints) the topology server databases to disk.
Note: After the command has completed, the current and backup copies of the topology server
databases are identical and both contain the latest database updates.
-cc
Manually writes (checkpoints) the topology server databases to the custom_backup directory.
-d
Dumps the topology server databases to the following directory:
• For Windows systems: %BINDIR%\TDS\server\log
• For AIX or Linux systems: $BINDIR/TDS/server/log
-f
Dumps the topology server databases, without semaphore access protection, to the following
directory:
• For Windows systems: %BINDIR%\TDS\server\log
• For AIX or Linux systems: $BINDIR/TDS/server/log
-m
Sends messages to topology consoles connected to the topology server.
user_name
The user name of the topology console to whom you want to send the message, or use all to
broadcast the message to all topology consoles signed on to the same server.
"the_message"
The message to send to the topology console.
Note: The double quotations are required unless the message is a single token.

Appendix A. Topology Server Commands 101


-p
Displays the current settings of the server properties file to the topology server window and to the
message log.
-s
Dumps the server semaphores to the topology server window and to the message log.

102 IBM Z NetView: User's Guide: NetView Management Console


Appendix B. Topology Console Commands

The topology console commands provided in this appendix are intended to be used as reference material.
The format in the following commands is in the form of syntax diagrams.

tconsolexx
Format
tconsolexx
tconsolexx path
-user <name>

-password <password>

-host <host_system>

-restore

-admin
-s
-trace

-rascomp <value>

-rastype <value>

-dump <value>

-perform

-key nmc

-b

-locale <locale>

-demo

-local

-f
-c

-saveViewsLocally

-noPlugin

-http

-debug

-?

Purpose
Starts the topology console from the command line. Start this directly from the topology console bin
directory. Following are the possible values for xx:
NT
Windows systems
.sh
AIX or Linux systems

© Copyright IBM Corp. 1997, 2022 103


Parameters
path
Specifies the top level of the topology console installation path:
• For Windows systems: %BINDIR%\..\generic_unix\TDS\client
• For AIX or Linux systems: $BINDIR/../generic_unix/TDS/client
-user <user>
Specifies the topology console sign on user ID. See “Using the Topology Console Sign On Window” on
page 53 for more information.
-password <password>
Specifies the topology console sign on password or password phrase. See “Using the Topology
Console Sign On Window” on page 53 for more information.
-host <host_system>
Specifies the topology console sign on host name and possible port number. See “Using the Topology
Console Sign On Window” on page 53 for more information.
-restore
Specifies the topology console sign on restore console attribute. See “Using the Topology Console
Sign On Window” on page 53 for more information.
-admin
Specifies the topology console sign on administrator attribute. See “Using the Topology Console Sign
On Window” on page 53 for more information.
-s
Automatically signs on using the specified options, previously saved values, or both. See “Using the
Topology Console Sign On Window” on page 53 for more information.
-trace
This option is for IBM Software Support only. It enables default tracing.
-rascomp <value>
This option is for IBM Software Support only. The <value> variable can be obtained from the Service
page of the Console Properties notebook.
-rastype <value>
This option is for IBM Software Support only. The <value> variable can be obtained from the Service
page of the Console Properties notebook.
-dump <value>
This option is for IBM Software Support only.
-perform
This option is for IBM Software Support only. Enables performance tracing.
-key nmc
Optional keyword.
-b
Use buffered tracing.
-locale
Override the default locale. The format for locale follows:

langCode [countryCode]

-demo
Starts the topology console disconnected from the topology server.
-local
Starts the topology console disconnected from the topology server.

104 IBM Z NetView: User's Guide: NetView Management Console


-f
Suppresses automatic synchronization of support files from the topology server.
-c
Suppresses automatic synchronization of topology console code from the topology server. This is not
recommended.
-saveViewsLocally
When Save View Customization is used while a connection to a topology server exists, the view is
saved in a standalone file on the topology console workstation. This option is used only for capturing
live views for use in a demonstration.
-noPlugin
Suppresses loading of any plug-ins.
-http
Forces the starting of the web server regardless of the current console property settings. This option
enables another application to set up the NetView management console environment before sending
locate-resource requests.
-debug
Enables built-in debugging code. This option is for IBM Software Support only.
-?
Display the command-line usage.

Usage
All scripts support the following optional environment variables:
TCONSOLE_BACKDOOR
Java code library (or libraries) placed at front of CLASSPATH. This option is for IBM Software Support
only.
TCONSOLE_CLASSPATH
Java code library (or libraries) placed at end of CLASSPATH. Typically, this is used to define other Java
classes to be accessed by the NetView management console.
TCONSOLE_JAVAOPTS
Command-line arguments for Java program. This option is for IBM Software Support only.

tappxx
Format
tappxx
tappxx path class_name args

Purpose
Starts the topology console utility functions. Start this directly from the topology console bin directory.
Following are the possible values for xx:
NT
Windows systems
.sh
AIX or Linux systems

Appendix B. Topology Console Commands 105


Parameters
path
Specifies the top level of the topology console installation path:
• For Windows systems: %BINDIR%\..\generic_unix\TDS\client
• For AIX or Linux systems: $BINDIR/../generic_unix/TDS/client
class_name
Specifies the class name for the topology console provided utility.
args
Specifies any arguments that are required for the utility.

Usage
All scripts support the following optional environment variables:
TCONSOLE_BACKDOOR
Java code library (or libraries) placed at front of CLASSPATH. This option is for IBM Software Support
only.
TCONSOLE_CLASSPATH
Java code library (or libraries) placed at end of CLASSPATH. Typically, this is used to define other Java
classes to be accessed by NetView management console.
TCONSOLE_JAVAOPTS
Command-line arguments for Java program. This option is for IBM Software Support only.

106 IBM Z NetView: User's Guide: NetView Management Console


Appendix C. Creating a Demonstration

You can create your own new NetView management console demonstration, customized to look and feel
like your NetView management console environment and display views from your network environment.
This section provides the process to create your own demonstration.
The demonstration capability is installed as part of the NetView Management Console Productivity Kit
(on the Windows platform, only). Be sure to perform a custom installation of the NetView management
console topology console and select the NetView Management Console Productivity Kit. To access further
information about the demonstration function, in the Windows environment, double-click the NMC
Productivity Kit icon on the desktop.
You can capture views from a live NetView management console system and integrate them into your
demonstration. Do this to demonstrate NetView management console in your own environment to provide
operator training, for example.
The following sections contain the steps that are required to create a new demonstration.
1. “Capturing Live Views from your NetView Management Console System” on page 107.
2. “Integrating Captured Views into the Demonstration” on page 114
a. “Updating the Business Tree” on page 114.
b. “Renaming Navigation Views” on page 116.
3. “Defining New Resource Types in Saved Views” on page 116.
After you complete these steps, the new demonstration consists of the files that are shown in Table 42 on
page 107.

Table 42. Demonstration Files


Demonstration Directory Files
View files (basic <installRoot>\bin\generic_unix\TDS\client\views *.md
data files)
Basic data <installRoot>\bin\generic_unix\TDS\client\settings basicdata.nmc
definitions
(See “Using Basic
Data Files” on
page 109 to define
additional resource
types).

Capturing Live Views from your NetView Management Console


System
To capture views from a live NetView management console system for subsequent integration
into the demonstration, use the -saveViewsLocally command-line argument. This argument
instructs the Save View Customization code to save the view in a local file in the
<installRoot>\bin\generic_unix\TDS\client\views directory instead of within the topology server database.
Note: For more information about local files, see “Renaming Navigation Views” on page 116.
To capture a view from the client workstation and to save all the views that you want to be displayed in
your demonstration, perform the following steps:
1. From the command prompt, make a backup copy of the demonstration views shipped with NetView
management console in the following way:

© Copyright IBM Corp. 1997, 2022 107


a. cd <installRoot>\bin\generic_unix\TDS\client\views
b. md backup
c. copy * backup
2. From the command prompt, delete all of the shipped NetView management console demonstration
files in the following way:
a. cd <installRoot>\bin\generic_unix\TDS\client\views
b. del *
3. Start the NetView management console topology console by using the -saveViewsLocally
command-line argument. To do this, change the properties of the NMC Topology Console desktop
icon, in the following way:
a. Right-click on the NMC Topology Console desktop icon to display the context menu.
b. Click Properties.
c. From the notebook that opens, select the Shortcut tab.
d. Select the Target field and place the cursor after the last character.
e. Type a separating blank and then enter -saveViewsLocally.
f. Click OK.
4. Start the NetView management console topology console and sign on.
5. Save the business tree view in the following way:
a. Right click on the background of the business tree.
b. Select Save View Customization.
This creates the <installRoot>\bin\generic_unix\TDS\client\views\1.ctl.md file. The root node of
the business tree is always resource ID 1.
Note: For more information about resource Ids, see “Finding the Resource ID” on page 117.
c. Save all of the specific views to be included in your demonstration by opening each view
individually. To open each view, perform one of the following actions:
• From the business tree, open each view sequentially.
• Select Locate Resource.
• Select More Detail, Configuration, or Locate Failing Resource from an open view.
d. To save each view:
i) Right click on the view background.
ii) Select Save View Customization.
e. Correlate the type of view saved with the saved name by performing the following steps:
i) Write down information such as the view type, view name, Configuration Parents, More Detail,
and Locate Resource.
ii) Look in the <installRoot> \bin\generic_unix\TDS\client\views\ directory for the view that you
just saved. It has the format <resourceid>.ctl.md. Write down this file name next to the view
type. You need this information when you rename the view to conform to the demonstration
naming conventions later.
The view you just created is the newest view in the directory. If you kept track of the
demonstration views as you created them, you should be able to distinguish which view was
just created to associate it with the view type.
Note: Multiple navigation views can be created from the same resource.
A fixed file name is created for each view saved based on the ID of the resource, regardless of
how the view is opened. If you save a More Detail and a Configuration view initiated from the
same resource, the same view file name is used. The last view saved is the available view. If

108 IBM Z NetView: User's Guide: NetView Management Console


you want to have multiple navigation views available from a single resource, you must use these
steps:
a) Select the Nth navigation view.
b) Save the view.
c) Rename the saved view.
d) Repeat these steps for the next navigation view.
6. Integrate the captured views into the demonstration in the following way.
a. Update the business tree. For detailed information about performing this step, see “Updating the
Business Tree” on page 114.
b. Rename the navigation views to conform to the required demonstration naming conventions. For
detailed information about performing this step, see “Renaming Navigation Views” on page 116.
7. Define any resource types in the saved views that were not previously defined.

Using Basic Data Files


Because Resource Object Data Manager (RODM), the topology server, and the CPE command definitions
are not available when the NetView management console topology console is run in demonstration mode,
the basic data properties files are used to define:
• Resource types
• Individual context menu items
• Sets of context menu items
• A set of view menu items (resource independent)
• A default set of real (resource dependent) resource menu items
• A default set of aggregate (resource dependent) resource menu items
When the console starts, the following files are loaded from the
<installRoot>\bin\generic_unix\TDS\client\settings directory:
• basicdata[<multicultural_support_language>] (base definitions of resources and common menu items)
• basicdata[<multicultural_support_language>].nmc (additional NetView management console resource
types and menu items)
Before making any changes to these files, make backup copies of these files with one of the following
methods:
• Use a packaging tool such as PKZip, WinZip, or tar.
• Create a backup directory and copy the installed files into it.
The following Japanese files can also be customized, using double byte character set (DBCS) characters,
with conversion commands:
• basicdata_ja
• basicdata_ja.nmc
• defaultschemetext_ja.properties
To customize these files, first convert them with the following command prior to editing:

native2ascii -reverse <input_dir>\filename <outpug_dir>\filename

After editing, perform a second conversion with the following command:

native2ascii -encoding SJIS <input_dir>\filename <outpug_dir>\filename

Appendix C. Creating a Demonstration 109


Defining a Menu Item
Table 43 on page 110 gives a description of the attributes available for menu item definition where the
N in the attribute is a consecutive sequence number (1, 2, ..., n) within the group of menu items. Several
types of menu items are supported. Each type has a separate definition list in the basic data file and
different definition requirements, as shown in Table 44 on page 110.

Table 43. Description of menu item attributes


Attribute Purpose
mi.N.<attr> Java applications launched using
com.tivoli.ihs.client.action.IhsJavaAppAction.
Note: Use this type of attribute for testing Java applications.

sc.N.<attr> Predefined scenarios.


nop.N.<attr> NOP menus which are displayed in the context menu but do not
do anything when selected.

Table 44. Attributes that can be specified for a menu item.


<attr> Description mi.N.<attr> Sc.N.<attr> nop.N.<attr>
tag Tag name that is Required Required Required
used to reference
this menu item
label Menu item text Required Required Required
class Package-qualified Optional Ignored Ignored
Java class that
provides the Java Def: Def: IhsScenario1 Def: IhsCPEAction1
implementation of IhsJavaAppAction1
this menu item
data Class specific data Optional Required Ignored

Def: blank scenario file name and


arguments
html Menu Help HTML Optional Optional Optional
panel name for the
menu item Def: ihs_nohelp_XXX. Def: ihs_nohelp_XXX. Def: ihs_nohelp_XXX.
html html html
max Maximum number Optional Optional Optional
of selected
resources Def: 1 Def: 1 Def: 1
supported by a
particular resource
type
debug Determines if this is Optional Optional Optional
a debug menu item;
enabled when the Def: false Def: false Def: false
-debug command-
line argument is
used

110 IBM Z NetView: User's Guide: NetView Management Console


Table 44. Attributes that can be specified for a menu item. (continued)
<attr> Description mi.N.<attr> Sc.N.<attr> nop.N.<attr>
vfy Determines if a Optional Optional Optional
verification prompt
is needed before Def: false Def: false Def: false
the item is
launched2

Notes:
1. These classes are part of the com.tivoli.ihs.client.action package.
2. This attribute, <attr>, is not currently implemented.

Defining a Set of Menus


A set of menus is a named group of one of the following items:
• Menu items
• Separators
• Other sets
A set can be used to define either of the following items:
• A set of menu items that can be referenced as many times as needed
• A cascaded menu item
Conditional debug sets are enabled when the -debug command-line argument is used.
A set is defined using the following syntax:

set.N.<attr>=value
set.N.X =tag reference

where:
• The set stem uniquely identifies this as a set definition.
• N is a consecutive sequence number (1, 2, ..., n) within the set definition area.
• X is a consecutive sequence number (1, 2, ..., n) within a set.
The attributes in Table 45 on page 111 can be specified for a set.

Table 45. Attributes that can be specified for a set.


<attr> Description Default
tag Name used to reference this set Required
label Name of cascaded menu item Optional
• If omitted, the set is used as a
container; items are copied into the
current menu.
• If specified, a cascaded menu item is
created with the menu items for this
set.

debug Determines if this is a debug set; Optional Def: false


enabled when the -debug command-line
argument is used

Each item of a set references one of the items in Table 46 on page 112.

Appendix C. Creating a Demonstration 111


Table 46. Set reference items
Tag Reference Description
- (dash) Menu separator
tag name Reference to a:
• menu item
• set

A Sample from basicdata.nmc


The following example is from the basicdata.nmc file.

###################################################
# Context menu items for an AGGREGATE resource
###################################################
set.3.tag =@nmcAgg
set.3.1 =@baseAgg
set.3.2 =-
set.3.3 =nmcFailing
####################################################
# "Configuration" cascaded menu
####################################################
set.4.tag =@nmcConfig
set.4.label =Configuration
set.4.html =ihs_mi_config_XXX.html
set.4.1 =nmcCfgPar
set.4.2 =nmcCfgChild
set.4.3 =nmcCfgPeer
set.4.4 =nmcCfgLP
set.4.5 =nmcCfgL
set.4.6 =nmcCfgP
set.4.7 =nmcCfgBBone
#####################################################
# SET for all example Java applications
######################################################
set.5.tag =@exJavaApps
set.5.debug =true
set.5.1 =-
set.5.2 =exGUI
set.5.3 =exCmdRsp
set.5.4 =exIPL

Defining a Resource Type


A resource type is defined using syntax as shown in Table 47 on page 112.

Table 47. Attributes that can be specified for a resource type.


<attr> Description Default
rtX_name Name; specified in node/link
"resource type" field
rtX_desc Description text Optional
resource type name

rtX_image Image file name Optional


node.gif

rtX_geometric Geometric shape name Optional


com.tivoli.ihs.reuse.gui.IhsRectangle

112 IBM Z NetView: User's Guide: NetView Management Console


Table 47. Attributes that can be specified for a resource type. (continued)
<attr> Description Default
rtX_help Help URL Optional
none

rtX_flags Flags Optional


1

The following example is from the basicdata.nmc file:

rt34_name=268828673
rt34_desc=LU
rt34_image=duiu5n00.gif
rt34_geometric=com.tivoli.ihs.reuse.gui.IhsTrapezoid

You can also specify additional context menu items for specific resource types. In the following example,
each rtN_mi.X item is a tag reference.

rt6_name=Lotus Notes Client


rt6_image=notesc.gif
rt6_geometric=com.tivoli.ihs.reuse.gui.IhsPentagon
rt6_mi.1=-
rt6_mi.2=start
rt6_mi.3=stop
rt6_mi.4=busSysHelp
rt6_mi.5=instSmtpGW

The current syntax for defining a resource type is available by using the following command when
CLASSPATH includes the ihseuc.jar file:

java com.tivoli.ihs.client.view.IhsResourceType

Defining Defaults
Each basic data file defines defaults for the following items:
• View context menu items
• Common context menu items for each real resource
• Common context menu items for each aggregate resource
These defaults are shown in the following example:

###########################################################
# Default VIEW items
#
# - each SET reference is a "tag"
# - these values override those in "basicdata"
###########################################################
view.addDefault=true <-- controls if defaultSet is added
view.defaultSet=@nmcView <-- set tag reference

###########################################################
# Default Resource Type items for this "basic data" file
#
# - each SET reference is a "tag"
# - these values override those in "basicdata"
############################################################
agg.addDefault =true <-- controls if defaultSet is added
agg.defaultSet =@nmcAgg <-- set tag reference

real.addDefault=true <-- controls if defaultSet is added


real.defaultSet=@nmcReal <-- set tag reference

Appendix C. Creating a Demonstration 113


Creating a New Resource Type
To create a new resource type, perform the following steps:
1. Add the required rtN_xxx entries at the end of the appropriate basic data file.
Note: The sequence numbers, the N part of rtN, must be sequential with no intervening gaps.
2. To define the geometric shape displayed on a topology view, specify the appropriate package qualified
class names as shown in the following list:
• com.tivoli.ihs.reuse.gui.IhsCircle
• com.tivoli.ihs.reuse.gui.IhsCircleStar
• com.tivoli.ihs.reuse.gui.IhsDiamond
• com.tivoli.ihs.reuse.gui.IhsHexagon
• com.tivoli.ihs.reuse.gui.IhsOctagon
• com.tivoli.ihs.reuse.gui.IhsOval
• com.tivoli.ihs.reuse.gui.IhsParallelogram
• com.tivoli.ihs.reuse.gui.IhsPentagon
• com.tivoli.ihs.reuse.gui.IhsRectangle
• com.tivoli.ihs.reuse.gui.IhsRoundRect
• com.tivoli.ihs.reuse.gui.IhsSolidLine
• com.tivoli.ihs.reuse.gui.IhsStar
• com.tivoli.ihs.reuse.gui.IhsTrapezoid
• com.tivoli.ihs.reuse.gui.IhsTriangle
Example: rtN_geometric=com.tivoli.ihs.reuse.gui.IhsHexagon
To use the new resource type in a view, set the anN_t attribute of a resource to the rtN_name attribute of
your new resource type. For example: an1_t=2147614793.

Integrating Captured Views into the Demonstration


To integrate the captured views into the demonstration, update the business tree and rename the
navigation views.

Updating the Business Tree


After the business tree has been saved, some work is required to make it usable by the
NetView management console code in demonstration mode. Note that the original business tree
file, shipped with NetView management console is the avail.control.md.nmc file. It is located in the
<installRoot>\bin\generic_unix\TDS\client\views\backup directory you created before saving views. This
file illustrates the parent-child relationships used within the business tree to create the tree node,
branches, and leaf nodes.
To make the saved business tree available, perform the following steps from the client workstation:
1. From the command prompt, rename the saved business tree view in the following way:
a. cd <installRoot>\bin\generic_unix\TDS\client\views
b. copy 1.ctl.md avail.control.md.nmc
Notes:
a. The root node of the business tree is always resource ID 1. For more detailed information
about the resource ID, see “Finding the Resource ID” on page 117.
b. If you copy the file, instead of renaming it, you can keep the original if you want to restart the
process during this procedure.

114 IBM Z NetView: User's Guide: NetView Management Console


2. Edit the avail.control.md.nmc file.
3. Replace the complete view model at the beginning of the file with the line in the After column in
Table 48 on page 115. For more detailed information about the view model, see “Defining View
Information” on page 120.

Table 48. Replacing the view model text example (before and after).
Before After
view_id=xxxx view_id=availAvail
view_prev_id=-1 view_width=500
view_useimage=-1 view_height=900
view_openview=0
view_width=xxxx
view_height=xxxx
view_cust=true
view_customizable=true
4. Remove all parent references to the root node of the tree by following these steps:
a. Locate every parent reference by searching for the string _p=1.
b. Delete each of these lines containing _p=1.
c. Verify that the value is 1 (and not 1x or 1xx, for example).
5. Update the resource type for every node by inserting the RT prefix as shown in Table 49 on page 115.

Table 49. Updating the resource type example (before and after).
Before After
anx_t=536871171 anx_t=RT536871171
6. Verify that the special business tree nodes shown in Table 50 on page 115 are defined to use these
specific resource type values. If a different value is present as the anX_t attribute, replace it with the
required value shown in Table 50 on page 115.
By doing this, you can avoid error messages when NetView management console is started and have
the correct icon displayed in the business tree.

Table 50. Verifying the resource type values for business tree nodes.
Special Business Tree Node (found in the anX_l Required Resource Type (defined in
attribute) basicdata.nmc)
Business Systems RT536871171
Systems Management Business System RT536871228
Networking RT536871168
Network Views RT536871169
Exception Views RT536871170
7. Remove the following attributes from every node in the business tree:
• anx_da=true
• anx_def=true
8. Save your changes.
To verify these changes, perform the following steps:

Appendix C. Creating a Demonstration 115


a. Start the NetView management console demonstration.
b. Verify that the business tree is properly displayed.
c. Verify that the views you saved, which were initiated from the business tree, can open.
9. Integrate the captured views into the demonstration by renaming the navigation views to conform to
the naming conventions for your demonstration.
10. Define any resource types in the saved views that were not previously defined.

Renaming Navigation Views


To rename the navigation view, first locate the correct navigation file. All of the target navigation files are
located in the <installRoot\bin\generic_unix\TDS\client\views> directory. Table 51 on page 116 shows
the naming conventions.

Table 51. Naming conventions for navigation views.


Navigation Context Menu Target File Naming Convention
Configuration > Parents <resource ID>.par.ctl.md
Configuration > Children <resource ID>.chd.ctl.md
Configuration > Peers <resource ID>.peer.ctl.md
Configuration > Logical and Physical <resource ID>.lp.ctl.md
Configuration > Logical <resource ID>.log.ctl.md
Configuration > Physical <resource ID>.phy.ctl.md
Configuration > Backbone <resource ID>.bak.ctl.md
Locate Failing Resources <resource ID>.fp.ctl.md
Locate Resource <locate name>.locate.md
More Detail <resource ID>.ctl.md

Defining New Resource Types in Saved Views


The views you save might contain resources that are not currently defined for the demonstration. This
section provides the steps necessary to define missing RODM resource types to the demonstration. When
a resource type is referenced in a view that is not currently defined, messages similar to the following
messages are written to stderr when the view is opened.

IhsViewModel:verifyView(save) Thread-8 p1=64 p2=ResourceType (2416050177) specified


on 2 was not found
IhsViewModel:verifyView(save) Thread-8 p1=64 p2=Setting 2's resource type to
IhsNodeRT
IhsViewModel:verifyView(save) Thread-8 p1=1085 p2=ResourceType (2147549291)
specified on 3 was not found
IhsViewModel:verifyView(save) Thread-8 p1=1085 p2=Setting 3's resource type to
IhsLinkRT

where:
• 2416050177 is the resource type specified in the anX_t attribute of a node resource.
• 2 is the resource ID specified in the anX_r attribute of a node resource.
• 2147549291 is the resource type specified in the alXt attribute of a link resource.
• 3 is the resource ID specified in the alX_r attribute of a link resource.
In a view, these resources display as icons.

116 IBM Z NetView: User's Guide: NetView Management Console


All of the information required to define a RODM resource type is available from the Legend window
when you are connected to a live NetView management console system. To define missing resource types
referenced by saved views from the client workstation, perform the following steps:
1. Select Help→Legend... to open the Legend window.
2. To locate the resource type, search the ID column of the Legend window for a decimal value
(2416050177, for example). This is the resource type that must be added.
3. Edit the basicdata.nmc file.
For more information about this file, see “Using Basic Data Files” on page 109.
4. Using the information in Table 52 on page 117, create a new resource type at the end of the currently
defined set.

Table 52. Creating a new resource type from the management console – Legend window.
Resource Type Attribute Description Legend Column
rtX_name Name use the decimal ID value (2nd
value)
rtX_desc Description text Resource Type
rtX_image Image file name Icon File Name
rtX_geometric Geometric shape map shape to the corresponding
geometric
rtX_help Help Help File Name
rtX_flags Flags Flags

For more information about creating new resource types, see “Creating a New Resource Type” on page
114.
The following example shows how an Advanced Peer-to-Peer Networking end node can be defined:

rtX_name=327883
rtX_desc=APPN end node (EN)
rtX_image=duiu5n00.gif
rtX_geometric=com.tivoli.ihs.reuse.gui.IhsOctagon

5. Save your changes.


6. Start the NetView management console demonstration and verify that the proper icon is now
displayed.

Finding the Resource ID


The topology server assigns each resource an internal resource ID value. This value is important for
demonstration mode because it is used to generate the name of navigation view files. To determine the ID
of a resource on a live NetView management console system, perform the following steps:
1. Sign on.
2. Select the Options menu item and then Console Properties to open the Console Properties
notebook.
3. Select the Service tab, which is the last tab in the notebook.
4. Check Action in the Components section.
5. Check Debug data in the Trace types section.
6. Click OK.
7. Select the view that contains the resource ID you want to find.
8. Click the resource to open the context menu for that resource and select Resource Properties.

Appendix C. Creating a Demonstration 117


9. Select the Debug tab. The Resource Properties window displays debugging data about the resource.
10. Look for ibmId in the property field. The corresponding Value is the ID for the resource. The ID
value is displayed in decimal and hexadecimal. Usually, you need to use the decimal value.

Defining a Node Resource in a View


The attributes used to define a node resource in a view are shown in Table 53 on page 118.

Table 53. Attributes to define a node resource in a view.


Attribute Definition
anX_i Display ID (unique per view).
anX_r Server ID (unique per server); double clicking the resource drills to <serverID>.md.
anX_p Parent ID (optional, none).
anX_t Resource type (optional, defaulted).
anX_s Status (optional, normal).
anX_u Flags (optional, zero).
anX_a Determines if this is an aggregate resource (optional, false).
anX_da Suppress '+' on aggregate resources. For Topology Display Subsystem view only,
others not live if suppressed (optional, value of anX_a).
anX_l Label (optional, blank).
anX_lx Label X coordinate (optional, auto).
anX_ly Label Y coordinate (optional, auto).
anX_d1 Data 1: TDS=HB1, NMC=RODM other data (optional, blank).
anX_d2 Data 2: TDS=HB2, NMC=RODM customer data (optional, blank).
anX_d3 Data 3: TDS=HB3, NMC=not used (optional, blank).
anX_d4 Data 4: TDS=HB4, NMC=not used (optional, blank).
anX_per On the business tree view, determines if a view is permanent (optional, false).
anX_cag Specifies if customer aggregation is allowed (Not currently in use.) (optional, true).
anX_c1 Monitor Count 1 (optional, none).
anX_c2 Monitor Count 2 (optional, none).
anX_x X coordinate.
anX_y Y coordinate.

In the documenting class, com.tivoli.ihs.client.view.IhsNode, the following example shows


how a node resource can be defined:

an3_i=3
an3_r=2100
an3_p=39
an3_t=327882
an3_l=NETA.FVT01EM
an3_s=18
an3_per=false
an3_x=342
an3_y=106

118 IBM Z NetView: User's Guide: NetView Management Console


Defining a Link Resource in a View
The attributes used to define a link resource in a view are shown in Table 54 on page 119.

Table 54. Attributes to define a link resource in a view.


Attribute Definition
alX_i Display ID (unique per view).
alX_r Server ID (unique per server); double clicking the resource drills to<serverID>.md.
alX_p Parent ID (optional, none).
alX_t Resource type (optional, defaulted).
alX_s Status (optional, normal).
alX_u Flags (optional, zero).
alX_a Determines if this is an aggregate resource (optional, false).
alX_da Suppress '+' on aggregate resources. For Topology Display Subsystem view only,
others not "real life" if suppressed (optional, value of alX_a).
alX_l Label (optional, blank).
alX_lx Label X coordinate (optional, auto).
alX_ly Label Y coordinate (optional, auto).
alX_d1 Data 1: TDS=HB1, NMC=RODM other data (optional, blank).
alX_d2 Data 2: TDS=HB2, NMC=RODM customer data (optional, blank).
alX_d3 Data 3: TDS=HB3, NMC=not used (optional, blank).
alX_d4 Data 4: TDS=HB4, NMC=not used (optional, blank).
alX_per On the business tree view, determines if a view is permanent (optional, false).
alX_cag Specifies if customer aggregation is allowed (Not currently in use.) (optional, true).
alX_c1 Monitor Count 1 (optional, none).
alX_c2 Monitor Count 2 (optional, none).
alX_1 First end point able to be displayed.
alX_2 Second end point able to be displayed.
alX_d Link direction with respect to the first end point
• 0=none (default)
• 1=origin
• 2=destination
• 3=bidirectional
• 4=replica

In the documenting class, com.tivoli.ihs.client.view.IhsLink, the following example shows


how a link resource can be defined:

al15_r=268
al15_p=216
al15_l=40001A20AC05
al15_d1=Bridge=3F10TOP, Segment=020A, MAC Address=40001A20AC05
al15_per=false

Appendix C. Creating a Demonstration 119


al15_1=28
al15_2=9

Defining View Information


Table 55 on page 120 shows the attributes used to define the appearance of a view.

Table 55. Attributes to Define The Appearance of a View


Attribute Definition
view_id ID for the view
view_prev_id Previous ID for the view
view_width Width of view (optional, 500)
view_height Height of view (optional, 300)
view_layer Layer of view
view_descriptor Descriptor of view (optional, "")
view_fgcolor Foreground text color of view; RGB value (optional, black)
view_ftcolor Free text color of view; RGB value (optional, black)
view_useimage Specifies whether to use image(1)/color(0)/notSet(-1) for view background
(optional, -1)
view_bgcolor If color, the background color RGB value (optional, gray)
view_bg If image, specific image file name
view_bgx If image, image X location within view (optional, -1)
view_bgy If image, image Y location within view (optional, -1)
view_bgwidth If image, width (optional, -1)
view_bgheight If image, height (optional, -1)
view_swidth Width of resource symbol area (optional, 40)
view_sheight Height of resource symbol area (optional, 40)
view_cust Specifies if the view is customized (optional, false)
view_customizable Specifies if the view can be customized (optional, true)
view_ffu Specifies whether or not to force full update of view (optional, false)
view_orp Specifies if override refresh property (optional, false)
view_activetab View automatically opened for tab (optional, first tab)
view_openview Open view option3 (topology or detail view)#

In the documenting class, com.tivoli.ihs.client.view.IhsViewModel, the following example


shows how the appearance of a view can be defined:

al15_r=268
al15_p=216
al15_l=40001A20AC05
al15_d1=Bridge=3F10TOP, Segment=020A, MAC Address=40001A20AC05
al15_per=false
al15_1=28
al15_2=9

120 IBM Z NetView: User's Guide: NetView Management Console


Defining a Demonstration View
A demonstration view is an ASCII flat file that is typically created as described in “Capturing Live Views
from your NetView Management Console System” on page 107. It contains the following collection of
object definitions:
1. A view model definition, as described in “Defining View Information” on page 120.
2. Zero or more node definitions, as described in “Defining a Node Resource in a View” on page 118.
3. Zero or more tack point definitions.
4. Zero or more free text definitions.
5. Zero or more link definitions, as described in “Defining a Link Resource in a View” on page 119.
The following example shows how a demonstration view can be defined.

###############################################################################
# View Definition File
#
# Resource: 89
#
# Created: Fri Feb 01 10:36:29 PST 2013
#
# Warning: Be careful if you modify this by hand!
###############################################################################
view_id=89
view_prev_id=-1
view_bgcolor=-1
view_fgcolor=-16777216
view_ftcolor=-16777216
view_useimage=1
view_openview=0
view_width=398
view_height=240
view_cust=true
view_customizable=true
view_descriptor=NETA.4-MDL
###############################################################################
# Node objects
###############################################################################
an1_i=1
an1_r=473
an1_p=461
an1_t=2147811538
an1_l=D:NETA.NRILOV00
an1_u=134217728
an1_a=true
an1_da=true
an1_per=false
an1_x=200
an1_y=60
an2_i=2
an2_r=474
an2_p=461
an2_t=327776
an2_da=true
an2_per=false
an2_x=200
an2_y=180
###############################################################################
# Tackpoint objects
###############################################################################
###############################################################################
# Free Text objects
###############################################################################
###############################################################################
# Link objects
###############################################################################
al1_i=3
al1_r=475
al1_p=461
al1_l=IC:NETA.NRILOV00.USIBMNT.NTFEMVS
al1_s=20
al1_a=true
al1_da=true
al1_per=false

Appendix C. Creating a Demonstration 121


al1_1=1
al1_2=2

122 IBM Z NetView: User's Guide: NetView Management Console


Appendix D. Launching and Using the NetView
Management Console from Other Applications

This appendix describes how to launch and use the NetView management console from other
applications using servlets, command-line programs, and scripts provided with the NetView management
console. It includes information about the servlets, setting up the NetView management console to use
the servlets, and the command-line programs that call the servlets.

Servlets
Two servlets provided with the NetView management console can be used by other applications:
• The check-web-server servlet, IhsRunning, enables other applications to check whether the NetView
management console web server is running.
• The locate-resource servlet, IhsLocRes, enables other applications to have the NetView management
console locate a specific resource. If the resource is found, a view containing the specified resource is
opened on the NetView management console topology console to which the request is sent.
The default security access for each servlet can be overridden with a servlet_name.access
attribute in the defaultscheme.properties file. The defaultscheme.properties file is
located on the NetView management console topology server in the following directory:
<installRoot>\bin\<interp>\TDS\Server\db\current\settings.
The values for servlet security access are shown in Table 56 on page 123, where:
local
Indicates that the servlet can be run only from the local host.
any
Indicates that the servlet can be run from any host.
disabled
Indicates that the servlet cannot be run.

Table 56. Changing servlet security access


defaultscheme.properties Attribute Default Value Other Valid Value
com.tivoli.ihs.servlet.IhsLocRes.access local any, disabled
com.tivoli.ihs.servlet.IhsRunning.access local any, disabled

Setup
For other applications to use the servlets to launch the NetView management console:
1. The NetView management console must be started.
2. The web server must be started in one of these ways:
• Checking the Automatically start web server check box on the Web Server page in the Console
Properties notebook.
• Using the http parameter with tconsolexx to force the starting of the web server; for more
information, see “tconsolexx” on page 103.
• Clicking on the Start web server now button on the Web Server page in the Console Properties
notebook.

© Copyright IBM Corp. 1997, 2022 123


Using the Servlets
This section describes the syntax for using the servlets directly, and the programs that provide a front end
to using the servlets.

IhsLocRes Servlet

Format
IhsLocRes
get http:// local_host : port_number /com.tivoli.ihs.servlet.IhsLocRes?name=

1
res_name
&display= display_ID HTTP/1.0

Notes:
1 The name and display parameters can be in any order.

Purpose
This is an HTTP get request that uses the IhsLocRes servlet to locate a resource.

Parameters
local_host:port_number
Specifies the host name and port number of the NetView management console web server.
com.tivoli.ihs.servlet.IhsLocRes
Specifies the IhsLocRes servlet.
name=res_name
Specifies the name of the resource to be located.
display=display_ID
Specifies the display ID of the NetView management console. This parameter is required for AIX or
Linux systems, and must match the DISPLAY environment variable on the AIX or Linux system.
HTTP/1.0
If specified, indicates that response codes are to be returned.

Return codes
If the HTTP/1.0 parameter is used, these response codes can be returned:
200
The request has been accepted.
400
The required servlet name was not specified or an incorrect value was specified.
403
The request was not made from the NetView management console host system or the NetView
management console is currently disabled.
409
The display ID specified does not match the display ID of the NetView management console.
500
An internal error occurred.

124 IBM Z NetView: User's Guide: NetView Management Console


IhsRunning Servlet

Format
IhsRunning
get http:// local_host : port_number /com.tivoli.ihs.servlet.IhsRunning?

display= display_ID HTTP/1.0

Purpose
This is an HTTP get request that uses the IhsRunning servlet to check whether or not the NetView
management console web server is running.

Parameters
local_host:port_number
Specifies the host name and port number of the NetView management console web server.
com.tivoli.ihs.servlet.IhsRunning
Specifies the IhsRunning servlet.
display=display_ID
Specifies the display ID of the NetView management console. This parameter is required for AIX or
Linux systems, and must match the DISPLAY environment variable on the AIX or Linux system.
HTTP/1.0
If specified, indicates that response codes are to be returned.

Return codes
If the HTTP/1.0 parameter is used, these response codes can be returned:
200
The NetView management console web server is running.
403
The request was not made from the NetView management console host system or the NetView
management console web server is currently disabled.
409
The display ID specified does not match the display ID of the NetView management console.

locRes Java Class

Format
LocRes
java com.tivoli.ihs.cli.locRes resource_name
-Dverbose port_number

Purpose
The locRes Java class uses the IhsLocRes servlet to locate a resource.

Appendix D. Launching and Using the NetView Management Console from Other Applications 125
Parameters
–Dverbose
Specifies that debugging information, including the return code, is to be printed.
com.tivoli.ihs.cli.locRes
Specifies the locRes Java class, which uses the IhsLocRes servlet.
resource_name
Specifies the name of the resource to be located.
port_number
Specifies the port number of the NetView management console web server. The default is port 80.

Return codes
0
The request was accepted.
1
The request was rejected because the web server is not running, access is denied, or the resource
name is not valid.
2
A command-line argument is in error.

Usage
This program is started from the command line or can be run using the tappxx scripts; for information
about tappxx, see “tappxx” on page 105. To use the Java command, you must install your own Java
environment.
If you use the tappxx script, the –Dverbose parameter must be specified with the
TCONSOLE_JAVAOPTS environment variable, rather than on the command line.

nmcRunning Java Class

Format
nmcRunning
java com.tivoli.ihs.cli.nmcRunning
-Dverbose -Dpoll

port_number

Purpose
The nmcRunning Java class uses the IhsRunning servlet to check whether the NetView management
console web server is running.

Parameters
–Dverbose
Specifies that debugging information, including the return code, is to be printed.
–Dpoll
Specifies that the program is to poll 10 times before stopping. A ten-second wait occurs between
each poll. If this parameter is not specified, the program polls only once.
com.tivoli.ihs.cli.nmcRunning
Specifies the nmcRunning program, which uses the IhsRunning servlet.

126 IBM Z NetView: User's Guide: NetView Management Console


port_number
Specifies the port number of the NetView management console web server. The default is port 80.

Return codes
0
The request was accepted.
1
The request was rejected because the web server is not running or access is denied.
2
A command-line argument is in error.

Usage
This program is started from the command line or can be run using the tappxx scripts; for information
about tappxx, see “tappxx” on page 105. To use the Java command, you must install your own Java
environment.
If you use the tappxx script, the –D parameters must be specified with the TCONSOLE_JAVAOPTS
environment variable, rather than on the command line.

tlocResxx Script

Format
tlocResxx
tlocResxx path port_number resource_name args

Purpose
This script submits a locate-resource request to the NetView management console web server, starting
the NetView management console topology console, if necessary, with the appropriate tconsolexx script.
The possible values for xx are:
NT
Windows systems
.sh
AIX or Linux systems

Parameters
path
Specifies the top level of the topology console installation path:
• For Windows systems: %BINDIR%\..\generic_unix\TDS\client
• For AIX or Linux systems: $BINDIR/../generic_unix/TDS/client
port_number
Specifies the port number of the NetView management console web server.
resource_name
Specifies the name of the resource to be located.
Note: If the % (percent sign) character is included in the string for the resource name, you need to
include two percent sign (%%) characters as the first is removed on the Windows platform.
args
Specifies optional tconsolexx start-up arguments. These arguments are used if the NetView
management console topology console has to be started.

Appendix D. Launching and Using the NetView Management Console from Other Applications 127
Usage
This script supports the following optional environment variables:
TCONSOLE_BACKDOOR
Java code libraries placed at the front of CLASSPATH. This option is for IBM Software Support only.
TCONSOLE_CLASSPATH
Java code libraries placed at the end of CLASSPATH. Typically, this is used to define other Java classes
to be accessed by the NetView management console topology console.
TCONSOLE_JAVAOPTS
Command-line arguments for the Java program. This option is for IBM Software Support only.

128 IBM Z NetView: User's Guide: NetView Management Console


Appendix E. Sending Commands to Multiple NetView
Domains

When sending certain commands from the topology console, such as Activate, Inactivate, or Recycle,
to the NetView host, there might be more than one NetView domain to run the command against.
This occurs only when you select a Systems Network Architecture topology manager resource with a
command indicator value of 32769 and the command is to be run at the NetView program using the
IHSXTHCE command exit. For example, when you select an SNA topology manager resource against
which to issue a command, more than one NetView domain might be monitoring that resource. In this
case, a multiple domain dialog box is displayed, so you can select one or more NetView domains. The
following example shows the multiple domain dialog box.

Figure 19. Multiple Domain Dialog Box Example

You can also specify one or more NetView domains as a default. In this case, when a command is issued
against a resource, only the NetView domains specified as the default receive the command.
To specify a NetView domain as the default, follow these steps:
1. Create one or more files named:
• userMultiDom.properties where user is the user name of an operator. Use this file if you want to
specify one or more NetView domains as a default for a specific operator.
• DefaultMultiDom.properties to specify one or more NetView domains as the default for all
operators.
The following example shows these properties:

autoSelect.1 = NTA09

autoSelect.2 = NTM12

autoSelect.3 = NTM13

autoSend = true

When autoSend = true, commands are run on the NetView domains specified in the properties file
without any operator interaction (the multiple domain dialog box is not displayed). All other NetView
domains are ignored. A value of autoSend = false indicates that the multiple domain dialog box

© Copyright IBM Corp. 1997, 2022 129


should be displayed for the operator with the domains specified in the properties file automatically
selected.
2. Store these files on the topology server workstation in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\db\current\settings
• For AIX or Linux systems: $BINDIR/TDS/server/db/current/settings

130 IBM Z NetView: User's Guide: NetView Management Console


Appendix F. Auditing and the ihsaudit.xml File

The NetView management console includes auditing capability and enables a log of various actions
taken on the NetView management console topology console and NetView management console topology
server which can be used as an audit trail. This auditing function is based on and operated by the
topology server. An XML (Extensible Markup Language) file, ihsaudit.xml, that is located in the
%BINDIR%/TDS/server/log directory contains the auditing information. The ihsaudit.xml file can
be edited by an ASCII text editor. This log can be displayed in a web browser, or other application, which
supports XML.
Note: For display from a web browser, the browser must support either CSS (Cascading Style Sheet) or
XSL (Extensible Style sheet Language) to enable the display of the log data from the ihsaudit.xml file.
The following NetView management console functions can be audited:
• Starting and stopping of the NetView management console topology server
• Using the NetView NETCONV command to start and stop communication between the host and server
• Signing on and off of the NetView management console topology console
• Signing on and off of the command profile editor (CPE) batch utility
• Starting commands
• Command responses
• Open view requests, including locate resource requests
• Open view responses
• Closing views
• View Customization
• Flag change requests, including note changes and list suspended resources requests
• Send message requests
• Aggregation priority and threshold change requests
To specify which functions are to be audited, edit the server.properties file located in the %BINDIR%
\TDS\server\config directory. For more details on editing this file, see “Auditing Functions and
the Server.Properties File” on page 9. The size of the ihsaudit.xml file can also be set. For more
information about this function in the server.properties file, see “Customizing the Size of the Audit
Log” on page 11.

Elements in the ihsaudit.xml file


The audit entry elements in the ihsaudit.xml file are defined in a data type definition (DTD) file,
ihsaudit.dtd, which is shipped with the NetView management console topology server as a sample.
The ihsaudit.dtd file is located in one of the following directories:
• For Windows systems: %BINDIR%\TDS\server\sample
• For AIX or Linux systems: $BINDIR/TDS/server/sample
Note: Editing this file is not recommended.
The ihsaudit.dtd file lists the data elements contained in the ihsaudit.xml file. A description of
each of these elements follows:

© Copyright IBM Corp. 1997, 2022 131


action ELEMENT
Format

<!ELEMENT action
(#CDATA) >

Description
General purpose, further qualifies the action that occurred for this audit entry. See “Audit Entry
Actions” on page 145 for the possible actions for each audit entry.
Parents
Aggregation, command, cpe, flag, netconv, nmcConsole, nmcServer, sendMsg, viewCust, viewNav
Children
None

admin ELEMENT
Format

<!ELEMENT admin
(#CDATA) >

Description
Determines, during sign on and sign off, if administrator access was requested. Will be either yes or
no.
Parents
nmcConsole
Children
None

aggPri ELEMENT
Format

<!ELEMENT aggPri
(#CDATA) >

Description
Aggregation priority was changed for a real resource.
Parents
Aggregation
Children
None

aggregation ELEMENT
Format

<!ELEMENT aggregation
(action,id,ipAddr,rodmId,((aggPri)|(thresholdDeg,thresholdSevDeg,
thresholdUnsat))) >

Description
Qualifies an auditEntry to represent a change to the aggregation priority of a real resource or a change
to the aggregation thresholds of an aggregate resource.
Parents
auditEntry

132 IBM Z NetView: User's Guide: NetView Management Console


Children
One each of (action, id, ipAddr, rodmId). One each of (aggPri) for a real resource and one each of
(thresholdDeg, thresholdSevDeg, thresholdUnsat) for an aggregate resource.

auditEntry ELEMENT
Format

<!ELEMENT auditEntry
(date,
(aggregation|command|cpe|flag|netconv|nmcConsole|nmcServer|sendmsg|
viewCust|viewNav)) >

Description
Wrappers one audit log entry.
Parents
auditLog
Children
One date and one of the following elements: aggregation, command, cpe, flag, netconv, nmcConsole,
nmcServer, sendMsg, viewCust, viewNav

auditLog ELEMENT
Format

<!ELEMENT auditLog
(auditEntry+) >

Description
Wrappers the entire audit log.
Parents
None
Children
One (or more) auditEntry (or entries).

cmd ELEMENT
Format

<!ELEMENT cmd
(#CDATA) >

Description
Contains the command string to be processed. Before a command string is written to the audit log,
if the auditTranslateToBrowseableChars attribute in the server.properties file is set to
1, then a subset of characters found in the command response string that cannot be browsed is
translated to a character format that can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
Parents
command
Children
None

Appendix F. Auditing and the ihsaudit.xml File 133


cmdResp ELEMENT
Format

<!ELEMENT cmdResp
(#CDATA) >

Description
Contains the command responses. Before a command response string is written to the audit log, the
following server.properties attributes are checked in the following order:
• auditCarriageReturnReplacement
If the auditCarriageReturnReplacement attribute is set to 1, then any carriage return (0x0D),
line feed (0x0A), or carriage return immediately followed by a line feed (0x0D0A) found in the
command response string is replaced with the characters specified by server.properties
attribute auditCarriageReturnReplacementValue.
For more information, see “Customizing the Replacement Character for Carriage Returns and Line
Feeds” on page 13.
• auditTranslateToBrowseableChars
If the auditTranslateToBrowseableChars attribute is set to 1, then a subset of characters
found in the command response string that cannot be browsed is translated to a format which can
be browsed. The following characters are examples:
– & is changed to &amp;
– < is changed to &lt;
– > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
• auditCommandResponseMaxSize
If the auditCommandResponseMaxSize attribute is not equal to 0 (zero), then the command
response string is truncated to the maximum length specified by the attribute.
For more information, see “Customizing the Length of Command Responses within the Audit Log”
on page 12.
Parents
command
Children
None

command ELEMENT
Format

<!ELEMENT command
(action,id?,ipAddr?,corrId,res?,rodmId?,menuText?,(cmd|cmdResp)) >

Description
Qualifies an auditEntry to represent either a command to be started or the command responses.
Parents
auditEntry
Children
One each of the following elements: action, corrId, (cmd|cmdResp). Optionally, one each of the
following elements: id, ipAddr, res, rodmId, menuText.

134 IBM Z NetView: User's Guide: NetView Management Console


corrId ELEMENT
Format

<!ELEMENT corrId
(#CDATA) >

Description
Contains a numeric correlation ID used to correlate a command that is started with the corresponding
command responses.
Parents
command
Children
None

cpe ELEMENT
Format

<!ELEMENT cpe
(action,id) >

Description
Qualifies an auditEntry to represent a command profile editor (CPE) batch utility sign on.
Parents
auditEntry
Children
One each of action and id.

date ELEMENT
Format

<!ELEMENT date
(#CDATA) >

Description
Timestamp of the audit log entry in the following format: YYYY-MM-DD HH:MM:SS
Parents
auditEntry
Children
None

extSearch ELEMENT
Format

<!ELEMENT extSearch
(#CDATA) >

Description
When a locate resource request is performed, indicates if the extended search option was selected.
Will be either yes or no
Parents
viewNav
Children
None

Appendix F. Auditing and the ihsaudit.xml File 135


flag ELEMENT
Format

<!ELEMENT flag
(action,id,ipAddr,((flagMask,flagValue)|(noteMask,note))?)
>

Description
Qualifies an auditEntry to represent one of the following items:
• Change to a flag, or flags, of a resource
• Change to a note of a resource
• List suspended resources request
If several notes are changed at one time, a separate auditEntry exists for each changed note.
Parents
auditEntry
Children
One each of the following elements: action, id, ipAddr. Optionally, one each of the following elements:
flagMask, flagValue, noteMask, note.

flagMask ELEMENT
Format

<!ELEMENT flagMask
(#CDATA) >

Description
Contains a hexadecimal 4-byte field, with one or more bits turned on. It represents the flag or flags
that changed (not the value to which the flag changed). These bit values are defined by the UserStatus
field in RODM. An example is 0x40000000, which indicates that the suspended flag is being changed.
Parents
flag
Children
None

flagValue ELEMENT
Format

<!ELEMENT flagValue
(#CDATA) >

Description
Contains a hexadecimal 4-byte field, with one or more bits turned on or off. This represents the value
to which the flag or flags are being changed. The value in the flagMask field represents the flag or flags
being set. These values are defined by the UserStatus field in RODM. An example is 0x40000000,
which turns on the suspended flag.
Parents
flag
Children
None

136 IBM Z NetView: User's Guide: NetView Management Console


fromHostname ELEMENT
Format

<!ELEMENT fromHostname
(#CDATA) >

Description
Contains a TCP host name from which a message is sent. This is in the context of the send message
function. If the message is sent from a topology console, fromHostname contains the TCP host name
of the topology console that sent the message. If the message is sent from the topology server,
fromHostname contains the TCP host name of the Z NetView program connected with the topology
server.
Parents
sendMsg
Children
None

fromId ELEMENT
Format

<!ELEMENT fromId
(#CDATA) >

Description
Contains the user name (a Z NetView logon ID) from which a message is being sent. This is in the
context of the send message function.
Parents
sendMsg
Children
None

fromIpAddr ELEMENT
Format

<!ELEMENT fromIpAddr
(#CDATA) >

Description
Contains the IP address of the TCP/IP host name from which a message is sent. This is in the context
of the send message function. If the message is sent from a topology console, fromIpAddr contains
the IP address of the TCP host name of the topology console that sent the message. If the message
is sent from the topology server, fromIpAddr contains the IP address of the TCP host name of the Z
NetView program connected with the topology server.
Parents
sendMsg
Children
None

hostname ELEMENT
Format

<!ELEMENT hostname
(#CDATA) >

Appendix F. Auditing and the ihsaudit.xml File 137


Description
Contains a TCP host name.
Parents
netconv, nmcConsole
Children
None

id ELEMENT
Format

<!ELEMENT id
(#CDATA) >

Description
Contains a user name (a Z NetView logon ID).
Parents
aggregation, command, cpe, flag, nmcConsole, viewCust, viewNav
Children
None

initRes ELEMENT
Format

<!ELEMENT initRes
(#CDATA) >

Description
Contains the initiating resource name; for example, the RODM object ID of the resource that was
selected, to navigate to another view.
Parents
viewNav
Children
None

ipAddr ELEMENT
Format

<!ELEMENT ipAddr
(#CDATA) >

Description
Contains an IP address.
Parents
aggregation, command, flag, netconv, nmcConsole, viewCust, viewNav
Children
None

locateName ELEMENT
Format

<!ELEMENT locateName
(#CDATA) >

138 IBM Z NetView: User's Guide: NetView Management Console


Description
Contains the name of the resource that was specified in the Locate Resource dialog box. Before a
locate name is written to the audit log, if the auditTranslateToBrowseableChars attribute in the
server.properties file is set to 1, then a subset of characters found in the name that cannot be
browsed is translated to a format that can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
Parents
viewNav
Children
None

lu62name ELEMENT
Format

<!ELEMENT lu62name
(#CDATA) >

Description
Contains the LU 6.2 address.
Parents
netconv
Children
None

menuText ELEMENT
Format

<!ELEMENT menuText
(#CDATA) >

Description
Contains the menu text of the command being started. Before a menu text is written to the audit log,
if the auditTranslateToBrowseableChars attribute in the server.properties file is set to 1,
then a subset of characters that cannot be browsed is found in the menu text and translated into
characters that can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
Parents
command
Children
None

Appendix F. Auditing and the ihsaudit.xml File 139


msg ELEMENT
Format

<!ELEMENT msg
(#CDATA) >

Description
Contains the message that was sent, using the send message function. Before a message is written
to the audit log, if the auditTranslateToBrowseableChars attribute in the server.properties
file is set to 1, then a subset of characters in the message that cannot be browsed is found and
translated into characters that can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
Parents
sendMsg
Children
None

netconv ELEMENT
Format

<!ELEMENT netconv
(action,nvDomain,((ipAddr,hostname)|(lu62name))) >

Description
Qualifies an auditEntry to represent a change in the NETCONV connection between the Z NetView
program and the NetView management console topology server (from the perspective of the NetView
management console topology server).
Parents
auditEntry
Children
One each of the following elements: action, nvDomain. Optionally, if the NETCONV connection is with
IP, then one each of the ipAddr and hostname elements, and, if the NETCONV connection is with LU
6.2., then one lu62name element.

nmcConsole ELEMENT
Format

<!ELEMENT nmcConsole
(action,id,ipAddr,hostname,admin) >

Description
Qualifies an auditEntry to represent the sign on or sign off of a NetView management console.
Parents
auditEntry
Children
One each of the following elements: action, id, ipAddr, hostname, admin.

140 IBM Z NetView: User's Guide: NetView Management Console


nmcServer ELEMENT
Format

<!ELEMENT nmcServer
(action) >

Description
Qualifies an auditEntry to represent the start or stop of the NetView management console topology
server.
Parents
auditEntry
Children
One of action.

note ELEMENT
Format
<!ELEMENT note (#CDATA) >
Description
Contains the free-form note text that was changed for the flag of a resource. If the note was
made null, this element exists with no data in it. The value in the noteMask field represents
the flag (bit) to which this note pertains. Before a note is written to the audit log, if the
auditTranslateToBrowseableChars attribute in the server.properties file is set to 1, then a
subset of characters in the note that cannot be browsed is found and translated into characters that
can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.
Parents
flag
Children
None

noteMask ELEMENT
Format

<!ELEMENT noteMask
(#CDATA) >

Description
Contains a hexadecimal 4-byte field, with one bit turned on, that represents the note that was
changed. An example is 0x40000000. This indicates that the note for the suspended flag is changed.
Parents
flag
Children
None

nvDomain Element
Format

<!ELEMENT nvDomain
(#CDATA) >

Appendix F. Auditing and the ihsaudit.xml File 141


Description
Contains a Z NetView domain ID.
Parents
netconv
Children
None

res ELEMENT
Format

<!ELEMENT res
(#CDATA) >

Description
Contains the display name of a resource at the server.
Parents
command
Children
None

rodmId ELEMENT
Format

<!ELEMENT rodmId
(#CDATA) >

Description
Contains the hexadecimal RODM object id, for example, 0000000E00000466.
Parents
aggregation, command, flag
Children
None

sendMsg ELEMENT
Format

<!ELEMENT sendMsg
(action,fromId,fromIpAddr,fromHostname,(toId,toIpAddr,toHostname)?,
msg) >

Description
Qualifies an auditEntry to represent a message that was sent, using the send message function.
Parents
auditEntry
Children
One each of the following elements: action, fromId, fromIpAddr, fromHostname, msg. Optionally,
when a specific user is targeted (not a broadcast message), one each of the following elements: toId,
toIpAddr, toHostname.

thresholdDeg ELEMENT
Format

<!ELEMENT thresholdDeg
(#CDATA) >

142 IBM Z NetView: User's Guide: NetView Management Console


Description
The degraded threshold was changed for an aggregate resource.
Parents
aggregation
Children
None

thresholdSevDeg ELEMENT
Format

<!ELEMENT thresholdSevDeg
(#CDATA) >

Description
The severely degraded threshold was changed for an aggregate resource.
Parents
aggregation
Children
None

thresholdUnsat ELEMENT
Format

<!ELEMENT thresholdUnsat (#CDATA) >

Description
The unsatisfactory threshold was changed for an aggregate resource.
Parents
aggregation
Children
None

toHostname ELEMENT
Format

<!ELEMENT toHostname
(#CDATA) >

Description
Contains a TCP host name to which a message is sent. This is in the context of the send message
function. If the message is sent to a topology console, toHostname contains the TCP host name
of the topology console that received the message. If the message is sent to the topology server,
toHostname contains the TCP host name of the Z NetView program connected with the topology
server.
Parents
sendMsg
Children
None

toId ELEMENT
Format

<!ELEMENT toId
(#CDATA) >

Appendix F. Auditing and the ihsaudit.xml File 143


Description
Contains the user name (a Z NetView logon ID) to which a message is sent. This is within the context
of the send message function.
Parents
sendMsg
Children
None

toIpAddr ELEMENT
Format

<!ELEMENT toIpAddr
(#CDATA) >

Description
Contains the IP address of the TCP host name to which a message is sent. This is in the context of
the send message function. If the message is sent to a topology console, toIpAddr contains the IP
address of the TCP host name of the topology console that received the message. If the message is
sent to the topology server, toIpAddr contains the IP address of the TCP host name of the Z NetView
program connected with the topology server.
Parents
sendMsg
Children
None

viewCust ELEMENT
Format

<!ELEMENT viewCust
(action,id,ipAddr,viewName) >

Description
Qualifies an auditEntry to represent a view that was customized and saved at the NetView
management console topology server. The view customization was saved, removed, or deleted.
Parents
auditEntry
Children
One each of the following elements: action, id, ipAddr, viewName.

viewName ELEMENT
Format

<!ELEMENT viewName
(#CDATA) >

Description
Contains a name of a view. Before a view name is written to the audit log, if the
auditTranslateToBrowseableChars attribute in the server.properties file is set to 1, then a
subset of characters in the view name that cannot be browsed is found and translated to a format that
can be browsed. The following characters are examples:
• & is changed to &amp;
• < is changed to &lt;
• > is changed to &gt;
For more information, see “Customizing Special Characters to be Browsed” on page 12.

144 IBM Z NetView: User's Guide: NetView Management Console


Parents
viewCust, viewNav
Children
None

viewNav ELEMENT
Format

<!ELEMENT viewNav
(action,id,ipAddr,viewType,((viewName)|(initRes)|(locateName,
extSearch))) >

Description
Qualifies an auditEntry to represent view navigation. Examples include: opening a network or
exception view, double-clicking a resource for more detail, configuration parents, locating a resource,
closing a view.
Parents
auditEntry
Children
One each of action, id, ipAddr, viewType. One of the following elements:
• One each of locateName and extSearch
• One of initRes
• One of viewName

viewType ELEMENT
Format

<!ELEMENT viewType
(#CDATA) >

Description
Contains the type of view.
Parents
viewCust, viewNav
Children
None

Audit Entry Actions


The actions for the elements are explained in the following sections. All of the audit entries are children
of the auditEntry element. Though action elements are strings, they are considered an extension of the
auditEntry element and are, therefore, not translated. If the attribute (as shown in the following tables) in
the server.properties file is equal to 1 (one), then the corresponding action is written to the audit log.

aggregation ELEMENT
The action element data for an aggregation audit entry is described in Table 57 on page 146.

Appendix F. Auditing and the ihsaudit.xml File 145


Table 57. Description of the aggregation action element
Action element Other elements Description Attribute
data
priority id Aggregation priority auditAggregationChange
User name is updated for this
resource.
ipAddr
IP address of console
rodmId
RODM object ID
aggPri
Aggregation priority
value

threshold id At least one of the auditAggregationChange


User name aggregation threshold
fields is updated for this
ipAddr
resource.
IP address of console
rodmId
RODM object ID
thresholdDeg
Degraded threshold
value
thresholdSevDeg
Severely degraded
threshold value
thresholdUnsat
Unsatisfactory
threshold value

command ELEMENT
The action element data for a command audit entry is described in Table 58 on page 147.

146 IBM Z NetView: User's Guide: NetView Management Console


Table 58. Description of the command action element
Action element Other elements Description Attribute
data
execution id A command is being initiated. auditCommand
User name Commands that are run in the
Z NetView program are also
ipAddr
logged at the NetView program;
IP address of console,
the auditing of commands and
if not a tserver
command responses, at the
hostcmd
NetView management console
corrId server, has no effect on the
Correlation ID to netlog of Z NetView.
correlate commands
to their responses
res
Resource name if
command is resource
dependent
rodmId
RODM object ID if
command is resource
dependent
menuText
Menu text of
command being
processed
cmd
Command string of
the command being
processed

response id The command response string. auditCommandResponse


User name, if not There might be one or
a tserver hostcmd more audit log entries for
response command responses, depending
on how the target of the
ipAddr
command provides chunks of
IP address of console,
the response. Commands that
if not a tserver
are started in Z NetView are also
hostcmd response
logged at the NetView program;
corrId the auditing of commands and
Correlation ID to command responses at the
correlate commands NetView management console
to their responses server has no effect on netlog of
cmdResp Z NetView.
Command response
string

cpe ELEMENT
The action element data for a cpe audit entry is described in Table 59 on page 148.

Appendix F. Auditing and the ihsaudit.xml File 147


Table 59. Description of the cpe action element
Action element Other elements Description Attribute
data
signon id Successful CPE signon auditCPESignonSignoff
User name

signonFailed id Unsuccessful CPE signon auditCPESignonSignoff


User name

signoff id CPE signoff auditCPESignonSignoff


User name

flag ELEMENT
The action element data for a flag audit entry is described in Table 60 on page 148.

Table 60. Description of the flag action element.


Action element Other elements Description Attribute
data
changeFlag id A flag (UserStatus field auditFlagChange
User name in RODM) was set on a
resource. Multiple flags
ipAddr
can be set on the
IP address of console
resource; all changes are
rodmId represented in this audit
RODM object ID log entry.
flagMask
0xFFFFFFFF value
with bits on to
represent the flags
being changed
flagValue
0xFFFFFFFF value
with value of the bits
specified by flagMask

changeNote id A note (UserStatusNote auditFlagChange


User name field in RODM) was set
on a resource. Multiple
ipAddr
notes can be set on the
IP address of console
resource; a separate audit
rodmId log entry is written for
RODM object ID each note.
noteMask
0xFFFFFFFF value
with bits on to
represent the note
being changed
note
Note was changed on
the bit represented
by noteMask for this
resource.

148 IBM Z NetView: User's Guide: NetView Management Console


Table 60. Description of the flag action element. (continued)
Action element Other elements Description Attribute
data
listSuspended id A list suspended auditFlagChange
User name resources request
occurred. This audit entry
ipAddr
does not indicate if the
IP address of console
request was successful.

netconv ELEMENT
The action element data for a netconv audit entry is described in Table 61 on page 149.

Table 61. Description of the netconv action element


Action element Other elements Description Attribute
data
up nvDomain NETCONV start auditNetconvUpDown
NetView domain ID
ipAddr
NetView IP address if
over IP
hostname
NetView TCP host
name if over IP
lu62name
LU name if over LU 6.2

down nvDomain NETCONV stop auditNetconvUpDown


NetView domain ID
ipAddr
NetView IP address if
over IP
hostname
NetView TCP host
name if over IP
lu62name
LU name if over LU 6.2

nmcConsole ELEMENT
The action element data for an nmcConsole audit entry is described in Table 62 on page 150.

Appendix F. Auditing and the ihsaudit.xml File 149


Table 62. Description of the nmcConsole action element
Action element Other elements Description Attribute
data
signon id Successful NetView auditConsoleSignonSignoff
User name management console
topology console signon
ipAddr
IP address of console
hostname
TCP host name of
console
admin
Either yes or no if
administrator access
was requested

signonFaile id Unsuccessful NetView auditConsoleSignonSignoff


d User name management console
topology console signon
ipAddr
IP address of console
hostname
TCP host name of
console
admin
Either yes or no if
administrator access
was requested

signoff id NetView management auditConsoleSignonSignoff


User name console topology console
signoff
ipAddr
IP address of console
hostname
TCP host name of
console
admin
Either yes or no if
administration access
was requested

nmcServer ELEMENT
The action element data for an nmcServer auditEntry is described in Table 63 on page 150.

Table 63. Description of the nmcServer action element


Action element data Description Attribute
start NetView management console topology server auditServerStartStop
is started
initialized NetView management console topology server auditServerStartStop
is initialized

150 IBM Z NetView: User's Guide: NetView Management Console


Table 63. Description of the nmcServer action element (continued)
Action element data Description Attribute
stop NetView management console topology server auditServerStartStop
is stopped

sendMsg ELEMENT
The action element data for a sendMsg audit entry is described in Table 64 on page 151.

Table 64. Description of the sendMsg action element


Action element Other elements Description Attribute
data
broadcast fromId A broadcast message was auditSendMessage
User name of the sent.
console sending the
message or topology
server if message
was initiated from the
NetView management
console topology
server
fromIpAddr
IP address of the
console or server
sending the message
fromHostname
Host name of the
console or server
sending the message
msg
Message text that was
sent

Appendix F. Auditing and the ihsaudit.xml File 151


Table 64. Description of the sendMsg action element (continued)
Action element Other elements Description Attribute
data
specificUser fromId A specific message was auditSendMessage
User name of the sent.
console sending the
message or topology
server if message
was initiated from the
NetView management
console topology
server
fromIpAddr
IP address of the
console or server
sending the message
fromHostname
Host name of the
console or server
sending the message
toId
Targeted console user.
Can also be "topology
server" if targeted
to the NetView
management console
topology server.
toIpAddr
Targeted console IP
address
toHostname
Targeted console host
name.
msg
Message text that was
sent

viewCust ELEMENT
The action element data for a viewCust audit entry is described in Table 65 on page 152.

Table 65. Description of the viewCust action element


Action Other elements Description Attribute
element data
save id The customization of auditViewCustomizationSaveRemove
User name a view was saved in
the database of the
ipAddr
NetView management
IP address of
console server.
console
viewName
View name

152 IBM Z NetView: User's Guide: NetView Management Console


Table 65. Description of the viewCust action element (continued)
Action Other elements Description Attribute
element data
remove id The customization of a auditViewCustomizationSaveRemove
User name view was removed from
the databases of the
ipAddr
NetView management
IP address of
console server.
console
viewName
View name

delete id A customized view was auditViewCustomizationSaveRemove


User name deleted.
ipAddr
IP address of
console
viewName
View name

viewNav ELEMENT
The action element data for a viewNav audit entry is described in Table 66 on page 154.

Appendix F. Auditing and the ihsaudit.xml File 153


Table 66. Description of the viewNav action element
Action element Other elements Description Attribute
data
openRequest id A view request was sent to auditViewOpenRequest
User name Z NetView.
ipAddr
IP address of console
viewType
Type of view
requested, (for
example: locateResource,
moreDetail, configParents,
configChildren,
configLogPhy, configLog,
ConfigPhy, configBackbone,
fastpath, network,
exception, configPeers)
initRes, viewName or
locateName
For network and exception
views, the audit entry
contains viewName which
is the name of the
view. For Locate Resource,
the audit entry contains
locateName, which is
the resource name as
entered by the operator, for
example, RALV4. For the
more detail, configuration
or fastpath views, the audit
entry contains initRes
which is the RODM id of the
initiating resource name.
extSearch
For locate resource
requests, indicates if
extended search was
requested. Valid values are
yes or no.

154 IBM Z NetView: User's Guide: NetView Management Console


Table 66. Description of the viewNav action element (continued)
Action element Other elements Description Attribute
data
openResponse id A RODM-based view was auditViewOpenResponse
User name opened.
ipAddr
IP address of console
viewType
Type of view
request for example:
moreDetail, configParents,
configChildren,
configPeers, configLogPhy,
configLog, configPhy,
configBackbone, network,
exception, fastpath.
viewName
View name

open id A server-based view was auditViewOpenRequest or


User name opened. auditViewOpenResponse
ipAddr
IP address of console
viewType
Type of view request, for
example server.
viewName
View name

close id A view was closed. auditViewClose


User name
ipAddr
IP address of console
viewType
Type of view, for example:
moreDetail, configParents,
configChildren,
configPeers, configLogPhy,
configLog, configPhy,
configBackbone, network,
exception, fastpath.
viewName
View name

Appendix F. Auditing and the ihsaudit.xml File 155


156 IBM Z NetView: User's Guide: NetView Management Console
Appendix G. Automatic File Download at Console Log
On

This appendix describes how files are downloaded from the server to the console when the console signs
on to the server.
The installation of the NetView management console topology console occurs in the following two
phases:
1. During the installation process
2. The first time the console logs on to the server

During Installation
During the installation process, the smallest possible set of files is installed on the local workstation. This
includes the following types of files:
• NetView management console topology console code
• MRI (readable strings) for the appropriate language
• A subset of background, help, and icon files
Note: The exception to the rule of installing the smallest possible set of files on the workstation during
installation occurs when a custom install is performed and the Productivity Kit is selected. This installs
all files necessary to run the NetView management console topology console in demonstration mode (not
requiring a NetView management console topology server).

During Initial Sign On


The first time the console signs on to the server following installation, files are automatically downloaded
from the following server directories:
• For Windows systems: %BINDIR%/TDS/server/db/current/
• For AIX or Linux systems: $BINDIR$\TDS\server\db\current
These directories and their descriptions follow:
backgrounds
View background maps/images
bin
NetView management console topology console binary support files including scripts
icons
Resource and company icons
help
Online help support files including:
• NetView management console product specific help files
• Customer Java application help files
lib
Java code including the following files:
• NetView management console topology console Java code (ihseuc.jar)
• NetView management console product personality file (nmc.properties)
• Customer Java application and plug-in JAR files

© Copyright IBM Corp. 1997, 2022 157


During Subsequent Sign On
The files downloaded during the initial sign on are automatically checked for updates each time the
console successfully signs onto the server. That is, when the console downloads a file, the console stores
the time stamp of the file on the server workstation. If the time stamp has changed, the file is downloaded
again.
If the console connects to the same server, these files are updated only when changes have been made.
However, if the console connects to different servers on different platforms, the time stamps across
servers is close, but not identical. Therefore, a value in the defaultscheme.properties file can be set
so that you can control exactly when the download occurs. This control applies when reconnecting to the
same server or to different servers. See “Customizing the Automatic Download of Files At Log On” on page
26 for more detailed information.
The lib directory is handled differently than the others. Files installed by the Console, and named in the
contents.properites file in the lib directory, are only downloaded if a different build of the Console
is placed in this directory. That is, the time stamps of these files are not cross-checked. The time stamp
cross-check does occur for files in the lib directory which were provided by the customer. However, the
defaultscheme.properties file has not yet been read in; therefore control over when these files are
downloaded cannot be customized. See the defaultscheme.properties file for more information and
for the internal value that the Console uses for the time stamp cross-check.
When a file in the lib directory needs to be downloaded, message IHS1137 is displayed and the file
must be downloaded before sign on can continue. These files might need to be reloaded into memory. For
files in all other directories, the file is downloaded and sign on processing continues automatically.
See Appendix B, “Topology Console Commands,” on page 103 for more information about command-line
arguments to suppress this downloading process.

158 IBM Z NetView: User's Guide: NetView Management Console


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 in other countries.
Consult your local IBM representative for information on the products and services currently available in
your area. Any reference to an IBM product, program, or service is not intended to state or imply that
only that IBM product, program, or service may be used. Any functionally equivalent product, program, or
service that does not infringe any IBM intellectual property right may be used instead. However, it is the
user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this
document. The furnishing of this document does not give you any 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 IBM Intellectual Property
Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing


Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE.
Some states do not allow disclaimer of express or implied warranties in certain transactions, 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 be incorporated in new editions of the publication.
IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in
any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the
exchange of information between independently created programs and other programs (including this
one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation
2Z4A/101
11400 Burnet Road

© Copyright IBM Corp. 1997, 2022 159


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 material available for it are provided by
IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any
equivalent agreement between us.
Information concerning non-IBM products was obtained from the suppliers of those products, their
published announcements or other publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM
products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of
those products.

Programming Interfaces
This publication primarily documents information that is NOT intended to be used as Programming
Interfaces of IBM Z NetView. This publication also documents intended Programming Interfaces that
allow the customer to write programs to obtain the services of IBM Z NetView. This information is
identified where it occurs, either by an introductory statement to a chapter or section or by the following
marking:

Programming Interface information


End of Programming Interface information

Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be
trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at
"Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml .
Adobe is a trademark of Adobe Systems Incorporated in the United States, and/or other countries.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or
its affiliates.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or
both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other product and service names might be trademarks of IBM or other companies.

Privacy policy considerations


IBM Software products, including software as a service solutions, (“Software Offerings”) may use cookies
or other technologies to collect product usage information, to help improve the end user experience,
to tailor interactions with the end user or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings can help enable you
to collect personally identifiable information. If this Software Offering uses cookies to collect personally
identifiable information, specific information about this offering’s use of cookies is set forth below.
This Software Offering does not use cookies or other technologies to collect personally identifiable
information.
If the configurations deployed for this Software Offering provide you as customer the ability to collect
personally identifiable information from end users via cookies and other technologies, you should seek

160 IBM Z NetView: User's Guide: NetView Management Console


your own legal advice about any laws applicable to such data collection, including any requirements for
notice and consent.
For more information about the use of various technologies, including cookies, for these purposes,
See IBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement at http://
www.ibm.com/privacy/details the section entitled “Cookies, Web Beacons and Other Technologies”
and the “IBM Software Products and Software-as-a-Service Privacy Statement” at http://www.ibm.com/
software/info/product-privacy.

Notices 161
162 IBM Z NetView: User's Guide: NetView Management Console
Index

Special Characters command profile editor


batch utility
-G option, cpebatch command 92 return codes 93
-I option, cpebatch command 92 command sets 77
-M option, cpebatch command 92 operators 78
-O option, cpebatch command 92 overview 77
-P option, cpebatch command 92 profiles 78
-U option, cpebatch command 92 response file 79
-V option, cpebatch command 92 response file defined 78
%hb_hostname% substitution variable 88 sample response file 78
%hb_primary% substitution variable 88 starting 79
%hb_secondary% substitution variable 88 command profiles 85
%hb_source% substitution variable 88 command set keywords 83
%hb_sub_origin% substitution variable 88 command sets 77
%hb_sub_source% substitution variable 88 commands
%ipaddress% substitution variable 88 config 91
%label% substitution variable 88 cpebatch 79, 92
%monitor% substitution variable 88 dbtransfer 93
getpd 93
hostcmd 94
A hostcmdoper 95
accessibility xiv ihszfmt 96
adding NetView management console help 18 ihszset 96
adding topology console icons 15 ihszsett 97
advanced customization, topology console 18 locRes 125
aggregate resources 4 nmcRunning 126
Automatic console file updates 157 service 97
start 98
stop 99
B tapp 105
tconsole 104
batch utility
tcpipkey 99
return codes 93
tlocRes 127
books
topology console 103
see publications xi
topology server 91
business tree 55
tserver 100
utility 101
C commands notebook 87
Commands notebook 86
command block config command 91
command set keywords 83 configuration backbone view 69
operator keywords 84 configuration child view 66
page keywords 81 configuration logical and physical view 68
profile keywords 84 configuration logical view 67
command block, response file 80 configuration parent view 66
command exits configuration peer view 67
command profiles 85 configuration physical view 68
description 85 configuration views 66
IHSXTJAM 87 configuration views, backbone 69
IHSXTJAV 87 configuration views, child 66
overview 85 configuration views, logical 67
substitution variables 87 configuration views, logical and physical 68
topology server 85 configuration views, parent 66
using IHSDGENE 86 configuration views, peer 67
using IHSDNATV 86 configuration views, physical 68
using IHSXTHCE 87 Console updates, automatic from server at logon 157
command indicators 77 conventions

Index 163
conventions (continued) exits, command (continued)
typeface xv topology server 85
cpebatch 79
cpebatch command
-G option 92
F
-I option 92 filter bar 57
-M option 92
-O option 92
-P option 92 G
-U option 92
getpd command 93
-V option 92
response file 79
return codes 93 H
creating a demonstration
NetView management console 107 help
customization adding 18
NetView management console 15 customizing 18
customized views 70 starting 51
customizing hostcmd command 94
NetView management console 9 hostcmdoper command 95
online help 18
topology console advanced customization 18 I
topology console backgrounds 15
topology console icons 15 IHSDGENE 86
topology server flat file 9 IHSDNATV 86
customizing the ihsshstc.cfg file 7 IhsLocRes servlet 124
IhsRunning servlet 125
IHSXTHCE 87
D
IHSXTJAM 87
daemon 52 IHSXTJAV 87
databases, topology server ihszfmt command 96
corrupted 61 ihszset command 96
creating 62 ihszsett command 97
importing 62 IP Commands
writing server information 60 issuing from NetView management console 58
dbtransfer command 93
defining J
web browser
properties file 44 Java application
web pages 43 web launch 43
details view, description 57 Java applications 33
directory names, notation xv Java plug-ins 33
displaying web browser views 16, 71
DUILOGON command 54
DUILOGON statement, PERMIT keyword 54 K
keywords
E command set 83
operator 84
environment variables, notation xv page, command block 81
examples profile 84
changing the number of rows in a view bar 25
enabling or disabling web browser function 24
flag enablement 20 L
line thickness, changing 30 launching NetView management console from other
Markedflag item in defaultscheme.properties file 22 applications 123
Markedflag item in defaultschemetext.properties file 23 locate failing resources 70
overriding date and display formats 28 locRes command 125
time and date formatting 29 logs
time stamp format specifications 27 topology console 56
time stamp tolerance settings 26
exception views 65
exits, command M
overview 85
manager block, response file 80

164 IBM Z NetView: User's Guide: NetView Management Console


manuals R
see publications xi
more detail views 69 real resources 4
registering, EgveInitialize32 88
resource managers 77
N resources
NetView aggregate 4
sending commands 129 locate failing 70
NetView management console real 4
creating a demonstration 107 response file
customizing 9, 15 command block 80
defining the password and ID on the Topology Server 7 description 79
functional overview 3 manager block 80
introduction 3 sample 78
launching from other applications 123 response file input 43
operating 3, 51 return codes, command profile editor batch utility 93
topology server RODM-based views 65
communication, starting 52
views 65 S
NetView Management Console Productivity Kit 33
NetView Resource Manager sending commands
monitoring NetView tasks 58 multiple NetView domains 129
NetView tasks server.properties file 9
views 58 service command 97
network operation servlets
Open Topology Interface 73 IhsLocRes 124
network views 65 IhsRunning 125
nmcRunning command 126 sign-on window, topology console 53
notation span control 71
environment variables xv start command 98
path names xv starting, topology console
typeface xv desktop 53
line command 53
starting, topology server
O daemon 52
objects desktop 51
command profile 77 manually 51
online help 57 NT service 52
online publications status area 56
accessing xiv stop command 99
Open Topology Interface substitution variables
operation 73 %hb_hostname% 88
operating, NetView management console 51 %hb_origin% 88
operator keywords 84 %hb_primary% 88
operator objects %hb_secondary% 88
defined 78 %hb_source% 88
%hb_sub_origin% 88
%hb_sub_source% 88
P %ipaddress% 88
%label% 88
page keywords 81
%monitor% 88
path names, notation xv
command exits 87
profile keywords 84
profiles, command profile editor 78
programming languages available, command indicators 77 T
programming languages, resources managers 77
progress indicator tapp command 105
topology console window 55 tconsole command 104
publications tcpipkey command 99
accessing online xiv Tivoli Software Information Center xiv
IBM Z NetView xi tlocRes command 127
ordering xiv topology console
advanced customization 18
commands 103

Index 165
topology console (continued) user groups (continued)
customizing backgrounds 15 NetView xv
customizing help 18 utility command 101
customizing icons 15
description 4
Java applications 33
V
Java plug–ins 33 variables, notation for xv
sign-on window 53 view area 57
starting view customization 70
desktop icon 53 views
line command 53 configuration 66
stopping 63 configuration backbone 69
window configuration child 66
business tree 55 configuration logical 67
filter bar 57 configuration logical and physical 68
log 56 configuration parent 66
online help 57 configuration peer 67
progress indicator 55 configuration physical 68
status area 56 customized 70
view area 57 exception 65
work space 55 more detail 69
topology console window NetView management console 65
business tree 55 NetView tasks 58
filter bar 57 network 65
log 56 restricted 71
online help 57 RODM 65
progress indicator 55
status area 56
view area 57 W
work space 55
web browser
topology server
properties file 44
command exits 85
web browser views
commands 91
displaying 16, 71
customizing 9
web launch Java application 43
customizing the ihsshstc.cfg file 7
web pages
databases
defining 43
corrupted 61
window, topology console
creating 62
business tree 55
importing 62
filter bar 57
writing information 60
log 56
defining the password and ID 7
online help 57
description 4
progress indicator 55
message help 51
status area 56
starting
view area 57
daemon 52
work space 55
desktop icon 51
work space area 55
NT service 52
writing server information
starting manually 51
databases 60
stopping
service version, NT 63
writing command exits
command profiles 85
topology server command exits
command profiles 85
overview 85
topology view, description 57
tserver command 100
typeface conventions xv

U
understanding views 65
user group, NetView xv
user groups

166 IBM Z NetView: User's Guide: NetView Management Console


IBM®

SC27-2868-04

You might also like