CA eHealth Command and Environment Variables - CA...

CA eHealth®

Command and Environment Variables Reference Guide

r6.1

This documentation and any related computer software help programs (hereinafter referred to as the “Documentation”) is for the end user’s informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties.

Notwithstanding the foregoing, licensed users may print a reasonable number of copies of the Documentation for their own internal use, and may make one copy of the related software as reasonably required for back-up and disaster recovery purposes, provided that all CA copyright notices and legends are affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who are bound by the provisions of the license for the Product are permitted to have access to such copies.

The right to print copies of the Documentation and to make a copy of the related software is limited to the period during which the applicable license for the Product remains in full force and effect. Should the license terminate for any reason, it shall be the user’s responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

EXCEPT AS OTHERWISE STATED IN THE APPLICABLE LICENSE AGREEMENT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.

The use of any product referenced in the Documentation is governed by the end user’s applicable license agreement.

The manufacturer of this Documentation is CA.

Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

Copyright © 2008 CA. All rights reserved.

CA Product References This document references the following CA products:

■ CA eHealth ® (eHealth)

■ CA eHealth® AdvantEDGE View (AdvantEDGE View)

■ CA eHealth® Application Response (Application Response)

■ CA Distributed eHealth®

■ CA eHealth® Integration for Alcatel

■ CA eHealth® Integration for Cisco Netflow

■ CA eHealth® Integration for Cisco VPN Solutions Center

■ CA eHealth® Integration for Cisco WAN Manager

■ CA eHealth® Integration for Nortel Preside

■ CA eHealth® Live Health™ (Live Health)

■ CA eHealth® Service Availability (Service Availability)

■ CA SPECTRUM®

■ CA eHealth® SystemEDGE (SystemEDGE)

■ CA eHealth® Traffic Accountant (Traffic Accountant)

■ CA eHealth® TrapEXPLODER (TrapEXPLODER)

Contact CA Contact Technical Support

For online technical assistance and a complete list of locations, primary service hours, and telephone numbers, contact Technical Support at http://ca.com/support.

Provide Feedback

If you have comments or questions about CA product documentation, you can send a message to [email protected].

If you would like to provide feedback about CA product documentation, please complete our short customer survey, which is also available on the CA Support website.

http://www.ca.com/support

mailto:[email protected]

http://www.casurveys.com/wsb.dll/166/TIPO_2008_Survey.htm



Contents

Chapter 1: Command Line Interface 13 About the Command Line Interface ............................................................ 13 Command Syntax ............................................................................ 14 Alphabetical List .............................................................................. 16

ehealth................................................................................... 16 nhAddAppType ........................................................................... 17 nhAddArConfig ........................................................................... 19 nhAddVcsResources....................................................................... 21 nhAlcatelNmInstall........................................................................ 22 nhAnmGetCfg ............................................................................ 22 nhAnmQcnVerify.......................................................................... 22 nhAutoLicenseSysEdge .................................................................... 22 nhChangeDbModelSize .................................................................... 22 nhCleanupNodes.......................................................................... 23 nhCollectDbData.......................................................................... 24 nhCompileMib ............................................................................ 25 nhCompileTrf ............................................................................. 25 nhConfig ................................................................................. 26 nhConfigDbNet ........................................................................... 26 nhConfigureTrapEx........................................................................ 27 nhConvertDb ............................................................................. 27 nhCreateDb .............................................................................. 28 nhCreateServiceNote...................................................................... 30 nhCustomVariable ........................................................................ 31 nhCwmGetCfg ............................................................................ 31 nhDbApi.................................................................................. 32 nhDbMaint ............................................................................... 32 nhDbStatus .............................................................................. 33 nhDeleteAnalyzedData .................................................................... 35 nhDeleteArConfig ......................................................................... 37 nhDeleteElements ........................................................................ 38 nhDeleteServiceNote...................................................................... 38 nhDestroyDb ............................................................................. 39 nhDiscover ............................................................................... 40 nhDiscoverPolicy.......................................................................... 44 nhDrConfigScenario....................................................................... 46 nhDrSetup ............................................................................... 46 nhElementStatus ......................................................................... 47

Contents 5

nhEncodeRdl ............................................................................. 49 nhExpire ................................................................................. 49 nhExportCalendarCfg...................................................................... 50 nhExportConfig ........................................................................... 50 nhExportData............................................................................. 51 nhExportDowntime........................................................................ 54 nhExportImPollerStatus ................................................................... 56 nhExportLiveExCfg........................................................................ 56 nhExportSnmpKeyInfo .................................................................... 56 nhExportWebAcct ......................................................................... 56 nhFindClusterDiffs ........................................................................ 57 nhFindDupObjects ........................................................................ 61 nhFindElement............................................................................ 64 nhGenDataSourceInfo..................................................................... 67 nhGetClusterPasswd ...................................................................... 67 nhGetFile................................................................................. 68 nhGetIscRouterCfg........................................................................ 69 nhGetIscSlaConfig ........................................................................ 69 nhGetRespLimit........................................................................... 69 nhGetSupportInfo......................................................................... 69 nhGetVpnscRouterConfig .................................................................. 71 nhGetVpnscSlaConfig ..................................................................... 71 nhGroup ................................................................................. 71 nhGroupList .............................................................................. 80 nhHaSetup ............................................................................... 90 nhHttpd .................................................................................. 90 nhHttpdCfg............................................................................... 91 nhImportCalendarCfg ..................................................................... 92 nhImportData ............................................................................ 92 nhImportDowntime ....................................................................... 93 nhImportImPollerStatus................................................................... 94 nhImportLiveExCfg ....................................................................... 94 nhImportSnmpKeyInfo .................................................................... 94 nhImportWebAcct......................................................................... 94 nhJoinCluster ............................................................................. 95 nhListAppTypes........................................................................... 97 nhListArConfig ............................................................................ 98 nhListClusterMembers.................................................................... 100 nhListElementLicenses ................................................................... 104 nhListElements .......................................................................... 106 nhListSaPaths ........................................................................... 110 nhListServiceNote........................................................................ 110

6 Command and Environment Variables Reference Guide

nhLiveExceptions ........................................................................ 111 nhLiveStatus ............................................................................ 112 nhLiveTrend ............................................................................. 113 nhLmgr ................................................................................. 113 nhLoadDb ............................................................................... 115 nhLucentGetCfg ......................................................................... 118 nhLucentMigrateElements ................................................................ 118 nhLucentSetup .......................................................................... 118 nhMail .................................................................................. 118 nhManageArAgent ....................................................................... 119 nhManageDbSpace....................................................................... 122 nhManageUsers.......................................................................... 125 nhModifyAppType ........................................................................ 127 nhModifyArConfig ........................................................................ 130 nhModifyClusterMember.................................................................. 132 nhModifyElements ....................................................................... 135 nhMonitoredSubjectsRpt ................................................................. 137 nhMonitorSubjects ....................................................................... 138 nhNameNodes ........................................................................... 139 nhNetflowSetup.......................................................................... 142 nhParameter ............................................................................ 142 nhPresideGetCfg ......................................................................... 142 nhPresideInstall ......................................................................... 143 nhPutFile ................................................................................ 143 nhReloadTrapRules ...................................................................... 144 nhRemotePollerSetup .................................................................... 144 nhRemoveClusterMember ................................................................ 145 nhReplicate.............................................................................. 146 nhReset ................................................................................. 148 nhRestoreClusterMember................................................................. 149 nhRmon2Diag ........................................................................... 152 nhRunCommand ......................................................................... 154 nhSaveDb ............................................................................... 156 nhSaveDbConfig ......................................................................... 158 nhSchedule.............................................................................. 164 nhScrubFsa.............................................................................. 177 nhSendSnmpTrap........................................................................ 178 nhServer ................................................................................ 180 nhSetClusterMode ....................................................................... 181 nhSetClusterPasswd ..................................................................... 182 nhSetRespLimit.......................................................................... 183 nhShowElementInfo...................................................................... 184

Contents 7

nhShowImRev ........................................................................... 184 nhShowRev ............................................................................. 186 nhSnmpTool............................................................................. 187 nhSpectrumSetup........................................................................ 188 nhStartDb ............................................................................... 189 nhStopDb ............................................................................... 190 nhSvDiagnose ........................................................................... 191 nhSvGetCfg ............................................................................. 191 nhSvInstall .............................................................................. 192 nhSynchronize........................................................................... 192 nhTaDataPurge .......................................................................... 194 nhTestTrapRule.......................................................................... 195 nhTranslateTrapLog...................................................................... 196 nhUpdateClusterTable.................................................................... 198 nhUpdateDatabaseIds.................................................................... 199 nhUpdateDbProtocol ..................................................................... 199 nhUpdateLicenses........................................................................ 201 nhUpdateServiceNote .................................................................... 202 nhUpgradeCluster........................................................................ 203 nhUpgradeOracleDb...................................................................... 204 nhVpnscSetup ........................................................................... 204 nhWebProtocol .......................................................................... 205 nhWebSso............................................................................... 206 nhWebUtil ............................................................................... 207

Administration Commands ................................................................... 209 ehealth.................................................................................. 210 nhDrConfigScenario...................................................................... 211 nhDrSetup .............................................................................. 211 nhExpire ................................................................................ 212 nhExportDowntime....................................................................... 213 nhGetSupportInfo........................................................................ 213 nhHaSetup .............................................................................. 215 nhImportDowntime ...................................................................... 215 nhUpdateLicenses........................................................................ 216 Overview Business Service Console (BSC) Administration Commands ....................... 216 Overview Administration Processes........................................................ 221 Overview Administration eHealth Info ..................................................... 225 Overview Administration Web Admin ...................................................... 230

Application Response Commands ............................................................. 236 nhAddAppType .......................................................................... 236 nhAddArConfig .......................................................................... 239 nhDeleteArConfig ........................................................................ 241


nhGetRespLimit.......................................................................... 242 nhListAppTypes.......................................................................... 242 nhListArConfig ........................................................................... 244 nhManageArAgent ....................................................................... 245 nhModifyAppType ........................................................................ 248 nhModifyArConfig ........................................................................ 250 nhSetRespLimit.......................................................................... 252

Database Commands ........................................................................ 252 nhChangeDbModelSize ................................................................... 253 nhConfigDbNet .......................................................................... 254 nhConvertDb ............................................................................ 255 nhCreateDb ............................................................................. 256 nhDbApi................................................................................. 257 nhDbMaint .............................................................................. 258 nhDbStatus ............................................................................. 258 nhDestroyDb ............................................................................ 261 nhGenDataSourceInfo.................................................................... 262 nhLoadDb ............................................................................... 263 nhManageDbSpace....................................................................... 266 nhManageUsers.......................................................................... 269 nhReset ................................................................................. 271 nhSaveDb ............................................................................... 272 nhSaveDbConfig ......................................................................... 275 nhStartDb ............................................................................... 279 nhStopDb ............................................................................... 280 nhUpdateDbProtocol ..................................................................... 281

Distributed eHealth Commands ............................................................... 282 Distributed Command Arguments and Special Variables .................................... 283 Understanding the Dots in Distributed Commands.......................................... 284 nhAddSysEdgeMonEntries ................................................................ 285 nhDeleteAnalyzedData ................................................................... 288 nhFindClusterDiffs ....................................................................... 290 nhFindDupObjects ....................................................................... 295 nhFindElement........................................................................... 298 nhGetFile................................................................................ 300 nhJoinCluster ............................................................................ 302 nhListClusterMembers.................................................................... 304 nhModifyClusterMember.................................................................. 308 nhPutFile ................................................................................ 311 nhRemoveClusterMember ................................................................ 312 nhReplicate.............................................................................. 314 nhRestoreClusterMember................................................................. 316

Contents 9

nhRunCommand ......................................................................... 319 nhScrubFsa.............................................................................. 321 nhSetClusterMode ....................................................................... 323 nhSetClusterPasswd ..................................................................... 324 nhSynchronize........................................................................... 325 nhUpdateClusterTable.................................................................... 328 nhUpdateDatabaseIds.................................................................... 329

Discover, Poller Elements and Groups Commands.............................................. 329 nhDeleteElements ....................................................................... 329 nhElementStatus ........................................................................ 330 nhGroup ................................................................................ 333 nhGroupList ............................................................................. 334 nhListElements .......................................................................... 337 nhListElementLicenses ................................................................... 340 nhModifyElements ....................................................................... 343

Installation Commands....................................................................... 345 nhUpgradeCluster........................................................................ 345 nhUpgradeOracleDb...................................................................... 345

Integration Modules Commands .............................................................. 346 nhAlcatelNmInstall....................................................................... 347 nhAnmGetCfg ........................................................................... 347 nhAnmQcnVerify......................................................................... 347 nhCwmGetCfg ........................................................................... 347 nhGetIscRouterCfg....................................................................... 348 nhGetIscSlaConfig ....................................................................... 348 nhGetVpnscRouterConfig ................................................................. 348 nhGetVpnscSlaConfig .................................................................... 348 nhLucentGetCfg ......................................................................... 348 nhLucentMigrateElements ................................................................ 348 nhLucentSetup .......................................................................... 348 nhNetflowSetup.......................................................................... 349 nhPresideGetCfg ......................................................................... 349 nhPresideInstall ......................................................................... 349 nhRemotePollerSetup .................................................................... 349 nhShowImRev ........................................................................... 349 nhSpectrumSetup........................................................................ 351 nhSvInstall .............................................................................. 352 nhSvGetCfg ............................................................................. 352 nhSvDiagnose ........................................................................... 352 nhVpnscSetup ........................................................................... 352

Live Health Commands....................................................................... 353 nhAutoLicenseSysEdge ................................................................... 353


nhCompileTrf ............................................................................ 353 nhConfigureTrapEx....................................................................... 354 nhLiveExceptions ........................................................................ 354 nhLiveStatus ............................................................................ 355 nhLiveTrend ............................................................................. 356 nhMonitorSubjects ....................................................................... 356 nhMonitoredSubjectsRpt ................................................................. 358 nhReloadTrapRules ...................................................................... 359 nhSendSnmpTrap........................................................................ 359 nhTestTrapRule.......................................................................... 362 nhTranslateTrapLog...................................................................... 363

Toolkit Commands........................................................................... 365 nhCompileMib ........................................................................... 366 nhConfig ................................................................................ 366 nhCustomVariable ....................................................................... 366 nhEncodeRdl ............................................................................ 366 nhExportCalendarCfg..................................................................... 366 nhExportConfig .......................................................................... 366 nhExportData............................................................................ 367 nhExportImPollerStatus .................................................................. 370 nhExportLiveExCfg....................................................................... 370 nhExportSnmpKeyInfo ................................................................... 370 nhExportWebAcct ........................................................................ 371 nhImportCalendarCfg .................................................................... 371 nhImportData ........................................................................... 371 nhImportImPollerStatus.................................................................. 371 nhImportLiveExCfg ...................................................................... 371 nhImportSnmpKeyInfo ................................................................... 372 nhImportWebAcct........................................................................ 372 nhSnmpTool............................................................................. 372

Traffic Accountant Commands ................................................................ 372 nhCleanupNodes......................................................................... 372 nhNameNodes ........................................................................... 373 nhTaDataPurge .......................................................................... 376

Internal Support Commands ................................................................. 376 nhCollectDbData......................................................................... 376 nhGetClusterPasswd ..................................................................... 377 nhRmon2Diag ........................................................................... 378 nhShowElementInfo...................................................................... 379

Chapter 2: Discover Policy Parameter Usage 381 Discover Policy Parameters................................................................... 381

Contents 11


Chapter 3: Environment Variables 411 About Environment Variables ................................................................. 411

Set Environment Variables on Windows Systems........................................... 411 Set Environment Variables on UNIX Systems .............................................. 413 Database Variables ...................................................................... 416 Debugging Variables ..................................................................... 420 Development Variables................................................................... 425 Distributed eHealth Variables ............................................................. 425 General Variables ........................................................................ 432 Help Variables ........................................................................... 439 Integration Variables..................................................................... 441 Licensing Variables....................................................................... 443 Live Exceptions Variables................................................................. 444 Poller Variables .......................................................................... 448 Poller Latency Variables .................................................................. 456 Report Variables ......................................................................... 457 Service Availability Variables ............................................................. 460 SNMP Variables .......................................................................... 461 Statistics Poller Variables................................................................. 461 System Variables ........................................................................ 465 Traffic Accountant Variables .............................................................. 468 UNIX-Specific Variables .................................................................. 470 Windows-Specific Variables............................................................... 471

Index 475

Chapter 1: Command Line Interface

This section contains the following topics:

About the Command Line Interface (see page 13) Command Syntax (see page 14) Alphabetical List (see page 16) Administration Commands (see page 209) Application Response Commands (see page 236) Database Commands (see page 252) Distributed eHealth Commands (see page 282) Discover, Poller Elements and Groups Commands (see page 329) Installation Commands (see page 345) Integration Modules Commands (see page 346) Live Health Commands (see page 353) Toolkit Commands (see page 365) Traffic Accountant Commands (see page 372) Internal Support Commands (see page 376)

About the Command Line Interface The eHealth suite provides a rich set of commands for creating scripts that you can use to automate processes. This command reference describes each of those commands in detail, and refers you to other documentation that describes how to use the commands to accomplish a variety of tasks.

On both Windows and Solaris systems, the eHealth commands are stored in the ehealth/bin directory, where ehealth represents the eHealth installation directory. On Windows this is the eHealth/bin directory, and on UNIX systems it is /opt/eHealth/bin. Most commands are available on both the Windows and UNIX versions of eHealth.

The bin subdirectory stores many commands, including commands for use by eHealth customers and commands for use by the software or under the direction of Technical Support. In general, this guide documents the commands designed for use by eHealth customers. The remaining commands are not documented here because they are used by the software or are diagnostic tools to be used only under the direction of Technical Support.

Chapter 1: Command Line Interface 13

Command Syntax

Command Syntax This section describes the conventions used in the syntax of eHealth commands.

Syntax Definition

value A substitution value. You must replace the value with a correct or valid value. Substitution values appear in this italicized font.

Sample syntax:

nhListElements - elemType type

Valid command:

nhListElements -elemType cpu

Note: In the online command usage, these values appear within angle brackets, like this: <value>. When executing a command, omit the angle brackets.

-argument value

or

-argument

or

argument

A required argument. You must specify the argument (and a valid value, if needed) with the command.

A required argument is not enclosed by any special braces. Some arguments must be preceded with a dash (-).

Sample syntax:

nhDestroyDb -s oracleSid

Valid command:

nhDestroyDb -s EHEALTH

[-argument value]

or

[-argument]

or

[argument]

An optional argument. You can choose to specify this argument (and a valid value, if needed) when you run the command; the command will not fail if you omit it.

Optional arguments are enclosed by square braces [ ]. When executing the command, omit the square braces.

Sample syntax:

nhStartDb [-h] [-s oracleSid]

Valid commands:

nhStartDb - h

nhStartDb -s EHEALTH


Command Syntax


Syntax Definition

{ -argument1 value1 | -argument2 value2 }

or

{ -argument1 | -argument2 }

or

{ argument1 | argument2 }

Mutually exclusive required arguments. You must specify one of the arguments (and its value, if needed) shown within the curly braces, but you cannot specify more than one.

These arguments are shown within curly braces { } and are separated with a vertical bar | . When executing the command, omit the curly braces and the vertical bar.

Sample syntax:

nhSchedule - schedule "typeName"

[-jobId "jobID"] -time "time"

{-daily days | - monthly nn | -

period i } [- args "args"]

Valid command:

nhSchedule -schedule "Name Nodes" -

time "2:30 AM" - monthly 1 -args "-

dns"

[ -argument1 value1 | -argument2 value2 ]

or

[-argument1 | -argument2 ]

or

[argument1 | argument2 ]

Mutually exclusive optional arguments. You can specify one of the arguments (and its value, if needed) within the square braces, but you cannot specify more than one.

These arguments are shown within square braces [ ] and are separated with a vertical bar | . When executing the command, omit the square braces and the vertical bar.

Sample syntax:

nhHttpd [-h] [start | stop]

Valid commands:

nhHttpd -h

nhHttpd stop

nhHttpd start

Alphabetical List


Syntax Definition

-argument value [...]

or

-argument [...]

or

-argument value[,...]

Multiple values are permitted. The ... characters indicate that you can specify more than one of the arguments or argument values in the command. The arguments may be required or optional, as indicated by the surrounding braces. (Square braces [ ] indicate optional arguments or values; curly braces { } indicate required arguments or values.) The string may require punctuation such as comma- separators, as indicated by [,...].

Sample syntax:

nhGroup -create -groups "groupName

[...]"

Valid command:

nhGroup -create -groups

"grp1,grp2,grp3"

command \ moreCommand

In command examples, the backslash (\) is a continuation character, indicating that the command continues on the next line. If you type the command on a single line, omit any continuation characters shown in the example.

Alphabetical List The following is an alphabetical listing of the command syntax.

ehealth

Starts the OneClick for eHealth console, the eHealth console, and, if necessary, the eHealth server. You can also use this command to run a secondary eHealth console from remote workstations on your network. Use this command to start eHealth on UNIX systems. (On Windows systems, you can start eHealth from the Start menu.)

Note: In prior releases, the nethealth command started eHealth.

This command has the following format:

ehealth [-h] [-2nd] [-display displayName] [-oce] [-motif]

Argument Description

-h Displays help for this command.

Alphabetical List



-2nd Starts eHealth in a secondary console. For more information about secondary consoles, see the Using Secondary eHealth Consoles focus topic.

-display displayName Specifies the X Windows display to open the administrative consoles and view them on a remote system.

-oce Opens the OneClick for eHealth console, if it is installed. If you do not specify -oce or -motif, the command opens both consoles. If the eHealth servers are not already running, start them using the nhServer start command.

-motif Opens the OneClick Motif console and starts the eHealth servers if they are not already running. If you do not specify -oce or - motif, the command opens both consoles. If you specify only -motif, the command opens the Motif console only.

nhAddAppType

Adds a new application type to your eHealth application hierarchy (your object model).


nhAddAppType [-h] [-rev] -symbol symbolName -label labelName

-level levelName [- basedOn basedOn] [-appSvcType type]

[-respMeasureType type] [-normalSortOrder order] [-verify]



- rev (Optional) Displays the eHealth software revision.

-label labelName (Required) Specifies the label for the new application type.

-level level (Required) Specifies the level for the new application type.

For level, specify one of the following:

application,moduleset,module

Alphabetical List



-basedOn basedOn (Optional) Specifies a previously-defined element type on which to base this new application type. If you do not specify this argument, the command uses "" and does not specify a basedOn value.

-appSvcType type (Optional) Specifies the application service associated with the new application type (for example: exchangeAppSvc). If you do not specify this argument, the command uses "" and does not specify an application service for the application type.

For type, specify one or more of the following:

appService,genericAppSvc,apacheAppSvc,dnsAppSvc,eHealthAppSvc, exchangeAppSvc,iisAppSvc,lotusNotesAppSvc,msSqlServerAppSvc, oracleAppSvc,sendMailAppSvc,userApp1AppSvc,webAppSvc, fw1MgmtStationAppSvc,fw1EnforcementPtAppSvc, netSvcsSendmailUnixAppSvc,netSvcsNisUnixAppSvc,netSvcsLpUnixAppSvc,netSvcsDnsUnixAppSvc,netSvcsNfsUnixAppSvc, netSvcsLdapUnixAppSvc,netSvcsActiveDirNtAppSvc, netSvcsDhcpNtAppSvc,netSvcsDnsNtAppSvc,netSvcsWinsNtAppSvc, httpProxy,genericCallMng,ccmConfMgrAppSvc,genericCCMAppSvc, ccmMsgIntAppSvc,ccmCtiMgrAppSvc,ccmWebAttAppSvc,unifiedMsgAppSvc, exchangePubMailboxStoreAppSvc,ciscoGatekeeper,ciscoGatekeeperZone, exchangeAppSvcVirus,exchangeAppSvcSMTP,exchangeAppSvcPublicStore, exchangeAppSvcPrivateStore,exchangeAppSvcOWA,exchangeAppSvcSRS, exchangeAppSvcDSCache,exchangeAppSvcMessageStore,avayaCommMgrAppSvc, avayaAttGroupAppSvc,avayaAttPosAppSvc,avayaClanBoardAppSvc,avayaHun

Alphabetical List



-respMeasureType measure

(Optional) Specifies the method by which eHealth should measure response for this new application type. If you do not specify this argument, the command uses "any" by default.

For measure, specify one of the following values:

observedClientUse,activeTest,any

-normalSortOrder value

(Optional) Specifies where this application type should appear in sorted lists. If you do not specify this argument, the command uses 0.0000000.

-verify (Optional) Only validates the input, but does not add the application type to your object model.

Example:

The following example creates an application type named reader at level moduleSet:

nhAddAppType -symbol reader -label mail -level moduleSet

Created AppType:

id = 607056

symbol = "reader"

label = "mail"

basedOn = ""

appSvcType = ""

respMeasureType = "any"

normalSortOrder = 0.000000

level = "moduleSet"

systemAppType = "no"

nhAddArConfig

Adds a new element to the AR Configuration.


nhAddArConfig [-h] [-rev]

-type {agent | agentSet | server | application}

-name elementName

[-agentSet agentSet] [-hostnames hostNames]

[- applicationType applicationType] [- serverType serverType]

[-portRedirection {yes|no}] [-urls urls]

[-parameterSubstitutions params]

[-description description] [-operatingSystem operatingSystem]

[-confirm {yes|no}] [-verify]

Alphabetical List



-rev Displays the eHealth software revision.


(Required) Specifies which type of element to add. The default value is agent.

- name elementName (Required) Specifies the name of the element to add.

- agentSet agentSet (Optional) Specifies the agentSet in which to place the new agent. Valid for type “agent” only. The default value is "All-Clients."

- hostnames hostname;hostname;... | hostname:ports;hostname:ports;...

(Required when specifying "-type agent” or “-type server.")

For agent, specifies a list of hostnames. Use semi- colons to separate hostnames.

For server, specifies a list of hostname:ports. Use semi-colons to separate hostnames, and commas to separate multiple ports per hostname. A port number is required; specify port 0 (zero) to match any port.

Valid for - type “server” and “agent” only.

- applicationType applicationType

(Required when specifying "-type application") Specifies the type of application to add. Valid for - type application only.

- serverType serverType (Required when specifying "-type server") Specifies the type of server to add. Valid for -type server only.

- portRedirection {yes|no} (Optional) Indicates whether or not to enable port redirection for the server being added. Valid for - type server only. The default value is "no".

-urls urls (Optional) Specifies comma separated list of urls to monitor; default value is ""; only valid for type -server.


Alphabetical List



- parameterSubstitutions params

(Optional) Specifies semi-colon separated list of parameter substitution sets; each set is a "name=value" pair, where name is of the form $Name for string values and %Name for numeric values; the value is a comma separated list of string or numeric value as the case may be; only valid for -type application; default value is "".

- description description (Optional) A description of the element being added. The default value is "".

- operatingSystem operatingSystem

(Optional) Specifies the name of the Operating System. Valid for - type agent only. The default value is "".

-confirm {yes|no} (Optional) Prompts before adding the element. The default is yes.

- verify (Optional) Verifies that the input parameters are valid without performing the actual operation.

Examples:

■ The following example creates an Agent Set named “a1”:

nhAddArConfig -type agentSet -name a1

-description "My AgentSet"

■ The following example creates an application named “app1” of type “Web”monitoring two urls, foo.com and bar.com:

nhAddArConfig -type application -name app1

-description "My Web Application"

-applicationType Web

-parameterSubstitutions "foo.com,bar.com"

■ The following example creates an application named “app2” of type “Windows” to monitor ParamSubstitutions app21.exe and app22.exe:


-description "My Windows Application"

-applicationType Windows

-parameterSubstitutions

"$ExecutableName=app21,app22"

Alphabetical List

■ The following example creates a server named “s1” of type “Exchange” with two hostnames: e1 and e2, and ports 1,2, and 3 on e1, and ports 3 and 4 on e2:

nhAddArConfig -type server -name s1

-description "My Exchange Server"

-serverType Exchange -portRedirection no

-hostnames "e1:1,2,3;e2:4,5"

nhAddVcsResources

Adds resources to an existing service group to allow the Veritas Cluster Server to manage eHealth in a high availability failover cluster.


nhAddVcsResources [-h] [-replace]



-replace (Optional) Replaces existing eHealth resources and resource types with those supplied by a new CAehealthVcsHA Solaris package in a high availability VCS configuration.

nhAlcatelNmInstall

Installs and sets up eHealth Integration for Alcatel, which helps you collect data from your Alcatel 5620 Network Manager system (NMS) and generate eHealth reports.

nhAnmGetCfg

Extracts configuration information for Alcatel elements from the Alcatel 5620 NMS.


Alphabetical List

nhAnmQcnVerify

Tests the availability of a QCnetwork server process running on a remote Alcatel 5620 NMS.

nhAutoLicenseSysEdge

Automatically licenses unlicensed SystemEDGE agents. Before you can use this command, you must perform some preliminary setup tasks.

nhChangeDbModelSize

Changes the growth model of the eHealth database. This command is useful for statistics data only. It does not resize existing tables. Only tables or rows inserted after you run nhChangeDbModelSize conform to the new model size.

Note: An Oracle database allocates extents only when there is no room left in the previously allocated extents. If you change the model size but the existing extents are not completely used, the size of the database does not change. A new extent using the new size you specified is added only after all blocks in existing extents are full.


nhChangeDbModelSize [-tiny | -small | -medium | -large | -xlarge]


- tiny Internal

Specifies a database for very small installations, such as on test systems.

- small Specifies a database for installations of less than 3,000 elements.

- medium Specifies a database for installations of between 3,000 to 10,000 elements polled every 5 minutes.

- large Specifies a database for installations of between 10,000 to 25,000 elements polled every 5 minutes.

- xlarge Specifies a database for installations of over 25,000 elements polled every 5 minutes.


Alphabetical List

nhCleanupNodes

Hides or removes unwanted and unused node and node-address pairs from the database. When nodes no longer have associated data, you can continue to create reports on them because the database still contains the addresses (although reports will list internal database IDs instead of node addresses or names). Use this command to hide nodes so that the data will appear to be unavailable for reports or to reduce the growth rate of the eHealth database.

By default, eHealth provides this command as a scheduled system job but does not enable it. You can modify the job to schedule it to run on a regular basis.


nhCleanupNodes [-h] [-rev] -hoursOld hours

{-hide | -remove}




- hoursOld hours Specifies the age of the nodes (in hours) to use as a basis for hiding or removing them. This argument is required.

- hide or - remove

■ When the number of hours specified by the -hoursOld argument have passed, use the appropriate argument to do the following:

■ -hide – Leaves node or node-address pairs in the database; however, deletes the data when it is rolled out of the database.

■ -remove – Removes node or node-address pairs from the database.

Important! Using the - remove argument can have serious consequences on your Traffic Accountant reports. For example, if you specify an - hoursOld value that is too small, you may remove important nodes inadvertently.

Example:

Enter the following command to remove nodes that are older than two days:

nhCleanupNodes -hoursOld 48 - remove


Alphabetical List

nhCollectDbData

Gathers information to help diagnose problems with your eHealth database.

Important! Use this command under the direction of Technical Support only.


nhCollectDbData [-nhHome <ehealth>] [-ftp] [-outPath <ehealth>] [-v]


-h (Optional) Displays help for this command.

- nhHome ehealth (Optional) Searches the specified directory for information related to eHealth. For use where NH_HOME can not be determined for some reason. If not specified, will search NH_HOME.

-ftp (Optional) Ftp's the information to the eHealth product's FTP site.

- outPath pathname (Optional) Specifies the directory in which eHealth will copy the collected information for tarring. A set of subdirectories will be created to hold all the collected data. If you do not specify this argument, the command creates the subdirectory root in the <ehealth> directory by default.

- v (Optional) Turns on verbose mode.

Example:

The following example collects data from the <ehealth>/tmp directory and tars it to the eHealth product's FTP site: nhCollectDbData -ftp -v

creating tarball of environment and all relevant files ...

:: NH_HOME: f:/eh5.6 selections ...

:: NH_ORACLE_HOME: f:/oracle/ora92 selections ...

:: attempt to gather info from Oracle...

:: done with capture, making tarball ...

:: preparing to ftp...

:: FTP'ing tarball to madison.concord.com ...

:: local tarball retained: F:/eh5.6/gbrown-gx260.2003-07-01-1637.tar

:: done.


Alphabetical List

nhCompileMib

Creates a precompiled management information base (MIB) (PCM) file, which is one step in the process for creating a custom variable. For the complete syntax, see the eHealth Data Integration Guide.

nhCompileTrf

Compiles one or more trap rule files (TRFs), which is part of the trap certification process.


nhCompileTrf [-h] [-rev]

nhCompileTrf {-f filename | -a} [-i | - s]



- rev Displays the eHealth software revision.

-f filename Compiles one TRF (filename) and saves the output as filename.sio and filename.pcm, in the directory in which the TRF resides. The nhCompileTrf command then creates ehealth/data/traps/staticTrapInfo using all precompiled information (where ehealth represents the eHealth installation directory).

Provide a full pathname for filename. The TRFs to compile typically reside in the ehealth/extensions/traps/usr directory.

-a Compiles all TRFs located in the ehealth/extensions/traps/sys and ehealth/extensions/traps/usr directories and saves the output in ehealth/data/traps/staticTrapInfo.

nhConfig

Imports element configuration information from a Database Configuration Information (DCI) file into the eHealth database. If you have a network management system (NMS) or other data source that collects configuration information and data about your resource devices, you can import the information from that source into the eHealth database. For the complete syntax, see the eHealth Data Integration Guide.


Alphabetical List

nhConfigDbNet

This command is primarily used by the nhCreateDb command. It enables communication between eHealth client processes and the eHealth database server by configuring SQL*Net. It can also be used to enable the SystemEDGE agent to communicate with an Oracle database server.

The listener process is the gatekeeper for establishing connections to the eHealth database server.


nhConfigDbNet [-h] [-rev] -addTnsNames -addListener [- listenerName]

[-sid oracleSid] [-port portNumber]

[-oracleHome oracleHomeDir] [-host hostName]

[-noRestart]

[-stopListener | -startListener]




-addTnsNames Updates the tnsnames.ora file so that the Oracle database server can communicate with the Oracle client.

-addListener Updates the listener.ora file so that the Oracle client can communicate with the Oracle database server.

To configure communication for another instance of the database and eHealth, specify [- addListener -listenerName listenerName] where listenerName is an alphanumeric name (of up to eight characters in length) for the listener process.

-sid oracleSid Specifies the name of the Oracle instance to update. The default is the value of the ORACLE_SID environment variable.

-port portNumber Specifies the port number for net8 communication. The default is 1521.

-oracleHome oracleHomeDir

Specifies the home directory of the Oracle instance to update. The default is the value of the NH_ORACLE_HOME environment variable.

-host hostName In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to run the command.


Alphabetical List



-noRestart Prevents automatic start of the Oracle Listener service following creation of the service.

-stopListener Stops the listener process. Any scheduled jobs that start while the listener is stopped will fail.

-startListener Starts the listener process if it had stopped.

nhConfigureTrapEx

Configures automatic licensing of SystemEDGE agents for use with TrapEXPLODER software.

nhConvertDb

Converts the eHealth database schema for a software upgrade. This command compares the value of the NH_DB_VERSION environment variable (defined by the installation process or in nethealthrc.sh) with the database version stored in the database. If these versions are different, the command takes appropriate action.

This command has the following format: nhConvertDb [-h] [-rev]

[-convertStandalone | -savePriorVersion | -finalize | - undoConvert |

-offlineConvert | -preConvert | - checkDiskSpace]




- convertStandalone Completes the upgrade of an eHealth database. This is the default action.

- savePriorVersion Saves the current database schema (before converting the schema).

- finalize Deletes the old version of the database schema. This is the final step of the database conversion. After specifying the - finalize argument, you cannot specify - undoConvert.

- undoConvert Reverts to the old version of the database schema. Use this argument if you encounter problems with the database conversion. You cannot specify - undoConvert after specifying -finalize.

Alphabetical List



- offlineConvert

- preConvert

- checkDiskSpace

Internal

These arguments are used by the eHealth installation process to upgrade a system from Release 5.5 to 5.6. You must specify them in a particular order and with a properly defined environment. Do not attempt to use these arguments without the direct assistance of Technical Support.

Example:

Enter the following command to convert your eHealth database:

nhConvertDb

nhCreateDb

Creates a new eHealth database (an Oracle instance and a empty eHealth schema). You may need to create a new database if the existing database is corrupted, or if you have deleted the existing database.

If you specify the -s argument, this command is interactive; before creating a new eHealth database, it asks a series of questions concerning how to set up the database, the size of the database, and the directories to use for the database.

If you specify the -i argument, you must specify the location of a layout configuration file (LCF), which contains details about how to create the database. In this case, the command is not interactive; it immediately begins to create the database using the parameters specified in the LCF.

When using the nhCreateDb command, follow these guidelines:

■ To run the nhCreateDb command on UNIX, you must first log in as the root user.

■ You must define the environment variable appropriately.

■ By default, eHealth creates a log file of the nhCreateDb operation in ehealth/log/install/CreateDb[n].log, where ehealth represents the eHealth installation directory, and n is the number of times you have run this command. To change the log file pathname, specify the -l argument.


nhCreateDb [-h] [-s oracleSid | -i lcf]

[-l logFile] [-o statusFile] [- t]

Alphabetical List



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) in which to create an eHealth database. By default, the nhCreateDb command uses the value of the ORACLE_SID environment variable for oracleSid.

-i lcf Specifies the LCF to use when creating the database. For more information about LCFs, see the Administration Guide.

-l logFile Specifies the pathname of the log file for the nhCreateDb command. The default is ehealth/log/install/CreateDb.log.

-o statusFile Specifies the output status file.

-t Internal

Creates a tiny database for use in test installations or on development systems.

Examples:

■ Enter the following command to create an eHealth database:

nhCreateDb -s EHEALTH

■ Enter the following command to create an eHealth database using a layout configuration file:

nhCreateDb -i D:/ehealth/oracle/database/purple_EHEALTH.lcf

nhCreateServiceNote

Lets you send a message to Business Service Console users to inform them that a business service is experiencing a performance or availability problem and that the person who is responsible is actively managing the problem resolution.

This command has the following format: nhCreateServiceNote [-h] -creator webUser

-appType applicationName -title "title"

[-owner webUser] [-note "note"]

[-readers "reader1;reader2;..."]

[-ticket problemTicketIdentifier]




Alphabetical List



-creator webUser (Required) Specifies the user who is creating the note. The user name must be a valid eHealth Web user name and it cannot exceed 64 characters.

-appType applicationName

(Required) Specifies the note application name. The applicationName must be a valid application. You cannot create a service note for a module or module set.

-title title (Required) Specifies the title of the note. The title should be enclosed in quotation marks.

-owner webUser (Optional) Specifies the owner of the note. The user name must be a valid eHealth Web user name, and it cannot exceed 64 characters. If you do not specify an owner, the command uses the value of the - creator argument by default.

-note note (Optional) Specifies the text of the note. The note should be enclosed in quotation marks.

-readers reader1;reader2;...

(Optional) Specifies a list of users who should have read permissions to review the note. The list must be enclosed in quotation marks. The names in the series are case-sensitive and must be separated by a semicolon. Each name can be a valid eHealth Web user name or user alias. The value is case-sensitive. If you do not specify this argument, only Web administrators will have permission to read the note.

-ticket problemTicketIdentifier

(Optional) Specifies the problem ticket identifier associated with the issue that is documented in the service note.

Example:

The following example creates a service note that notifies four people about a problem that has occurred with the mail system. It references a specific problem ticket number. nhCreateServiceNote -creator jsmith -appType Outlook

-title "Mail Slow" -owner dshanley

-note "Outlook has been experiencing slow response

for the past 2 hours. IT is actively working

on the problem."

-readers "john;richard;susan;dan" -ticket 34567

Note: You must specify an application name for the -appType argument, not a module or module set name. You cannot create a Service Note for a module or module set.

Alphabetical List

nhCustomVariable

Displays a graphical user interface through which you can add custom variables to a MIB translation file (MTF), apply an MTF to specific elements, and run a test poll to ensure that your customization is valid. For the complete syntax, see the eHealth Data Integration Guide.

nhCwmGetCfg

Imports configuration information from all Cisco WAN Manager (CWM) Network Management System (NMS) hosts configured for the integration module; imports the data, records it, and commits it to the eHealth database.


nhCwmGetCfg [-h] [-rev]

[-verify] [-noCommit] [-host hostName] [-sf]



-rev (Optional) Displays the eHealth software revision.

-verify (Optional) Imports data, but does not commit or record that the data was imported.

-noCommit (Optional) Imports data, records it was imported, but does not commit it to the eHealth database.

-host hostName (Optional) Imports data only from the specified host.

-sf (Optional) Skips the FTP step. Data is taken from the file: $NH_HOME/modules/cwm/hostName.import.

nhDbApi

Manages the creation and deletion of eHealth database views and tables through an application programming interface (API). These views and tables store statistics information that you can use to obtain trend data.


Alphabetical List

nhDbMaint

Performs a variety of maintenance tasks on the eHealth database. If you do not specify any arguments, nhDbMaint runs all of its options, except for -deleteArchiveLogs.

Note: You should manually backup and trim the alerts file because the alert_ehealth.log can become very large and impact performance.


nhDbMaint [-h] [-coalesce] [-rebuildIndexes] [- cleanSharedPool]

[-trimAlertLogs] [-deleteArchiveLogs]



- coalesce (Optional) Executes 'alter tablespace t coalesce' on each tablespace.

- rebuildIndexes (Optional) Executes 'alter index i rebuild compute statistics' on various configuration tables.

-cleanSharedPool (Optional) Executes 'alter system flush shared_pool'.

- trimAlertLogs (Optional) Truncates the system alert log files if the log files are larger than 16 MB in size.

- deleteArchiveLogs (Optional) Removes archive logs from the system.

nhDbStatus

Displays the status of the database. This information is similar to the information that appears in the Database Status dialog box of the eHealth console; it informs you about the available space of the devices on which the datafiles reside.

This command has the following format: nhDbStatus [-h] [-host hostname | -cluster | -all]

[-u user] [database]

If you do not specify -host or -cluster or -all, the nhDbStatus command displays the status of the database on the local system. If you specify one of these distributed arguments, the command shows the database status of one, more, or all systems in the cluster, displaying the output on the local system.


Alphabetical List



-host hostname Specifies the name of the Distributed eHealth System for which you want to display database status. For example, to display the status of the database on the eHealth system named max, enter the following command from any eHealth system in the cluster:

nhDbStatus -host max

-cluster Displays the database status of all eHealth systems in a Distributed eHealth cluster except the local system.

-all Displays the database status of all eHealth systems in a Distributed eHealth cluster.

-u user Specifies the name of the eHealth user. The default is the value of the NH_USER environment variable.

database Specifies the name of the database on which to display the status. The default is the value of the NH_RDBMS_NAME environment variable.


Alphabetical List

Example:

The following shows sample output from an nhDbStatus command run on a Windows system: Database Name: EHEALTH

Database Size: 1632632832.00 bytes

RDBMS Version: 9.2.0.3.0

+---------------+--------------------+--------------------+----------------------

-----------

| Tablespace | Free Space In | Free Space On | Data Path

| | Data File (bytes) | Device |

+---------------+--------------------+--------------------+----------------------

-----------

| NH_ROLLBACK | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_RBS01.DBF|

| NH_TEMP | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_TEMP.DBF|

| NH_USERS | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_USERS01.DBF|

| NH_INDEX | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_INDX01.DBF|

| NH_DATA02 | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_DATA21.DBF|


| SYSTEM | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/SYSTEM01.DBF|

+---------------+--------------------+--------------------+----------------------

-----------

Statistics Data:

Number of Elements: 597


Location(s):

Latest Entry: 19/12/2002 07:44:00

Earliest Entry: 1/11/2002 00:00:00

Last Roll up: 18/12/2002 20:00:50

Conversations Data:

Number of Probes: 0

Number of Nodes: 0

As Polled:

Database Size: N/A

Location(s):

Latest Entry:

Earliest Entry:

Last Roll up: 19/12/2002 04:05:25

Rolled up Conversations:

Database Size: N/A

Location(s):

Latest Entry:

Earliest Entry:

Rolled up Top Conversations:

Database Size: N/A

Location(s):

Latest Entry:


Alphabetical List

Earliest Entry:

nhDeleteAnalyzedData

Deletes the analyzed data for one or more service profiles. If you change the settings of a service profile that is used by scheduled reports, the analyzed data for those reports could become inconsistent; the analyzed data for the days before the profile changed could be different from the analyzed data that occurs for days after the profile change.

In a Distributed eHealth cluster, service profiles are replicated among the cluster members. If you change a profile, the changes could affect the appearance of reports on other cluster members. You can use the nhDeleteAnalyzedData command to delete existing analyzed data for a service profile. The next time the scheduled Data Analysis job runs, it will create new analyzed data for the reports based on the new service profile settings; the next time the reports run, the data in the reports will be consistent.

Note: In a Distributed eHealth environment, you should specify the -all argument with the nhDeleteAnalyzedData command to ensure that you delete the analyzed data from all Distributed eHealth Systems in the cluster.

This command has the following format: nhDeleteAnalyzedData [-h] [-rev] -afterDate mmddyyyy

[-host hostname | -cluster | -all ]

[-serviceProfileIds machineId@serviceProfileId ... ]


-h Displays the help for the command.


-afterDate mmddyyyy

Specifies the date after which eHealth deletes the analyzed data for the specified service profiles. For example, if you specify 01062001, eHealth deletes all analyzed data for the service profile after January 6, 2001 (that is, starting on January 7, 2001).

-host hostname Deletes the analyzed data for the service profiles on the specified eHealth system hostname. If you do not specify - host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.

-cluster Deletes the analyzed data for the service profiles on all other systems in the cluster except the local system. If you do not specify -host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.


Alphabetical List



-all Deletes the analyzed data for the service profiles on all eHealth systems in the cluster. If you do not specify -host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.

- serviceProfileIds machineId@ serviceProfileId ...

Specifies one or more service profiles for which you want to delete the analyzed data. To uniquely identify the service profiles, you must specify the service profile ID and the member ID of the cluster system.

If you do not specify a service profile ID, the command deletes the analyzed data for all service profiles on the specified eHealth systems.

When you create a service profile on a Distributed eHealth System, eHealth saves the profile in the ehealth/reports/dataAnalysis directory, where ehealth represents the eHealth installation directory. The file name has the following format:

profileName.memberId.profileId.dac

Example:

CorpProfile.739247905.1000001.dac

Examples:

■ The following example deletes the analyzed data for the service profile CorpProfile on the eHealth system CHICAGO after June 12, 2003:

nhDeleteAnalyzedData -afterDate 06122003 \

-host CHICAGO \

-serviceProfileIds 739247905@1000001

Note: If you run a Health, Service Level, or MyHealth report for a report period that includes any days before the -afterDate value, your reports will display a data note indicating that the analysis controls changed on the day after the -afterDate value.

■ The following example deletes all analyzed data on the local eHealth system after November 23, 2002:

nhDeleteAnalyzedData -afterDate 11232002

■ If the command does not find any analyzed data for the specified profiles, it displays the following message:

No data associated with service profile profileId.

Alphabetical List

nhDeleteArConfig

Removes an element (agent, agentSet, server, or application) from the Application Response Configuration.

This command has the following format: nhDeleteArConfig [-h] [-rev]

-type {agent | agentSet | server | application} -name elementName

[-deleteAgents {yes|no}] [-confirm {yes|no}] [-verify]





(Optional) Specifies which type of element to delete. The default value is agent.

-name elementName (Required) Specifies the name of the element to delete.

- deleteAgents {yes|no} (Optional) Specifies whether to delete all of the agents in the agentSet; only valid for - type agentSet; default value is yes.

-confirm {yes|no} (Optional) Specifies whether to display a prompt before deleting the element. The default value is yes, which displays a prompt.

-verify (Optional) Verifies that the input parameters are valid without performing the actual operation. Processes the input and produces a DCI file, but does not remove the elements from the eHealth database.


Alphabetical List

Examples:

■ The following example deletes the application named app1:

nhDeleteArConfig -type application -name app1

■ The following example deletes a server named s1 without prompting for confirmation that you want to delete it.

nhDeleteArConfig -type server -name s1 -confirm no

■ The following example uses the output of the nhListArConfig command to delete agents whose names start with "zz."

nhListArConfig | grep zzz | nhDeleteArConfig -confirm no

nhDeleteElements

Deletes elements from the database and poller configuration. You can specify the names of elements to delete using standard input (stdin) or the -inFile argument. You can also redirect the output of the nhListElements command as input to the nhDeleteElements command.

Important! Use of this command will result in loss of all data for deleted elements.


nhDeleteElements [-h] [-rev] [-inFile filename] [-verify]




- inFile filename Specifies the name of the file that contains the list of element names to delete.

If you do not specify an input file, eHealth reads input from standard input. You must specify the element names exactly, with one name per line.

- verify Processes the input and produces a DCI file, but does not remove the elements from the eHealth database.


Alphabetical List

Examples:

To delete elements that are specified in file1, enter the following:

nhDeleteElements -inFile file1

To locate all router elements that have not added data to the database for the past six hours, and then delete them, use the following command combination:

nhListElements -elemType router -noDbDataFor 6 | nhDeleteElements

nhDeleteServiceNote

Deletes Business Service Console (BSC) service notes from the eHealth database. Only eHealth administrators can delete Service Notes.


nhDeleteServiceNote [-h] -noteID noteID [.., noteID]



-noteID ID (Required) Specifies the ID numbers of one or more service notes to delete.

Example:

In the following example, the command removes a single Service Note with a note ID of 1000001:

nhDeleteServiceNote -noteId 1000001

nhDestroyDb

Completely removes an eHealth database, including the Oracle instance, all corresponding database files, the init.ora file, and so on. The nhDestroyDb command does not, however, destroy a database save.

You should delete a database for the following reasons only:

■ The database is corrupted.

■ You need to move the database.


Alphabetical List

When using the nhDestroyDb command, note the following:

■ You must define the NH_HOME and NH_ORACLE_HOME environment variables.

eHealth creates a log file of the nhDestroyDb operation in ehealth/log/install/DestroyDbEHEALTH.log, where ehealth represents the eHealth installation directory.

■ To run the nhDestroyDb command on UNIX, you must first log in as the root user.

After deleting a database, you must create a new one using the nhCreateDb command. After creating a new database, you can load a previously saved copy of the database using the nhLoadDb command.


nhDestroyDb [-h] -s oracleSid [-f]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) from which to delete the eHealth database.

-f Forces the nhDestroyDb command to proceed with the destruction of the eHealth database. It shuts down all connections to the database and related processes without warning users.

Examples:

■ To delete the database whose Oracle SID is EHEALTH, enter the following:


■ The following is sample output from the nhDestroyDb command on a Windows system when the database server is running but eHealth has been stopped:

c:> nhDestroyDb -s EH56

Destroying the eHealth database 'EH56' ...

0% 25% 50% 75% 100%

|||||||||||||||||||||||||||||||||||||||||||||||||||

Please reboot system prior to creating a new database.


Alphabetical List

nhDiscover

Locates resources within your infrastructure from which eHealth collects data and reports about resource performance and availability. This command uses Simple Network Management Protocol (SNMP) to find agents on particular ports at specified IP addresses. It then obtains information from the management information base (MIB) of each device and creates elements based on that information.

It discovers elements so that you can add to or update your eHealth element configuration. The results of a Discover operation can be filtered and transformed using DCI rules, and the elements can be saved to named groups. Many options of the discover process are controlled by the Discover Policy parameter settings, which can be defined and edited using the eHealth for OneClick interface.

Each element can only be associated with a single policy. If no policy is specified for a discover run, the command uses the existing environment settings to remain backwards compatible with previously scheduled discover jobs or old scripts.

Important! Discovering elements without a defined policy makes it difficult to rediscover them properly, and can lead to unintended configuration changes that prevent your elements from polling and reporting properly.

You can rediscover a list of named elements using previously stored and associated policies. If some of the provided element names are not associated with a stored policy, then those elements will be rediscovered by utilizing environment variable settings. Otherwise eHealth rediscovers each of the named elements with the appropriate policy and performs a single merge operation to update the configuration.

You can specify a policy for a discovery. Each element can only be associated with one policy. If no policy is specified, the discovery uses the existing defined environment, merges matching rules, and no DCI files.

You can discover elements under multiple policies without saving the new policies. However, if you do allow a policy to be saved during a discover, it overwrites any previously saved policies for all elements discovered during that run, regardless of whether the elements are new, updated, or otherwise unchanged. Many elements will undergo a one-time performance impact the first time they are discovered under eHealth due to the policy updates.


Alphabetical List

This command has the following syntax:

nhDiscover [ -h ] [ -mode modeValue,modeValue ]

[ -policy policyName ]

[ -g groupName,groupName ] [ -dciRule ruleFile ]

[ -c community ] [ -ret retries ] [ -t timeout ]

[ -o outputFilename ] [ -res resultsFilename ]

[ -e excludeFilename ]

[ -mergeSource { interactive | scheduled } ] [ -ignoreProcessSet ]

[ -createNew { Yes | No } ]

{ -f seedFile [ -fOptions optionList ] |

-spectrum collectionName | -p n:n::n-m:x,y | n.n.n-m.x,y |

-elementStdin | -elementFile fileName | -elements elementList |

-usePlrCfg }

Specifying any arguments on the command line will override the contents of any specified discover policies.

Specifying any arguments on the command line will override the configured attributes of provided elements when specifying element lists.


Alphabetical List

You must specify one of the following arguments with the nhDiscover command. You can specify more than one.

-f seedFilename

(Optional) Specifies a file that contains the IP addresses that discover should query.

-fOptions parameter[,parameter]

(Optional) Specifies additional data to parse from -f <seedFilename>. Valid file option parameters are 'address,community,port,rootName', separated by commas. The required file syntax is address[:port] [community [port [rootName]]]

Default: address

-spectrum collectionName

(Optional) Specifies that eHealth import IP address information from the specified SPECTRUM global collection.

-p n:n::n-m:x,y> | <n.n.n-m.x,y

(Optional) Specifies the IP address pattern that discover should query.

-elements elementList

(Optional) Specifies that eHealth bases its query on the attributes of the elements contained in a comma-separated list.

-elementFile fileName

(Optional) Specifies that eHealth bases its query on the attributes of the elements included in the specified file.

-elementStdin

(Optional) Specifies that eHealth bases its query on the attributes of the elements written to standard input (one element per line), and terminated with ^D.

-usePlrCfg

(Optional) Specifies that discover uses the eHealth configuration as the seed file. As a best practice, specify this argument with -mode to rediscover a particular technology type.

The following optional arguments can be used:

-h

(Optional) Displays this command usage.

-mode modeValue

(Optional) Specifies the technology type of the resources that discover should find within the network.

-policy policyName


Alphabetical List

(Optional) Specifies the Discover Policy that eHealth should associate with the discovered elements.

-g groupName,groupName

(Optional) Specifies the name of one or more groups to which eHealth should add all discovered elements.

-dciRule ruleFilename

(Optional) Specifies the name of a Database Configuration Information (DCI) rules file that discover should run against its results. The rules file can include or exclude elements based on certain element attributes, create groups, create associations, or modify element attributes.

-c community

(Optional) Controls read and write access to data that is stored in the MIB. By default, eHealth performs a discovery based on the public community string.

-ret retries

(Optional) Specifies the number of times that eHealth will ping the element or make an SNMP request.

Default: 3

-t timeout

(Optional) Specifies the number of seconds that eHealth will wait for an ICMP ping or SNMP response before timing out.

-o outputFilename

(Optional) Specifies the name of a DCI file to which the discovered element configuration is written.

-res resultsFilename

(Optional) Specifies the name of a text file to which the discover result messages are written.

-e excludeFilename

(Optional) Specifies that discover excludes the file of IP addresses from its query.

-mergeSource {interactive | scheduled}

(Optional) Specifies the type of discover process and adds it to the globalInfo section of the DCI file.

Default: interactive

-ignoreProcessSet

(Optional) Specifies that discover exclude process sets and process elements from its query.

-createNew {Yes | No}


Alphabetical List

(Optional) Specifies whether unmatched elements should be added to the eHealth configuration or ignored.

n.n.n.n or n:n::n:n:n

Discovers a single IP address.

nhDiscoverPolicy

Export and import policies across separate eHealth installations.


nhDiscoverPolicy [-h] {-list | -export [ -policy <policyName> ] | -import [-

force] } [ -filePrefix <namePrefix> ]



-list Lists all discover policy names from the database.

-export Exports one or all discover policies from the database.

-import Imports discover policies to the database.

-force Overlays any existing policies in the database with the same name. It is used with the –import option.

-policy Specifies the name of a single policy to be exported. If no policy is specified, then all policies will be exported. It can only be optionally used with –export option.

-filePrefix Prefix prepended to DiscoverPolicy.xml and DiscoverPolicyParams.xml when importing and exporting. The actual file names that are used, which can include a path, will be [set the File Name variable]DiscoverPolicy.xml and [set the File Name variable]DiscoverPolicyParams.xml.

If the –fileName option is not used, and the –policy option is used, the file names will be <policyname>DiscoverPolicy.xml and <policyname>DiscoverPolicyParams.xml in the current directory.

If the –fileName and –policy options are not used; the default file names will be DiscoverPolicy.xml and DiscoverPolicyParams.xml in the current directory.


Alphabetical List

Error messages can appear under the following circumstances:

■ If you try to import a duplicately named discover policy record (To replace the policy, use the –force argument.)

■ If you try to use –import and –policy option at the same time

Examples:

■ To export a single policy, use the following string:

nhDiscoverPolicy –export –policy policy1

Result:

Two files named policy1DiscoverPolicy.xml and policy1DiscoverPolicyParams.xml will be generated in the current directory.

■ To export all the discover policy data, use one of the following strings:

nhDiscoverPolicy –export –filePrefix /tmp/alldiscoverPolicy

Result:

Two files named /tmp/alldiscoverPolicyDiscoverPolicy.xml and /tmp/alldiscoverPolicyDiscoverPolicyParams.xml will be generated

or

nhDiscoverPolicy –export

Result:

Two files named DiscoverPolicy.xml and DiscoverPolicyParams.xml will be generated in the current directory.

■ To import a policy, use one of the following strings:

nhDiscoverPolicy –import –filePrefix $NH_HOME/discoverPolicy

or

nhDiscoverPolicy –import –force –filePrefix $NH_HOME/discoverPolicy

■ To list all policies:

nhDiscoverPolicy –list


Alphabetical List

nhDrConfigScenario

Configures the scenarios for XOSoft WANSync. This script prompts the user for information and generates scenarios that are imported to WANSync using the command line interface.


nhDrConfigScenario

Example: Sample output

The following sample output shows the user response for the host name in italics:

Enter the nhuser password :

Enter the name of the standby server (WANSync replication host): uscisf01

Generating WANSync scenarios for replication from u10cluster to uscisf01.

Using default WANSync spool directory /space/WANSync/spool.

Using default WANSync reports directory /space/WANSync/reports.

You can update the WANSync scenarios by running /opt/WANSync/bin/ws_cli.

Would you like to perform an initial synchronization of the scenarios? [y]:

nhDrSetup

Configures an eHealth disaster recovery system with a shared hostname.

This command has the following format: nhDrSetup -hostname sharedhostname [-list] [-disable] [- configureStandby] [-h]


- hostname sharedhostname

Specifies the name of the shared host where eHealth is running.

-list (Optional) Displays the name of the shared host this eHealth system is currently set to.

-disable (Optional) Removes the disaster recovery configuration setting.

-configureStandby (Optional) Performs various tasks that allow a standby system to run eHealth after a failover has occurred.

-h (Optional) Displays help for this command


Alphabetical List

Examples:

■ To configure an eHealth disaster recovery system to support shared hostnames, enter the following command:

nhDrSetup -hostname sharedhostname

■ To remove the disaster recovery setting from the eHealth system, enter the following command:

nhDrSetup -disable

nhElementStatus

Shows the polling status of each element as of the last poll and displays this information on the screen. It provides a snapshot of the state of each element.

The nhElementStatus command can help you to identify elements that have not been polled in the last day, and elements that have polling errors. eHealth must poll the elements at least twice before the command can determine the element status.

This command has the following format: nhElementStatus [-h] [-rev] [-v] [-showAll] [-neverPolled] [-noDataFor minutes]

[-showErrors] [-noDbDataFor minutes] [-outfile filename]

[-host hostname | -cluster | -all]

If you do not specify -host, -cluster, or -all, the nhElementStatus command displays the status of elements on the local system. If you use one of these distributed arguments, the command shows the element status of one or all systems in the cluster, displaying the output on the local system.




- v[erbose] Prints verbose details.

- showAll Displays all elements and their status. This is the default action.

- neverPolled Displays elements that have never been polled.

- noDataFor n Displays elements that have not posted data during polling for the specified number (n) of minutes.

- showErrors Displays elements that have been receiving data but errors have prevented the data from being saved in the database.


Alphabetical List



- noDbDataFor n Displays elements that have not posted data to the database during polling for the specified number (n) of minutes.

- retired (Optional) Shows only those elements that are retired. Must be specified with –noDataFor <minutes>.

- outfile f Sends output to the specified file (f).

- host hostname Specifies the name of the Distributed eHealth System for which you want to display element status.

-names Shows only element names.

- cluster Displays element status for all eHealth systems in a Distributed eHealth cluster except the local system.

- all Displays element status for all eHealth systems in a Distributed eHealth cluster.

By default, the nhElementStatus command produces a log file that lists the following:

■ All elements on the local system that are polling correctly

■ All elements on the local system that have never been polled

■ All elements on the local system that received polling errors

Note: Some types of elements do not show up in this tool. For example, elements that do not poll data, such as response endpoints, will not be listed. Also, aggregateOnly elements or interface elements that have been operationally down since eHealth started polling them are excluded.

The following table describes the log file fields:

Field Description

Element Name Specifies the element name, as defined in the poller configuration.

Alphabetical List


Field Description

Status Specifies the state of the element. Status values include:

■ Polling correctly

■ Is off

■ Not polled in n minutes

■ Never polled

■ Polling but receiving errors

Last Save Time Specifies the last time that the poller saved data for the element in the database (on the eHealth system).

Last Poll Time Specifies the last time that the poller attempted to poll the element (on the eHealth system).

Data Time Specifies the time at which the most recent data was received for the element (on the eHealth system). Some of the fields in the time stamp may be blank if the system does not have any values for them.

MTF Name Specifies the name of the MTF used to obtain data from the element.

Examples:

■ You can specify the -noDataFor argument to list elements for which the poller has not received data for a specified number of minutes. For example, to list elements that have not returned data during the past hour, enter the following:

nhElementStatus -noDataFor 60

■ You can specify the -neverPolled argument to list elements that have never been polled. You can specify the -showErrors argument to list elements that have polling errors. You can also specify a combination of arguments.

If none of the elements match the report criteria, the report displays the following:

Nothing to report.

nhEncodeRdl

Encodes custom report files. For the complete syntax, see the eHealth Data Integration Guide.

Alphabetical List

nhExpire

Deletes old ASCII, EPS, PDF, PS, or Web-based reports and temporary files, including temporary PDF files that are older than the specified number of days.

Important! Improper use of this command can result in loss of data or reports. Use this command only if you are an advanced user and are familiar with its effects.

This command has the following format: nhExpire [-h] [-output days] [- webGroup days]

[-webUser days] [-webReport type days] [-tmp days]

Note: The nhExpire command requires one of these arguments: -webUser, -webGroup, -webReport, -output, or -tmp.

Argument Name Description


-output days Specifies the number of days to keep reports as files in the output directory of your eHealth installation.

- webGroup days Specifies the number of days to keep Health, Service Level, and Top N reports that were output as Web reports.

- webUser days Specifies the number of days to keep Trend, Traffic Accountant, and At-a- Glance reports output as Web reports.

- webReport type days

Deletes Web- based reports of the specified types that are older than days.

For type, specify one or more of the following: glance, dailyHealth, dailyService, monthlyHealth, monthlyService, topN, traffic, trend, weeklyHealth, weeklyService, whatIf.

-tmp days Deletes any files in the tmp directory (of your eHealth installation) that are older than days.

nhExportCalendarCfg

Exports calendar configuration information from eHealth to a Calendar DCI file for processing. For the complete syntax, see the eHealth Data Integration Guide.


Alphabetical List

nhExportConfig

Exports element configuration information from the eHealth database to a DCI file. You can then use the file to modify element information and import the new information to the eHealth database. You can export all elements in the poller configuration; elements in a single group or group list; and elements of a particular type or technology. You cannot use this command to export configuration information for a single element.

Note: You can use this command on a Distributed eHealth System; however, it is not supported on a Distributed eHealth Console.

The eHealth server must be running when you use the nhExportConfig command. For the complete syntax, see the eHealth Data Integration Guide.

nhExportData

Exports data for statistics elements from the eHealth database to a Database Definition Output (DDO) file for processing. You can use this command to export large amounts of bulk (unanalyzed) data from the eHealth database to a spreadsheet, database, script, or other application program to perform your own statistical analysis. The command option –cfgFields lets you include element configuration attributes along with the statistical data.

You can use command arguments with the nhExportData command to specify the element or group, DDO file name, time range, and Trend report variables to export. You can use this command on a Distributed eHealth System; however, it is not supported on a Distributed eHealth Console.

You cannot use the nhExportData command to do the following:

■ Export statistics data for the elements in a group list.

■ Export statistics data for all elements in the poller configuration at the same time.

■ Limit the data export to a particular element type.

■ Export statistics data for variables other than Trend report variables.

■ Export data for eHealth conversations elements used in applications such as eHealth – Traffic Accountant and eHealth Integration for Cisco NetFlow.


nhExportData [-h] [-rev] -subjName "name1, ..., nameN"

[-host name | -cluster | -all] [-outFile ddoOutputFile]

[-autoRange type | -fromDate date -fromTime time -toDate date -toTime time]

[-subjType type] [-vars "variable1, ..., variablen"]


Alphabetical List


-h Displays the command usage.

-rev Displays the eHealth software version.

-subjName "name1, ..., nameN"

Specifies the name of one or more elements or a single group for which to export statistics data. If you specify a list of element names, separate them with commas (,) and enclose the list in quotation marks (" "). This is the only required argument. If you specify a parent element name, the command also exports statistics data for all of its child elements. If you specify a group name, it exports statistics data for all elements in the group and their respective child elements.

-host name Specifies the name of the eHealth system in the cluster on which you want to run the command. For example, to run the nhExportData command on an eHealth system named newyork, use the following command from any eHealth system in the cluster:

nhExportData -host newyork

Note: You must use the hostname and not the IP address.

-cluster Runs the command on all eHealth systems in the cluster except the local system. This command creates an output file for each system and appends the hostname as follows: dciOutputFile.hostname. It also adds the machine ID to the element descriptor for each element in an output file. You cannot merge the output files into a single file.

Note: The -cluster argument does not identify duplicate element names in the resulting output files. Use the file name to differentiate elements with the same name that reside on multiple systems.


Alphabetical List



-all Runs the command on all eHealth systems in the cluster. This command creates an output file for each system and appends the hostname as follows: dciOutputFile.hostname. It also adds the machine ID to the element descriptor for each element in an output file. You cannot merge the output files into a single file.


-outFile ddoOutputFile Specifies the name of the DDO file to which you want to export the statistics data. If you omit this argument, eHealth exports the statistics data to standard output by default.

-autoRange type Specifies the time range for which you want to export statistics data. The following values are valid:

■ today

■ yesterday

■ thisWeek

■ lastWeek

■ thisMonth

■ lastMonth

■ prevHour (the default)

■ prev12Hours

■ prev24Hours

■ prev7Days

■ prev4Weeks

-fromDate date Specifies the starting date for which you want to export statistics data. Specify the date in MM/DD/YYYY format.

-fromTime time Specifies the starting time for which you want to export data. Specify the time in hh:mm:ss format using a 24-hour clock.

Alphabetical List



-toDate date Specifies the ending date for which you want to export data. Specify the date in MM/DD/YYYY format.

-toTime time Specifies the ending time for which you want to export data. Specify the time in hh:mm:ss format using a 24-hour clock.

-subjType type Specifies whether you want to export statistics data for one or more elements or for a single group of elements. The following values are valid:

■ element (the default)

■ group

If you specify the name of one or more elements for the -subjName argument, set the value of -subjType to element. If you specify the name of a group for the -subjName argument, set the value of -subjType to group.

-vars "variable1, ..., variablen" Specifies the names of Trend report variables for which you want to export statistics data. By default, data appears for the union of all Trend report variables applicable to the specified elements. If you specify a list of variable names, separate the names with commas (,) and enclose the list in quotation marks (" ").

For more information and examples, see the eHealth Data Integration Guide.

nhExportDowntime

Provides a summary of all planned downtime that was previously imported into the eHealth database. You can use this information to update the schedule and then reimport the data into the eHealth database. eHealth rounds planned downtime to the nearest minute.


nhExportDowntime [-h] [-rev] filename.pdi

[-host hostname | -cluster | - all]

Alphabetical List

If you do not specify -host, -cluster, or -all, the nhExportDowntime command exports downtime from the database on the local system. If you specify one of these distributed arguments, the command exports downtime from one, more, or all systems in the cluster, and returns the output (.pdi) file to the local system.


- h Displays help for this command.


filename.pdi Specifies the name of the file that contains all planned downtime or outages. For more information about customizing the planned downtime import (.pdi) file, see the eHealth Report Management Guide.

- host hostname

In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to export downtime.

- cluster In a Distributed eHealth cluster, exports downtime from all eHealth systems in the cluster except the local system.

- all In a Distributed eHealth cluster, exports downtime from all eHealth systems in the cluster.

Planned Downtime in a Cluster

You can export a summary of planned downtime on individual Distributed eHealth Systems in a cluster using the nhExportDowntime command; however, this command is not "cluster aware." Each Distributed eHealth System must have a unique .pdi file for all planned downtime elements being polled on that system. You should not replicate planned downtime settings for individual Distributed eHealth Systems to other machines to account for planned downtime on those systems.

Note: If you move the settings to another machine, the load will fail. The elements do not exist on the other machine, so the existing planned downtime at that machine may be lost.

The -cluster argument is not useful for exporting downtime from all Distributed eHealth Systems in a cluster, and it is not recommended. The -cluster argument is only useful if you launch the command from a central location in the cluster to take effect at remote systems.


Alphabetical List

Modify Planned Downtime

To modify the planned downtime schedule for a Distributed eHealth System

1. Enter the following command:

nhExportDowntime filename.pdi -host distributedeHealthSystemName

2. Open the file and review the summary; then do the following:

a. Resolve discrepancies among existing planned outages and actual events.

b. Correct errors.

c. Add new outages.

d. Delete outages that did not occur.

e. Save the file.

3. Reimport the data into the eHealth database:

nhImportDowntime filename.pdi -host distributedeHealthSystemName

Note: If you are running this command from the actual Distributed eHealth System, you can omit the -host argument; otherwise, you must specify it.

nhExportImPollerStatus

Saves the IM poller status files to the specified zip file in a format suitable for use with nhImportImPollerStatus. For the complete syntax, see the eHealth Data Integration Guide.

nhExportLiveExCfg

Exports Live Exceptions configuration information to a DCI file, so you can modify the information. For the complete syntax, see the eHealth Data Integration Guide.

nhExportSnmpKeyInfo

Exports SNMPv3 key configuration information from the eHealth database to a DCI file. You can then modify the information and reimport it into the database. For more information about this command, see the eHealth Data Integration Guide.


Alphabetical List

nhExportWebAcct

Exports eHealth Web user account information and passwords from users.cfg to a DCI file that you can modify. It can also copy user Web reports to a file. This command supports Distributed eHealth cluster arguments. For the complete syntax, see the eHealth Data Integration Guide.

Note: The nhExportWebAcct command is intended for use by the eHealth Web administrator.

nhFindClusterDiffs

Compares the configuration of one or more eHealth systems in a Distributed eHealth cluster to determine whether their replicated information is synchronized. The command displays information about the differences in the replicated information.


nhFindClusterDiffs [-h] [-rev] { -host hostname | -cluster }

[ -objTypeAll | -objType objType | -objTypeList ]

[-includeHomed] [-localView] [-retryTime seconds]

The local system is the system that you are logged into when you run the command.


- h Displays the help for the command.

- rev Displays the eHealth software revision information.

- host hostname Compares the replicated information on the local system to the information on the specified eHealth system hostname. This argument is required unless you specify -cluster.

- cluster Compares the replicated information on all of the other systems in the cluster to the local system and displays the differences for each system. This argument is required unless you specify -host.

If you also specify the -localView argument, the output shows the differences for the local system only.


Alphabetical List



- objTypeAll Compares the replicated information for the group, groupList, groupListContents, dataAnalysisRec, and serviceProfile objects. This is the default.

To include the replicated information for elements and group sections, you must specify the -includeHomed argument.

You can check for differences for a specific object type using the -objType argument.

- objType objType Compares the information for a specified object type. You can select one of the following object type values:

■ element

■ group

■ groupSection

■ groupList

■ groupListContents

■ dataAnalysisRec

■ serviceProfile

- objTypeList Lists the supported object types, but does process the command. Use this argument to list the valid objType values for the -objType argument.

- includeHomed Compares the replicated information for element and groupSection objects as well as the other specified object or objects.

- localView Displays the differences relative to the local eHealth system only. This argument is meaningful only when you specify the -cluster argument.

If you include this argument, the command displays the differences for only the local system. This shows you how much the local eHealth system is in (or out of) synchronization with the other systems in the cluster.

Alphabetical List



- retryTime seconds

Specifies how long in seconds the local system will retry the command. If the command fails due to an internal problem (for example, the system connection to the network is down), eHealth reissues the command for the specified retry time.

The default is 0, which indicates that the local system will not retry the command. If you specify a value, it should be less than the value of the NH_REPL_MSG_TIMEOUT environment variable, which is 300 seconds (five minutes) by default.

If the nhFindClusterDiffs command shows that the eHealth systems are not synchronized, you can run the nhReplicate or nhSynchronize commands to synchronize them.

Alphabetical List

Examples:

■ The following example checks all object types and displays the differences. (In this example, the command found no differences among the object information that require correction.)

nhFindClusterDiffs -cluster -objTypeAll

Cluster Find Differences initiated:

Searching for cluster differences between objects of type group... OK

Searching for cluster differences between objects of type groupList... OK

Searching for cluster differences between objects of type

groupListContents... OK

Searching for cluster differences between objects of type dataAnalysisRec...

OK

Searching for cluster differences between objects of type serviceProfile...

OK

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

**

nhFindClusterDifferences Report

Machine Run On: wake 07/18/2001 11:41:23 AM

Report Summary table:

-----------------------------+-------------------+---------------------------

--

| Machines | Objects

Object Type | Polled Responded| Processed Need Update

-----------------------------+-------------------+---------------------------

--

dataAnalysisRec 2 2 0 0

element 2 2 0 0

group 2 2 8 0

groupSection 2 2 0 0

groupList 2 2 0 0

groupListContents 2 2 0 0

serviceProfile 2 2 0 0

-----------------------------+-------------------+---------------------------

--

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

**


Alphabetical List

■ The following example checks the cluster for group list differences. (In this example, the command finds differences that must be resolved. see the text after the example for an explanation.)

nhFindClusterDiffs -cluster -objType groupList


Searching for cluster differences between objects of type groupList..... OK

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

**




-----------------------------+-------------------+---------------------------

--



-----------------------------+-------------------+---------------------------

--

groupList 4 4 2 2

-----------------------------+-------------------+---------------------------

--

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

**

-----------------------------------------------------------------------------

-

Object Type: groupList

Machines Polled: 4

Responses Received: 4

Object(s) Processed: 2

Object Update(s) Required: 2

-----------------------------------------------------------------------------

-

Object Name: abc_LanServer

Object Id: 739249216:1000007

Latest Version On: tigger 07/17/2001 11:19:15 AM

(+ 2 others)

Machine(s) to Update: solomon <No Object>

Object Name: 50-grouplists

Object Id: 739249216:1000008


(+ 2 others)

Machine(s) to Update: solomon 07/10/2001 05:23:35 PM

-----------------------------------------------------------------------------

-


Alphabetical List

■ In this example, both group lists have differences in the cluster. The groups are the same on three systems (tigger + two others), but one system (solomon) has old information. For the abc_LanServer group list, the <No Object> value indicates that the cluster member solomon has no information about the group list. For the 50-grouplists, the system solomon has old information about the group lists. The time stamp 07/10/2001 indicates that the group list information on solomon is over 7 days older than the latest information on the other systems.

■ To correct these differences, log into solomon as the eHealth administrator and run the nhSynchronize command as follows:

nhSynchronize -host tigger -objType groupList

■ You could also log into an up-to-date system such as tigger and use the nhReplicate command to update solomon as follows:

nhReplicate -host solomon -objType groupList

nhFindDupObjects

Searches for duplicate elements, groups, group lists, and service profiles in a Distributed eHealth cluster and displays information about the duplicates and which Distributed eHealth systems own them. You can run this command from any Distributed eHealth System or Console in the cluster.

This command has the following format: nhFindDupObjects [-h] [-rev] { -host hostname | -all }

[-objTypeAll | -objType objType ] [-objTypeList]

[-outFile filename] [-outLimit number] [-retryTime seconds]

[-timeout seconds]



-rev Displays the eHealth software revision information.

-host hostname Specifies the name of the Distributed eHealth System that you want to compare for duplicate objects with the local system. This argument is required unless you specify -all.

-all Compares all other Distributed eHealth Systems with the local system to locate duplicate objects. This argument is required unless you specify -host.

-objTypeAll Identifies duplicates among all object types. This is the default.


Alphabetical List



-objType objType Identifies duplicates in the specified object type. You can select one of the following object type values:

■ element

■ group

■ groupList

■ serviceProfile


-outFile filename Sends the command output to the specified file named filename. The file contains data in comma-separated value (CSV) format. If you do not specify an output file, the command outputs data to standard output (usually the command line).

-outLimit number Specifies the maximum number of duplicate objects to display. The default is 10,000 objects. If you specify 0, the command displays all of the duplicate objects.

-retryTime seconds


If you specify a value, it should be less than the -timeout value. The default is 0, which indicates that the local system will not retry the command.

-timeout seconds Specifies the time in seconds to wait for the command to finish. If the time expires before the command finishes, the command stops and returns an error.

The default is 30 seconds. You can specify another value using this argument or change the default using the NH_CLUSTER_CMD_TIMEOUT environment variable.

Alphabetical List

Examples:

The following command checks all systems in the cluster for duplicate objects and displays the information for any duplicates found: nhFindDupObjects -all -objTypeAll

Cluster Find Duplicates initiated:

Querying cluster ... OK

finding duplicate elements on shaggy DONE

finding duplicate elements on eire DONE

finding duplicate elements on baffin DONE

finding duplicate group names on local machine DONE

finding duplicate group list names on local machine DONE

finding duplicate service profile names on local machine DONE

oak-sh,eire,06-12-01 12:04:06

oak-sh,shaggy,07-17-01 14:40:33

enid-sh,eire,06-12-01 12:04:04

enid-sh,shaggy,07-17-01 14:40:32

barney-sh,eire,06-12-01 12:04:03

barney-sh,shaggy,07-17-01 14:40:32

voyager-rh,eire,06-12-01 12:04:09

voyager-rh,shaggy,07-17-01 14:40:34

(element list abbreviated for documentation readability)

SUMMARY:

Member Name # of Duplicates

---------------+--+---------------

shaggy 41

eire 83

baffin 59

You can use the command to identify the duplicate objects in your cluster and remove them. Duplicate groups, group lists, and service profiles typically occur when eHealth administrators or scheduled processes create objects with the same name on multiple cluster systems. Duplicate elements typically occur when several Distributed eHealth Systems discover and poll the same elements. For example, the systems eire and shaggy are both polling a system named oak. The information on shaggy has a more recent timestamp than the information on eire, so shaggy has more up-to-date element information. You should delete one of the oak-sh system elements to free up the poller license and reduce duplicate data in your distributed reports.

Default: The command shows up to 10,000 duplicate objects. You use the -outLimit argument to specify the number of duplicate objects that the command displays. If you specify a value of 0, the command displays all duplicate objects. If you specify a value such as 1,000, and there are actually more than 1,000 duplicates, the command displays the following message: **** WARNING: the # of duplicates has exceeded the output limit of 1000 ****


Alphabetical List

nhFindElement

Displays information displays information about the Distributed eHealth System that polls and collects data for a specific element.

This command has the following format: nhFindElement [-h] [-rev] { -name elementName | -alias aliasName }

[-outFile pathname]




-name elementName

Specifies the element name of the element that you want to find. The search is case-sensitive. If you have an element named Boston-WAN-12, you must specify the name exactly.

You can specify an asterisk (*) or a percent sign (%) as a wildcard character (0n UNIX systems, if you use the asterisk as a wildcard, you must enclose the value of -name in double quotation marks). For example, if you specify the string Boston* or Boston%, the command locates all elements that have element names that begin with the characters Boston (but not boston or BOSTON).

-alias aliasName Specifies the alias of the element that you want to locate. You can specify an asterisk (*) or a percent sign (%) as a wildcard character.

-outFile pathname Sends the command output to the specified file name. If you do not specify an output file, the command outputs data to standard output (usually the command line).

eHealth administrators can run the command from any eHealth system in the cluster. If you use a wildcard in the -name or -alias argument, note that the command returns up to 100 elements that match the wildcard.

The command output displays the following information:

Element Name

Name of the element as defined in the poller configuration of the eHealth system.

Mach Name (Type)

Hostname and type (either console or server) of the eHealth system that polls the element.


Alphabetical List

Elem Type

Type of the element.

IP Address

IP address associated with the element.

Date Last Modified

Date that the element information was last changed.

If the command displays multiple elements, the elements appear in the following order:

1. Alpha-numeric order by name

2. For elements with the same name, in alpha-numeric order by member name

3. For elements with the same name and member name, by element type

If the command cannot find an element that matches the input search string, the command displays the message “No match.”

Examples:

■ The following command displays information about the element named OAK-SH:

nhFindElement -name OAK-SH

searching...

ELEMENT NAME MACH NAME(TYPE) ELEM TYPE IP ADDRESS DATE LAST MODIFIED

============ =============== ========= ========== ==================

OAK-SH eire(server) sysEdgeNtSystem 192.124.15.8 06-12-01 12:04:06

OAK-SH shaggy(server) sysEdgeNtSystem 192.124.15.8 06-12-01 12:04:06

ERRORS:

NONE


Alphabetical List

■ The following command displays up to 100 elements that match the name string OAK-SH- C. When you use a wildcard character in the search information, note that the command displays the number of matches for the total number of elements on each cluster system.

nhFindElement -name OAK-SH-C%

searching...


============ =============== ========= ========== ==================

OAK-SH-C: eire(server) sysEdgeUnixUserPartition 192.124.15.8 07-17-01

13:26:40

OAK-SH-C: shaggy(server) sysEdgeUnixUserPartition 192.124.15.8 07-17-01

14:40:33

OAK-SH-C: solomon(console) sysEdgeUnixUserPartition 192.124.15.8 07-18-01

23:01:11


13:05:37

OAK-SH-C: tigger(console) sysEdgeUnixUserPartition 192.124.15.8 07-18-01

23:00:51


13:05:36

OAK-SH-Cpu-1 eire(server) systemCpu 192.124.15.8 07-17-01 13:26:40

OAK-SH-Cpu-1 shaggy(server) systemCpu 192.124.15.8 07-17-01

14:40:33

OAK-SH-Cpu-1 solomon(console) systemCpu 192.124.15.8 07-18- 01

23:01:11


13:05:37

OAK-SH-Cpu-1 tigger(console) systemCpu 192.124.15.8 07-18-01

23:00:51


13:05:36

solomon(console) had 4 matches out of 2099 total elements.

eire(server) had 2 matches out of 351 total elements.

baffin(server) had 0 matches out of 1687 total elements.

tigger(console) had 4 matches out of 2099 total elements.

shaggy(server) had 2 matches out of 61 total elements.

ERRORS:

NONE


Alphabetical List

nhGenDataSourceInfo

Regenerates the d:/eHealth/poller/dataSourceInfo.ddi file based on the existing management information base (mib) translation files (mtf's). The resulting file is required by the Path Manager user interface to create path elements.

Note: This script should be rerun whenever mtf files for paths are modified or added.

This command has the following format: nhGenDataSourceInfo [-h] [-rev] [-o filename]




-o filename (Optional) Sends output to the specified file.

nhGetClusterPasswd

Displays the cluster password used in a Distributed eHealth cluster. To obtain a copy of the command, contact your eHealth Sales Engineer or Technical Support. Specify the operating system of your eHealth platform to ensure that you receive the correct executable file. Save the command in the ehealth/bin directory.

Important! If you include the nhGetClusterPasswd command in your ehealth/bin directory (where ehealth represents the eHealth installation directory), any user who logs in as an eHealth administrator to that system (or any user with access to the eHealth system) can display the cluster password.

This command has the following format: nhGetClusterPasswd [-h] [-rev]





Alphabetical List

nhGetFile

Retrieves a specified file from one or more eHealth systems in a Distributed eHealth cluster and saves it on the local system. The nhGetFile command can retrieve files only from the ehealth directory or its subdirectories of the specified eHealth systems.

This command has the following format: nhGetFile [-h] [-rev] { -host hostname | -cluster | -all }

-fromFile remoteFilePath -toFile localFilePath

[-overwrite] [-retryTime seconds]




- host hostname Retrieves the specified file name in -fromFile from the eHealth system named hostname. This argument is required unless you specify -cluster or - all.

- cluster Retrieves the specified file name in -fromFile from all systems in the cluster except the local system. This argument is required unless you specify -host or -all.

- all Retrieves the specified file name in -fromFile from all systems in the cluster. This argument is required unless you specify -host or - cluster.

- fromFile remoteFilePath

Specifies the full pathname of the file to retrieve. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

- toFile remoteFilePath

Specifies the full pathname of the destination file; this is the file that will be created (or overwritten) on the local system. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

- overwrite Specifies that the retrieved file should overwrite the local file specified in -toFile, if one exists.

- retryTime seconds


The default is 0, which indicates that the local system will retry the command until it succeeds.


Alphabetical List

Example:

The following command copies the file messages.stats.log from all systems in the cluster to the local system and saves them in the NH_HOME/tmp directory: nhGetFile -all -fromFile '$(NH_HOME)/log/pollerStatus/messages.stats.log' \

-toFile '$(NH_HOME)/tmp/pollerMsgs.log.$(remoteHostname)'

nhGetIscRouterCfg

Extracts the configuration information for routers and router interfaces in your VPN. You can run variants of this command to create groups and group lists for this information.

nhGetIscSlaConfig

Extracts the configuration information for SA Agents. You can run variants of this command to create groups and group lists for this information.

nhGetRespLimit

Evaluates and recommends response limit values for a group of response path elements. It uses a Top N report to calculate the average response time for the group over a specified time period. The command also recommends a response time limit value based on the average response multiplied by a limit factor.

To use the nhGetRespLimit command, enter nhGetRespLimit at the command line and respond to each prompt.

nhGetSupportInfo

Collects important troubleshooting files from an eHealth system and saves them in the ehealth/tmp/diagnostics_string_date_time.zip file, where:

ehealth

Represents the eHealth installation directory.

string_date_time

Represents the current time, expressed in the format: 'YYMMDD_hhmmss.'


Alphabetical List

The diagnostics_string_date_time.zip file contains the specified log files. This command also returns the current time, all environment variables, and the nethealthrc.csh* files (on UNIX systems).

Important! Use this command under the supervision of Technical Support.

This command has the following format: nhGetSupportInfo [-h] [-host hostname | -cluster | - all]

[-list] [callTicketNum value] [dir directory]

[-slient] [-type type1[, ...]]



-host hostname or -cluster or -all

(Optional) Specifies the systems from which eHealth gathers the information. You can specify one of the following:

-host hostname – Collects data from the specified cluster system.

-cluster – Collects data from all members of an eHealth cluster except the local system.

-all – Collects data from all cluster members.

If you omit these arguments, the command collects information from the local system.

- cluster (Optional) Collects data from all members of an eHealth cluster except the local system. You can specify this argument if you do not specify -host or -all.

-all (Optional) Collects data from all cluster members. You can specify this argument if you do not specify -host or - cluster.

-list (Optional) Lists the valid information types to use with the -type argument.

- callTicketNum value

(Optional) Specifies an identifier, usually a call ticket number, to include as part of the file name.

-dir directory (Optional) Specifies the directory in which to place the troubleshooting file.

-silent Logs messages to the $NH_HOME/log/nhiGetSupportInfo.log file instead of to the screen.


Alphabetical List



-type type1[, ...] Retrieves specified information types. Run the command with the –list option to get the list of valid types. You can include multiple types in a comma separated list enclosed in double quotes.

Technical Support may supply a 'custom' type, if needed.

nhGetVpnscRouterConfig

Creates a file containing a list of VPN Solutions Center router elements. You can use the resulting file as input to the nhConfig command to import these elements into your eHealth poller configuration.

nhGetVpnscSlaConfig

Creates a file containing a list of VPN Solutions Center service level agreement (SLA) elements. You can use the resulting file as input to the nhConfig command to import these elements into your eHealth poller configuration as response endpoints and paths.

nhGroup

Organizes elements into groups and performs functions on existing groups.

Note: In Distributed eHealth, to differentiate between two identically-named groups or group lists on different Distributed eHealth systems, specify the cluster member ID with the group name using the following format: groupName@memberID. To determine the member ID, run the nhListClusterMembers command with the -host hostname argument. This cluster syntax is valid for all nhGroup arguments except -create.

Alphabetical List


nhGroup [ -rev ] [ -h ] [ -verify ]

{ -create { -groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-delete {-groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-list [ -hasMember ] {-groups "groupName,groupName,groupName" | - groupFile

filename | -groupStdin } |

-modify {-groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-insertMembers { -groups "groupName,groupName,groupName" | - groupFile filename |

-groupStdin }

{ { -elements "elementName,elementName,elementName" | -elementFile

elementFilename |

-elementStdin } |

[ -fromGroups "groupName,groupName,groupName" ] }

-removeMembers { -groups "groupName,groupName,groupName" | - groupFile

groupFilename | -groupStdin }

{ -elements "elementName,elementName,elementName" | -elementFile elementFilename

| - elementStdin } }




-create Creates new groups.

-delete Soft deletes groups from the eHealth database.

-list Lists all groups that currently exist within the eHealth database.

-modify Changes attributes of a group.

-groups "groupName,groupName,groupName"

Specifies the names of multiple groups to create. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Alphabetical List



-groupFile groupFilename

Specifies the name of the file that contains the list of groups to act upon. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups to act upon via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-insertMembers Adds specified elements to existing groups. If the group does not exist, eHealth creates it.

-removeMembers Removes specified elements from groups.

-hasMember Lists those groups that include the specified element.

-verify Does not commit changes to be executed by any of the following arguments: - create, -delete, -modify, -insertMembers, or - removeMembers.

Create Groups

You can use nhGroup to organize your elements into one or more groups. If you need to create multiple groups, you can specify the group names in a file and specify the filename as input for the command.

Note: This argument does not accept cluster syntax for group names.

This command has the following format: nhGroup -create { -groups "groupName,groupName,groupName" | - groupFile



-create Creates the specified groups.

Alphabetical List




Specifies the names of the groups that you want to create. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to create. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups that you want to create using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -create argument.

Examples:

■ The following example creates a single group called Boston:

nhGroup -create -groups Boston

■ This example creates several groups named NewYork, Boston, and Tokyo:

nhGroup -create -groups "NewYork,Boston,Tokyo"

Modify Groups

You can use nhGroup to modify the attributes of one or more groups. If you need to modify multiple groups, you can specify the group names in a file and specify the filename as input for the command.

This command has the following format: nhGroup -modify { -groups "groupName,groupName,groupName" | - groupFile

groupFilename | -groupStdin - showDciFields | -fieldName fieldName - value value

}

Alphabetical List


-modify Modifies the specified groups.


Specifies the names of multiple groups that you want to modify. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to modify. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups that you want to modify via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-showDciFields Outputs a list of group DCI field names that you can change.

-fieldName fieldName

Specifies the DCI field corresponding to the attribute that you want to modify.

-value value Specifies the new value that you want to apply to the specified attribute.

-verify Does not commit changes to be executed by the -modify argument.

Examples:

■ The following example renames a group from Boston to Sydney:

nhGroup -modify -groups Boston -fieldName name -value Sydney

■ This example modifies the description field for a set of groups.

nhGroup -modify -groups "group1,group2,group3" -fieldName description

-value "Supports the Boston office"


Alphabetical List

Delete Groups

You can use nhGroup to delete one or more groups. If you need to delete multiple groups, you can specify the group names in a file and specify the filename as input for the command.

This command has the following format: nhGroup -delete { -groups "groupName,groupName,groupName" | - groupFile



-delete Deletes the specified groups.


Specifies the names of the groups that you want to delete. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to delete. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups that you want to delete via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -delete argument.

Examples:

■ The following example deletes a single group called Boston:

nhGroup -delete -groups Boston

■ This example deletes several groups named NewYork, Boston, and Tokyo:

nhGroup -delete -groups "NewYork,Boston,Tokyo"


Alphabetical List

List Groups

Use the -list argument with the nhGroup command to list existing groups in the eHealth database, identify the groups that belong to set of group lists, and identify the groups that contain a specified element.

Examples:

■ The following example lists all groups contained in an eHealth database:

nhGroup -list

■ The following example lists all groups belonging to a specified set of group lists:

nhGroup -list -groupLists "GroupList1, GroupList2, GroupList3"

■ The following example lists all groups that contain a particular element as a member:

nhGroup -list -hasMember Element1

Add Members to a Group

Use the -insertMembers argument with the nhGroup command to add elements to specified groups. If the group does not exist, eHealth creates it automatically.


nhGroup -insertMembers

{ -groups "groupName,groupName,groupName" | - groupFile groupFilename | -

groupStdin }

{ -elements "elementName,elementName,elementName" | -elementFile

elementFilename |

-elementStdin | -fromGroups "groupName,groupName,groupName" }


-insertMembers Adds specified elements to specified groups.


Specifies the names of multiple groups to which you want to add elements. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Alphabetical List




Specifies the name of the file that contains the list of groups to which you want to add elements. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups to which to add elements using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-elements "elementName,elementname,elementName"

Specifies the elements that you want to add to the specified groups. If you specify a single element name, do not enclose it in quotation marks. If you specify multiple element names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

elementFile elementFilename

Specifies the element files that you want to add to the specified groups.

elementStdin Specifies the elements that you want to add to the specified groups using standard input.

-fromGroups "groupName,groupName,groupName"

Specifies the list of groups from which you want to copy members.

-verify Does not commit changes to be executed by the -insertMembers argument.

Alphabetical List

Examples:

■ The following example adds one element to a group Boston using standard input:

nhGroup -insertMembers -groups Boston -elementStdin

element1

^D

■ This example adds two elements to several groups using standard input:

nhGroup -insertMembers -groups Boston,Tokyo,Sydney -elementStdin

elementName1

elementName2

^D

■ This example adds elements from the Boston group to the Sydney group: nhGroup -insertMembers -groups Sydney -fromGroups Boston

Delete Members from a Group

Use the -removeMembers argument with the nhGroup command to remove elements from specified groups.

This command has the following format: nhGroup -removeMembers { -groups "groupName,groupName,groupName" | - groupFile



| - elementStdin }


- removeMembers Removes specified elements from specified groups.


Specifies the names of multiple groups from which you want to delete elements. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups from which you want to delete elements. The file must have the following format:

name

name

...

name


Alphabetical List



-groupStdin Specifies the list of groups from which you want to delete elements using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-elements "elementName,elementname,elementName"

Specifies the elements that you want to remove from the specified groups. If you specify a single element name, do not enclose it in quotation marks. If you specify multiple element names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

-elementFile elementFilename

Specifies the element filenames that you want to remove from the specified groups.

-elementStdin Specifies the elements that you want to remove from the specified groups using standard input.

-verify Does not commit changes to be executed by the - removeMembers argument.

Examples:

■ The following example removes a list of elements from a group Boston using an input file:

nhGroup -removeMembers -groups Boston -elementFile List1

■ This example removes elements from several groups using standard input:

nhGroup -removeMembers -groupStdin -elements system1,system2,system3"

group1

^D

Alphabetical List

nhGroupList

Organizes groups into groupLists and perform functions on existing groupLists.

Note: In Distributed eHealth, to differentiate between two similarly named group lists on different Distributed eHealth systems, specify the cluster member ID with the group list name using the following format: grouplistName@memberID. To determine the member ID, run the nhListClusterMembers command with the -host hostname argument. This cluster syntax is valid for all nhGroupList arguments except -create.


nhGroupList [ -rev ] [ -h ] [ -verify ]

{ -create { -groupLists "groupListName,groupListName,groupListName" | -

groupListFile groupListFilename | - groupListStdin } |

-delete { -groupLists "groupListName,groupListName,groupListName" | -


-list |

-modify [-showDciFields] { -groupLists

"groupListName,grouplistName,groupListName" | -groupListFile groupListFilename |

- groupListStdin -fieldName fieldName -value value } |

-insertMembers { -groupLists "groupListName,groupListName,groupListName" | -

groupListFile groupFilename | - groupListStdin }


groupStdin } |

-removeMembers { -groupLists "groupListName,groupListName,groupListName" | -

grouplistFile groupListFilename | - groupListStdin } { -groups

"groupName,groupName,groupName" | - groupFile groupFilename | -groupStdin } }




-create Creates new groupLists.

-delete Deletes groupLists from the eHealth database.

-list Lists all groupLists that currently exist within the eHealth database.

-modify Changes attributes of a groupList.


Alphabetical List



-groupLists "groupListName,groupListName,groupListName"

Specifies the names of multiple groupLists that you want to act upon. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple group list names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

-groupListFile groupListFilename

Specifies the name of the file that contains the list of groupLists that you want to create. The file must have the following format:

name

name

...

name

-groupListStdin Specifies the list of groupLists that you want to act upon using standard input. Use ^D to exit. The specification must have the following format:

name

name

...


Specifies the names of multiple groups that you want to add to or remove from a groupList. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to add or remove. The file must have the following format:

name

name

...

name

Alphabetical List



-groupStdin Specifies the list of groups that you want to add or remove via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-insertMembers Adds specified groups to an existing groupList. If the groupList does not exist, eHealth creates it.

-removeMembers Removes specified groups from a groupList.

-verify Does not commit changes to be executed by the -create, -modify, -delete, -removeMembers, or -insertMembers arguments.

Create GroupLists

You can use nhGroupList to organize your groups into one or more group lists. If you need to create multiple group lists, you can specify the names in a file and specify the filename as input for the command.

Note: This argument does not accept cluster syntax for group list names.

This command has the following format: nhGroupList -create { -groupLists "groupListName,groupListName,groupListName" |

-groupListFile groupListFilename | - groupListStdin } [ -verify ]


-create Creates the specified groupLists.


Specifies the names of multiple groupLists that you want to create. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple groupList names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

Alphabetical List





name

name

...

name

-groupListStdin Specifies the list of groupLists that you want to create via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -create argument.

Examples:

■ The following example creates a single group list called Boston:

nhGroupList -create -groupLists Boston

■ This example creates several group lists named NewYork, Boston, and Tokyo:

nhGroupList -create -groupLists "NewYork,Boston,Tokyo"

Modify GroupLists

You can use nhGroupList to modify one or more group lists. If you need to modify multiple groupLists, you can specify the groupList names in a file and specify the filename as input for the command.

This command has the following format: nhGroupList -modify [-showDciFields] { -groupLists

"groupListName,groupListName,groupListName" | -groupListFile groupListFilename |

- groupListStdin -fieldName fieldName -value value } [ - verify ]


-modify Modifies the specified groupList.

Alphabetical List




Specifies the names of multiple groupLists that you want to modify. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple groupList names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groupLists that you want to modify. The file must have the following format:

name

name

...

name

-groupListStdin Specifies the list of groupLists that you want to modify using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-fieldName fieldName Specifies the DCI field corresponding to the attribute that you want to modify.

-value value Specifies the new value to apply to the specified attribute.

-verify Does not commit changes to be executed by the -modify arguments.

Examples:

■ The following example renames a group list from Boston to Sydney:

nhGroupList -modify -groupLists Boston -fieldName name -value Sydney

■ This example modifies the description field for a set of groupLists.

nhGroupList -modify -groupLists "groupList1,groupList2,groupList3" -

fieldName description

-value "Supports the Boston office"

Delete GroupLists

You can use nhGroupList to delete the attributes of one or more groupLists. If you need to delete multiple groupLists, you can specify the groupList names in a file and specify the filename as input for the command.

Alphabetical List

This command has the following format: nhGroupList -delete { -groupLists "groupListName,groupListName,groupListName" |

-groupListFile groupListFilename | - groupListStdin } [ -verify ]


-delete Deletes the specified groupLists.


Specifies the names of multiple groupLists that you want to delete. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple groupList names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groupLists that you want to delete. The file must have the following format:

name

name

...

name

-groupListStdin Specifies the list of groupLists that you want to delete using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -delete argument.

Examples:

■ The following example deletes a single groupList called Boston:

nhGroupList -delete -groupLists Boston

■ This example deletes several groupLists named NewYork, Boston, and Tokyo:

nhGroupList -delete -groupLists "NewYork,Boston,Tokyo"

List GroupLists

Use the -list argument with the nhGroupList command to list all existing groupLists in the eHealth database.


Alphabetical List

Example:

The following example lists all groupLists contained in an eHealth database:

nhGroupList -list

Add Members to a GroupList

Use the -insertMembers argument with the nhGroupList command to add groups to specified groupLists. If the groupList does not exist, eHealth creates it automatically.

This command has the following format: nhGroupList -insertMembers { -groupLists

"groupListName,groupListName,groupListName" |

-groupListFile groupFilename | - groupListStdin } { -groups {

"groupName,groupName,groupName" |

-groupFile groupFilename | -groupStdin } [ - verify ]


-insertMembers Adds specified groups to specified groupLists.


Specifies the names of multiple groupLists to which you want to add groups. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple groupList names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

-groupListFile groupFilename

Specifies the name of the file that contains the list of groupLists to which you want to add groups. The file must have the following format:

name

name

...

name

-groupListStdin Specifies the list of group lists to which you want to add groups using standard input. Use ^D to exit. The specification must have the following format:

name

name

...


Alphabetical List




Specifies the names of multiple groups to be added to the specified groupLists. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to add to the specified groupLists. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups that you want to add to the specified groupLists using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -insertMembers argument.

Examples:

■ The following example adds groups to a groupList Boston using standard input:

nhGroupList -insertMembers -groupLists Boston -groupStdin

group1

group2

^D

■ This example adds groups to several groupLists using standard input:

nhGroup -insertMembers -groupLists Boston,Tokyo,Sydney -groupStdin

group1

^D

Alphabetical List

Delete Members from a GroupList

Use the -removeMembers argument with the nhGroupList command to remove groups from specified groupLists.

This command has the following format: nhGroupList -removeMembers

{ -groupLists "groupListName,groupListName,groupListName" | -groupListFile

groupFilename | - groupListStdin }


groupStdin } [ - verify ]


- removeMembers Removes specified groups from specified groupLists.


Specifies the names of multiple groupLists to which you want to remove groups. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple groupList names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.

-groupListFile groupFilename

Specifies the name of the file that contains the list of groupLists from which you want to remove groups. The file must have the following format:

name

name

...

name

-groupListStdin Specifies the list of groupLists from which you want to remove groups using standard input. Use ^D to exit. The specification must have the following format:

name

name

...


Specifies the names of multiple groups that you want to remove from the specified groupLists. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Alphabetical List




Specifies the name of the file that contains the list of groups that you want to remove from the specified groupLists. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups that you want to remove from the specified groupLists using standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-verify Does not commit changes to be executed by the -removeMembers argument.

■ The following example removes groups from the groupList Boston using an input file:

nhGroupList -removeMembers -groupLists Boston -groupFile List1

■ This example removes groups from several groupLists using standard input:

nhGroupList -removeMembers -groupListStdin -groups "system1,system2,system3"

nhHaSetup

Configures an existing eHealth system to be managed by high availability clusterware, such as Sun Cluster software.


nhHaSetup [-h] [-rev] -hostname sharedHost [-list] [-disable]




Alphabetical List



- hostname sharedhost

(Required) Specifies the name of the shared host where eHealth is running. This is the resource that will be managed by the high availability clusterware solution. In the event of a failover, the clusterware will move the instance of this name from this host to the failover host.

-list (Optional) Displays the name of the shared host the eHealth system is currently set to.

- disable (Optional) Removes the high availability configuration setting.

Examples:

■ To configure eHealth to support shared hostnames and run in a high availability cluster, enter the following command:

$NH_HOME/bin/nhHaSetup -hostname sharedhost

■ To remove eHealth from a high availability configuration, enter the following command:

nhHaSetup -disable

nhHttpd

Starts or stops the eHealth Web server. This command works on UNIX systems only. To stop the eHealth httpd service on Windows systems, use the Control Panel Services utility.





start Starts the eHealth Web server.

stop Stops the eHealth Web server.

Alphabetical List

nhHttpdCfg

Reconfigures the eHealth Web server. You typically use this command as part of a software upgrade or when directed by Technical Support to correct potential Web problems. After reconfiguring the eHealth Web server with nhHttpdCfg, use the nhHttpd command with the start argument to restart it.

This command has the following format: nhHttpd [-h] -user ehUser -grp NH_USERgroupName

-nhDir rootEhealthDir [-protect | -noProtect]

[-enableProxy | -noEnableProxy]

[- outfile filename]



-user ehUser Specifies the name of the eHealth user account.

-grp NH_USERgroupName

On UNIX, specifies the primary group name of the eHealth user account. On Windows, specifies Administrators, the group to which the eHealth user belongs.

-nhDir rootEhealthDir Specifies the full path to the eHealth root directory using a UNIX-style pathname (with forward slashes instead of backslashes).

-protect or -noProtect

-protect enables Web security, requiring users to enter a password to log in to the eHealth Web interface. This is the default.

-noprotect disables Web security; the eHealth Web interface does not prompt users for a password when they log in.

Note: The - noprotect argument enables free access to all reports without a login.

This argument corresponds to the Enable Web Security setting on the Site Configuration page of the eHealth Web interface.


Alphabetical List



-enableProxy or -noEnableProxy

-enableProxy saves the URL when running a Web report and saving it in a file. This allows eHealth to display the report when it is finished.

-noenableProxy disables this feature. This is the default.

Use this argument when the eHealth Web interface runs on a proxy server that hides true IP addresses from the Internet Explorer browser. (This setting does not apply to Netscape.)

This argument corresponds to the Enable Proxy Redirect setting on the Site Configuration page of the eHealth Web interface.

- outfile filename Directs the command output to the specified file. Typically, the filename path should be ehealth/web/httpd/httpd.conf.

If you do not specify - outfile, the command directs the output to standard output (stdout).

Example:

The following command reconfigures the eHealth Web server on a Windows system: nhHttpdCfg -user nhuser -grp Administrators \

-nhDir D:/ehealth \

-cfg D:/ehealth/web/webCfg/users.cfg \

-outfile D:/ehealth/web/httpd/httpd.conf

nhImportCalendarCfg

Imports calendar configuration information for partial-day support to eHealth from a Calendar DCI file. For the complete syntax, see the eHealth Data Integration Guide.

nhImportData

Imports the following types of information to your eHealth database:

■ Statistical data about your resources

■ Conversations data transferred between node pairs on your network

You can then use eHealth to report on this data. For the complete syntax, see the eHealth Data Integration Guide.

Alphabetical List

nhImportDowntime

Imports a summary of all planned downtime into the eHealth database. You can also use this command to import a summary of planned downtime that has already occurred. eHealth rounds planned downtime to the nearest minute.

This command has the following format: nhImportDowntime [-h] [-rev] filename.pdi





filename.pdi Specifies the name of the file that contains all planned downtime or outages.

- host hostname In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to import the planned downtime file.

- cluster In a Distributed eHealth cluster, imports the planned downtime file to all eHealth systems in the cluster except the local system.

- all In a Distributed eHealth cluster, imports the planned downtime file to all eHealth systems in the cluster.

Set Up Planned Downtime in a Cluster

You can set up planned downtime on individual Distributed eHealth systems in a cluster using the nhImportDowntime command; however, this command is not "cluster aware." Each Distributed eHealth system must have a unique .pdi file for all planned downtime elements being polled on that system. You should not replicate planned downtime settings for individual Distributed eHealth systems to other machines to account for planned downtime on those systems.

Note: If you move the settings to another machine, the load will fail. The elements do not exist on the other machine, so the existing planned downtime at that machine may be lost.

The -cluster argument is not useful for importing downtime to Distributed eHealth systems, and it is not recommended. The -cluster argument is only useful if you launch the command from a central location in the cluster to take effect at remote systems.


Alphabetical List

To set up planned downtime in a cluster

1. Define outages within a .pdi file for each element for the given Distributed eHealth system. For instructions, see the section on accounting for planned downtime in the eHealth Reports User and Administration Guide.

2. Import the downtime schedule for the system into the eHealth database by entering the following:

nhImportDowntime filename.pdi -host distributedeHealthSystemName

Note: If you are running this command from the actual Distributed eHealth system, you can omit the -host argument; otherwise, you must specify it.

3. Repeat Steps 1 and 2 for each Distributed eHealth system in the cluster.

nhImportImPollerStatus

Restores the IM poller status files. By default, the files are restored to d:/eHealth, but you can use the -nhHome option to specify a different path name. This command complements the nhImportImPollerStatus command. For the complete syntax, see the eHealth Data Integration Guide.

nhImportLiveExCfg

Imports Live Exceptions configuration information into the eHealth database from a DCI file. For the complete syntax, see the eHealth Data Integration Guide.

nhImportSnmpKeyInfo

Imports SNMPv3 key configuration information from a DCI file into the eHealth database. You can then use eHealth to discover and report on SNMPv3 elements. For more information about this command, see the eHealth Data Integration Guide.

nhImportWebAcct

Uses a DCI file that contains Web user account configuration information to create a new Web user profile, users.cfg. It then saves the previous version of the profile as users.cfg.bak. The command can also copy user Web reports from a file. For the complete syntax, see the eHealth Data Integration Guide.


Alphabetical List

nhJoinCluster

Adds the local eHealth system to an existing Distributed eHealth cluster and synchronizes the system with the other systems in the cluster. When a cluster does not yet exist (that is, you are adding the first eHealth system in the cluster), the command establishes internal tables used by the cluster.

When using this command, follow these guidelines:

■ Before you run this command, close the eHealth console, any secondary eHealth consoles, and any open Live Health applications. This ensures that eHealth updates the object IDs on the local system with the cluster information. You can restart these applications after you join the system to the cluster.

■ Ensure that the first system that you add to a cluster is a trusted member. If your first system is a non-trusted member, eHealth will not allow any other systems to join the cluster.

■ Always add one eHealth system at a time. Allow the nhJoinCluster command to finish before you run the command on another eHealth system that you want to add to the cluster.

■ Specify a password composed of one to eight characters. If you specify more than eight, the command displays an error.

■ When you add the first cluster member, add the password at the appropriate prompt; then specify the same cluster password for each subsequent member.

■ Do not remove a cluster member from one cluster and add it to another cluster without first wiping its database.

This command has the following format: nhJoinCluster [-h] [-rev]

{ -host hostname [-useStdDac yes | no] | - firstMember }

[-ipAddress address] [-contacts contact1,contact2,...]

[-trusted yes | no] [-id id] [-retryTime seconds]

[-timeout seconds]




- host hostname Specifies the hostname of a trusted system already in a cluster that you want to join. This argument is required unless you specify - firstMember.


Alphabetical List



- useStdDac For each additional eHealth system that you add to the cluster, specifies whether the cluster should use the Standard service profile defined on this eHealth system, or whether the eHealth system should use the Standard service profile settings of the -host system. The valid values are yes and no.

If you specify yes, the Standard service profile on the local system will be replicated to all of the other cluster members. That is, the Standard service profile will overwrite the Standard profiles on all of the other cluster members. If you specify no, the Standard service profile used by the -host system will overwrite the Standard profile on the local system.

You cannot specify this argument if you also specify the -firstMember argument.

- firstMember Specifies that this is the first member in the cluster. You cannot specify this argument if you specify -host. The first system you add to a cluster must be a trusted system.

- ipAddress address

Specifies the IP address of the system that you are adding to the cluster. The default is the IP address of the local system.

- contacts contact1, contact2, ...

Specifies the names or e-mail addresses of the contacts for the system that you are adding to the cluster.

- trusted yes | no

Specifies whether the system that you are adding is a trusted member of the cluster. The default is yes.

If you specify the -firstMember argument, do not specify a value of no for -trusted.

-id id Specifies a unique member ID number for the system that you are adding. If you do not specify an ID, the default is based on the IP address of the system that you are adding.

Note: Never change the member ID of a system.

- retryTime seconds



Alphabetical List



- timeout seconds

Specifies the time in seconds to wait for the command to finish. If the time expires before the command finishes, the command stops and returns an error.


Examples:

■ To add the first member of a cluster, log in to the eHealth system that you want to add to the cluster and run a command similar to the following:

nhJoinCluster -firstMember

This command adds the local system to the cluster as the first cluster member. The command uses the default values for the IP address (the local system’s IP address), trusted (yes), member name (hostname), and member ID (a unique string derived from the IP address).

■ To add the next member, log in to the that eHealth system and run a command similar to the following, where hostname is the hostname of the system that you added as the first member:

nhJoinCluster -host hostname - useStdDac yes

■ To add any subsequent members, log in to each system and run the same command. For the hostname value, you can specify the hostname of any trusted system already in the cluster.

nhListAppTypes

Displays the application types that are defined in your eHealth object model.

This command has the following format: nhListAppTypes [-h] [-rev] [-symbol symbolName]

[-level application | moduleSet | module] [-outFile filename] [-all]

[-recurse] [-indent] [-showLevels] [-verbose] [-csv] [- appTypeId]




- symbol symbolName

(Optional) Lists the application type for the specified entry. If you do not specify this argument, the command lists all application types by default.

Alphabetical List



-level application | moduleSet | module

(Optional) Lists all application types for the specified level. If you specify the -recurse argument with this argument, the command lists the entire hierarchy under the symbol.

- outFile filename (Optional) Specifies the name of the file to which eHealth should send output. If you do not specify a file, it sends output to standard output.

-all (Optional) Lists all applications in your hierarchy. This is the default action.

- recurse (Optional) Lists the entire hierarchy under the symbol that you specify for the -symbol or -level argument.

-indent (Optional) Prints the hierarchy with each level indented appropriately, producing a nested output. If you do not specify this argument, the command left aligns all levels.

- showLevels (Optional) Lists all levels currently defined in your object model.

- verbose (Optional) Lists all fields for an application type.

-csv (Optional) Prints the output in csv format.

- appTypeId Internal

(Optional) Prints the OM appTypeId.

Example:

The following command lists only entries of level moduleSet under the symbol named Outlook:

nhListAppTypes -level moduleSet -symbol Outlook

symbol

"Outlook-Reply"

"Outlook-ReplyAll"

"Outlook-Forward"

"Outlook-Delete"

"Outlook-New"

"Outlook-Read"

nhListArConfig

Lists an element, or all elements of a specific type, in the AR Configuration.

Alphabetical List


nhListArConfig [-h] [-rev]

[-type {agent | agentSet | server | application}]

[-name elementName] [-defaultRule] [-actualRule]

[-licenseInfo] [-long] [- verbose] [-csv] [-showHeader]





(Optional) Specifies which type of element to list. The default value is agent.

-name elementName (Optional) Specifies the name of the element to list. The default value is all elements of the specified type.

- defaultRule (Optional) Displays the default rule for the specified application. This option is valid only for -type application.

- actualRule (Optional) Displays the actual rule for the specified application. This option is valid only for -type application.

- licenseInfo (Optional) Displays the AR License information. This option is not valid with other output options.

- long (Optional) Lists more details for the selected elements.

- verbose (Optional) Lists all the fields of the selected elements; for AgentSets, lists all the associated Agents.

- csv (Optional) Lists the output in the CSV file format.

- showHeader (Optional) Shows column headers in the output.

Examples:

■ The following example lists all Agent names:

nhListArConfig

■ The following example lists all Agents and the details about them as shown in the Agents List page in the AR WebConsole:

nhListArConfig -type agent -long


Alphabetical List

■ The following example lists in CSV format all Agents and the details about them, as shown in the Agents Properties page in the AR WebConsole:

nhListArConfig -type agent -long -csv

■ The following example lists details about the application named app1:

nhListArConfig -type application -name app1

-long

■ The following example uses output from the nhListArConfig command to delete agents whose names begin with the letters “zzz”:

nhListArConfig | grep zzz | nhDeleteArConfig

-confirm no

nhListClusterMembers

Displays information about and the member table for one or more eHealth systems in a Distributed eHealth cluster. The member table contains information about each cluster system known to the local system. The command also displays information about the eHealth systems.

Note: You cannot list the member table of a system that has been removed from the cluster. You can see the removed system in another system’s member table (if you use the -includeRemoved argument).


nhListClusterMembers [-h] [-rev]

{ -host hostname | -cluster | - all }

[-nameOnly] [- includeRemoved] [-retryTime seconds]

[-timeout seconds]




-host hostname Displays the member table on the specified eHealth system. This argument is required unless you specify -cluster or -all.

-cluster Displays the member table for all eHealth systems except the local system. This argument is required unless you specify -host or -all.


Alphabetical List



-all Lists the cluster members for all eHealth systems in a cluster including the local system. This argument is required unless you specify -host or -cluster. Note that the command will not display the member table of a removed system.

- nameOnly Lists only the names of the eHealth systems in the member table. If you do not specify this option, the command also shows the member ID, member type, trusted setting, IP address, and contact information for each cluster member.

- includeRemoved Includes the eHealth systems that have been removed from the member table. If you do not specify this argument, the command lists only the active members of the table.

- retryTime seconds Specifies how long in seconds the local system will retry the command. If the command fails due to an internal problem (for example, the system connection to the network is down), eHealth reissues the command for the specified retry time.




Alphabetical List

Examples:

■ The following command lists the cluster members for each system in the cluster:

nhListClusterMembers -all

Cluster List Members initiated:

Querying cluster ..... OK

Cluster Members for host: baffin

MemberId Name MemberType Trusted IpAddress

+--------+--+-------------+--+---------+--+-----+--+-------------+

739249213 baffin server Yes 100.26.12.61

Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:

739249169 shaggy server Yes 100.26.12.17

Contacts:

739249215 solomon console Yes 100.26.12.63

Contacts:

739249177 tigger console Yes 100.26.12.25

Contacts:

Cluster Members for host: shaggy


+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:


Contacts:


Contacts:


Contacts:

(output abbreviated for documentation readability)


Alphabetical List

■ The following command lists only the member names of the systems that are in the member table of the system named baffin:

nhListClusterMembers -host baffin -nameOnly


Querying cluster . OK


eire

shaggy

solomon

tigger

■ The following command lists the removed members of the member table for the system baffin:

nhListClusterMembers -host baffin -includeRemoved




MemberId Name MemberType Trusted IpAddress Removed

+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+

739249213 baffin server Yes 100.26.12.61 No

Contacts: tester

739249216 eire server Yes 100.26.12.64 No

Contacts:

739249214 sparky server Yes 100.26.12.62 Yes

Contacts:

739249169 shaggy server Yes 100.26.12.17 No

Contacts:

739249215 solomon console Yes 100.26.12.63 No

Contacts:

739249177 tigger console Yes 100.26.12.25 No

Contacts:


Alphabetical List

nhListElementLicenses

Tracks the number of licenses that are required for all elements in your poller configuration. This command enables you to determine where to allocate licenses, what information to include in your reports, which elements you do not need to poll, and which elements you can delete. eHealth must be running when you use the nhListElementLicenses command; otherwise, you will receive an error message.

Note: You can use the nhListElementLicenses command on a standalone eHealth system or a Distributed eHealth System; however, you cannot use it on a Distributed eHealth Console.

When you run nhListElementLicenses, it displays the following information for each element license:

■ License ID is an arbitrary number that represents a single poller license. Elements that share a license have the same ID number. The number of distinct IDs indicates the number of poller licenses that you need to successfully poll all of the elements in your poller configuration. Licensed elements have a positive license ID number; unlicensed or unpolled elements have a license ID of -1; and elements that do not require a license have a license ID of 0 (zero).

■ Element name displays the name of the element.

License state displays one of the following states:

■ Free indicates that a license is not required for the element.

■ Unlicensed indicates that the element is not currently consuming a license.

■ Primary indicates that the element is the primary cause for a license to be consumed.

■ Secondary indicates that the element is sharing a license with another element, and the other element is the primary cause for the license consumption.

In some cases, two elements may share a license ID, but both elements are marked as primary. To free a license for use by another element, you must delete or disable all primary elements that share the same license ID.

Element weight displays the weight in Universal Elements (UEs). The weight is 1 or more UEs, with 1,000 EUs being the current highest number. Most elements have a weight of 1 UE. There is no distinction between licenses to poll different kinds of elements. Elements that support multiple devices are assigned higher weights to better reflect the number of devices they support. An element that supports more devices requires multiple licenses from a pool of universal poller licenses.


Alphabetical List

This command has the following format: nhListElementLicenses [-h] [-rev]

[-inFile {filename | - } ]

[-outFile filename] [- count] [-primaryOnly]




-inFile filename or -inFile –

Specifies the element names whose licenses you wish to list as follows:

- inFile filename specifies the name of a file containing the list of element names. In the file, list each element on a separate line.

- inFile – specifies that you will enter the element names using standard input, with one element name on each line.

-outFile filename Specifies the name of the file to which eHealth should send output. If you do not specify a file, it sends output to standard output.

-count Lists the total number of licenses needed to poll the elements in your poller configuration.

Note: The total number of licenses does not reflect any elements for which you have polling turned off in the poller configuration. If you want the total number of licenses for all elements, you must turn on polling for all elements before running the nhListElementLicenses command with the -count argument.

- primaryOnly Lists elements whose license status is primary.

Examples:

■ The following command generates a list of licenses and a total count of licenses required, storing the output in /tmp/license.out:

nhListElementLicenses -count -outFile /tmp/license.out

■ The following command generates a list of elements with primary licenses and a total count of licenses required, displaying the output on the screen:

nhListElementLicenses -count -primaryOnly


Alphabetical List

■ The following command obtains license information for all lanWan elements and any elements that share licenses with them, storing the results in /tmp/license.out:

nhListElements -elemType lanWan | nhListElementLicenses \

-inFile - -outFile /tmp/license.out

■ The following is a partial list produced by the nhListElementLicenses command:

-1,QUEEN-RS,unlicensed

-1,RUSTLE-PC-RS,unlicensed

-1,SING-RS,unlicensed

1,ALBERT-OPT-SH,primary

1,ALBERT-OPT-SH-C:,secondary

1,ALBERT-OPT-SH-Cpu-1,secondary

1,ALBERT-OPT-SH-D:,secondary

1,ALBERT-OPT-SH-enet-port-16777219,secondary

2,BLACK-OPT-SH,primary

2,BLACK-OPT-SH-Cpu-1,secondary

2,BLACK-OPT-SH-disk-Fixed,secondary

2,BLACK-OPT-SH-enet-port-16777221,secondary

2,KLINGER-340-SH-Cpu-1,secondary

2,KLINGER-340-SH-disk-Fixed,secondary

3,BROWN-PC-AH-IIS,primary

3,BROWN-PC-AH-IIS-ProcessSet,secondary

4,BROWN-PC-AH-NetworkSvcsNT_AD,primary

4,BROWN-PC-AH-NetworkSvcsNT_AD-ProcessSet,secondary

5,BROWN-PC-AH-NetworkSvcsNT_DNS,primary

6,BROWN-PC-AH-NetworkSvcsNT_WINS,primary


Alphabetical List

nhListElements

Displays a simple list of eHealth element names using selected criteria. You can use arguments to filter the list of elements. You can also redirect the output of this command as input to other commands to modify your poller configuration file, as described in the following command descriptions:

■ nhModifyElements

■ nhDeleteElements

■ nhGroup


The nhListElements command uses the following syntax: nhListElements [-h] [-rev] [-showTypes] [-showDciFields]

nhListElements [-elements] [-outFile filename]

nhListElements -rebooted [-outFile filename]

nhListElements –rebootedNames [-outFile filename]

nhListElements -where "whereClause" [-outFile filename]

nhListElements -elemType type [-outFile filename]

nhListElements -noDbDataFor hours [-outFile filename]

nhListElements -inGroup group [-outFile filename] [-includeChildren]

nhListElements -notInAnyGroup [-outFile filename]




- showTypes Displays a list of valid element types to use with the -elemType argument.

- showDciFields Displays the DCI attribute field names that you can use as parameters in the -where argument.

Note: The field names for the -showDciFields argument may not match the names in the standardHeader.dci file. Use this argument to determine the valid parameter names.

-elements Lists element names. This is the default.

-outFile filename Specifies the name of the file to which eHealth should send output. If you do not specify a file, eHealth sends output to standard output.


Alphabetical List



-rebooted Produces a list of IP addresses and community strings for elements that have recently experienced agent reboots. (The nhListElements command searches the messages.stats.log file in ehealth/log/pollerStatus to obtain the list of elements that have recently rebooted.) You can use the resulting file as a discovery seed file.

-rebootedNames Produces a list of element names for elements that have recently experienced agent reboots. (The nhListElements command searches the messages.stats.log file in ehealth/log/pollerStatus to obtain the list of elements that have recently rebooted.) You can use the resulting file as a discovery seed file.

Alphabetical List



-where "whereClause"

Filters the element list to include only those elements that match the criteria specified in the whereClause. Each whereClause consists of a field, relational operator, and pattern or values to match. You must enclose a whereClause in quotation marks (" "). Each whereClause must be separated by a space. If you specify multiple whereClause arguments, eHealth combines them by processing them cumulatively.

Possible fields for this argument include the following:

■ Any DCI field-Use any DCI field name from the output of the nhListElements - showDciFields command. Commonly used fields are name and alias.

■ speed | speedIn | speedOut-Use any of these fields to match the speed assigned to the element in the poller configuration, expressed in bits per second (bps).

■ altLatency-Use with the = operator and the values yes or no to filter elements based on alternate latency.

■ assocName name-assocName is a variable for one of the following: parent, respSrc, respDst, device, processSet. For example, to select elements based on parent name, specify parentName. Possible relational operators include the following: matches: =, !=, >, <, >=, <=. Use the matches operator for string comparisons, not numeric comparisons. You can use an asterisk (*) with the matches operator to match any string of characters, or a question mark (?) to match a single character.

- noDbDataFor hours Lists only those elements for which eHealth has not collected data or added it to the database for the number of hours specified, and for which there is not any alarm data. You must specify a number greater than zero.

This command allows you to produce a list of elements that eHealth is not currently polling, or elements that it is currently polling but that have poll errors. You cannot use this argument in combination with any other nhListElements argument except for -outfile. You cannot use this argument on the central site to return data in a remote polling environment. You must run it on the remote systems.

Alphabetical List



- elemType type Filters the element list so that only elements of a specific type are included in the output. This argument specifies the type of target elements. To obtain the valid list of types, use the -showTypes argument. You can specify the -where argument in combination with this argument to filter the list to show elements of a specific type and a specific name, alias, or speed. However, you cannot use this argument with a -where clause that uses an association name as a filter.

-inGroup group Lists the elements that belong to a specific group with a specified name. Specifies the exact name of the group. This argument does not support wildcards. You must specify the exact name of the group.

- includeChildren Includes children of grouped elements in the result list when specified with the -inGroup argument.

- notInAnyGroup Filters the element list to include only ungrouped elements. If you specify this argument, you cannot specify the -inGroup attribute.

Examples:

■ To list all elements and store the list in a file, enter the following:

nhListElements -outFile elements.txt

■ To list the DCI attribute field names that you can use in the whereClause of a -where argument, enter the following:

nhListElements -showDciFields

■ To store a list of all technology types in a file, enter the following:

nhListElements -showTypes -outFile types.txt

■ To list all elements with names that begin with Acme, enter the following:

nhListElements -where "name matches Acme*"

■ To list all elements that have not had any new data collected for the past four hours, enter the following:

nhListElements -noDbDataFor 4

■ To find all elements in the remote access server (RAS) group Acme whose name begins with “dialup-region-1” and whose line speed is less than or equal to 56 Kbs, enter the following:

nhListElements -inGroup Acme \

-where "name matches dialup-region-1*" \

-where "speed <= 56000"

Alphabetical List

nhListSaPaths

Displays a list of response path element names from the current eHealth configuration that belongs to a specified Service Availability test profile. To modify your eHealth configuration you can redirect the output of this command as input to the following commands: nhGroup, nhModifyElements, or nhDeleteElements.

This command has the following format: nhListSaPaths [-h]

nhListSaPaths [-outFile filename] test-profile-name



-outFile filename (Optional) Directs the output to the specified file.

test-profilename The name of the test profile that you want to list.

Examples:

■ The following example lists the paths that exist in the test profile named test_profile_A:

nhListSaPaths test_profile_A

■ The following example lists the paths that exist in the test profile named test_profile_B and sends the output to the file named pathlist.txt:

nhListSaPaths -outFile pathlist.txt test_profile_B

nhListServiceNote

Lists Business Service Console (BSC) service notes. If you do not specify any arguments for this command, it lists all Service Notes, each with its respective note ID, owner, title, application type, and last update time, from earliest to latest. You can save the output to a file.

This command has the following format: nhListServiceNote [-h]

[-noteID noteID [..,noteID] | -status {active | inactive | all}]

[-full]




Alphabetical List



-noteID noteID [..,noteID] (Optional) Specifies the ID number of the service note that you want to list. If you specify -status, you cannot use this option. By default, this command lists all service notes.

-status {active | inactive | all} (Optional) Specifies whether to list active, inactive, or all service notes. By default this command lists all service notes, regardless of status.

-full (Optional) Displays all columns for each service note specified, rather than just the columns included by defaults. The columns listed by default include: note ID, owner, title, application type, and last update time. In addition to those columns, the full column listing includes: user ID, state, create time, creator, ticket, readers, updater, and detail.

Example:

The following example lists all service notes, each with its respective note ID, owner, title, application type, and last update time.

nhListServiceNote

1000001,admin,"Response Time is Slow",voiceSvc,6/2/2004 15:47:18

1000002,admin,"Unable to Connect to Server",Telnet,6/7/2004 16:19:26

1000003,admin,"Mail Server Is Down",Outlook,6/25/2004 12:55:52

nhLiveExceptions

Starts the Live Exceptions Browser. This command is located in live/client/bin, where live represents the directory in which you installed Live Exceptions.

This command has the following format: nhLiveExceptions [-h] [-rev] [-host hostname] [- port portNumber]

[-user username] [-passwd password] [- XmxSize]

[-debug] [-jconsole]




Alphabetical List



-host hostname Specifies the hostname of the eHealth system to which you want to connect.

-port portNumber Specifies the eHealth Web port number.

-user username Specifies the name of the eHealth Web user account.

-passwd password Specifies the password of the eHealth Web user account.

- XmxSize Specifies the maximum size (in bytes) of the memory allocation pool. This value must be a multiple of 1024 greater than 2 MB. Append the letter k or K to indicate kilobytes, or m or M to indicate megabytes. The default value is 2 MB.

Examples:

-Xmx83886080

-Xmx81920k

-Xmx80m

Use this argument when you are running Live Exceptions on a Distributed eHealth Console and you receive a “running out of memory” error. Increase the value of Size to correct the problem.

-debug Internal

Runs in debug mode providing additional logging information.

-jconsole Internal

Displays debugging mode information to the Java Console.

nhLiveStatus

Starts the Live Status application. The command is located in live/client/bin, where live represents the installation directory for Live Status.

This command has the following format: nhLiveStatus [-h] [-rev]

[-host hostname] [-port portNumber]

[-user username] [-passwd password]

[-threshold value] [debug] [jconsole]

[screenSize widthXheight]

Alphabetical List








-threshold value Specifies the maximum number of elements for fixed-sized icons. Diagrams that have more than the specified number of elements will use dynamically-sized icons. The default value is 750.

nhLiveTrend

Starts the Live Trend application. This command is located in live/client/bin, where live represents the directory in which you installed Live Trend.

This command has the following format: nhLiveTrend [-h] [-rev] [-host hostname] [-port portNumber]

[-user username] [-passwd password] [-debug] [-jconsole]




-host hostname Specifies the hostname of the eHealth system.



- passwd password

Specifies the password of the eHealth Web user account.

- debug Internal



Alphabetical List



- jconsole Internal


nhLmgr

Starts, stops, and displays the status of the eHealth license manager. This command does not start or stop the license manager.

Note: Improper use of this command can cause the eHealth pollers to stop, or the servers to fail. Use this command only if you are an advanced user and are familiar with its effects.

This command has the following format: nhLmgr [-h] [start | stop | status]



start Starts the license manager. This is the default.

stop Stops the license manager.

status Displays the status of the license manager.

Examples:

■ To start the license manager, enter the following:

nhLmgr start

■ To stop the license manager, enter the following:

nhLmgr stop

■ To display status information, enter the following:

nhLmgr status

Alphabetical List

■ Sample status information for eHealth running on a Windows system follows:

License server status (License file: \home\nethealth\lmgr\license.dat):

sysname: license server UP (MASTER)

Vendor daemon status (on sysname):

ccilmgrd: UP v7.0

■ Sample status information for eHealth running on a UNIX system follows:

License server status (License file: /home/nethealth/lmgr/license.dat):



ccilmgrd

nhLoadDb

Completely replaces the contents of the current database with a saved database. This command also copies the saved report, element type, and other customized files into the appropriate directories:

■ The report, element type, and other customized files into their appropriate directories, including ehealth/extension/mibs/usr and ehealth/extension/traps/usr

■ In a remote polling environment, files in ehealth/modules/remotePoller, but not files in ehealth/modules/remotePoller/config

■ In the ehealth/poller directory, any USR-CV*.mtf and USR-CV*.pcm files

The nhLoadDb command automatically detects the version and format of the saved database, and uses the appropriate settings to load it. After loading the database, the command automatically converts it to the current database version, if needed. Only the -p argument is required to use this command.

For more information about saving and loading the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

Important! Improper use of this command can cause loss of data or reports, or stop the eHealth pollers. Use this command only if you are an advanced user familiar with its effects.


Alphabetical List


nhLoadDb [-h] [-rev] -p path [- useLCF path]

[-fullRecovery | -pointInTimeRecovery date:time] [-showRecoveryTimeRange]

[-force] [-verifyMigration] [-useStdDac] [-difUserBinLoad]

[-ascii (deprecated)] [-binary (deprecated)] [-u user (deprecated)]

[-nolog (deprecated)] [-useOldRestoreScript (deprecated)]

Note: To load a database saved in binary format, the database directory path must be the same as when it was created. Also, the database you are loading cannot be owned by root.



- rev (Optional) Displays the product version.

-p path (Required) Specifies the full pathname of the saved database that you want to load.

If you saved the database to multiple paths, enter only the first path. eHealth automatically finds the remaining paths.

Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If you used the nhSaveDb command and the resulting path (directory name) contains accented characters, you must change those characters to non-accented characters before using the nhLoadDb command.

- useLCF path (Optional) Specifies the location of an LCF file to use when loading the database.

When you use this argument, load maps the files from the saved database to the locations specified in the LCF file. You must create any paths that cannot be mapped.

If you do not specify this argument, load uses the LCF file that is in the save.

- defaultRecovery (Optional) Specifies recovery from a standard backup. The database will be restored to the time that the standard backup occurred.

- fileOnly (Optional) Specifies a files only restore, which loads the report, element type, and other customized files, but does not load the eHealth database.


Alphabetical List



- showRecoveryTimeRange (Optional) Displays the times for which point-in-time recovery is possible.

This option is only valid for incremental saves.

- skipDbRestore (Optional) Specifies a database update without a restore operation. This is performed after a manual partial restore of the database by a DBA. It handles restoring files as well as modifying the database to address any changes to the machine name or cluster information.

- fullRecovery (Optional) Specifies full recovery from an incremental backup. The database will be restored to its most recent state.

- pointInTimeRecovery date:time

(Optional) Specifies point-in-time recovery from incremental backup. The database will be restored to the time you specify.

Note: You can identify the times for which recovery is available using the -showRecoveryTimeRange option.

Specify the time format as mm:dd:yyyy:hh24:mi:ss.

For example, - pointInTimeRecovery 10:27:2006:23:15:00 will recover the database to its state as of 11:15 P.M. on October 27, 2006.

- force Internal

Specifies that nhLoadDb should proceed with the database load operation without asking for confirmation.

- verifyMigration Internal

(Optional) This argument is used during migrations from Network Health Release 4.8 or eHealth Release 5.0.2 to eHealth 5.6. The eHealth installation program uses it to verify a loaded Ingres database during migration. When using -verifyMigration, you must also specify the -p argument to indicate the location of the saved Ingres database.

Alphabetical List



- useStdDac Internal

(Optional) When joining a cluster, specifies whether the cluster will use this machine's standard.dac file.

- difBinUserLoad Internal

(Optional) This argument allows you to load a saved binary database that was owned by one eHealth user (as defined by the NH_USER variable) into a database that is owned by a different eHealth user.

- ascii (deprecated) (Optional) Loads a logical save. This flag is deprecated. Load will detect the mode to use automatically.

- binary (deprecated) (Optional) Loads a full (standard) save. This flag is deprecated. Use -defaultRecovery to load a standard save.

Load a Database

To load a database

1. Stop the eHealth server.

nhServer stop

2. Perform a database load by entering the following (where path is the pathname for the saved database):

nhLoadDb -p path.tdb

3. Start the eHealth server.

nhServer start

nhLucentGetCfg

Extracts configuration information from the Lucent NavisCore network management system (NMS) and converts it to DCI. This command can be used to import the configuration information into eHealth.

Alphabetical List

nhLucentMigrateElements

Converts Cascade/Ascend elements into Lucent elements. This allows customers to upgrade from pre-5.6 versions of eHealth that used the old integration module to eHealth Integration for Lucent.

nhLucentSetup

Installs and sets up eHealth Integration for Lucent.

nhMail

Sends a message or file to specified email recipients.

Note: To view an email message created by the nhMail command on a Japanese system, you must manually set encoding to Japanese (Auto-Select) or Japanese (Auto Detect) in your email application. For instructions, see the documentation for your email application.


nhMail [-h] [filename | -e subject message] recipient



filename Specifies the pathname of the file to send to recipients. If you do not specify a full pathname, eHealth looks for the file in the current directory.

When you specify a filename argument, you cannot specify the -e argument.

-e subject message

Specifies text to include in the e-mail message. In addition to recipient, the following arguments are required when you specify -e:

subject – A text string to appear in the subject line of the e-mail message.

message – A text string to appear in the body of the e-mail message.

When you specify -e, you cannot also specify a file to send (with the filename argument).


Alphabetical List



recipient Specifies one or more e-mail addresses to which the command should send the message or file. To specify multiple e-mail addresses, do the following:

■ On a UNIX system, separate each e- mail address with a space and enclose the entire string in single quotation marks. For example: '[email protected] [email protected]'

■ On a Windows system, separate each e-mail address with a plus sign (+) and enclose the entire string in single quotation marks. For example: '[email protected][email protected]'

These addresses appear in the To field of the e-mail message.

Examples:

■ To send the file /home/readme.txt to the user [email protected], enter the following:

nhMail [email protected] /home/readme.txt

■ The following command sends a text message to the specified user:

nhMail -e "Low Disk Space" \

"Running out of disk space on System-Blue, Disk-D" \

[email protected]

nhManageArAgent

Use to manage an Application Response Agent.

This command has the following format: nhManageArAgent [-h] [-rev]

-type {agent | agentSet} -name elementName

[-startAgent | - stopAgent | -startAgentSetAgents | -stopAgentSetAgents |

- startTransactionLogging | -stopTransactionLogging |

-startEventLogging | -stopEventLogging |

-showDiscoveryInfo [csv] [ showHeader ] |

-showRegistryInfo [csv] [ showHeader ] |

-setRegistry keyName keyValue |

-getFile filename [overwrite] | -forceHeartbeat]


Alphabetical List




-name elementName (Required) Specifies the name of the element to manage.

-type {agent | agentSet} (Optional) Specifies which type of element to manage. The default type is agent.

-startAgent (Optional) Starts the named agent; valid for type agent only.

-stopAgent (Optional) Stops the named agent; valid for type agent only.

- startAgentSetAgents (Optional) Starts all agents in the named agentSet; valid for agentSets only.

- stopAgentSetAgents (Optional) Stops all agents in the named agentSet; valid for agentSets only.

- startTransactionLogging (Optional) Starts Transaction Logging for the named agent; valid for agent type only.

- stopTransactionLogging (Optional) Stops Transaction Logging for the named agent; valid for agent type only.

-startEventLogging (Optional) Starts Event Logging for the named agent; valid for agent type only.

-stopEventLogging (Optional) Stops Event Logging for the named agent; valid for agent type only.

-showDiscoveryInfo [csv] [showHeader]

(Optional) Displays server discovery information for the named agent; when used with the csv option, generates output in CSV format. Valid for agent type only.

-showRegistryInfo [csv] [showHeader]

(Optional) Displays Registry information for the named agent; when used with the csv option, generates output in CSV format. Valid for agent type only.

Note: Only values under HKEY_LOCAL_MACHINE\SOFTWARE\FirstSense\FirstSense will be displayed.

-setRegistry keyName keyValue

(Optional) Sets a single Registry setting for the named agent; valid for agent type only.

Note: Only values under HKEY_LOCAL_MACHINE\SOFTWARE\FirstSense\FirstSense will be set.


Alphabetical List



-getFile filename [overwrite]

(Optional) Gets the specified file from the named agent. The overwrite option suppresses the user prompt if the file being downloaded already exists in the current directory. Valid for agent type only.

Note: Only files from the agent directory on the agent system may be downloaded.

-forceHeartbeat (Optional) Forces the agent identified by name to heartbeat immediately.

-confirm {yes|no} (Optional) Prompts before performing the agent operation. The default value is yes.

-verify (Optional) Verifies that the input parameters are valid without performing the actual operation.

Examples:

■ The following example starts agent "foo":

nhManageArAgent -name foo -type agent

-startAgent

■ The following example stops all agents whose names start with zzz:

nhListArConfig | grep zzz | nhManageArAgent

-stopAgent -confirm no

■ The following example stops all agents whose IP Address is in the subnet 172.16.x.x:

nhListArConfig -long -csv| grep "172.16" |

cut -f1 -d',' | nhManageArAgent -stop Agent

-confirm no

■ The following example stops all agents whose IP Address is in the range 172.16.6.50- 172.16.6.60:

nhListArConfig -long -csv | grep "172.16.6" |

grep -E "\.50|\.51|\.52|\.53|\.54|\.55|\.56|\

.57|\.58|\.59|\.60" | cut -f1 -d',' |

nhManageArAgent -stopAgent -con firm no

nhManageDbSpace

Manages database space. Use this command to:

■ Add a datafile to an eHealth tablespace.

■ Move a datafile from one location to another.

■ Move all datafiles from one location to another.

Alphabetical List

■ Create a layout configuration file (LCF).

■ Improve database performance and allow for future growth, when used in conjunction with nhDbStatus.

Note: Before using this command to add or move a datafile, stop eHealth.

This command has the following format: nhManageDbSpace [-h] [-rev]

■ To add a datafile to a tablespace or evaluate its addition:

nhManageDbSpace [-evaluate] -add -newPath directory

-tablespace tablespace -size fileSize

■ To move a datafile to another location or evaluate the move:

nhManageDbSpace [-evaluate] -move -datafile datafile

-newPath directory

■ To move all the Reg tablespaces:

nhManageDbSpace -moveRegTableSpaceTo newDirPath

■ To create a layout configuration file (LCF):

nhManageDbSpace -createLcf [filename]


-h Displays help for the command.


-add Adds a datafile to the tablespace specified by the - tablespace argument. When specifying -add, do not specify a name for the new datafile; eHealth assigns a datafile name using appropriate naming conventions.


Alphabetical List



-move Moves the data file specified by -datafile to the location specified by -newPath. When specifying -move, do not specify the tablespace in which the data file resides; eHealth locates the specified data file automatically.

Note: Only the following tablespaces can be moved using this option: NH_USERS, NH_INDEX, NH_DATA01, NH_DATA02. Before moving any of these tablespaces you must stop the eHealth server and database, check the memory and semaphores sections for active processes associated with the ehUser account, and stop those processes. See the first example below.

-moveRegTableSpaceTo newDirPath

Queries the database to find all the tablespaces named %NH_REG% and moves the datafiles to the new directory location.

Note: This is not compatible with the -evaluate argument.

-tablespace tablespace Specifies the name of the tablespace to which you want to add a datafile. You must specify this argument when using - add.

-newPath directory Specifies the pathname of the database directory to which you are adding or moving the datafile (the top-level directory for the eHealth database). eHealth will create the appropriate directory structure within the specified directory.

You must specify this argument when using -add or - move.

-datafile datafile Specifies the name of the datafile to move. You must specify this argument when using -move.

-size fileSize Specifies the initial size of the new datafile in megabytes. You must specify this argument when using -add.

Alphabetical List



-evaluate Evaluates whether the other parameters are valid. This parameter is optional. It determines whether the pathname and tablespace exist and whether there is enough disk space within the recommended range for the proposed add or move operation. This argument returns any appropriate warnings, but it does not modify the database.

-createLcf [filename] Creates an LCF. If you do not specify a file name for the LCF (with a full path), it is named hostname_sid.lcf (such as mySystem_EHEALTH.lcf); it resides in the ehealth/oracle/database directory, where ehealth is the eHealth installation directory.

Use this argument when you have made manual changes to your eHealth database (such as adding an archive file), and you want to record the new database structure. If you later need to recreate the database (due to corruption, for example), do the following:

Move the LCF to a location outside the eHealth installation directory.

Specify nhSaveDb to save the database.

Specify nhDestroyDb to destroy the database.

Specify nhCreateDb -i lcf. The nhCreateDb command uses the LCF as input when creating the database and thus preserves your changes.

Specify nhLoadDb to load the database.

For information about LCFs, refer to Creating the Database Layout Configuration File.

Alphabetical List

Examples:

■ To move the NH_INDEX01 datafile to C:\database, first stopping the eHealth server, enter the following commands:

nhServer stop

nhManageDbSpace -move \

-datafile /oradata/EHEALTH/NH_INDEX01.dbf \

-newPath C:/database

nhStartDb

■ To test whether a command and its arguments are valid without actually moving a datafile, add the -evaluate argument, as follows:

nhManageDbSpace -evaluate -move \



■ To evaluate a command to add a datafile of 20 megabytes to the NH_DATA01 tablespace, enter the following: nhManageDbSpace -evaluate -add \

-newPath C:/database \

-tablespace NH_DATA01 -size 20

■ To create a layout configuration file for your eHealth database, enter the following:

nhManageDbSpace -createLcf /tmp/myDb.lcf

nhManageUsers

Modifies the contents of the eHealth password file (located in ehealth/sys/ehUsers.cfg, where ehealth represents the eHealth installation directory).

This command has the following format: nhManageUsers [-h]

nhManageUsers -add -user username

-priv [admin|readOnly]

nhManageUsers -modPriv -user username

-priv {admin | readOnly}

nhManageUsers -delete -user username

nhManageUsers -showPass -user username

nhManageUsers -modPass -user username [-listener]

nhManageUsers -showPriv -user username

nhManageUsers - passPhrase

nhManageUsers -list

nhManageUsers -crtDefault


Alphabetical List



-add Adds the user specified by the -user argument.

-user username Specifies the login username that the command affects. The name is the account that a user enters to access eHealth or the eHealth database.

-priv {admin | readOnly} Specifies whether to apply administrator or read-only user privileges to the specified user. You can specify this argument if you specify the -add or -modPriv argument.

-modPriv Modifies the privileges for the user specified by the -user argument.

-delete Removes the user specified by the -user argument.

- showPass Displays the password for the user specified by the -user argument.

- modPass Modifies the password for the user specified by the -user argument. The command prompts you to enter the current password, then enter and re-enter the new password.

The password must start with an alphanumeric character and may include alphabetic, numeric, and underscore characters; no other special characters are permitted. The password may be 30 characters long and is not case- sensitive.

To change the password for the nhlistener account, specify nhManageUsers -modPass -listener. This syntax is necessary because changes to the nhlistener account must occur within and outside of the database.

-showPriv Displays the privileges for the user specified by the -user argument.

- passPhrase Modifies the password phrase originally entered during the installation. The command prompts you to enter and re-enter the new phrase.


Alphabetical List



-list Prints a list of users and their privileges. This list is generated from the password file, rather than from Oracle’s ALL_USERS view.

- crtDefault Internal

Removes ehUsers.cfg from the ehealth/sys directory and recreates a default version of that file containing only the nhuser, sys, and system users. You may want to use this argument when the eHealth system is in an unstable state.

Examples:

■ To apply administrator privileges to an account named ehReports, enter the following:

nhManageUsers -modPriv -user ehReports -priv admin

■ To add a user with administrator privileges as an account named ehUser, enter the following:

nhManageUsers -add -user ehUser -priv admin

Note: If you add more than one eHealth administrator, they should share the same eHealth password.

nhModifyAppType

Changes an application type in your eHealth application hierarchy (your object model). If eHealth creates a new application type after you add an application using Application Response, you can modify only the basedOn field of this application type.

This command has the following format: nhModifyAppType [-h] [-rev] -symbol symbolName -newSymbol newSymbolName

-newLabel newLabelName -newLevel newLevelName [-newBasedOn]

[-newAppSvcType newType] [-newRespMeasureType newType]

[-newNormalSortOrder newOrder] [-verify]




Alphabetical List



-symbol SymbolName (Required) Specifies the current symbol for the existing application type.

- newSymbol newSymbolName

(Optional) Specifies a different symbol for the application type.

- newLabel newLabelName (Optional) Specifies a different label for the application type.

- newLevel (Optional) Specifies a different level for the application type.

For newLevel, specify one of the following:


- newBasedOn newBasedOn (Optional) Specifies a different (previously-defined) element type on which to base the application type.

Alphabetical List



- newAppSvcType newType (Optional) Specifies a different application service to associate with the application type (for example: exchangeAppSvc).

For newType, specify one or more of the following:

appService,genericAppSvc,apacheAppSvc,dnsAppSvc,

eHealthAppSvc,exchangeAppSvc,iisAppSvc,lotusNotesAppSvc,

msSqlServerAppSvc,oracleAppSvc,sendMailAppSvc,userApp1AppSvc,

webAppSvc,fw1MgmtStationAppSvc,fw1EnforcementPtAppSvc,

netSvcsSendmailUnixAppSvc,netSvcsNisUnixAppSvc,

netSvcsLpUnixAppSvc,netSvcsDnsUnixAppSvc,

netSvcsNfsUnixAppSvc,netSvcsLdapUnixAppSvc,

netSvcsActiveDirNtAppSvc,netSvcsDhcpNtAppSvc,

netSvcsDnsNtAppSvc,netSvcsWinsNtAppSvc,httpProxy,

genericCallMng,ccmConfMgrAppSvc,genericCCMAppSvc,

ccmMsgIntAppSvc,ccmCtiMgrAppSvc,ccmWebAttAppSvc,

unifiedMsgAppSvc,exchangePubMailboxStoreAppSvc,

ciscoGatekeeper,ciscoGatekeeperZone,exchangeAppSvcVirus,

exchangeAppSvcSMTP,exchangeAppSvcPublicStore,

exchangeAppSvcPrivateStore,exchangeAppSvcOWA,

exchangeAppSvcSRS,exchangeAppSvcDSCache,

exchangeAppSvcMessageStore,avayaCommMgrAppSvc,

avayaAttGroupAppSvc,avayaAttPosAppSvc,

avayaClanBoardAppSvc,avayaHun

Alphabetical List



- newRespMeasureType newMeasure

(Optional) Specifies a different method by which eHealth should measure response for this application type.

For newMeasure, specify one of the following:


- newNormalSortOrder newValue

(Optional) Changes the location in which this application type should appear in sorted lists.


Example:

The following example modifies the label of the application type symbol reader: nhModifyAppType -symbol reader

-newLabel distribution

Modified AppType:

symbol = "reader"

oldLabel = "mail"

newLabel = "distribution"

nhModifyArConfig

Modifies an element in the Application Response Configuration.

This command has the following format: nhModifyArConfig [-h] [-rev]


elementName [-newName newName] [- agentSet agentSet]

[-hostnames hostnames] [- portRedirection {yes|no}]

[-urls urls] [- parameterSubstitutions params]

[-description description]

[-operatingSystem operatingSystem]

[-importRules rulesFile] [- disable] [-enable]





Alphabetical List




(Required) Specifies which type of element to modify. The default type is agent.

- name elementName (Optional) Specifies the name of the element to modify.

- newName newName (Required) Specifies a new name for the element being modified.

- agentSet agentSet (Optional) Specifies a new agentSet in which to place the agent. Valid for the agent type, and the web applicationType only.


(Optional) For agent, specifies a list of hostnames. Use semi- colons to separate hostnames.

For server, specifies a list of hostname:ports. Use semi- colons to separate hostnames, and commas to separate ports per hostname.

Valid for - type server and agent only.

- portRedirection {yes|no} (Optional) Indicates whether or not to enable port redirection for the server being modified. Valid for -type server only. The default value is "no".

-urls urls (Optional) Specifies urls to monitor. Use commas to separate urls. The default value is "". Valid for - type server only.

- parameterSubstitutions params (Optional) Specifies semi-colon separated list of parameter substitution sets; each set is a "name=value" pair, where name is of the form $Name for string values and %Name for numeric values; the value is a comma separated list of string or numeric values as the case may be; only valid for -type application; default value is "".

- description description (Optional) Specifies the description of the element being modified.


(Optional) Specifies the name of the Operating System. This option is valid for -type agent only.

Alphabetical List



- importRules rulesFile (Optional) Specifies the name of a rules file containing the new rules for this application; only a single application's rules may be updated using this option. This option is valid for -type application only.

- disable (Optional) Disables the specified application. This option is valid for type -application only.

- enable (Optional) Enables the specified application. This option is valid for type -application only.

-confirm {yes|no} (Optional) Prompts before modifying the element. The default is yes.


Examples:

■ The following example changes the name of an AgentSet from a1 to a2:

nhModifyArConfig -type agentSet -name a1

-newName a2

■ The following example assigns the hostnames f1:1,2,3;f2:4,5 to a server named s1:

nhModifyArConfig -type server -name s1

-newHostnames "f1:1,2,3;f2:4,5"

■ The following example uses the output of the nhListArConfig command to move agents whose names start with "zzz" to a new agentSet named "newZZ":

nhListArConfig | grep zzz | nhModifyArConfig

-newAgentSet newZZ -confirm no

nhModifyClusterMember

Modifies the information for an eHealth system in the member table of one or more systems in a Distributed eHealth cluster.

Note: You must run this command from a trusted cluster member to change the information for any other system in the cluster. You can run this command on an untrusted member to update its member table.

Alphabetical List


nhModifyClusterMember [-h] [-rev]


{ -id | -name memberName } [-ipAddress address]

[-contacts contact1,contact2,...] [-trusted yes | no]

[-newName newMemberName] [-retryTime seconds] [-timeout seconds]




-host hostname Modifies the member table on the specified cluster system named hostname. This argument is required unless you specify -cluster or -all.

-cluster Modifies the member tables on all eHealth systems except the local system. This argument is required unless you specify - host or -all.

-all Modifies the member tables on all eHealth systems in a cluster. This argument is required unless you specify - host or -cluster.

-id Specifies the unique ID for the cluster member’s information that you are modifying in the table. This argument is required unless you specify - name.

-name memberName Specifies the member name for the cluster member’s information that you are modifying in the table. This argument is required unless you specify -id.

-ipAddress address Specifies the new IP address for the member information that you are modifying. If you change the IP address of a cluster member, you should use the -all argument to change it in all cluster member tables.

-contacts contact1, contact2, ... Specifies the new contact names or e-mail addresses for the member information that you are modifying.


Alphabetical List



-trusted yes | no Specifies the new trusted setting for the member information that you are modifying.

-newName memberName Specifies the new member name for the member information that you are modifying. If you change the name of a cluster member, you should use the -all argument to change the name in all cluster member tables.

-retryTime seconds Specifies how long in seconds the local system will retry the command. If the command fails due to an internal problem (for example, the system connection to the network is down), eHealth reissues the command for the specified retry time.




Alphabetical List

Examples:

■ The following example shows how the nhModifyClusterMember command changes the member table information on a cluster system.

Assume that you have a cluster system named baffin that has the following member table information: nhListClusterMembers -host baffin





+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:


Contacts:


Contacts:


Contacts:

■ To modify the member table information on baffin, you can specify a command similar to the following: nhModifyClusterMember -host baffin -name eire -trusted no -contacts

[email protected]

Cluster Modify Member initiated:

Sending modifications . OK


Alphabetical List

■ If you display the member table information on baffin again, you would see the following changes (shown in bold): nhListClusterMembers -host baffin





+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server No 100.26.12.64

Contacts: [email protected]


Contacts:


Contacts:


Contacts:

nhModifyElements

Changes selected attributes for one or more elements maintained by the eHealth software. You can use any of the following methods to specify elements:

■ Use standard input (stdin).

■ Use the -inFile argument to give this command a file of valid element names.

■ Redirect the output of the nhListElements command as input to this command.

Important! Improper use of this command can result in failure to poll or incorrect report data. Use this command only if you are an advanced user and are familiar with its effects.


nhModifyElements [-h] [-rev] -fieldName fieldName

[-value value] [-inFile fileName] [-verify]


Alphabetical List

Argument Definition



- fieldName fieldName

(Required) Specifies a DCI element field to update. You can update only one field at a time. For a complete list of the valid DCI element fieldName values, see the "Element Section Definition Fields" table in of the eHealth Data Integration Guide.

Note: Fields representing database handles (objId, dbId, machineId) and deprecated fields are not supported.

-value value (Optional) Modifies a property for a set of elements without requiring you to generate an input file.

If you specify “- fieldName nmsState -value Retired” to retire a parent element, the nhModifyElements command also retires all related child elements that do not consume their own polling licenses (store detailed data).

Note: For information about special cases, see the Data Integration Guide.

-inFile fileName (Optional) Specifies the name of the file that contains the list of modifications. Use -inFile to specify unique values for each element, not the same value for all elements. Or, create a list and use the -value argument to specify the same value for all elements in the list. If you do not specify an input file, eHealth reads input from standard input. Input has the following format:

name[,value]

name[,value]

...

name[,value]

If you do not use the -value argument, you must specify a value for each name.

-verify (Optional) Processes the input and produces a DCI file but does not commit the changes to the eHealth database.


Alphabetical List

Examples:

■ Enter the following command to change the poll rate of all elements listed in the file subnet5Routers to normal:

nhModifyElements -fieldName pollRate \

-value normal -inFile subnet5Routers

■ Enter the following command to find all elements that have not collected data for four hours and turn off polling for them:

nhListElements -noDbDataFor 4 | \

nhModifyElements -fieldName poll -value no

■ Enter the following command to list all elements that have a speed of 9600 bps and change them to a speed of 19200 bps:

nhListElements -where "speed = 9600" | \

nhModifyElements -fieldName speed -value 19200

■ Enter the following command to retire all elements listed in the file obsoleteElements:

nhModifyElements -fieldName nmsState \

-value Retired -inFile obsoleteElements

nhMonitoredSubjectsRpt

Generates the Monitored Subjects Summary and Detail reports for Live Exceptions. These reports summarize the monitoring rules for the various subjects (groups and group lists) that Live Exceptions is monitoring. This command outputs the HTML syntax that renders the reports to standard output. To view the reports, you can redirect the output to a file and view it using a Web browser.

This command has the following format: nhMonitoredSubjectsRpt [-h] [-rev]

-profile profile - subjType subjType - subjName subject

[-summary | -detail] [-outFile filename] [- calendar calendar] [-alias]




- profile profile Specifies the name of the profile to preview. When you specify this argument, you must also specify the - subjName, and -subjType arguments.

- subjType subjType Specifies the subject type. Valid values are group and groupList. The default is group.


Alphabetical List



- subjName subject Specifies the subject name as a valid group or group list name. If you specify this argument, the report summarizes the Live Exceptions monitoring information for the specified subject. If you do not specify it, the report summarizes the monitoring information for all groups and group lists.

- summary Generates the Monitored Subjects Summary Report. This is the default.

- detail Generates the Monitored Subjects Detail Report.

- outFile filename Specifies the name of the output file.

- calendar calendar Specifies the name of the calendar to preview. When you specify this argument, you must also specify the - profile argument.

- alias Specifies that eHealth should use alias names for elements instead of element names.

nhMonitorSubjects

Associates Live Health profiles with subjects (groups or group lists). This is the same functionality that is available in the Live Exceptions Browser using Setup, Subjects to Monitor. However, it is easier to use the nhMonitorSubjects command to perform a large number of associations.

Note: This command does not support the removal of associations.

After an eHealth upgrade, use the nhMonitorSubjects command to associate selected profiles with specified subjects.

This command has the following format: nhMonitorSubjects [-h] [-rev]

-all | [-subjType {group | groupList}] [-subjName subject]

[-calendar calendarName] [- profileList filename]




Alphabetical List



-all (Optional) Uses the default values for all other arguments. I.e. associates the All groups with all system profiles and the 24x7 calendar. Needs to be specified if no other arguments are specified. Cannot be used together with other arguments.

-subjType {group | groupList}

Specifies the subject type. Valid values are group and groupList. The default is group. Not valid with the -all option.

-subjName subject Specifies the subject name as a valid group or group list name. The default is the subject named All. Not valid with the -all option.

-calendar calendarName

Specifies an existing calendar to apply to this association. The default is the calendar named 24x7. Not valid with the -all option.

-profileList filename Specifies the name of the file that lists the existing profiles that you want to associate. You must list each profile on a separate line in the file. The default is all system profiles. Not valid with the -all option.

Examples:

■ To apply the profiles listed in lwProfiles.lis to all groups called All, enter the following:

nhMonitorSubjects -profileList lwProfiles.lis

■ To associate the All group with the profiles listed in a file named lwProfiles.lis, enter the following:

nhMonitorSubjects -subjType group - profileList lwProfiles.lis

■ To associate the West group for all groups with the profiles listed in a file named lwProfiles.lis, enter the following:

nhMonitorSubjects -subjName West - profileList lwProfiles.lis

nhNameNodes

Converts the network addresses of nodes in the database into names using a standard name resolution protocol (DNS), maps, or files. By default, eHealth provides this command as a scheduled system job that runs hourly. You can modify the job to schedule it to run less frequently.

Note: When Traffic Accountant is in AS-to-AS mode, you can only use files (not maps or DNS) to convert network addresses to node names. For more information, see nhTaDataPurge.

Alphabetical List

The nhNameNodes command requires one of the following mutually exclusive forms: nhNameNodes [-h] [-rev]

nhNameNodes [-all] [-dns] [-timeout seconds] [-retry number]

[-norecurse] [-user username] [-db database]

[-last hours | -view viewName -group groupName]

nhNameNodes [-all] [-file filename] [-user username] [-db database]

[-last hours | - view viewName - group groupName]

nhNameNodes [-reset] [-user username] [-db database]


If you do not specify any arguments, the command defaults to the following: nhNameNodes -dns




-all Specifies that eHealth should name all nodes even if they have already been named. If you do not specify this argument, eHealth disregards nodes that already have names. You can use this argument if you do not specify -reset.

-dns Uses the DNS name resolution protocol as provided by BIND. You can use this argument if you do not specify -map, -file, or -reset.

Note: You cannot use the -dns argument when Traffic Accountant is in AS-to-AS mode.

-map mapName Specifies a Network Information System (NIS) map to use for node address-to-name information.

Note: This argument is deprecated. Use the -file or -dns arguments instead.

-file filename Specifies a file to use for address-to-name information. The file must have the same format as the standard /etc/hosts file. You can specify this argument if you do not specify -map, -dns, or -reset.


Alphabetical List



- timeout seconds Specifies the amount of time (in seconds) to wait for a name request to be filled. If the value of -retry has not been met, this argument specifies how long to wait before requesting the node again. If the value of -retry is exceeded, this argument specifies how long to wait before requesting the next node. The default is 3 seconds. Specify - timeout only when specifying -dns.

A -timeout value of less than 3 seconds may produce an increase in nodes (usually outside the client network) without names.

-retry number Specifies the number of times that eHealth will attempt to look up a node’s name before moving on to the next node. The default is 2. Specify -retry only when specifying -dns.

A -retry value of less than 2 may produce an increase in nodes (usually outside the client network) without names.

- norecurse Specifies that the command should stop at the local tier of DNS servers when retrieving node names. Specify -norecurse only when specifying -dns.

While you can use this argument to save retrieval time, its use can sometimes produce an increase in nodes that are not renamed.

-reset Converts nodes back to IP addresses or AS numbers. For consolidated addresses, eHealth cannot restore the node address because it can choose from more than one possible address.

-user username Specifies a user name. If you do not specify this argument, the command uses the eHealth administrator.

-db database Specifies the database to use. By default, eHealth uses the value of the NH_RDBMS_NAME environment variable.

-last hours Names only the nodes that were created within the specified number of hours. The default (as a scheduled job) is 1 hour. However, from the command line, this feature is disabled by default. You can specify this argument if you do not specify -view and -group.

-view viewName Names only the nodes in the specified view. You can specify this argument if you do not specify -last.

Alphabetical List



-group groupName Names only the nodes in the specified group for viewName. You can specify this argument if you do not specify -last.

Note: You can mix address types (IP, Media Access Control [MAC], and Internetwork Packet Exchange [IPX]) in the same file or map. DNS only uses IP-type addresses. When nhNameNodes encounters more than one address that resolves to an identical name, the command consolidates those addresses to point to a single named node in the database. It deletes all other nodes originally associated with the unique addresses.

Example:

If the standard resolver is DNS, resolve (nonlocal) node addresses by entering the following:

nhNameNodes -dns

nhNetflowSetup

Configures and installs eHealth Integration for Cisco Netflow. To use the nhNetflowSetup command, enter nhNetflowSetup at the command line and respond to each prompt.

For more information about how to use the setup script, see the eHealth Traffic Accountant and Netflow Administration Guide.

nhParameter

Lets you display the list of eHealth parameters, delete a parameter, change the value of a parameter, or get the value of a parameter. This is a wrapper around the NH_PARAMETER table to allow manipulation of that table.

The former NH_ORA_MAXCORRUPT environment variable that governed how many Oracle database block corruptions were allowed on a database restore has been moved from the environment to a setting of the same name in the NH_PARAMETER table. Use the nhParameter command to change the NH_ORA_MAXCORRUPT value as if there is an entry in the database for that setting. The nhParameter command will override an environment variable setting.


nhParameter –h [-get <name>] [-set <name> <value>][-delete <name>][-list]

Alphabetical List



-get Gets the value of parameter.

-set Sets a parameter to a given value.

-delete Deletes a parameter setting.

-list List shows all name value pair as “<name>=<value>”.

nhPresideGetCfg

Extracts configuration information from the Nortel Preside Multiservice Data Manager for use with the eHealth Integration for Nortel Preside module.

nhPresideInstall

Installs and sets up the eHealth Integration for Nortel module for use with Nortel Preside Multiservice Data Manager.

nhPutFile

Sends a specified file to one or more remote eHealth systems in a Distributed eHealth cluster.

Note: You can put files only in the ehealth directory or its subdirectories. You cannot run this command from a non-trusted system in the cluster to affect other systems in the cluster.


nhPutFile [-h] [-rev] [-v] { -host hostname | -cluster | -all }

-fromFile localFilePath -toFile remoteFilePath





-v Displays verbose output.


Alphabetical List



-host hostname Sends the specified file in -fromFile to the eHealth system named hostname. This argument is required unless you specify - cluster or -all.

-cluster Sends the specified file in -fromFile to all systems in the cluster except the local system. This argument is required unless you specify -host or - all.

-all Sends the specified file in -fromFile to all systems in the cluster. This argument is required unless you specify -host or -cluster.

-fromFile Specifies the full pathame of the local file to send. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

-toFile Specifies the full pathname of the destination file; this is the file that will be created (or overwritten) on each remote system. The pathname must be located within the eHealth installation directory on the remote system. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

-overwrite Specifies that the sent file should overwrite the local file specified in -toFile, if one exists.



nhReloadTrapRules

Reloads all system and user trap rule files (TRFs) without restarting eHealth; finds new and changed files in the ehealth/extensions/traps/user and eHealth/extensions/traps/sys directories and loads them to the eHealth trap server and Live Exceptions Browser.

This command has the following format: nhReloadTrapRules [-h] [-rev] [-v]

Alphabetical List




-v Displays output messages in verbose mode.

nhRemotePollerSetup

Configures local and remote systems for remote polling. Use this command when you run eHealth in a remote polling environment.

To use the nhRemotePollerSetup command, enter nhRemotePollerSetup at the command line, and respond to each prompt.

nhRemoveClusterMember

Removes the specified eHealth system as an active member of a Distributed eHealth cluster. The command updates the member table on one or more eHealth systems in the cluster to show that the specified system has been removed. The removal process does not update the member table of the cluster member that you are removing.

When you remove a system from a member table, the system can still function as a standalone system. However, it cannot replicate its information to or synchronize its information with the cluster members from which it has been removed. You can restore a removed system to return it to the cluster membership and make it an active member of the cluster again.

When you remove a system, eHealth does not actually delete the member information permanently. It soft deletes the information, which means that the information remains in the table but it is updated to show that the system has been removed. You can restore the information to the member tables using the nhRestoreClusterMember command.


nhRemoveClusterMember [-h] [-rev]


{ -id id | -name memberName } [-retryTime seconds]

[-timeout seconds]


Alphabetical List



-rev Displays the eHealth software revision information

-host hostname Removes the specified system from the member table of the eHealth system specified by -host. This argument is required unless you specify - cluster or -all.

-cluster Removes the specified system from the member tables of all eHealth systems in the cluster except the local system (the system on which you run the command). This argument is required unless you specify -host or -all.

-all Removes the specified system from the member tables of all eHealth systems in the cluster. This argument is required unless you specify -host or -cluster.

-id id Specifies the unique member ID for the system that you want to remove from the cluster. This argument is required unless you specify -name.

-name memberName Specifies the member name of the system that you want to remove from the cluster. This argument is required unless you specify -id.



- timeout seconds Specifies the time in seconds to wait for the command to finish. If the time expires before the command finishes, the command stops and returns an error.



Alphabetical List

Examples:

■ The following command removes a cluster system named eire from the member table of the system baffin: nhRemoveClusterMember -host baffin -name eire

Cluster Remove Member initiated:

Sending remove messages . OK

■ The following command removes the system named eire from the member table of all systems in the cluster (including its own member table): nhRemoveClusterMember -all -name eire


Sending remove messages ...... OK

nhReplicate

Updates the other members of a Distributed eHealth cluster with the specified information (objects) on the local eHealth cluster member.

When you run this command from a Distributed eHealth System, the command replicates only the element information that has changed since the last replication. Use the -allElements argument to force the replication of all elements.


nhReplicate [- h] [-rev] { -host hostname | -cluster }

[ -objTypeAll | -objType objType[,objType,...] | - objTypeList]

[ -allObjects | -name objName ]

[-allElements] [-retryTime seconds]




-host hostname Updates only the specified eHealth system with the local system’s information. This argument is required unless you specify -cluster.

-cluster Updates all other eHealth systems in the cluster with the local system’s information. This argument is required unless you specify -host.

-objTypeAll Replicates the information for all object types. This is the default.


Alphabetical List



-objType objType[,objType,...] Replicates the information for the specified object types. You must enclose the objType values in quotes (" "), separated by a comma. You can select one or more of the following object type values:

■ element

■ group

■ groupSection

■ groupList


■ dataAnalysisRec

■ serviceProfile

-objTypeList Lists the supported object types, but does process the command. Use this argument to list the valid values for the -objType argument.

-allObjects Replicates all objects of type object type. This is the default.

-name objName Replicates the object named objName.

-allElements Replicates all elements, not just those that changed since the last time that the elements were replicated. If you do not specify this argument, the command replicates only those elements that have changed since the last replication.

-retryTime seconds Specifies how long, in seconds, the local system will retry the command. If the command fails due to an internal problem (for example, the system connection to the network is down), eHealth reissues the command for the specified retry time.

The default is 0, which indicates that the local system will not retry the command. If you specify a value, it should be less than the value of the NH_REPL_MSG_TIMEOUT environment variable, which is 5 minutes by default.

Alphabetical List

Example:

The following command replicates group information from the local system to all other systems in the cluster: nhReplicate -cluster -objType group

Cluster Replicate initiated:

Replicating objects of type group ..... OK

nhReset

Stops and restarts the eHealth server. If your eHealth software is installed on a UNIX system, this command also trims system tables, cleans up temporary files, and reallocates memory.

Important! This command stops and restarts the eHealth pollers. Use only if you are an advanced user familiar with its effects.

The nhReset command closes any eHealth dialog boxes that are open, except for the console and the polling status windows. Use it to perform periodic maintenance of the eHealth database or to reset the eHealth server after a system crash. The nhReset command syntax and its use depend on your operating system.

If the NH_RESET_ORACLE environment variable is set to yes, the nhReset command shuts down and restarts the Oracle database server, and restarts the eHealth server.


On UNIX Systems

Run the source nethealthrc.csh command, then type:

nhReset

On Windows Systems

The nhReset command does not stop and start the Oracle database server. However, you can force nhReset to restart the Oracle database server by specifying the -db argument, as follows:

nhReset -db


Alphabetical List

nhRestoreClusterMember

Restores the local eHealth system as an active member of a Distributed eHealth cluster. You can restore a system that was once in the cluster but that had been subsequently removed using nhRemoveClusterMember. The command updates the member table information on one or more systems in the cluster.

Note: When you restore a cluster member, use the -all argument to restore it to all cluster members. If you restore it to only some of the cluster members, you could cause your cluster to become out-of-sync.


The nhRestoreClusterMember command has the following syntax: nhRestoreClusterMember [-h] [-rev]

{ -host hostname | -cluster | -all }


[-timeout seconds]




- host hostname Updates the member table of the specified eHealth system to restore the local system to the cluster. This argument is required unless you specify -cluster or -all.

- cluster Updates the member table of all eHealth systems except the local system to restore the local system to the cluster. This argument is required unless you specify -host or -all.

- all Updates the member table of all eHealth systems including the local system to restore the local system to the cluster. This argument is required unless you specify -host or -cluster.

- id id Specifies the unique member ID of the system that you are restoring. This argument is required unless you specify -name.

- name memberName Specifies the member name of the system that you are restoring. This argument is required unless you specify -id.


Alphabetical List







Examples:

■ Assume that you have a system named baffin that has the following member table: nhListClusterMembers -host baffin -includeRemoved





+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+


Contacts: tester


Contacts:


Contacts:


Contacts:


Contacts:


Contacts:

Alphabetical List

■ To restore the system named sparky to the cluster (and to update the member table on baffin), use the following command:

nhRestoreClusterMember -host baffin -name sparky

The next time you list the member table on baffin, you will see the following changes (shown in bold): nhListClusterMembers -host baffin -includeRemoved





+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+


Contacts: tester


Contacts:

739249214 sparky server Yes 100.26.12.62 No

Contacts:


Contacts:


Contacts:


Contacts:

■ To restore the system named sparky in the member tables of all systems in the cluster, use the following command:

nhRestoreClusterMember -all -name sparky

nhRmon2Diag

Shows the current probe configuration (that is, control table entries and protocols), creates and deletes control table entries, and detects duplicate control table entries.

Note: Use the nhRmon2Diag command only under the direction of Technical Support.


Alphabetical List

This command has the following format: nhRmon2Diag [-h] [-c community] [-r retries] [-t timeout] [- showConfig]

[-showProtocol] [-showAll] [-showDupCtrlEntry] [- delete ctrlTblIndex]

[-create interface] [- alMax alMaxEntries] [-nlMax nlMaxEntries]

[-own owner] ipAddress



-c community Specifies the community string. The default is public.

-r retries Specifies the number of times that the nhRmon2Diag command should attempt to identify the current probe configuration. The default is 2.

-t timeout Sets the amount of time (in seconds) that the nhRmon2Diag command maintains the search. The default is 1 (one).

-showConfig Shows the entries in the nlMatrixControlTable table. One entry in the table represents an interface on the probe.

-showProtocol Shows the protocolDirTable table, which lists the protocols configured for the application layer matrix (as shown in Traffic Accountant reports if the protocols exist in the network).

-showAll Shows the nlMatrixControlTable and protocolDirTable tables.

-showDupCtrlEntry Shows duplicate entries in the nlMatrixControlTable table.

-delete ctrlTblIndex Deletes an entry with the specified index from nlMatrixControlTable.

-create interface Creates an entry for the specified interface in nlMatrixControlTable.

-alMax alMaxEntries Specifies the maximum desired number of application layer matrix entries. The default is -1 (negative one), indicating that the RMON2 probe can increase the matrix as much as resources allow.

-nlMax nlMaxEntries Specifies the maximum desired number of network layer matrix entries. The default is 6000.

-own owner Specifies the owner of the control table entry. The default is Concord.

ipAddress Specifies the IP address of the probe.


Alphabetical List

Example:

■ The following command shows all control table entries and protocols for the specified probe:

nhRmon2Diag -showAll 192.16.4.120

nhRunCommand

Executes a specified command on one or more eHealth systems in a Distributed eHealth cluster. You cannot run this command from a non-trusted system in the cluster to affect other systems in the cluster. nhRunCommand collects all messages displayed in standard output (stdout) and standard error (stderr) on each system and displays them on the local system.

This command has the following format: nhRunCommand [-h] [-rev] [-v] { -host hostname | -cluster | -all }

-cmd 'cmdString' [-attachFile1 pathname]

[-returnFile1 pathname] ... [-retryTime seconds]

[-timeout seconds]





-host hostname Runs the command specified in -cmd on the eHealth system specified by hostname. This argument is required unless you specify -cluster or -all.

-cluster Runs the command specified in -cmd on all eHealth systems except the local system (the system on which you run the command). This argument is required unless you specify -host or -all.

-all Runs the command specified in -cmd on all eHealth systems in the cluster. This argument is required unless you specify -host or - cluster.

-cmd cmdString Specifies the full pathname and arguments of the command that you want to run. You must enclose the command string in single quotation characters (' '). The maximum length of the command string depends on your operating system restrictions.


Alphabetical List



-attachFile1 pathname


...


Specifies the full pathname of a file to attach to the command if the command operates on an input filename. You can specify a maximum of five files to attach.

-returnFile1 pathname


...


Specifies the full pathname of a file that you want the command to return if the command returns a file. You can specify a maximum of five return files.


If you specify a value, it should be less than the value of the NH_REMOTE_CMD_TIMEOUT. The default is 0, which indicates that the local system will not retry the command.



Alphabetical List

Examples:

■ The following command runs the nhShowRev command on each cluster member to display the eHealth software revision information for each eHealth system in the cluster and returns the output to the local system:

nhRunCommand -all -cmd 'nhShowRev'

■ The command displays the following on the local system, which is the standard error and standard output from each system in the cluster. The system that replies first appears first in the output, until the last system replies. STDERR: solomon

eHealth version: 5.6.0 D0 - Patch Level: 0

STDERR: eire


STDERR: baffin


STDERR: sparky


nhSaveDb

Saves the current eHealth database to a series of files. Use nhSaveDb to back up your database.

Note: To schedule regular database backups, use the nhSaveDbConfig command.

If you use nhLoadDb to replace your current database with a saved database, the database directory path must be the same as when it was created using nhSaveDb, unless the database was saved using the -ascii option.

For more information about backing up the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

Saves completed using the nhSaveDb command are known as long-term saves. They are not regularly overwritten or deleted by eHealth. If you save the database to a path that already contains a long-term save, eHealth automatically creates a backup of the existing saved database in path.bak, and saves the current copy in path.


Alphabetical List

This command has the following format: nhSaveDb [-h] [-rev] {-p path [...] | -validate path | -showProgress}

[-fullBackup | -ascii [-fast] [-compress] | -fileOnly]

[-noDiskSpaceCheck] [-incrLevel1]

[-binary] [-backup (deprecated)]




-p path [...] (Required) Specifies the full path name for the saved database. You can specify up to 10 backup locations for binary (non-ascii) saves.

The parent directory must exist before you can run nhSaveDbConfig. A suffix of ".tdb" is appended to the filename if you do not enter it.

If you save the database to the same location as an existing save, the existing save is retained until the new save completes successfully. After the new save is validated, the prior save is deleted.

Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If the target directory name contains accented characters, you must change those characters to non- accented characters before using the nhSaveDb command.

-validate path (Optional) Performs diagnostics to ensure that an existing backup at the specified path is valid for recovery.

If you saved the backup to multiple paths, enter only the first path.

To use the -validate option, you must specify it as the only argument.

- showProgress (Optional) Displays the status of a currently running binary save.

To use the -showProgress option, you must specify it as the only argument.

Note: The -showProgress option is not supported for universal (ASCII) saves.


Alphabetical List



-fullBackup (Optional) Specifies that a standard (full) save be performed. Standard saves are binary, platform-dependent, path-dependent, and language-dependent saves of all the physical database blocks using the Oracle RMAN utility.

This is the default if you do not specify another type of save.

-ascii

[-fast]

[-compress]

(Optional) Specifies that an universal (ASCII) save be performed. Universal saves are platform-independent, path- independent, and language-independent saves using the Oracle export utility.

Universal saves allow you to load the information into an eHealth database running on a different platform. However, they consume more disk space and require more time than binary saves.

You can use either of the following options with the -ascii argument:

-fast – (Optional) performs the ascii save in a platform-specific format, which takes less time, but is not portable. You can still load the information into another eHealth database, but that database must be running on the same type of system (Windows or UNIX).

-compress – (Optional) compresses the save so that it requires less space.

-fileOnly (Optional) Specifies that a files only save be performed. This option saves only the report, element type, and other customized files, but does not save the eHealth database.

- noDiskSpaceCheck

(Optional) Specifies that the system skip the disk space estimate before saving the database.

-incrLevel1 (Optional) Specifies that an incremental Level 1 save be performed. Level 1 saves record only the data that has changed since the last backup, saving time and disk space.

Alphabetical List



-binary

(internal)

(Optional) Saves the database in a platform-dependent, path-dependent, and language-dependent format using the Oracle RMAN utility.

Note: This option has been replaced by -fullBackup. The -binary option is still supported for customers who have created scripts to perform scheduled backups using the nhSaveDb command, or those who are familiar with using the option.

When eHealth saves the database, it also saves the following report and configuration files:

■ Object model extension (.omx) files

■ Report (.rpt, .dac, .rds, .rde, .sds, .sde, .vpns, and .mhd) files

■ Report presentation variable (.vars) files

■ Database data information (.ddi) files

■ Database layout configuration (.lcf) files

■ Time zone information

■ Traffic Accountant view definitions

Example:

The following example saves a copy of the current database to three paths (E:\waltham.tdb F:\concord.tdb, and G:\paxton.tdb) using the -fullBackup option:

nhSaveDb -p E:\waltham.tdb -p F:\concord.tdb -p G:\paxton.tdb

nhSaveDbConfig

nhSaveDbConfig schedules a database backup job to occur regularly. Use nhSaveDbConfig to implement a backup strategy for the eHealth database.

Note: For more information about backing up the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

This command has the following format: nhSaveDbConfig [-h] [-rev] [-list | -listSizes] [-delete jobID]

[-add -p path [...] - startDate MM-DD-YYYY -startTime HH:MM

{-fullBackup period | -incrLevel0Days interval - incrLevel1 period |

-ascii period} ]

Alphabetical List




-list (Optional) Displays a list of currently scheduled backups.

- listSizes (Optional) Displays the size of recent backups.

- delete jobID (Optional) Deletes the scheduled backup with the specified ID number.

You can obtain a list of ID numbers for currently scheduled backups using the command nhSaveDbConfig - list.

-add (Optional) Schedules a new database backup job.

Note: The remaining arguments (below) apply to the -add option only.



Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If the target directory name contains accented characters, you must change those characters to non-accented characters before using the nhSaveDbConfig command.

- startDate date (Required) Specifies the date on which to begin backups.

You can specify the date in the format MM/DD/YYYY, unless you have set NH_DATE_FMT to DMY.

- startTime time (Required) Specifies the time at which the backup job will run.

You must specify the time in the format HH:MM.


Alphabetical List



- fullBackup period clause

Specifies that a full (standard) save be performed at the specified interval.

Standard saves are binary, platform-dependent, path- dependent, and language-dependent saves using the Oracle RMAN utility.

You can specify the period clause in one of two ways:

period hours – Specifies an interval of hours between backups. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, - fullBackup period 12 will perform a full save every 12 hours.

daily nyyynyn – Specifies the days of the week to perform the backup. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, - fullBackup daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

- incrLevel0Days interval

Specifies that an incremental Level 0 save be performed at the specified interval. Level 0 saves are full database saves similar to a standard save.

You specify the interval as the number of days between Level 0 saves. For example, -incrLevel0Days 7 schedules a Level 0 save to occur once a week, while -incrLevel0Days 2 schedules a save to occur every other day.

- incrLevel1 period clause

Specifies that an incremental Level 1 save be performed at the specified period. Level 1 saves record only the data that has changed since the last backup, saving time and disk space.


period hours – Specifies an interval of hours between Level 1 saves. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, - incrLevel1 period 6 will perform a Level 1 save every 6 hours.

daily nyyynyn – Specifies the days of the week to perform the Level 1 save. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, - incrLevel1 daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

Alphabetical List



period clause

Specifies that an universal (ASCII) save be performed at the specified interval. Universal saves are platform-independent, path-independent, and language-independent saves using the Oracle export utility.


period hours – Specifies an interval of hours between saves. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, period 12 will perform a save every 12 hours.

daily nyyynyn – Specifies the days of the week to perform the backup. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

Note: Only 1 save location is supported for ASCII saves.









Alphabetical List

Example: Listing Scheduled Job

The following command lists the job ID of the currently scheduled backup job:

nhSaveDbConfig -list

------+--------+------------------+------------------+---------+--------+--------

--------+ BACKUP| BACKUP | PERIOD | PERIOD | IS | IS

| START ID | MODE | FULL | INCR |COMPRESS | FAST

| AT ------+--------+------------------+------------------+---------+--------

+----------------+ 1 |binary Every 7 days M,Tu,W,Th,F,Sa No

No 09/24/2006 23:00 ------+--------+------------------+----------------

--+---------+--------+----------------+ 09/18/2006 08:36:49 PM - Done.

Example: Deleting an Existing Job

The following command deletes an existing job with a jobID of 1.

nhSaveDbConfig -delete 1

Example: Scheduling Daily Incremental Saves

The following command schedules an incremental level 0 save to occur every Sunday at 7:00 P.M. and a level 1 save to occur Monday through Saturday at the same time. This command also specifies three separate paths in which to save the database.

nhSaveDbConfig -add -incrLevel0Days 7 -incrLevel1 daily nyyyyyy

-startDate 09/24/2006 -startTime 19:00

-p /export/disk12/eHealth/backup.tdb



Note: When you specify daily, you include the days on which level 1 backups run.

Example: Scheduling Periodic Incremental Saves

The following command schedules an incremental level 0 save to occur every Sunday at 7:00 P.M. and a level 1 save to occur every 6 hours. This command also specifies two separate paths in which to save the database.

nhSaveDbConfig -add -incrLevel0Days 7 -incrLevel1 period 6




Example: Scheduling Full (Standard) Saves


Alphabetical List

The following command schedules a full (standard) save to occur every day at 11:15 P.M.

nhSaveDbConfig -add -fullBackup daily yyyyyyy



Example: Scheduling a Weekly Universal (ASCII) Save

The following command schedules a universal (ASCII) save to occur every Saturday at 2:45 A.M.

nhSaveDbConfig -add -ascii daily nnnnnny




Alphabetical List

nhSchedule

Schedules and manages jobs that you want to run regularly. eHealth provides several predefined job types: Data Analysis, Update Views, Cleanup Nodes, Name Nodes, Delete Old Reports, Delete Database Archive, Maintenance, Find Cluster Differences, Conversations Rollup, Live Exceptions History and Live Exceptions Baseline, and Statistics Rollup. You can create new job types for any operating system or eHealth command that the eHealth user can run.

To list a specific job or all scheduled jobs, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] -list

[ -type \"<typeName>\" ] [ -full ]

To list all job type that you can schedule, use the following format:

nhSchedule -listTypes

To enable a scheduled job, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] -enable <jobId>

To disable a scheduled job, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] -disable <jobId>

To add a scheduled job, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ]

-schedule \"<typeName>\" [ -jobId <jobId> ] -time \"<time>\"

{ -daily <nyyyyyn> | -monthly <nn> | -period <i> } [ -args '<args>' ]

To modify a scheduled job, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] -modify <jobId>

[ -time \"<time>\" ] { -daily <nyyyyyn> | -monthly <nn> | -period <i> }

[ -args '<args>' ]

To delete a scheduled job, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] -delete <jobId>

To delete a job type, use the following format:

nhSchedule -deleteType <\"typeName\">

To create a specific type of scheduled job, use the following format:


-defineType \"<typeName>\" -load <load> -cmd '<command>'

To modify a specific type of scheduled job, use the following format:


Alphabetical List


-modifyType \"<typeName>\" -load <load> -cmd '<command>'

To make a copy of an existing scheduled job, use the following format:

nhSchedule -copy <jobId>

To indicate the cluster systems that nhSchedule should affect, use the following format:

nhSchedule [ -host <hostname> | -cluster | -all ] <otherArguments>



-host <hostname> (Optional) In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to run the command. You can specify this argument if you do not specify -cluster or -all.

-cluster (Optional) In a Distributed eHealth cluster, runs the command on all eHealth systems in the cluster except the local system. You can specify this argument if you do not specify -host or -all.

-all (Optional) In a Distributed eHealth cluster, runs the command on all eHealth systems in the cluster. You can specify this argument if you do not specify -host or -cluster.

-list (Required to list jobs) Lists one or more scheduled jobs.

-enable <jobId> (Required to enable jobs) Enables the specified disabled job, which causes a disabled scheduled job to run as scheduled.

-disable <jobId> (Required to disable jobs) Disables the specified job. A disabled job remains in the schedule queue, but it does not run until it is enabled.

-schedule "<typeName>"

(Required to schedule a job) Specifies the job to schedule. <typeName> must be enclosed in quotation marks (" "). To list the available job types, specify -listTypes. This argument is required when scheduling a system job.

-modify <jobId> (Required to modify a job) Modifies the specified job.

-delete <jobId> (Required to delete a job) Deletes the specified job and removes it from the schedule queue.


Alphabetical List



-copy <jobId> (Required to copy a job) Creates a copy of the specified job with a new jobId value and all the same attributes as the original job. You can specify this argument only if you do not specify -host or -cluster or -all.

-type "<typeName>"

(Optional) Specifies the job type to list. You must specify the job type in quotation marks (" ").

-jobId <jobId> (Optional) Assigns a job ID to the scheduled job at creation time or specifies the job ID from the job list. Duplicate job IDs are not permitted.

-listTypes (Required to list all job types) Lists all job types that you can schedule, including predefined job types and any user-defined types.

-defineType "<typeName>"

(Required to create a job type) Specifies the name of the job type to create. Enclose <typeName> in quotation marks (" "). After you create a job type, you can schedule it.

-full (Optional) Shows any arguments specified for the job.

-modifyType "<typeName>"

(Required) Modifies the specified type of scheduled job. <typeName> must be enclosed in quotation marks (" ").

-deleteType "<typeName>"

(Required to delete a job type) Specifies the eHealth job type to delete. Must enclose <typeName> in quotation marks (" ").

-cmd '<command>' (Required to create or modify a job type) Specifies the command that you want to add as a job type. You must specify the full pathname. You can also specify the necessary arguments. The command and arguments must be enclosed in single quotes (' '). You must specify this argument last.

-load <load> (Required to create or modify a job type) Specifies the percentage of system resources that this command is expected to use while running. You can specify values of 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100 percent. If you schedule several jobs to run at the same time, eHealth runs as many jobs as possible, up to a cumulative load of 100%.

Alphabetical List



-time "<time>" (Required to schedule or modify a job) Specifies the time to run the job. <time> must be enclosed in quotation marks (" "). Enter the time in the format specified at installation. For example, specify one of the following: \"17:30\" or \"5:30 PM\". If you use it with -daily or -monthly, it specifies the time of day to start the job. If you use it with -period, it specifies the first execution of the command.

-daily <days> (Required) Specifies the days of the week on which to run the command. Enter y to run the command on that day or n to not run the command, starting with Sunday. For example, to run the command on Monday through Friday, specify: nyyyyyn. You must enter seven letters. When scheduling or modifying a system job, you must specify this argument if you do not specify -monthly or -period.

-monthly <nn> (Required) Specifies the day of the month on which to run the job. You can enter values from 1 to 31. If you specify -monthly 31, eHealth will run the scheduled job on the 31st of each month that contains 31 days. eHealth does not run the job for months that contain less than 31 days. When scheduling or modifying a system job, you must specify this argument if you do not specify -daily or -period.

-period <i> (Required) Specifies the interval in hours to run the command. You can enter 1, 2, 4, 6, 8, or 12 hours. When scheduling or modifying a system job, you must specify this argument if you do not specify -monthly or -daily.

-args '<args>' (Optional) Specifies the command arguments to include. The arguments must be enclosed in single quotes (' '). This argument is optional when scheduling a system job. If you do specify it, it must be the last argument.

Alphabetical List

Examples:

■ The following example lists all scheduled jobs and displays any arguments specified for the jobs:

nhSchedule -list -full

-JobId- -Days------------ -Status- -RunTime--------- -Name----------------

100000 Every 4 hours Enabled 05/16/02 12:05:00 Conversations Rollup

100001 Su,M,Tu,W,Th,F,Sa Enabled 01/01/02 00:05:00 Statistics Rollup

100020 Th Enabled 02/05/02 01:00:00 ServerRpt -s

-type svr -scope day -cf Standard.cfg -scheduled

■ The following example enables a disabled job with a job ID of 1000002:

nhSchedule -enable 1000002

■ The following example disables a scheduled job with a job ID of 1000002:

nhSchedule -disable 1000002

■ The following example adds a node-naming job at 2:30 a.m. each Monday:

nhSchedule -schedule \"Name Nodes\" -time \"2:30 AM\" -daily nynnnnn -args '-

dns'

■ The following example schedules a node-naming job with a job ID of 1000100 to run every 12 hours starting at 6:00 p.m:

nhSchedule -schedule \"Name Nodes\" -jobId 100017 -time \"06:00 PM\"

-period 12 -args '-dns'

■ The following example schedules a node-naming job to run at 2:00 a.m. on the first day of every month:

nhSchedule -schedule \"Name Nodes\" -time \"02:00 AM\" -monthly 1 -args '-

dns'

■ The following example modifies a scheduled job (job ID 1000600) to run every 12 hours starting at 6:00 p.m:

nhSchedule -modify 100060 -time \"6:00 PM\" -period 12 -args '-testarg'

■ The following example deletes a scheduled job with a job ID of 1000002:

nhSchedule -delete 1000002

■ The following example enables a disabled job with a job ID of 1000002 on the eHealth system named max:

nhSchedule -host max -enable 1000002

■ The following example disables a scheduled job with a job ID of 1000002 on all eHealth systems in the cluster except the local system:

nhSchedule -cluster -disable 1000002


Alphabetical List

Create Job Types

If you write a script that you want to run regularly, you can create a job type for that script.

This command has the following format: nhSchedule -defineType "typeName" -load

-cmd 'command'


-defineType "typeName" Specifies the name of the job type to create. The typeName must be enclosed in double quotes (" "). After you create a job type, you can schedule it.

-load load Specifies the percentage of system resources that this command is expected to use while running. You can specify values of 10, 20, 30, 40, 50, 60, 70, 80, 90, and 100 percent. If you schedule several jobs to run at the same time, eHealth runs as many jobs as possible, up to a cumulative load of 100%.

-cmd 'command' Specifies the command that you want to add as a job type. You must specify the full pathname. You can also specify the necessary arguments for the command. The command and its arguments must be enclosed in single quotes ( ' ). You must specify this argument last.

Be sure to enclose the command in single quotes. If you use double quotes ( " ), the nhSchedule command immediately expands the values of any environment variables used in the command (such as NH_HOME). As a result, the scheduled command may not work properly if the environment variables are later redefined (for example, after upgrading or migrating eHealth to the next release).


Alphabetical List

Examples:

■ If you have a script that examines the amount of free space in the partition in which eHealth is installed, you can create a job type for that script. On a Windows system, enter a command similar to the following:

nhSchedule -defineType "Check Disk Space" \

-load 10 -cmd 'c:\home\bin\chkDskSpc'

■ On a UNIX system, enter a command similar to the following:

nhSchedule -defineType "Check Disk Space" \

-load 10 -cmd '/home/bin/chkDskSpc'

You can then schedule jobs for your job type.

Modify Job Types

Use the -modifyType argument with the nhSchedule command to redefine a job type. You use the same arguments with -modifyType as with -defineType.

This command has the following format: nhSchedule -modifyType "typeName" -load load -cmd 'command'

For argument definitions, see Create Job Types.

Example:

Assume that you have run the command example for a Windows system in the Create Job Types. Enter the following command to modify that job type by increasing the percentage of system resources from 10 percent to 30 percent:

nhSchedule -modifyType "Check Disc Space" \

-load 30 -cmd 'c:\home\bin\chkDskSpc'

Delete Job Types

Use the -deleteType argument with the nhSchedule command to delete a job type that you created.

Note: You can delete only the job types that you have created.

This command has the following format: nhSchedule -deleteType "typeName"

- deleteType "typeName"

Specifies the eHealth job type to delete. The typeName must be enclosed in double quotation marks (" ").


Alphabetical List

List Job Types

Use the -listTypes argument with the nhSchedule command to list all job types that you can schedule.

This command has the following format: nhSchedule -listTypes

- listTypes

Lists all job types that you can schedule, including predefined job types and any user-defined types.

Schedule a Job

Use the -schedule argument with the nhSchedule command to schedule a job.


The nhSchedule command for scheduling a job uses the following syntax: nhSchedule -schedule "typeName" [-jobId "jobID"] -time "time"

{-daily days | -monthly nn | - period i } [-args "args"]


- schedule "typeName" Specifies the job to schedule. You must enclose typeName in double quotes (" "). To list the available job types, specify the -listTypes argument.

-jobId jobID Assigns a job ID to the scheduled job at creation time or specifies the job ID from the job list. Duplicate job IDs are not permitted.

-time "time" Specifies the time to run the job. You must enclose the time in double quotes (" "). Enter the time in the format specified at installation. For example, specify one of the following: "17:30" or "5:30 PM"

If you specify -time with the -daily or -monthly argument, it specifies the time of day to start the job. If you use it with the -period argument, it specifies the first execution of the command.


Alphabetical List



-daily days Specifies the days of the week on which to run the command. Enter y to run the command on that day or n to not run the command, starting with Sunday. For example, to run the command on Monday through Friday, specify nyyyyyn.

You must enter seven letters. You must specify -daily, -monthly, or - period, but you cannot specify more than one of these arguments.

- monthly nn Specifies the day of the month on which to run the job. You can enter values from 1 to 31.

Note: If you specify - monthly 31, eHealth will run the scheduled job on the 31st of each month that contains 31 days. eHealth does not run the job for months that contain less than 31 days.

You must specify -daily, -monthly, or -period, but you cannot specify more than one of these arguments.

-period i Specifies the interval in hours to run the command. You can specify 1, 2, 4, 6, 8, or 12 hours.

You must specify -daily, -monthly, or -period, but you cannot specify more than one of these arguments.

-args "args" Specifies the command arguments to include. The arguments must be enclosed in quotation marks (" "). If you specify this argument, it must be the last one.

Alphabetical List

Examples:

■ Enter the following command to schedule a node-naming job at 2:30 a.m. each Monday:

nhSchedule -schedule "Name Nodes" \

-time "2:30 AM" -daily nynnnnn -args "-dns"

■ Enter the following command to schedule a node-naming job with a job ID of 1000100 to run every 12 hours starting at 6:00 p.m:


-jobId 100017 -time "06:00 PM" \

-period 12 -args "-dns"

■ Enter the following command to schedule a node-naming job to run at 2:00 a.m. on the first day of every month:


-time "02:00 AM" -monthly 1 -args "-dns"

Copy Scheduled Jobs

Use the -copy argument with the nhSchedule command to create a copy of a specified job that runs on an eHealth system.

This command has the following format: nhSchedule [-host hostname] -copy jobID


-host hostname In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to run the command. Specify this argument if you are copying a job that runs on an eHealth system within a Distributed eHealth cluster.

-copy jobID Copies the scheduled job and assigns a new job ID value and all of the same attributes as the original job.

Example:

The following example copies a scheduled job with a job ID of 100102 on an eHealth system named max in a Distributed eHealth cluster:

nhSchedule -host max -copy 100102

Note: You cannot copy system jobs.


Alphabetical List

List Scheduled Jobs

Use the -list argument with the nhSchedule command to list scheduled jobs.

This command has the following format: nhSchedule -list [-type "typeName"] [-full]


-list Lists one or more scheduled jobs.

-type " typeName" Specifies the job type to list. You must specify the job type in quotation marks (" ").

-full Shows any arguments specified for the jobs.

Example:

Enter the following command to produce output similar to the output show below:

nhSchedule -list -full

-JobId- -Days------------ -Status- -RunTime--------- -Name----------------

100000 Every 4 hours Enabled 05/16/03 12:05:00 Conversations Rollup

100001 Su,M,Tu,W,Th,F,Sa Enabled 01/01/03 00:05:00 Statistics Rollup

100020 Th Enabled 02/05/03 01:00:00 ServerRpt -s

-type svr -scope day -cf Standard.cfg -scheduled

Modify Scheduled Jobs

Use the -modify argument with the nhSchedule command to modify scheduled jobs.


nhSchedule -modify jobID -time "time"

{-daily days | -monthly nn | -period i }

[-args "args”]


-modify jobID Modifies the specified job.


Alphabetical List



-time "time" Specifies the time to run the job. You must enclose the time in double quotes (" "). Enter the time in the format specified at installation. For example, specify one of the following: "17:30" or "5:30 PM"

If you specify -time with - daily or -monthly, it specifies the time of day to start the job. If you specify it with the -period argument, it specifies the first execution of the command.

-daily days Specifies the days of the week on which to run the command. Enter y to run the command on that day or n to not run the command. For example, to run the command on Monday through Friday, specify nyyyyyn.

You must enter seven letters. You must specify -daily, -monthly, or - period, but you cannot specify more than one of these arguments.

-monthly nn Specifies the day of the month on which to run the job. You can specify values from 1 to 31.

Note: If you specify - monthly 31, eHealth will run the scheduled job on the 31st of each month that contains 31 days. eHealth does not run the job for months that contain less than 31 days.

You must specify -daily, - monthly, or -period, but you cannot specify more than one of these arguments.

-period i Specifies the interval in hours to run the command. You can specify 1, 2, 4, 6, 8, or 12 hours.

You must specify -daily, - monthly, or -period, but you cannot specify more than one of these arguments.

-args "args" Specifies the command arguments to include. You must enclose the arguments in double quotes (" "). If you specify this argument, it must be the last one.

Note: You must specify all arguments, not only the arguments that you are changing.

Alphabetical List

Example:

Enter the following command to modify a scheduled job (job ID 1000600) to run every 12 hours starting at 6:00 p.m:

nhSchedule -modify 100060 -time "6:00 PM" \

-period 12 -args "-testarg"

Enable, Disable, and Delete Scheduled Jobs

You can use the -enable, -disable, and -delete arguments with the nhSchedule command, respectively, to enable, disable, and delete scheduled jobs.

This command has the following format: nhSchedule [-enable jobID]

nhSchedule [-disable jobID]

nhSchedule [-delete jobID]


-enable jobID Enables a disabled job, which causes a disabled scheduled job to run as scheduled.

-disable jobID Disables a job. A disabled job remains in the schedule queue, but it does not run until it is enabled.

-delete jobID Deletes a job and removes it from the schedule queue.

Examples:

■ To enable a disabled job with a job ID of 1000002, enter the following:

nhSchedule -enable 1000002

■ To disable a scheduled job with a job ID of 1000002, enter the following:

nhSchedule -disable 1000002

■ To delete a scheduled job with a job ID of 1000002, enter the following:

nhSchedule -delete 1000002

Manage Scheduled Jobs on Distributed eHealth Systems

When managing scheduled jobs on Distributed eHealth systems, you can use the -host, -cluster, and -all arguments to indicate the cluster systems that the command should affect.


Alphabetical List


The nhSchedule command uses the following syntax: nhSchedule [-host hostname | -cluster | -all] otherArguments


-host hostname In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to run the command.

-cluster In a Distributed eHealth cluster, runs the command on all eHealth systems in the cluster except the local system.

-all In a Distributed eHealth cluster, runs the command on all eHealth systems in the cluster.

otherArguments The other arguments that you can use to create and control scheduled jobs, as described in the preceding sections.

Examples:

■ To enable a disabled job with a job ID of 1000002 on the eHealth system named max, enter the following:

nhSchedule -host max -enable 1000002

■ To disable a scheduled job with a job ID of 1000002 on all eHealth systems in the cluster except the local system, enter the following:

nhSchedule -cluster -disable 1000002

■ To delete a scheduled job with a job ID of 1000002 on all eHealth systems in the cluster, enter the following:

nhSchedule -all -delete 1000002

nhScrubFsa

Removes temporary files in the File Staging Area (FSA) and soft-deleted objects that still have entries in the database on Distributed eHealth Systems, including:

■ Objects that are older than the number of hours specified by the NH_DB_DELETED_OBJECTS_TIME2KEEP environment variable, or older than seven days if that variable is not set.

■ Temporary files in the FSA that are older than the number of hours specified by the NH_FSA_SCRUB_TTL environment variable, or older than four hours if that variable is not set.


Alphabetical List

Note: When you delete an object such as a group, service profile, or group list, the deletion process immediately removes the object from your menus, subject selections, and other visible interface areas. However, a record of the object remains in the eHealth database until the scheduled FSA Scrubber job runs. These objects are called soft-deleted objects.

This command has the following format: nhScrubFsa [-h] [-rev] [-d database] [-u user]

[-fsaTtl FSA_time_to_live]

[-deletedObjectHours hours]




-d database Specifies the name of the database to clean. By default, nhScrubFsa operates on the database specified by the ORACLE_SID environment variable.

-u user Specifies a user who is authorized to access the database. The default is the value of the NH_USER environment variable.

-fsaTtl FSA_time_to_live Deletes temporary files in the file staging area and the corresponding entries in the database table NH_FILE_STAGING_AREA that are older than the number of hours specified. The default is 4. (The file staging area is ehealth/fileStagingArea, where ehealth represents the eHealth installation directory.)

You can use the NH_FSA_SCRUB_TTL environment variable to override this value.

- deletedObjectHours hours

Deletes from the database all objects that were soft- deleted before the number of hours specified. The default is 168 (one week).

You can use the NH_DB_DELETED_OBJECTS_TIME2KEEP environment variable to override this value.


Alphabetical List

Examples:

■ To delete all temporary FSA files and all soft-deleted objects from the database, enter the following:

nhScrubFsa -fsaTtl 0 -deleteObjectHours 0

■ To connect to the eHealth database as user green, delete temporary FSA files that are older than three hours, and delete soft-deleted objects that are older than seven hours, enter the following:

nhScrubFsa -d EHEALTH -u green -fsaTtl 3

-deletedObjectHours 7

nhSendSnmpTrap

Builds a Simple Network Management Protocol (SNMP) trap from command line arguments that you specify, or reads traps from a file. This command sends an actual trap, and an alarm should appear in the Live Exceptions Browser. Use this command to test your trap rule file (TRF) and to check whether Live Exceptions receives traps from devices properly.

Note: The SNMP variable type does not support an IPv6 address. The type is defined in RFC1212 as an OCTET of size 4 (a 32 bit value). If a trap is defined with one or more of its variable bindings as IPv6 addresses, the type will probably be octet string and not IP address.

This command has the following format: nhSendSnmpTrap [-debug] [-h] [-rev] -a ipAddress

[-s ipAddress] [-v version]

[-p port] [-f filePath ...] [- r number] [-i]

[-z] [-m path ...] [-gt genericType]

[-st specificType] [- e enterprise]

[-n notificationId] [-b {oid type value}]

Arguments Description

-debug Internal

Runs this command with debug output.



-a ipAddress (Required) Specifies the IP address to which the trap will be sent.

- s ipAddress Specifies the IP address of the source agent from which to simulate sending the trap.


Alphabetical List



-v version Specifies the SNMP version of the trap (v1, v2, v2c, or v3). The default is v1. If you specify v2c or v3, you must also use the -n argument.

-p port Specifies the port to which the trap will be sent. The default is 162.

-f filePath [...] Specifies the full pathnames of the standard trap files containing traps.

-r number Specifies the number of times to send the files or traps.

-i Ignores the trap timestamps in the standard trap files and sends the traps as soon as possible.

-z Processes traps using standard input.

-m path [...] Specifies the full pathname of one or more MIB files used to translate the symbolic names to object identifiers (OIDs).

-gt genericType Specifies the SNMP v1 generic trap type.

-st specificType Specifies the SNMP v1 specific trap type.

-e enterprise Specifies the SNMP v1 enterprise OID for command line traps.

-n notificationId Specifies the SNMP notification OID. This argument is required for SNMP v2c and v3.

Alphabetical List



-b {oid type value} ... Specifies variable bindings lists consisting of three bindings: oid, type, and value, separated by single spaces. The list functions as a data field in the SNMP protocol data unit (PDU) by binding objects with their current values.

oid – An ASN.1 object identifier (for example, .1.3.6.1.2.1.2.2.1). A symbolic OID must appear in one of the loaded MIBs or in a standard MIB.

type – The object type. The following are valid values: INTEGER, OCTETSTRING, OID, IPADDRESS, INTEGER32, Counter, Counter32, Gauge, Gauge32, TimeTicks, Unsigned32, Counter64.

value – The value of the type. The value must be of the same object type specified by the type argument.

Syntax Notes:

■ Enclose empty strings with double- quotes created using escape sequences—that is: \".

■ Enter long commands on one line.

Example:

The following example sends version 2c (v2c) SNMP traps and data expressed as strings and INTEGERS. Notice that v2c traps require the -n or notification OID argument.

nhSendSnmpTrap -v v2c -a 172.16.5.52 -p 7001 \

-n .1.3.6.1.4.1.546.0.1 \

-b .1.3.6.1.2.1.1.5.0 OCTETSTRING \

\"Monitoring variable mbufDesc oid 1.3.6.1.4.1.546.6.1.1.5\"

.1.3.6.1.4.1.546.6.1.1.5 OID \

.1.3.6.1.4.1.546.1.1.10.1.7.1.2.69 \

.1.3.6.1.4.1.546.6.1.1.6 INTEGER 666 \

.1.3.6.1.4.1.546.6.1.1.8 IPADDRESS 192.168.11.1 \

.1.3.6.1.4.1.546.6.1.1.8 INTEGER 333 \

.1.3.6.1.4.1.546.6.1.1.12 INTEGER 4 \

.1.3.6.1.4.1.546.6.1.1.7 INTEGER 2 \

.1.3.6.1.4.1.546.6.1.1.1 INTEGER 22 \

.1.3.6.1.4.1.546.6.1.1.16 INTEGER 42

Alphabetical List

nhServer

Starts and stops the eHealth server and displays its revision information.

This command has the following format: nhServer [-h] [-rev] [-c startup_file] [start | stop]




-c startup_file Specifies the initialization file that the eHealth server should use when the server starts. The default is ehealth/sys/startup.cfg, where ehealth represents the eHealth installation directory.

start Starts the eHealth server. This is the default.

stop Stops the eHealth server.

Examples:

■ To start the eHealth server, enter the following:

nhServer start

■ To stop the eHealth server, enter the following:

nhServer stop

■ To display revision information for the eHealth server, enter the following:

nhServer -rev

nhSetClusterMode

Changes the administration mode of the local cluster system. You can use this command to place an eHealth system in upgrade (or “quiet”) mode, which prevents any administrative changes to the database, such as the discovery of new elements, element modifications or deletions, or group administration.

Typically, you place the system in upgrade mode when you are upgrading the software on a cluster member, or when you need to troubleshoot problems on the system. This command also restores the system to full, administrative operations.


Alphabetical List

Important! You should only place an eHealth system in upgrade mode when Technical Support or a documented procedure instructs you to do so.

This command has the following format: nhSetClusterMode [-h] [-rev] {-upgrade | -fullAdmin}




- upgrade Places the eHealth system in upgrade mode, disabling administrative changes and updates to the database. This argument is required unless you specify -fullAdmin. If eHealth administrators perform a function that would normally update the database, eHealth displays an error message and does not save the changes.

- fullAdmin Places the eHealth system n full, administrative mode, enabling administrative changes and updates to the database. This argument is required unless you specify -upgrade.

nhSetClusterPasswd

Specifies the administration password that controls access and communications to the systems of a Distributed eHealth cluster.

The nhSetClusterPasswd command specifies the administration password that controls access and communications to the cluster systems. The password can be up to eight characters in length.

Note: After you change the cluster password using this command, restart the eHealth server on each cluster member to ensure that the new password takes effect. You cannot run this command on an untrusted member of the cluster.

This command has the following format: nhSetClusterPasswd [-h] [-rev] [-retryTime seconds]

[-timeout seconds]


Alphabetical List








Example:

The following command changes the cluster password for all systems in the cluster: nhSetClusterPasswd

Enter Cluster Password: oldPasswd

Enter New Cluster Password: newPasswd

Re-Enter New Cluster Password: newPasswd

Set cluster password initiated:

Establishing connections ... OK

Changing passwords ... OK

The command does not display the password characters that you type. The command hides the characters as a security precaution. As a security precaution, the cluster password is stored and transmitted in encrypted format.


Alphabetical List

nhSetRespLimit

Sets response limit values for a group of response path elements based on an input file such as the nhRecommend.txt file produced by the nhGetRespLimit command.

To use the nhSetRespLimit command, enter nhSetRespLimit at the command line, and respond to each prompt.

nhShowElementInfo

Displays element information and data from the poller configuration file. Use this command to debug Technical Support or polling problems such as duplicate elements or other data problems.

This command has the following format: nhShowElementInfo [-h] [-rev] -element elementId

[-time timeStamp] [- window minutes]




-element elementId Specifies the database element ID.

-time timeStamp Specifies a Universal Time Code (UTC) that you want to examine. The default is the current time.

-window minutes Specifies the number of minutes of data to display before and after the value specified by the -time argument. The default is 30 minutes. If you specify a time window that does not have polled data, this argument displays the available data instead.

nhShowImRev

Displays the third-party software versions supported by eHealth integration modules for which you are licensed.

This command has the following format: nhShowImRev [-h] [-all] [-versionFile filename]


Alphabetical List



-all Displays the versions of supported third-party software products for all integration modules, including integration modules for which you do not have a license.

By default, this command displays supported software versions only for the integration modules for which you are licensed.

- versionFile filename Specifies the version file to search. The version file contains the license keys and version information for each eHealth integration module.

The default value is ehealth/modules/common/itgRev.dat, where ehealth represents the eHealth installation directory.

Examples:

■ The following command lists third-party software versions supported by all eHealth integration modules, including those for which you are not licensed. (Supported software versions may differ from this example.)

nhShowImRev -all

Alcatel 5620 Network Manager:

5.3 H0-00

Cisco Netflow:

v4.0, v5.0

Cisco VPNSC:

2.1.x, 2.2.x

Cisco WAN Manager:

11.0, 12.0

HP OpenView:

6.4

Lucent Naviscore NMS / NavisXtend Statistics Server:

08,00.03.xx/04.00.02.xx, 08.01.00.02

Micromuse Netcool:

3.5, 3.6

Nortel Preside MDM/MDP:

14.2

Aprisma SPECTRUM:

6.0 Nortel SCS: 3.0


Alphabetical List

■ The following command displays supported versions of software for the licensed integration modules listed in an alternative version file:

nhShowImRev -versionFile ./altRefFile

nhShowRev

Outputs the eHealth release numbers, followed by the certification release and patch level. By default, the command also displays:

■ The dates of the latest certification verification kit and strategic patch installed on the system.

■ Installation history of patch and certification releases.

■ Hot fixes installed on the system.


nhShowRev [-h] [-quiet]



-quiet or -q Omits the text from the output, showing only the numeric values. (Use -q on UNIX systems.)


Alphabetical List

Examples:

■ When you run this command without any arguments, eHealth outputs the version information for your eHealth system in the following format:

eHealth version: x Dy - Patch Level: z

■ The x value is the eHealth release, Dy is the device certification level, and z is the eHealth device patch level for that release. The version information is followed by the dates of the latest certification verification kit and strategic patch installed on the system, the installation history of patch and certification releases, and any Hot fixes installed on the system. For example:


Cert Verification Kit: March_2006

Cert Strategic Patch: March_2006

Installation History:Installed Strategic Cert NH570505 on Jan 25 2006 09:47

[kit created: Jan 23 2006]

Installed Certification FH570305 on Jan 25 2006 09:50 [kit created: Jan 24

2006]

Installed Certification FH570305 on Mar 17 2006 09:19 [kit created: Mar 16

2006]

Installed Strategic Cert NH570505 on Mar 21 2006 10:14 [kit created: Mar 20

2006]

Installed Patch NH570505 on Mar 28 2006 10:41

[kit created: Mar 27 2006]

Hot Fixes:

17653.log

77474.log

■ When you run this command with the -quiet argument, eHealth outputs the numeric values, but omits the text. For example:

5.7.0 D05 05

nhSnmpTool

Displays a subset of the MIB information for the specified host and MIB. For the complete syntax, see the eHealth Data Integration Guide.

Important! Use this command only under the direction of Technical Support.


Alphabetical List

nhSpectrumSetup

The nhSpectrumSetup command configures the eHealth SPECTRUM Integration, which allows you to import configuration information about the network devices that you manage with SPECTRUM.

This command does not have any arguments. To use it, enter nhSpectrumSetup at the command line, and specify the requested parameters.

Note: The nhSpectrumSetup command may take a few seconds to run if you enter the arguments on the command line, depending on the computer you are using.

When the discovery request is sent to the eHealth server from the OneClick server, the community string from the configured attribute is used. If you elected to use the CommunityNameForSNMPSets attribute, but some of the devices in the discovery set do not have a value in that attribute, the discovery request reverts to the standard community_name attribute.

In releases prior to eHealth r6.1 and SPECTRUM r9.0, if you have configured nhSpectrumSetup and attempt to run a discovery using Spectrum import, the list of devices to discover includes the community string from the configured Spectrum attribute.

For more information, see the eHealth SPECTRUM Integration User Guide.

The following command line arguments are for internal use only. These arguments allow you to set the SPECTRUM import parameters directly, without bringing up the GUI. Most users will run the command without arguments, and use the GUI to specify these parameters. However, if you want to setup multiple eHealth systems, you can create a script that sets these values on each box.

This command has the following format: nhSpectrumSetup [-h] [-list] [-host name] [-port number] [-path path] [-user

name] [-password]



-list Lists the current setup parameters.

-host name Specifies the hostname or IP address of the SPECTRUM OneClick server.


Alphabetical List



-port number Specifies the port number for SPECTRUM OneClick server Web requests.

Default: 80

-path path Specifies the path in which SPECTRUM OneClick is installed on the server.

Default: spectrum.

Note: Use the default value unless you specified another path when installing SPECTRUM OneClick.

-user name Specifies the username used to log in to the SPECTRUM OneClick server.

-password Specifies the password for the selected user name.

Note: The password value is not supplied as an argument. After you enter the command, you must type the password. The password is then read by the program.

nhStartDb

Starts the Oracle instance of the eHealth database, as specified by the ORACLE_SID environment variable. It also starts the TNS Listener or SQL*Net.

Note: To perform periodic maintenance of the eHealth database, use the eHealth Maintenance schedule.

This command has the following format: nhStartDb [-h] [-s oracleSid] [-listenerName listenerName]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) for the eHealth database. By default, the nhStartDb command uses the value of the ORACLE_SID environment variable for oracleSid.

-listenerName listenerName Specifies a non-default listener name. The value that you specify replaces "LISTENER" as the the default value of the environment variable, NH_ORA_LISTENER_NAME.

Alphabetical List

Example:

Enter the following command to start the eHealth database:

nhStartDb

nhStopDb

Stops the Oracle instance of the eHealth database, as specified by the ORACLE_SID environment variable.

This command has the following format: nhStopDb [-h] [-s oracleSid]

[normal | immediate | abort]

[-listenerName listenerName]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) for the eHealth database. By default, the nhStopDb command uses the value of the ORACLE_SID environment variable for oracleSid.

normal (Default) Specifies a normal database shutdown, waiting for users to disconnect from the database. It proceeds as follows: nhStopDb checks for eHealth processes; if any are running, it issues an error and exits. You must stop all eHealth processes and run nhStopDb again. If eHealth processes are not running, nhStopDb does the following:

■ Prevents further connections to the database.

■ Waits for users to disconnect from the database.

■ Closes and dismounts the database.

■ Shuts down the Oracle instance. (Instance recovery is not required on the next database startup.)


Alphabetical List



immediate Specifies an immediate database shutdown without waiting for calls to finish or users to disconnect. It proceeds as follows: nhStopDb checks for eHealth processes; if any are running, it issues a warning and then stops those processes. It then does the following:


■ Closes and dismounts the database (without waiting for current calls to finish or users to disconnect from the database).


abort Specifies the fastest possible shutdown of the database without waiting for calls to finish or users to disconnect. Use this option if a background process terminates abnormally. nhStopDb checks for eHealth processes; if any are running, it issues a warning and then stops those processes. It then does the following:

■ Disconnects all users currently connected to the database.

■ Terminates client SQL statements currently being processed.

■ Does not roll back uncommitted transactions. (The next database startup will require instance recovery.)

-listenerName listenerName

Specifies a non-default listener name. The value you specify for this option precedes the environment variable NH_ORA_LISTENER_NAME, which precedes the default value of "LISTENER".

nhSvDiagnose

This diagnostic tool for eHealth Integration for Cisco WAN Manager identifies and resolves statistics collection problems and avoids further configuration and polling problems.

Alphabetical List

nhSvGetCfg

Extracts configuration information from a Cisco WAN Manager NMS.

nhSvInstall

Installs and sets up the eHealth Integration for Cisco WAN Manager module.

nhSynchronize

Synchronizes one or more eHealth systems in a Distributed eHealth cluster. It retrieves object information from the other systems and updates the local eHealth cluster system.

Note: The nhSynchronize command synchronizes one or more eHealth systems in the cluster. It retrieves object information from the other systems and updates the local eHealth cluster system. (The Distributed eHealth Consoles run this command as a scheduled job to obtain the latest object information from the cluster systems.)

When you run this command from a Distributed eHealth Console, the command updates only the element information that has changed since the last synchronization (as a result of either the scheduled Synchronize job or the nhSynchronize command). Use the - allElements argument to force the synchronization of all elements.


The command has the following syntax:

nhSynchronize [-h] [-rev] { -host hostname | -cluster }

{ -objTypeAll | -objType objType[,objType,...] | -objTypeList }

[ -allObjects | -name objName | -id uid ][-allElements]

[-retryTime seconds]




-host hostname Updates the local system with the replicated information from the specified eHealth system. This argument is required unless you specify -cluster.


Alphabetical List



-cluster Updates the local system with the replicated information from all other eHealth systems in the cluster. This argument is required unless you specify -host.

-objTypeAll Synchronizes the information for all object types. This is the default.

-objType objType[,objType,...]

Synchronizes the information for the specified object types. You must enclose the objType values in quotes (" "), separated by a comma. You can select one or more of the following object type values:

■ element

■ group

■ groupSection

■ groupList


■ dataAnalysisRec

■ serviceProfile

-objTypeList Lists the supported object types, but does process the command. Use this argument to list the valid objType values for the -objType argument.

-allObjects Synchronizes all objects of the specified object type. This is the default.

-name objName Synchronizes the object that has the name objName.

-id uid Synchronizes the object with the specified unique ID (uid). The uid is a combination of the member ID of the system on which the object was created and the database ID for the object. It has a format similar to the following:

739249213@1000001

-allElements Synchronizes all elements, not just those that changed since the last time that the elements were synchronized. If you do not specify this argument, the command synchronizes only those elements that have changed since the last synchronization.

Alphabetical List





Examples:

■ The following command updates the local system with the replicated information from the system named eire:

nhSynchronize -host eire

Cluster Sync initiated:

Synchronizing objects of type group .. OK

Synchronizing objects of type groupList .. OK

Synchronizing objects of type groupListContents .. OK

Synchronizing objects of type serviceProfile .. OK

Synchronizing objects of type dataAnalysisRec OK

In the example command, note that the status line for the dataAnalysisRec objects does not have any periods(.). When the local system and the -host system are both Distributed eHealth Systems, they do not synchronize data analysis records. Thus this step is omitted (which the command indicates by not displaying periods at the end of the status line for that object type).

■ The following command synchronizes all systems in the cluster except the local system:

nhSynchronize -cluster


Synchronizing objects of type group ..... OK

Synchronizing objects of type groupList ..... OK

Synchronizing objects of type groupListContents ..... OK

Synchronizing objects of type dataAnalysisRec ..... OK

nhTaDataPurge

Deletes Traffic Accountant data from the eHealth database, and specifies that Traffic Accountant is in node-to-node or AS-to-AS mode.

Alphabetical List

This command has the following format: nhTaDataPurge [-h] mode



mode Specifies the mode in which Traffic Accountant operates, based on one of the following:

as or AS – AS- to-AS mode

ip or IP – node- to-node mode

nhTestTrapRule

Tests a trap rule file (TRF) without restarting the eHealth server. After you write a new TRF and save it in the ehealth/extensions/traps/usr directory, you can use the nhTestTrapRule command to test that the rule file accepts the trap type information and properly formats it.

Note: Use the nhTestTrapRule command to test the SNMP Version 1-style of trap information only. You cannot use nhTestTrapRule to test trap information for other versions of SNMP.

This command has the following format: nhTestTrapRule [-h] [-rev] [-v] [-u] [-gt genericType]

[-st specificType] [- e enterpriseOid]

[-b variable oid type value ...]





-u Outputs the userMessage variable as a list of arguments and skips substitutions. The userMessage variable is one of eight variables that compose the User-Visible Information section of the TRF. This section defines the format of all user-visible information that appears in the Live Exceptions Browser or the Rule Editor dialog box.


Alphabetical List



-gt genericType Specifies the SNMP v1 generic trap type. The default value for genericType is 0 (zero).

-st specificType Specifies the SNMP v1 specific trap type. The default value for specificType is 0 (zero).

-e enterpriseOid Specifies the SNMP v1 enterprise OID for command line traps. The default value for enterpriseOid is 0.0.

-b variable oid type value [...] Specifies variable bindings lists. Each list consists of four bindings: variable, oid, type, and value. The list functions as a data field in the SNMP protocol data unit (PDU) by binding objects with their current values.

variable – Name of the variable.

oid – An ASN.1 object identifier (for example, .1.3.6.1.2.1.2.2.1). A symbolic OID must appear in one of the loaded MIBs or in a standard RFC MIB.

type – The object type. The following are valid values: integer, oid, string.


Syntax Notes:

■ Enclose empty strings with double-quotes created using escape sequences—that is: \".


nhTranslateTrapLog

Translates binary, ASCII, or Micromuse Netcool trap log files into ASCII or a standard form that can be sent to the nhSendSnmpTrap command. Use this command to evaluate non-certified traps or to rerun traps for testing or certification purposes.

Alphabetical List

This command has the following format: nhTranslateTrapLog [-h]

{-bin inputfile [-t pduIdList] | -ascii inputfile | -netcool inputfile}

[[-ascii | - standard] outputfile]



-bin, - ascii, or - netcool (Required) Specifies the format of the input file, consisting of one of the following:

-bin – A binary trap server log file. If you specify -bin, you must also specify -t.

-ascii – A readable and editable text format.

-netcool – A Netcool trapd log file.

inputfile (Required) Specifies the name of the trap file to translate.

-t pduIdList (Optional) Specifies a list of protocol data unit (PDU) IDs or sequence numbers of the traps to be translated. Uncertified traps have an associated PDU ID. For the PDU ID, see the browser or tool displaying the trap that you want to translate. The Live Exceptions Browser displays the PDU ID in the Description column.

You can use this argument only when specifying the -bin argument; you cannot use it with -ascii or - netcool.

-ascii or -standard (Optional) Specifies the format of the output file:


-standard – A file format that can be used with the nhSendSnmpTrap command. This argument is the default.

outputfile (Optional) Overrides the standard output with the file name you supply.


Alphabetical List

Examples:

■ This example shows how to certify traps:

1. Obtain the non-certified trap’s PDU ID from the browser or the tool displaying the trap.

2. To convert the trap to a readable ASCII format file, enter the following command:

nhTranslateTrapLog -t pduId -bin inputfile -ascii outputfile.log

■ This example shows how to use the nhTranslateTrapLog and nhSendSnmpTrap commands to rerun a log immediately after it has been translated. Use this syntax to replay traps for certification or testing purposes:

nhTranslateTrapLog -netcool trapd.log | \

nhSendSNMPTrap -a 172.16.5.58 - z

Note: In this syntax example, “|” is the pipe command, not an “or” condition.

nhUpdateClusterTable

Updates the member table information on the local system with the information from one or more other systems in a Distributed eHealth cluster. The member table is an internal table that provides information about all eHealth systems in the cluster.

You typically use this command after you restore an eHealth system to the cluster, or after you load a database on an eHealth system in the cluster, to ensure that the member table on the system is current with the cluster.


nhUpdateClusterTable [-h] [-rev] { -host hostname | -cluster }

[-retryTime seconds] [-timeout seconds]




-host hostname Updates the member table on the local system with the member table information from the specified eHealth system. This argument is required unless you specify -cluster.


Alphabetical List



-cluster Updates the member table on the local system with the member table information on all of the other eHealth systems in the cluster. This argument is required unless you specify - host.





Example:

The following command updates the member table on the local system with the member table on the system named eire: nhUpdateClusterTable -host eire

Cluster Fix Machine Table initiated:

Querying cluster .. OK

nhUpdateDatabaseIds

In a Distributed eHealth cluster, updates the eHealth database ID table on the local system with the database ID table information on one or more cluster systems. Use this command after you load a database in order to ensure that the local system is up-to-date with its next available database ID.

nhUpdateDbProtocol

Updates the database with any changes that you make to user application definition files in the sys directory of your eHealth installation. If you have a Traffic Accountant license, you can add definitions for your specific applications to these files to generate reports on the conversations for these applications.

Alphabetical List

This command has the following format: nhUpdateDbProtocol [-u user] -t user|sys database



-t user | sys Specifies the type of application definition file to use: user or sys. This argument is required.

For more information about specifying the file type, see the “Editing User Application Definition Files” section below.

database Specifies the name of the database on which to run the status. This argument is required.

-host hostname Specifies the name of the eHealth system in the cluster on which you want to run the command. For example, to run the nhDbStatus command on the eHealth system named max, enter the following command from any eHealth system in the cluster:


-cluster Runs the command on all eHealth systems in the cluster except the local system.

-all Runs the command on all eHealth systems in the cluster.

Edit User Application Definition Files

The following table lists the application definition files that eHealth provides in the sys directory in your eHealth installation:

Files Description

decnetApplics.* Defines DECnet applications.

protocolsOverDll.* Defines applications using the data link layer (DLL) protocol, such as Ethernet and Link Service Access Point (LSAP).

protocolsOverIp.* Defines applications using the IP protocol.

socketsOverIpx.* Defines applications using IPX sockets.

tcpIpPorts.* Defines well-known TCP/IP and UDP/IP ports.


Alphabetical List


Files Description

tcpIpPrograms.* Defines applications using TCP/IP port numbers.

Each file has a .sys file and a .user file. The .sys file contains the list of commonly used socket or port numbers for the designated protocol or application. The .user files are the files that you can edit to add your specific applications.

Each protocol or application occupies a line in the file that contains its ID (the socket or port number), an abbreviation (used by eHealth to identify the application), and a description. The following is an example of a portion of the tcpIpPorts.sys file: # id abbrev (12) "description"

1 TCP-MUX "TCP Port Service Multiplexer"

2 MGMT-UTILITY "Management Utility"

3 COMPRESSION "Compression Process"

4 RJE "Remote Job Entry"

5 ECHO "Echo"

When you edit the .user file, use this format and follow these guidelines:

■ Specify IDs as either decimal or hexadecimal with all hexadecimal numbers preceded by 0x.

■ Add comments to any line by prefacing them with the pound sign (#).

■ For the abbreviation, use up to 12 single-byte characters without any spaces. You can use dashes (-) or underscores (_). If an abbreviation can be interpreted as a hexadecimal number (that is, containing only numbers 0 through 9 and letters A through F), you must enclose it in double quotes (" "). If you use double-byte characters, the name cannot exceed six bytes.

For the description, use a maximum of 32 single-byte characters enclosed in double quotes (" ").

Update the Database

After you change the .user files, you can enter the following command to update the database:

nhUpdateDbProtocol -t user database

Alphabetical List

nhUpdateLicenses

Sends a message to the Message server to include the new license file on servers that already process new license information. This is applicable mainly for Poller and some Application Response servers.


nhUpdateLicenses <arguments>




nhUpdateServiceNote

Enables you to change a Business Service Console (BSC) service note to update users on the status of a performance availability problem that a business service is experiencing and the actions that are being taken to manage and resolve the problem.

This command has the following format: nhUpdateServiceNote [-h] -noteID ID -updatedBy webUser

[-appType applicationName] [-owner webUser] [-note "note"]

[-title "title"] [-readers "reader1;reader2;..."]


[-status {active | inactive}]



-noteID ID (Required) Specifies the ID number of the service note that you want to modify.

-updatedBy webUser (Required) Specifies the user who is updating the note. The user name must be a valid eHealth Web user ID, and it cannot exceed 64 characters.

-appType applicationName (Optional) Specifies the note application type. The applicationName must be a valid application.


Alphabetical List



-owner webUser (Optional) Specifies the owner of the note. The user name must be a valid eHealth Web user name, and it cannot exceed 64 characters.

-note note (Optional) Replaces the text of the note with an updated message. The note must be enclosed in quotation marks.

-title title (Optional) Specifies or replaces the title of the note. The title must be enclosed in quotation marks.

-readers reader1;reader2;... (Optional) Specifies a list of users who should have read permissions to review the note. The list must be enclosed in quotation marks. The names in the series are case-sensitive and must be separated by a semicolon. Each name can be a valid eHealth Web user name or user alias. The value is case-sensitive.

-ticket problemTicketIdentifier (Optional) Specifies the problem ticket identifier associated with the issue that is documented in the service note.

-status {active | inactive} (Optional) Specifies the status of the issue that is being communicated in the note. Valid values are active and inactive.

Example:

The following example updates a service note to notify four people about a change in status concerning a problem that occurred previously with the mail system. nhUpdateServiceNote -noteId 456 -updatedBy jsmith

-note "Outlook response has now improved. The server was

experiencing some problems, but they have now been resolved."

-readers "jJones;rBrown;sGarrison;dLoring" -ticket 34567

-status inactive

Note: For the owner and the list of readers, you must specify Web user names only; do not specify Web user aliases.

Alphabetical List

Guidelines for Changing the Ownership of a Service Note

If you are an administrator, and you reassign the ownership of a note to another user, your name still appears in the Readers list (although the user cannot see the name). Because the administrator is not typically part of any user’s domain, the user cannot edit the Service Note. To enable the new owner of the note to make modifications, you must remove your name from the Readers list.

nhUpgradeCluster

Lets you manage eHealth release upgrades across a cluster.

This command has the following format: nhUpgradeCluster [-h]

[-activate | -validate | -rollback] [-local]



-activate Activates a new release of eHealth across a cluster and deactivates the previous release.

-validate Confirms that eHealth has started across a cluster.

-rollback Reverts the cluster to the previous eHealth version. Use this argument if errors occurred during activation.

Note: After you run the nhUpgradeCluster command with the -rollback argument, the cluster is in quiet mode. To return the cluster to full administration mode, run the nhSetClusterMode command with the -fullAdmin argument.

-local Runs the nhUpgradeCluster command and the selected argument on the local system rather than across a cluster. For example, to ensure that eHealth has started on the local system, specify -validate and -local.

By default (if you omit -local), the command runs on all eHealth systems in the cluster.

nhUpgradeOracleDb

Lets you upgrade the eHealth database from Oracle8i to Oracle9i on a standalone system or across a Distributed eHealth cluster.


Alphabetical List

This command has the following format: nhUpgradeOracleDb [-h] [-rev]




nhVpnscSetup

Installs and sets up eHealth Integration for Cisco VPN Solutions Center.

nhWebProtocol

Enables and disables an SSL connection on your eHealth web server.

This command has the following format: nhWebProtocol -h -mode {http | https} -port portNumber

-certificate certificateFile - key keyFile

-intermediate intermediateCertificateFile

-hostname hostName - passphrase passphrase



{http | https}

(Required) Specifies the mode that Apache should use:

■ HTTP is an Internet protocol that is used to transfer information via the web.

■ HTTPS represents a secure HTTP that adds an additional encryption/authentication layer between HTTP and Transmission Control Protocol (TCP).

-port portNumber (Optional) Specifies a value used to map data that is coming through a network protocol to a particular process running on a computer. By default, eHealth uses port 80 for HTTP and uses port 443 for HTTPS.

-certificate certificateFile

Specifies a digital identity certificate, also known as a public key certificate. Required when you enable SSL using a secure server certificate file issued by a Certificate Authority; otherwise, it is optional.


Alphabetical List



-key keyFile Specifies information that controls the operation of a cryptography algorithm. Required when you enable SSL using a secure server certificate file issued by a Certificate Authority; otherwise, it is optional. Without this argument, eHealth generates a certificate/key.


Specifies a certificate issued by a Certificate Authority for another Certificate Authority. When enabling SSL using a secure server certificate file issued by a Certificate Authority and providing an intermediate certificate, this argument is required; otherwise, it is optional.

-hostname hostName

Specifies the unique name by which a network-attached device is known on a network. When enabling SSL with a self-signed certificate, this argument is required; otherwise, it is optional.

-passphrase passphrase

Specifies the pass phrase needed for a certificate/key to ensure that the Apache web server functions correctly. Required for keys that are protected by a pass phrase; otherwise, it is optional.

Examples:

■ To enable SSL support using a signed certificate from a Certificate Authority, enter the following command: nhWebProtocol -mode https -certificate certificatefile -key keyfile -

intermediate intermediatecertificatefile -passphrase passphrase

■ To enable SSL support using a self-signed secure certificate, enter the following command:

nhWebProtocol –mode https –hostname hostname

■ To disable SSL support and restore the default (HTTP) web server configuration, enter the following command: nhWebProtocol -mode http

nhWebSso

The nhWebSSO command line utility enables SSO support with eHealth SPECTRUM integration and lets you modify the directives in httpd.conf for direct Apache to lad and authenticate using the eHealth Apache module mod_eem_sso.


nhWebSso -h

Alphabetical List


-disableFallback (Optional) Specifies that Single Sign-on is disabled.

-hostname (Required if -disbable is not specified.) Specifies the fully qualified hostname of an EEM backend server.

-idleTimeout (Optional) The idle timeout (in minutes) before the user is rechallenged for authentication when accessing eHealth from an external application.

Default: 10 minutes.

-disable Disables Single Sign-on if specified. Set EEMSSOAuthEnable to Off and remove all other EEM directives from httpd.conf.

Examples:

■ nhWebSso -hostname <name of host> -idleTimeout 10 -disableFallback

■ nhWebSso -disable

nhWebUtil

Performs various operations related to the eHealth Web interface. You can use this command to:

■ Update the users.cfg file from a previous release of eHealth .

■ Reset the users.cfg file to the default version of the file.

■ Recreate the reportIndex.txt files.

■ Convert MyHealth files for use with the latest release of eHealth.

■ List licenses for technology types available for Web reporting.

■ Hide the MyHealth tab of the eHealth Web interface.

■ List files of a specified type located in a directory.

This command has the following format: nhWebUtil [-h]

[-cfg | -init | -myHealth value | -index | - license |

-convertMyHealth]

[-o outfile] [-dir pathname] [-suffix filetype]

[-setupTomcat]


Alphabetical List



-cfg (Optional) Updates the users.cfg file from a previous release of eHealth.

-init (Optional) Replaces the current users.cfg file with the default version of the file. You can use this argument, for example, to update the default time zone used for eHealth Web users with the current time zone on the local system, or to replace a corrupt users.cfg file.

Important! Use -init only on a new eHealth installation or to repair a corrupt users.cfg file. If you specify this argument on an established eHealth system, nhWebUtil overwrites the users.cfg file with a default version of the file, removing any users that you had added.

-o outfile (Optional) Specifies the output file. When you specify this argument with -cfg, -init, or -myHealth, it outputs the file to users.cfg.

-index (Optional) Recreates the reportIndex.txt files. Use this argument if you suspect that these files are corrupt. A reportIndex.txt file resides in each of the following directories (where ehealth represents the eHealth installation directory):

■ ehealth/web/output/users

■ ehealth/web/output/groups

■ ehealth/web/output/groupLists

■ ehealth/web/output/views

-license (Optional) Provides a list of licenses for technology types available for Web reporting. This argument is typically used for debugging purposes.


Alphabetical List



-convertMyHealth (Optional) Converts MyHealth files (*.mhd, *.rds, and *.rde in ehealth/reports/myHealth) and reschedules reports for these cases:

■ When a standalone eHealth joings an eHealth cluster, it updates machine IDs.

■ For an upgrade from Network Health Release 4.8 or eHealth Release 5.0, it replaces subject names with subject IDs.

■ For an upgrade from a release prior to 6.0, as a result of typed group conversion to untyped groups, it updates old group IDs to new IDs. It also updates Live Status Diagram files (LiveStatus.cfg), updating old group list subject IDs to new IDs.

-dir pathname (Optional) Scans the specified directory for files with the file type indicated with the -suffix argument, and stores a list of matching files in the outfile specified by the -o argument. This argument is typically used for debugging purposes.

-suffix filetype (Optional) When used with the -dir argument, specifies the file type (suffix) to search for.

-myHealth value (Optional) Specify -myHealth on to display the MyHealth tab on the eHealth Web interface. Specify -myHealth off to hide the MyHealth tab from all users, except for the admin user.

Specify the -f and -o argument to update the pathname of the users.cfg file with this setting.

-setupTomcat (Optional) Creates the Tomcat configuration file.

Examples:

■ The following command rewrites the users.cfg file with the backup version of that file:

nhWebUtil -cfg -f $NH_HOME/web/webCfg/users.cfg.bak -o users.cfg

■ The following command recreates all of the reportIndex.txt files:

nhWebUtil -index

■ The following command converts the MyHealth files for use with the latest release of eHealth:

nhWebUtil -convertMyHealth

Administration Commands

■ The following command allows all eHealth users to access MyHealth reports:

nhWebUtil -myHealth on \

-f $NH_HOME/web/webCfg/users.cfg \

-o $NH_HOME/web/webCfg/users.cfg

■ The following command generates a list of all GIF files that reside in the ehealth/web/output directory, where ehealth represents the eHealth installation directory:

nhWebUtil -dir $NH_HOME/web/output -suffix gif -o gifFiles

Administration Commands The administration commands are as follows:

■ ehealth

■ nhDrConfigScenario

■ nhDrSetup

■ nhExpire

■ nhExportDowntime

■ nhGetSupportInfo

■ nhHaSetup

■ nhImportDowntime

■ nhUpdateLicenses

ehealth

Starts the OneClick for eHealth console, the eHealth console, and, if necessary, the eHealth server. You can also use this command to run a secondary eHealth console from remote workstations on your network. Use this command to start eHealth on UNIX systems. (On Windows systems, you can start eHealth from the Start menu.)

Note: In prior releases, the nethealth command started eHealth.


ehealth [-h] [-2nd] [-display displayName] [-oce] [-motif]





-2nd Starts eHealth in a secondary console. For more information about secondary consoles, see the Using Secondary eHealth Consoles focus topic.

-display displayName Specifies the X Windows display to open the administrative consoles and view them on a remote system.

-oce Opens the OneClick for eHealth console, if it is installed. If you do not specify -oce or -motif, the command opens both consoles. If the eHealth servers are not already running, start them using the nhServer start command.

-motif Opens the OneClick Motif console and starts the eHealth servers if they are not already running. If you do not specify -oce or - motif, the command opens both consoles. If you specify only -motif, the command opens the Motif console only.

nhDrConfigScenario

Configures the scenarios for XOSoft WANSync. This script prompts the user for information and generates scenarios that are imported to WANSync using the command line interface.


nhDrConfigScenario

Example: Sample output

The following sample output shows the user response for the host name in italics:

Enter the nhuser password :

Enter the name of the standby server (WANSync replication host): uscisf01

Generating WANSync scenarios for replication from u10cluster to uscisf01.

Using default WANSync spool directory /space/WANSync/spool.

Using default WANSync reports directory /space/WANSync/reports.

You can update the WANSync scenarios by running /opt/WANSync/bin/ws_cli.

Would you like to perform an initial synchronization of the scenarios? [y]:



nhDrSetup

Configures an eHealth disaster recovery system with a shared hostname.

This command has the following format: nhDrSetup -hostname sharedhostname [-list] [-disable] [- configureStandby] [-h]


- hostname sharedhostname

Specifies the name of the shared host where eHealth is running.

-list (Optional) Displays the name of the shared host this eHealth system is currently set to.

-disable (Optional) Removes the disaster recovery configuration setting.

-configureStandby (Optional) Performs various tasks that allow a standby system to run eHealth after a failover has occurred.

-h (Optional) Displays help for this command

Examples:

■ To configure an eHealth disaster recovery system to support shared hostnames, enter the following command:

nhDrSetup -hostname sharedhostname

■ To remove the disaster recovery setting from the eHealth system, enter the following command:

nhDrSetup -disable

nhExpire

Deletes old ASCII, EPS, PDF, PS, or Web-based reports and temporary files, including temporary PDF files that are older than the specified number of days.

Important! Improper use of this command can result in loss of data or reports. Use this command only if you are an advanced user and are familiar with its effects.



This command has the following format: nhExpire [-h] [-output days] [- webGroup days]

[-webUser days] [-webReport type days] [-tmp days]

Note: The nhExpire command requires one of these arguments: -webUser, -webGroup, -webReport, -output, or -tmp.

Argument Name Description


-output days Specifies the number of days to keep reports as files in the output directory of your eHealth installation.

- webGroup days Specifies the number of days to keep Health, Service Level, and Top N reports that were output as Web reports.

- webUser days Specifies the number of days to keep Trend, Traffic Accountant, and At-a- Glance reports output as Web reports.

- webReport type days

Deletes Web- based reports of the specified types that are older than days.

For type, specify one or more of the following: glance, dailyHealth, dailyService, monthlyHealth, monthlyService, topN, traffic, trend, weeklyHealth, weeklyService, whatIf.

-tmp days Deletes any files in the tmp directory (of your eHealth installation) that are older than days.

nhExportDowntime

Provides a summary of all planned downtime that was previously imported into the eHealth database. You can use this information to update the schedule and then reimport the data into the eHealth database. eHealth rounds planned downtime to the nearest minute.


nhExportDowntime [-h] [-rev] filename.pdi


If you do not specify -host, -cluster, or -all, the nhExportDowntime command exports downtime from the database on the local system. If you specify one of these distributed arguments, the command exports downtime from one, more, or all systems in the cluster, and returns the output (.pdi) file to the local system.






filename.pdi Specifies the name of the file that contains all planned downtime or outages. For more information about customizing the planned downtime import (.pdi) file, see the eHealth Report Management Guide.

- host hostname

In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to export downtime.

- cluster In a Distributed eHealth cluster, exports downtime from all eHealth systems in the cluster except the local system.

- all In a Distributed eHealth cluster, exports downtime from all eHealth systems in the cluster.

nhGetSupportInfo

Collects important troubleshooting files from an eHealth system and saves them in the ehealth/tmp/diagnostics_string_date_time.zip file, where:

ehealth

Represents the eHealth installation directory.

string_date_time

Represents the current time, expressed in the format: 'YYMMDD_hhmmss.'

The diagnostics_string_date_time.zip file contains the specified log files. This command also returns the current time, all environment variables, and the nethealthrc.csh* files (on UNIX systems).

Important! Use this command under the supervision of Technical Support.

This command has the following format: nhGetSupportInfo [-h] [-host hostname | -cluster | - all]

[-list] [callTicketNum value] [dir directory]

[-slient] [-type type1[, ...]]







-host hostname or -cluster or -all

(Optional) Specifies the systems from which eHealth gathers the information. You can specify one of the following:

-host hostname – Collects data from the specified cluster system.

-cluster – Collects data from all members of an eHealth cluster except the local system.

-all – Collects data from all cluster members.

If you omit these arguments, the command collects information from the local system.

- cluster (Optional) Collects data from all members of an eHealth cluster except the local system. You can specify this argument if you do not specify -host or -all.

-all (Optional) Collects data from all cluster members. You can specify this argument if you do not specify -host or - cluster.

-list (Optional) Lists the valid information types to use with the -type argument.

- callTicketNum value

(Optional) Specifies an identifier, usually a call ticket number, to include as part of the file name.

-dir directory (Optional) Specifies the directory in which to place the troubleshooting file.

-silent Logs messages to the $NH_HOME/log/nhiGetSupportInfo.log file instead of to the screen.

-type type1[, ...] Retrieves specified information types. Run the command with the –list option to get the list of valid types. You can include multiple types in a comma separated list enclosed in double quotes.

Technical Support may supply a 'custom' type, if needed.

nhHaSetup

Configures an existing eHealth system to be managed by high availability clusterware, such as Sun Cluster software.


nhHaSetup [-h] [-rev] -hostname sharedHost [-list] [-disable]





- hostname sharedhost

(Required) Specifies the name of the shared host where eHealth is running. This is the resource that will be managed by the high availability clusterware solution. In the event of a failover, the clusterware will move the instance of this name from this host to the failover host.

-list (Optional) Displays the name of the shared host the eHealth system is currently set to.

- disable (Optional) Removes the high availability configuration setting.

Examples:

■ To configure eHealth to support shared hostnames and run in a high availability cluster, enter the following command:

$NH_HOME/bin/nhHaSetup -hostname sharedhost

■ To remove eHealth from a high availability configuration, enter the following command:

nhHaSetup -disable

nhImportDowntime

Imports a summary of all planned downtime into the eHealth database. You can also use this command to import a summary of planned downtime that has already occurred. eHealth rounds planned downtime to the nearest minute.

This command has the following format: nhImportDowntime [-h] [-rev] filename.pdi





filename.pdi Specifies the name of the file that contains all planned downtime or outages.





- host hostname In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to import the planned downtime file.

- cluster In a Distributed eHealth cluster, imports the planned downtime file to all eHealth systems in the cluster except the local system.

- all In a Distributed eHealth cluster, imports the planned downtime file to all eHealth systems in the cluster.

nhUpdateLicenses

Sends a message to the Message server to include the new license file on servers that already process new license information. This is applicable mainly for Poller and some Application Response servers.


nhUpdateLicenses <arguments>




Overview Business Service Console (BSC) Administration Commands

Business Service Console (BSC) Administration describes the following commands:

■ nhCreateServiceNote

■ nhDeleteServiceNote

■ nhListServiceNote

■ nhUpdateServiceNote

nhCreateServiceNote

Lets you send a message to Business Service Console users to inform them that a business service is experiencing a performance or availability problem and that the person who is responsible is actively managing the problem resolution.


This command has the following format: nhCreateServiceNote [-h] -creator webUser

-appType applicationName -title "title"

[-owner webUser] [-note "note"]

[-readers "reader1;reader2;..."]




-creator webUser (Required) Specifies the user who is creating the note. The user name must be a valid eHealth Web user name and it cannot exceed 64 characters.

-appType applicationName

(Required) Specifies the note application name. The applicationName must be a valid application. You cannot create a service note for a module or module set.

-title title (Required) Specifies the title of the note. The title should be enclosed in quotation marks.

-owner webUser (Optional) Specifies the owner of the note. The user name must be a valid eHealth Web user name, and it cannot exceed 64 characters. If you do not specify an owner, the command uses the value of the - creator argument by default.

-note note (Optional) Specifies the text of the note. The note should be enclosed in quotation marks.

-readers reader1;reader2;...

(Optional) Specifies a list of users who should have read permissions to review the note. The list must be enclosed in quotation marks. The names in the series are case-sensitive and must be separated by a semicolon. Each name can be a valid eHealth Web user name or user alias. The value is case-sensitive. If you do not specify this argument, only Web administrators will have permission to read the note.

-ticket problemTicketIdentifier

(Optional) Specifies the problem ticket identifier associated with the issue that is documented in the service note.



Example:

The following example creates a service note that notifies four people about a problem that has occurred with the mail system. It references a specific problem ticket number. nhCreateServiceNote -creator jsmith -appType Outlook

-title "Mail Slow" -owner dshanley

-note "Outlook has been experiencing slow response

for the past 2 hours. IT is actively working

on the problem."

-readers "john;richard;susan;dan" -ticket 34567

Note: You must specify an application name for the -appType argument, not a module or module set name. You cannot create a Service Note for a module or module set.

nhDeleteServiceNote

Deletes Business Service Console (BSC) service notes from the eHealth database. Only eHealth administrators can delete Service Notes.


nhDeleteServiceNote [-h] -noteID noteID [.., noteID]



-noteID ID (Required) Specifies the ID numbers of one or more service notes to delete.

Example:

In the following example, the command removes a single Service Note with a note ID of 1000001:

nhDeleteServiceNote -noteId 1000001

nhListServiceNote

Lists Business Service Console (BSC) service notes. If you do not specify any arguments for this command, it lists all Service Notes, each with its respective note ID, owner, title, application type, and last update time, from earliest to latest. You can save the output to a file.



This command has the following format: nhListServiceNote [-h]

[-noteID noteID [..,noteID] | -status {active | inactive | all}]

[-full]



-noteID noteID [..,noteID] (Optional) Specifies the ID number of the service note that you want to list. If you specify -status, you cannot use this option. By default, this command lists all service notes.

-status {active | inactive | all} (Optional) Specifies whether to list active, inactive, or all service notes. By default this command lists all service notes, regardless of status.

-full (Optional) Displays all columns for each service note specified, rather than just the columns included by defaults. The columns listed by default include: note ID, owner, title, application type, and last update time. In addition to those columns, the full column listing includes: user ID, state, create time, creator, ticket, readers, updater, and detail.

Example:

The following example lists all service notes, each with its respective note ID, owner, title, application type, and last update time.

nhListServiceNote

1000001,admin,"Response Time is Slow",voiceSvc,6/2/2004 15:47:18

1000002,admin,"Unable to Connect to Server",Telnet,6/7/2004 16:19:26

1000003,admin,"Mail Server Is Down",Outlook,6/25/2004 12:55:52

nhUpdateServiceNote

Enables you to change a Business Service Console (BSC) service note to update users on the status of a performance availability problem that a business service is experiencing and the actions that are being taken to manage and resolve the problem.



This command has the following format: nhUpdateServiceNote [-h] -noteID ID -updatedBy webUser

[-appType applicationName] [-owner webUser] [-note "note"]

[-title "title"] [-readers "reader1;reader2;..."]


[-status {active | inactive}]



-noteID ID (Required) Specifies the ID number of the service note that you want to modify.

-updatedBy webUser (Required) Specifies the user who is updating the note. The user name must be a valid eHealth Web user ID, and it cannot exceed 64 characters.

-appType applicationName (Optional) Specifies the note application type. The applicationName must be a valid application.

-owner webUser (Optional) Specifies the owner of the note. The user name must be a valid eHealth Web user name, and it cannot exceed 64 characters.

-note note (Optional) Replaces the text of the note with an updated message. The note must be enclosed in quotation marks.

-title title (Optional) Specifies or replaces the title of the note. The title must be enclosed in quotation marks.

-readers reader1;reader2;... (Optional) Specifies a list of users who should have read permissions to review the note. The list must be enclosed in quotation marks. The names in the series are case-sensitive and must be separated by a semicolon. Each name can be a valid eHealth Web user name or user alias. The value is case-sensitive.

-ticket problemTicketIdentifier (Optional) Specifies the problem ticket identifier associated with the issue that is documented in the service note.

-status {active | inactive} (Optional) Specifies the status of the issue that is being communicated in the note. Valid values are active and inactive.



Example:

The following example updates a service note to notify four people about a change in status concerning a problem that occurred previously with the mail system. nhUpdateServiceNote -noteId 456 -updatedBy jsmith

-note "Outlook response has now improved. The server was

experiencing some problems, but they have now been resolved."

-readers "jJones;rBrown;sGarrison;dLoring" -ticket 34567

-status inactive

Note: For the owner and the list of readers, you must specify Web user names only; do not specify Web user aliases.

Overview Administration Processes

Administration Processes describes the following commands:

■ nhHttpd

■ nhLmgr

■ nhMail

■ nhSchedule

■ nhServer

■ nhStopImportPolling

nhHttpd

Starts or stops the eHealth Web server. This command works on UNIX systems only. To stop the eHealth httpd service on Windows systems, use the Control Panel Services utility.





start Starts the eHealth Web server.

stop Stops the eHealth Web server.



nhLmgr

Starts, stops, and displays the status of the eHealth license manager. This command does not start or stop the license manager.

Note: Improper use of this command can cause the eHealth pollers to stop, or the servers to fail. Use this command only if you are an advanced user and are familiar with its effects.

This command has the following format: nhLmgr [-h] [start | stop | status]



start Starts the license manager. This is the default.

stop Stops the license manager.

status Displays the status of the license manager.

Examples:

■ To start the license manager, enter the following:

nhLmgr start

■ To stop the license manager, enter the following:

nhLmgr stop

■ To display status information, enter the following:

nhLmgr status

■ Sample status information for eHealth running on a Windows system follows:

License server status (License file: \home\nethealth\lmgr\license.dat):



ccilmgrd: UP v7.0

■ Sample status information for eHealth running on a UNIX system follows:

License server status (License file: /home/nethealth/lmgr/license.dat):



ccilmgrd



nhMail

Sends a message or file to specified email recipients.

Note: To view an email message created by the nhMail command on a Japanese system, you must manually set encoding to Japanese (Auto-Select) or Japanese (Auto Detect) in your email application. For instructions, see the documentation for your email application.


nhMail [-h] [filename | -e subject message] recipient



filename Specifies the pathname of the file to send to recipients. If you do not specify a full pathname, eHealth looks for the file in the current directory.

When you specify a filename argument, you cannot specify the -e argument.

-e subject message

Specifies text to include in the e-mail message. In addition to recipient, the following arguments are required when you specify -e:

subject – A text string to appear in the subject line of the e-mail message.

message – A text string to appear in the body of the e-mail message.

When you specify -e, you cannot also specify a file to send (with the filename argument).

recipient Specifies one or more e-mail addresses to which the command should send the message or file. To specify multiple e-mail addresses, do the following:

■ On a UNIX system, separate each e- mail address with a space and enclose the entire string in single quotation marks. For example: '[email protected] [email protected]'

■ On a Windows system, separate each e-mail address with a plus sign (+) and enclose the entire string in single quotation marks. For example: '[email protected][email protected]'

These addresses appear in the To field of the e-mail message.



Examples:

■ To send the file /home/readme.txt to the user [email protected], enter the following:

nhMail [email protected] /home/readme.txt

■ The following command sends a text message to the specified user:

nhMail -e "Low Disk Space" \

"Running out of disk space on System-Blue, Disk-D" \

[email protected]

nhServer

Starts and stops the eHealth server and displays its revision information.

This command has the following format: nhServer [-h] [-rev] [-c startup_file] [start | stop]




-c startup_file Specifies the initialization file that the eHealth server should use when the server starts. The default is ehealth/sys/startup.cfg, where ehealth represents the eHealth installation directory.

start Starts the eHealth server. This is the default.

stop Stops the eHealth server.

Examples:

■ To start the eHealth server, enter the following:

nhServer start

■ To stop the eHealth server, enter the following:

nhServer stop

■ To display revision information for the eHealth server, enter the following:

nhServer -rev



Overview Administration eHealth Info

eHealth Administration describes the following commands:

■ nhListElementLicenses

■ nhShowImRev

■ nhShowRev















Examples:































nhShowImRev











Examples:


nhShowImRev -all


5.3 H0-00

Cisco Netflow:

v4.0, v5.0

Cisco VPNSC:

2.1.x, 2.2.x

Cisco WAN Manager:

11.0, 12.0

HP OpenView:

6.4


08,00.03.xx/04.00.02.xx, 08.01.00.02

Micromuse Netcool:

3.5, 3.6


14.2

Aprisma SPECTRUM:

6.0 Nortel SCS: 3.0



nhShowRev

Outputs the eHealth release numbers, followed by the certification release and patch level. By default, the command also displays:

■ The dates of the latest certification verification kit and strategic patch installed on the system.

■ Installation history of patch and certification releases.

■ Hot fixes installed on the system.


nhShowRev [-h] [-quiet]







-quiet or -q Omits the text from the output, showing only the numeric values. (Use -q on UNIX systems.)

Examples:

■ When you run this command without any arguments, eHealth outputs the version information for your eHealth system in the following format:

eHealth version: x Dy - Patch Level: z

■ The x value is the eHealth release, Dy is the device certification level, and z is the eHealth device patch level for that release. The version information is followed by the dates of the latest certification verification kit and strategic patch installed on the system, the installation history of patch and certification releases, and any Hot fixes installed on the system. For example:


Cert Verification Kit: March_2006

Cert Strategic Patch: March_2006

Installation History:Installed Strategic Cert NH570505 on Jan 25 2006 09:47

[kit created: Jan 23 2006]

Installed Certification FH570305 on Jan 25 2006 09:50 [kit created: Jan 24

2006]

Installed Certification FH570305 on Mar 17 2006 09:19 [kit created: Mar 16

2006]

Installed Strategic Cert NH570505 on Mar 21 2006 10:14 [kit created: Mar 20

2006]

Installed Patch NH570505 on Mar 28 2006 10:41

[kit created: Mar 27 2006]

Hot Fixes:

17653.log

77474.log

■ When you run this command with the -quiet argument, eHealth outputs the numeric values, but omits the text. For example:

5.7.0 D05 05

Overview Administration Web Admin

Web Administration describes the following commands:

■ nhHttpdCfg

■ nhWebUtil


nhHttpdCfg

Reconfigures the eHealth Web server. You typically use this command as part of a software upgrade or when directed by Technical Support to correct potential Web problems. After reconfiguring the eHealth Web server with nhHttpdCfg, use the nhHttpd command with the start argument to restart it.

This command has the following format: nhHttpd [-h] -user ehUser -grp NH_USERgroupName

-nhDir rootEhealthDir [-protect | -noProtect]

[-enableProxy | -noEnableProxy]

[- outfile filename]



-user ehUser Specifies the name of the eHealth user account.

-grp NH_USERgroupName

On UNIX, specifies the primary group name of the eHealth user account. On Windows, specifies Administrators, the group to which the eHealth user belongs.

-nhDir rootEhealthDir Specifies the full path to the eHealth root directory using a UNIX-style pathname (with forward slashes instead of backslashes).

-protect or -noProtect

-protect enables Web security, requiring users to enter a password to log in to the eHealth Web interface. This is the default.

-noprotect disables Web security; the eHealth Web interface does not prompt users for a password when they log in.

Note: The - noprotect argument enables free access to all reports without a login.

This argument corresponds to the Enable Web Security setting on the Site Configuration page of the eHealth Web interface.





-enableProxy or -noEnableProxy

-enableProxy saves the URL when running a Web report and saving it in a file. This allows eHealth to display the report when it is finished.

-noenableProxy disables this feature. This is the default.

Use this argument when the eHealth Web interface runs on a proxy server that hides true IP addresses from the Internet Explorer browser. (This setting does not apply to Netscape.)

This argument corresponds to the Enable Proxy Redirect setting on the Site Configuration page of the eHealth Web interface.

- outfile filename Directs the command output to the specified file. Typically, the filename path should be ehealth/web/httpd/httpd.conf.

If you do not specify - outfile, the command directs the output to standard output (stdout).

Example:

The following command reconfigures the eHealth Web server on a Windows system: nhHttpdCfg -user nhuser -grp Administrators \

-nhDir D:/ehealth \

-cfg D:/ehealth/web/webCfg/users.cfg \

-outfile D:/ehealth/web/httpd/httpd.conf

nhWebProtocol

Enables and disables an SSL connection on your eHealth web server.

This command has the following format: nhWebProtocol -h -mode {http | https} -port portNumber

-certificate certificateFile - key keyFile


-hostname hostName - passphrase passphrase






{http | https}

(Required) Specifies the mode that Apache should use:

■ HTTP is an Internet protocol that is used to transfer information via the web.

■ HTTPS represents a secure HTTP that adds an additional encryption/authentication layer between HTTP and Transmission Control Protocol (TCP).

-port portNumber (Optional) Specifies a value used to map data that is coming through a network protocol to a particular process running on a computer. By default, eHealth uses port 80 for HTTP and uses port 443 for HTTPS.

-certificate certificateFile

Specifies a digital identity certificate, also known as a public key certificate. Required when you enable SSL using a secure server certificate file issued by a Certificate Authority; otherwise, it is optional.

-key keyFile Specifies information that controls the operation of a cryptography algorithm. Required when you enable SSL using a secure server certificate file issued by a Certificate Authority; otherwise, it is optional. Without this argument, eHealth generates a certificate/key.


Specifies a certificate issued by a Certificate Authority for another Certificate Authority. When enabling SSL using a secure server certificate file issued by a Certificate Authority and providing an intermediate certificate, this argument is required; otherwise, it is optional.

-hostname hostName

Specifies the unique name by which a network-attached device is known on a network. When enabling SSL with a self-signed certificate, this argument is required; otherwise, it is optional.

-passphrase passphrase

Specifies the pass phrase needed for a certificate/key to ensure that the Apache web server functions correctly. Required for keys that are protected by a pass phrase; otherwise, it is optional.


Examples:

■ To enable SSL support using a signed certificate from a Certificate Authority, enter the following command: nhWebProtocol -mode https -certificate certificatefile -key keyfile -

intermediate intermediatecertificatefile -passphrase passphrase

■ To enable SSL support using a self-signed secure certificate, enter the following command:

nhWebProtocol –mode https –hostname hostname

■ To disable SSL support and restore the default (HTTP) web server configuration, enter the following command: nhWebProtocol -mode http

nhWebUtil

Performs various operations related to the eHealth Web interface. You can use this command to:

■ Update the users.cfg file from a previous release of eHealth .

■ Reset the users.cfg file to the default version of the file.

■ Recreate the reportIndex.txt files.

■ Convert MyHealth files for use with the latest release of eHealth.

■ List licenses for technology types available for Web reporting.

■ Hide the MyHealth tab of the eHealth Web interface.

■ List files of a specified type located in a directory.

This command has the following format: nhWebUtil [-h]

[-cfg | -init | -myHealth value | -index | - license |

-convertMyHealth]

[-o outfile] [-dir pathname] [-suffix filetype]

[-setupTomcat]



-cfg (Optional) Updates the users.cfg file from a previous release of eHealth.





-init (Optional) Replaces the current users.cfg file with the default version of the file. You can use this argument, for example, to update the default time zone used for eHealth Web users with the current time zone on the local system, or to replace a corrupt users.cfg file.

Important! Use -init only on a new eHealth installation or to repair a corrupt users.cfg file. If you specify this argument on an established eHealth system, nhWebUtil overwrites the users.cfg file with a default version of the file, removing any users that you had added.

-o outfile (Optional) Specifies the output file. When you specify this argument with -cfg, -init, or -myHealth, it outputs the file to users.cfg.

-index (Optional) Recreates the reportIndex.txt files. Use this argument if you suspect that these files are corrupt. A reportIndex.txt file resides in each of the following directories (where ehealth represents the eHealth installation directory):

■ ehealth/web/output/users

■ ehealth/web/output/groups

■ ehealth/web/output/groupLists

■ ehealth/web/output/views

-license (Optional) Provides a list of licenses for technology types available for Web reporting. This argument is typically used for debugging purposes.




-convertMyHealth (Optional) Converts MyHealth files (*.mhd, *.rds, and *.rde in ehealth/reports/myHealth) and reschedules reports for these cases:

■ When a standalone eHealth joings an eHealth cluster, it updates machine IDs.

■ For an upgrade from Network Health Release 4.8 or eHealth Release 5.0, it replaces subject names with subject IDs.

■ For an upgrade from a release prior to 6.0, as a result of typed group conversion to untyped groups, it updates old group IDs to new IDs. It also updates Live Status Diagram files (LiveStatus.cfg), updating old group list subject IDs to new IDs.

-dir pathname (Optional) Scans the specified directory for files with the file type indicated with the -suffix argument, and stores a list of matching files in the outfile specified by the -o argument. This argument is typically used for debugging purposes.

-suffix filetype (Optional) When used with the -dir argument, specifies the file type (suffix) to search for.

-myHealth value (Optional) Specify -myHealth on to display the MyHealth tab on the eHealth Web interface. Specify -myHealth off to hide the MyHealth tab from all users, except for the admin user.

Specify the -f and -o argument to update the pathname of the users.cfg file with this setting.

-setupTomcat (Optional) Creates the Tomcat configuration file.

Examples:

■ The following command rewrites the users.cfg file with the backup version of that file:

nhWebUtil -cfg -f $NH_HOME/web/webCfg/users.cfg.bak -o users.cfg

■ The following command recreates all of the reportIndex.txt files:

nhWebUtil -index

■ The following command converts the MyHealth files for use with the latest release of eHealth:

nhWebUtil -convertMyHealth

Application Response Commands

■ The following command allows all eHealth users to access MyHealth reports:

nhWebUtil -myHealth on \

-f $NH_HOME/web/webCfg/users.cfg \

-o $NH_HOME/web/webCfg/users.cfg

■ The following command generates a list of all GIF files that reside in the ehealth/web/output directory, where ehealth represents the eHealth installation directory:

nhWebUtil -dir $NH_HOME/web/output -suffix gif -o gifFiles

Application Response Commands The Application Response commands are as follows:

■ nhAddAppType

■ nhAddArConfig

■ nhDeleteArConfig

■ nhGetRespLimit

■ nhListAppTypes

■ nhListArConfig

■ nhManageArAgent

■ nhModifyAppType

■ nhModifyArConfig

■ nhSetRespLimit

nhAddAppType

Adds a new application type to your eHealth application hierarchy (your object model).


nhAddAppType [-h] [-rev] -symbol symbolName -label labelName

-level levelName [- basedOn basedOn] [-appSvcType type]

[-respMeasureType type] [-normalSortOrder order] [-verify]





- rev (Optional) Displays the eHealth software revision.

-label labelName (Required) Specifies the label for the new application type.

-level level (Required) Specifies the level for the new application type.

For level, specify one of the following:


-basedOn basedOn (Optional) Specifies a previously-defined element type on which to base this new application type. If you do not specify this argument, the command uses "" and does not specify a basedOn value.





-appSvcType type (Optional) Specifies the application service associated with the new application type (for example: exchangeAppSvc). If you do not specify this argument, the command uses "" and does not specify an application service for the application type.

For type, specify one or more of the following:

appService,genericAppSvc,apacheAppSvc,dnsAppSvc,eHealthAppSvc, exchangeAppSvc,iisAppSvc,lotusNotesAppSvc,msSqlServerAppSvc, oracleAppSvc,sendMailAppSvc,userApp1AppSvc,webAppSvc, fw1MgmtStationAppSvc,fw1EnforcementPtAppSvc, netSvcsSendmailUnixAppSvc,netSvcsNisUnixAppSvc,netSvcsLpUnixAppSvc,netSvcsDnsUnixAppSvc,netSvcsNfsUnixAppSvc, netSvcsLdapUnixAppSvc,netSvcsActiveDirNtAppSvc, netSvcsDhcpNtAppSvc,netSvcsDnsNtAppSvc,netSvcsWinsNtAppSvc, httpProxy,genericCallMng,ccmConfMgrAppSvc,genericCCMAppSvc, ccmMsgIntAppSvc,ccmCtiMgrAppSvc,ccmWebAttAppSvc,unifiedMsgAppSvc, exchangePubMailboxStoreAppSvc,ciscoGatekeeper,ciscoGatekeeperZone, exchangeAppSvcVirus,exchangeAppSvcSMTP,exchangeAppSvcPublicStore, exchangeAppSvcPrivateStore,exchangeAppSvcOWA,exchangeAppSvcSRS, exchangeAppSvcDSCache,exchangeAppSvcMessageStore,avayaCommMgrAppSvc, avayaAttGroupAppSvc,avayaAttPosAppSvc,avayaClanBoardAppSvc,avayaHun

-respMeasureType measure

(Optional) Specifies the method by which eHealth should measure response for this new application type. If you do not specify this argument, the command uses "any" by default.

For measure, specify one of the following values:





-normalSortOrder value

(Optional) Specifies where this application type should appear in sorted lists. If you do not specify this argument, the command uses 0.0000000.


Example:

The following example creates an application type named reader at level moduleSet:

nhAddAppType -symbol reader -label mail -level moduleSet

Created AppType:

id = 607056

symbol = "reader"

label = "mail"

basedOn = ""

appSvcType = ""

respMeasureType = "any"

normalSortOrder = 0.000000

level = "moduleSet"

systemAppType = "no"

nhAddArConfig

Adds a new element to the AR Configuration.


nhAddArConfig [-h] [-rev]


-name elementName

[-agentSet agentSet] [-hostnames hostNames]

[- applicationType applicationType] [- serverType serverType]

[-portRedirection {yes|no}] [-urls urls]

[-parameterSubstitutions params]

[-description description] [-operatingSystem operatingSystem]









(Required) Specifies which type of element to add. The default value is agent.

- name elementName (Required) Specifies the name of the element to add.

- agentSet agentSet (Optional) Specifies the agentSet in which to place the new agent. Valid for type “agent” only. The default value is "All-Clients."


(Required when specifying "-type agent” or “-type server.")

For agent, specifies a list of hostnames. Use semi- colons to separate hostnames.

For server, specifies a list of hostname:ports. Use semi-colons to separate hostnames, and commas to separate multiple ports per hostname. A port number is required; specify port 0 (zero) to match any port.

Valid for - type “server” and “agent” only.

- applicationType applicationType

(Required when specifying "-type application") Specifies the type of application to add. Valid for - type application only.

- serverType serverType (Required when specifying "-type server") Specifies the type of server to add. Valid for -type server only.

- portRedirection {yes|no} (Optional) Indicates whether or not to enable port redirection for the server being added. Valid for - type server only. The default value is "no".

-urls urls (Optional) Specifies comma separated list of urls to monitor; default value is ""; only valid for type -server.

- parameterSubstitutions params

(Optional) Specifies semi-colon separated list of parameter substitution sets; each set is a "name=value" pair, where name is of the form $Name for string values and %Name for numeric values; the value is a comma separated list of string or numeric value as the case may be; only valid for -type application; default value is "".




- description description (Optional) A description of the element being added. The default value is "".


(Optional) Specifies the name of the Operating System. Valid for - type agent only. The default value is "".

-confirm {yes|no} (Optional) Prompts before adding the element. The default is yes.


Examples:

■ The following example creates an Agent Set named “a1”:

nhAddArConfig -type agentSet -name a1

-description "My AgentSet"

■ The following example creates an application named “app1” of type “Web”monitoring two urls, foo.com and bar.com:


-description "My Web Application"

-applicationType Web

-parameterSubstitutions "foo.com,bar.com"

■ The following example creates an application named “app2” of type “Windows” to monitor ParamSubstitutions app21.exe and app22.exe:


-description "My Windows Application"

-applicationType Windows

-parameterSubstitutions

"$ExecutableName=app21,app22"

■ The following example creates a server named “s1” of type “Exchange” with two hostnames: e1 and e2, and ports 1,2, and 3 on e1, and ports 3 and 4 on e2:

nhAddArConfig -type server -name s1

-description "My Exchange Server"

-serverType Exchange -portRedirection no

-hostnames "e1:1,2,3;e2:4,5"

nhDeleteArConfig

Removes an element (agent, agentSet, server, or application) from the Application Response Configuration.


This command has the following format: nhDeleteArConfig [-h] [-rev]

-type {agent | agentSet | server | application} -name elementName

[-deleteAgents {yes|no}] [-confirm {yes|no}] [-verify]





(Optional) Specifies which type of element to delete. The default value is agent.

-name elementName (Required) Specifies the name of the element to delete.

- deleteAgents {yes|no} (Optional) Specifies whether to delete all of the agents in the agentSet; only valid for - type agentSet; default value is yes.

-confirm {yes|no} (Optional) Specifies whether to display a prompt before deleting the element. The default value is yes, which displays a prompt.

-verify (Optional) Verifies that the input parameters are valid without performing the actual operation. Processes the input and produces a DCI file, but does not remove the elements from the eHealth database.

Examples:

■ The following example deletes the application named app1:

nhDeleteArConfig -type application -name app1

■ The following example deletes a server named s1 without prompting for confirmation that you want to delete it.

nhDeleteArConfig -type server -name s1 -confirm no

■ The following example uses the output of the nhListArConfig command to delete agents whose names start with "zz."

nhListArConfig | grep zzz | nhDeleteArConfig -confirm no



nhGetRespLimit

Evaluates and recommends response limit values for a group of response path elements. It uses a Top N report to calculate the average response time for the group over a specified time period. The command also recommends a response time limit value based on the average response multiplied by a limit factor.

To use the nhGetRespLimit command, enter nhGetRespLimit at the command line and respond to each prompt.

nhListAppTypes

Displays the application types that are defined in your eHealth object model.

This command has the following format: nhListAppTypes [-h] [-rev] [-symbol symbolName]

[-level application | moduleSet | module] [-outFile filename] [-all]

[-recurse] [-indent] [-showLevels] [-verbose] [-csv] [- appTypeId]




- symbol symbolName

(Optional) Lists the application type for the specified entry. If you do not specify this argument, the command lists all application types by default.

-level application | moduleSet | module

(Optional) Lists all application types for the specified level. If you specify the -recurse argument with this argument, the command lists the entire hierarchy under the symbol.

- outFile filename (Optional) Specifies the name of the file to which eHealth should send output. If you do not specify a file, it sends output to standard output.

-all (Optional) Lists all applications in your hierarchy. This is the default action.

- recurse (Optional) Lists the entire hierarchy under the symbol that you specify for the -symbol or -level argument.

-indent (Optional) Prints the hierarchy with each level indented appropriately, producing a nested output. If you do not specify this argument, the command left aligns all levels.





- showLevels (Optional) Lists all levels currently defined in your object model.

- verbose (Optional) Lists all fields for an application type.

-csv (Optional) Prints the output in csv format.

- appTypeId Internal

(Optional) Prints the OM appTypeId.

Example:

The following command lists only entries of level moduleSet under the symbol named Outlook:

nhListAppTypes -level moduleSet -symbol Outlook

symbol

"Outlook-Reply"

"Outlook-ReplyAll"

"Outlook-Forward"

"Outlook-Delete"

"Outlook-New"

"Outlook-Read"

nhListArConfig

Lists an element, or all elements of a specific type, in the AR Configuration.


nhListArConfig [-h] [-rev]

[-type {agent | agentSet | server | application}]

[-name elementName] [-defaultRule] [-actualRule]

[-licenseInfo] [-long] [- verbose] [-csv] [-showHeader]





(Optional) Specifies which type of element to list. The default value is agent.




-name elementName (Optional) Specifies the name of the element to list. The default value is all elements of the specified type.

- defaultRule (Optional) Displays the default rule for the specified application. This option is valid only for -type application.

- actualRule (Optional) Displays the actual rule for the specified application. This option is valid only for -type application.

- licenseInfo (Optional) Displays the AR License information. This option is not valid with other output options.

- long (Optional) Lists more details for the selected elements.

- verbose (Optional) Lists all the fields of the selected elements; for AgentSets, lists all the associated Agents.

- csv (Optional) Lists the output in the CSV file format.

- showHeader (Optional) Shows column headers in the output.

Examples:

■ The following example lists all Agent names:

nhListArConfig

■ The following example lists all Agents and the details about them as shown in the Agents List page in the AR WebConsole:

nhListArConfig -type agent -long

■ The following example lists in CSV format all Agents and the details about them, as shown in the Agents Properties page in the AR WebConsole:

nhListArConfig -type agent -long -csv

■ The following example lists details about the application named app1:

nhListArConfig -type application -name app1

-long

■ The following example uses output from the nhListArConfig command to delete agents whose names begin with the letters “zzz”:

nhListArConfig | grep zzz | nhDeleteArConfig

-confirm no


nhManageArAgent

Use to manage an Application Response Agent.

This command has the following format: nhManageArAgent [-h] [-rev]

-type {agent | agentSet} -name elementName

[-startAgent | - stopAgent | -startAgentSetAgents | -stopAgentSetAgents |

- startTransactionLogging | -stopTransactionLogging |

-startEventLogging | -stopEventLogging |

-showDiscoveryInfo [csv] [ showHeader ] |

-showRegistryInfo [csv] [ showHeader ] |

-setRegistry keyName keyValue |

-getFile filename [overwrite] | -forceHeartbeat]





-name elementName (Required) Specifies the name of the element to manage.

-type {agent | agentSet} (Optional) Specifies which type of element to manage. The default type is agent.

-startAgent (Optional) Starts the named agent; valid for type agent only.

-stopAgent (Optional) Stops the named agent; valid for type agent only.

- startAgentSetAgents (Optional) Starts all agents in the named agentSet; valid for agentSets only.

- stopAgentSetAgents (Optional) Stops all agents in the named agentSet; valid for agentSets only.

- startTransactionLogging (Optional) Starts Transaction Logging for the named agent; valid for agent type only.

- stopTransactionLogging (Optional) Stops Transaction Logging for the named agent; valid for agent type only.

-startEventLogging (Optional) Starts Event Logging for the named agent; valid for agent type only.

-stopEventLogging (Optional) Stops Event Logging for the named agent; valid for agent type only.





-showDiscoveryInfo [csv] [showHeader]

(Optional) Displays server discovery information for the named agent; when used with the csv option, generates output in CSV format. Valid for agent type only.

-showRegistryInfo [csv] [showHeader]

(Optional) Displays Registry information for the named agent; when used with the csv option, generates output in CSV format. Valid for agent type only.

Note: Only values under HKEY_LOCAL_MACHINE\SOFTWARE\FirstSense\FirstSense will be displayed.

-setRegistry keyName keyValue

(Optional) Sets a single Registry setting for the named agent; valid for agent type only.

Note: Only values under HKEY_LOCAL_MACHINE\SOFTWARE\FirstSense\FirstSense will be set.

-getFile filename [overwrite]

(Optional) Gets the specified file from the named agent. The overwrite option suppresses the user prompt if the file being downloaded already exists in the current directory. Valid for agent type only.

Note: Only files from the agent directory on the agent system may be downloaded.

-forceHeartbeat (Optional) Forces the agent identified by name to heartbeat immediately.

-confirm {yes|no} (Optional) Prompts before performing the agent operation. The default value is yes.

-verify (Optional) Verifies that the input parameters are valid without performing the actual operation.

Examples:

■ The following example starts agent "foo":

nhManageArAgent -name foo -type agent

-startAgent

■ The following example stops all agents whose names start with zzz:

nhListArConfig | grep zzz | nhManageArAgent

-stopAgent -confirm no


■ The following example stops all agents whose IP Address is in the subnet 172.16.x.x:

nhListArConfig -long -csv| grep "172.16" |

cut -f1 -d',' | nhManageArAgent -stop Agent

-confirm no

■ The following example stops all agents whose IP Address is in the range 172.16.6.50- 172.16.6.60:

nhListArConfig -long -csv | grep "172.16.6" |

grep -E "\.50|\.51|\.52|\.53|\.54|\.55|\.56|\

.57|\.58|\.59|\.60" | cut -f1 -d',' |

nhManageArAgent -stopAgent -con firm no

nhModifyAppType

Changes an application type in your eHealth application hierarchy (your object model). If eHealth creates a new application type after you add an application using Application Response, you can modify only the basedOn field of this application type.

This command has the following format: nhModifyAppType [-h] [-rev] -symbol symbolName -newSymbol newSymbolName

-newLabel newLabelName -newLevel newLevelName [-newBasedOn]

[-newAppSvcType newType] [-newRespMeasureType newType]

[-newNormalSortOrder newOrder] [-verify]




-symbol SymbolName (Required) Specifies the current symbol for the existing application type.

- newSymbol newSymbolName

(Optional) Specifies a different symbol for the application type.

- newLabel newLabelName (Optional) Specifies a different label for the application type.

- newLevel (Optional) Specifies a different level for the application type.

For newLevel, specify one of the following:






- newBasedOn newBasedOn (Optional) Specifies a different (previously-defined) element type on which to base the application type.




- newAppSvcType newType (Optional) Specifies a different application service to associate with the application type (for example: exchangeAppSvc).

For newType, specify one or more of the following:

appService,genericAppSvc,apacheAppSvc,dnsAppSvc,

eHealthAppSvc,exchangeAppSvc,iisAppSvc,lotusNotesAppSvc,

msSqlServerAppSvc,oracleAppSvc,sendMailAppSvc,userApp1AppSvc,

webAppSvc,fw1MgmtStationAppSvc,fw1EnforcementPtAppSvc,

netSvcsSendmailUnixAppSvc,netSvcsNisUnixAppSvc,

netSvcsLpUnixAppSvc,netSvcsDnsUnixAppSvc,

netSvcsNfsUnixAppSvc,netSvcsLdapUnixAppSvc,

netSvcsActiveDirNtAppSvc,netSvcsDhcpNtAppSvc,

netSvcsDnsNtAppSvc,netSvcsWinsNtAppSvc,httpProxy,

genericCallMng,ccmConfMgrAppSvc,genericCCMAppSvc,

ccmMsgIntAppSvc,ccmCtiMgrAppSvc,ccmWebAttAppSvc,

unifiedMsgAppSvc,exchangePubMailboxStoreAppSvc,

ciscoGatekeeper,ciscoGatekeeperZone,exchangeAppSvcVirus,

exchangeAppSvcSMTP,exchangeAppSvcPublicStore,

exchangeAppSvcPrivateStore,exchangeAppSvcOWA,

exchangeAppSvcSRS,exchangeAppSvcDSCache,

exchangeAppSvcMessageStore,avayaCommMgrAppSvc,

avayaAttGroupAppSvc,avayaAttPosAppSvc,

avayaClanBoardAppSvc,avayaHun




- newRespMeasureType newMeasure

(Optional) Specifies a different method by which eHealth should measure response for this application type.

For newMeasure, specify one of the following:


- newNormalSortOrder newValue

(Optional) Changes the location in which this application type should appear in sorted lists.


Example:

The following example modifies the label of the application type symbol reader: nhModifyAppType -symbol reader

-newLabel distribution

Modified AppType:

symbol = "reader"

oldLabel = "mail"

newLabel = "distribution"

nhModifyArConfig

Modifies an element in the Application Response Configuration.

This command has the following format: nhModifyArConfig [-h] [-rev]


elementName [-newName newName] [- agentSet agentSet]

[-hostnames hostnames] [- portRedirection {yes|no}]

[-urls urls] [- parameterSubstitutions params]

[-description description]

[-operatingSystem operatingSystem]

[-importRules rulesFile] [- disable] [-enable]









(Required) Specifies which type of element to modify. The default type is agent.

- name elementName (Optional) Specifies the name of the element to modify.

- newName newName (Required) Specifies a new name for the element being modified.

- agentSet agentSet (Optional) Specifies a new agentSet in which to place the agent. Valid for the agent type, and the web applicationType only.


(Optional) For agent, specifies a list of hostnames. Use semi- colons to separate hostnames.

For server, specifies a list of hostname:ports. Use semi- colons to separate hostnames, and commas to separate ports per hostname.

Valid for - type server and agent only.

- portRedirection {yes|no} (Optional) Indicates whether or not to enable port redirection for the server being modified. Valid for -type server only. The default value is "no".

-urls urls (Optional) Specifies urls to monitor. Use commas to separate urls. The default value is "". Valid for - type server only.

- parameterSubstitutions params (Optional) Specifies semi-colon separated list of parameter substitution sets; each set is a "name=value" pair, where name is of the form $Name for string values and %Name for numeric values; the value is a comma separated list of string or numeric values as the case may be; only valid for -type application; default value is "".

- description description (Optional) Specifies the description of the element being modified.


(Optional) Specifies the name of the Operating System. This option is valid for -type agent only.




- importRules rulesFile (Optional) Specifies the name of a rules file containing the new rules for this application; only a single application's rules may be updated using this option. This option is valid for -type application only.

- disable (Optional) Disables the specified application. This option is valid for type -application only.

- enable (Optional) Enables the specified application. This option is valid for type -application only.

-confirm {yes|no} (Optional) Prompts before modifying the element. The default is yes.


Examples:

■ The following example changes the name of an AgentSet from a1 to a2:

nhModifyArConfig -type agentSet -name a1

-newName a2

■ The following example assigns the hostnames f1:1,2,3;f2:4,5 to a server named s1:

nhModifyArConfig -type server -name s1

-newHostnames "f1:1,2,3;f2:4,5"

■ The following example uses the output of the nhListArConfig command to move agents whose names start with "zzz" to a new agentSet named "newZZ":

nhListArConfig | grep zzz | nhModifyArConfig

-newAgentSet newZZ -confirm no

nhSetRespLimit

Sets response limit values for a group of response path elements based on an input file such as the nhRecommend.txt file produced by the nhGetRespLimit command.

Database Commands

To use the nhSetRespLimit command, enter nhSetRespLimit at the command line, and respond to each prompt.

Database Commands The database commands are as follows:

■ nhChangeDbModelSize

■ nhConfigDbNet

■ nhConvertDb

■ nhCreateDb

■ nhDbApi

■ nhDbMaint

■ nhDbStatus

■ nhDestroyDb

■ nhGenDataSourceInfo

■ nhLoadDb

■ nhManageDbSpace

■ nhManageUsers

■ nhReset

■ nhSaveDb

■ nhStartDb

■ nhStopDb

■ nhUpdateDbProtocol

nhChangeDbModelSize

Changes the growth model of the eHealth database. This command is useful for statistics data only. It does not resize existing tables. Only tables or rows inserted after you run nhChangeDbModelSize conform to the new model size.


Database Commands

Note: An Oracle database allocates extents only when there is no room left in the previously allocated extents. If you change the model size but the existing extents are not completely used, the size of the database does not change. A new extent using the new size you specified is added only after all blocks in existing extents are full.


nhChangeDbModelSize [-tiny | -small | -medium | -large | -xlarge]


- tiny Internal

Specifies a database for very small installations, such as on test systems.

- small Specifies a database for installations of less than 3,000 elements.

- medium Specifies a database for installations of between 3,000 to 10,000 elements polled every 5 minutes.

- large Specifies a database for installations of between 10,000 to 25,000 elements polled every 5 minutes.

- xlarge Specifies a database for installations of over 25,000 elements polled every 5 minutes.

nhConfigDbNet

This command is primarily used by the nhCreateDb command. It enables communication between eHealth client processes and the eHealth database server by configuring SQL*Net. It can also be used to enable the SystemEDGE agent to communicate with an Oracle database server.

The listener process is the gatekeeper for establishing connections to the eHealth database server.


nhConfigDbNet [-h] [-rev] -addTnsNames -addListener [- listenerName]

[-sid oracleSid] [-port portNumber]

[-oracleHome oracleHomeDir] [-host hostName]

[-noRestart]

[-stopListener | -startListener]


Database Commands




-addTnsNames Updates the tnsnames.ora file so that the Oracle database server can communicate with the Oracle client.

-addListener Updates the listener.ora file so that the Oracle client can communicate with the Oracle database server.

To configure communication for another instance of the database and eHealth, specify [- addListener -listenerName listenerName] where listenerName is an alphanumeric name (of up to eight characters in length) for the listener process.

-sid oracleSid Specifies the name of the Oracle instance to update. The default is the value of the ORACLE_SID environment variable.

-port portNumber Specifies the port number for net8 communication. The default is 1521.

-oracleHome oracleHomeDir

Specifies the home directory of the Oracle instance to update. The default is the value of the NH_ORACLE_HOME environment variable.

-host hostName In a Distributed eHealth cluster, specifies the name of the eHealth system on which you want to run the command.

-noRestart Prevents automatic start of the Oracle Listener service following creation of the service.

-stopListener Stops the listener process. Any scheduled jobs that start while the listener is stopped will fail.

-startListener Starts the listener process if it had stopped.

nhConvertDb

Converts the eHealth database schema for a software upgrade. This command compares the value of the NH_DB_VERSION environment variable (defined by the installation process or in nethealthrc.sh) with the database version stored in the database. If these versions are different, the command takes appropriate action.


Database Commands

This command has the following format: nhConvertDb [-h] [-rev]

[-convertStandalone | -savePriorVersion | -finalize | - undoConvert |

-offlineConvert | -preConvert | - checkDiskSpace]




- convertStandalone Completes the upgrade of an eHealth database. This is the default action.

- savePriorVersion Saves the current database schema (before converting the schema).

- finalize Deletes the old version of the database schema. This is the final step of the database conversion. After specifying the - finalize argument, you cannot specify - undoConvert.

- undoConvert Reverts to the old version of the database schema. Use this argument if you encounter problems with the database conversion. You cannot specify - undoConvert after specifying -finalize.

- offlineConvert

- preConvert

- checkDiskSpace

Internal

These arguments are used by the eHealth installation process to upgrade a system from Release 5.5 to 5.6. You must specify them in a particular order and with a properly defined environment. Do not attempt to use these arguments without the direct assistance of Technical Support.

Example:

Enter the following command to convert your eHealth database:

nhConvertDb

nhCreateDb

Creates a new eHealth database (an Oracle instance and a empty eHealth schema). You may need to create a new database if the existing database is corrupted, or if you have deleted the existing database.


Database Commands

If you specify the -s argument, this command is interactive; before creating a new eHealth database, it asks a series of questions concerning how to set up the database, the size of the database, and the directories to use for the database.

If you specify the -i argument, you must specify the location of a layout configuration file (LCF), which contains details about how to create the database. In this case, the command is not interactive; it immediately begins to create the database using the parameters specified in the LCF.

When using the nhCreateDb command, follow these guidelines:

■ To run the nhCreateDb command on UNIX, you must first log in as the root user.

■ You must define the environment variable appropriately.

■ By default, eHealth creates a log file of the nhCreateDb operation in ehealth/log/install/CreateDb[n].log, where ehealth represents the eHealth installation directory, and n is the number of times you have run this command. To change the log file pathname, specify the -l argument.


nhCreateDb [-h] [-s oracleSid | -i lcf]

[-l logFile] [-o statusFile] [- t]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) in which to create an eHealth database. By default, the nhCreateDb command uses the value of the ORACLE_SID environment variable for oracleSid.

-i lcf Specifies the LCF to use when creating the database. For more information about LCFs, see the Administration Guide.

-l logFile Specifies the pathname of the log file for the nhCreateDb command. The default is ehealth/log/install/CreateDb.log.

-o statusFile Specifies the output status file.

-t Internal

Creates a tiny database for use in test installations or on development systems.


Database Commands

Examples:

■ Enter the following command to create an eHealth database:

nhCreateDb -s EHEALTH

■ Enter the following command to create an eHealth database using a layout configuration file:

nhCreateDb -i D:/ehealth/oracle/database/purple_EHEALTH.lcf

nhDbApi

Manages the creation and deletion of eHealth database views and tables through an application programming interface (API). These views and tables store statistics information that you can use to obtain trend data.

nhDbMaint

Performs a variety of maintenance tasks on the eHealth database. If you do not specify any arguments, nhDbMaint runs all of its options, except for -deleteArchiveLogs.

Note: You should manually backup and trim the alerts file because the alert_ehealth.log can become very large and impact performance.


nhDbMaint [-h] [-coalesce] [-rebuildIndexes] [- cleanSharedPool]

[-trimAlertLogs] [-deleteArchiveLogs]



- coalesce (Optional) Executes 'alter tablespace t coalesce' on each tablespace.

- rebuildIndexes (Optional) Executes 'alter index i rebuild compute statistics' on various configuration tables.

-cleanSharedPool (Optional) Executes 'alter system flush shared_pool'.

- trimAlertLogs (Optional) Truncates the system alert log files if the log files are larger than 16 MB in size.

- deleteArchiveLogs (Optional) Removes archive logs from the system.


Database Commands

nhDbStatus

Displays the status of the database. This information is similar to the information that appears in the Database Status dialog box of the eHealth console; it informs you about the available space of the devices on which the datafiles reside.

This command has the following format: nhDbStatus [-h] [-host hostname | -cluster | -all]

[-u user] [database]

If you do not specify -host or -cluster or -all, the nhDbStatus command displays the status of the database on the local system. If you specify one of these distributed arguments, the command shows the database status of one, more, or all systems in the cluster, displaying the output on the local system.



-host hostname Specifies the name of the Distributed eHealth System for which you want to display database status. For example, to display the status of the database on the eHealth system named max, enter the following command from any eHealth system in the cluster:


-cluster Displays the database status of all eHealth systems in a Distributed eHealth cluster except the local system.

-all Displays the database status of all eHealth systems in a Distributed eHealth cluster.


database Specifies the name of the database on which to display the status. The default is the value of the NH_RDBMS_NAME environment variable.


Database Commands

Example:

The following shows sample output from an nhDbStatus command run on a Windows system: Database Name: EHEALTH


RDBMS Version: 9.2.0.3.0

+---------------+--------------------+--------------------+----------------------

-----------

| Tablespace | Free Space In | Free Space On | Data Path

| | Data File (bytes) | Device |

+---------------+--------------------+--------------------+----------------------

-----------

| NH_ROLLBACK | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_RBS01.DBF|

| NH_TEMP | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_TEMP.DBF|

| NH_USERS | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_USERS01.DBF|

| NH_INDEX | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/NH_INDX01.DBF|



| SYSTEM | 0.00 | 5401915392.00 | D:/EH56/ORADATA/EHEALTH/SYSTEM01.DBF|

+---------------+--------------------+--------------------+----------------------

-----------

Statistics Data:

Number of Elements: 597


Location(s):

Latest Entry: 19/12/2002 07:44:00

Earliest Entry: 1/11/2002 00:00:00

Last Roll up: 18/12/2002 20:00:50

Conversations Data:

Number of Probes: 0

Number of Nodes: 0

As Polled:

Database Size: N/A

Location(s):

Latest Entry:

Earliest Entry:

Last Roll up: 19/12/2002 04:05:25

Rolled up Conversations:

Database Size: N/A

Location(s):

Latest Entry:

Earliest Entry:

Rolled up Top Conversations:

Database Size: N/A

Location(s):

Latest Entry:


Database Commands

Earliest Entry:

nhDestroyDb

Completely removes an eHealth database, including the Oracle instance, all corresponding database files, the init.ora file, and so on. The nhDestroyDb command does not, however, destroy a database save.

You should delete a database for the following reasons only:

■ The database is corrupted.

■ You need to move the database.

When using the nhDestroyDb command, note the following:

■ You must define the NH_HOME and NH_ORACLE_HOME environment variables.

eHealth creates a log file of the nhDestroyDb operation in ehealth/log/install/DestroyDbEHEALTH.log, where ehealth represents the eHealth installation directory.

■ To run the nhDestroyDb command on UNIX, you must first log in as the root user.

After deleting a database, you must create a new one using the nhCreateDb command. After creating a new database, you can load a previously saved copy of the database using the nhLoadDb command.


nhDestroyDb [-h] -s oracleSid [-f]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) from which to delete the eHealth database.

-f Forces the nhDestroyDb command to proceed with the destruction of the eHealth database. It shuts down all connections to the database and related processes without warning users.


Database Commands

Examples:

■ To delete the database whose Oracle SID is EHEALTH, enter the following:


■ The following is sample output from the nhDestroyDb command on a Windows system when the database server is running but eHealth has been stopped:

c:> nhDestroyDb -s EH56

Destroying the eHealth database 'EH56' ...

0% 25% 50% 75% 100%

|||||||||||||||||||||||||||||||||||||||||||||||||||

Please reboot system prior to creating a new database.

nhGenDataSourceInfo

Regenerates the d:/eHealth/poller/dataSourceInfo.ddi file based on the existing management information base (mib) translation files (mtf's). The resulting file is required by the Path Manager user interface to create path elements.

Note: This script should be rerun whenever mtf files for paths are modified or added.

This command has the following format: nhGenDataSourceInfo [-h] [-rev] [-o filename]




-o filename (Optional) Sends output to the specified file.


Database Commands

nhLoadDb

Completely replaces the contents of the current database with a saved database. This command also copies the saved report, element type, and other customized files into the appropriate directories:

■ The report, element type, and other customized files into their appropriate directories, including ehealth/extension/mibs/usr and ehealth/extension/traps/usr

■ In a remote polling environment, files in ehealth/modules/remotePoller, but not files in ehealth/modules/remotePoller/config

■ In the ehealth/poller directory, any USR-CV*.mtf and USR-CV*.pcm files

The nhLoadDb command automatically detects the version and format of the saved database, and uses the appropriate settings to load it. After loading the database, the command automatically converts it to the current database version, if needed. Only the -p argument is required to use this command.

For more information about saving and loading the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

Important! Improper use of this command can cause loss of data or reports, or stop the eHealth pollers. Use this command only if you are an advanced user familiar with its effects.


nhLoadDb [-h] [-rev] -p path [- useLCF path]

[-fullRecovery | -pointInTimeRecovery date:time] [-showRecoveryTimeRange]

[-force] [-verifyMigration] [-useStdDac] [-difUserBinLoad]

[-ascii (deprecated)] [-binary (deprecated)] [-u user (deprecated)]

[-nolog (deprecated)] [-useOldRestoreScript (deprecated)]

Note: To load a database saved in binary format, the database directory path must be the same as when it was created. Also, the database you are loading cannot be owned by root.



- rev (Optional) Displays the product version.


Database Commands



-p path (Required) Specifies the full pathname of the saved database that you want to load.

If you saved the database to multiple paths, enter only the first path. eHealth automatically finds the remaining paths.

Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If you used the nhSaveDb command and the resulting path (directory name) contains accented characters, you must change those characters to non-accented characters before using the nhLoadDb command.

- useLCF path (Optional) Specifies the location of an LCF file to use when loading the database.

When you use this argument, load maps the files from the saved database to the locations specified in the LCF file. You must create any paths that cannot be mapped.

If you do not specify this argument, load uses the LCF file that is in the save.

- defaultRecovery (Optional) Specifies recovery from a standard backup. The database will be restored to the time that the standard backup occurred.

- fileOnly (Optional) Specifies a files only restore, which loads the report, element type, and other customized files, but does not load the eHealth database.

- showRecoveryTimeRange (Optional) Displays the times for which point-in-time recovery is possible.

This option is only valid for incremental saves.

- skipDbRestore (Optional) Specifies a database update without a restore operation. This is performed after a manual partial restore of the database by a DBA. It handles restoring files as well as modifying the database to address any changes to the machine name or cluster information.

- fullRecovery (Optional) Specifies full recovery from an incremental backup. The database will be restored to its most recent state.

Database Commands



- pointInTimeRecovery date:time

(Optional) Specifies point-in-time recovery from incremental backup. The database will be restored to the time you specify.

Note: You can identify the times for which recovery is available using the -showRecoveryTimeRange option.

Specify the time format as mm:dd:yyyy:hh24:mi:ss.

For example, - pointInTimeRecovery 10:27:2006:23:15:00 will recover the database to its state as of 11:15 P.M. on October 27, 2006.

- force Internal

Specifies that nhLoadDb should proceed with the database load operation without asking for confirmation.

- verifyMigration Internal

(Optional) This argument is used during migrations from Network Health Release 4.8 or eHealth Release 5.0.2 to eHealth 5.6. The eHealth installation program uses it to verify a loaded Ingres database during migration. When using -verifyMigration, you must also specify the -p argument to indicate the location of the saved Ingres database.

- useStdDac Internal

(Optional) When joining a cluster, specifies whether the cluster will use this machine's standard.dac file.

- difBinUserLoad Internal

(Optional) This argument allows you to load a saved binary database that was owned by one eHealth user (as defined by the NH_USER variable) into a database that is owned by a different eHealth user.

- ascii (deprecated) (Optional) Loads a logical save. This flag is deprecated. Load will detect the mode to use automatically.

Database Commands



- binary (deprecated) (Optional) Loads a full (standard) save. This flag is deprecated. Use -defaultRecovery to load a standard save.

nhManageDbSpace

Manages database space. Use this command to:

■ Add a datafile to an eHealth tablespace.

■ Move a datafile from one location to another.

■ Move all datafiles from one location to another.

■ Create a layout configuration file (LCF).

■ Improve database performance and allow for future growth, when used in conjunction with nhDbStatus.

Note: Before using this command to add or move a datafile, stop eHealth.

This command has the following format: nhManageDbSpace [-h] [-rev]

■ To add a datafile to a tablespace or evaluate its addition:

nhManageDbSpace [-evaluate] -add -newPath directory

-tablespace tablespace -size fileSize

■ To move a datafile to another location or evaluate the move:

nhManageDbSpace [-evaluate] -move -datafile datafile

-newPath directory

■ To move all the Reg tablespaces:

nhManageDbSpace -moveRegTableSpaceTo newDirPath

■ To create a layout configuration file (LCF):

nhManageDbSpace -createLcf [filename]




Database Commands



-add Adds a datafile to the tablespace specified by the - tablespace argument. When specifying -add, do not specify a name for the new datafile; eHealth assigns a datafile name using appropriate naming conventions.

-move Moves the data file specified by -datafile to the location specified by -newPath. When specifying -move, do not specify the tablespace in which the data file resides; eHealth locates the specified data file automatically.

Note: Only the following tablespaces can be moved using this option: NH_USERS, NH_INDEX, NH_DATA01, NH_DATA02. Before moving any of these tablespaces you must stop the eHealth server and database, check the memory and semaphores sections for active processes associated with the ehUser account, and stop those processes. See the first example below.

-moveRegTableSpaceTo newDirPath

Queries the database to find all the tablespaces named %NH_REG% and moves the datafiles to the new directory location.

Note: This is not compatible with the -evaluate argument.

-tablespace tablespace Specifies the name of the tablespace to which you want to add a datafile. You must specify this argument when using - add.

-newPath directory Specifies the pathname of the database directory to which you are adding or moving the datafile (the top-level directory for the eHealth database). eHealth will create the appropriate directory structure within the specified directory.

You must specify this argument when using -add or - move.

Database Commands



-datafile datafile Specifies the name of the datafile to move. You must specify this argument when using -move.

-size fileSize Specifies the initial size of the new datafile in megabytes. You must specify this argument when using -add.

-evaluate Evaluates whether the other parameters are valid. This parameter is optional. It determines whether the pathname and tablespace exist and whether there is enough disk space within the recommended range for the proposed add or move operation. This argument returns any appropriate warnings, but it does not modify the database.

-createLcf [filename] Creates an LCF. If you do not specify a file name for the LCF (with a full path), it is named hostname_sid.lcf (such as mySystem_EHEALTH.lcf); it resides in the ehealth/oracle/database directory, where ehealth is the eHealth installation directory.

Use this argument when you have made manual changes to your eHealth database (such as adding an archive file), and you want to record the new database structure. If you later need to recreate the database (due to corruption, for example), do the following:

Move the LCF to a location outside the eHealth installation directory.

Specify nhSaveDb to save the database.

Specify nhDestroyDb to destroy the database.

Specify nhCreateDb -i lcf. The nhCreateDb command uses the LCF as input when creating the database and thus preserves your changes.

Specify nhLoadDb to load the database.

For information about LCFs, refer to Creating the Database Layout Configuration File.

Database Commands

Examples:

■ To move the NH_INDEX01 datafile to C:\database, first stopping the eHealth server, enter the following commands:

nhServer stop

nhManageDbSpace -move \



nhStartDb

■ To test whether a command and its arguments are valid without actually moving a datafile, add the -evaluate argument, as follows:

nhManageDbSpace -evaluate -move \



■ To evaluate a command to add a datafile of 20 megabytes to the NH_DATA01 tablespace, enter the following: nhManageDbSpace -evaluate -add \

-newPath C:/database \

-tablespace NH_DATA01 -size 20

■ To create a layout configuration file for your eHealth database, enter the following:

nhManageDbSpace -createLcf /tmp/myDb.lcf

nhManageUsers

Modifies the contents of the eHealth password file (located in ehealth/sys/ehUsers.cfg, where ehealth represents the eHealth installation directory).

This command has the following format: nhManageUsers [-h]

nhManageUsers -add -user username

-priv [admin|readOnly]

nhManageUsers -modPriv -user username

-priv {admin | readOnly}

nhManageUsers -delete -user username

nhManageUsers -showPass -user username

nhManageUsers -modPass -user username [-listener]

nhManageUsers -showPriv -user username

nhManageUsers - passPhrase

nhManageUsers -list

nhManageUsers -crtDefault


Database Commands



-add Adds the user specified by the -user argument.

-user username Specifies the login username that the command affects. The name is the account that a user enters to access eHealth or the eHealth database.

-priv {admin | readOnly} Specifies whether to apply administrator or read-only user privileges to the specified user. You can specify this argument if you specify the -add or -modPriv argument.

-modPriv Modifies the privileges for the user specified by the -user argument.

-delete Removes the user specified by the -user argument.

- showPass Displays the password for the user specified by the -user argument.

- modPass Modifies the password for the user specified by the -user argument. The command prompts you to enter the current password, then enter and re-enter the new password.

The password must start with an alphanumeric character and may include alphabetic, numeric, and underscore characters; no other special characters are permitted. The password may be 30 characters long and is not case- sensitive.

To change the password for the nhlistener account, specify nhManageUsers -modPass -listener. This syntax is necessary because changes to the nhlistener account must occur within and outside of the database.

-showPriv Displays the privileges for the user specified by the -user argument.

- passPhrase Modifies the password phrase originally entered during the installation. The command prompts you to enter and re-enter the new phrase.


Database Commands



-list Prints a list of users and their privileges. This list is generated from the password file, rather than from Oracle’s ALL_USERS view.

- crtDefault Internal

Removes ehUsers.cfg from the ehealth/sys directory and recreates a default version of that file containing only the nhuser, sys, and system users. You may want to use this argument when the eHealth system is in an unstable state.

Examples:

■ To apply administrator privileges to an account named ehReports, enter the following:

nhManageUsers -modPriv -user ehReports -priv admin

■ To add a user with administrator privileges as an account named ehUser, enter the following:

nhManageUsers -add -user ehUser -priv admin

Note: If you add more than one eHealth administrator, they should share the same eHealth password.

nhReset

Stops and restarts the eHealth server. If your eHealth software is installed on a UNIX system, this command also trims system tables, cleans up temporary files, and reallocates memory.

Important! This command stops and restarts the eHealth pollers. Use only if you are an advanced user familiar with its effects.

The nhReset command closes any eHealth dialog boxes that are open, except for the console and the polling status windows. Use it to perform periodic maintenance of the eHealth database or to reset the eHealth server after a system crash. The nhReset command syntax and its use depend on your operating system.

If the NH_RESET_ORACLE environment variable is set to yes, the nhReset command shuts down and restarts the Oracle database server, and restarts the eHealth server.

Database Commands


On UNIX Systems

Run the source nethealthrc.csh command, then type:

nhReset

On Windows Systems

The nhReset command does not stop and start the Oracle database server. However, you can force nhReset to restart the Oracle database server by specifying the -db argument, as follows:

nhReset -db

nhSaveDb

Saves the current eHealth database to a series of files. Use nhSaveDb to back up your database.

Note: To schedule regular database backups, use the nhSaveDbConfig command.

If you use nhLoadDb to replace your current database with a saved database, the database directory path must be the same as when it was created using nhSaveDb, unless the database was saved using the -ascii option.

For more information about backing up the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

Saves completed using the nhSaveDb command are known as long-term saves. They are not regularly overwritten or deleted by eHealth. If you save the database to a path that already contains a long-term save, eHealth automatically creates a backup of the existing saved database in path.bak, and saves the current copy in path.

This command has the following format: nhSaveDb [-h] [-rev] {-p path [...] | -validate path | -showProgress}

[-fullBackup | -ascii [-fast] [-compress] | -fileOnly]

[-noDiskSpaceCheck] [-incrLevel1]

[-binary] [-backup (deprecated)]





Database Commands





If you save the database to the same location as an existing save, the existing save is retained until the new save completes successfully. After the new save is validated, the prior save is deleted.

Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If the target directory name contains accented characters, you must change those characters to non- accented characters before using the nhSaveDb command.

-validate path (Optional) Performs diagnostics to ensure that an existing backup at the specified path is valid for recovery.

If you saved the backup to multiple paths, enter only the first path.

To use the -validate option, you must specify it as the only argument.

- showProgress (Optional) Displays the status of a currently running binary save.

To use the -showProgress option, you must specify it as the only argument.

Note: The -showProgress option is not supported for universal (ASCII) saves.

-fullBackup (Optional) Specifies that a standard (full) save be performed. Standard saves are binary, platform-dependent, path-dependent, and language-dependent saves of all the physical database blocks using the Oracle RMAN utility.

This is the default if you do not specify another type of save.

Database Commands



-ascii

[-fast]

[-compress]

(Optional) Specifies that an universal (ASCII) save be performed. Universal saves are platform-independent, path- independent, and language-independent saves using the Oracle export utility.

Universal saves allow you to load the information into an eHealth database running on a different platform. However, they consume more disk space and require more time than binary saves.

You can use either of the following options with the -ascii argument:

-fast – (Optional) performs the ascii save in a platform-specific format, which takes less time, but is not portable. You can still load the information into another eHealth database, but that database must be running on the same type of system (Windows or UNIX).

-compress – (Optional) compresses the save so that it requires less space.

-fileOnly (Optional) Specifies that a files only save be performed. This option saves only the report, element type, and other customized files, but does not save the eHealth database.

- noDiskSpaceCheck

(Optional) Specifies that the system skip the disk space estimate before saving the database.

-incrLevel1 (Optional) Specifies that an incremental Level 1 save be performed. Level 1 saves record only the data that has changed since the last backup, saving time and disk space.

-binary

(internal)

(Optional) Saves the database in a platform-dependent, path-dependent, and language-dependent format using the Oracle RMAN utility.

Note: This option has been replaced by -fullBackup. The -binary option is still supported for customers who have created scripts to perform scheduled backups using the nhSaveDb command, or those who are familiar with using the option.





Database Commands





Example:

The following example saves a copy of the current database to three paths (E:\waltham.tdb F:\concord.tdb, and G:\paxton.tdb) using the -fullBackup option:

nhSaveDb -p E:\waltham.tdb -p F:\concord.tdb -p G:\paxton.tdb

nhSaveDbConfig

nhSaveDbConfig schedules a database backup job to occur regularly. Use nhSaveDbConfig to implement a backup strategy for the eHealth database.

Note: For more information about backing up the database, and the types of saves that eHealth supports, see the eHealth Administration Guide.

This command has the following format: nhSaveDbConfig [-h] [-rev] [-list | -listSizes] [-delete jobID]

[-add -p path [...] - startDate MM-DD-YYYY -startTime HH:MM

{-fullBackup period | -incrLevel0Days interval - incrLevel1 period |

-ascii period} ]




-list (Optional) Displays a list of currently scheduled backups.

- listSizes (Optional) Displays the size of recent backups.

- delete jobID (Optional) Deletes the scheduled backup with the specified ID number.

You can obtain a list of ID numbers for currently scheduled backups using the command nhSaveDbConfig - list.

-add (Optional) Schedules a new database backup job.

Note: The remaining arguments (below) apply to the -add option only.


Database Commands





Note: When using French or Spanish eHealth, the path value cannot contain accented characters. If the target directory name contains accented characters, you must change those characters to non-accented characters before using the nhSaveDbConfig command.

- startDate date (Required) Specifies the date on which to begin backups.

You can specify the date in the format MM/DD/YYYY, unless you have set NH_DATE_FMT to DMY.

- startTime time (Required) Specifies the time at which the backup job will run.

You must specify the time in the format HH:MM.

- fullBackup period clause

Specifies that a full (standard) save be performed at the specified interval.

Standard saves are binary, platform-dependent, path- dependent, and language-dependent saves using the Oracle RMAN utility.


period hours – Specifies an interval of hours between backups. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, - fullBackup period 12 will perform a full save every 12 hours.

daily nyyynyn – Specifies the days of the week to perform the backup. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, - fullBackup daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

Database Commands



- incrLevel0Days interval

Specifies that an incremental Level 0 save be performed at the specified interval. Level 0 saves are full database saves similar to a standard save.

You specify the interval as the number of days between Level 0 saves. For example, -incrLevel0Days 7 schedules a Level 0 save to occur once a week, while -incrLevel0Days 2 schedules a save to occur every other day.

- incrLevel1 period clause

Specifies that an incremental Level 1 save be performed at the specified period. Level 1 saves record only the data that has changed since the last backup, saving time and disk space.


period hours – Specifies an interval of hours between Level 1 saves. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, - incrLevel1 period 6 will perform a Level 1 save every 6 hours.

daily nyyynyn – Specifies the days of the week to perform the Level 1 save. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, - incrLevel1 daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

Database Commands



period clause

Specifies that an universal (ASCII) save be performed at the specified interval. Universal saves are platform-independent, path-independent, and language-independent saves using the Oracle export utility.


period hours – Specifies an interval of hours between saves. Valid settings are 1, 2, 4, 6, 8, and 12 hours. For example, period 12 will perform a save every 12 hours.

daily nyyynyn – Specifies the days of the week to perform the backup. Saves occur on each day with a y, at the time specified by the -startTime argument. You must specify all days of week beginning with Sunday. For example, daily nyyyyyn will perform a save Monday through Friday, but will not perform the save on Saturday or Sunday.

Note: Only 1 save location is supported for ASCII saves.









Database Commands

Example: Listing Scheduled Job

The following command lists the job ID of the currently scheduled backup job:

nhSaveDbConfig -list

------+--------+------------------+------------------+---------+--------+--------

--------+ BACKUP| BACKUP | PERIOD | PERIOD | IS | IS

| START ID | MODE | FULL | INCR |COMPRESS | FAST

| AT ------+--------+------------------+------------------+---------+--------

+----------------+ 1 |binary Every 7 days M,Tu,W,Th,F,Sa No

No 09/24/2006 23:00 ------+--------+------------------+----------------

--+---------+--------+----------------+ 09/18/2006 08:36:49 PM - Done.

Example: Deleting an Existing Job

The following command deletes an existing job with a jobID of 1.

nhSaveDbConfig -delete 1

Example: Scheduling Daily Incremental Saves

The following command schedules an incremental level 0 save to occur every Sunday at 7:00 P.M. and a level 1 save to occur Monday through Saturday at the same time. This command also specifies three separate paths in which to save the database.

nhSaveDbConfig -add -incrLevel0Days 7 -incrLevel1 daily nyyyyyy





Note: When you specify daily, you include the days on which level 1 backups run.

Example: Scheduling Periodic Incremental Saves

The following command schedules an incremental level 0 save to occur every Sunday at 7:00 P.M. and a level 1 save to occur every 6 hours. This command also specifies two separate paths in which to save the database.

nhSaveDbConfig -add -incrLevel0Days 7 -incrLevel1 period 6




Example: Scheduling Full (Standard) Saves


Database Commands

The following command schedules a full (standard) save to occur every day at 11:15 P.M.

nhSaveDbConfig -add -fullBackup daily yyyyyyy



Example: Scheduling a Weekly Universal (ASCII) Save

The following command schedules a universal (ASCII) save to occur every Saturday at 2:45 A.M.

nhSaveDbConfig -add -ascii daily nnnnnny



nhStartDb

Starts the Oracle instance of the eHealth database, as specified by the ORACLE_SID environment variable. It also starts the TNS Listener or SQL*Net.

Note: To perform periodic maintenance of the eHealth database, use the eHealth Maintenance schedule.

This command has the following format: nhStartDb [-h] [-s oracleSid] [-listenerName listenerName]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) for the eHealth database. By default, the nhStartDb command uses the value of the ORACLE_SID environment variable for oracleSid.

-listenerName listenerName Specifies a non-default listener name. The value that you specify replaces "LISTENER" as the the default value of the environment variable, NH_ORA_LISTENER_NAME.

Example:

Enter the following command to start the eHealth database:

nhStartDb


Database Commands

nhStopDb

Stops the Oracle instance of the eHealth database, as specified by the ORACLE_SID environment variable.

This command has the following format: nhStopDb [-h] [-s oracleSid]

[normal | immediate | abort]

[-listenerName listenerName]



-s oracleSid Specifies the name of the Oracle instance (the Oracle session identifier or SID) for the eHealth database. By default, the nhStopDb command uses the value of the ORACLE_SID environment variable for oracleSid.

normal (Default) Specifies a normal database shutdown, waiting for users to disconnect from the database. It proceeds as follows: nhStopDb checks for eHealth processes; if any are running, it issues an error and exits. You must stop all eHealth processes and run nhStopDb again. If eHealth processes are not running, nhStopDb does the following:


■ Waits for users to disconnect from the database.

■ Closes and dismounts the database.


immediate Specifies an immediate database shutdown without waiting for calls to finish or users to disconnect. It proceeds as follows: nhStopDb checks for eHealth processes; if any are running, it issues a warning and then stops those processes. It then does the following:


■ Closes and dismounts the database (without waiting for current calls to finish or users to disconnect from the database).



Database Commands



abort Specifies the fastest possible shutdown of the database without waiting for calls to finish or users to disconnect. Use this option if a background process terminates abnormally. nhStopDb checks for eHealth processes; if any are running, it issues a warning and then stops those processes. It then does the following:

■ Disconnects all users currently connected to the database.

■ Terminates client SQL statements currently being processed.

■ Does not roll back uncommitted transactions. (The next database startup will require instance recovery.)

-listenerName listenerName

Specifies a non-default listener name. The value you specify for this option precedes the environment variable NH_ORA_LISTENER_NAME, which precedes the default value of "LISTENER".

nhUpdateDbProtocol

Updates the database with any changes that you make to user application definition files in the sys directory of your eHealth installation. If you have a Traffic Accountant license, you can add definitions for your specific applications to these files to generate reports on the conversations for these applications.

This command has the following format: nhUpdateDbProtocol [-u user] -t user|sys database



-t user | sys Specifies the type of application definition file to use: user or sys. This argument is required.

For more information about specifying the file type, see the “Editing User Application Definition Files” section below.

database Specifies the name of the database on which to run the status. This argument is required.

Distributed eHealth Commands



-host hostname Specifies the name of the eHealth system in the cluster on which you want to run the command. For example, to run the nhDbStatus command on the eHealth system named max, enter the following command from any eHealth system in the cluster:


-cluster Runs the command on all eHealth systems in the cluster except the local system.

-all Runs the command on all eHealth systems in the cluster.

Distributed eHealth Commands The Distributed eHealth commands topics describe the following:

■ Distributed Command Arguments and Special Variables

■ Understanding the Dots in Distributed Commands

■ nhAddSysEdgeMonEntries

■ nhDeleteAnalyzedData

■ nhFindClusterDiffs

■ nhFindDupObjects

■ nhFindElement

■ nhGetFile

■ nhJoinCluster

■ nhListClusterMembers

■ nhModifyClusterMember

■ nhPutFile

■ nhRemoveClusterMember

■ nhReplicate

■ nhRestoreClusterMember

■ nhRunCommand

■ nhScrubFsa


■ nhSetClusterMode

■ nhSetClusterPasswd

■ nhSynchronize

■ nhUpdateClusterTable

■ nhUpdateDatabaseIds

Distributed Command Arguments and Special Variables

When you run the nhPutFile, nhGetFile, and nhRunCommand commands, you can use a variety of special variables within file names and path argument values. These variables can help you to run commands that work for all systems in the cluster, regardless of specific local settings such as the pathname of the eHealth installation directory.

The following table describes the variables that you can use in pathnames and command string arguments:

Variable Description

attachPathname1, attachPathname2

...

attachPathname5

Represents the resolved pathname of attachment1. You use this variable to send a file which is then read by the remote program. Five attachments are supported, up to attachPathname5. (attachPathname1 is associated with - attachFile1, and so on.)

HOME Represents the directory pathname of the HOME environment variable (which is the pathname of the logged-in user’s home directory). This variable is only relevant on the local member. HOME does not include the trailing '/'.

localHostname Represents the hostname of the local eHealth system that is running the command. This variable allows the remote eHealth systems in the cluster to return data to the system that initially ran the command.

NH_HOME Represents the directory pathname of the eHealth home directory. It does not include the trailing backslash (/).




Variable Description

remoteHostname Represents the hostname of the remote eHealth system on which the command will run.

returnPathname1 returnPathname2

...

returnPathname5

Represents the resolved pathname of returned file 1. You use this variable to represent the pathname of a file returned by the command. Five return files are supported, up to returnPathname5. (returnPathname1 is associated with - returnFile1, and so on.)

When you use a variable in a command argument, you must specify it in the following format:

$(variable)

An example of a command that uses some of these variables follows. This command retrieves the messages.stats.log file from each cluster member system (including the local system) and saves each file in the local ehealth/tmp directory as pollerMsgs.log.remoteHostname. nhGetFile -all -fromFile '$(ehealth)/log/pollerStatus/messages.stats.log' \

-toFile '$(ehealth)/tmp/pollerMsgs.log.$(remoteHostname)'

Note: When you include a variable in a value, you must enclose the value in single quote (' ') characters, as shown in this example.

In the command example, note that each eHealth system substitutes ehealth with the local value of the eHealth installation directory. Likewise, the local system substitutes remoteHostname with the hostname of each system that returns the specified file.

Understanding the Dots in Distributed Commands

When you run a distributed command such as nhFindClusterDiffs, you might notice a series of period characters (.) that appear in the command output. For example:



Searching for cluster differences between objects of type group...... OK

In this command, note the string of periods that appear before the OK. The periods appear one at a time, and finally the word OK appears. In many commands, periods are progress indicators—they indicate that the command is working or in progress.


For Distributed eHealth commands, these periods have a special meaning. The first period indicates that the eHealth system on which you ran the command has sent the command to all designated systems. Each subsequent period indicates a cluster member that has processed the command. So, in the example above which specifies the -cluster argument (that is, run on all systems in the cluster except the local system), the periods indicate that the command was sent (first period) and that five other systems in the cluster ran the command and responded. Assuming that the cluster has six members, the command successfully ran on the five others.

If the cluster had more than six members, the additional systems did not receive or respond to the command. The systems may have been down, or they may have been removed from the cluster. You should use Cluster Status to determine how many other systems are in the cluster and whether the connection to any system is down from the local system where you ran the distributed command.

nhAddSysEdgeMonEntries

Configures the SystemEDGE agent to monitor critical eHealth processes and system logs on an eHealth system; adds entries to the sysedge.cf file; and stops and restarts the SystemEDGE agent to implement the changes.

Note: To use this command, a SystemEDGE agent must be running.

If -trapList is specified, the script monitors 19 log files and 16 processes; if -mail is specified, the script monitors only 17 log files and none of the processes. To ensure that you receive messages about problems that occur with the log files, you must specify the - mail argument with an e-mail address.

On UNIX systems, you must log in as the root user to run this command. The sysede.cf file lives in /etc on UNIX systems and %SystemRoot%\system32 on Windows systems.

Note: In Release 5.6, nhAddSysEdgeMonEntries uses the index range 602000 through 602999. If you used nhAddSysEdgeMonEntries with a previous release of eHealth, the index started at 1000000. Before you can use the command again, you must delete the existing entries in the sysedge.cf file, which resides in /etc/sysedge.cf on Unix systems and in \winnt\system32\sysedge.cf on Windows systems.

This command has the following format: nhAddSysEdgeMonEntries [-h]

{[-accessList ipaddr_list] [- trapList ipaddr_list] [- mail email_addr]

[-trapExpr "regExpList"] [- mailExpr "regExpList"]}



Although each of the arguments individually is optional, you must enter one or more of them with this command.



- accessList ipaddr_list (Optional) Specifies a list of IP addresses (separated by commas) that defines the access community. The command adds these values to the configuration file.

If you specify an empty access list, SystemEDGE grants access to any system that uses the community string.

-trapList ipaddr_list (Optional) Specifies a list of IP addresses (separated by commas) that defines the destinations to which the SystemEDGE agent sends traps. When the agent finds a matching string in any one of 19 log files or observes a problem with one of 16 monitored process, it sends a trap to the specified destinations.

-mail email_addr (Optional) Specifies the e-mail address of the user to whom the agent sends the log file. If the SystemEDGE agent finds a matching expression in any one of 17 monitored log files, it emails the log file to this user.

Note: When you specify -mail, nhAddSysEdgeMonEntries does not monitor processes.

-trapExpr "regExpList" (Optional) Specifies a string of comma-separated regular expressions for which the agent sends a trap whenever it finds a match. You must enclose the string in double quotes (" "). You can specify only the following values: error, warning, info, unknown.

For the values that you specify, SystemEDGE sends a trap message when it encounters any of the specified values (in any letter casing) in a log file. If you do not specify the -trapExpr argument, the agent will not send any traps for log file messages.





-mailExpr "regExpList" (Optional) Specifies a string of comma-separated regular expressions for which the agent sends e- mail whenever it finds a match in the logMonTable. You must enclose the string in double quotes (" "). You can specify only the following values: error, warning, info, unknown.

For the values that you specify, SystemEDGE e-mails the associated log file every time it encounters any of the specified values (in any letter casing) since the last time it checked the log file. If you do not specify the -mailExpr argument, the agent will not send any e-mail for log file messages.

Examples:

The command adds entries to the sysedge.cf file which is located in /etc on UNIX systems and %SystemRoot%\winnt\system32 on Windows systems. The command also stops and restarts the SystemEDGE agent to cause the changes to take effect.

■ To run the nhAddSysEdgeMonEntries command on a UNIX system, log in to the eHealth system as root. (Only the root user can configure the SystemEDGE agent.) Open a terminal window and change to the eHealth installation directory as follows:

cd ehealth

Source the nethealthrc resource file for your shell type.

■ To run the nhAddSysEdgeMonEntries command on a Windows system, log in as the eHealth administrator and open a DOS command window. In the command/terminal window, use the following command:

nhAddSysEdgeMonEntries arguments

Specify the -trapList Argument on Windows

When you specify the -trapList argument on Windows systems, you must specify the trap destinations for the SNMP service.

To define trap destinations for the SNMP service

1. Open the Windows Services dialog box.

2. Right-click SNMP Service and select Properties from the shortcut menu.

3. In the SNMP Service Properties dialog box, click the Traps tab.

4. In the Community name field, specify the community for the trap received (such as Public).


5. Click Add to List.

6. For each trap destination that you want to add, do the following:

a. Under Trap destinations, click Add.

b. Specify the hostname or IP address of a trap destination to which the SystemEDGE agent should send traps, and click Add.

c. Click OK.

7. In the Services dialog box, stop and restart the SNMP Service.

Examples of the command:

■ The following example sends traps to destination 1.2.3.4 when a critical process stops or when a log file contains the word error:

nhAddSysEdgeMonEntries -trapList 1.2.3.4 -trapExpr "error"

The command outputs the following information:

■ Stopping SystemEDGE Management Agent

■ SystemEDGE Management Agent starting.

■ The following example sends e-mail to account [email protected] when a log file contains the word error or unknown:

nhAddSysEdgeMonEntries -mail [email protected] -mailExpr "error,

unknown"

■ The following example sends traps to destination 1.2.3.4 when a critical process stops or when a log file contains the word error. It also sends e-mail to account [email protected] when a critical process stops or when a log file contains the word unknown:

nhAddSysEdgeMonEntries -trapList 1.2.3.4 -trapExpr "error" -mail

[email protected] -mailExpr "unknown"

The nhAddSysEdgeMonEntries command configures eHealth SystemEDGE to monitor the default log files for these specific string cases; you can, however, use SystemEDGE commands and utilities to increase these monitoring capabilities.

nhDeleteAnalyzedData

Deletes the analyzed data for one or more service profiles. If you change the settings of a service profile that is used by scheduled reports, the analyzed data for those reports could become inconsistent; the analyzed data for the days before the profile changed could be different from the analyzed data that occurs for days after the profile change.



In a Distributed eHealth cluster, service profiles are replicated among the cluster members. If you change a profile, the changes could affect the appearance of reports on other cluster members. You can use the nhDeleteAnalyzedData command to delete existing analyzed data for a service profile. The next time the scheduled Data Analysis job runs, it will create new analyzed data for the reports based on the new service profile settings; the next time the reports run, the data in the reports will be consistent.

Note: In a Distributed eHealth environment, you should specify the -all argument with the nhDeleteAnalyzedData command to ensure that you delete the analyzed data from all Distributed eHealth Systems in the cluster.

This command has the following format: nhDeleteAnalyzedData [-h] [-rev] -afterDate mmddyyyy

[-host hostname | -cluster | -all ]

[-serviceProfileIds machineId@serviceProfileId ... ]




-afterDate mmddyyyy

Specifies the date after which eHealth deletes the analyzed data for the specified service profiles. For example, if you specify 01062001, eHealth deletes all analyzed data for the service profile after January 6, 2001 (that is, starting on January 7, 2001).

-host hostname Deletes the analyzed data for the service profiles on the specified eHealth system hostname. If you do not specify - host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.

-cluster Deletes the analyzed data for the service profiles on all other systems in the cluster except the local system. If you do not specify -host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.

-all Deletes the analyzed data for the service profiles on all eHealth systems in the cluster. If you do not specify -host, -cluster, or -all, the command deletes the analyzed data on the local eHealth system.





- serviceProfileIds machineId@ serviceProfileId ...

Specifies one or more service profiles for which you want to delete the analyzed data. To uniquely identify the service profiles, you must specify the service profile ID and the member ID of the cluster system.

If you do not specify a service profile ID, the command deletes the analyzed data for all service profiles on the specified eHealth systems.

When you create a service profile on a Distributed eHealth System, eHealth saves the profile in the ehealth/reports/dataAnalysis directory, where ehealth represents the eHealth installation directory. The file name has the following format:

profileName.memberId.profileId.dac

Example:

CorpProfile.739247905.1000001.dac

Examples:

■ The following example deletes the analyzed data for the service profile CorpProfile on the eHealth system CHICAGO after June 12, 2003:

nhDeleteAnalyzedData -afterDate 06122003 \

-host CHICAGO \

-serviceProfileIds 739247905@1000001

Note: If you run a Health, Service Level, or MyHealth report for a report period that includes any days before the -afterDate value, your reports will display a data note indicating that the analysis controls changed on the day after the -afterDate value.

■ The following example deletes all analyzed data on the local eHealth system after November 23, 2002:

nhDeleteAnalyzedData -afterDate 11232002

■ If the command does not find any analyzed data for the specified profiles, it displays the following message:

No data associated with service profile profileId.

nhFindClusterDiffs

Compares the configuration of one or more eHealth systems in a Distributed eHealth cluster to determine whether their replicated information is synchronized. The command displays information about the differences in the replicated information.



nhFindClusterDiffs [-h] [-rev] { -host hostname | -cluster }

[ -objTypeAll | -objType objType | -objTypeList ]

[-includeHomed] [-localView] [-retryTime seconds]

The local system is the system that you are logged into when you run the command.




- host hostname Compares the replicated information on the local system to the information on the specified eHealth system hostname. This argument is required unless you specify -cluster.

- cluster Compares the replicated information on all of the other systems in the cluster to the local system and displays the differences for each system. This argument is required unless you specify -host.

If you also specify the -localView argument, the output shows the differences for the local system only.

- objTypeAll Compares the replicated information for the group, groupList, groupListContents, dataAnalysisRec, and serviceProfile objects. This is the default.

To include the replicated information for elements and group sections, you must specify the -includeHomed argument.

You can check for differences for a specific object type using the -objType argument.

- objType objType Compares the information for a specified object type. You can select one of the following object type values:

■ element

■ group

■ groupSection

■ groupList


■ dataAnalysisRec

■ serviceProfile






- includeHomed Compares the replicated information for element and groupSection objects as well as the other specified object or objects.

- localView Displays the differences relative to the local eHealth system only. This argument is meaningful only when you specify the -cluster argument.

If you include this argument, the command displays the differences for only the local system. This shows you how much the local eHealth system is in (or out of) synchronization with the other systems in the cluster.

- retryTime seconds


The default is 0, which indicates that the local system will not retry the command. If you specify a value, it should be less than the value of the NH_REPL_MSG_TIMEOUT environment variable, which is 300 seconds (five minutes) by default.

If the nhFindClusterDiffs command shows that the eHealth systems are not synchronized, you can run the nhReplicate or nhSynchronize commands to synchronize them.


Examples:

■ The following example checks all object types and displays the differences. (In this example, the command found no differences among the object information that require correction.)



Searching for cluster differences between objects of type group... OK

Searching for cluster differences between objects of type groupList... OK

Searching for cluster differences between objects of type

groupListContents... OK

Searching for cluster differences between objects of type dataAnalysisRec...

OK

Searching for cluster differences between objects of type serviceProfile...

OK

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

**




-----------------------------+-------------------+---------------------------

--



-----------------------------+-------------------+---------------------------

--

dataAnalysisRec 2 2 0 0

element 2 2 0 0

group 2 2 8 0

groupSection 2 2 0 0

groupList 2 2 0 0

groupListContents 2 2 0 0

serviceProfile 2 2 0 0

-----------------------------+-------------------+---------------------------

--

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

**



■ The following example checks the cluster for group list differences. (In this example, the command finds differences that must be resolved. see the text after the example for an explanation.)

nhFindClusterDiffs -cluster -objType groupList


Searching for cluster differences between objects of type groupList..... OK

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

**




-----------------------------+-------------------+---------------------------

--



-----------------------------+-------------------+---------------------------

--

groupList 4 4 2 2

-----------------------------+-------------------+---------------------------

--

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

**

-----------------------------------------------------------------------------

-

Object Type: groupList

Machines Polled: 4

Responses Received: 4

Object(s) Processed: 2

Object Update(s) Required: 2

-----------------------------------------------------------------------------

-

Object Name: abc_LanServer

Object Id: 739249216:1000007


(+ 2 others)

Machine(s) to Update: solomon <No Object>

Object Name: 50-grouplists

Object Id: 739249216:1000008


(+ 2 others)

Machine(s) to Update: solomon 07/10/2001 05:23:35 PM

-----------------------------------------------------------------------------

-



■ In this example, both group lists have differences in the cluster. The groups are the same on three systems (tigger + two others), but one system (solomon) has old information. For the abc_LanServer group list, the <No Object> value indicates that the cluster member solomon has no information about the group list. For the 50-grouplists, the system solomon has old information about the group lists. The time stamp 07/10/2001 indicates that the group list information on solomon is over 7 days older than the latest information on the other systems.

■ To correct these differences, log into solomon as the eHealth administrator and run the nhSynchronize command as follows:

nhSynchronize -host tigger -objType groupList

■ You could also log into an up-to-date system such as tigger and use the nhReplicate command to update solomon as follows:

nhReplicate -host solomon -objType groupList

nhFindDupObjects

Searches for duplicate elements, groups, group lists, and service profiles in a Distributed eHealth cluster and displays information about the duplicates and which Distributed eHealth systems own them. You can run this command from any Distributed eHealth System or Console in the cluster.

This command has the following format: nhFindDupObjects [-h] [-rev] { -host hostname | -all }

[-objTypeAll | -objType objType ] [-objTypeList]

[-outFile filename] [-outLimit number] [-retryTime seconds]

[-timeout seconds]




-host hostname Specifies the name of the Distributed eHealth System that you want to compare for duplicate objects with the local system. This argument is required unless you specify -all.

-all Compares all other Distributed eHealth Systems with the local system to locate duplicate objects. This argument is required unless you specify -host.

-objTypeAll Identifies duplicates among all object types. This is the default.





-objType objType Identifies duplicates in the specified object type. You can select one of the following object type values:

■ element

■ group

■ groupList

■ serviceProfile


-outFile filename Sends the command output to the specified file named filename. The file contains data in comma-separated value (CSV) format. If you do not specify an output file, the command outputs data to standard output (usually the command line).

-outLimit number Specifies the maximum number of duplicate objects to display. The default is 10,000 objects. If you specify 0, the command displays all of the duplicate objects.

-retryTime seconds






Examples:

The following command checks all systems in the cluster for duplicate objects and displays the information for any duplicates found: nhFindDupObjects -all -objTypeAll

Cluster Find Duplicates initiated:

Querying cluster ... OK

finding duplicate elements on shaggy DONE

finding duplicate elements on eire DONE

finding duplicate elements on baffin DONE

finding duplicate group names on local machine DONE

finding duplicate group list names on local machine DONE

finding duplicate service profile names on local machine DONE

oak-sh,eire,06-12-01 12:04:06

oak-sh,shaggy,07-17-01 14:40:33

enid-sh,eire,06-12-01 12:04:04

enid-sh,shaggy,07-17-01 14:40:32

barney-sh,eire,06-12-01 12:04:03

barney-sh,shaggy,07-17-01 14:40:32

voyager-rh,eire,06-12-01 12:04:09

voyager-rh,shaggy,07-17-01 14:40:34

(element list abbreviated for documentation readability)

SUMMARY:

Member Name # of Duplicates

---------------+--+---------------

shaggy 41

eire 83

baffin 59

You can use the command to identify the duplicate objects in your cluster and remove them. Duplicate groups, group lists, and service profiles typically occur when eHealth administrators or scheduled processes create objects with the same name on multiple cluster systems. Duplicate elements typically occur when several Distributed eHealth Systems discover and poll the same elements. For example, the systems eire and shaggy are both polling a system named oak. The information on shaggy has a more recent timestamp than the information on eire, so shaggy has more up-to-date element information. You should delete one of the oak-sh system elements to free up the poller license and reduce duplicate data in your distributed reports.

Default: The command shows up to 10,000 duplicate objects. You use the -outLimit argument to specify the number of duplicate objects that the command displays. If you specify a value of 0, the command displays all duplicate objects. If you specify a value such as 1,000, and there are actually more than 1,000 duplicates, the command displays the following message: **** WARNING: the # of duplicates has exceeded the output limit of 1000 ****



nhFindElement

Displays information displays information about the Distributed eHealth System that polls and collects data for a specific element.

This command has the following format: nhFindElement [-h] [-rev] { -name elementName | -alias aliasName }

[-outFile pathname]




-name elementName

Specifies the element name of the element that you want to find. The search is case-sensitive. If you have an element named Boston-WAN-12, you must specify the name exactly.

You can specify an asterisk (*) or a percent sign (%) as a wildcard character (0n UNIX systems, if you use the asterisk as a wildcard, you must enclose the value of -name in double quotation marks). For example, if you specify the string Boston* or Boston%, the command locates all elements that have element names that begin with the characters Boston (but not boston or BOSTON).

-alias aliasName Specifies the alias of the element that you want to locate. You can specify an asterisk (*) or a percent sign (%) as a wildcard character.

-outFile pathname Sends the command output to the specified file name. If you do not specify an output file, the command outputs data to standard output (usually the command line).

eHealth administrators can run the command from any eHealth system in the cluster. If you use a wildcard in the -name or -alias argument, note that the command returns up to 100 elements that match the wildcard.

The command output displays the following information:

Element Name

Name of the element as defined in the poller configuration of the eHealth system.

Mach Name (Type)

Hostname and type (either console or server) of the eHealth system that polls the element.



Elem Type

Type of the element.

IP Address

IP address associated with the element.

Date Last Modified

Date that the element information was last changed.

If the command displays multiple elements, the elements appear in the following order:

1. Alpha-numeric order by name

2. For elements with the same name, in alpha-numeric order by member name

3. For elements with the same name and member name, by element type

If the command cannot find an element that matches the input search string, the command displays the message “No match.”

Examples:

■ The following command displays information about the element named OAK-SH:

nhFindElement -name OAK-SH

searching...


============ =============== ========= ========== ==================

OAK-SH eire(server) sysEdgeNtSystem 192.124.15.8 06-12-01 12:04:06

OAK-SH shaggy(server) sysEdgeNtSystem 192.124.15.8 06-12-01 12:04:06

ERRORS:

NONE



■ The following command displays up to 100 elements that match the name string OAK-SH- C. When you use a wildcard character in the search information, note that the command displays the number of matches for the total number of elements on each cluster system.

nhFindElement -name OAK-SH-C%

searching...


============ =============== ========= ========== ==================

OAK-SH-C: eire(server) sysEdgeUnixUserPartition 192.124.15.8 07-17-01

13:26:40

OAK-SH-C: shaggy(server) sysEdgeUnixUserPartition 192.124.15.8 07-17-01

14:40:33


23:01:11


13:05:37


23:00:51


13:05:36

OAK-SH-Cpu-1 eire(server) systemCpu 192.124.15.8 07-17-01 13:26:40

OAK-SH-Cpu-1 shaggy(server) systemCpu 192.124.15.8 07-17-01

14:40:33


23:01:11


13:05:37


23:00:51


13:05:36

solomon(console) had 4 matches out of 2099 total elements.

eire(server) had 2 matches out of 351 total elements.

baffin(server) had 0 matches out of 1687 total elements.

tigger(console) had 4 matches out of 2099 total elements.

shaggy(server) had 2 matches out of 61 total elements.

ERRORS:

NONE

nhGetFile

Retrieves a specified file from one or more eHealth systems in a Distributed eHealth cluster and saves it on the local system. The nhGetFile command can retrieve files only from the ehealth directory or its subdirectories of the specified eHealth systems.



This command has the following format: nhGetFile [-h] [-rev] { -host hostname | -cluster | -all }

-fromFile remoteFilePath -toFile localFilePath





- host hostname Retrieves the specified file name in -fromFile from the eHealth system named hostname. This argument is required unless you specify -cluster or - all.

- cluster Retrieves the specified file name in -fromFile from all systems in the cluster except the local system. This argument is required unless you specify -host or -all.

- all Retrieves the specified file name in -fromFile from all systems in the cluster. This argument is required unless you specify -host or - cluster.

- fromFile remoteFilePath

Specifies the full pathname of the file to retrieve. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

- toFile remoteFilePath

Specifies the full pathname of the destination file; this is the file that will be created (or overwritten) on the local system. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

- overwrite Specifies that the retrieved file should overwrite the local file specified in -toFile, if one exists.

- retryTime seconds





Example:

The following command copies the file messages.stats.log from all systems in the cluster to the local system and saves them in the NH_HOME/tmp directory: nhGetFile -all -fromFile '$(NH_HOME)/log/pollerStatus/messages.stats.log' \

-toFile '$(NH_HOME)/tmp/pollerMsgs.log.$(remoteHostname)'

nhJoinCluster

Adds the local eHealth system to an existing Distributed eHealth cluster and synchronizes the system with the other systems in the cluster. When a cluster does not yet exist (that is, you are adding the first eHealth system in the cluster), the command establishes internal tables used by the cluster.

When using this command, follow these guidelines:

■ Before you run this command, close the eHealth console, any secondary eHealth consoles, and any open Live Health applications. This ensures that eHealth updates the object IDs on the local system with the cluster information. You can restart these applications after you join the system to the cluster.

■ Ensure that the first system that you add to a cluster is a trusted member. If your first system is a non-trusted member, eHealth will not allow any other systems to join the cluster.

■ Always add one eHealth system at a time. Allow the nhJoinCluster command to finish before you run the command on another eHealth system that you want to add to the cluster.

■ Specify a password composed of one to eight characters. If you specify more than eight, the command displays an error.

■ When you add the first cluster member, add the password at the appropriate prompt; then specify the same cluster password for each subsequent member.

■ Do not remove a cluster member from one cluster and add it to another cluster without first wiping its database.

This command has the following format: nhJoinCluster [-h] [-rev]

{ -host hostname [-useStdDac yes | no] | - firstMember }

[-ipAddress address] [-contacts contact1,contact2,...]

[-trusted yes | no] [-id id] [-retryTime seconds]

[-timeout seconds]






- host hostname Specifies the hostname of a trusted system already in a cluster that you want to join. This argument is required unless you specify - firstMember.

- useStdDac For each additional eHealth system that you add to the cluster, specifies whether the cluster should use the Standard service profile defined on this eHealth system, or whether the eHealth system should use the Standard service profile settings of the -host system. The valid values are yes and no.

If you specify yes, the Standard service profile on the local system will be replicated to all of the other cluster members. That is, the Standard service profile will overwrite the Standard profiles on all of the other cluster members. If you specify no, the Standard service profile used by the -host system will overwrite the Standard profile on the local system.

You cannot specify this argument if you also specify the -firstMember argument.

- firstMember Specifies that this is the first member in the cluster. You cannot specify this argument if you specify -host. The first system you add to a cluster must be a trusted system.

- ipAddress address

Specifies the IP address of the system that you are adding to the cluster. The default is the IP address of the local system.

- contacts contact1, contact2, ...

Specifies the names or e-mail addresses of the contacts for the system that you are adding to the cluster.

- trusted yes | no

Specifies whether the system that you are adding is a trusted member of the cluster. The default is yes.

If you specify the -firstMember argument, do not specify a value of no for -trusted.

-id id Specifies a unique member ID number for the system that you are adding. If you do not specify an ID, the default is based on the IP address of the system that you are adding.

Note: Never change the member ID of a system.





- retryTime seconds



- timeout seconds

Specifies the time in seconds to wait for the command to finish. If the time expires before the command finishes, the command stops and returns an error.


Examples:

■ To add the first member of a cluster, log in to the eHealth system that you want to add to the cluster and run a command similar to the following:

nhJoinCluster -firstMember

This command adds the local system to the cluster as the first cluster member. The command uses the default values for the IP address (the local system’s IP address), trusted (yes), member name (hostname), and member ID (a unique string derived from the IP address).

■ To add the next member, log in to the that eHealth system and run a command similar to the following, where hostname is the hostname of the system that you added as the first member:

nhJoinCluster -host hostname - useStdDac yes

■ To add any subsequent members, log in to each system and run the same command. For the hostname value, you can specify the hostname of any trusted system already in the cluster.

nhListClusterMembers

Displays information about and the member table for one or more eHealth systems in a Distributed eHealth cluster. The member table contains information about each cluster system known to the local system. The command also displays information about the eHealth systems.

Note: You cannot list the member table of a system that has been removed from the cluster. You can see the removed system in another system’s member table (if you use the -includeRemoved argument).



nhListClusterMembers [-h] [-rev]


[-nameOnly] [- includeRemoved] [-retryTime seconds]

[-timeout seconds]




-host hostname Displays the member table on the specified eHealth system. This argument is required unless you specify -cluster or -all.

-cluster Displays the member table for all eHealth systems except the local system. This argument is required unless you specify -host or -all.

-all Lists the cluster members for all eHealth systems in a cluster including the local system. This argument is required unless you specify -host or -cluster. Note that the command will not display the member table of a removed system.

- nameOnly Lists only the names of the eHealth systems in the member table. If you do not specify this option, the command also shows the member ID, member type, trusted setting, IP address, and contact information for each cluster member.

- includeRemoved Includes the eHealth systems that have been removed from the member table. If you do not specify this argument, the command lists only the active members of the table.





Examples:

■ The following command lists the cluster members for each system in the cluster:

nhListClusterMembers -all


Querying cluster ..... OK



+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:


Contacts:


Contacts:


Contacts:

Cluster Members for host: shaggy


+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:


Contacts:


Contacts:


Contacts:

(output abbreviated for documentation readability)



■ The following command lists only the member names of the systems that are in the member table of the system named baffin:

nhListClusterMembers -host baffin -nameOnly




eire

shaggy

solomon

tigger

■ The following command lists the removed members of the member table for the system baffin:

nhListClusterMembers -host baffin -includeRemoved





+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+


Contacts: tester


Contacts:


Contacts:


Contacts:


Contacts:


Contacts:



nhModifyClusterMember

Modifies the information for an eHealth system in the member table of one or more systems in a Distributed eHealth cluster.

Note: You must run this command from a trusted cluster member to change the information for any other system in the cluster. You can run this command on an untrusted member to update its member table.


nhModifyClusterMember [-h] [-rev]


{ -id | -name memberName } [-ipAddress address]

[-contacts contact1,contact2,...] [-trusted yes | no]

[-newName newMemberName] [-retryTime seconds] [-timeout seconds]




-host hostname Modifies the member table on the specified cluster system named hostname. This argument is required unless you specify -cluster or -all.

-cluster Modifies the member tables on all eHealth systems except the local system. This argument is required unless you specify - host or -all.

-all Modifies the member tables on all eHealth systems in a cluster. This argument is required unless you specify - host or -cluster.

-id Specifies the unique ID for the cluster member’s information that you are modifying in the table. This argument is required unless you specify - name.

-name memberName Specifies the member name for the cluster member’s information that you are modifying in the table. This argument is required unless you specify -id.





-ipAddress address Specifies the new IP address for the member information that you are modifying. If you change the IP address of a cluster member, you should use the -all argument to change it in all cluster member tables.

-contacts contact1, contact2, ... Specifies the new contact names or e-mail addresses for the member information that you are modifying.

-trusted yes | no Specifies the new trusted setting for the member information that you are modifying.

-newName memberName Specifies the new member name for the member information that you are modifying. If you change the name of a cluster member, you should use the -all argument to change the name in all cluster member tables.






Examples:

■ The following example shows how the nhModifyClusterMember command changes the member table information on a cluster system.

Assume that you have a cluster system named baffin that has the following member table information: nhListClusterMembers -host baffin





+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server Yes 100.26.12.64

Contacts:


Contacts:


Contacts:


Contacts:

■ To modify the member table information on baffin, you can specify a command similar to the following: nhModifyClusterMember -host baffin -name eire -trusted no -contacts

[email protected]

Cluster Modify Member initiated:

Sending modifications . OK



■ If you display the member table information on baffin again, you would see the following changes (shown in bold): nhListClusterMembers -host baffin





+--------+--+-------------+--+---------+--+-----+--+-------------+


Contacts:

739249216 eire server No 100.26.12.64

Contacts: [email protected]


Contacts:


Contacts:


Contacts:

nhPutFile

Sends a specified file to one or more remote eHealth systems in a Distributed eHealth cluster.

Note: You can put files only in the ehealth directory or its subdirectories. You cannot run this command from a non-trusted system in the cluster to affect other systems in the cluster.


nhPutFile [-h] [-rev] [-v] { -host hostname | -cluster | -all }

-fromFile localFilePath -toFile remoteFilePath










-host hostname Sends the specified file in -fromFile to the eHealth system named hostname. This argument is required unless you specify - cluster or -all.

-cluster Sends the specified file in -fromFile to all systems in the cluster except the local system. This argument is required unless you specify -host or - all.

-all Sends the specified file in -fromFile to all systems in the cluster. This argument is required unless you specify -host or -cluster.

-fromFile Specifies the full pathame of the local file to send. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

-toFile Specifies the full pathname of the destination file; this is the file that will be created (or overwritten) on each remote system. The pathname must be located within the eHealth installation directory on the remote system. You must enclose the pathname in single quotes (' ') when you use substitute values such as $(NH_HOME), for example.

-overwrite Specifies that the sent file should overwrite the local file specified in -toFile, if one exists.



nhRemoveClusterMember

Removes the specified eHealth system as an active member of a Distributed eHealth cluster. The command updates the member table on one or more eHealth systems in the cluster to show that the specified system has been removed. The removal process does not update the member table of the cluster member that you are removing.


When you remove a system from a member table, the system can still function as a standalone system. However, it cannot replicate its information to or synchronize its information with the cluster members from which it has been removed. You can restore a removed system to return it to the cluster membership and make it an active member of the cluster again.

When you remove a system, eHealth does not actually delete the member information permanently. It soft deletes the information, which means that the information remains in the table but it is updated to show that the system has been removed. You can restore the information to the member tables using the nhRestoreClusterMember command.


nhRemoveClusterMember [-h] [-rev]



[-timeout seconds]



-rev Displays the eHealth software revision information

-host hostname Removes the specified system from the member table of the eHealth system specified by -host. This argument is required unless you specify - cluster or -all.

-cluster Removes the specified system from the member tables of all eHealth systems in the cluster except the local system (the system on which you run the command). This argument is required unless you specify -host or -all.

-all Removes the specified system from the member tables of all eHealth systems in the cluster. This argument is required unless you specify -host or -cluster.

-id id Specifies the unique member ID for the system that you want to remove from the cluster. This argument is required unless you specify -name.

-name memberName Specifies the member name of the system that you want to remove from the cluster. This argument is required unless you specify -id.









Examples:

■ The following command removes a cluster system named eire from the member table of the system baffin: nhRemoveClusterMember -host baffin -name eire


Sending remove messages . OK

■ The following command removes the system named eire from the member table of all systems in the cluster (including its own member table): nhRemoveClusterMember -all -name eire


Sending remove messages ...... OK

nhReplicate

Updates the other members of a Distributed eHealth cluster with the specified information (objects) on the local eHealth cluster member.

When you run this command from a Distributed eHealth System, the command replicates only the element information that has changed since the last replication. Use the -allElements argument to force the replication of all elements.



nhReplicate [- h] [-rev] { -host hostname | -cluster }

[ -objTypeAll | -objType objType[,objType,...] | - objTypeList]

[ -allObjects | -name objName ]

[-allElements] [-retryTime seconds]




-host hostname Updates only the specified eHealth system with the local system’s information. This argument is required unless you specify -cluster.

-cluster Updates all other eHealth systems in the cluster with the local system’s information. This argument is required unless you specify -host.

-objTypeAll Replicates the information for all object types. This is the default.

-objType objType[,objType,...] Replicates the information for the specified object types. You must enclose the objType values in quotes (" "), separated by a comma. You can select one or more of the following object type values:

■ element

■ group

■ groupSection

■ groupList


■ dataAnalysisRec

■ serviceProfile

-objTypeList Lists the supported object types, but does process the command. Use this argument to list the valid values for the -objType argument.

-allObjects Replicates all objects of type object type. This is the default.

-name objName Replicates the object named objName.





-allElements Replicates all elements, not just those that changed since the last time that the elements were replicated. If you do not specify this argument, the command replicates only those elements that have changed since the last replication.



Example:

The following command replicates group information from the local system to all other systems in the cluster: nhReplicate -cluster -objType group

Cluster Replicate initiated:

Replicating objects of type group ..... OK

nhRestoreClusterMember

Restores the local eHealth system as an active member of a Distributed eHealth cluster. You can restore a system that was once in the cluster but that had been subsequently removed using nhRemoveClusterMember. The command updates the member table information on one or more systems in the cluster.

Note: When you restore a cluster member, use the -all argument to restore it to all cluster members. If you restore it to only some of the cluster members, you could cause your cluster to become out-of-sync.



The nhRestoreClusterMember command has the following syntax: nhRestoreClusterMember [-h] [-rev]

{ -host hostname | -cluster | -all }


[-timeout seconds]




- host hostname Updates the member table of the specified eHealth system to restore the local system to the cluster. This argument is required unless you specify -cluster or -all.

- cluster Updates the member table of all eHealth systems except the local system to restore the local system to the cluster. This argument is required unless you specify -host or -all.

- all Updates the member table of all eHealth systems including the local system to restore the local system to the cluster. This argument is required unless you specify -host or -cluster.

- id id Specifies the unique member ID of the system that you are restoring. This argument is required unless you specify -name.

- name memberName Specifies the member name of the system that you are restoring. This argument is required unless you specify -id.









Examples:

■ Assume that you have a system named baffin that has the following member table: nhListClusterMembers -host baffin -includeRemoved





+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+


Contacts: tester


Contacts:


Contacts:


Contacts:


Contacts:


Contacts:


■ To restore the system named sparky to the cluster (and to update the member table on baffin), use the following command:

nhRestoreClusterMember -host baffin -name sparky

The next time you list the member table on baffin, you will see the following changes (shown in bold): nhListClusterMembers -host baffin -includeRemoved





+--------+--+-------------+--+---------+--+-----+--+-------------+--+-----+


Contacts: tester


Contacts:

739249214 sparky server Yes 100.26.12.62 No

Contacts:


Contacts:


Contacts:


Contacts:

■ To restore the system named sparky in the member tables of all systems in the cluster, use the following command:

nhRestoreClusterMember -all -name sparky

nhRunCommand

Executes a specified command on one or more eHealth systems in a Distributed eHealth cluster. You cannot run this command from a non-trusted system in the cluster to affect other systems in the cluster. nhRunCommand collects all messages displayed in standard output (stdout) and standard error (stderr) on each system and displays them on the local system.



This command has the following format: nhRunCommand [-h] [-rev] [-v] { -host hostname | -cluster | -all }

-cmd 'cmdString' [-attachFile1 pathname]

[-returnFile1 pathname] ... [-retryTime seconds]

[-timeout seconds]





-host hostname Runs the command specified in -cmd on the eHealth system specified by hostname. This argument is required unless you specify -cluster or -all.

-cluster Runs the command specified in -cmd on all eHealth systems except the local system (the system on which you run the command). This argument is required unless you specify -host or -all.

-all Runs the command specified in -cmd on all eHealth systems in the cluster. This argument is required unless you specify -host or - cluster.

-cmd cmdString Specifies the full pathname and arguments of the command that you want to run. You must enclose the command string in single quotation characters (' '). The maximum length of the command string depends on your operating system restrictions.



...


Specifies the full pathname of a file to attach to the command if the command operates on an input filename. You can specify a maximum of five files to attach.



...


Specifies the full pathname of a file that you want the command to return if the command returns a file. You can specify a maximum of five return files.






If you specify a value, it should be less than the value of the NH_REMOTE_CMD_TIMEOUT. The default is 0, which indicates that the local system will not retry the command.



Examples:

■ The following command runs the nhShowRev command on each cluster member to display the eHealth software revision information for each eHealth system in the cluster and returns the output to the local system:

nhRunCommand -all -cmd 'nhShowRev'

■ The command displays the following on the local system, which is the standard error and standard output from each system in the cluster. The system that replies first appears first in the output, until the last system replies. STDERR: solomon


STDERR: eire


STDERR: baffin


STDERR: sparky



nhScrubFsa

Removes temporary files in the File Staging Area (FSA) and soft-deleted objects that still have entries in the database on Distributed eHealth Systems, including:

■ Objects that are older than the number of hours specified by the NH_DB_DELETED_OBJECTS_TIME2KEEP environment variable, or older than seven days if that variable is not set.

■ Temporary files in the FSA that are older than the number of hours specified by the NH_FSA_SCRUB_TTL environment variable, or older than four hours if that variable is not set.

Note: When you delete an object such as a group, service profile, or group list, the deletion process immediately removes the object from your menus, subject selections, and other visible interface areas. However, a record of the object remains in the eHealth database until the scheduled FSA Scrubber job runs. These objects are called soft-deleted objects.

This command has the following format: nhScrubFsa [-h] [-rev] [-d database] [-u user]

[-fsaTtl FSA_time_to_live]

[-deletedObjectHours hours]




-d database Specifies the name of the database to clean. By default, nhScrubFsa operates on the database specified by the ORACLE_SID environment variable.

-u user Specifies a user who is authorized to access the database. The default is the value of the NH_USER environment variable.

-fsaTtl FSA_time_to_live Deletes temporary files in the file staging area and the corresponding entries in the database table NH_FILE_STAGING_AREA that are older than the number of hours specified. The default is 4. (The file staging area is ehealth/fileStagingArea, where ehealth represents the eHealth installation directory.)

You can use the NH_FSA_SCRUB_TTL environment variable to override this value.





- deletedObjectHours hours

Deletes from the database all objects that were soft- deleted before the number of hours specified. The default is 168 (one week).

You can use the NH_DB_DELETED_OBJECTS_TIME2KEEP environment variable to override this value.

Examples:

■ To delete all temporary FSA files and all soft-deleted objects from the database, enter the following:

nhScrubFsa -fsaTtl 0 -deleteObjectHours 0

■ To connect to the eHealth database as user green, delete temporary FSA files that are older than three hours, and delete soft-deleted objects that are older than seven hours, enter the following:

nhScrubFsa -d EHEALTH -u green -fsaTtl 3

-deletedObjectHours 7

nhSetClusterMode

Changes the administration mode of the local cluster system. You can use this command to place an eHealth system in upgrade (or “quiet”) mode, which prevents any administrative changes to the database, such as the discovery of new elements, element modifications or deletions, or group administration.

Typically, you place the system in upgrade mode when you are upgrading the software on a cluster member, or when you need to troubleshoot problems on the system. This command also restores the system to full, administrative operations.

Important! You should only place an eHealth system in upgrade mode when Technical Support or a documented procedure instructs you to do so.

This command has the following format: nhSetClusterMode [-h] [-rev] {-upgrade | -fullAdmin}







- upgrade Places the eHealth system in upgrade mode, disabling administrative changes and updates to the database. This argument is required unless you specify -fullAdmin. If eHealth administrators perform a function that would normally update the database, eHealth displays an error message and does not save the changes.

- fullAdmin Places the eHealth system n full, administrative mode, enabling administrative changes and updates to the database. This argument is required unless you specify -upgrade.

nhSetClusterPasswd

Specifies the administration password that controls access and communications to the systems of a Distributed eHealth cluster.

The nhSetClusterPasswd command specifies the administration password that controls access and communications to the cluster systems. The password can be up to eight characters in length.

Note: After you change the cluster password using this command, restart the eHealth server on each cluster member to ensure that the new password takes effect. You cannot run this command on an untrusted member of the cluster.

This command has the following format: nhSetClusterPasswd [-h] [-rev] [-retryTime seconds]

[-timeout seconds]











Example:

The following command changes the cluster password for all systems in the cluster: nhSetClusterPasswd

Enter Cluster Password: oldPasswd

Enter New Cluster Password: newPasswd

Re-Enter New Cluster Password: newPasswd

Set cluster password initiated:

Establishing connections ... OK

Changing passwords ... OK

The command does not display the password characters that you type. The command hides the characters as a security precaution. As a security precaution, the cluster password is stored and transmitted in encrypted format.

nhSynchronize

Synchronizes one or more eHealth systems in a Distributed eHealth cluster. It retrieves object information from the other systems and updates the local eHealth cluster system.


Note: The nhSynchronize command synchronizes one or more eHealth systems in the cluster. It retrieves object information from the other systems and updates the local eHealth cluster system. (The Distributed eHealth Consoles run this command as a scheduled job to obtain the latest object information from the cluster systems.)

When you run this command from a Distributed eHealth Console, the command updates only the element information that has changed since the last synchronization (as a result of either the scheduled Synchronize job or the nhSynchronize command). Use the - allElements argument to force the synchronization of all elements.


The command has the following syntax:

nhSynchronize [-h] [-rev] { -host hostname | -cluster }

{ -objTypeAll | -objType objType[,objType,...] | -objTypeList }

[ -allObjects | -name objName | -id uid ][-allElements]

[-retryTime seconds]




-host hostname Updates the local system with the replicated information from the specified eHealth system. This argument is required unless you specify -cluster.

-cluster Updates the local system with the replicated information from all other eHealth systems in the cluster. This argument is required unless you specify -host.

-objTypeAll Synchronizes the information for all object types. This is the default.





-objType objType[,objType,...]

Synchronizes the information for the specified object types. You must enclose the objType values in quotes (" "), separated by a comma. You can select one or more of the following object type values:

■ element

■ group

■ groupSection

■ groupList


■ dataAnalysisRec

■ serviceProfile

-objTypeList Lists the supported object types, but does process the command. Use this argument to list the valid objType values for the -objType argument.

-allObjects Synchronizes all objects of the specified object type. This is the default.

-name objName Synchronizes the object that has the name objName.

-id uid Synchronizes the object with the specified unique ID (uid). The uid is a combination of the member ID of the system on which the object was created and the database ID for the object. It has a format similar to the following:

739249213@1000001

-allElements Synchronizes all elements, not just those that changed since the last time that the elements were synchronized. If you do not specify this argument, the command synchronizes only those elements that have changed since the last synchronization.




Examples:

■ The following command updates the local system with the replicated information from the system named eire:

nhSynchronize -host eire


Synchronizing objects of type group .. OK

Synchronizing objects of type groupList .. OK

Synchronizing objects of type groupListContents .. OK

Synchronizing objects of type serviceProfile .. OK

Synchronizing objects of type dataAnalysisRec OK

In the example command, note that the status line for the dataAnalysisRec objects does not have any periods(.). When the local system and the -host system are both Distributed eHealth Systems, they do not synchronize data analysis records. Thus this step is omitted (which the command indicates by not displaying periods at the end of the status line for that object type).

■ The following command synchronizes all systems in the cluster except the local system:

nhSynchronize -cluster


Synchronizing objects of type group ..... OK

Synchronizing objects of type groupList ..... OK

Synchronizing objects of type groupListContents ..... OK

Synchronizing objects of type dataAnalysisRec ..... OK

nhUpdateClusterTable

Updates the member table information on the local system with the information from one or more other systems in a Distributed eHealth cluster. The member table is an internal table that provides information about all eHealth systems in the cluster.

You typically use this command after you restore an eHealth system to the cluster, or after you load a database on an eHealth system in the cluster, to ensure that the member table on the system is current with the cluster.


nhUpdateClusterTable [-h] [-rev] { -host hostname | -cluster }

[-retryTime seconds] [-timeout seconds]








-host hostname Updates the member table on the local system with the member table information from the specified eHealth system. This argument is required unless you specify -cluster.

-cluster Updates the member table on the local system with the member table information on all of the other eHealth systems in the cluster. This argument is required unless you specify - host.





Example:

The following command updates the member table on the local system with the member table on the system named eire: nhUpdateClusterTable -host eire

Cluster Fix Machine Table initiated:

Querying cluster .. OK

nhUpdateDatabaseIds

In a Distributed eHealth cluster, updates the eHealth database ID table on the local system with the database ID table information on one or more cluster systems. Use this command after you load a database in order to ensure that the local system is up-to-date with its next available database ID.

Discover, Poller Elements and Groups Commands

Discover, Poller Elements and Groups Commands The discover, poller elements, and groups commands are as follows:


■ nhElementStatus

■ nhListElements

■ nhListElementLicenses

■ nhGroups

■ nhGroupList


nhDeleteElements

Deletes elements from the database and poller configuration. You can specify the names of elements to delete using standard input (stdin) or the -inFile argument. You can also redirect the output of the nhListElements command as input to the nhDeleteElements command.

Important! Use of this command will result in loss of all data for deleted elements.


nhDeleteElements [-h] [-rev] [-inFile filename] [-verify]




- inFile filename Specifies the name of the file that contains the list of element names to delete.

If you do not specify an input file, eHealth reads input from standard input. You must specify the element names exactly, with one name per line.

- verify Processes the input and produces a DCI file, but does not remove the elements from the eHealth database.



Examples:

To delete elements that are specified in file1, enter the following:

nhDeleteElements -inFile file1

To locate all router elements that have not added data to the database for the past six hours, and then delete them, use the following command combination:

nhListElements -elemType router -noDbDataFor 6 | nhDeleteElements

nhElementStatus

Shows the polling status of each element as of the last poll and displays this information on the screen. It provides a snapshot of the state of each element.

The nhElementStatus command can help you to identify elements that have not been polled in the last day, and elements that have polling errors. eHealth must poll the elements at least twice before the command can determine the element status.

This command has the following format: nhElementStatus [-h] [-rev] [-v] [-showAll] [-neverPolled] [-noDataFor minutes]

[-showErrors] [-noDbDataFor minutes] [-outfile filename]

[-host hostname | -cluster | -all]

If you do not specify -host, -cluster, or -all, the nhElementStatus command displays the status of elements on the local system. If you use one of these distributed arguments, the command shows the element status of one or all systems in the cluster, displaying the output on the local system.




- v[erbose] Prints verbose details.

- showAll Displays all elements and their status. This is the default action.

- neverPolled Displays elements that have never been polled.

- noDataFor n Displays elements that have not posted data during polling for the specified number (n) of minutes.





- showErrors Displays elements that have been receiving data but errors have prevented the data from being saved in the database.

- noDbDataFor n Displays elements that have not posted data to the database during polling for the specified number (n) of minutes.

- retired (Optional) Shows only those elements that are retired. Must be specified with –noDataFor <minutes>.

- outfile f Sends output to the specified file (f).

- host hostname Specifies the name of the Distributed eHealth System for which you want to display element status.

-names Shows only element names.

- cluster Displays element status for all eHealth systems in a Distributed eHealth cluster except the local system.

- all Displays element status for all eHealth systems in a Distributed eHealth cluster.

By default, the nhElementStatus command produces a log file that lists the following:

■ All elements on the local system that are polling correctly

■ All elements on the local system that have never been polled

■ All elements on the local system that received polling errors

Note: Some types of elements do not show up in this tool. For example, elements that do not poll data, such as response endpoints, will not be listed. Also, aggregateOnly elements or interface elements that have been operationally down since eHealth started polling them are excluded.

The following table describes the log file fields:

Field Description

Element Name Specifies the element name, as defined in the poller configuration.



Field Description

Status Specifies the state of the element. Status values include:

■ Polling correctly

■ Is off

■ Not polled in n minutes

■ Never polled

■ Polling but receiving errors

Last Save Time Specifies the last time that the poller saved data for the element in the database (on the eHealth system).

Last Poll Time Specifies the last time that the poller attempted to poll the element (on the eHealth system).

Data Time Specifies the time at which the most recent data was received for the element (on the eHealth system). Some of the fields in the time stamp may be blank if the system does not have any values for them.

MTF Name Specifies the name of the MTF used to obtain data from the element.

Examples:

■ You can specify the -noDataFor argument to list elements for which the poller has not received data for a specified number of minutes. For example, to list elements that have not returned data during the past hour, enter the following:

nhElementStatus -noDataFor 60

■ You can specify the -neverPolled argument to list elements that have never been polled. You can specify the -showErrors argument to list elements that have polling errors. You can also specify a combination of arguments.

If none of the elements match the report criteria, the report displays the following:

Nothing to report.


nhGroup

Organizes elements into groups and performs functions on existing groups.

Note: In Distributed eHealth, to differentiate between two identically-named groups or group lists on different Distributed eHealth systems, specify the cluster member ID with the group name using the following format: groupName@memberID. To determine the member ID, run the nhListClusterMembers command with the -host hostname argument. This cluster syntax is valid for all nhGroup arguments except -create.


nhGroup [ -rev ] [ -h ] [ -verify ]

{ -create { -groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-delete {-groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-list [ -hasMember ] {-groups "groupName,groupName,groupName" | - groupFile

filename | -groupStdin } |

-modify {-groups "groupName,groupName,groupName" | - groupFile filename | -

groupStdin } |

-insertMembers { -groups "groupName,groupName,groupName" | - groupFile filename |

-groupStdin }

{ { -elements "elementName,elementName,elementName" | -elementFile

elementFilename |

-elementStdin } |

[ -fromGroups "groupName,groupName,groupName" ] }

-removeMembers { -groups "groupName,groupName,groupName" | - groupFile



| - elementStdin } }




-create Creates new groups.





-delete Soft deletes groups from the eHealth database.

-list Lists all groups that currently exist within the eHealth database.

-modify Changes attributes of a group.


Specifies the names of multiple groups to create. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups to act upon. The file must have the following format:

name

name

...

name

-groupStdin Specifies the list of groups to act upon via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-insertMembers Adds specified elements to existing groups. If the group does not exist, eHealth creates it.

-removeMembers Removes specified elements from groups.

-hasMember Lists those groups that include the specified element.

-verify Does not commit changes to be executed by any of the following arguments: - create, -delete, -modify, -insertMembers, or - removeMembers.


nhGroupList

Organizes groups into groupLists and perform functions on existing groupLists.

Note: In Distributed eHealth, to differentiate between two similarly named group lists on different Distributed eHealth systems, specify the cluster member ID with the group list name using the following format: grouplistName@memberID. To determine the member ID, run the nhListClusterMembers command with the -host hostname argument. This cluster syntax is valid for all nhGroupList arguments except -create.


nhGroupList [ -rev ] [ -h ] [ -verify ]

{ -create { -groupLists "groupListName,groupListName,groupListName" | -


-delete { -groupLists "groupListName,groupListName,groupListName" | -


-list |

-modify [-showDciFields] { -groupLists

"groupListName,grouplistName,groupListName" | -groupListFile groupListFilename |

- groupListStdin -fieldName fieldName -value value } |

-insertMembers { -groupLists "groupListName,groupListName,groupListName" | -

groupListFile groupFilename | - groupListStdin }


groupStdin } |

-removeMembers { -groupLists "groupListName,groupListName,groupListName" | -

grouplistFile groupListFilename | - groupListStdin } { -groups

"groupName,groupName,groupName" | - groupFile groupFilename | -groupStdin } }




-create Creates new groupLists.

-delete Deletes groupLists from the eHealth database.

-list Lists all groupLists that currently exist within the eHealth database.

-modify Changes attributes of a groupList.






Specifies the names of multiple groupLists that you want to act upon. If you specify a single groupList name, do not enclose it in quotation marks. If you specify multiple group list names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.



name

name

...

name

-groupListStdin Specifies the list of groupLists that you want to act upon using standard input. Use ^D to exit. The specification must have the following format:

name

name

...


Specifies the names of multiple groups that you want to add to or remove from a groupList. If you specify a single group name, do not enclose it in quotation marks. If you specify multiple group names, separate each one with a comma, and enclose the names in double quotation marks. Do not insert spaces.


Specifies the name of the file that contains the list of groups that you want to add or remove. The file must have the following format:

name

name

...

name




-groupStdin Specifies the list of groups that you want to add or remove via standard input. Use ^D to exit. The specification must have the following format:

name

name

...

-insertMembers Adds specified groups to an existing groupList. If the groupList does not exist, eHealth creates it.

-removeMembers Removes specified groups from a groupList.

-verify Does not commit changes to be executed by the -create, -modify, -delete, -removeMembers, or -insertMembers arguments.

nhListElements

Displays a simple list of eHealth element names using selected criteria. You can use arguments to filter the list of elements. You can also redirect the output of this command as input to other commands to modify your poller configuration file, as described in the following command descriptions:



■ nhGroup


The nhListElements command uses the following syntax: nhListElements [-h] [-rev] [-showTypes] [-showDciFields]

nhListElements [-elements] [-outFile filename]

nhListElements -rebooted [-outFile filename]

nhListElements –rebootedNames [-outFile filename]

nhListElements -where "whereClause" [-outFile filename]

nhListElements -elemType type [-outFile filename]

nhListElements -noDbDataFor hours [-outFile filename]

nhListElements -inGroup group [-outFile filename] [-includeChildren]

nhListElements -notInAnyGroup [-outFile filename]







- showTypes Displays a list of valid element types to use with the -elemType argument.

- showDciFields Displays the DCI attribute field names that you can use as parameters in the -where argument.

Note: The field names for the -showDciFields argument may not match the names in the standardHeader.dci file. Use this argument to determine the valid parameter names.

-elements Lists element names. This is the default.

-outFile filename Specifies the name of the file to which eHealth should send output. If you do not specify a file, eHealth sends output to standard output.

-rebooted Produces a list of IP addresses and community strings for elements that have recently experienced agent reboots. (The nhListElements command searches the messages.stats.log file in ehealth/log/pollerStatus to obtain the list of elements that have recently rebooted.) You can use the resulting file as a discovery seed file.

-rebootedNames Produces a list of element names for elements that have recently experienced agent reboots. (The nhListElements command searches the messages.stats.log file in ehealth/log/pollerStatus to obtain the list of elements that have recently rebooted.) You can use the resulting file as a discovery seed file.




-where "whereClause"

Filters the element list to include only those elements that match the criteria specified in the whereClause. Each whereClause consists of a field, relational operator, and pattern or values to match. You must enclose a whereClause in quotation marks (" "). Each whereClause must be separated by a space. If you specify multiple whereClause arguments, eHealth combines them by processing them cumulatively.

Possible fields for this argument include the following:

■ Any DCI field-Use any DCI field name from the output of the nhListElements - showDciFields command. Commonly used fields are name and alias.

■ speed | speedIn | speedOut-Use any of these fields to match the speed assigned to the element in the poller configuration, expressed in bits per second (bps).

■ altLatency-Use with the = operator and the values yes or no to filter elements based on alternate latency.

■ assocName name-assocName is a variable for one of the following: parent, respSrc, respDst, device, processSet. For example, to select elements based on parent name, specify parentName. Possible relational operators include the following: matches: =, !=, >, <, >=, <=. Use the matches operator for string comparisons, not numeric comparisons. You can use an asterisk (*) with the matches operator to match any string of characters, or a question mark (?) to match a single character.

- noDbDataFor hours Lists only those elements for which eHealth has not collected data or added it to the database for the number of hours specified, and for which there is not any alarm data. You must specify a number greater than zero.

This command allows you to produce a list of elements that eHealth is not currently polling, or elements that it is currently polling but that have poll errors. You cannot use this argument in combination with any other nhListElements argument except for -outfile. You cannot use this argument on the central site to return data in a remote polling environment. You must run it on the remote systems.




- elemType type Filters the element list so that only elements of a specific type are included in the output. This argument specifies the type of target elements. To obtain the valid list of types, use the -showTypes argument. You can specify the -where argument in combination with this argument to filter the list to show elements of a specific type and a specific name, alias, or speed. However, you cannot use this argument with a -where clause that uses an association name as a filter.

-inGroup group Lists the elements that belong to a specific group with a specified name. Specifies the exact name of the group. This argument does not support wildcards. You must specify the exact name of the group.

- includeChildren Includes children of grouped elements in the result list when specified with the -inGroup argument.

- notInAnyGroup Filters the element list to include only ungrouped elements. If you specify this argument, you cannot specify the -inGroup attribute.

Examples:

■ To list all elements and store the list in a file, enter the following:

nhListElements -outFile elements.txt

■ To list the DCI attribute field names that you can use in the whereClause of a -where argument, enter the following:

nhListElements -showDciFields

■ To store a list of all technology types in a file, enter the following:

nhListElements -showTypes -outFile types.txt

■ To list all elements with names that begin with Acme, enter the following:

nhListElements -where "name matches Acme*"

■ To list all elements that have not had any new data collected for the past four hours, enter the following:

nhListElements -noDbDataFor 4

■ To find all elements in the remote access server (RAS) group Acme whose name begins with “dialup-region-1” and whose line speed is less than or equal to 56 Kbs, enter the following:

nhListElements -inGroup Acme \

-where "name matches dialup-region-1*" \

-where "speed <= 56000"
















Examples:







nhModifyElements

Changes selected attributes for one or more elements maintained by the eHealth software. You can use any of the following methods to specify elements:

■ Use standard input (stdin).

■ Use the -inFile argument to give this command a file of valid element names.

■ Redirect the output of the nhListElements command as input to this command.

Important! Improper use of this command can result in failure to poll or incorrect report data. Use this command only if you are an advanced user and are familiar with its effects.


nhModifyElements [-h] [-rev] -fieldName fieldName

[-value value] [-inFile fileName] [-verify]

Argument Definition



- fieldName fieldName

(Required) Specifies a DCI element field to update. You can update only one field at a time. For a complete list of the valid DCI element fieldName values, see the "Element Section Definition Fields" table in of the eHealth Data Integration Guide.

Note: Fields representing database handles (objId, dbId, machineId) and deprecated fields are not supported.

-value value (Optional) Modifies a property for a set of elements without requiring you to generate an input file.

If you specify “- fieldName nmsState -value Retired” to retire a parent element, the nhModifyElements command also retires all related child elements that do not consume their own polling licenses (store detailed data).

Note: For information about special cases, see the Data Integration Guide.




Argument Definition

-inFile fileName (Optional) Specifies the name of the file that contains the list of modifications. Use -inFile to specify unique values for each element, not the same value for all elements. Or, create a list and use the -value argument to specify the same value for all elements in the list. If you do not specify an input file, eHealth reads input from standard input. Input has the following format:

name[,value]

name[,value]

...

name[,value]

If you do not use the -value argument, you must specify a value for each name.

-verify (Optional) Processes the input and produces a DCI file but does not commit the changes to the eHealth database.

Examples:

■ Enter the following command to change the poll rate of all elements listed in the file subnet5Routers to normal:

nhModifyElements -fieldName pollRate \

-value normal -inFile subnet5Routers

■ Enter the following command to find all elements that have not collected data for four hours and turn off polling for them:

nhListElements -noDbDataFor 4 | \

nhModifyElements -fieldName poll -value no

■ Enter the following command to list all elements that have a speed of 9600 bps and change them to a speed of 19200 bps:

nhListElements -where "speed = 9600" | \

nhModifyElements -fieldName speed -value 19200

■ Enter the following command to retire all elements listed in the file obsoleteElements:

nhModifyElements -fieldName nmsState \

-value Retired -inFile obsoleteElements

Installation Commands

Installation Commands The installation commands are as follows:

■ nhUpgradeCluster

■ nhUpgradeOracleDb

nhUpgradeCluster

Lets you manage eHealth release upgrades across a cluster.

This command has the following format: nhUpgradeCluster [-h]

[-activate | -validate | -rollback] [-local]



-activate Activates a new release of eHealth across a cluster and deactivates the previous release.

-validate Confirms that eHealth has started across a cluster.

-rollback Reverts the cluster to the previous eHealth version. Use this argument if errors occurred during activation.

Note: After you run the nhUpgradeCluster command with the -rollback argument, the cluster is in quiet mode. To return the cluster to full administration mode, run the nhSetClusterMode command with the -fullAdmin argument.

-local Runs the nhUpgradeCluster command and the selected argument on the local system rather than across a cluster. For example, to ensure that eHealth has started on the local system, specify -validate and -local.

By default (if you omit -local), the command runs on all eHealth systems in the cluster.

nhUpgradeOracleDb

Lets you upgrade the eHealth database from Oracle8i to Oracle9i on a standalone system or across a Distributed eHealth cluster.

This command has the following format: nhUpgradeOracleDb [-h] [-rev]


Integration Modules Commands




Integration Modules Commands The Integration Modules commands are as follows:

■ nhAlcatelNmInstall

■ nhAnmGetCfg

■ nhAnmQcnVerify

■ nhCwmGetCfg

■ nhGetIscRouterCfg

■ nhGetIscSlaConfig

■ nhGetVpnscRouterConfig

■ nhGetVpnscSlaConfig

■ nhLucentGetCfg

■ nhLucentMigrateElements

■ nhLucentSetup

■ nhNetflowSetup

■ nhPresideGetCfg

■ nhPresideInstall

■ nhRemotePollerSetup

■ nhShowImRev

■ nhSpectrumSetup

■ nhSvInstall

■ nhSvGetCfg

■ nhSvDiagnose

■ nhVpnscSetup



nhAlcatelNmInstall

Installs and sets up eHealth Integration for Alcatel, which helps you collect data from your Alcatel 5620 Network Manager system (NMS) and generate eHealth reports.

nhAnmGetCfg

Extracts configuration information for Alcatel elements from the Alcatel 5620 NMS.

nhAnmQcnVerify

Tests the availability of a QCnetwork server process running on a remote Alcatel 5620 NMS.

nhCwmGetCfg

Imports configuration information from all Cisco WAN Manager (CWM) Network Management System (NMS) hosts configured for the integration module; imports the data, records it, and commits it to the eHealth database.


nhCwmGetCfg [-h] [-rev]

[-verify] [-noCommit] [-host hostName] [-sf]




-verify (Optional) Imports data, but does not commit or record that the data was imported.

-noCommit (Optional) Imports data, records it was imported, but does not commit it to the eHealth database.

-host hostName (Optional) Imports data only from the specified host.

-sf (Optional) Skips the FTP step. Data is taken from the file: $NH_HOME/modules/cwm/hostName.import.



nhGetIscRouterCfg

Extracts the configuration information for routers and router interfaces in your VPN. You can run variants of this command to create groups and group lists for this information.

nhGetIscSlaConfig

Extracts the configuration information for SA Agents. You can run variants of this command to create groups and group lists for this information.

nhGetVpnscRouterConfig

Creates a file containing a list of VPN Solutions Center router elements. You can use the resulting file as input to the nhConfig command to import these elements into your eHealth poller configuration.

nhGetVpnscSlaConfig

Creates a file containing a list of VPN Solutions Center service level agreement (SLA) elements. You can use the resulting file as input to the nhConfig command to import these elements into your eHealth poller configuration as response endpoints and paths.

nhLucentGetCfg

Extracts configuration information from the Lucent NavisCore network management system (NMS) and converts it to DCI. This command can be used to import the configuration information into eHealth.

nhLucentMigrateElements

Converts Cascade/Ascend elements into Lucent elements. This allows customers to upgrade from pre-5.6 versions of eHealth that used the old integration module to eHealth Integration for Lucent.

nhLucentSetup

Installs and sets up eHealth Integration for Lucent.



nhNetflowSetup

Configures and installs eHealth Integration for Cisco Netflow. To use the nhNetflowSetup command, enter nhNetflowSetup at the command line and respond to each prompt.

For more information about how to use the setup script, see the eHealth Traffic Accountant and Netflow Administration Guide.

nhPresideGetCfg

Extracts configuration information from the Nortel Preside Multiservice Data Manager for use with the eHealth Integration for Nortel Preside module.

nhPresideInstall

Installs and sets up the eHealth Integration for Nortel module for use with Nortel Preside Multiservice Data Manager.

nhRemotePollerSetup

Configures local and remote systems for remote polling. Use this command when you run eHealth in a remote polling environment.

To use the nhRemotePollerSetup command, enter nhRemotePollerSetup at the command line, and respond to each prompt.

nhShowImRev













Examples:


nhShowImRev -all


5.3 H0-00

Cisco Netflow:

v4.0, v5.0

Cisco VPNSC:

2.1.x, 2.2.x

Cisco WAN Manager:

11.0, 12.0

HP OpenView:

6.4


08,00.03.xx/04.00.02.xx, 08.01.00.02

Micromuse Netcool:

3.5, 3.6


14.2

Aprisma SPECTRUM:

6.0 Nortel SCS: 3.0




nhSpectrumSetup

The nhSpectrumSetup command configures the eHealth SPECTRUM Integration, which allows you to import configuration information about the network devices that you manage with SPECTRUM.

This command does not have any arguments. To use it, enter nhSpectrumSetup at the command line, and specify the requested parameters.

Note: The nhSpectrumSetup command may take a few seconds to run if you enter the arguments on the command line, depending on the computer you are using.

When the discovery request is sent to the eHealth server from the OneClick server, the community string from the configured attribute is used. If you elected to use the CommunityNameForSNMPSets attribute, but some of the devices in the discovery set do not have a value in that attribute, the discovery request reverts to the standard community_name attribute.

In releases prior to eHealth r6.1 and SPECTRUM r9.0, if you have configured nhSpectrumSetup and attempt to run a discovery using Spectrum import, the list of devices to discover includes the community string from the configured Spectrum attribute.

For more information, see the eHealth SPECTRUM Integration User Guide.

The following command line arguments are for internal use only. These arguments allow you to set the SPECTRUM import parameters directly, without bringing up the GUI. Most users will run the command without arguments, and use the GUI to specify these parameters. However, if you want to setup multiple eHealth systems, you can create a script that sets these values on each box.

This command has the following format: nhSpectrumSetup [-h] [-list] [-host name] [-port number] [-path path] [-user

name] [-password]



-list Lists the current setup parameters.

-host name Specifies the hostname or IP address of the SPECTRUM OneClick server.





-port number Specifies the port number for SPECTRUM OneClick server Web requests.

Default: 80

-path path Specifies the path in which SPECTRUM OneClick is installed on the server.

Default: spectrum.

Note: Use the default value unless you specified another path when installing SPECTRUM OneClick.

-user name Specifies the username used to log in to the SPECTRUM OneClick server.

-password Specifies the password for the selected user name.

Note: The password value is not supplied as an argument. After you enter the command, you must type the password. The password is then read by the program.

nhSvInstall

Installs and sets up the eHealth Integration for Cisco WAN Manager module.

nhSvGetCfg

Extracts configuration information from a Cisco WAN Manager NMS.

nhSvDiagnose

This diagnostic tool for eHealth Integration for Cisco WAN Manager identifies and resolves statistics collection problems and avoids further configuration and polling problems.

nhVpnscSetup

Installs and sets up eHealth Integration for Cisco VPN Solutions Center.

Live Health Commands

Live Health Commands The Live Health commands are as follows:

■ nhAutoLicenseSysEdge

■ nhCompileTrf

■ nhConfigureTrapEx

■ nhLiveExceptions

■ nhLiveStatus

■ nhLiveTrend

■ nhMonitorSubjects

■ nhMonitoredSubjectsRpt

■ nhReloadTrapRules

■ nhSendSnmpTrap

■ nhTestTrapRule

■ nhTranslateTrapLog

nhAutoLicenseSysEdge

Automatically licenses unlicensed SystemEDGE agents. Before you can use this command, you must perform some preliminary setup tasks.

nhCompileTrf

Compiles one or more trap rule files (TRFs), which is part of the trap certification process.


nhCompileTrf [-h] [-rev]

nhCompileTrf {-f filename | -a} [-i | - s]








-f filename Compiles one TRF (filename) and saves the output as filename.sio and filename.pcm, in the directory in which the TRF resides. The nhCompileTrf command then creates ehealth/data/traps/staticTrapInfo using all precompiled information (where ehealth represents the eHealth installation directory).

Provide a full pathname for filename. The TRFs to compile typically reside in the ehealth/extensions/traps/usr directory.

-a Compiles all TRFs located in the ehealth/extensions/traps/sys and ehealth/extensions/traps/usr directories and saves the output in ehealth/data/traps/staticTrapInfo.

nhConfigureTrapEx

Configures automatic licensing of SystemEDGE agents for use with TrapEXPLODER software.

nhLiveExceptions

Starts the Live Exceptions Browser. This command is located in live/client/bin, where live represents the directory in which you installed Live Exceptions.

This command has the following format: nhLiveExceptions [-h] [-rev] [-host hostname] [- port portNumber]

[-user username] [-passwd password] [- XmxSize]

[-debug] [-jconsole]











- XmxSize Specifies the maximum size (in bytes) of the memory allocation pool. This value must be a multiple of 1024 greater than 2 MB. Append the letter k or K to indicate kilobytes, or m or M to indicate megabytes. The default value is 2 MB.

Examples:

-Xmx83886080

-Xmx81920k

-Xmx80m

Use this argument when you are running Live Exceptions on a Distributed eHealth Console and you receive a “running out of memory” error. Increase the value of Size to correct the problem.

-debug Internal


-jconsole Internal


nhLiveStatus

Starts the Live Status application. The command is located in live/client/bin, where live represents the installation directory for Live Status.

This command has the following format: nhLiveStatus [-h] [-rev]

[-host hostname] [-port portNumber]

[-user username] [-passwd password]

[-threshold value] [debug] [jconsole]

[screenSize widthXheight]











-threshold value Specifies the maximum number of elements for fixed-sized icons. Diagrams that have more than the specified number of elements will use dynamically-sized icons. The default value is 750.

nhLiveTrend

Starts the Live Trend application. This command is located in live/client/bin, where live represents the directory in which you installed Live Trend.

This command has the following format: nhLiveTrend [-h] [-rev] [-host hostname] [-port portNumber]

[-user username] [-passwd password] [-debug] [-jconsole]




-host hostname Specifies the hostname of the eHealth system.



- passwd password

Specifies the password of the eHealth Web user account.

- debug Internal


- jconsole Internal



nhMonitorSubjects

Associates Live Health profiles with subjects (groups or group lists). This is the same functionality that is available in the Live Exceptions Browser using Setup, Subjects to Monitor. However, it is easier to use the nhMonitorSubjects command to perform a large number of associations.

Note: This command does not support the removal of associations.

After an eHealth upgrade, use the nhMonitorSubjects command to associate selected profiles with specified subjects.

This command has the following format: nhMonitorSubjects [-h] [-rev]

-all | [-subjType {group | groupList}] [-subjName subject]

[-calendar calendarName] [- profileList filename]




-all (Optional) Uses the default values for all other arguments. I.e. associates the All groups with all system profiles and the 24x7 calendar. Needs to be specified if no other arguments are specified. Cannot be used together with other arguments.

-subjType {group | groupList}

Specifies the subject type. Valid values are group and groupList. The default is group. Not valid with the -all option.

-subjName subject Specifies the subject name as a valid group or group list name. The default is the subject named All. Not valid with the -all option.

-calendar calendarName

Specifies an existing calendar to apply to this association. The default is the calendar named 24x7. Not valid with the -all option.

-profileList filename Specifies the name of the file that lists the existing profiles that you want to associate. You must list each profile on a separate line in the file. The default is all system profiles. Not valid with the -all option.



Examples:

■ To apply the profiles listed in lwProfiles.lis to all groups called All, enter the following:

nhMonitorSubjects -profileList lwProfiles.lis

■ To associate the All group with the profiles listed in a file named lwProfiles.lis, enter the following:

nhMonitorSubjects -subjType group - profileList lwProfiles.lis

■ To associate the West group for all groups with the profiles listed in a file named lwProfiles.lis, enter the following:

nhMonitorSubjects -subjName West - profileList lwProfiles.lis

nhMonitoredSubjectsRpt

Generates the Monitored Subjects Summary and Detail reports for Live Exceptions. These reports summarize the monitoring rules for the various subjects (groups and group lists) that Live Exceptions is monitoring. This command outputs the HTML syntax that renders the reports to standard output. To view the reports, you can redirect the output to a file and view it using a Web browser.

This command has the following format: nhMonitoredSubjectsRpt [-h] [-rev]

-profile profile - subjType subjType - subjName subject

[-summary | -detail] [-outFile filename] [- calendar calendar] [-alias]




- profile profile Specifies the name of the profile to preview. When you specify this argument, you must also specify the - subjName, and -subjType arguments.

- subjType subjType Specifies the subject type. Valid values are group and groupList. The default is group.

- subjName subject Specifies the subject name as a valid group or group list name. If you specify this argument, the report summarizes the Live Exceptions monitoring information for the specified subject. If you do not specify it, the report summarizes the monitoring information for all groups and group lists.





- summary Generates the Monitored Subjects Summary Report. This is the default.

- detail Generates the Monitored Subjects Detail Report.

- outFile filename Specifies the name of the output file.

- calendar calendar Specifies the name of the calendar to preview. When you specify this argument, you must also specify the - profile argument.

- alias Specifies that eHealth should use alias names for elements instead of element names.

nhReloadTrapRules

Reloads all system and user trap rule files (TRFs) without restarting eHealth; finds new and changed files in the ehealth/extensions/traps/user and eHealth/extensions/traps/sys directories and loads them to the eHealth trap server and Live Exceptions Browser.

This command has the following format: nhReloadTrapRules [-h] [-rev] [-v]





nhSendSnmpTrap

Builds a Simple Network Management Protocol (SNMP) trap from command line arguments that you specify, or reads traps from a file. This command sends an actual trap, and an alarm should appear in the Live Exceptions Browser. Use this command to test your trap rule file (TRF) and to check whether Live Exceptions receives traps from devices properly.

Note: The SNMP variable type does not support an IPv6 address. The type is defined in RFC1212 as an OCTET of size 4 (a 32 bit value). If a trap is defined with one or more of its variable bindings as IPv6 addresses, the type will probably be octet string and not IP address.


This command has the following format: nhSendSnmpTrap [-debug] [-h] [-rev] -a ipAddress

[-s ipAddress] [-v version]

[-p port] [-f filePath ...] [- r number] [-i]

[-z] [-m path ...] [-gt genericType]

[-st specificType] [- e enterprise]

[-n notificationId] [-b {oid type value}]


-debug Internal

Runs this command with debug output.



-a ipAddress (Required) Specifies the IP address to which the trap will be sent.

- s ipAddress Specifies the IP address of the source agent from which to simulate sending the trap.

-v version Specifies the SNMP version of the trap (v1, v2, v2c, or v3). The default is v1. If you specify v2c or v3, you must also use the -n argument.

-p port Specifies the port to which the trap will be sent. The default is 162.

-f filePath [...] Specifies the full pathnames of the standard trap files containing traps.

-r number Specifies the number of times to send the files or traps.

-i Ignores the trap timestamps in the standard trap files and sends the traps as soon as possible.

-z Processes traps using standard input.

-m path [...] Specifies the full pathname of one or more MIB files used to translate the symbolic names to object identifiers (OIDs).

-gt genericType Specifies the SNMP v1 generic trap type.

-st specificType Specifies the SNMP v1 specific trap type.

-e enterprise Specifies the SNMP v1 enterprise OID for command line traps.

-n notificationId Specifies the SNMP notification OID. This argument is required for SNMP v2c and v3.





-b {oid type value} ... Specifies variable bindings lists consisting of three bindings: oid, type, and value, separated by single spaces. The list functions as a data field in the SNMP protocol data unit (PDU) by binding objects with their current values.

oid – An ASN.1 object identifier (for example, .1.3.6.1.2.1.2.2.1). A symbolic OID must appear in one of the loaded MIBs or in a standard MIB.

type – The object type. The following are valid values: INTEGER, OCTETSTRING, OID, IPADDRESS, INTEGER32, Counter, Counter32, Gauge, Gauge32, TimeTicks, Unsigned32, Counter64.


Syntax Notes:

■ Enclose empty strings with double- quotes created using escape sequences—that is: \".


Example:

The following example sends version 2c (v2c) SNMP traps and data expressed as strings and INTEGERS. Notice that v2c traps require the -n or notification OID argument.

nhSendSnmpTrap -v v2c -a 172.16.5.52 -p 7001 \

-n .1.3.6.1.4.1.546.0.1 \

-b .1.3.6.1.2.1.1.5.0 OCTETSTRING \

\"Monitoring variable mbufDesc oid 1.3.6.1.4.1.546.6.1.1.5\"

.1.3.6.1.4.1.546.6.1.1.5 OID \

.1.3.6.1.4.1.546.1.1.10.1.7.1.2.69 \

.1.3.6.1.4.1.546.6.1.1.6 INTEGER 666 \

.1.3.6.1.4.1.546.6.1.1.8 IPADDRESS 192.168.11.1 \

.1.3.6.1.4.1.546.6.1.1.8 INTEGER 333 \

.1.3.6.1.4.1.546.6.1.1.12 INTEGER 4 \

.1.3.6.1.4.1.546.6.1.1.7 INTEGER 2 \

.1.3.6.1.4.1.546.6.1.1.1 INTEGER 22 \

.1.3.6.1.4.1.546.6.1.1.16 INTEGER 42


nhTestTrapRule

Tests a trap rule file (TRF) without restarting the eHealth server. After you write a new TRF and save it in the ehealth/extensions/traps/usr directory, you can use the nhTestTrapRule command to test that the rule file accepts the trap type information and properly formats it.

Note: Use the nhTestTrapRule command to test the SNMP Version 1-style of trap information only. You cannot use nhTestTrapRule to test trap information for other versions of SNMP.

This command has the following format: nhTestTrapRule [-h] [-rev] [-v] [-u] [-gt genericType]

[-st specificType] [- e enterpriseOid]

[-b variable oid type value ...]





-u Outputs the userMessage variable as a list of arguments and skips substitutions. The userMessage variable is one of eight variables that compose the User-Visible Information section of the TRF. This section defines the format of all user-visible information that appears in the Live Exceptions Browser or the Rule Editor dialog box.

-gt genericType Specifies the SNMP v1 generic trap type. The default value for genericType is 0 (zero).

-st specificType Specifies the SNMP v1 specific trap type. The default value for specificType is 0 (zero).

-e enterpriseOid Specifies the SNMP v1 enterprise OID for command line traps. The default value for enterpriseOid is 0.0.





-b variable oid type value [...] Specifies variable bindings lists. Each list consists of four bindings: variable, oid, type, and value. The list functions as a data field in the SNMP protocol data unit (PDU) by binding objects with their current values.

variable – Name of the variable.

oid – An ASN.1 object identifier (for example, .1.3.6.1.2.1.2.2.1). A symbolic OID must appear in one of the loaded MIBs or in a standard RFC MIB.

type – The object type. The following are valid values: integer, oid, string.


Syntax Notes:

■ Enclose empty strings with double-quotes created using escape sequences—that is: \".


nhTranslateTrapLog

Translates binary, ASCII, or Micromuse Netcool trap log files into ASCII or a standard form that can be sent to the nhSendSnmpTrap command. Use this command to evaluate non-certified traps or to rerun traps for testing or certification purposes.

This command has the following format: nhTranslateTrapLog [-h]

{-bin inputfile [-t pduIdList] | -ascii inputfile | -netcool inputfile}

[[-ascii | - standard] outputfile]






-bin, - ascii, or - netcool (Required) Specifies the format of the input file, consisting of one of the following:

-bin – A binary trap server log file. If you specify -bin, you must also specify -t.


-netcool – A Netcool trapd log file.

inputfile (Required) Specifies the name of the trap file to translate.

-t pduIdList (Optional) Specifies a list of protocol data unit (PDU) IDs or sequence numbers of the traps to be translated. Uncertified traps have an associated PDU ID. For the PDU ID, see the browser or tool displaying the trap that you want to translate. The Live Exceptions Browser displays the PDU ID in the Description column.

You can use this argument only when specifying the -bin argument; you cannot use it with -ascii or - netcool.

-ascii or -standard (Optional) Specifies the format of the output file:


-standard – A file format that can be used with the nhSendSnmpTrap command. This argument is the default.

outputfile (Optional) Overrides the standard output with the file name you supply.

Examples:

■ This example shows how to certify traps:

1. Obtain the non-certified trap’s PDU ID from the browser or the tool displaying the trap.

2. To convert the trap to a readable ASCII format file, enter the following command:

nhTranslateTrapLog -t pduId -bin inputfile -ascii outputfile.log

Toolkit Commands

■ This example shows how to use the nhTranslateTrapLog and nhSendSnmpTrap commands to rerun a log immediately after it has been translated. Use this syntax to replay traps for certification or testing purposes:

nhTranslateTrapLog -netcool trapd.log | \

nhSendSNMPTrap -a 172.16.5.58 - z

Note: In this syntax example, “|” is the pipe command, not an “or” condition.

Toolkit Commands The toolkit commands are as follows:

■ nhCompileMib

■ nhConfig

■ nhCustomVariable

■ nhEncodeRdl

■ nhExportCalendarCfg

■ nhExportConfig

■ nhExportData

■ nhExportImPollerStatus

■ nhExportLiveExCfg

■ nhExportSnmpKeyInfo

■ nhExportWebAcct

■ nhImportCalendarCfg

■ nhImportData

■ nhImportImPollerStatus

■ nhImportLiveExCfg

■ nhImportSnmpKeyInfo

■ nhImportWebAcct

■ nhSnmpTool


Toolkit Commands

nhCompileMib

Creates a precompiled management information base (MIB) (PCM) file, which is one step in the process for creating a custom variable. For the complete syntax, see the eHealth Data Integration Guide.

nhConfig

Imports element configuration information from a Database Configuration Information (DCI) file into the eHealth database. If you have a network management system (NMS) or other data source that collects configuration information and data about your resource devices, you can import the information from that source into the eHealth database. For the complete syntax, see the eHealth Data Integration Guide.

nhCustomVariable

Displays a graphical user interface through which you can add custom variables to a MIB translation file (MTF), apply an MTF to specific elements, and run a test poll to ensure that your customization is valid. For the complete syntax, see the eHealth Data Integration Guide.

nhEncodeRdl

Encodes custom report files. For the complete syntax, see the eHealth Data Integration Guide.

nhExportCalendarCfg

Exports calendar configuration information from eHealth to a Calendar DCI file for processing. For the complete syntax, see the eHealth Data Integration Guide.

nhExportConfig

Exports element configuration information from the eHealth database to a DCI file. You can then use the file to modify element information and import the new information to the eHealth database. You can export all elements in the poller configuration; elements in a single group or group list; and elements of a particular type or technology. You cannot use this command to export configuration information for a single element.


Toolkit Commands

Note: You can use this command on a Distributed eHealth System; however, it is not supported on a Distributed eHealth Console.

The eHealth server must be running when you use the nhExportConfig command. For the complete syntax, see the eHealth Data Integration Guide.

nhExportData

Exports data for statistics elements from the eHealth database to a Database Definition Output (DDO) file for processing. You can use this command to export large amounts of bulk (unanalyzed) data from the eHealth database to a spreadsheet, database, script, or other application program to perform your own statistical analysis. The command option –cfgFields lets you include element configuration attributes along with the statistical data.

You can use command arguments with the nhExportData command to specify the element or group, DDO file name, time range, and Trend report variables to export. You can use this command on a Distributed eHealth System; however, it is not supported on a Distributed eHealth Console.

You cannot use the nhExportData command to do the following:

■ Export statistics data for the elements in a group list.

■ Export statistics data for all elements in the poller configuration at the same time.

■ Limit the data export to a particular element type.

■ Export statistics data for variables other than Trend report variables.

■ Export data for eHealth conversations elements used in applications such as eHealth – Traffic Accountant and eHealth Integration for Cisco NetFlow.


nhExportData [-h] [-rev] -subjName "name1, ..., nameN"

[-host name | -cluster | -all] [-outFile ddoOutputFile]

[-autoRange type | -fromDate date -fromTime time -toDate date -toTime time]

[-subjType type] [-vars "variable1, ..., variablen"]


-h Displays the command usage.



Toolkit Commands



-subjName "name1, ..., nameN"

Specifies the name of one or more elements or a single group for which to export statistics data. If you specify a list of element names, separate them with commas (,) and enclose the list in quotation marks (" "). This is the only required argument. If you specify a parent element name, the command also exports statistics data for all of its child elements. If you specify a group name, it exports statistics data for all elements in the group and their respective child elements.

-host name Specifies the name of the eHealth system in the cluster on which you want to run the command. For example, to run the nhExportData command on an eHealth system named newyork, use the following command from any eHealth system in the cluster:

nhExportData -host newyork

Note: You must use the hostname and not the IP address.

-cluster Runs the command on all eHealth systems in the cluster except the local system. This command creates an output file for each system and appends the hostname as follows: dciOutputFile.hostname. It also adds the machine ID to the element descriptor for each element in an output file. You cannot merge the output files into a single file.


Toolkit Commands



-all Runs the command on all eHealth systems in the cluster. This command creates an output file for each system and appends the hostname as follows: dciOutputFile.hostname. It also adds the machine ID to the element descriptor for each element in an output file. You cannot merge the output files into a single file.


-outFile ddoOutputFile Specifies the name of the DDO file to which you want to export the statistics data. If you omit this argument, eHealth exports the statistics data to standard output by default.

-autoRange type Specifies the time range for which you want to export statistics data. The following values are valid:

■ today

■ yesterday

■ thisWeek

■ lastWeek

■ thisMonth

■ lastMonth

■ prevHour (the default)

■ prev12Hours

■ prev24Hours

■ prev7Days

■ prev4Weeks

-fromDate date Specifies the starting date for which you want to export statistics data. Specify the date in MM/DD/YYYY format.

-fromTime time Specifies the starting time for which you want to export data. Specify the time in hh:mm:ss format using a 24-hour clock.

Toolkit Commands



-toDate date Specifies the ending date for which you want to export data. Specify the date in MM/DD/YYYY format.

-toTime time Specifies the ending time for which you want to export data. Specify the time in hh:mm:ss format using a 24-hour clock.

-subjType type Specifies whether you want to export statistics data for one or more elements or for a single group of elements. The following values are valid:

■ element (the default)

■ group

If you specify the name of one or more elements for the -subjName argument, set the value of -subjType to element. If you specify the name of a group for the -subjName argument, set the value of -subjType to group.

-vars "variable1, ..., variablen" Specifies the names of Trend report variables for which you want to export statistics data. By default, data appears for the union of all Trend report variables applicable to the specified elements. If you specify a list of variable names, separate the names with commas (,) and enclose the list in quotation marks (" ").

For more information and examples, see the eHealth Data Integration Guide.

nhExportImPollerStatus

Saves the IM poller status files to the specified zip file in a format suitable for use with nhImportImPollerStatus. For the complete syntax, see the eHealth Data Integration Guide.

nhExportLiveExCfg

Exports Live Exceptions configuration information to a DCI file, so you can modify the information. For the complete syntax, see the eHealth Data Integration Guide.

Toolkit Commands

nhExportSnmpKeyInfo

Exports SNMPv3 key configuration information from the eHealth database to a DCI file. You can then modify the information and reimport it into the database. For more information about this command, see the eHealth Data Integration Guide.

nhExportWebAcct

Exports eHealth Web user account information and passwords from users.cfg to a DCI file that you can modify. It can also copy user Web reports to a file. This command supports Distributed eHealth cluster arguments. For the complete syntax, see the eHealth Data Integration Guide.

Note: The nhExportWebAcct command is intended for use by the eHealth Web administrator.

nhImportCalendarCfg

Imports calendar configuration information for partial-day support to eHealth from a Calendar DCI file. For the complete syntax, see the eHealth Data Integration Guide.

nhImportData

Imports the following types of information to your eHealth database:

■ Statistical data about your resources

■ Conversations data transferred between node pairs on your network

You can then use eHealth to report on this data. For the complete syntax, see the eHealth Data Integration Guide.

nhImportImPollerStatus

Restores the IM poller status files. By default, the files are restored to d:/eHealth, but you can use the -nhHome option to specify a different path name. This command complements the nhImportImPollerStatus command. For the complete syntax, see the eHealth Data Integration Guide.


Traffic Accountant Commands

nhImportLiveExCfg

Imports Live Exceptions configuration information into the eHealth database from a DCI file. For the complete syntax, see the eHealth Data Integration Guide.

nhImportSnmpKeyInfo

Imports SNMPv3 key configuration information from a DCI file into the eHealth database. You can then use eHealth to discover and report on SNMPv3 elements. For more information about this command, see the eHealth Data Integration Guide.

nhImportWebAcct

Uses a DCI file that contains Web user account configuration information to create a new Web user profile, users.cfg. It then saves the previous version of the profile as users.cfg.bak. The command can also copy user Web reports from a file. For the complete syntax, see the eHealth Data Integration Guide.

nhSnmpTool

Displays a subset of the MIB information for the specified host and MIB. For the complete syntax, see the eHealth Data Integration Guide.

Important! Use this command only under the direction of Technical Support.

Traffic Accountant Commands The Traffic Accountant commands are as follows:

■ nhCleanupNodes

■ nhNameNodes

■ nhTaDataPurge



nhCleanupNodes

Hides or removes unwanted and unused node and node-address pairs from the database. When nodes no longer have associated data, you can continue to create reports on them because the database still contains the addresses (although reports will list internal database IDs instead of node addresses or names). Use this command to hide nodes so that the data will appear to be unavailable for reports or to reduce the growth rate of the eHealth database.

By default, eHealth provides this command as a scheduled system job but does not enable it. You can modify the job to schedule it to run on a regular basis.


nhCleanupNodes [-h] [-rev] -hoursOld hours

{-hide | -remove}




- hoursOld hours Specifies the age of the nodes (in hours) to use as a basis for hiding or removing them. This argument is required.

- hide or - remove

■ When the number of hours specified by the -hoursOld argument have passed, use the appropriate argument to do the following:

■ -hide – Leaves node or node-address pairs in the database; however, deletes the data when it is rolled out of the database.

■ -remove – Removes node or node-address pairs from the database.

Important! Using the - remove argument can have serious consequences on your Traffic Accountant reports. For example, if you specify an - hoursOld value that is too small, you may remove important nodes inadvertently.

Example:

Enter the following command to remove nodes that are older than two days:

nhCleanupNodes -hoursOld 48 - remove



nhNameNodes

Converts the network addresses of nodes in the database into names using a standard name resolution protocol (DNS), maps, or files. By default, eHealth provides this command as a scheduled system job that runs hourly. You can modify the job to schedule it to run less frequently.

Note: When Traffic Accountant is in AS-to-AS mode, you can only use files (not maps or DNS) to convert network addresses to node names. For more information, see nhTaDataPurge.

The nhNameNodes command requires one of the following mutually exclusive forms: nhNameNodes [-h] [-rev]

nhNameNodes [-all] [-dns] [-timeout seconds] [-retry number]

[-norecurse] [-user username] [-db database]

[-last hours | -view viewName -group groupName]

nhNameNodes [-all] [-file filename] [-user username] [-db database]


nhNameNodes [-reset] [-user username] [-db database]


If you do not specify any arguments, the command defaults to the following: nhNameNodes -dns




-all Specifies that eHealth should name all nodes even if they have already been named. If you do not specify this argument, eHealth disregards nodes that already have names. You can use this argument if you do not specify -reset.

-dns Uses the DNS name resolution protocol as provided by BIND. You can use this argument if you do not specify -map, -file, or -reset.

Note: You cannot use the -dns argument when Traffic Accountant is in AS-to-AS mode.

-map mapName Specifies a Network Information System (NIS) map to use for node address-to-name information.

Note: This argument is deprecated. Use the -file or -dns arguments instead.





-file filename Specifies a file to use for address-to-name information. The file must have the same format as the standard /etc/hosts file. You can specify this argument if you do not specify -map, -dns, or -reset.

- timeout seconds Specifies the amount of time (in seconds) to wait for a name request to be filled. If the value of -retry has not been met, this argument specifies how long to wait before requesting the node again. If the value of -retry is exceeded, this argument specifies how long to wait before requesting the next node. The default is 3 seconds. Specify - timeout only when specifying -dns.

A -timeout value of less than 3 seconds may produce an increase in nodes (usually outside the client network) without names.

-retry number Specifies the number of times that eHealth will attempt to look up a node’s name before moving on to the next node. The default is 2. Specify -retry only when specifying -dns.

A -retry value of less than 2 may produce an increase in nodes (usually outside the client network) without names.

- norecurse Specifies that the command should stop at the local tier of DNS servers when retrieving node names. Specify -norecurse only when specifying -dns.

While you can use this argument to save retrieval time, its use can sometimes produce an increase in nodes that are not renamed.

-reset Converts nodes back to IP addresses or AS numbers. For consolidated addresses, eHealth cannot restore the node address because it can choose from more than one possible address.

-user username Specifies a user name. If you do not specify this argument, the command uses the eHealth administrator.

-db database Specifies the database to use. By default, eHealth uses the value of the NH_RDBMS_NAME environment variable.

-last hours Names only the nodes that were created within the specified number of hours. The default (as a scheduled job) is 1 hour. However, from the command line, this feature is disabled by default. You can specify this argument if you do not specify -view and -group.




-view viewName Names only the nodes in the specified view. You can specify this argument if you do not specify -last.

-group groupName Names only the nodes in the specified group for viewName. You can specify this argument if you do not specify -last.

Note: You can mix address types (IP, Media Access Control [MAC], and Internetwork Packet Exchange [IPX]) in the same file or map. DNS only uses IP-type addresses. When nhNameNodes encounters more than one address that resolves to an identical name, the command consolidates those addresses to point to a single named node in the database. It deletes all other nodes originally associated with the unique addresses.

Example:

If the standard resolver is DNS, resolve (nonlocal) node addresses by entering the following:

nhNameNodes -dns

nhTaDataPurge

Deletes Traffic Accountant data from the eHealth database, and specifies that Traffic Accountant is in node-to-node or AS-to-AS mode.

This command has the following format: nhTaDataPurge [-h] mode



mode Specifies the mode in which Traffic Accountant operates, based on one of the following:

as or AS – AS- to-AS mode

ip or IP – node- to-node mode

Internal Support Commands

Internal Support Commands The internal support commands are as follows:

■ nhCollectDbData

■ nhGetClusterPasswd

■ nhRmon2Diag

■ nhShowElementInfo

nhCollectDbData

Gathers information to help diagnose problems with your eHealth database.

Important! Use this command under the direction of Technical Support only.


nhCollectDbData [-nhHome <ehealth>] [-ftp] [-outPath <ehealth>] [-v]



- nhHome ehealth (Optional) Searches the specified directory for information related to eHealth. For use where NH_HOME can not be determined for some reason. If not specified, will search NH_HOME.

-ftp (Optional) Ftp's the information to the eHealth product's FTP site.

- outPath pathname (Optional) Specifies the directory in which eHealth will copy the collected information for tarring. A set of subdirectories will be created to hold all the collected data. If you do not specify this argument, the command creates the subdirectory root in the <ehealth> directory by default.

- v (Optional) Turns on verbose mode.



Example:

The following example collects data from the <ehealth>/tmp directory and tars it to the eHealth product's FTP site: nhCollectDbData -ftp -v

creating tarball of environment and all relevant files ...

:: NH_HOME: f:/eh5.6 selections ...

:: NH_ORACLE_HOME: f:/oracle/ora92 selections ...

:: attempt to gather info from Oracle...

:: done with capture, making tarball ...

:: preparing to ftp...

:: FTP'ing tarball to madison.concord.com ...

:: local tarball retained: F:/eh5.6/gbrown-gx260.2003-07-01-1637.tar

:: done.

nhGetClusterPasswd

Displays the cluster password used in a Distributed eHealth cluster. To obtain a copy of the command, contact your eHealth Sales Engineer or Technical Support. Specify the operating system of your eHealth platform to ensure that you receive the correct executable file. Save the command in the ehealth/bin directory.

Important! If you include the nhGetClusterPasswd command in your ehealth/bin directory (where ehealth represents the eHealth installation directory), any user who logs in as an eHealth administrator to that system (or any user with access to the eHealth system) can display the cluster password.

This command has the following format: nhGetClusterPasswd [-h] [-rev]




nhRmon2Diag

Shows the current probe configuration (that is, control table entries and protocols), creates and deletes control table entries, and detects duplicate control table entries.

Note: Use the nhRmon2Diag command only under the direction of Technical Support.



This command has the following format: nhRmon2Diag [-h] [-c community] [-r retries] [-t timeout] [- showConfig]

[-showProtocol] [-showAll] [-showDupCtrlEntry] [- delete ctrlTblIndex]

[-create interface] [- alMax alMaxEntries] [-nlMax nlMaxEntries]

[-own owner] ipAddress



-c community Specifies the community string. The default is public.

-r retries Specifies the number of times that the nhRmon2Diag command should attempt to identify the current probe configuration. The default is 2.

-t timeout Sets the amount of time (in seconds) that the nhRmon2Diag command maintains the search. The default is 1 (one).

-showConfig Shows the entries in the nlMatrixControlTable table. One entry in the table represents an interface on the probe.

-showProtocol Shows the protocolDirTable table, which lists the protocols configured for the application layer matrix (as shown in Traffic Accountant reports if the protocols exist in the network).

-showAll Shows the nlMatrixControlTable and protocolDirTable tables.

-showDupCtrlEntry Shows duplicate entries in the nlMatrixControlTable table.

-delete ctrlTblIndex Deletes an entry with the specified index from nlMatrixControlTable.

-create interface Creates an entry for the specified interface in nlMatrixControlTable.

-alMax alMaxEntries Specifies the maximum desired number of application layer matrix entries. The default is -1 (negative one), indicating that the RMON2 probe can increase the matrix as much as resources allow.

-nlMax nlMaxEntries Specifies the maximum desired number of network layer matrix entries. The default is 6000.

-own owner Specifies the owner of the control table entry. The default is Concord.

ipAddress Specifies the IP address of the probe.



Example:

■ The following command shows all control table entries and protocols for the specified probe:

nhRmon2Diag -showAll 192.16.4.120

nhShowElementInfo

Displays element information and data from the poller configuration file. Use this command to debug Technical Support or polling problems such as duplicate elements or other data problems.

This command has the following format: nhShowElementInfo [-h] [-rev] -element elementId

[-time timeStamp] [- window minutes]




-element elementId Specifies the database element ID.

-time timeStamp Specifies a Universal Time Code (UTC) that you want to examine. The default is the current time.

-window minutes Specifies the number of minutes of data to display before and after the value specified by the -time argument. The default is 30 minutes. If you specify a time window that does not have polled data, this argument displays the available data instead.


Chapter 2: Discover Policy Parameter Usage

Discover Policy Parameters This section describes parameters that relate to the eHealth Discover Policies. The obsolete environment variable names (in parentheses) are provided for cross referencing purposes and are no longer usable as environment variables.

Alcatel - Discover RMON (NH_DISCOVER_ALCATEL_RMON)

Discovers Alcatel RMON elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Alteon - Discover BWM Policy (EH_DISCOVER_ALTEON_BWMPOLICY)

Discovers Alteon BWM Policy elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

ATM - Filter Ethernet LANE (NH_IGNORE_LEC_PVC)

Discovers ATM Ethrenet LANE elements.

yes

Disables discovery.

no

Enables discovery.

Default: no

Chapter 2: Discover Policy Parameter Usage 397

Discover Policy Parameters

Bay - Discover Clusters (NH_BAY_CLUSTERS)

Discovers Bay clusters.

yes

Enables discovery.

no

Disables discovery.

Default: yes

Bay - Use Ethernet with Collisions (NH_FIND_BAY_CSMACD)

Discovers Bay Ethernet elements using the Bay/Wellfleet Ethernet with the Collisions agent instead of the default Bay management information base-2 (MIB2) (LAN port) agent.

yes

Enables discovery using Bay/Wellfleet Ethernet with the Collisions agent.

no

Enables discovery using Bay management information base-2 (MIB2) (LAN port) agent.

Default: no

Cable - Discover DOCSIS 2.0 Plus (NH_DISCOVER_CABLE_DOCSIS_EXT)

Discovers DOCSIS 2.0 Plus Cable LAN elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cable - UGS Bandwidth (NH_UGS_BANDWIDTH_FACTOR)

Specifies UGS bandwidth.

Default: 109888



Cisco ATM PVC - Use ifSpeed (EH_CISCO_PVC_IFSPEED)

Uses ifSpeed for ATM PVC if SCR is invalid. Otherwise, an invalid SCR will result in a zero speed.

yes

Uses interface speed for ATM PVC if SCR (Sustained Cell Rate) is invalid.

no

Uses SCR (Sustained Cell Rate) for speed.

Default: no

Cisco Catalyst - Legacy Naming (NH_DISCOVER_CISCO_CAT_NAME)

Specifies use of legacy Cisco Catalyst naming scheme. This scheme does not use ifDescr when naming elements.

yes

Uses legacy naming scheme.

no

Uses ifDescr when naming elements.

Default: no

Cisco - Discover ATM OAM PVCs (NH_DISCOVER_CISCO_OAM_PVCS)

Discovers Cisco ATM OAM PVC interfaces.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cisco - Discover CIP (NH_DISCOVER_CISCO_CIP)

Discovers Cisco CIP elements.

yes

Enables discovery.

no

Disables discovery.

Default: no



Cisco - Discover HSSI Subinterfaces (EH_CISCO_HSSI_SUBIF)

Discovers High Speed Serial Interface (HSSI) management information base version 2 (MIB2) subinterfaces, in addition to Frame Relay data link connection identifiers (DLCIs).

HSSI subinterfaces connect subnetworks to a single physical port while keeping the networks separate. The discover process normally filters out HSSI MIB2 subinterfaces due to the presence of Frame Relay DLCIs. To also discover subinterfaces, you must set this variable.

yes

Enables discovery of HSSI subinterfaces.

no

Disables discover of HSSI subinterfaces.

Default: no

Cisco - Discover MIB2 ATM VCC (NH_DISCOVER_MIB2_VCC)

(For installations with Cisco routers) Discovers Cisco MIB2 ATM Virtual Circuit Connection (VCC) statistical elements.

yes

Creates cAal5VccTable statistical elements if they are present.

no

Creates MIB2 statistics elements if they are present.

Default: no

Cisco - Discover MGX Logical B Band (EH_DISCOVER_MGX_LOGICAL_B_BAND)

Discovers Cisco MGX Logical B Band elements.

yes

Enables discovery.

no

Disables discovery.

Default: no



Cisco - Discover MGX Logical N Band (EH_DISCOVER_MGX_LOGICAL_N_BAND)

Discovers Cisco MGX Logical N Band elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cisco - Discover MPLS (EH_DISCOVER_CISCO_MPLS )

Discovers additional MPLS types on Cisco devices: mpls-in-segment, mpls-out-segment, mpls-te, and mpls-interface elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cisco - Discover NAT (EH_DISCOVER_CISCO_NAT)

Discovers Cisco NAT elements.

yes

Enables discovery.

no

Disbles discovery.

Default: no

Cisco - Discover NBAR Protocol (NH_DISCOVER_NBAR_PROTO)

Discovers Cisco NBAR Protocol elements.

yes

Enables discovery.

no

Disables discovery.

Default: no



Cisco - Discover PIX Firewall Connections (NH_DISCOVER_CISCO_PIX_PROTO_CONNECTION_STATS)

Discovers Cisco PIX Firewall Connections as sessions instead of as WAN interfaces.

yes

Enables cisco-pix-firewall-session.mtf.

no

Enables cisco-pix-firewall-wan.mtf.

Default: no

Cisco - Discover Sensors (NH_DISCOVER_CISCO_SENSOR)

Specifies discovery of Cisco sensor elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cisco - Discover SVCs and PVCs (NH_DISCOVER_IOS_SVC)

(For Cisco devices only) Discover switched virtual circuits (SVCs) and permanent virtual circuits (PVCs).

Ciscos management information base (MIB) for routers does not currently provide information to determine whether a virtual circuit is an SVC or a PVC. When the discover process cannot make that determination, eHealth considers the circuit to be an SVC and does not discover it unless the value of Cisco – Discover SVCs and PVCs is set to yes.

yes

Discovers SVCs and PVCs.

no

Discovers PVCs only.

Default: no



Cisco FR PVC - Use ifSpeed (EH_CISCO_DLCI_IFSPEED)

Specifies the speed assigned to a Cisco Frame Relay PVC element.

yes

Assigns ifSpeed to the element.

no

Assigns PVC speed to the element.

Default: no

Cisco - Group VLANs (NH_DISCOVER_CISCO_VLAN_GROUPS)

Lets you generate groups automatically for Cisco VLAN elements.

eHealth assigns trunks to a group named CISCO-VLAN-ALL-TRUNKS. If a port belongs to a named VLAN, eHealth adds the port to a group called CISCO-VLAN- vlanName. For example, for a VLAN called North, eHealth creates a group named CISCO-VLAN-North.

If a port belongs to an unnamed VLAN, eHealth determines whether the VLAN is configured on a local switch. If so, eHealth assigns the port to a group named CISCO- sysname-VLAN- vlanIndex, where sysname is the name of the local switch, and vlanIndex is the index of the VLAN. If the port belongs to an unnamed VLAN that is configured across multiple switches, eHealth assigns the port to a group named CISCO- VLAN- vlanIndex.

If these groups do not exist, eHealth creates them automatically.

yes

Enables discovery of Cisco Virtual LANs (VLANs) and automatically adds Cisco Catalyst switch ports and trunks to groups.

no

Disables discovery of Cisco VLANs and group creation.

Default: no

Cisco Naming - Use Legacy Names (NH_KEEP_OLD_CISCO_NAMES)

Uses legacy Cisco naming conventions when naming elements.

yes

Specifies legacy Cisco naming convention.

no

Specifies supported Cisco naming convention.

Default: no (recommended)



Cisco Naming - Use Local ifDescr (NH_DISC_LOCAL_IF_NAME)

Uses locIfDescr, if found in the Cisco OLD-INTERFACES-MIB, when naming elements.

yes

Uses locIfDescr.

No

Uses IfDescr.

Default: no

Cisco - Port MAC (EH_DISCOVER_CISCO_PORT_MAC)

Discovers PAUSE frames with the specified Cisco Port MAC.

yes

Enables discovery.

no

Disables discovery.

Default: no

Cisco QoS - Enable Queueing Discards (EH_CISCO_QOS_QUEUEING_DISCARD)

Specifies collection of discarded bytes and packets from queuing for classMap elements.

yes

Enables collection of discarded bytes and packets.

no

Disables collection of discarded bytes and packets.

Default: no

Cisco QoS - Name Scheme (NH_CISCO_QOS_NAME_SCHEME, EH_CISCO_QOS_NAME_SCHEME)

Uses the specified policyMap/classMap when naming elements. Works with the variable Cisco QoS Naming - Use PolicyMap, which must be set to yes to enable this behavior.

Values: The name of the tcl script that generates custom name of the elements

Default: blank



Cisco QoS Naming - Use PolicyMap (EH_CISCO_QOS_POLICYNAME)

Uses policyMap when naming Cisco QoS elements. By default, QoS elements do not include policyMap in the name because element names have a length limitation of 64 characters. Using policyMap may cause long names that get truncated, resulting in duplicate element names. Cisco QoS - Name Scheme provides an alternate mechanism for Cisco QoS naming.

yes

Enables use of policyMap in element naming.

no

Disables use of policyMap in element naming.

Default: no

Cisco QoS - Filter RED (EH_CISCO_QOS_RED_FILTER )

Prevents discovery of Cisco QoS RED elements.

yes

Prevents discovery of RED elements.

no

Discovers RED elements.

Default: yes

Cisco QoS - RED DSCP Value (EH_CISCO_QOS_RED_IP_VALUE)

Discovers Cisco QoS RED elements with the specified DSCP value.

Values: Any DSCP value.

Default: blank

Cisco QoS - Use ifSpeed (NH_CISCO_QOS_IFSPEED)

Specifies use of ifSpeed for Cisco QoS Default classMap elements if the current speed is 0.

yes

Uses ifSpeed.

no

Does not use ifSpeed.

Default: no



Cisco QoS - Name Scheme (NH_CISCO_QOS_NAME_SCHEME, EH_CISCO_QOS_NAME_SCHEME)

Uses the specified policyMap/classMap when naming elements. Works with the variable Cisco QoS Naming - Use PolicyMap, which must be set to yes to enable this behavior.

Values:

Default: blank

Cisco QoS - Use Speed from MTF (NH_CISCO_QOS_NO_OVERRIDE_SPEED)

Uses speed from MTF for Cisco QoS elements instead of the usual global speed value assigned by Discover.

yes

Assigns MTF speed.

no

Assigns global speed.

Default: no

Cisco RAS - Discover Async Modems (EH_CISCO_RAS_PPP)

Discovers asynchronous modems on Cisco RAS devices. Cisco RAS devices can contain hundreds of modems, which can cause excessive SNMP traffic to the device.

yes

Enables reporting on individual modems.

no

Ignores the asynchronous modems to avoid excessive SNMP traffic to the device.

Default: no

Custom Discover Modules (NH_DISCOVER_MODES_PLUS)

Lets you specify a list of custom discover modules to be used.

Note: For more information, see the Professional Services Finder Extension document.

Values: One or more custom discover modules.

Default: blank



Discover - Assign Parent Discover Key (NH_DISCOVER_UNIQ_BY_PORT)

Assigns a unique nmsId attribute value to parent elements. The Server element should not have any discovery key.

yes

Assigns nmsId attribute to parent elements.

no

Leaves nmsId attribute blank for parent elements.

Default: no

Discover 802.5 (NH_DISCOVER_DOT5_OVERRIDE_MIB2)

Discovers Token Ring ports as IEEE 802.5 interfaces instead of as Token Ring elements.

yes

Enables discovery as 802.5 interfaces.

no

Enables discovery as Token Ring elements.

Default: no

Discover - Filter ATM (NH_DISCOVER_ATM_DISABLED)

Prevents discovery of Asynchronous Transfer Mode (ATM) virtual paths or circuit elements.

When you discover devices as ATM devices (rather than LAN/WAN), eHealth uses an ATM MIB Translation File (MTF).

yes

Prevents the discovery of ATM path and circuit elements.

no

Enables the discovery of ATM path and circuit elements.

Default: no

Discover - Filter Frame Relay (NH_DISCOVER_FR_DISABLED)

Specifies discovery of Frame Relay elements during a LAN/WAN discovery.



Discovering Frame Relay elements can provide data about the overall health of the Frame Relay connections (permanent virtual circuits, PVCs).

yes

Disables discovery of Frame Relay elements.

no

Enables discovery of Frame Relay elements.

Default: no

Discover IfAdmin DOWN (NH_IGNORE_ADMIN_DOWN)

Discovers interfaces in an administratively DOWN state.

yes

Enables discovery.

no

Prevents discovery.

Default: no

Discover - Ignore SNMP Errors (NH_DISCOVER_IGNORE_ERROR)

Ignores SNMP errors during discovery.

Use this variable when discovering large, complex devices that may be difficult to discover, such as Cisco Catalyst switches to prevent complete failure to discover elements when some errors are seen.

yes

Ignores the errors and continues the discover process.

no

Terminates the discover process for this device on the first SNMP error.

Default: no

Discover IP Multicast Interfaces (EH_DISCOVER_MULTICAST_IF)

Discovers IP multicast interface ( Multicast Routing Interface and Multicast IGMP Interface).

yes

Enables discovery.

no

Disables discovery.

Default: no



Discover IP Multicast Subsystems (EH_DISCOVER_MULTICAST)

Discovers IP Multicast Subsystem and Multicast Source Group elements.

yes

Enables discovery.

no

Disables discovery.

Default:

Discover - MIB2 Override All (NH_DISCOVER_MIB2_OVERRIDE_ALL)

Uses statistics from ifTable whenever available.

yes

Discovers statistics from ifTable.

no

Does not discover statistics from ifTable.

Default: no

Discover - MIB2 Override 802.3 (NH_DISCOVER_MIB2_OVERRIDE_DOT3)

Discovers statistics from ifTable rather than from 802.3 table.

yes


no

Discovers statistics from 802.3 table.

Default: no

Discover - MIB2 Override RMON (NH_DISCOVER_MIB2_OVERRIDE_RMON)

Discovers statistics from ifTable rather than from RMON table.

yes


no

Discovers statistics from RMON Table.

Default: no




Discover - MIB2 Full-Duplex Override All (NH_DISCOVER_MIB2FD_OVERRIDE_ALL)

Discovers full-duplex statistics from ifTable whenever available.

yes

Discovers Full Duplex statistics from ifTable.

no

Does not discover Full Duplex statistics from ifTable.

Default: no

Discover Operationally DOWN Interfaces (NH_DISCOVER_OPER_DOWN)

Discovers interfaces whose operational status (operstatus) is DOWN.

yes

Enables discovery of operationally DOWN interfaces.

no

Prevents discovery of operationally DOWN interfaces.

Default: not defined

Naming - Use ifAlias Name (NH_DISCOVER_IFALIAS_NAME)

Uses ifAliasName when naming elements.

1

Uses ifAlias value for ifDescr.

2

Uses ifAlias value for alias.

3

Uses a modified version of ifAliasName.

4

Uses ifAlias value for alias.

5

Uses ifAlias for userString.

Note: The values for 2 and 4 are the same - you can use either.

Default: 0

Discover - Use ifIpAddress (NH_DISCOVER_IF_IP_ADDR)

Sets the element ipAddr attribute to the ifIpAddress value.


When the value is yes, eHealth retrieves an IP address from ipAddressTable and assigns it to the interface. As a result, eHealth polls the interface at this IP address, not the device/agent IP address.

When the value is no, eHealth assigns the IP address used to discover an interface to that interface. As a result, eHealth polls the entire device at the same IP address.

yes

Enables discovery and polling of interfaces by the polled IP address of the device.

no

Enables discovery and polling of interfaces by the interface IP address.

Default: no

DLCI - Use ifSpeed (NH_DLCI_IFSPEED)

Uses ifSpeed for DLCI element speed.

yes

Uses ifSpeed.

no

Does not use ifSpeed.

Default: no

DNS Lookup by ifIpAddress (NH_NAME_DNS_VIA_IP)

Specifies whether DNS lookup will be done by interface IP address.

yes

Performs DNS lookup by interface IP address.

no

Does not perform DNS lookup by interface IP address.

Default: no

Filter Dialer Interfaces (NH_IGNORE_DIALER_IF)

Specifies whether Dialer interfaces will be discovered.

yes

Disables discovery.

no

Enables discovery.

Default: no



Frame Relay - Use Frame Relay Table (NH_INIT_FR_TABLE)

Specifies discovery of Frame Relay statistics instead of ifTable statistics.

yes

Discovers Frame Relay statistics.

no

Discovers ifTable statistics.

Default: no

Group Automatically (EH_DISCOVER_AUTO_GROUP)

Lets you generate groups automatically for certain element types such as MPLS, IP Multicast, and VPN.

yes

Generates groups automatically.

no

Does not generate groups automatically.

Default: no

IBM - Use Agent IP and Port (EH_DISCOVER_IBM_LPAR_IP)

Append agent IP address and port to uniqueDeviceId attribute if the device contains a link of type ipaqenet (22).

yes

Modifies uniqueDeviceId attribute with IP address and port.

no

Does not change default setting of uniqueDeviceId attribute.

Default: no

Juniper - Discover ERX Logical Interfaces (EH_DISCOVER_ERX_LOGICAL)

Discovers Juniper ERX logical interfaces.

yes

Enables discovery.

no

Disables discovery.

Default: no



Juniper - Discover ERX Virtual Routers (EH_DISCOVER_ERX_VIRTUAL_ROUTER)

Discovers Juniper ERX virtual routers.

yes

Enables discovery.

no

Disables discovery.

Default: no

Juniper - Discover Firewalls (NH_DISCOVER_JUNIPER_FIREWALL)

Discover Juniper proxy-based Internet Firewall client, endpoint, and application elements.

yes

Discovers Juniper Firewall statistics.

no

Does not discover Juniper Firewall statistics.

Default: no

MPLS - Discover VPN VRF (NH_DISCOVER_MPLS_VPN_VRF)

Discovers MPLS VPN VRF elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Naming - Use Alternate Alias Scheme (NH_ALT_ALIAS_SCHEME)

Specifies the tool command language (TCL) script that eHealth uses to assign alias names during discovery.

Values: Any valid TCL script.

Naming - Use Alternate Name Scheme (NH_ALT_NAME_SCHEME)

Specifies the tool command language (TCL) script that eHealth uses to name elements during discovery.

Values: Any valid TCL script.



Naming - Use DNS (NH_USE_NAME_SRVC)

Uses domain naming system (DNS), or custom value from file, rather than sysName when naming elements.

DNS

Uses DNS when naming elements.

file

Uses the specified file when naming elements.

no

Uses default element naming based on sysName.

Default: no

Naming - Use ifDescr (NH_DISCOVER_IF_DESCR_IN_NAME)

Uses ifDescr when naming elements.

yes

Enables use of ifDescr.

no

Uses default naming rules.

Default: no

Naming - Use ifIpAddress (NH_NAME_IF_ADDR)

Specifies whether the discover process uses the interface table address or the polled address of a device for element names.

yes

Uses interface address.

no

Uses polled address.

Default: yes

Naming - Use ifName (EH_DISCOVER_IF_NAME)

Specifies use of ifName from ifMIB when naming elements.

yes

Uses ifName.

no

Does not use ifName.

Default:



Naming - Truncate by Regular Expression (NH_NAME_SRVC_PAT)

Specifies a regular expression to determine the part of the element name to truncate when maximum name length is exceeded.

NetScout - Discover RMON2 Distribution Entries (NH_DISCOVER_RMON2_PROTO_DIST)

Discovers NetScout RMON2 distribution entries as LAN/WAN elements. Currently, this variable only applies to NetScout probes or NetScout original equipment manufacturer (OEM) probes.

When this variable is set to yes, eHealth discovers RMON2 probes, their interfaces, their interface speeds, and their traffic by protocol. Each discovered interface/protocol pair consumes a poller license and appears in the poller configuration.

During a poll, eHealth collects data from the Protocol Distribution Group tables in the probe. This data includes packets and octets for each protocol. The line speed is derived from the probe interface speeds.

During discovery, database configuration information (DCI) rules can filter out unwanted protocols. Discovered probe/interface protocol elements can be grouped on individual probes and/or across multiple probes to support each users reporting needs. The most useful reports for this data are the Top N and Trend reports.

Note: Setting this variable to yes could consume 50 to 100 licenses per probe. Before setting this variable to yes, make sure that you have enough poller licenses.

yes

Discovers RMON2 protocol distribution entries as LAN/WAN elements.

no

Does not discover RMON2 protocol distribution entries as LAN/WAN elements.

Default: no

Newbridge - ATM PVC Hourly Statistics (NH_DISCOVER_NB_ATMPVC_HR)

Specifies whether hourly ATM PVC statistic buckets should be used instead of 15 minute buckets.

yes

Uses hourly ATM PVC.

no

Uses 15 minute interval.

Default: no



Max Seed Addresses (NH_DISCOVER_ADDR_LIMIT_

(Internal) Specifies the maximum number of addresses to discover during a discover process based on specified IP patterns or seed file.

If you set this value to a very high number, the discover process may run out of memory and crash before it finishes. It is, therefore, best to run the discover process several times on smaller ranges.

Values: Any non-negative integer.

Default: 100,000

Ports - Application (NH_DISCOVER_APPLICATION_PORTS)

Specifies additional UDP destination ports on which to discover application elements.

Values: A space-separated string of port numbers.

Default: 1691

Allow Broadcast IP Addresses (NH_DISCOVER_BROADCAST_IP_ADDRS)

Discovers possible broadcast IP addresses.

yes

Enables discovery.

No

Disables discovery.

Default: no

ICMP Ping – Disable (NH_DISCOVER_DISABLE_PING)

Specifies that the discover process does not ping addresses before sending SNMP packets.

You can use this variable to enable discovery of elements behind a firewall.

When this variable is set, you can also clear the setuid bit on the executable file nhiDiscover.

yes

Causes discover to send SNMP packets without first pinging the address.

no

Sets the discover process to ping addresses before sending SNMP packets.

Default: no



DCI Rule File (NH_DISCOVER_FILTER_FILE)

Specifies the DCI rule file to be used for filtering prior to merging discovered elements.

Values: File name for the rules file you want to use to filter discovery results.

Default: blank

Note: For more information about rules files, see the eHealth Data Integration Guide.

Ports - All (NH_DISCOVER_PORTS)

Specifies the UPD destination ports that the eHealth discover process checks for Simple Network Management Protocol (SNMP) agents when it discovers elements.

Values: A space-separated string of port numbers. 161 is the standard SNMP agent port.

Default: 161

The discover process checks all of these ports on each IP address for agents. This process can, therefore, impede discovery if the setting includes a large number of ports.

Empire – Process Args Match (NH_DISCOVER_PSARGS_MATCH)

Generates processSet elements if at least one process exists and the arguments match.

Yes

Discovers processSet elements with limited process matches.

No

Requires full set of existing processes to create processSet elements.

Default: no

Ports - Response (NH_DISCOVER_RESPONSE_PORTS)

Specifies the additional UDP destination ports that the eHealth discover process checks for SNMP agents when it discovers response elements.


Default: 1691 7000

Retries (NH_DISCOVER_RETRIES)

Specifies the number of times that the discover process requests a response from a device for ICMP ping and SNMP requests.



This parameter is useful in enabling discovery of devices on slow networks. You can use this parameter and the Timeput parameter to limit the number of times and amount of time that eHealth spends discovering devices.

The discover process checks all ports on each IP address for agents. This process can, therefore, impede discovery if the setting includes a large number of retries.

Values: 1 to any positive integer.

Default: 2

Port - System (NH_DISCOVER_SERVER_PORTS)

Specifies the additional UDP destination ports that the eHealth discover process checks for SNMP agents when it discovers system elements.


Default: 1161 1691 6665

SNMP v2C (NH_DISCOVER_SNMPV2C_ONLY)

Uses SNMP v2c format requests if a response is not received from an SNMP v1 request for Discover.

Yes

Attempts an SNMP v2c request if a response is not received from the SNMP v1 request.

No

Uses only SNMP v1 when discovering devices.

Default: no

Timeout (NH_DISCOVER_TIMEOUT)

Specifies the time (in seconds) that the discover process waits for an ICMP ping response and an SNMP response from a device.

SNMPv3 elements may take longer to discover than other types of elements. If you experience problems discovering SNMPv3 elements, increase the default timeout setting for these elements.

This parameter lets administrators adjust discovery settings on slow networks. The time may be affected by system traffic.

You can use this parameter and the Retries parameter to limit or increase the number of times and amount of time that eHealth spends discovering devices.

Values: 1 to any positive integer

Default: 1 second



Update Community Strings (NH_DISCOVER_UPDATE_COMM_STR)

Forces the update of community strings when discovering from a seed file.

yes

Updates the community string.

no

Does not update the community string.

Default: no

Note: For instructions on running a discover based on an IP address file and specifying community strings, see the eHealth Administration Guide.

Update IP Addresses (NH_DISCOVER_UPDATE_IPADDR)

Forces the update of IP addresses when discovering from a seed file.

yes

Updates the IP addresses.

no

Does not updates the IP addresses.

Default: no

Note: For instructions about running a discover based on an IP address file, see the eHealth Administration Guide.

Find MIB2 LANs (NH_FIND_MIB2_LANS)

Enables discovery of MIB2 based LAN/WAN elements.

Set this parameter to discover MIB2 LANs only when you want to discover interfaces such as specific IP addresses of routers on your network. Otherwise, eHealth could discover devices such as printers and fax machines that also support MIB2 but that you probably do not want to poll or include in reports.

yes

Discovers MIB2 LANs.

no

Does not discover MIB2 LANs.

Default: no

Note: For more information, see the eHealth Administration Guide.

Max Finder Processes (NH_FINDER_PROC_LIMIT)

Specifies the number of concurrent Finder processes to use during Discover.



If you have a high-performance eHealth system, you may want to increase the number of devices that eHealth discovers simultaneously. However, increasing the value of this variable can impair system performance.

Values: 1 to 20

Default: 4

NMS Source Name (NH_NMS_SOURCE)

Assigns the specified value to the nsmSource attribute for all discovered elements.

Default: NH:Discover

ICMP Ping Packet Size (NH_POLL_PING_PKTSIZE)

Specifies the number of bytes to use for ICMP Ping tests.

Values: Positive integer up to 2^16

Default: 100

Nortel - Discover VLAN and Group (NH_DISCOVER_NORTEL_VLAN_GROUPS )

Discovers Nortel VLAN elements and automatically creates VLAN groups.

yes

Enables discovery.

no

Disables discovery.

Default: no

Nortel Naming - Use Contivity IP Address (NH_DISCOVER_CONTIVITY_IP)

Uses the Nortel Contivity Interface IP address when naming elements.

yes

Uses the Nortel Contivity Interface IP address.

no

Does not use the Nortel Contivity Interface IP address.

Default: no

Packeteer - Discover Traffic Classes and Partitions (NH_DISCOVER_PACKETEER_DEFAULT)

Discovers Packeteer traffic classes and partitions as LAN/WAN elements.



For information about selecting uni-directional or bi-directional traffic classes, see Packeteer - Discover Uni-Directional Interfaces.

yes

Enables discovery.

no

Disables discovery.

Default: no

Packeteer - Discover Uni-Directional Interfaces (NH_DISCOVER_PACKETEER_TC_1WAY)

Discovers traffic classes that are flowing one way on either an INSIDE or OUTSIDE partition, and discovers bi-directional partitions as two uni-directional WAN elements.

By default, eHealth discovers traffic classes that are GLOBAL or that reside both INSIDE and OUTSIDE of partitions; these classes are referred to as bi-directional traffic classes. It ignores one-way traffic classes residing either on the INSIDE or the OUTSIDE partition; these classes are referred to as uni-directional traffic classes.

yes

Discovers uni-directional traffic classes and discovers INSIDE, OUTSIDE, and application partitions as uni-directional WAN elements.

no

Discovers GLOBAL, INSIDE, and OUTSIDE partitions.

Default: no

QoS - Discover Associations (NH_DISCOVER_QOS_ASSOCIATIONS)

Creates a device type association from the LAN/WAN element to the QoS Integrated element. Use this parameter if the device is discovered under both LAN/WAN and QoS modes.

yes

Creates an association.

no

Does not create an association.

Default: no

QoS - Discover In-Contract (NH_DISCOVER_QOS_MATCH_NAME_IN_CONTRACT)

Discover In-Contract Quality of Service (QoS) and Class of Service (CoS) elements.



In addition to defining the QoS - Discover In-Contract and QoS - Discover Out-of-Contract variables, you must define QoS match statement values on the router.

eHealth discovers and creates a QoS CoS Contract element when all of the following statements are true:

■ The value of QoS - Discover In-Contract matches one of the routers QoS match statement values.

■ The value of QoS - Discover Out-of-Contract matches another of the routers QoS match statement values.

Valid statistics exist for the two objects associated with the QoS match statements.

yes

Discovers in-contract QoS and Cos elements.

no

Disables discovery of in-contract QoS and CoS elements.

Default: no

QoS - Discover Out-of-Contract (NH_DISCOVER_QOS_MATCH_NAME_OUT_OF_CONTRACT)

Discover Out-of-Contract Quality of Service (QoS) and Class of Service (CoS) elements.

In addition to defining the QoS - Discover In-Contract and QoS - Discover Out-of-Contract variables, you must define QoS match statement values on the router.

eHealth discovers and creates a QoS CoS Contract element when all of the following are true:

■ The value of QoS - Discover In-Contract matches one of the routers QoS match statement values.

■ The value of QoS - Discover Out-of-Contract matches another of the routers QoS match statement values.

Valid statistics exist for the two objects associated with the QoS match statements.

yes

Discovers out-of-contract QoS and Cos elements.

no

Disables discovery of out-of-contract QoS and CoS elements.

Default: no



QoS - Group (NH_DISCOVER_QOS_GROUPS)

Generates groups automatically for QoS elements.

yes

Enables automatic creation of QoS Groups.

no

Disables automatic creation of QoS Groups.

Default: no

Router/Switch Minimum Ports (NH_DISCOVER_MIN_SW_PORTS)

Discovers devices with at least this many ports as routers.

Values: 1 to any integer.

Default: 5

Shasta Naming - Omit Discover Key (NH_DISCOVER_SHASTA_KEY)

Omits the nmsId value when naming Shasta elements.

yes

Omits the nmsId value.

no

Includes the nmsId value.

Default: no

Switch Discovery Mode (NH_DISC_SW_MODE)

Sets the discovery mode for switch elements.

When eHealth discovers a switch that is a supported Plus device, it creates the switch element, its interfaces, the backplane, and the CPU. If it discovers an existing traditional switch, it simply adds the backplane and CPU elements.

Before you rediscover a Plus switch as a Lite switch, you must first delete it from your poller configuration.

Note: If you do not delete existing Plus switches before rediscovering them as Lite switches (and vice versa), eHealth aggregates the statistics from the interface and the backplane, resulting in inflated total statistics for the switch.

plus

Sets the discover process to discover switches as switch Plus devices.

lite

Sets the discover process to discover switches as switch Lite devices.



Default: plus

Note: For more information, see the eHealth Administration Guide.

System - Discover Partitions (NH_FIND_SYS_PARTITIONS)

Discovers systems partitions on system elements.

When this variable is set to yes, it enables the discover process to determine that a partition that has the name / (slash) is a system partition and that it will map to the correct MTF.

yes

Enables discovery.

no

Disables discovery.

Default: yes

System - Store Process Statistics (NH_STORE_PROCESS_DATA)

Store statistics for individual system process elements.

yes

Stores statistics to the database for reporting on individual process elements.

no

Stores only aggregated statistics for processSet elements.

Default: no

Traffic Accountant - Max IP Addresses in View (NH_MAX_IP_ADDRS)

Specifies the maximum number of IP addresses in a Traffic Accountant view created by IP address range or by subnet address and mask.

Default: 1000000

Support – SNMP Log File Path (NH_SNMP_TEST_FILE)

(Internal) Specifies the name of SNMP debug log file. This file stores the information collected by the Support - SNMP Enable Logging parameter.

Values: Pathname of the SNMP file.

Default: /opt/eHealth/log/advanced

Support – SNMP Enable Logging (NH_SNMP_TEST_MODE)

(Internal) Enables SNMP requests and responses debug logging.



yes

Enables logging.

Default: blank

Tylink - Create Aggregate Elements (NH_TYLINK_AGG)

Creates an aggregate element for each DTE/DSU pipe if any value is defined. Default behavior is that no pipe will have an MIB-2 element, in addition to the 2 (or 3) elements for each PVC in the pipe.

yes

Creates the aggregate elements.

no

Does not create aggregate elements.

Default: no

Tylink - Create Bi-Directional Elements (NH_TYLINK_INOUT)

Creates bi-directional elements for each Tylink PVC in addition to uni-directional elements that are normally created.

Default behavior is that only the two elements (separate "in" and "out") are ever generated.

Value: Any value.

Default: Only uni-directional elements (separate "in" and "out") are generated.

Tylink - Create DLCI 0 Elements (NH_TYLINK_LMI_0)

Creates DLCI 0 elements for each Tylink FRAP.

Value: Any value. 1 skips the discovery of DLCI elements with index 0. Any other value enables the discovery.

Default: 1

Tylink - Create DLCI 1023 Elements (NH_TYLINK_LMI_1023)

Creates DLCI 1023 elements for each Tylink FRAP.

Value: Any value. 1 skips the discovery of DLCI elements with index 1023. Any other value enables the discovery.

Default: 1



Xedia - Discover Traffic Classes (NH_XEDIA_TRAFFIC_CLASS)

Discovers Xedia traffic class elements.

yes

Enables discovery.

no

Disables discovery.

Default: no

Xedia - Discover Traffic Class Root (NH_XEDIA_TRAFFIC_CLASS_ROOT)

Enables discovery of class root elements and includes root in the name.

yes

Enables discovery.

no

Disables discovery.

Default: no


Chapter 3: Environment Variables

This section contains the following topics:

About Environment Variables (see page 411)

About Environment Variables The eHealth system supports environment variables that you can use to specify and control eHealth processes and operations. This section describes how to modify environment variables on UNIX and Windows systems, and then describes each of the eHealth environment variables, their default values, and other valid values.

The environment variables are grouped by type and listed in alphabetical order within each group. All topics use UNIX-style pathnames to describe directory locations, for example, ehealth/bin (where ehealth represents the eHealth installation directory).

All integer variables have upper limits, even if their valid values are described as any non- negative integer. The maximum integer value depends on your system. Use the default values as a guideline for reasonable settings for those variables.

Set Environment Variables on Windows Systems

On a Windows system, eHealth sets environment variables as system variables; whenever you change a setting, you must stop and restart the eHealth server to enable the new settings. If you are running scheduled processes, you must also stop and restart the eHealth service.

After you set the environment variables, you must apply the settings in order for them to take effect.

Set a Variable on a Windows NT System

To set a variable on a Windows NT system

1. Select Start, Settings, Control Panel.

2. Double-click System.

3. In the System Properties dialog box, select the Environment tab.

Chapter 3: Environment Variables 427

About Environment Variables

4. To modify a variable, do the following:

a. Under System Variables, select the variable from the list.

b. Enter its new value in the Value field for the variable. To specify multiple values, separate each value with a space.

c. Click Set.

5. To add a new variable, do the following:

a. Select any variable under System Variables.

b. In the Variable field, replace the name of the existing variable with the name of the variable that you want to define.

c. You must change the name in the Variable field to avoid modifying an existing variable (instead of creating a new one).

d. Specify a value in the Value field for the variable. To specify multiple values, separate each value with a space.

e. Click Set.

6. Click OK in the System Properties dialog box.

Set a Variable on a Windows 2000 System

To set a variable on a Windows 2000 system

1. Select Start, Settings, Control Panel.

2. Double-click System.

3. In the System Properties dialog box, click the Advanced tab.

4. Click the Environment Variables button.

5. Under System variables, do one of the following:

a. To modify a variable, select the variable in the list and click Edit. In the Edit System Variable dialog box, modify the variable value and click OK.

b. To add a variable, click New. In the New System Variable dialog box, enter a variable name and value, and click OK.

6. Click OK in the Environment Variables dialog box.

7. Click OK in the System Properties dialog box.



Apply New Environment Variables Settings

To apply new environment variable settings

1. Stop the eHealth server and console, or Web interface, whichever the environment variables affect.

2. Check the console and the console messages to see if any eHealth processes or scheduled jobs are running. If jobs are running, wait until they finish.

3. Open the Services dialog box:

a. On Windows NT, select Start, Settings, Control Panel. Double- click Services.

b. On Windows 2000, select Start, Settings, Control Panel. Double- click Administrative Tools. Double-click Services.

4. In the list of services, select eHealth (console) or eHealth httpdnn (web interface).

a. On Windows NT, click Stop; then Start.

b. On Windows 2000, right-click the eHealth service and select Restart from the shortcut menu.

5. Close the Services dialog box.

Set Environment Variables on UNIX Systems

This topic describes the files in which eHealth environment variables are defined, and explains how to define variables for eHealth processes and commands.

On a UNIX system, eHealth environment variables are defined in the following files:

File name Used by... To define settings for...

The eHealth software then reads...

nethealthrc.sh eHealth processes eHealth processes, including console, discover

nethealthrc.sh.usr

nethealthrc.csh UNIX system C- shell users, including the eHealth administrator

nethealtrc.csh.usr



The above files have the following characteristics:

■ They are overwritten during upgrades.

■ They each have a customizable .usr version that takes precedence over them.

The following customizable versions of these files take precedence, and they are not overwritten during upgrades:

File name Used by... To set variables for...

Takes precedence over...

nethealthrc.sh.usr

eHealth administrator

eHealth processes nethealthrc.sh

nethealtrc.csh.usr

eHealth administrator

Command- line sessions

nethealthrc.csh

To specify or change the value of an environment variable, you must modify the .usr version of the file. During software upgrades, eHealth preserves the variable definitions in the .usr files.

If you define a variable in both the nethealthrc.sh and nethealthrc.sh.usr files (or the nethealthrc.csh and nethealthrc.csh.usr files), the definition in the .usr file takes precedence. You can replace or override the settings for each variable in these files.

Define Variables for eHealth Processes

For variables that you use for command line processes, you need to source the nethealthrc.sh or nethealthrc.csh file to activate the new settings. For variables used by the eHealth persistent processes and services, you need to stop and restart the eHealth service. Use the following procedure to define an environment variable for eHealth processes on UNIX systems.



To set an environment variable for eHealth processes on a UNIX system

1. Using any text editor, open the nethealthrc.sh.usr file in the eHealth installation directory.

2. Do one of the following:

a. Look for an existing definition for the variable in the file. If you find one, modify the value of the variable.

b. If the variable is not already defined in the file, edit the nethealthrc.sh.usr file to define the variable, using either of the following formats:

VARIABLE=value; export VARIABLE

or

VARIABLE=value

export VARIABLE

Note: Do not add spaces between the variable name and its value.

VARIABLE is the name of the environment variable, and value is the setting. If value is a string, enclose it in double quotation marks (" ") unless otherwise instructed. If value is a string containing several values, separate each with a space within the quotation marks.

Note: The nethealthrc.sh.usr file and the nethealthrc.sh file use the same format conventions.

3. Save and close the file.

eHealth processes source the nethealthrc.sh and nethealthrc.sh.usr files when they run; therefore, your changes take effect immediately for processes that you run from the console.

However, processes that are already running do not use the new variables until you stop and restart the processes. For example, changes to a poller environment variable do not take effect until you stop and restart the eHealth server.

Define Variables for Commands

If you use the C shell and want the variable to be in effect for all commands that you run from the command line, specify your environment variables in the nethealthrc.csh.usr file.

If you are using the Bourne or Korn shell, set the variables in the nethealthrc.sh.usr file using the command format described in the “Define Variables for eHealth Processes.”



To set an environment variable in the nethealthrc.csh.usr file

1. Using any text editor, open the nethealthrc.csh.usr file in the eHealth installation directory.

2. Do one of the following:

a. If the variable is already defined in the file, modify the value as necessary.

b. If the variable is not already defined in the file, add a line to the nethealthrc.csh.usr file using the following format:

setenv VARIABLE value

VARIABLE is the name of the environment variable, and value is the setting. If value is a string, enclose it in double quotation marks (" ") unless otherwise instructed. To specify several values, separate each with a space within the quotation marks.

Note: For examples of how to specify variables in the nethealthrc.csh.usr file, see the nethealthrc.csh file. Both files use the same format conventions.

3. Save and close the file.

4. In your terminal window, source the nethealthrc.csh file to set your environment, where ehealth represents the eHealth installation directory:

source ehealth/nethealthrc.csh

When you source the nethealthrc.csh file, the nethealthrc.csh file sources the nethealthrc.csh.usr file.

Database Variables

This section describes variables that relate to the eHealth database.

NH_DB_DATA_DIR

(Internal) Defines the location of the initialization files for a new database.

This variable defines the directory that contains eHealth meta-data, such as Trend label tables, Live Exceptions profiles, and Traffic Accountant protocols. eHealth uses this variable only with database creation, loading, and conversion.

Values: Directory name.

Default: ehealth/db/data, where ehealth represents the eHealth installation directory.



NH_DB_DIR

(Internal) Defines the location of the eHealth database backup and initialization files.

This variable sets the parent directory for the NH_DIR and NH_DB_SAVE_DIR variables.

Values: Location of database backup and initialization files.

Default: ehealth/db, where ehealth represents the eHealth installation directory.

NH_DB_SAVE_DIR

(Internal) Defines the default location where eHealth saves databases during a database save process.

The NH_DB_DIR variable sets the parent directory for this directory.

Make sure you have enough disk space in this location to store the entire database.

Consult Technical Support or your Sales Engineer for detailed information on calculating database disk space requirements for your system.

Values: Location for saving databases.

Default: $NH_DB_DIR/save

NH_DB_SRV_PORT

(Internal) Defines the database server port number.

Note: Do not change this variable unless a port conflict occurs.

Values: Any port number.

Default: 5056

NH_DB_VERSION

(Internal) Defines the version number of the eHealth database.

The value is a combination of the eHealth release number and the Oracle database release number. Use this variable to fix database problems with version inconsistency.

Values: Current eHealth release and database revision. For example, the value 5.0:25 indicates Release 5.0 of eHealth and revision 25 of the database schema.

Default: eHealth Release:DatabaseRevision

NH_HOURLY_HEALTH_NUM_WEEKS

(Internal) Specifies the default number of weeks for which eHealth stores hourly health data.



This variable enables preservation of database space. The Data Analysis process caches calculations once each night. These bits of data are used to populate the Health and Service Level reports. Most of those calculations are kept for the number of weeks dictated in the Data Analysis scheduled job. One set of calculations (Health Index by Hour) is used by only one chart in the Health report. This is the widest row in the database schema.

Keep this cached data for more than one week only if you need to run a Health Report for a day that was prior to one week ago and you want to display the data in this chart.


Default: 1

NH_ORACLE_HOME

Specifies the location of the eHealth RDBMS (Oracle), using a UNIX-style path (with forward slashes).

In eHealth Release 5.5, this variable was named ORACLE_HOME.

Values: A valid directory and path.

Default: The path specified during the installation of eHealth (for example, D:/oracle/oracle.9.2)

NH_ORACLE_HOME_NEW

Specifies the location of Oracle for the new release of eHealth (during an upgrade or migration of the software).

For a new eHealth installation, NH_ORACLE_HOME_NEW and NH_ORACLE_HOME_OLD should refer to the same Oracle directory.

For an upgrade, NH_ORACLE_HOME_NEW should refer to the new Oracle directory and NH_ORACLE_HOME_OLD should refer to the previous Oracle directory.


NH_ORACLE_HOME_OLD

Specifies the location of Oracle for the prior release of eHealth (during an upgrade or migration of the software).

For a new eHealth installation, NH_ORACLE_HOME_OLD and NH_ORACLE_HOME_NEW should refer to the same directory.

For an upgrade, NH_ORACLE_HOME_OLD should refer to the previous Oracle directory and NH_ORACLE_HOME_NEW should refer to the new Oracle directory.




NH_ORACLE_HOME_OS

Specifies the location of the eHealth database for use by the eHealth database administrator utilities.

The eHealth installation sets this environment variable. Do not change this variable.

On UNIX systems, this variable has the same value as NH_ORACLE_HOME. On Windows systems, this variable points to the same path as NH_ORACLE_HOME, but it uses Windows-style slashes (\ instead of /).


NH_ORACLE_MAX_CORRUPT_BLKS

(Internal) Specifies the number of corrupt disk blocks to allow in the eHealth database when saving it using the nhDbSave command.

Use this variable in the rare case where a database has developed some corrupted blocks and they cannot be fixed by Technical Support or the customer.

Normally, the nhDbSave and nhDbLoad commands fail if they encounter any corrupt blocks. Setting this environment variable the specified number of corrupt blocks to be seen.

Values: Any integer.

Default: 0

NH_ORA_LISTENER_NAME

Specifies the name of a custom Oracle listener.

High availability solutions require non-default listener names. The nhDbStop and nhDbStart commands accept the - listenerName option, which overrides the default listener name.

Values: Any valid Oracle listener name.

Default: LISTENER

NH_RDBMS_NAME

Specifies the name of the eHealth database.

The eHealth installation defines this variable using the database name that you enter during the installation process.

If you change this variable after you have collected and stored data, all new data will be stored in the new database, and the old data will remain in the old database.

For Oracle installations, this variable must match the value of the Oracle-specific variable ORACLE_SID.



Values: anyName

Default: EHEALTH

ORACLE_SID

Specifies the name of the Oracle instance, which is also the name of the eHealth database.

This environment variable is defined during the installation of eHealth.

Values: Eight characters or less, beginning with a letter. It can consist of uppercase letters (AZ) and numbers (09).

Default: EHEALTH

Debugging Variables

This section describes variables for debugging eHealth.

Note: Set the debugging variables only under the direction of Technical Support.

DEBUG_CERT

(Internal) Displays alarm rule certification data to standard output while it is being loaded into the NH_ALARM_RULE database table.

The Certification and Quality Assurance teams use this environment variable to ensure that their specialized releases do not overwrite Live Exceptions data.

off

Disables alarm rule data display.

on

Enables alarm rule data display.

Default: blank

NH_DBG_FLAGS

(Internal) Sets the list of debugging flags to enable, indicating the types of debugging information to provide. Set this variable only as directed by Technical Support.

Setting this variable enables debug mode. You can save the debugging output by setting the NH_DBG_OUTPATH variable.

Note: Debug mode can significantly slow the performance of the eHealth application.



Values and type of debugging information:

■ c-Communication messages

■ C-Data with communication messages

■ d-Major debug

■ D-Data with major debug

■ e-Error utility

■ i-Initialization

■ I-Data with initialization

■ o-Add 'module/routine' to output messages

■ O-General debug for output message display

■ m-Memory management

■ M-Data with memory management

■ r-X resources

■ R-Data with X resources

■ t-Major trace (primary methods/routines)

■ T-Minor trace (internal methods/routines)

■ u-UI callbacks, updates

■ U-Data with UI callbacks, updates

■ x-X events (mouse, resize)

■ X-Data with X events

■ z-Minor debug

■ Z-Data with minor debug

Default: blank

NH_DBG_MODULES

(Internal) Defines the list of debugging modules to enable. Set this variable under the direction of Technical Support.

Setting this variable enables debug mode. You can save the debug output by setting the NH_DBG_OUTPATH variable.

Note: Debug mode can significantly impede the performance of the eHealth application.



Values and debugging mode:

■ cba-C++ Base Application Library

■ ccm-C++ Communications Library

■ cdb-Database Library

■ cdm-C++ Data Model Library

■ cdt-C++ Data Types Library

■ clc-Cluster Utilities

■ cos-C++ OS Library

■ csm-C++ System Messages Library

■ cst-C++ Simple Types

■ cu-C++ Util Library

■ dbg-Debug Utility

■ ddi-DDI Library

■ ddt-CDF Data Types Library

■ dsvr-Database Server

■ du-Database Utility Library

■ esd-Element Service Data Library

■ ex-Exceptions

■ fsa-FSA Library

■ he-Health Engine

■ jml-jm Library

■ lcn-Licensing Support

■ liveex-Live Exceptions

■ lmgr-License Manager

■ lut-Live Exceptions Utilities

■ mhd-MyHealth Subsystem

■ ndm-Networking Data Model Library

■ ndt-Networking Data Types Library

■ nhw-nhWeb

■ om-Object Model Library

■ omd-Object Model DB IF Library

■ rdf-Report Definition File Library

■ ru-Report Utils Library



■ slr-Statistics Report Library

■ sps-Startup Server

■ sre-Standard Report Engine

■ sde-Statistics Data Engine

■ tb-Trace Utility

■ wsc-WS Core Library

■ poller-Poller applications

■ dci-Database Configuration Interface

■ snmp-SNMP library for Discover, Pollers, and Notifier

■ csvr-Configuration Server

■ ts-Trap Server

Default: blank

NH_DBG_OUTPATH

(Internal) Lets you redirect debug output for eHealth programs from standard error (stderr) and standard output (stdout) to a specified directory.

When debug data is generated from NH_DBG_FLAGS and NH_DBG_MODULES, eHealth saves the debug output in the directory specified in this variable.

The file name indicates the eHealth program that generates the debug output. For example, for the poller, the file name is nhiPoller_<poller type>.txt. For standard reports (At-a-Glance, Trend, Health, or SLR), the file name is nhiStdReport_dbg.txt.


Values: An existing directory to contain the log file. For example: ehealth/log/dbg, where ehealth represents the eHealth installation directory.

If the specified directory does not exist, eHealth writes the debug output to a file of that name. For example, if you define NH_DBG_OUTPATH as $NH_HOME/log/dbg and this directory does not exist, eHealth sends the debug output to the file $NH_HOME/log/dbg.

blank

Indicates that the debug information appears on the screen (standard output) and is not saved in a log file.

Default: blank, indicating that debug output for eHealth programs goes to standard error (stderr) and standard output (stdout).



NH_DBG_SCRIPTS

(Internal) Enables or disables debug tracing.


on

Enables debug tracing.

off

Disables debug tracing.

Default: on

NH_DBG_STARTUP

(Internal) Enables or disables Windows server debugging. This environment variable is equivalent to the following command:

nhiServer.exe -Dall -Dt start

Since a Windows Service does not have terminal output, you must use NH_DBG_STARTUP with the NH_DBG_OUTPATH variable to direct the output to a directory. Stop and restart eHealth for this variable to take effect.

on

Enables server debugging.

off

Disables server debugging.

Default: blank

NH_EXPOSE_PING_FOR_IP

(Internal) Exposes the results of PING tests to a specific Internet Protocol (IP) address.

Use this variable to debug poller ping issues, for example, when a customer believes that reported latency values for statistics elements are inaccurate.

Values: A valid IP address (the agent address of a network element that eHealth polls for statistics data)

Default: blank

To use this variable, do the following

1. Define NH_EXPOSE_PING_FOR_IP as the IP address to be tested.



2. Modify the $NH_HOME/sys/debugLog.cfg file to specify the following arguments for nhiPoller[Net]. eHealth stores this advanced log information in nhiPoller_Net.txt in the $NH_HOME/log/advanced directory.

-Dm cos -Df o

3. Stop the eHealth server.

4. Start the eHealth server.

5. Enable advanced logging for the statistics poller via the OCE interface.

6. Allow polling to occur for awhile.

7. Examine nhiPoller_Net.txt to analyze the advanced logging information regarding pings to the specified IP address.

8. When you are finished with the testing, disable advanced logging, remove the NH_EXPOSE_PING_FOR_IP variable, and edit debugLog.cfg to restore the original arguments.

Development Variables

This section describes variables that relate to eHealth software development. These variables are for internal use only.

NH_IMAGE_DIR

(Internal) Specifies an alternative location for the eHealth installation files (the kit). Set this variable only under the advice of Technical Support.

Use this variable when installing eHealth using a different version of INSTALL.NH from the one in the kit. You can use this variable if a special version of INSTALL.NH is required, in which case NH_IMAGE_DIR typically points to the directory where the CD-ROM is mounted.

Values: A valid pathname.

Default: blank

Distributed eHealth Variables

This section describes variables that relate to Distributed eHealth environments.

NH_CLUSTER_CMD_TIMEOUT

Specifies the time (in seconds) before which the cluster administration commands must complete processing. If they do not finish within this time, they fail with a timeout error message.



As a best practice, the value should be greater than 30 seconds but less than 600 seconds (10 minutes). A value of 300 seconds (5 minutes) is a typical default for clusters that use a virtual private network (VPN) that continually rebuilds connections and closes them after communication ceases.


Default: 30

For more information, see the section on timeout errors in the Distributed eHealth Administration Guide.

NH_COMPRESS_DLIVE

(Internal) Compresses data files for Distributed Live Health. Use it to resolve performance problems regarding slow links between cluster members and the Distributed eHealth Console.

Use NH_COMPRESS_DLIVE to help resolve performance problems for Distributed Live Health when network links in the cluster are slow. When you set NH_COMPRESS_DLIVE to yes on a Distributed eHealth System, it sends the binary response file for Live Health to the Distributed eHealth Console in a compressed format. When it receives the file, the Distributed eHealth Console identifies the file as compressed and uncompresses it before sending it to the Live Exceptions Browser on that system.

Note: Compressing and uncompressing the binary response files requires additional time; if the cluster is large and has many slow links, decompression of the files on the Distributed eHealth Console may further impede performance instead of improving it.

no

Does not compress data files for Distributed Live Health.

yes

Compresses data files for Distributed Live Health.

Default: no

NH_DB_DELETED_OBJECTS_TIME2KEEP

Specifies the number of hours to retain soft-deleted data.

Use this variable to override the value of the - deletedObjectHours argument of the nhScrubFsa command.

Values: Any number of hours.

Default: 168 (one week)

For more information, see the section on replication and soft deletion in the Distributed eHealth Administration Guide.



NH_DRPT_COMPRESS_RDI

Specifies whether the internal report data file sent by the Distributed eHealth System to a Distributed eHealth Console should be compressed.

The value for this variable must be the same on all cluster members. If your cluster members are connected over slow (less than T1 speed) links and your reports typically contain thousands of elements from a Distributed eHealth System, compressing the report data files decreases the time that it takes to send them to the Distributed eHealth Console. This can help to prevent timeouts that cause a distributed report to assume that the report data was lost and result in missing element messages in the report.The value for this variable must be the same on all cluster members. If your cluster members are connected over slow (less than T1 speed) links and your reports typically contain thousands of elements from a Distributed eHealth System, compressing the report data files decreases the time that it takes to send them to the Distributed eHealth Console. This can help to prevent timeouts that cause a distributed report to assume that the report data was lost and result in missing element messages in the report.

no

Disables compression of the internal report data file.

yes

Enables compression of the internal report data file.

Default: no

For more information, see the section on Distributed eHealth Console variables in the Distributed eHealth Administration Guide.

NH_DRPT_HEARTBEAT_INTVL

Specifies the interval (in seconds) between the heartbeat timer checks. This variable specifies how often the Distributed eHealth Console checks each Distributed eHealth System to make sure that it is still processing data for a distributed report.

This variable, in conjunction with the NH_DRPT_MISSED_MSG_LIMIT variable, can have a significant impact on report performance.

Values: 5 through 36000 seconds (ten hours).

Default: 60

For more information, see the sections on the heartbeat timer and Distributed eHealth Console variables in the Distributed eHealth Administration Guide.

NH_DRPT_MAINLOOP_INTVL

Specifies the interval (in seconds) at which the Distributed eHealth Console checks whether it has received new report data from one of the Distributed eHealth Systems involved in processing a report.



Values: 1 through 600 seconds (10 minutes)

Default: 1


NH_DRPT_MISSED_MSG_LIMIT

Specifies the number of heartbeat messages that can be missed (not responded to) before the Distributed eHealth Console assumes that the report request has timed out or failed on a Distributed eHealth System involved in the report.

This variable, in conjunction with the NH_DRPT_HEARTBEAT_INTVL variable, can have a significant impact on report performance.

Values: 1 to any valid integer.

Default: 2


NH_DRPT_RUN_CMD_TIMEOUT

Specifies the time (in seconds) to send a report request with a data specification information (DSI) file from a Distributed eHealth Console to a Distributed eHealth System.

The value should be greater than the value of NH_DRPT_STATUS_MSG_TIMEOUT and less than the value of NH_DRPT_HEARTBEAT_INTVL. To estimate this value, calculate the time that it takes to send a file of approximately 100 kilobytes (KB) from a Distributed eHealth Console to a Distributed eHealth System (using File Transfer Protocol, FTP).

Values: 3 to 2700 seconds (45 minutes)

Default: 45


NH_DRPT_STATUS_MSG_TIMEOUT

Specifies the time (in seconds) that the Distributed eHealth Console waits for a response to the heartbeat timer check from a Distributed eHealth System. If the timer expires without a response, eHealth considers the heartbeat check as a missed heartbeat message.

The value for this variable should be less than the value of the NH_DRPT_HEARTBEAT_INTVL.



Values: 2 to 1200 seconds (20 minutes)

Default: 30


NH_FSA_SCRUB_TTL

Specifies the number of hours to retain temporary FSA files left by the replication process.

Use this variable to override the value of the -fsaTtl argument of the nhScrubFsa command.

Values: Any number of hours.

Default: 4

For more information, see the section on replication and soft deletion in the Distributed eHealth Administration Guide.

NH_MAX_REPL_DRIVERS

(Internal) Defines the maximum number of replication drivers that eHealth uses to update group information across a Distributed eHealth cluster. Use this variable to avoid problems when adding, deleting, or modifying many groups or group lists at one time using the eHealth Database Configuration Information (DCI) interface.

When you add, delete, or modify groups or group lists (using the eHealth console, Web interface, or DCI), eHealth compares the number of groups or group lists involved to the value of this variable. If the number of groups is less than the variable value, eHealth replicates groups across the cluster by object ID; that is, eHealth replicates the changes to each group individually. If the number of groups is greater than the variable value, eHealth replicates groups across the cluster by object type.

If the system slows down after starting a DCI import of groups or group lists, use the following command to determine which eHealth processes are running:

ps -ef | grep nhi

If the resulting list includes a large number of nhiReplDriver processes, you may be importing fewer groups than NH_MAX_REPL_DRIVER specifies. To solve this problem, decrease the value of this variable to one less than the number of groups that you are importing with DCI.

If you are importing more groups than NH_MAX_REPL_DRIVER and the eHealth database already contains thousands of groups, increase the value of the variable. (This situation is uncommon.)

Values: 1 to any valid integer.

Default: 20



For more information, see the Distributed eHealth Administration Guide.

NH_RCS_CONNECT_TIMEOUT

Specifies the length of time, in seconds, that eHealth waits for the Remote Communication Service (RCS) connection to occur between an eHealth request (command, report, or other process) and a remote cluster member.

Transmission Control Protocol (TCP) connections also have a timeout value. If the TCP timeout is less than the value of NH_RCS_CONNECT_TIMEOUT, the TCP timeout value supersedes the RCS connection timeout.

Values: 1 to any non- negative integer.

Default: 5

For more information, see the section on RCS timeout errors in the Distributed eHealth Administration Guide.

NH_RCS_MSG_TIMEOUT

Specifies how long, in seconds, that the local system waits for acknowledgements to the messages that it sends to a remote cluster member.

If the message timeout expires before the local system receives an acknowledgement, eHealth displays an error message and closes the RCS connection with the remote system. eHealth waits for the time specified by NH_RCS_RETRY_QUEUE_TIME and then attempts to reestablish the RCS connection and resend the message.


Default: 5


NH_RCS_RETRY_QUEUE_TIME

Specifies how many seconds eHealth waits and then attempts to reestablish an RCS connection in order to resend a message to a remote cluster member. eHealth uses this variable after it closes an RCS message connection that has exceeded the value of NH_RCS_MSG_TIMEOUT.

The values that you specify for the NH_RCS_MSG_TIMEOUT and NH_RCS_RETRY_QUEUE_TIME variables could impact the application-level timeouts used for distributed reports and commands.

Values: 1 to any non-negative integer.

Default: 5




NH_REMOTE_CMD_TIMEOUT

Specifies how long (in seconds) a command started using nhRunCommand runs before it fails due to non-responding cluster systems.

If you change the default, be sure to select a value that is larger than the RCS timeouts.


Default: 300 (5 minutes)

For more information, see the section on how RCS timeouts affect application timeouts in the Distributed eHealth Administration Guide.

NH_REPL_MSG_TIMEOUT

Specifies the time in seconds that the replication server should wait for a response from another cluster members replication server.

By default, the eHealth replication server waits up to five minutes for a response from another cluster members replication server. Use this variable to override the server default.


Default: 300 (5 minutes)


NH_RFT_BLOCK_SIZE

(Internal) Controls the block size (in bytes) of data being sent by the remote communication service (nhiRftOut), which transfers files among cluster members.

Adjust the value of NH_RFT_BLOCK_SIZE as appropriate to tune the performance of communications among cluster members.

Values: Any valid number of bytes.

Default: 8192

NH_RFT_IN_PORT

Specifies the port that carries Remote File Transfer (In) TCP traffic between clustered eHealth systems.

Use this variable to change the port number across systems if another application or process uses the default port.

Values: Any valid available port number.

Default: 5052




NH_RFT_OUT_PORT

Specifies the port that carries Remote File Transfer (Out) TCP traffic between clustered eHealth systems.



Default: 5053


NH_RMT_IN_PORT

Specifies the port that carries Remote Message Transfer (In) TCP traffic between clustered eHealth systems.



Default: 5050


NH_RMT_OUT_PORT

Specifies the port that carries Remote Message Transfer (Out) TCP traffic between clustered eHealth systems.



Default: 5051


General Variables

This section describes general eHealth environment variables.

NH_BIN_DIR

(Internal) Defines the directory that contains the public eHealth binary files (commands), as well as some internal commands.

This directory is created during the eHealth installation. If you move the eHealth software, set this variable to the new bin location.

Values: Directory containing the binary files.

Default: ehealth/bin, where ehealth represents the eHealth installation directory.



NH_BIN_SYS_DIR

(Internal) Defines the directory that contains the internal eHealth binary files (commands).

These files are internal only; they are not accessible to customers. The binary files in this directory are invoked by public commands in $NH_BIN_DIR or by eHealth processes.

Values: Directory containing the internal eHealth binary files.

Default: ehealth/bin/sys, where ehealth represents the eHealth installation directory.

NH_DATE_FMT

Specifies the format used for the date values in eHealth reports, the console, and the Web interface.

This variable is set to the format that the user specifies during the eHealth installation. If you change this variable after installation, the change affects only the date values in scheduled reports and the eHealth console. To change the date format used in the Web interface (on the Run Reports page), you must do the following:

For Windows systems

After defining NH_DATE_FMT, reboot the system to ensure that the Web server uses the new value of the variable.

For UNIX systems

1. Edit /etc/init.d/httpd on Solaris or /sbin/init.d/httpd on HP-UX, and update the value of NH_DATE_FMT.

2. To stop and restart the eHealth Web server, log in as the eHealth user and enter the following commands at a command prompt:

nhHttpd stop nhHttpd start

Values:

DMY dd/mm/yyyy format. For example, 31 December 2003 appears as 31/12/2003.

MDY mm/dd/yyyy format. For example, 31 December 2003 appears as 12/31/2003.

YMD yyyy/mm/dd format. For example, 31 December 2003 appears as 2003/12/31.

Default:

MDY for English

DMY for French and Spanish

YMD for Japanese



NH_DIR

(Internal) Defines the directory in which the eHealth software (executables, binaries, and so on) is installed.

This variable is set during the eHealth installation.

Values: Location of the eHealth software.

Default: Location specified during eHealth installation.

NH_HOME

Specifies the directory in which the eHealth software (executables, binaries, and so on) is installed.

This variable is set during the eHealth installation. Do not change the value of this variable.

To change the eHealth installation directory, use the eHealth installation program.

Values: Location of the eHealth software.

Default: Directory that is specified during the eHealth installation.

For more information, see the eHealth Installation Guide for your platform.

NH_HOME_NEW

Specifies the installation directory for the new release of eHealth during a software upgrade.

For a new eHealth installation or a migration from Ingres to Oracle, NH_HOME_NEW is not defined.


Default: pathname

NH_HOME_OLD

Specifies the installation directory for the previous release of eHealth during a software upgrade.

For a new eHealth installation or a migration from Ingres to Oracle, NH_HOME_OLD is not defined.


Default: pathname

NH_HOME_OS

Specifies the value of NH_HOME using a Windows-style pathname.

Values: A valid Windows-style directory and path (using backslashes instead of forward slashes).

Default: pathname



NH_HTTP_PORT

Specifies the port to use for the eHealth Web server.

This variable is set during the eHealth installation in /etc/init.d/httpd on Solaris or /sbin/init.d/httpd on HP- UX systems. On Windows system, it is defined as a system variable.

Values: Any valid port number.

Default:

80 if not set.

443 if users are running in Hypertext Transfer Protocol over Secure Socket Layer (HTTPS) mode (when using iPlanet or a Professional Services Secure Socket Layer [SSL] implementation).

Note: For more information, see the eHealth Installation Guide for your platform.

NH_LOG_APPS_DIR

(Internal) Defines the directory that contains eHealth application log files.

Set this variable only if you need a new default directory for the application log files.

Values: Location of eHealth application log files.

Default: $NH_LOG_DIR/apps

NH_LOG_DIR

(Internal) Defines the default location for all log files that result from scheduled jobs, and discover, report, and rollup processes.

Set this variable only if you need a new default directory for these log files.

Values: Location for the log files.

Default: ehealth/log, where ehealth represents the eHealth installation directory.

NH_LOG_INST_DIR

(Internal) Defines the default location for the installation and upgrade log files.

Set this variable only if you need a new default directory for these log files.

Values: Location for the installation and upgrade log files.

Default: $NH_LOG_DIR/install

NH_LOG_POLL_DIR

(Internal) Defines the location of the poller log files.



Set this variable only if you need a new directory for these log files.

Values: Location for poller log files.

Default: $NH_LOG_DIR/pollerStatus

NH_LOG_SYS_DIR

(Internal) Defines the default location for all system message log files.

Set this variable to change the directory for storing system message log files.

Values: Location for system message log files.

Default: $NH_LOG_DIR/sys

NH_MSG_SRV_PORT

(Internal) Defines the port for the eHealth message server.

Set this variable to the port used by the eHealth message server.

Values: A valid port number.

Default: 5055

NH_MSG_TXT_FILE

(Internal) Defines the name of the system message text file.

Set this variable to the name of a file in which you want to store system messages.

Values: filename.sys

Default: messageText.sys

NH_SERVER_ID

Defines the unique identification (ID) number for an eHealth system that serves as a remote site in a remote polling environment.

Each remote polling site must have a unique server ID.

Values: 1 through 100.

Default: 1

NH_SNMP_LOG_IP_ADDR

(Internal) Limits SNMP advanced logging to one IP address.

Change the value of NH_SNMP_LOG_IP_ADDR when you want to focus on a specific address that is having problems.

Values: IpAddress - Any valid IP address.

Default: No default value.



NH_SNMP_MAX_LOG_SIZE

(Internal) NH_SNMP_MAX_LOG_SIZE controls the size of the log file when you turn on SNMP advanced logging. Once the maximum size is reached, the log file is backed up and logging continues. When the log file reaches maximum size again, it is backed up, overwriting the previous backup file.

If you plan to leave SNMP advanced logging on for a long time, use this environment variable to keep the log file size from growing infinitely and using up too much disk space.

Values: Any valid file size expressed in bytes.

Default: No default value.

NH_SYS_DIR

Defines the directory that contains the eHealth configuration files, console files, and other system files.

Change the value of NH_SYS_DIR only if directed to do so by Technical Support.

Values: Location for eHealth system files.

Default: ehealth/sys, where ehealth represents the eHealth installation directory.

NH_TIME_FMT

Specifies the format used for displaying times in eHealth reports, the console, and the Web interface.

This value is set during the eHealth installation. If you change this variable after installation, the change affects only the time values in scheduled reports and the eHealth console. To change the time format used in the Web interface (on the Run Reports page), you must do the following:

For Windows systems

After defining NH_TIME_FMT, reboot the system to ensure that the Web server uses the new value of the variable.

For UNIX:

1. Edit /etc/init.d/httpd.sh on Solaris or /sbin/init.d/httpd on HP-UX, and update the value of NH_TIME_FMT.

2. To stop and restart the eHealth Web server, log in as the eHealth user and enter the following commands at a command prompt:

nhHttpd stop nhHttpd start

Values: 12Hour indicates a 12-hour clock that includes am or pm designations. For example, 8:30 pm is specified as 8:30 pm. 24Hour indicates a 24-hour (military-style) clock. For example, 8:30 pm is specified as 20:30.



Note: On French and Spanish eHealth systems, you cannot change the time format to use a 12-hour clock; that is, you cannot define NH_TIME_FMT as 12Hour.

Default: 12Hour for English and Japanese. 24Hour for French and Spanish.

NH_USER

Specifies the account name of the eHealth administrator (without the domain name).

This value is set during the eHealth installation.

Values: Any valid username.

Default: The name of the eHealth user account specified during the eHealth installation.


NH_WEB_PROXY_TIMEOUT

(Internal) Specifies how long the nhWuiMsg command waits for a response from the Business Service Console.

Values: Any number of seconds.

Default: 270 Seconds (4.5 minutes)

NH_WWW_DIR

(Internal) Specifies the location of the eHealth web subdirectory, which stores files related to the eHealth Web interface. This value is set during the eHealth installation.

Default: ehealth/web, where ehealth represents the eHealth installation directory.

NLS_LANG

Sets the language environment for the Oracle database. This value is set during the eHealth installation.

Values: For a complete list of valid values for the NLS_LANG variable, refer to your Oracle documentation (the Oracle9i Database Globalization Support Guide).

Default:

AMERICAN_AMERICA.WE8ISO8859P1 for all languages except Japanese (for new installations and upgrades from Release 4.8 or 5.0, and same-system upgrades from Release 5.5 to 5.6)

AMERICAN_AMERICA.US7ASCII for all languages except Japanese (for cluster upgrades)



AMERICAN_AMERICA.JA16SJIS for Japanese on Windows

AMERICAN_AMERICA.JA16EUC for Japanese on UNIX


PERL_LIB

(Internal) Defines the location of the Perl libraries.

Values: Location of the Perl libraries.

Default: ehealth/bin, where ehealth represents the eHealth installation directory.

TMPDIR

Specifies the location of temporary disk space. eHealth uses TMPDIR as defined by the Portable Operating System Interface (POSIX).

During eHealth upgrades and migrations, the value of TMPDIR may change to $NH_HOME_OLD/tmp or $NH_HOME_NEW/tmp.

On Windows systems, the TMPDIR variable must be defined as a user variable and a system variable, and both variables must have the same value.

Values: A valid pathname.

Default: ehealth/tmp, where ehealth represents the eHealth installation directory.

Help Variables

The variables in this section relate to the Web Help that is provided with eHealth.

HHHOME

(Internal) Specifies the HyperHelp installation directory on UNIX systems. HyperHelp is the application that displays context- sensitive console Help on UNIX systems. Set this variable only to change the location of the HyperHelp installation directory.

Values: Directory that contains the HyperHelp files.

Default: ehealth/help, where ehealth represents the eHealth installation directory.

HHLOCAL

(Internal) Specifies the HyperHelp location on UNIX systems. Set this variable only to change the location of the HyperHelp application.



Values: Directory that contains the HyperHelp application.


HHPATH

(Internal) Specifies the location of the HyperHelp application executable on UNIX systems. Set this variable only to change the location of the HyperHelp application executable.

Values: Directory that contains the HyperHelp application executable.

Default: ehealth/help/bin, where ehealth represents the eHealth installation directory.

HOHPATH

(Internal) Specifies the location of the HyperHelp compiled help files, which display context-sensitive console Help on UNIX systems. Set this variable only to select a new directory for the HyperHelp compiled help files.

Values: Location of the HyperHelp compiled help files.

Default: ehealth/help/files, where ehealth represents the eHealth installation directory.

NH_HELP_BIN_DIR

(Internal) defines the location of the HyperHelp software on UNIX systems. Set this variable only to change the location of the HyperHelp software.

Values: Pathname for the HyperHelp software.

Default: ehealth/help/bin, where ehealth represents the eHealth installation directory.

NH_HELP_DIR

(Internal) Defines the location of the eHealth console Help. Set this variable only to define a new location for the eHealth console Help.

Values: Pathname for the eHealth console Help.


NH_HELP_FILE

(Internal) Defines the name of the file that contains the console Help for eHealth. Set this variable only to specify a new file name for the file containing the console Help.

Values: File that contains the eHealth console Help.

Default: netHealth.hlp



NH_HELP_FILES_DIR

(Internal) Defines the location of the HyperHelp compiled help file used for eHealth console Help. Set this variable only to specify a new directory for the HyperHelp compiled help file.

Values: Pathname for the HyperHelp compiled help file used for eHealth.

Default: ehealth/help/files, where ehealth represents the eHealth installation directory.

NH_HELP_XPR_DIR

(Internal) Defines the location of the HyperHelp xprinter files used for eHealth console Help on UNIX. This variable exists only for eHealth running on the UNIX platform.

Values: Pathname for the HyperHelp xprinter files used for eHealth console Help on UNIX.

Default: ehealth/help/xprinter, where ehealth represents the eHealth installation directory.

Integration Variables

This section describes variables that relate to the following eHealth integration modules: Alcatel and SPECTRUM.

NH_NMS_SOURCE

(Internal) sets the nmsSource field in the element row of the DCI file output from the finder program.

This variable is used only by the SPECTRUM NMS integration.

The nmsSource field is a symbol value that specifies the name that you assign to the NMS. Normally, elements discovered by the finder do not set the nmsSource field, but you may want to use this key to distinguish elements from one another.

Values: Text string that specifies the name you assigned to the Network Management System (NMS).

Default: blank

NH_NWB_CFG_DIR

(Internal) Specifies the directory that contains the Alcatel configuration files. Set this variable only to select a new directory for the Alcatel configuration files.

Values: Pathname for the Alcatel configuration files.

Default: ehealth/modules/newbridge/config, where ehealth represents the eHealth installation directory.



NH_NWB_DIR

(Internal) Specifies the directory that contains the Alcatel module files. Set this variable only to select a new directory for the Alcatel module files.

Values: Pathname for the Alcatel module files.

Default: ehealth/modules/newbridge, where ehealth represents the eHealth installation directory.

NH_NWB_TMP_DIR

(Internal) Defines the directory that contains the Alcatel temporary files. Set this variable only to select a new directory for the Alcatel temporary files.

Values: Pathname for the Alcatel temporary files.

Default: ehealth/tmp, where ehealth represents the eHealth installation directory.

NH_SPECTRUM_HOST

(Internal) Specifies the name of the SpectroSERVER host. This variable is set during the SPECTRUM installation.

Values: Name of SpectroSERVER host.

Default: hostname

NH_SPECTRUM_LANDSCAPE

(Internal) Specifies the landscape handle of the SPECTRUM map. This variable is set during the SPECTRUM installation.

Values: Landscape handle of the SPECTRUM map.

Default: landscapeHandle

NH_SPECTRUM_VNMSH

(Internal) Defines the location of the directory that contains the SPECTRUM command executables. This variable is set during the SPECTRUM installation.

Values: Directory that contains the SPECTRUM command executables.

Default: directory

SPECTRUM_DIR

(Internal) Specifies the directory in which eHealth stores the Aprisma SPECTRUM files. This variable is set during the SPECTRUM installation.

Values: Directory that contains Aprisma SPECTRUM files.

Default: The eHealth installation directory.



Licensing Variables

This section describes eHealth variables that relate to licensing.

LM_LICENSE_FILE

(Internal) Defines the pathname of the eHealth license file. You can also set this location through the FlexLM console.

If you are running software that requires a different LM_LICENSE_FILE (for example, Sun’s debugger), append the location of the other license file.

Example:

$NH_HOME/lmgr:/my/other/lmgr/paths

You can also merge the .lic files and then move the daemon to the new location.

Values: The pathname for license files. You can specify several pathnames as colon-separated values.

Default: ehealth/lmgr/license.dat, where ehealth represents the eHealth installation directory.

NH_LMGR_BIN_DIR

(Internal) Defines the location of the FlexLM license manager software binary files. Change this variable only if a previous version of FlexLM exists elsewhere on the system.

Values: The location of the FlexLM license manager software binary files.

Default: ehealth/lmgr/bin, where ehealth represents the eHealth installation directory.

NH_LMGR_DIR

(Internal) Defines the location of the FlexLM license manager software directory. Change this variable only if a previous version of FlexLM exists elsewhere on the system.

Values: The location of the FlexLM software directory.

Default: ehealth/lmgr, where ehealth represents the eHealth installation directory.



Live Exceptions Variables

This section describes variables that relate to the Live Exceptions application.

NH_MIN_LEX_BASELINE

Controls the minimum number of weeks of data that Live Exceptions requires before defining a normal behavior for use by Time Over Dynamic Threshold and Deviation from Normal alarms. This variable affects the Live Exceptions application.

The greater the number of weeks for which Live Exceptions collects historical data, the more accurately it defines normal conditions.

Values: 2 to any integer

Default: 2

For more information, see the Live Health Web Help.

NH_NTF_ACTION_DELAY

Specifies the minimum time in seconds to delay a notification server command before running the next command. Set this variable to a number greater than 2 if you have a custom script that takes longer than two seconds to run. This allows you to prevent command executions from overlapping.


Default: 2000 (milliseconds)


NH_NTF_ACTION_QUEUE_SIZE

Specifies the maximum number of notification messages that the Live Exceptions notifier server places in the queue at one time. If the queue is full, the queue drops any new notifications. The NH_NTF_ACTION_DELAY variable controls the rate at which the queue is emptied.


Default: 100


NH_TRAP_ELEM_CREATE_INTVL

(Internal) Controls the time interval in seconds that the trap server waits before sending DCI files to the eHealth configuration server to create event source elements.

Values: Any non- negative number

Default: 60



NH_NTF_ACTION_QUEUE_SIZE

Specifies the maximum number of notification messages that the Live Exceptions notifier server places in the queue at one time. If the queue is full, the queue drops any new notifications. The NH_NTF_ACTION_DELAY variable controls the rate at which the queue is emptied.


Default: 100


NH_TRAP_LE_FILES_CK_INTVL

(Internal) Specifies the time interval in seconds that the trap server uses to check if the Live Exceptions application has processed and removed the files previously sent by the trap server. In particular, the trap server uses this interval to detect when the Live Exceptions engine resumes processing after having been blocked or overloaded. Use this variable in conjunction with NH_TRAP_MAX_LE_FILES to coordinate the maximum number of files sent by the trap server and the time it takes to process them by Live Exceptions.

Values: Any non-negative number.

Default: 10

NH_TRAP_GOVERNOR_SIZE

Specifies the maximum number of traps to queue to the Live Exceptions notifier server at one time. Excess traps are discarded. Set this variable to a number that characterizes an abnormal amount of traps sent on your network.

The purpose of this variable is to prevent the notifier server from being overwhelmed by a sudden burst of alarms triggering it to send large numbers of traps.

Alarms are sent in batches to the notifier, usually right after a poll period. The notifier queues traps to be sent out until the limit specified by this variable is reached, 1000 by default. At that point, the notifier stops adding new traps to the queue, and proceeds to send them. Once the whole batch of traps has been sent, the queue is empty and ready for the next batch.

If there is a sudden burst of 1000+ alarms, it is clear that something serious has happened to a major portion of your network, and it is unnecessary to continue accumulating sympathy traps, so they are discarded.



When the notifier servers queue exceeds 1000 (or the amount you set using this variable) the following message is displayed:

Trap governor enforcing a limit of nnnn traps.

where nnnn is the number to which you set this variable, 1000 by default.

Note: This variable has no effect on the email and run command notifier actions.

Values: 1 - 2147483647

Default: 1000

NH_TRAP_MAX_LE_FILES

(Internal) Specifies the maximum number of files that the trap server will allow the Live Exceptions application to delay the processing of ehealth/log/trapLog.date.bin notification files (where ehealth represents the eHealth installation directory). When the trap server reaches this value, it stops reporting new traps until the backlog of delayed files resume processing.

Default: 20

NH_TRAP_MAX_LE_QUEUE_DELAY

(Internal) Specifies the maximum time (in seconds) that the trap server delays sending traps to the Live Exceptions engine. Setting this value too low can result in the Live Exceptions engine being scheduled too frequently. Setting this value too high can delay trap notification in a way that prevents timely event detection.

To avoid setting NH_TRAP_MAX_LE_QUEUE_DELAY too low or too high, use this value with NH_TRAP_MAX_LE_QUEUE_SIZE.

Default: 30

NH_TRAP_MAX_LE_QUEUE_SIZE

(Internal) Specifies the maximum number of traps that the trap server processes, packages, and sends to the Live Exceptions engine at one time. The trap server must receive traps in a time that is less than the value of the NH_TRAP_MAX_LE_QUEUE_DELAY variable in order for it to send them to the Live Exceptions engine.

Default: 10000 (traps per packet)



NH_TRAP_MAX_LOG_SIZE

Specifies the amount of disk space in kilobytes (KB) that the trap server uses for logging received traps. The trap server writes binary log files to ehealth/log/trapLog.date.bin, where ehealth represents the eHealth installation directory. By default, the trap server can store a maximum of 20 megabytes (MB) of log data across all log files. The trap server splits this allocated space across 10 files of 2 MB each. When the log files are full, the trap server deletes the oldest log file and creates a new file. Having multiple log files ensures that the trap server purges a minimum amount of data when necessary. If you increase the value to 40000, the trap server writes the log data to 20 files of 2 MB each. You can convert these files to ASCII and view them in an editor, or use them to replay the traps to the trap server for testing purposes.


Default: 20000

For more information on translating and replaying trap logs for testing and certification purposes, see the nhTranslateTrapLog command.

NH_TRAP_SVR_PORT

(Internal) Specifies the port number that the trap server uses to communicate with TrapEXPLODER using TCP and User Datagram Protocol (UDP) interprocesses. TrapEXPLODER allows you to filter and send traps to multiple destinations from a single system. You must also set this port number in the TrapEXPLODER configuration file.


Default: 5058

NH_TRAPS_PER_SECOND

Specifies the maximum number of traps sent to an NMS or other trap destination per second. This variable controls only Live Exceptions traps; it does not affect diagnostic monitor traps or traps that result from scheduled Health report exceptions. The minimum value is 20.

Values: Any non- negative integer greater than or equal to 20.

Default: 100


TRACE_DIR

(Internal) Specifies the location of the trace files for exceptions. This variable affects the Live Exceptions application. Set this variable only if you need to specify a new directory in which to save the trace files.

Values: Location of trace files.

Default: ehealth/trace, where ehealth represents the eHealth installation directory.



Poller Variables

This section defines variables that relate to the eHealth poller.

NH_COMMON_MIB_FILE

(Internal) Defines the location of a Management Information Base (MIB) file that contains common MIB definitions that are used to compile many eHealth MIB files.

Values: Location of a MIB file that contains MIB definitions to use with eHealth.

Default: ehealth/poller/nhCommonMib, where ehealth represents the eHealth installation directory.

NH_DISABLE_WRAP_CHECK

(Internal) Indicates whether the poller should report wrap errors for delta values that are greater than 231. If the wrap is an error and this variable is set to yes, the database may contain invalid data. If valid wraps are occurring, fast polling the elements that are experiencing the wraps may solve the problem.

yes

Disables the check for delta values greater than 231; that is, it instructs the poller not to report any wrap errors.

no

Reports delta values greater than 231 as errors.

Default: no

NH_DLG_POLLS_PER_SECOND

(Internal) Specifies the number of SNMP requests that the conversations poller sends in one second. Use a value lower than 10,000,000 if the requests are flooding the customer’s network or flooding probes with a high concentration of interfaces and leading to performance problems for other traffic. Reducing the value may, however, extend conversations poller poll times.

Values: Any non-negative integer. 10,000,000 is approximately equivalent to setting no limit on the frequency of the SNMP GETNEXT requests.

Default: 10,000,000

NH_MANAGE_STAT_DUPS

(Internal) Insulates customers from seeing problems related to duplicate statistics data by creating non-unique indexes where eHealth rollup (or indexing) jobs would normally have failed.



Consider using this environment variable if you encounter the error messages similar to the following:

■ From Database Rollup jobs or Statistics Index jobs:

Error: Sql Error occurred during operation EUS1592 INDEX: table could not be indexed because rows contain duplicate keys.

■ From polling:

Error: Sql Error occurred during operation : ‘ORA-00604: error occurred at recursive SQL level 1 ORA-00933: SQL comm’; possible problem data is: sample time: 1030277052, element id: 1009740 When NH_MANAGE_STAT_DUPS is defined as either true or false, you do not need to run any additional jobs (such as a cleanup script) before the Database Rollups or Statistics Index jobs run. When a “create unique index” operation fails on any of the NH_STATS tables, NH_MANAGE_STAT_DUPS permits the duplicate indexes to be created so the job does not fail.

It also creates a forensics data report each time the “create unique index” operation would have failed. This report is stored in ehealth/log/STAT_DUPS.nnnnnnnnn, where ehealth represents the eHealth installation directory and nnnnnnnnn is the UNIX-style timestamp indicating when the report was generated (a few minutes after the “create unique index” error occurred). Please forward these reports to the eHealth poller team, so they can study the reports and diagnose the problems.

You can use nhShowElementInfo to validate the reporting aspects of NH_MANAGE_STAT_DUPS.

When NH_MANAGE_STAT_DUPS is not set, this feature is disabled.

Use this only if you see a serious performance degradation when nhiIndexStats is run.

true

Enables the creation of unique-constraint indexes for statistics data.

false

Enables the creation of non-unique indexes for statistics data.

Default: true



NH_MIGRATION_RULES

(Internal) Specifies the location of a rules file that describes the MIB translation file (MTF) upgrade policy. Change this variable only to set a new directory for the migration rules file.

Values: Directory that contains the MTF upgrade- policy file.

Default: ehealth/poller/mtfMigration.rules, where ehealth represents the eHealth installation directory.

NH_POLL_APPEND_RETRIES

(Internal) Specifies the number of times that the poller attempts to save the polled data in the database after a poll. Sometimes the save process fails because the eHealth database has locked out the process. This variable enables a retry in the event that the process fails initially.

Values: 1 to any integer. 1 specifies one extra attempt to save the data.

Default: 1

NH_POLL_DLG_BPM

Defines the minimum traffic filter size (in bytes per minute [BPM]) for each node pair application that Traffic Accountant polls. If the traffic data rate does not meet this criteria, Traffic Accountant discards the conversations data.

Traffic Accountant does not record data for any conversations with a data rate that is below the value of this variable.

Note: If you set this variable to 0 (zero), eHealth disables the filter and saves all conversations in the database. This setting will significantly increase the size of your database. In fact, setting this variable to anything less than 150 BPM will significantly increase your disk requirements, polling write times, and report-run times.

Values: Any non-negative integer; 150 BPM is the lowest recommended number.

Default: 500

NH_POLL_DLG_DISABLE_ROLLUP

(Internal) Disables the protocol rollback for Traffic Accountant (not conversation rollups for Traffic Accountant).

Important! Traffic Accountant computes traffic values for protocols across several network layers. Setting this environment variable to yes could result in inaccurate network protocol reports.



When Traffic Accountant computes traffic values for protocols at several network layers, it takes into consideration that probes report traffic counted multiple times for the lower network layers. For example, the protocols FTP, TCP, and IP exist at consecutive network layers. When a probe accumulates data on FTP traffic, Traffic Accountant counts only that layer.

However, when a probe accumulates data on TCP traffic, that value includes all FTP traffic as well as traffic for all other protocols at the same level of FTP and above TCP. Furthermore, when a probe accumulates data on IP traffic, that value includes all TCP traffic as well as traffic for all other protocols at the level of TCP and above IP, and so on.

With NH_POLL_DLG_DISABLE_ROLLUP set to no, Traffic Accountant subtracts the higher layer values from the totals for the lower layer values. What remains for protocols such as TCP is the traffic that Traffic Accountant could not identify at a higher level. (Some competitors refer to this as “Other TCP;” eHealth just calls it “TCP.”)

The effect of subtracting the higher level data is to present an accurate picture of data on a network. If you set NH_POLL_DLG_DISABLE_ROLLUP to yes, this rollback feature is disabled, leaving the values as the probes measured them. This can result in inaccurate network protocol reports.

yes

Disables rollbacks.

no

Enables protocol rollbacks.

Default: no

NH_POLL_DLG_SHOW_STATS

(Internal) Specifies whether Traffic Accountant shows conversations poller performance statistics. You can use this variable for debugging the poller and tuning poller performance. It provides information about where the poller is spending its time and how much information each probe is collecting. Set this variable only in a local shell to prevent excess collection of data that could consume disk space.

yes

Enables showing conversations performance statistics.

no

Disables showing conversations performance statistics.

Default: no



NH_POLL_LOG_FILE

(External) Specifies the location and name of the log files for the poller messages. You can change the names (messages portion only) of these files and select a new pathname for the files, if desired.

If this variable is undefined or blank, logging is disabled. If set to a full pathname, the log is sent to the full pathname. If not set to a full pathname, and the NH_LOG_DIR variable is defined, the log is sent to this directory: $NH_LOG_DIR/pollerStatus/$NH_POLL_LOG_FILE.

If this variable is not set to a full pathname and NH_LOG_DIR is undefined or blank, the log is sent to $NH_HOME/log/pollerStatus/$NH_POLL_LOG_FILE.

Values: anyPath/anyName.stats.log

anyPath/anyName.traffic.log anyPath/anyName.import.log anyPath/anyName.live.log anyPath/anyName.standalone.log

Default: ehealth/log/pollerStatus is the default location, where ehealth represents the eHealth installation directory.

The default file names are as follows:

messages.stats.log messages.traffic.log messages.import.log messages.live.log messages.standalone.log

NH_POLL_LOG_SIZE

Defines the maximum size of the log files and backup log files in bytes. When the log reaches the specified size, it is moved into a .bak (backup) file, and the old .bak file is deleted.

Note: Do not enter commas in the variable value.


Default: 1000000

NH_POLL_MAX_TIME_SKEWS

Defines the number of allowable contiguous time skews before eHealth discards polled data and re-establishes counter baselines. Performance problems such as an overloaded eHealth system, insufficient hardware configuration, latency problems on the network, or improper poller tuning settings can lead to time skew. The poller is unable to process Simple Network Management Protocol (SNMP) responses in a timely fashion, leading to poll intervals being alternatively lengthened and shortened. This artificial interval change can lead to unusual values, such as CPU utilization rates greater than 100%.



When the poller detects time skew problems, the poller discards the polled data and considers the poll to be a missed poll. If the poller detects that the past several contiguous polls are skewed, it discards the polls and creates a new baseline for the element.

Also refer to NH_POLL_SKIP_TIME_SKEW_CHECK.


Default: 3

NH_POLL_MIN_DEVICE_REQUEST_INTERVAL

Defines the minimum time in microseconds between SNMP requests and a device. Use it when you must keep the device polling bandwidth at a specific level. This variable adds the specified poller delay to all devices.


Default: 0

NH_POLL_NUM_POLLS_FOR_SPEED_UPDATE

Represents the number of successive polls that have to occur with a stable speed value before the poller will trigger a speed configuration update in the database.

NH_POLL_PCT_CORRECTABLE_TIME_SKEW

When NH_POLL_SKIP_TIME_SKEW_CHECK is set to no, the eHealth poller compares the computed delta time values on the local eHealth system against the sysUptime values of polled devices to check for time skew problems. When it detects excessive skew problems, eHealth drops those polls.

NH_POLL_PCT_CORRECTABLE_TIME_SKEW defines the percentage of time skew allowed before eHealth recognizes a time skew issue and begins to drop polls.

This variable defines the maximum allowable percentage of time skew. For more information, also refer to NH_POLL_MAX_TIME_SKEWS and NH_POLL_SKIP_TIME_SKEW_CHECK.

Values: 1 to 100 (Values between 1 and 10 are recommended.)

Default: 5 (5% allowable time skew, or 15 seconds per 5- minute poll)

NH_POLL_PING_MEAS_TYPE

Specifies the algorithm used to compute latency values based on multiple pings: minimum, average, or maximum. The algorithms associated with this environment variable are applicable only to ping measurements, not alternate latency measurements.



min

Records the minimum response time.

avg

Records the average response time.

max

Records the maximum response time.

Default: min

NH_POLL_PING_NUM_PINGS

Defines the number of pings sent to the eHealth poller. eHealth adds one to the value of this variable. For example, the default value is 3+1.


Default: 3

NH_POLL_PROBE_TIME_LIMIT

Defines the time (in minutes) after which the Traffic Accountant poller terminates the polling of an RMON2 probe. Use this variable in environments that require polling over WANs with numerous probes and short polling intervals. In this situation, the poller continues to poll probes that are slow to respond.

If the Traffic Accountant poller reaches the timeout value, it saves any partial data and sends a message to the Conversation Poller Status window.

A value of 0 (zero) or a value greater than the Conversation Poll Rate disables the polling time limit.

Values below 5 minutes may cause eHealth to stop polling probes that are slow but responding. To select a time limit that will not cut off slow responding probes, add a few extra minutes to the time of your slowest probe.

Values near the Conversation Poll Rate may cause some degradation of poller performance. When increasing this value, make sure that it is lower than the Conversation Poll Rate by enough time to allow the poller to write all the polled data to the database. If there is not enough time, the system may skip the next poll.

Note: If polling is stopped prematurely for the same probes all the time, the poller may never update conversations for those probes.



You set the Conversation Poll Rate value in the Poller Controls dialog of the eHealth console. For more information, see the eHealth Administration Guide.

Values: 0 through the value of the Conversation Poll Rate.

Default: 20

NH_POLL_SKIP_TIME_SKEW_CHECK

By default, the eHealth poller compares the computed delta time values on the local eHealth system against the sysUptime values of polled devices to check for time skew problems. When it detects excessive skew problems, eHealth drops those polls.

NH_POLL_SKIP_TIME_SKEW_CHECK disables the poller checking of time skew between the eHealth system and the polled devices. Without this check, clock synchronization skew can reduce the accuracy of the reported data values that use delta time in the calculations.

Also refer to NH_POLL_MAX_TIME_SKEWS.

yes

Disables the check.

no

Sets eHealth to check for time skew problems between the eHealth system and polled devices.

Default: yes

NH_POLL_SPACECHECK

(Internal) Specifies whether the poller checks for sufficient disk space before attempting to save polled data.

Important! When this variable is set to no, you will not be warned when the disk is full and cannot save polled data.

yes

Sets eHealth to check the available space and either provide a warning or prevent storage when disk space is low.

no

Disables the check.

Default: yes



NH_STAT_POLLS_PER_SECOND

Specifies the maximum number of SNMP requests per second sent by the poller. This is the single most manipulated value during poller tuning. Raising this value can improve poll times on machines that can handle the extra load. Raising it too high, however, can overload the machine and the network, which can cause performance problems. The recommended maximum value is 400.

Default: 300

Poller Latency Variables

The variables in this section relate to poller latency.

NH_POLL_PING_DISABLED

Specifies whether the eHealth poller collects latency information. For UNIX systems, setting this variable to yes means that the poller process no longer needs to be owned by the root user with the setuid bit set. It also means that your latency reports will be empty or omitted.

yes

Disables latency collection (pinging).

no

Enables eHealth to collect latency data.

Default: no

NH_POLL_PING_MAX

Specifies the maximum number of ping requests that are outstanding at any time. If the eHealth system is unable to process ping responses fast enough, reported latency values may be inflated. Reduce the value of NH_POLL_PING_MAX to prevent this problem and to produce realistic latency values. Reducing the value of NH_POLL_PING_MAX can increase poll times.


Default: 64

NH_POLL_PING_PKTSIZE

Specifies the size in bytes of the ping packet sent by the eHealth system to obtain eHealth latency information. The size of a ping packet is usually at least 12 bytes. You can increase this value to create ping packets that are closer in size to your typical data packets.

Values: 0 through 64000.

Default: 100



NH_POLL_PING_RETRIES

Specifies the number of times that the eHealth poller attempts to get a successful response to a ping. Setting this variable to a large number (such as 100) can increase effective poll times when devices do not respond to a ping.


Default: 4

NH_POLL_PING_TIMEOUT

Specifies the time (in seconds) that the eHealth poller waits for a ping response from an element. Increasing this value can increase effective poll times. (It doubles with each successive request.)

Note: When the poller retries the ping request, it doubles the ping timeout value. Also, the time may be affected by system traffic.


Default: 1

NH_USE_LOW_RES_CLOCK

Bases ping latency calculations on a a low-resolution Windows system clock. By default, eHealth bases ping latency calculations on a high-resolution Windows system clock. If you have systems with multiple CPU systems, skewed data can result if each CPU bases its calculations on a different clock. For multi-CPU systems, you can base all of the calculations on a a low- resolution Windows system clock by setting this environment variable to on. For detailed information about how eHealth calculates latency, see the eHealth Administration Guide.

Values: on

Default: off

Report Variables

This section describes variables that relate to creating and viewing eHealth reports.

NH_ALLOW_MULTIPLE_VIEWERS

(Internal) Permits more than one viewing window to display At-a-Glance reports launched from the eHealth console on UNIX. (This variable does not affect At-a-Glance reports launched from the eHealth Web interface, or from the eHealth console on Windows.)




When you run an At-a-Glance report for multiple elements from the eHealth console on UNIX, eHealth actually runs multiple reports (one for each element). However, only the first report displays in the viewer window. To ensure that you can view the At-a- Glance reports for the remaining elements, set NH_ALLOW_MULTIPLE_VIEWERS to yes.

Values: yes

Default: (not defined)

NH_COLORS_DEF

(Internal) Defines the name of the color definitions file used by eHealth reports.

Values: File name of the color definitions file that you want to use for your eHealth reports.

Default: colors.cdf

NH_GIF_RESOLUTION

(Internal) Controls the resolution (in pixels per inch) of images produced by the eHealth report engine when creating HTML reports.

Change this value only if you have experience modifying image resolutions.

Values: Any non- negative integer.

Default: 90

NH_PSVIEWER1

Specifies the image-viewing application used when eHealth reports display on the screen of a UNIX system. You can change the default tool used by either operating system.

Example: Set the Solaris Operating System

To set the Solaris operating system to use the GhostView utility, enter the following:

NH_PSVIEWER1="$NH_HOME/bin/ghostview"

Values: Path to the executable program for the image- viewing application.

Default: /usr/openwin/bin/imagetool for Solaris systems. ehealth/bin/ghostview for HP-UX systems, where ehealth represents the eHealth installation directory.

NH_PSVIEWER1_EXE

Specifies the application to use to view eHealth reports with the Screen output option. NH_PSVIEWER1 is the application of choice. If it is not available, you can use NH_PSVIEWER2.



Default: ehealth/bin/imagetool, where ehealth represents the eHealth installation directory.

NH_PSVIEWER2

Specifies the backup image- viewing application if NH_PSVIEWER1 is not available. You can change the default tool used by either operating system.

Example: Set the HP-UX Operating System to Use the Image Tool Utility

To set the HP-UX operating system to use the Image Tool utility, enter the following:

NH_PSVIEWER2="$NH_HOME/bin/imagetool"


Default: ehealth/bin/ghostview, where ehealth represents the eHealth installation directory.

NH_REPORT_ASCII_FILE_EXT

Lets you specify the file extension to use when generating reports in ascii format. The default extension used is .csv. Use this variable when you want to open ascii report files without using the Microsoft Excel application.

On Windows systems, Microsoft Excel does not correctly display Japanese text created on Solaris systems, but when you’re working in Internet Explorer, the .csv extension causes text files to be opened in Microsoft Excel. You can use the NH_REPORT_ASCII_FILE_EXT variable to specify an alternate file extension, such as .txt, for ascii files.

Values: Any valid file extension. The recommended value is .txt.

Default: .csv

NH_REPORTS_DIR

(Internal) Defines the location of the eHealth report files. Set this variable only to specify a new directory for saving reports. To maintain disk space, eHealth automatically deletes old files after 31 days. If you want to maintain reports for longer than this time, you must move them into another directory.

Values: Directory in which you want to save eHealth report files.

Default: ehealth/reports, where ehealth represents the eHealth installation directory.



NH_VIEWER_TYPE

Specifies an alternative application, such as PostScript or Adobe Acrobat Reader, for viewing eHealth reports.

To view reports that are output to the screen in Acrobat Reader, specify pdf for this variable on Windows systems, or specify ps on UNIX systems to view reports using a PostScript viewer.

To set Acrobat Reader as the viewer for UNIX systems, do the following:

1. Include a directory for Acrobat Reader in your path setting.

2. Set NH_VIEWER_TYPE as follows:

setenv NH_VIEWER_TYPE "pdf"

3. Stop and restart eHealth before running a report.

ps

Sets PostScript as the report-viewing application.

pdf

Sets Adobe Acrobat Reader as the report-viewing application.

Default: ps

Service Availability Variables

This section describes variables that you can use with Service Availability.

NH_EMPIRE_USE_HOSTNAME

(Internal) Enables the poller to create a permanent database row (svcrsp) on the SystemEDGE agent for Service Availability path elements. The poller will not delete this row when the poller is stopped, when polling is disabled for the element, or when the element is deleted.

You can use either of the following methods to delete the svcrsp rows:

■ Use AdvantEDGE View to delete them.

■ Stop the SystemEDGE agent, delete the entry in the svcrsp.cf file, and restart the agent.

no

Specifies that permanent svcrsp database rows will not be created.

yes

Specifies that permanent svcrsp database rows will be created.

Default: yes




SNMP Variables

This section defines variables that relate to Simple Network Management Protocol (SNMP). These variables are used with the discover and poller processes.

NH_SNMP_PROXY_ADDRESS

Specifies the IP address and port number of the BRASS™ server used as the SNMPv3 proxy. Setting this environment variable allows you to discover and poll devices using the SNMPv3 protocol.

Before you set this environment variable, you must install and configure the SNMP Security Pack software on your eHealth system. For more information, see the SNMP Security Pack Quick Start Guide, provided by SNMP Research.

Specify a value of 127.0.0.1:4747 for this variable unless you specified another port for the BRASS server during installation.

After setting this variable, you must import SNMPv3 key configuration information for each of your devices before you can discover and poll them using SNMPv3. For more information, see the eHealth Data Integration Guide.

Values: IP address and port number of the BRASS server installed as part of the SNMP Security Pack software.

Default: None

Statistics Poller Variables

This section describes variables that you can use to tune the eHealth statistics poller. They are for technically knowledgeable users. Do not change their settings unless you have experience tuning poller performance.

Important! Improper use of these variables can result in serious performance degradation and invalid polled statistics data.

NH_POLL_AGENT_THROTTLE

Defines the maximum number of concurrent requests that the poller will send to a particular device during a poll.

Important! This variable affects the performance of the eHealth statistics poller. Do not modify this variable unless you have experience with and a firm understanding of tuning poller performance.

The poller sends the number of requests specified by this variable to an agent and then waits for responses from that agent before sending additional requests. By using this variable to limit the number of concurrent requests sent to a device, you can prevent the poller from overloading large or slow devices with SNMP requests.



Customers with many elements on a device may need to increase this value to meet the Statistics Poller poll interval.

If you set this value to a very large number (such as 50), you effectively disable throttling. You can also disable throttling by setting the NH_POLL_ALL_AGENTS_THROTTLED variable to no.


Default: 5

NH_POLL_ALL_AGENTS_THROTTLED

Specifies whether agent-based throttling is enabled during polling.


An agent is a combination of Unique Device ID and port. Throttling prevents the poller from overloading polled agents. Most configurations can benefit from agent throttling; setting this variable to no is not recommended.

yes

Enables agent-based throttling during polling.

no

Disables agent-based throttling.

Default: yes

NH_POLL_ALT_BS

Specifies the alternative backoff strategy used for modem/Remote Access Server (RAS) elements to allow their polling to be tuned separately from other types of elements.


The exponential value is not recommended because the timeout periods increase rapidly.

constant

Sets a progression of equal timeout periods, with the default timeout value of 4 seconds.

linear

Sets a progression of timeout periods where each subsequent period is incremented by the timeout value itself. For example, for three retries, the timeouts are 4, 8, and 12 seconds.



exponential

Sets a progression of timeout values where subsequent timeout values are increased by a factor of 2. For example, for three retries, the timeouts are 4, 8, and 16 seconds.

Default: constant

NH_POLL_BS

Specifies the backoff strategy used to determine timeout intervals for SNMP requests that time out and need to be resent.


If the NH_SNMP_TIMEOUT value needs to be increased, use constant progression to prevent subsequent retries from having excessive timeout values.

The exponential value is not recommended because the timeout periods increase rapidly.

constant

Sets a progression of equal timeout periods with the default timeout value of 4 seconds.

linear

Sets a progression of timeout periods where each subsequent period is incremented by the timeout value itself. For example, for three retries, the timeouts are 4, 8, and 12 seconds.

exponential

Sets a progression of timeout values where subsequent timeout values are increased by a factor of 2. For example, for three retries, the timeouts are 4, 8, and 16 seconds.

Default: linear

NH_SNMP_ALT_RETRIES

Sets the maximum number of times that the poller sends an SNMP request to obtain data from an element using alternative tuning algorithms during a poll.


Use this variable for modem devices. If modems are timing out, try increasing the value. Larger numbers can increase effective poll times.

If the element does not respond to any of the requests, eHealth reports the lack of data as a missed poll for the element.




Default: 2

NH_SNMP_DEVICE_TIMEOUTS

Specifies the maximum number of SNMP request timeouts for each device on a given poll before the poller considers all device elements a missed poll and proceeds to the next device. The poller attempts the requests again on all subsequent polls.


Device timeouts help reduce the time spent polling devices that are not responding to polls on a consistent basis. Reducing the value may cause missed polls for agents that are slow to respond. Increasing the value will increase poll times in configurations where devices are not responding.

Note: If you set this value to a number that is much higher than 15, you effectively disable the timeout. The poller continues to poll the device until all elements respond or time out.

Values that exceed the agent throttle value by more than a factor of three may extend poll times excessively. See the values of NH_POLL_AGENT_THROTTLE and NH_POLL_ALL_AGENTS_THROTTLED.

Values: 1 to any integer. Setting this variable to 15, for example, indicates that if any 15 elements on the same agent fail to respond after all retries and timeouts, the poller will cease trying to poll the agent for this poll period.

Default: 15

NH_SNMP_RETRIES

Specifies the maximum number of times the poller sends an SNMP request to get data from an element.

This variable affects the performance of the eHealth statistics poller. Do not modify this variable unless you have experience with and a firm understanding of tuning poller performance.

Use this variable to set the number of retries for non-modem devices. Large values can increase effective poll times. If the element does not respond to any of the requests, eHealth reports the lack of data as a missed poll for the element.


Default: 4



NH_SNMP_TIMEOUT

Specifies the amount of time (in microseconds) that the poller waits for an SNMP response from an element before timing out and retrying the request.


If this time expires, the poller sends another SNMP request, up to the number specified by NH_SNMP_RETRIES.

Values: Any non- negative integer.

Default: 4000000 microseconds (equivalent to 4 seconds)

NH_STAT_POLLS_PER_SECOND

Sets the maximum number of SNMP requests that the statistics poller attempts in one second.


If your eHealth system is powerful and you have sufficient network bandwidth, you can increase the value to improve poller performance.

If the number is too high, however, the poller may not be able to keep up with the rate of SNMP responses. This can result in skewed delta times and statistics data.

For more information about using this variable, see the white paper titled Tuning the Network Health Statistics Poller, which is available from the Technical Support Web site.


Default: 300

System Variables

This section describes variables that relate to eHealth System and Application.

NH_BSC_PORT

Specifies the port to use for the eHealth Business Services Console (BSC) application server.



In the unlikely event that port 5054 is being used for another application, the NH_BSC_PORT variable lets you define the BSC application server environment variable to an unused port.

You can set this variable during the eHealth installation in /etc/init.d/httpd on Solaris or /sbin/init.d/httpd on HP-UX systems. On Windows system, it is defined as a system variable.


Default: 5054 if not set.


NH_EMPIRE_RANGE_HIGH

(Internal) Defines the maximum value in the pmon table index that eHealth uses to create process entries in SystemEDGE agent MIB tables.

If you create pmon table entries for processes that you want to monitor, the entries must be between the value of this variable and the value of NH_EMPIRE_RANGE_LOW.

Performance during the first poll is reduced when eHealth manages SystemEDGE agent MIB table rows. The more rows eHealth is managing, the larger the impact on poller performance.

You can use this variable to help reduce the chance of eHealth deleting or modifying rows that were created by other applications, for example, by users who defined their own row entries with AdvantEDGE View or by editing SystemEDGE agent configuration files local to the agent (on the system).

Values: Any non-negative integer that is higher than the value of NH_EMPIRE_RANGE_LOW.

Default: 3999

NH_EMPIRE_RANGE_LOW

(Internal) Defines the minimum value in the pmon table index that eHealth uses to create process entries in SystemEDGE agent MIB tables.

If you create pmon table entries for processes that you want to monitor, the entries must be between the value of this variable and the value of NH_EMPIRE_RANGE_HIGH.

Performance during the first poll is reduced when eHealth manages SystemEDGE agent MIB table rows. The more rows eHealth is managing, the larger the impact on poller performance.

You can use this variable to help reduce the chance of eHealth deleting or modifying rows that were created by other applications, for example, by users who defined their own row entries with AdvantEDGE View or by editing SystemEDGE agent configuration files local to the agent (on the system).



Values: Any non-negative integer that is lower than the value of NH_EMPIRE_RANGE_HIGH.

Default: 3001

NH_STARTUP_CFG

(Internal) Defines the default name of the eHealth process initialization file.

Values: Name of the process initialization file.

Default: startup.cfg

NH_STARTUP_DELAY

(Internal) Slows down the startup of eHealth servers on reboot.

Set this variable only if eHealth is having trouble starting on reboot. The value indicates the amount of time that the servers wait before starting.

Values: Any non-negative integer. Values of 50 through 100 are recommended.

Default: 0

NH_STORE_PROCESS_DATA

Enables storing and reporting of statistics for individual system process elements (as opposed to aggregate process set elements).

To enable eHealth to report on new process elements, set this variable to yes before you discover the new elements.

yes

eHealth discovers and stores data for system process elements. You can then run reports for those process elements.

no

Disables the storing of polled statistics for individual process elements in the eHealth database; however, eHealth still discovers them.

Default: no

NH_SV_DISABLE_STAT_CHECK

(Internal) Disables the statistics availability check during an element configuration import in eHealth Integration for Cisco WAN Manager (CWM).

Use this variable when you need to import a customer’s CWM configuration where some required statistics are not enabled for collection.

yes

Activates this variable.

Default: blank



Traffic Accountant Variables

The variables in this section relate to Traffic Accountant.

NH_DLG_TIME2KEEP

Configures the time in hours after which the Traffic Accountant poller deletes poller conversations from the internal poller cache. If you set this variable to 0 (zero), the poller no longer ages out conversations from the poller cache.

Because the pollers keep instances of every node pair, protocol, and probe combination that they identify, use this variable to reduce the size of the Traffic Accountant and Import polled data.

To set NH_DLG_TIME2KEEP on a UNIX system, you must stop the eHealth server and console, edit the nethealthrc.csh.usr or nethealthrc.sh.usr file to define the variable, and restart eHealth.


Default: 4

NH_MAX_IP_ADDRS

Configures the maximum number of IP addresses in a Traffic Accountant view created by IP address range or subnet address and mask. Use this value to control the size of a Traffic Accountant view created by IP address range or subnet address and mask.


Default: 1000000

NH_DLG_POLL_TIME_FIRST_WARNING_THRESHOLD

Controls the time at which the TA SNMP or NetFlow Import poller issues a warning that the poll may not complete in the specified interval. This variable guards against performance impacts by detecting TA resource overutilization. The value of this variable is a percent of the poll interval and must be less than the NH_DLG_POLL_TIME_SECOND_WARNING_THRESHOLD setting.

Values: Any percentage from 1% to 99%

Default: 90%

For detailed instructions on using this variable, see the eHealth Traffic Accountant Administration Guide.



NH_DLG_POLL_TIME_SECOND_WARNING_THRESHOLD

Controls the time at which the TA SNMP or NetFlow Import poller issues a warning that it has polled the specified percentage of your elements. This variable guards against performance impacts by detecting TA resource overutilization.

The value of this variable must always be greater than the NH_DLG_POLL_TIME_FIRST_WARNING_THRESHOLD setting. To disable the TA resource overutilization utility, set both of these environment variables to 0.

Values: Any percentage from 1% to 99%

Default: 95%

For detailed instructions on using this variable, see the eHealth Traffic Accountant Administration Guide.

NH_SNMP_DLG_RETRIES

Specifies the number of times that the poller attempts to poll a probe element. Large values can increase effective poll times.

Note: This variable affects the performance of the eHealth conversation poller. Do not modify this variable unless you have experience with and a firm understanding of tuning poller performance.


Default: 6

NH_SNMP_DLG_TIMEOUT

Specifies the length of time (in microseconds) that the poller waits for a response from a probe element. If this time expires, the poller sends another SNMP request, up to the number specified by NH_SNMP_DLG_RETRIES.

Note: This variable affects the performance of the eHealth conversations poller. Do not modify this variable unless you have experience with and a firm understanding of tuning poller performance.


Default: 4000000 (equivalent to 4 seconds)

NH_TA_DIRECTIONALITY

(External) Controls the data aggregation of inbound and outbound traffic direction between node conversations for Traffic Accountant. If the variable is set to an invalid value, eHealth uses the default.



To set NH_TA_DIRECTIONALITY on a UNIX system, do the following:

1. Stop the eHealth server and console.

2. Edit the nethealthrc.csh.usr file to define the environment variable for eHealth processes.

3. Edit the nethealthrc.sh.usr file to define the environment variable for commands.

4. Restart eHealth.

For instructions on starting and stopping the eHealth server and console, see the Administration Web Help.

BI-DIRECTIONAL

Keeps inbound and outbound traffic separate and creates two node-address pairs.

UNI-DIRECTIONAL

Combines inbound and outbound traffic between nodes into one conversation and creates one node-address pair.

Default: UNI-DIRECTIONAL

NH_TA_RPT_INCLUDE_UNASSIGNED_NODES

When you create a view of the nodes or autonomous systems that the probe elements in your network observe, includes all traffic, including traffic that occurs between unassigned nodes. By default, eHealth creates the Unassigned Nodes group to contain all nodes or autonomous systems that you have not assigned to any group in the view. If you set this variable to yes, eHealth includes the traffic between unassigned nodes and does not create the Unassigned Nodes group.

Values: yes and no

Default: no

UNIX-Specific Variables

This section describes eHealth variables that are specific to the UNIX operating system.

OPENWINHOME

Defines the location of the OpenWindows software. Do not change the value of this variable unless you have changed the location of the OpenWindows software on your system.

Values: Location of the OpenWindows software.

Default: /usr/openwin



PRINTER

Specifies the name of the default printer that eHealth uses for printing reports on a UNIX system. You can specify this value during eHealth installation or at any time thereafter.

Values: Any printer name.

Default: printerName

TWO_TASK

When you upgrade from eHealth Release 5.5 to Release 5.6, the installation process uses the TWO_TASK environment variable to connect to the Oracle 5.5 database during transition mode. Transition mode occurs when you are running eHealth Release 5.6 but have not yet updated the database from Oracle8i to Oracle9i.

The upgrade process defines TWO_TASK in the nethealtrc.sh file. The nhUpgradeOracleDb command clears its value.

This environment variable applies only to UNIX installations.

Values: The value of TWO_TASK must match what the installation process writes using the nhConfigDbNet command.

Default: The default value of TWO_TASK is based on the hostname and ORACLE_SID values.

Windows-Specific Variables

This section describes eHealth variables that are specific to Windows operating systems.

NH_EWOULDBLOCK_RETRIES

(Internal) Provides a workaround to a NuTCRACKER problem with the eHealth console of a system running Windows 2000, Service Pack 3.

Try resetting this variable if you encounter the following error message repeatedly on the eHealth console, relating to a particular process:

Internal error programName: Expectation for 'timeout !=0' failed (EWOULDBLOCK

on blocking fd in file ../ccmUtil.C, line 765). (cu/cuAssert)

This error is generated by the NuTCRACKER software and is related to an issue with Windows 2000, Service Pack 3. To correct the problem, set NH_EWOULDBLOCK_RETRIES to 20. If the error continues to occur, increase the value of the variable by increments of 10 until the error no longer occurs.

Values: Any integer, indicating the number of retries.

Default: 10



NH_NT_LANG

(Internal) Specifies the language (English, French, Spanish, or Japanese) for the eHealth application on Windows systems.

It is recommended that you do not change this value from the value set by the eHealth installation program. The value must match the language version of eHealth that is installed on your system.

ENU

English

ESP

Spanish

FRA

French

JPN

Japanese

Default: Set automatically by the eHealth installation program, based on the language version installed.

NH_NT_SMTP_SERVER

Specifies the name of the Simple Mail Transfer Protocol (SMTP) server to use on a Windows system when eHealth sends reports and other messages such as e-mail messages. You can specify the value during eHealth installation or at any time thereafter.

Values: Any server name.

Default: ServerName

For more information, see the eHealth Installation Guide for the Windows platform.

NH_PDFVIEWER

Specifies the path of the Adobe Acrobat Reader application on Windows systems. This value is set during the eHealth installation.

Values: Pathname of the Adobe Acrobat Reader application.

Default: The path of the drive that contains the system files. The recommended path is c:\acrobat or c:\program files\acrobat, but it can be any path the user specifies for installing Acrobat Reader during the eHealth installation.



NH_PRINTER

Specifies the name of the default printer that eHealth uses for printing reports on a Windows system. You can specify the value during eHealth installation or at any time thereafter. To set a value, use the Environment tab in the Windows Control Panel.

Values: Location of the default printer for eHealth reports.

Default: \\printServer\printerName


NH_SELECT_SLEEP_TIME

(Internal) Specifies the number of milliseconds to wait before retrying a select statement. Use this variable as a workaround to an error generated by the NuTCRACKER software.

This variable provides a workaround to a NuTCRACKER problem that results in the following error message:

Internal error processName: UNIX select (2) failed (bad file number).

(cos/CosFdSet::doSelect)

eHealth may restart automatically. If you encounter this error repeatedly with the same process, set NH_SELECT_SLEEP_TIME to 500. If the error continues to occur, increase the value to 1000.

Values: Any positive integer, indicating milliseconds.

Default: 0

NH_USER_DOMAIN

Specifies the domain associated with the eHealth user account on a Windows system. You set this variable during the eHealth installation.

Values: A valid Windows NT domain name. eHealth does not support Windows 2000 domains for the eHealth user account.

Default: domainName specified during the eHealth installation.


NUT_ENV_LITERAL

The NuTCRACKER software converts environment variables between NuTCRACKER and Win32 format.

NUT_ENV_LITERAL defines a list of environment variables that the NuTCRACKER software should not convert.

Values: Do not change the value of this variable.

Default: TZ



NUT_SUFFIXED_SEARCHING

Specifies a search order for executable programs. For example, suppose you have the files calendar.exe and calendar.sh. If this environment variable is defined as exe and you type calendar at the command line, the calendar.exe program runs. This environment variable is used by the NuTCRACKER software.

Values: Do not change the value of this variable.

Default: exe

NUTCROOT

Specifies the location of the NuTCRACKER software for eHealth on Windows systems.

This variable is defined during installation. Do not change the value of this variable unless you need to change the location of the NuTCRACKER software for eHealth.

Values: Location of the NuTCRACKER software.

Default: The root of the disk drive used for the NH_HOME directory. For example, if NH_HOME is defined as E:\ehealth, then NUTCROOT is defined as E:\nutcroot.

Index 491

Index

A about

command line • 13 environment variables • 411

administration commands • 209 Application Response commands • 236

C commands

about command line interface • 13 syntax • 14

D database commands • 252 database variables • 416 debugging variables • 420 development variables • 425 discover commands • 329 discover policy parameters • 44, 381 Distributed eHealth

commands • 282 variables • 425

E environment variables

about • 411 set variables on UNIX • 413 set variables on Windows • 411

G general variables • 432 group commands • 329

H help variables • 439

I installation commands • 345 integration modules commands • 346 integration variables • 441 internal support commands • 376

L licensing variables • 443 Live Exceptions variables • 444 Live Health commands • 353

P poller

commands • 329 poller latency variables • 456 poller variables • 448 statistics poller variables • 461

R report variables • 457

S Service Availability

variables • 460 SNMP variables • 461 statistics poller variables • 461 system variables • 465

T toolkit commands • 365 Traffic Accountant

Traffic Accountant commands • 372 variables • 468

U UNIX variables • 470

W Windows variables • 471

CA eHealth Command and Environment Variables - CA...

Documents

Transcript of CA eHealth Command and Environment Variables - CA...