Cisco Info Server Reference

The nco_sql command allows you to connect to Cisco Info Server (or Cisco Info Gateways) and use the SQL interface to interact with and control the Cisco Info Server.

Usage

nco_sql [-server <string>] [-user <string>] [-password <string>]

where:

-server takes a parameter which is the name of the server to connect to. Default is NCOMS.

-user takes a parameter which is the name of a Cisco Info Center user. Default is the user's UNIX login name.

-password takes a parameter for the user. We recommend this option not be used as it makes the password visible.

Operation

Once logged in using nco_sql, you can specify any SQL commands. The commands are not issued until the command go is issued. For example:

wco_sql -server INFOSERVER

Password:

1> update alerts.status set Severity=0 where Severity<3;

1> update alerts.status set Severity=5 where Severity>=3;

1> go

The nco_migrate command takes two definitions of an Cisco Info Server database, an old and new definition, and migrates the data, assuming it to be valid for the old definition, to the new definition. It should be used when fields have been added or removed from existing Cisco Info Server tables. nco_migrate preserves the data.

Usage

nco_migrate [-server <string>] [-orig <string>] [-sql <string>]

[-defaults <string>] [-verbose] [-version] [-help]

where:

-server takes a parameter which is the name of the server to be migrated. This defaults to NCOMS.

-orig takes a parameter which is the name of the file that contains the old SQL definition with which the database was created. This defaults to servername.orig. The option -old can be used as an alias.

-sql takes a parameter which is the name of the file that contains the new SQL definition. This is the definition to convert to. This defaults to servername.sql. The option -new can be used as an alias.

-defaults takes a parameter which is the name of a default file.

-verbose sets nco_migrate to provide verbose output during the migration process.

-version displays version information about nco_migrate and then exits.

-help displays help information about nco_migrate and then exits.

Default Files

To allow for automatic settings to be made to new fields, a defaults file can be created and used by specifying the -defaults option with a file name. The file should contain entries in the form:

<databasename>.<tablename>.<fieldname>=<value>

Where <databasename> is the name of the database, <tablename> is the name of the table, <fieldname> is the name of the field to set and <value> is the value to set it to.

<value> may be a quoted string or integer value depending on the type of the field being set.

For example, when a field called HtmlPage is added to the alerts.status table and existing entries should be set to http://www.envysoft.com then the defaults file would contain:

alerts.status.HtmlPage="http://www.envysoft.com/"

Note When you specify an existing field in the defaults file, any data stored in that field is overwritten by the default setting.

Operation

When you run nco_migrate, it takes the original SQL file (.orig) and the new SQL file (.sql), and migrates the data in the $OMNIHOME/db directory. The existing files are backed up as .orig and the new files are created in their place. The .bak files in the $OMNIHOME/db directory are not changed.

Messages

Description

The nco_message command is used to display a message in a window.

Usage

nco_message [-title <string>] [-message <string>] [-type <string>]

[-tag] [-stdin] [-version] [-help]

where:

-title sets the title of the dialog.

-message takes a message string to display.

-type takes a parameter which is the name of the message type. The message type can be either: info, warn, or, error. This defaults to error.

-tag sets the help page tag.

-stdin reads the message from the standard input rather than from -message.

-version displays version information about nco_message and then exits.

-help displays help information about nco_message and then exits.

Operation

You can run the nco_message command from within a script. It takes the message you specify and displays it in a window.

Data Types

The data types shown in Table A-1are used in the Cisco Info Server tables.

Data Type	Description
char	A string of characters, maximum size is defined by the field size.
int	An integer value.
time	Time and date as a value in seconds since Midnight, Jan 1st 1970.
timestamp	Time and date as above, however, automatically populates by the Info Server when the record is created.
ltime	A time field which has modified semantics to allow for it to be updated by Cisco Info Mediators.
incr	An integer field which is automatically populated with an Info Server internal variable when the record is inserted. (Used for unique serial number generation).
optime	A time field which is automatically updated with current date and time whenever an insert or update operation is performed.
opcount	An integer field which is incremented whenever a record is inserted or an attempt is made to insert a record which already exists.

Table A-1: Cisco Info Server Data Types

Data Type Description

char

A string of characters, maximum size is defined by the field size.

int

An integer value.

time

Time and date as a value in seconds since Midnight, Jan 1st 1970.

timestamp

Time and date as above, however, automatically populates by the Info Server when the record is created.

ltime

A time field which has modified semantics to allow for it to be updated by Cisco Info Mediators.

incr

An integer field which is automatically populated with an Info Server internal variable when the record is inserted. (Used for unique serial number generation).

optime

A time field which is automatically updated with current date and time whenever an insert or update operation is performed.

opcount

An integer field which is incremented whenever a record is inserted or an attempt is made to insert a record which already exists.

Database Tables

This section lists the Cisco Info Server database tables. They are grouped into the following:

Alert Related Tables

alerts.status Table

The alerts.status table is the storage point for all events and correlations of those events. Table A-2 displays the alerts.status table fields.

Table A-2: alerts.status Table
Field Name Field Type Field Size Mandatory Description

Identifier

char

255

Yes

Internal hash key/table identifier.Set by the Info Mediators for the Cisco Info Server for de-duplication.

Serial

incr

Yes

Unique serial number generated by the Cisco Info Server.

Node

char

64

Yes

This field identifies the origin of alerts. As the origin is usually the Cisco WAN Manager (SNMP Manager), this field contains either the name or IP address of the Cisco WAN Manager hosts.

The only exception to this is for user connection traps. See the Cisco Info Center Mediator and Gateway Reference guide for more information.

NEName

char

64

No

Name of the network element reporting the event.

Manager

char

64

Yes

Name given to the Info Mediator to identify the source of event. This is set within the Mediator properties.

For example, NNM is the HP NNM Mediator.

SV+ is the Cisco WAN Manager Mediator.

Agent

char

64

No

Descriptive name of sub manager which generated the alert.

AlertGroup

char

64

No

Used in the Generic, Type 3, and Type 4 automations to group event pairs. See the Cisco Info Center Administrator Reference guide for more information on Automations.

AlertKey

char

64

Yes

Descriptive key with reference to the event. This field contains the instance of the Object, for example, NEName Slot for Card Events, Serial0 for Cisco IOS Router Events.

Severity

int

Yes

Severity of problem:
0 Clear, 1 Indeterminate, 2 Warning,
3 Minor, 4 Major, 5 Critical.

Summary

char

255

Yes

Summary of alert/problem as human readable text to appear on the administration console.

StateChange

optime

Yes

Automatically maintained timestamp at Cisco Info Server of last insert/update of alert from any source.

FirstOccurrence

time

Yes

Time (in seconds, since Jan. 1, 1970) when this alert was created or when polling started at the Mediator.

LastOccurrence

ltime

Yes

Time when this alert was last updated at the Mediator.

InternalLast

timestamp

Yes

Time when this alert was updated at the Cisco Info Server.

Poll

int

No

Frequency of polling for this alert in seconds.

Type

int

No

Used in the Generic, Type 3 and Type 4 automations to define the relationship between event pairs. See the Cisco Info Center Administrator Reference guide for more information on Automations.

Tally

opcount

Yes

Automatically maintained count of the number of inserts/updates of the alert from any source.

Class

int

Yes

Class the event belongs to. This field defines the context sensitive tools available to each event. See the Cisco Info Center Administrator Reference guide for more information on classes, menus, and menu options.

Grade

int

No

Grade of alert/problem within the set severity.

Location

char

64

No

This field is currently not used and can be used by the Service Provider to populate this with the location name.

OwnerUID

int

8

Yes

Userid of the user who is assigned to handle this alert.

OwnerGID

int

8

No

Group ID of the group assigned to handle this alert.

Acknowledged

int

8

Yes

Has assigned user acknowledged the assignment? (0 means No, 1 means Yes).

Flash

int

No

Enables the option to make the Event List flash.

ServerName

char

64

Yes

Name of originating server. Used by Cisco Info Gateways to control propagation of alerts between Cisco Info Server.

ServerSerial

int

8

Yes

Serial number of alert on originating server (when not originated on this server). Used by Cisco Info Gateways to control propagation of alerts between Cisco Info Server.

NEAddress

char

32

Yes

IP address of the network element used by the Cisco WAN Manager machine to access the network element.

NEType

int

Yes

0 - IPX

1 - BPX

2 - IGX

3 - AXIS

4 - DAS

5 - VNS

6 - DASD

12 - ESP

999 Unknown

1000 Info Center Mediator.

ObjectType

char

64

Yes

NE

Card

Connection

Endpoint

Endpoint.FR

Endpoint.ATM

Endpoint.CE

Endpoint.VOICE

Line.access

Line.trunk

Peripheral

Peripheral.dc

Peripheral.disk

Peripheral.fan

Peripheral.ps

Peripheral.ts

Port

Port.ATM

Port.FR

Port.VOICE

System

System.config

System.connectivity

System.general

System.nic

System.redundancy

System.test

SubObjectType

char

64

No

Used to further identify the object. The value in this field depends upon the ObjectType. This field is not mandatory and may be blank in some cases.

ObjectStatus

int

No

The current status of the object reporting the event. For example, Down, Added, Inserted, etc.

Events cleared by automation contain Cleared in the ObjectStatus.

Slot

char

4

No

Slot number of the network element reporting the event.

PSAP

char

6

No

Physical Service Access Point. The PSAP is a hierarchical identifier for the resource over which virtual circuits are provisioned. The word "Physical" here refers to the OSI layer, thus, a PSAP identifies the Layer 1 facility.

This hierarchical structure follows the following convention: <physical_line>.<sub_channel1>.<sub_channel2><sub_channeln>.

For single port cards, physical line number is always 1.

For multi-port cards, physical line number starts at 1.

LSAP

char

6

No

Logical Service Access Point. For naming consistency, the concept of logical port numbering at the card level was introduced. For cards such as UFM, FRSM, and AUSM, a logical identifier for the port is created when the port is provisioned. It can essentially be thought of as a random number, as it has no inherent physical information contained within it. These identifiers are stored in the LSAP field. For IMA, it is this number which remains constant, even when lines are added and deleted from the port.

For virtual trunks, the LSAP contains the user assigned Trunk ID.

DSAP

char

24

No

Data Link Service Access Point.

This field contains the virtual circuit identifier. The syntax is <DSAP> (<annotation>), with a space delimiting the DSAP from the annotation, and the annotation appearing in parentheses. This SAP is used between OSI Layer 3 and Layer 2 to identify virtual circuits. Depending on the trap type and trap subtype, this field would contain:

FR: DSAP = <DLCI> (DLCI)

ATM: DSAP = <VPI>[.<VCI>] (VPI/VCI)

RemoteNEName

char

64

No

This field contains the remote network element name for connection and trunk events.

RemoteSlot

char

4

No

This field contains the slot number for the remote network element name for connection and trunk events.

RemotePSAP

char

6

No

This field contains the PSAP for the remote network element name for connection and trunk events.

RemoteLSAP

char

6

No

This field contains the LSAP for the remote network element name for connection and trunk events.

RemoteDSAP

char

24

No

This field contains the DSAP for the remote network element name for connection events.

AdditionalInfo

char

255

No

This field contains values for all SNMP VarBinds received in the traps that don't fall into one of the other fields.

TrapReason

char

64

No

This field contains the trap reason code as specified in the MIB for BPX and IGX. For AXIS, VNS, ESP, trap reason is populated by the trap number itself, as each trap is associated with a specific event. This allows filtering on a range of traps, based on trap identifiers.

Customer

char

64

No

This field is currently not used and can be used by the Service Provider to populate this with the customer name.

Site

char

64

No

Physical location field. This is left to be specified by the Service Provider.

ServiceIdentifier

char

64

No

This field is currently not used not used and can be used by the Service Provider

ServiceType

char

24

No

This field is used by the Real Time Counter tool to determine the counters. See the Cisco Info Center Administrator Reference guide for more information

BitMapField

char

36

No

This field contains the BitMap from one of the SNMP VarBinds received by the Mediators.The Deocode BitMap tool uses the information within this field along with the Convert field to display the decoded values.

Convert

char

64

No

Field used by the BitMap Decode tool to define the conversion values for the BitMap held in the above field.

OldObjectStatus

int

No

Field used by hold the original status as the ObjectStatus field can be modified by Automation.

OldClass

int

No

Field used by hold the original class as the ObjectStatus field can be modified by Automation.

Table A-2: **alerts.status Table**
Field Name	Field Type	Field Size	Mandatory	Description
Identifier	char	255	Yes	Internal hash key/table identifier.Set by the Info Mediators for the Cisco Info Server for de-duplication.
Serial	incr		Yes	Unique serial number generated by the Cisco Info Server.
Node	char	64	Yes	This field identifies the origin of alerts. As the origin is usually the Cisco WAN Manager (SNMP Manager), this field contains either the name or IP address of the Cisco WAN Manager hosts. The only exception to this is for user connection traps. See the Cisco Info Center Mediator and Gateway Reference guide for more information.
NEName	char	64	No	Name of the network element reporting the event.
Manager	char	64	Yes	Name given to the Info Mediator to identify the source of event. This is set within the Mediator properties. For example, NNM is the HP NNM Mediator. SV+ is the Cisco WAN Manager Mediator.
Agent	char	64	No	Descriptive name of sub manager which generated the alert.
AlertGroup	char	64	No	Used in the Generic, Type 3, and Type 4 automations to group event pairs. See the Cisco Info Center Administrator Reference guide for more information on Automations.
AlertKey	char	64	Yes	Descriptive key with reference to the event. This field contains the instance of the Object, for example, NEName Slot for Card Events, Serial0 for Cisco IOS Router Events.
Severity	int		Yes	Severity of problem: 0 Clear, 1 Indeterminate, 2 Warning, 3 Minor, 4 Major, 5 Critical.
Summary	char	255	Yes	Summary of alert/problem as human readable text to appear on the administration console.
StateChange	optime		Yes	Automatically maintained timestamp at Cisco Info Server of last insert/update of alert from any source.
FirstOccurrence	time		Yes	Time (in seconds, since Jan. 1, 1970) when this alert was created or when polling started at the Mediator.
LastOccurrence	ltime		Yes	Time when this alert was last updated at the Mediator.
InternalLast	timestamp		Yes	Time when this alert was updated at the Cisco Info Server.
Poll	int		No	Frequency of polling for this alert in seconds.
Type	int		No	Used in the Generic, Type 3 and Type 4 automations to define the relationship between event pairs. See the Cisco Info Center Administrator Reference guide for more information on Automations.
Tally	opcount		Yes	Automatically maintained count of the number of inserts/updates of the alert from any source.
Class	int		Yes	Class the event belongs to. This field defines the context sensitive tools available to each event. See the Cisco Info Center Administrator Reference guide for more information on classes, menus, and menu options.
Grade	int		No	Grade of alert/problem within the set severity.
Location	char	64	No	This field is currently not used and can be used by the Service Provider to populate this with the location name.
OwnerUID	int	8	Yes	Userid of the user who is assigned to handle this alert.
OwnerGID	int	8	No	Group ID of the group assigned to handle this alert.
Acknowledged	int	8	Yes	Has assigned user acknowledged the assignment? (0 means No, 1 means Yes).
Flash	int		No	Enables the option to make the Event List flash.
ServerName	char	64	Yes	Name of originating server. Used by Cisco Info Gateways to control propagation of alerts between Cisco Info Server.
ServerSerial	int	8	Yes	Serial number of alert on originating server (when not originated on this server). Used by Cisco Info Gateways to control propagation of alerts between Cisco Info Server.
NEAddress	char	32	Yes	IP address of the network element used by the Cisco WAN Manager machine to access the network element.
NEType	int		Yes	0 - IPX 1 - BPX 2 - IGX 3 - AXIS 4 - DAS 5 - VNS 6 - DASD 12 - ESP 999 Unknown 1000 Info Center Mediator.
ObjectType	char	64	Yes	NE Card Connection Endpoint Endpoint.FR Endpoint.ATM Endpoint.CE Endpoint.VOICE Line.access Line.trunk Peripheral Peripheral.dc Peripheral.disk Peripheral.fan Peripheral.ps Peripheral.ts Port Port.ATM Port.FR Port.VOICE System System.config System.connectivity System.general System.nic System.redundancy System.test
SubObjectType	char	64	No	Used to further identify the object. The value in this field depends upon the ObjectType. This field is not mandatory and may be blank in some cases.
ObjectStatus	int		No	The current status of the object reporting the event. For example, Down, Added, Inserted, etc. Events cleared by automation contain Cleared in the ObjectStatus.
Slot	char	4	No	Slot number of the network element reporting the event.
PSAP	char	6	No	Physical Service Access Point. The PSAP is a hierarchical identifier for the resource over which virtual circuits are provisioned. The word "Physical" here refers to the OSI layer, thus, a PSAP identifies the Layer 1 facility. This hierarchical structure follows the following convention: <physical_line>.<sub_channel1>.<sub_channel2><sub_channeln>. For single port cards, physical line number is always 1. For multi-port cards, physical line number starts at 1.
LSAP	char	6	No	Logical Service Access Point. For naming consistency, the concept of logical port numbering at the card level was introduced. For cards such as UFM, FRSM, and AUSM, a logical identifier for the port is created when the port is provisioned. It can essentially be thought of as a random number, as it has no inherent physical information contained within it. These identifiers are stored in the LSAP field. For IMA, it is this number which remains constant, even when lines are added and deleted from the port. For virtual trunks, the LSAP contains the user assigned Trunk ID.
DSAP	char	24	No	Data Link Service Access Point. This field contains the virtual circuit identifier. The syntax is <DSAP> (<annotation>), with a space delimiting the DSAP from the annotation, and the annotation appearing in parentheses. This SAP is used between OSI Layer 3 and Layer 2 to identify virtual circuits. Depending on the trap type and trap subtype, this field would contain: FR: DSAP = <DLCI> (DLCI) ATM: DSAP = <VPI>[.<VCI>] (VPI/VCI)
RemoteNEName	char	64	No	This field contains the remote network element name for connection and trunk events.
RemoteSlot	char	4	No	This field contains the slot number for the remote network element name for connection and trunk events.
RemotePSAP	char	6	No	This field contains the PSAP for the remote network element name for connection and trunk events.
RemoteLSAP	char	6	No	This field contains the LSAP for the remote network element name for connection and trunk events.
RemoteDSAP	char	24	No	This field contains the DSAP for the remote network element name for connection events.
AdditionalInfo	char	255	No	This field contains values for all SNMP VarBinds received in the traps that don't fall into one of the other fields.
TrapReason	char	64	No	This field contains the trap reason code as specified in the MIB for BPX and IGX. For AXIS, VNS, ESP, trap reason is populated by the trap number itself, as each trap is associated with a specific event. This allows filtering on a range of traps, based on trap identifiers.
Customer	char	64	No	This field is currently not used and can be used by the Service Provider to populate this with the customer name.
Site	char	64	No	Physical location field. This is left to be specified by the Service Provider.
ServiceIdentifier	char	64	No	This field is currently not used not used and can be used by the Service Provider
ServiceType	char	24	No	This field is used by the Real Time Counter tool to determine the counters. See the Cisco Info Center Administrator Reference guide for more information
BitMapField	char	36	No	This field contains the BitMap from one of the SNMP VarBinds received by the Mediators.The Deocode BitMap tool uses the information within this field along with the Convert field to display the decoded values.
Convert	char	64	No	Field used by the BitMap Decode tool to define the conversion values for the BitMap held in the above field.
OldObjectStatus	int		No	Field used by hold the original status as the ObjectStatus field can be modified by Automation.
OldClass	int		No	Field used by hold the original class as the ObjectStatus field can be modified by Automation.

alerts.details Table

The Details table contains the detail attributes of the events in the system. Table A-3 displays the alerts.details table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	255	Internal sequencing string for uniqueness.
Identifier	char	255	Identifier (as status table) to relate details to entries in the status table.
AttrVal	int		Boolean; when true, Name and Detail fields are valid, otherwise, only the Detail field is valid.
Sequence	int		Sequence number, used for ordering entries in Detail fields.
Name	char	255	Name of attribute stored in Detail field.
Detail	char	255	Attribute value.

Table A-3: alerts.details Table

Field Name Field Type Field Size Description

KeyField

char

255

Internal sequencing string for uniqueness.

Identifier

char

255

Identifier (as status table) to relate details to entries in the status table.

AttrVal

int

Boolean; when true, Name and Detail fields are valid, otherwise, only the Detail field is valid.

Sequence

int

Sequence number, used for ordering entries in Detail fields.

Name

char

255

Name of attribute stored in Detail field.

Detail

char

255

Attribute value.

alerts.journal Table

The Journal table provides a history of work performed on events. Table A-4 displays the alerts.journal table fields.

Table A-4: alerts.journal Table
Field Name Field Type Field Size Description

KeyField

char

255

Unique key field for table.

Serial

int

Serial number of the event this journal entry is related to.

UID

int

User ID of user who made this entry.

Chrono

time

Time and date this entry was made.

Text1

char

255

First block of text for journal entry.

Text2

char

255

Second block of text for journal entry.

Text3

char

255

Third block of text for journal entry.

Text4

char

255

fourth block of text for journal entry.

Text5

char

255

Fifth block of text for journal entry.

Text6

char

255

Sixth block of text for journal entry.

Text7

char

255

Seventh block of text for journal entry.

Text8

char

255

Eighth block of text for journal entry.

Text9

char

255

Ninth block of text for journal entry.

Text10

char

255

Tenth block of text for journal entry.

Text11

char

255

Eleventh block of text for journal entry.

Text12

char

255

Twelfth block of text for journal entry.

Text13

char

255

Thirteenth block of text for journal entry.

Text14

char

255

Fourteenth block of text for journal entry.

Text15

char

255

Fifteenth block of text for journal entry.

Text16

char

255

Sixteenth block of text for journal entry.

**Table A-4: alerts.journal Table**
Field Name	Field Type	Field Size	Description
KeyField	char	255	Unique key field for table.
Serial	int		Serial number of the event this journal entry is related to.
UID	int		User ID of user who made this entry.
Chrono	time		Time and date this entry was made.
Text1	char	255	First block of text for journal entry.
Text2	char	255	Second block of text for journal entry.
Text3	char	255	Third block of text for journal entry.
Text4	char	255	fourth block of text for journal entry.
Text5	char	255	Fifth block of text for journal entry.
Text6	char	255	Sixth block of text for journal entry.
Text7	char	255	Seventh block of text for journal entry.
Text8	char	255	Eighth block of text for journal entry.
Text9	char	255	Ninth block of text for journal entry.
Text10	char	255	Tenth block of text for journal entry.
Text11	char	255	Eleventh block of text for journal entry.
Text12	char	255	Twelfth block of text for journal entry.
Text13	char	255	Thirteenth block of text for journal entry.
Text14	char	255	Fourteenth block of text for journal entry.
Text15	char	255	Fifteenth block of text for journal entry.
Text16	char	255	Sixteenth block of text for journal entry.

Client Tool Support Tables

alerts.objclass Table

The alerts.objclass table is used to determine which menu and icons to use for a particular class of object. Table A-5 displays the alerts.objclass table fields.

Field Name	Field Type	Field Size	Description
Tag	int		Unique key field for the table; Class's numeric value.
Name	char	64	Name of the class.
Icon	char	255	Path and file name of default icon for tools.
Menu	char	64	Name of the Tools menu (in objmenus table) for the menu associated with this class. Used by tools to display appropriate menu.

Table A-5: alerts.objclass Table

Field Name Field Type Field Size Description

Tag

int

Unique key field for the table; Class's numeric value.

Name

char

64

Name of the class.

Icon

char

255

Path and file name of default icon for tools.

Menu

char

64

Name of the Tools menu (in objmenus table) for the menu associated with this class. Used by tools to display appropriate menu.

alerts.objmenus Table

The alerts.objmenus table is used to provide the list of menus.Table A-6 displays the alerts.objmenus table fields.

Field Name	Field Type	Field Size	Description
Menu	char	64	Unique key field for table; menu name (referred to in objmenus table).
Columns	int		Number of columns the menu should use.

Table A-6: alerts.objmenus Table

Field Name Field Type Field Size Description

Menu

char

64

Unique key field for table; menu name (referred to in objmenus table).

Columns

int

Number of columns the menu should use.

alerts.objmenuitems Table

The alerts.objmenuitems table is used to provide the contents of menus. Table A-7 displays the alerts.objmenuitems table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	255	Unique key field for table.
Menu	char	64	Menu name (referred to in objmenus table).
Sequence	char		Number used to determine order of the menu item in a menu when it is displayed.
Title	char	64	Displayed title for menu item.
Command1	char	255	Command to be executed when this item is selected in a tools menu (first block of).
Command2	char	255	Command to be executed (second block of).
Command3	char	255	Command to be executed (third block of).
Command4	char	255	Command to be executed (fourth block of).
RedirectStdin	int		Currently unused.
RedirectStdout	int		Boolean; when true (1), output is redirected to the dialog in the tool that called the command. Otherwise, the standard output is discarded.
RedirectStderr	int		Boolean; when true (1), error output is redirected to the dialog in the tool that called the command. Otherwise, the error output is discarded

Table A-7: alerts.objmenuitems Table

Field Name Field Type Field Size Description

KeyField

char

255

Unique key field for table.

Menu

char

64

Menu name (referred to in objmenus table).

Sequence

char

Number used to determine order of the menu item in a menu when it is displayed.

Title

char

64

Displayed title for menu item.

Command1

char

255

Command to be executed when this item is selected in a tools menu (first block of).

Command2

char

255

Command to be executed (second block of).

Command3

char

255

Command to be executed (third block of).

Command4

char

255

Command to be executed (fourth block of).

RedirectStdin

int

Currently unused.

RedirectStdout

int

Boolean; when true (1), output is redirected to the dialog in the tool that called the command. Otherwise, the standard output is discarded.

RedirectStderr

int

Boolean; when true (1), error output is redirected to the dialog in the tool that called the command. Otherwise, the error output is discarded

alerts.resolutions Table

The alerts.resolutions table is used to maintain the Resolutions option in the Event List. Table A-8 displays the alerts.resolutions table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	v	Unique key for the table.
Tag	int		Class value for this resolution.
Sequence	int		Sequence number which sets ordering at display time.
Title	char	64	Title of resolution.
Resolution1	char	255	First line of text for resolution.
Resolution2	char	255	Second line of text for resolution.
Resolution3	char	255	Third line of text for resolution.
Resolution4	char	255	Fourth line of text for resolution.

Table A-8: alerts.resolutions Table

Field Name Field Type Field Size Description

KeyField

char

v

Unique key for the table.

Tag

int

Class value for this resolution.

Sequence

int

Sequence number which sets ordering at display time.

Title

char

64

Title of resolution.

Resolution1

char

255

First line of text for resolution.

Resolution2

char

255

Second line of text for resolution.

Resolution3

char

255

Third line of text for resolution.

Resolution4

char

255

Fourth line of text for resolution.

alerts.conversions Table

The alerts.conversions table is used to provide easy conversion from a numeric value to a string for any column. Table A-9 displays the alerts.conversions table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	255	Unique key for the table; Internal sequencing string (comprised of Colname and Value).
Colname	char	255	Name of column this conversion is appropriate for.
Value	int		Numeric value for conversion.
Conversion	char	255	String value for conversion.

Table A-9: alerts.conversions Table

Field Name Field Type Field Size Description

KeyField

char

255

Unique key for the table; Internal sequencing string (comprised of Colname and Value).

Colname

char

255

Name of column this conversion is appropriate for.

Value

int

Numeric value for conversion.

Conversion

char

255

String value for conversion.

alerts.col_visuals Table

The alerts.col_visuals table is used to provide the default visuals for fields when displayed in the Cisco Info Admin Desktop tools. Table A-10 displays the alerts.col_visuals table fields.

Field Name	Field Type	Field Size	Description
Colname	char	255	Name of column for the visual settings.
Title	char	255	Title of column when displayed.
DefWidth	int		Default width of column when displayed.
MaxWidth	int		Maximum width of column.
TitleJustify	int		Justification for column's title: 0 - left, 1 - center, 2 - right.
DataJustify	int		Justification for column's data: 0 - left, 1 - center, 2 - right.

Table A-10: alerts.col_visuals Table

Field Name Field Type Field Size Description

Colname

char

255

Name of column for the visual settings.

Title

char

255

Title of column when displayed.

DefWidth

int

Default width of column when displayed.

MaxWidth

int

Maximum width of column.

TitleJustify

int

Justification for column's title: 0 - left, 1 - center, 2 - right.

DataJustify

int

Justification for column's data: 0 - left, 1 - center, 2 - right.

alerts.colors Table

The alerts.colors table is used to create the colors required by the Cisco Info Admin Desktop. Table A-11 displays the alerts.colors table fields.

Table A-11: alerts.colors Table
Field Name Field Type Description

Severity

int

Severity of problem: 0 Clear, 1 Indeterminate, 2 Warning, 3 Minor, 4 Major,
5 Critical.

AckedRed

int

RGB value of the color red for acknowledged events. Must be in the range 0-255.

AckedGreen

int

RGB value of the color green for acknowledged events. Must be in the range 0-255.

AckedBlue

int

RGB value of the color blue for acknowledged events. Must be in the range 0-255.

UnackedRed

int

RGB value of the color red for unacknowledged events. Must be in the range 0-255.

UnackedGreen

int

RGB value of the color green for unacknowledged events. Must be in the range 0-255.

UnackedBlue

int

RGB value of the color green for unacknowledged events. Must be in the range 0-255.

**Table A-11: alerts.colors Table**
Field Name	Field Type	Description
Severity	int	Severity of problem: 0 Clear, 1 Indeterminate, 2 Warning, 3 Minor, 4 Major, 5 Critical.
AckedRed	int	RGB value of the color red for acknowledged events. Must be in the range 0-255.
AckedGreen	int	RGB value of the color green for acknowledged events. Must be in the range 0-255.
AckedBlue	int	RGB value of the color blue for acknowledged events. Must be in the range 0-255.
UnackedRed	int	RGB value of the color red for unacknowledged events. Must be in the range 0-255.
UnackedGreen	int	RGB value of the color green for unacknowledged events. Must be in the range 0-255.
UnackedBlue	int	RGB value of the color green for unacknowledged events. Must be in the range 0-255.

User Authentication Tables

master.names Table

The master.names table is used to provide user identification and authorization. Table A-12 displays the master.names table fields.

Field Name	Field Type	Field Size	Description
Name	char	64	UNIX user name.
UID	int		User ID of user.
GID	int		Group ID of user.
Passwd	char	64	Encrypted password for user.
Type	int		User type: 1 - Supervisor, 2 - Administrator, 3 - Normal User, 4 - Nobody User.

Table A-12: master.names Table

Field Name Field Type Field Size Description

Name

char

64

UNIX user name.

UID

int

User ID of user.

GID

int

Group ID of user.

Passwd

char

64

Encrypted password for user.

Type

int

User type: 1 - Supervisor, 2 - Administrator, 3 - Normal User,
4 - Nobody User.

master.groups Table

The master.groups table is used to provide groups identification and authorization. Table A-13 displays the master.groups table fields.

Field Name	Field Type	Field Size	Description
Name	char	64	UNIX user name.
GID	int		Group ID.

Table A-13: master.groups Table

Field Name Field Type Field Size Description

Name

char

64

UNIX user name.

GID

int

Group ID.

master.members Table

The master.members table is used to provide user identification and authorization. Table A-14 displays the master.members table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	64	Unique key field for table.
UID	int		User ID.
GID	int		Group ID.

Table A-14: master.members Table

Field Name Field Type Field Size Description

KeyField

char

64

Unique key field for table.

UID

int

User ID.

GID

int

Group ID.

master.profiles Table

The master.profiles table is used to provide the user restriction information. Table A-15 displays the master.profiles table fields.

Field Name	Field Type	Field Size	Description
KeyField	char	64	Unique key field for table.
Restrict1	char	255	First line of restriction.
Restrict2	char	255	Second line of restriction.
Restrict3	char	255	Third line of restriction.
Restrict4	char	255	Fourth line of restriction.
AllowISQL	int		ISQL access.

Table A-15: master.profiles Table

Field Name Field Type Field Size Description

KeyField

char

64

Unique key field for table.

Restrict1

char

255

First line of restriction.

Restrict2

char

255

Second line of restriction.

Restrict3

char

255

Third line of restriction.

Restrict4

char

255

Fourth line of restriction.

AllowISQL

int

ISQL access.

master.stats Table

The master.stats table is used to control the -stats Cisco Info Server command line option. Table A-16 displays the master.stats table fields.

Field Name	Field Type	Description
StatTime	time	The time the statistics are collected.
NumClients	int	The number of clients, for example, desktops, attached to the Cisco Info Server.
NumRealtime	int	The number of real time clients attached to the Cisco Info Server.
NumProbes	int	The number of Cisco Info Mediators attached to the Cisco Info Server.
NumGateways	int	The number of Cisco Info Gateways attached to the Cisco Info Server.
NumMonitors	int	The number of monitors connected to the Cisco Info Server. This is applicable to Internet Service Monitors from Micromuse.
NumProxys	int	The number of Proxy Servers connected to the Cisco Info Server.
EventCount	int	The current number of events in the Cisco Info Server.
JournalCount	int	The current number of journals in the Cisco Info Server.
DetailCount	int	The current number of details in the Cisco Info Server.

Table A-16: master.stats Table

Field Name Field Type Description

StatTime

time

The time the statistics are collected.

NumClients

int

The number of clients, for example, desktops, attached to the Cisco Info Server.

NumRealtime

int

The number of real time clients attached to the Cisco Info Server.

NumProbes

int

The number of Cisco Info Mediators attached to the Cisco Info Server.

NumGateways

int

The number of Cisco Info Gateways attached to the Cisco Info Server.

NumMonitors

int

The number of monitors connected to the Cisco Info Server. This is applicable to Internet Service Monitors from Micromuse.

NumProxys

int

The number of Proxy Servers connected to the Cisco Info Server.

EventCount

int

The current number of events in the Cisco Info Server.

JournalCount

int

The current number of journals in the Cisco Info Server.

DetailCount

int

The current number of details in the Cisco Info Server.

Automation Tables

auto.triggers Table

The auto.triggers table is used to control automation triggers. Table A-17 displays the auto.triggers table fields.

Field Name	Field Type	Field Size	Description
Name	char	64	The name of the trigger.
Cond1	char	255	The first line of the trigger SQL.
Cond2	char	255	The second line of the trigger SQL.
Cond3	char	255	The third line of the trigger SQL.
Cond4	char	255	The fourth line of the trigger SQL.
AutoExec	char	64	The ascent action.
DecExec	int		The descent action.
OwnerUID	int		The UID of the trigger owner.
Active	int		Indicates whether the trigger is currently active or not. 0 - not active, 1 - active
Level	int		Indicates whether the trigger is a level or edge trigger.
EvalPeriod	int		The sample rate of the trigger.
Threshold	int		The delay threshold of the trigger.
Hits	int		Reserved for future use.
ProcessAllHits	int		Indicates whether the trigger should fire for each matched row, or just for the first row.
Comment1	char	255	The first line of the trigger description.
Comment2	char	255	The second line of the trigger description.
Comment3	char	255	The third line of the trigger description.
Comment4	char	255	The fourth line of the trigger description.

Table A-17: auto.triggers Table

Field Name Field Type Field Size Description

Name

char

64

The name of the trigger.

Cond1

char

255

The first line of the trigger SQL.

Cond2

char

255

The second line of the trigger SQL.

Cond3

char

255

The third line of the trigger SQL.

Cond4

char

255

The fourth line of the trigger SQL.

AutoExec

char

64

The ascent action.

DecExec

int

The descent action.

OwnerUID

int

The UID of the trigger owner.

Active

int

Indicates whether the trigger is currently active or not.
0 - not active, 1 - active

Level

int

Indicates whether the trigger is a level or edge trigger.

EvalPeriod

int

The sample rate of the trigger.

Threshold

int

The delay threshold of the trigger.

Hits

int

Reserved for future use.

ProcessAllHits

int

Indicates whether the trigger should fire for each matched row, or just for the first row.

Comment1

char

255

The first line of the trigger description.

Comment2

char

255

The second line of the trigger description.

Comment3

char

255

The third line of the trigger description.

Comment4

char

255

The fourth line of the trigger description.

auto.actions Table

The auto.actions table is used to control automation triggers. Table A-18 displays the auto.actions table fields.

Field Name	Field Type	Field Size	Description
Name	char	64	The name of the action.
HasData	int
Data1	char	255	The first line of the data effect SQL.
Data2	char	255	The second line of the data effect SQL.
Data3	char	255	The third line of the data effect SQL.
Data4	char	255	The fourth line of the data effect SQL.
Hasexec	int		Indicates whether the action has an external effect or not.
ExecPath	char	255	The pathname of the external effect executable.
ExecArgs	char	255	The arguments of the external effect executable.
ExecHost	char	64	The hostname of the host to run the external effect executable on.
EUID	int		Effective user ID.
HasPhone	int		Reserved for future use.
PhoneArgs1	char	255	Reserved for future use.
PhoneArgs2	char	255	Reserved for future use.
PhoneArgs3	char	255	Reserved for future use.
PhoneArgs4	char	255	Reserved for future use.
Comment1	char	255	The first line of the action description.
Comment2	char	255	The second line of the action description.
Comment3	char	255	The third line of the action description.
Comment4	char	255	The fourth line of the action description.

Table A-18: auto.actions Table

Field Name Field Type Field Size Description

Name

char

64

The name of the action.

HasData

int

Data1

char

255

The first line of the data effect SQL.

Data2

char

255

The second line of the data effect SQL.

Data3

char

255

The third line of the data effect SQL.

Data4

char

255

The fourth line of the data effect SQL.

Hasexec

int

Indicates whether the action has an external effect or not.

ExecPath

char

255

The pathname of the external effect executable.

ExecArgs

char

255

The arguments of the external effect executable.

ExecHost

char

64

The hostname of the host to run the external effect executable on.

EUID

int

Effective user ID.

HasPhone

int

Reserved for future use.

PhoneArgs1

char

255

Reserved for future use.

PhoneArgs2

char

255

Reserved for future use.

PhoneArgs3

char

255

Reserved for future use.

PhoneArgs4

char

255

Reserved for future use.

Comment1

char

255

The first line of the action description.

Comment2

char

255

The second line of the action description.

Comment3

char

255

The third line of the action description.

Comment4

char

255

The fourth line of the action description.

Java Event List Tables

jel.jel_props Table

The jel.jel_props table is used to control Java Event List and Java JELD. It is maintained by the JACE configuration tool (do not edit it directly). Table A-19 displays the jel.jel_props table fields.

Field Name	Field Type	Field Size	Description
KeyField	incr		Unique key field for table.
ConfigName	char	127	The name of the configuration.
PropSet	char	127	The name of a set within the configuration.
PropName	char	127	The name of a property within a set.
PropVal	char	255	The value of a property.

Table A-19: jel.jel_props Table

Field Name Field Type Field Size Description

KeyField

incr

Unique key field for table.

ConfigName

char

127

The name of the configuration.

PropSet

char

127

The name of a set within the configuration.

PropName

char

127

The name of a property within a set.

PropVal

char

255

The value of a property.

Cisco Info Server Properties

Note, some properties are read only; these are information only properties for use by upgrade scripts and other utilities.

The Cisco Info Server properties currently supported are shown in Table A-20.

Table A-20: Cisco Info Server Properties Table
Property Name Editable Type Default Description

ServerMajorRel

No

int

3

Cisco Info Server major release number.

ServerMinorRel

No

int

3

Cisco Info Server minor release number.

ServerRevision

No

int

0

Cisco Info Server revision level.

AuditAutomation

Yes

boolean

False

Audit changes to the automation system (the auto database).¹

AuditNames

Yes

boolean

False

Audit changes to the authentication systems (the master database).

AuditConfig

Yes

boolean

False

Audit changes to the configuration tables (all tables in alerts database except status, journals and details).

AllowISQL

Yes

boolean

True

Allow connections to the Cisco Info Server using ISQL or nco_sql.

AllowConnections

Yes

boolean

True

Allow connections to the Info Server with any tool.

DebugLevel

Yes

int

0

Sets debug level of the Cisco Info Server. Overridden by the -debug command line option.

Granularity

Yes

int

60

Sets the granularity of the Cisco Info Server. Overridden by the -granularity command line option.

LogInterval

Yes

int

300

Sets the interval to consolidate the persistent database. Overridden by the -interval command line option.

AutoTick

Yes

int

1

Sets the clock tick interval for Automation handling. Overridden by the -autotick command line option.

UpdateAlertKey

Yes

boolean

False

When set, the new AlertKey value is copied on deduplication.

UpdateSummary

Yes

boolean

False

When set, the new Summary value is copied on deduplication.

ReawakenClosed

Yes

boolean

False

Sets the option to reawaken closed alarms when a new alarm arrives. (See Chapter 1, "Cisco Info Server").

DeackOnReawaken

Yes

boolean

False

When set, when an alert is reawakened, the Acknowledged field is cleared.

DebugTriggers

Yes

boolean

False

Sets the option to log the execution of triggers into the log file.

DebugActions

Yes

boolean

False

Sets the option to log the execution of actions into the log file.

UpTime

No

int

Time when the server came up.

MonitorConnections

Yes

boolean

True

Generates an alarm to say a process has connected to the Cisco Info Server.

StatsInterval

Yes

int

900

Controls the time interval for gathering statistics.

¹The Audit features when enabled, create SystemWatch alerts in the alerts.status table which inform users the change has occurred.

**Table A-20: Cisco Info Server Properties Table**
Property Name	Editable	Type	Default	Description
ServerMajorRel	No	int	3	Cisco Info Server major release number.
ServerMinorRel	No	int	3	Cisco Info Server minor release number.
ServerRevision	No	int	0	Cisco Info Server revision level.
AuditAutomation	Yes	boolean	False	Audit changes to the automation system (the auto database).¹
AuditNames	Yes	boolean	False	Audit changes to the authentication systems (the master database).
AuditConfig	Yes	boolean	False	Audit changes to the configuration tables (all tables in alerts database except status, journals and details).
AllowISQL	Yes	boolean	True	Allow connections to the Cisco Info Server using ISQL or nco_sql.
AllowConnections	Yes	boolean	True	Allow connections to the Info Server with any tool.
DebugLevel	Yes	int	0	Sets debug level of the Cisco Info Server. Overridden by the -debug command line option.
Granularity	Yes	int	60	Sets the granularity of the Cisco Info Server. Overridden by the -granularity command line option.
LogInterval	Yes	int	300	Sets the interval to consolidate the persistent database. Overridden by the -interval command line option.
AutoTick	Yes	int	1	Sets the clock tick interval for Automation handling. Overridden by the -autotick command line option.
UpdateAlertKey	Yes	boolean	False	When set, the new AlertKey value is copied on deduplication.
UpdateSummary	Yes	boolean	False	When set, the new Summary value is copied on deduplication.
ReawakenClosed	Yes	boolean	False	Sets the option to reawaken closed alarms when a new alarm arrives. (See Chapter 1, "Cisco Info Server").
DeackOnReawaken	Yes	boolean	False	When set, when an alert is reawakened, the Acknowledged field is cleared.
DebugTriggers	Yes	boolean	False	Sets the option to log the execution of triggers into the log file.
DebugActions	Yes	boolean	False	Sets the option to log the execution of actions into the log file.
UpTime	No	int		Time when the server came up.
MonitorConnections	Yes	boolean	True	Generates an alarm to say a process has connected to the Cisco Info Server.
StatsInterval	Yes	int	900	Controls the time interval for gathering statistics.

Proxy Server Properties

Note, some properties are read only; these are information only properties for use by upgrade scripts and other utilities.

The Proxy Server properties currently supported are shown in Table A-21.

Property Name	Editable	Type	Default	Description
ConnectionRatio	Yes	int	10	Ratio of incoming and outgoing connections.
DebugMode	Yes	boolean	False	Sets the option to debug the Proxy Server.
MaxConnections	Yes	int	30	Maximum number of connections to the Proxy Server.
RemoteServer	Yes	char	NCOMS	Sets the name of the Cisco Info Server to connect to.
ServerName	Yes	char	NCO_PROXY	The name of the Proxy Server.

Table A-21:

Property Name Editable Type Default Description

ConnectionRatio

Yes

int

10

Ratio of incoming and outgoing connections.

DebugMode

Yes

boolean

False

Sets the option to debug the Proxy Server.

MaxConnections

Yes

int

30

Maximum number of connections to the Proxy Server.

RemoteServer

Yes

char

NCOMS

Sets the name of the Cisco Info Server to connect to.

ServerName

Yes

char

NCO_PROXY

The name of the Proxy Server.

Proxy Server Properties

Cisco Info Server Command Line Options

The nco_objserv command uses the following format:

nco_objserv -name <string> -propsfile <string> -pa <string> -DNS <string>
-logfile <string> -uniquelog -connections <numeric> -port <numeric> -secure
-queue <numeric> -oldpa -stats -granularity <numeric> -interval <numeric>
-autotick <numeric> -timer <string> stacksize <numeric> -debug <numeric>
-DELETES <string> -stderr -version -help

Table A-22 lists the defaults for the nco_objserv command line options.

Table A-22: Object Server Command Line Options
Option/Parameter Default Description

-name <string>

NCOMS

Sets the server name. When omitted, defaults to NCOMS.

-propsfile <string>

$OMNIHOME/etc/servername.props

Sets the Cisco Info Server properties file name.

-pa <string>

NCO_PA

Sets the process agent name.

-DNS <string>

off

Sets a hostname for clients to use to locate the Cisco Info Server. This is used when the site uses DNS naming, however, the machines have their own non-DNS name.

-logfile <string>

$OMNIHOME/log/<servername>.log

Sets the filename of the log file.

-uniquelog

off

Without -logfile set, forces the log file to be uniquely named by appending the process ID of the Cisco Info Server to the end of the default log file name. With -logfile set, this has no effect.

-connections <numeric>

30

Sets the total number of available connections for Desktops, Cisco Info Mediators, and Cisco Info Gateways.

-port <numeric>

Sets the IDUC port to listen.

-secure

Sets the security mode of the Cisco Info Server. When this is set, the Cisco Info Server authenticates connection requests with a user name and password.

-queue <numeric>

1024

Changes the queue size for the Cisco Info Server when the server is overloaded. This can be increased only.

-hashsize

5013

Sets the internal hash size tables to improve memory usage. The default is 5013.

-oldpa

Sets the Cisco Info Server to use the previous version of the NPPC protocol.

-stats

900

Sets the time interval for gathering statistics. To use the statistics gathering facility, uncomment the statistics table in the NCOMS.sql file.

-granularity <numeric>

60

Sets the granularity of updates to Desktops and Cisco Info Gateways.

-interval <numeric>

300

Sets the persistent store consolidation interval; the number of seconds between the Cisco Info Server consolidating the files in the db directory and restarting transaction based logging. Setting this to 0 disables the writing of these files (not recommended for production use).

-autotick <numeric>

1

Sets the number of seconds on which the automation system ticks, which in turn controls the sampling of triggers.

-timer <string>

Internal on Solaris 2.x and HP-UX, external on SunOS

Selects the timing mechanism to be used. Can be internal, external, or none. See Chapter 1, "Cisco Info Server" for full details.

-stacksize <numeric>

64K

Sets the stacksize for the internal multi-threading.

-debug <numeric>

0

Enables debug messages mode. The numeric specifies the amount of debug information required; available levels are 0 (Silent), 1, 2,and 3 (Ultra-verbose).

-DELETES <string>

off

Writes a separate log file which logs only deletes from any table in the Cisco Info Server.

-stderr

off

Redirects messages from the log file to stderr.

-version

off

Displays version information about the Cisco Info Server and exits.

-help

off

Displays help on nco_objserv command line options and exits.

**Table A-22: Object Server Command Line Options**
Option/Parameter	Default	Description
-name <string>	NCOMS	Sets the server name. When omitted, defaults to NCOMS.
-propsfile <string>	$OMNIHOME/etc/servername.props	Sets the Cisco Info Server properties file name.
-pa <string>	NCO_PA	Sets the process agent name.
-DNS <string>	off	Sets a hostname for clients to use to locate the Cisco Info Server. This is used when the site uses DNS naming, however, the machines have their own non-DNS name.
-logfile <string>	$OMNIHOME/log/<servername>.log	Sets the filename of the log file.
-uniquelog	off	Without -logfile set, forces the log file to be uniquely named by appending the process ID of the Cisco Info Server to the end of the default log file name. With -logfile set, this has no effect.
-connections <numeric>	30	Sets the total number of available connections for Desktops, Cisco Info Mediators, and Cisco Info Gateways.
-port <numeric>		Sets the IDUC port to listen.
-secure		Sets the security mode of the Cisco Info Server. When this is set, the Cisco Info Server authenticates connection requests with a user name and password.
-queue <numeric>	1024	Changes the queue size for the Cisco Info Server when the server is overloaded. This can be increased only.
-hashsize	5013	Sets the internal hash size tables to improve memory usage. The default is 5013.
-oldpa		Sets the Cisco Info Server to use the previous version of the NPPC protocol.
-stats	900	Sets the time interval for gathering statistics. To use the statistics gathering facility, uncomment the statistics table in the NCOMS.sql file.
-granularity <numeric>	60	Sets the granularity of updates to Desktops and Cisco Info Gateways.
-interval <numeric>	300	Sets the persistent store consolidation interval; the number of seconds between the Cisco Info Server consolidating the files in the db directory and restarting transaction based logging. Setting this to 0 disables the writing of these files (not recommended for production use).
-autotick <numeric>	1	Sets the number of seconds on which the automation system ticks, which in turn controls the sampling of triggers.
-timer <string>	Internal on Solaris 2.x and HP-UX, external on SunOS	Selects the timing mechanism to be used. Can be internal, external, or none. See Chapter 1, "Cisco Info Server" for full details.
-stacksize <numeric>	64K	Sets the stacksize for the internal multi-threading.
-debug <numeric>	0	Enables debug messages mode. The numeric specifies the amount of debug information required; available levels are 0 (Silent), 1, 2,and 3 (Ultra-verbose).
-DELETES <string>	off	Writes a separate log file which logs only deletes from any table in the Cisco Info Server.
-stderr	off	Redirects messages from the log file to stderr.
-version	off	Displays version information about the Cisco Info Server and exits.
-help	off	Displays help on nco_objserv command line options and exits.

Back Compatible and Depreciated Command Line Options

The command line options shown in Table A-23 are supported for backward version compatibility. Their use is already depreciated by other options on the command line and these options may not be supported in future versions.

nco_objserv -transient -norecover -fds numeric

Option	Default	Description
-transient	off	Starts the Cisco Info Server in transient mode.
-norecover	off	Starts the Cisco Info Server, however, it does not attempt to recover the previous run's status and tables.
-fds <numeric>	256	Sets the number of available file descriptors for the Cisco Info Server.

Table A-23: Cisco Info Server Backward Compatible and Depreciated Command Line Options

Option Default Description

-transient

off

Starts the Cisco Info Server in transient mode.

-norecover

off

Starts the Cisco Info Server, however, it does not attempt to recover the previous run's status and tables.

-fds <numeric>

256

Sets the number of available file descriptors for the Cisco Info Server.

Proxy Server Command Line Options

The nco_proxyserv command uses the following format:

nco_proxyserv -name <string> -propsfile <string> -logfile <string> -max <numeric>
-ratio <numeric> -debug <numeric> -version -help

Table A-24 lists the defaults for the nco_proxyserv command line options.

Option	Default	Description
-name <string>	NCO_PROXY	Sets the servername. When omitted, defaults to NCO_PROXY.
-propsfile <string>	$OMNIHOME/etc/<servername>.props	Sets the Proxy Server properties file name. This defaults to NCO_PROXY.props.
-logfile <string>	$OMNIHOME/log/<servername>.log	Sets the filename for the log file to be written to.
-max	30	Sets the number of connections for Cisco Info Mediators and Cisco Info Gateways.
-ratio	10	Sets the ratio of incoming to outgoing connections to the Proxy Server.
-debug <numeric>	0	Turns on debug messages. The number denotes the amount of debug information required; available levels are 0 (Silent), 1, 2,and 3 (Ultra-verbose).
-version	off	Displays version information about the Proxy Server and then exits.
-help	off	Displays help on nco_proxyserv command line options and then exits.

Table A-24: Proxy Server Command Line Options

Option Default Description

-name <string>

NCO_PROXY

Sets the servername. When omitted, defaults to NCO_PROXY.

-propsfile <string>

$OMNIHOME/etc/<servername>.props

Sets the Proxy Server properties file name. This defaults to NCO_PROXY.props.

-logfile <string>

$OMNIHOME/log/<servername>.log

Sets the filename for the log file to be written to.

-max

30

Sets the number of connections for Cisco Info Mediators and Cisco Info Gateways.

-ratio

10

Sets the ratio of incoming to outgoing connections to the Proxy Server.

-debug <numeric>

0

Turns on debug messages. The number denotes the amount of debug information required; available levels are 0 (Silent), 1, 2,and 3 (Ultra-verbose).

-version

off

Displays version information about the Proxy Server and then exits.

-help

off

Displays help on nco_proxyserv command line options and then exits.

Cisco Info Server SQL

The following sections show example Cisco Info Server commands.

Select

Select allows you to find information in a table. For example, to select all the records where the Severity field is equal to 4, specify:

select * from alerts.status where Severity = 4;

To select all the records where the Node field starts with the word terminal followed by any other characters, specify:

select * from alerts.status where Node like 'terminal.*';

Update

Update allows you to change the information in the database. For example, to set the Severity to 0 for any record in the status table where the Node is equal to Fred, specify:

update alerts.status set Severity = 0 where Node = 'Fred';

You can also specify more than one command at the same time. For example, the following command searches for a record where the Severity is equal to 1 and the node is equal to Fred, then sets the Severity to 0 and changes the Summary field to the string Discarded:

update alerts.status set Severity = 0, Summary = 'Discarded' where Severity = 1 and Node = 'Fred';

Delete

Delete allows you to remove records from the status table. For example, to remove all the records where the Node field is equal to Fred, specify:

delete from alerts.status where Node = 'Fred';

Boolean Operators

You can use a number of boolean operators which evaluate to true or false. Table A-25 displays the available operators.

Operators	Description
a = b	a is equal to b?
a < b	a is less than b?
a > b	a is greater than b?
a < > b	a is not equal to b?
a like b	a is like b?
a not like b	a is not like b?

Table A-25:

Operators Description

a = b

a is equal to b?

a < b

a is less than b?

a > b

a is greater than b?

a < > b

a is not equal to b?

a like b

a is like b?

a not like b

a is not like b?

Boolean Operator in Cisco Info Server SQL

Use the like comparison where you require a wildcard match. Table A-26 shows how you can use the like comparisons.

Table A-26: Boolean Comparisons

where b is... and a is... This evaluates to...

Fr.*

Fred
Flip
fred

True
False
False

*-test

node-test
new-test
-test
This is a test of

True
True
True
False

Fred

Fred
Frederick
fred
Do you know Fres?

True
False
False
False

You can combine comparisons with the expressions and and or. For example, you could specify the following comparison:

Node = 'node1' and Severity > 4 and Summary like 'alert on .*'

Node = 'node1' or Node = 'node2' or Node = 'dbms1'

SQL Syntax

This section describes the SQL syntax.

The Detailed Syntax

alphachar = a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z

number = 0|1|2|3|4|5|6|7|8|9

string = 'any sequence of ASCII characters'

Note Strings can contain a single ' by escaping the string as \'.

intnum = number{number} | {number}.number{number}

name = alphachar{alphachar|number|_}

Note Examples of legal names include Fred1, Data_base, fast4some, and not_4_some.

column-name = name

table-name = name

database-name = name

table-ref = database-name.table-name | table-name

literal = intnum | string | dateliteral | property

property = %name |

: %ServerName |
%OMNIHOME |
%LogFile |
%HostName

Note Name can be any Cisco Info Server property. The subsequent properties refer to internal variables.

scalar = column-name | literal

scalar-expression =

: scalar + scalar |
scalar - scalar |
scalar * scalar |
scalar / scalar |
+scalar |
-scalar |
(scalar-expression) |
scalar

arith-expression =

: sum(column-name) |
min(column-name) |
max(column-name) |
avg(column-name) |
count(column-name) |
count(*) |
dist(column-name, exactnum)

boolean-expression =

: scalar-expression (<|>|=|<>|<=|>=) literal |
scalar-expression [not] like literal |
scalar-expression [not] in (subquery | (literal { ,
literal}))

search-condition = search-condition (and | or) search-condition |

: not search-condition |
(search-condition) |
boolean-expression

ordering-spec = column-name asc | desc {, column-name asc | desc}

subquery = select [(scalar-expression{, scalar-expression} | *]

: from [table-name]
[where search_condition]
[order by ordering-spec]

data-type =

: character [(int-val)] |
int |
time |
incr |
timestamp |
ltime |
optime |
opcount

table-constraint =

: unique (column-name) |
primary key (column-name) |
permanent |
notify on (never|insert|delete|update|change) |
iduc on (column-name)

table-entry = field-name data-type | table-constraint

state = good | marginal | bad

Search Conditions

A search condition specifies what you are looking for in the tables. The syntax for a search condition is detailed in the previous section. The following are some examples:

name not like 'John.*' and age > 20

(name like 'Jilted' and age <20) or (name like 'John' and age = 22)

not (name like 'Jilted' and age = 20) and not (name like 'John' and age >25)

Date Literals

A set of literals exist which return date information about the current time. These are called the date literals and are used for time-sensitive automation or filters.

getdate

getdate returns the current time to allow for comparisons with time based on the current time. getdate is equivalent to the integer value of the current date and time in seconds, such as a time field. Note, when the getdate function is used in a subtraction, a space character must precede and follow the minus sign, otherwise, the equation is not evaluated correctly.

dayname

dayname returns the name of the current day (for example, mon, tue, fri).

monthname

monthname returns the name of the current month (for example, jan, feb, jul).

dayofmonth

dayofmonth returns the day of the current month (for example, when it is January 21st, dayofmonth returns 21).

minuteofhour

minuteofhour returns the minute of the current hour (for example, when it is 11:31 then minuteofhour returns 31).

hourofday

hourofday returns the hour of the current day (for example, when it is 11:31 then hourofday returns 11).

dayasnum

dayasnum returns the day of the current week as a number (for example, when it is Sunday then dayasnum returns 0, Monday 1, Tuesday 2).

monthasnum

monthasnum returns the month of the current year as a number (for example, when it is January then monthasnum returns 1, December 12).

Statement Syntax

create database database-name;

use database database-name;

create table table-name (table-entry {, table-entry});

password string, string;

use database database-name;

delete from table-ref [via string] [where search-condition];

insert into table-ref values (literal {, literal});

select (* | (scalar-expression { , scalar-expression})) from table-ref [where search-condition] [order by ordering-spec];

select [arith-expression { , arith-expression }] from table-ref [where search-condition];

update table-ref set column-name = scalar-expression { , column-name = scalar_expression} [where search-condition];

shutdown;

describe table-ref;

users;

list databases;

list tables [in database-name];

sync [database database-name | table table-ref];

get prop prop-name;

set prop prop-name to simple-value;

show props;

save props [to filename];

svc update name state;

SQL Commands

This section details each command, its syntax, its usage, and provides examples.

create database

Syntax

create database database-name;

Usage

create database creates a new in-memory database under which tables may be created.

Example

create database newthings;

create table

Syntax

create table table-name (table-entry {,table-entry});

Usage

Creates a table within the in-memory database currently in use. The table-name is the name of the new table to create. For each field in the table, table-name and a data-type must be specified with a comma between each. This comma list can be followed by any number of table-entry entries which define the handling of the table.

Example

create table newtable (

: name char(20),
: age integer,
: unique (name));

password

Syntax

password string, string;

Usage

The first string is the name of the user whose password is to be changed. The second string is the new password.

Example

password 'dj','realpassword' ;

use

Syntax

use database database-name;

Usage

Uses the named database as the default for locating tables.

Example

use database newthings;

delete

Syntax

delete from table-name [where <search-condition>];

Usage

Deletes all rows from the table-name table that match the <search-condition> after the where. When no where and <search-condition> are specified, all rows are deleted.

Example

delete from newtable where age > 20;

Direct Delete

Alternatively, you can use via to delete one row only from the database table. For example, specify:

delete from newtable via string where age > 20;

Where string is an identifier in the database table.

insert

Syntax

insert into table-name values (literal{,literal});

Usage

Inserts a row into an existing named table. It is assumed values are specified for all columns in the order they were specified in the create statement for that table. The data to be inserted follows the values keyword in a parenthesized comma separated list of literal values.

Example

insert into newtable values ('fred', 30);

select

Syntax

select (* | (scalar-expression {,scalar-expression})) from table-name [where search-condition] [order by ordering-spec] ;

select [arith-expression{,arith-expression}] from table-name [where search-condition] ;

Usage

select extracts fields of data from a table.

1. This syntax is for retrieving fields. Immediately after select can be an asterisk (*) (representing all fields) or a comma separated list of specific fields to be extracted. This is followed by the from keyword and the name of the table from which to extract. This can then be followed by an optional where keyword and search condition and an optional order by keyword with an ordering specification.

2. This syntax returns the result of the arithmetic-expressions based on the table (named after the from keyword) and an optional search condition (defined after the where keyword).

Examples

select * from newtable where age > 20 and name ! like 'test.+'

select max(age) from alerts.status where name like 'fred .+'

update

Syntax

update <table-name> set column-name =(scalar-expression) {,column-name =
(scalar-expression)} [where search-condition];

Usage

Updates a table, named in <table-name>, setting values for the comma separated list of settings that follows the set keyword, for entries in the table that match the search condition which follows the where.

Examples

update newtable set age=90 if age>91;

update newtable set age=10,name='Peter Pan' where name = 'Peter';

Direct Update

Alternatively, you can use via to update one row only in the database table. For example, specify:

update newtable via string set age=90 if age>91;

Where string is an identifier in the database table.

shutdown

Syntax

shutdown;

Usage

Super user only.

Shuts down the Cisco Info Server after synchronizing the persistent store.

Example

shutdown;

describe

Syntax

describe table-name;

Usage

Prints details of the named table, describing field names, types and sizes of fields.

Example

describe newtable;

users

Syntax

users;

Usage

Lists the names of all the users connected to the Cisco Info Server.

Example

users;

list databases

Syntax

list databases;

Usage

Lists the databases in the Cisco Info Server.

Example

list databases;

list tables

Syntax

list tables [in database-name];

Usage

Lists the tables in the current database. When in <database-name> is appended, the tables in the specified database are listed.

Examples

list tables;

list tables in alerts;

sync

Syntax

sync [database database-name | table table-ref];

Usage

Forces the consolidation of either an entire database with the database-name parameter or of a specific table with table-ref appended. Consolidation writes out the current data and brings in the .trans file changes and applies them to the .dat file.

Examples

sync database alerts;

sync table alerts.status;

get prop

Syntax

get prop prop-name;

Usage

Returns the value of the property where <prop-name> is the name of the property. It is returned as a single SQL row.

Example

get prop DebugLevel;

set prop

Syntax

set prop prop-name to simple-value;

Usage

Sets a property value where prop-name is the name of the property to set and simple-value is the value to set that property to. The simple-value can be an integer value (for example, 0,10,2000), a boolean value (for example, TRUE or FALSE), or a single quoted string (for example, 'string value').

Note, there are no string properties currently defined in the system; the facility has been added for future expansion.

where b is...	and a is...	This evaluates to...
Fr.*	Fred Flip fred	True False False
*-test	node-test new-test -test This is a test of	True True True False
Fred	Fred Frederick fred Do you know Fres?	True False False False

Table of Contents

Cisco Info Server Reference