AutoNOC 2.5 User Guide
Preface
Acknowledgements
System Requirements
Legal

Part 1 - Introduction
1.1 The Ideal Difference
1.2 Automated Operations
1.3 Services & Scaler
1.4 Acquisition Stacks
1.5 Portal Deployment
1.6 Discovery and Crawler
1.7 Monitoring Agents
1.8 Recoiling Database
1.9 Multiple Languages
1.10 Security

Part 2 - NOC Views
2.1 Investigate
2.2 Observe
2.3 Visualize
2.4 Alarms
2.5 Analyze
2.6 Design
2.7 Configure

Part 3 - Model Design
3.1 Object Model
3.2 Devices
3.3 Sets
3.4 Set Criteria
3.5 Probes
3.6 Logs & Events
3.7 Alarms
3.8 Actions
3.9 Reports
3.10 Users
3.11 Polling
3.12 Service Levels
3.13 Dependencies
3.14 Performance

Part 4 - Developer Features
4.1 Adding SNMP MIBs
4.2 Variables
4.3 OSP API
4.4 Probe Template
4.5 Log Template
4.6 Device Template
4.7 Interface Template
4.8 Rebranding

Part 5 - Troubleshooting
5.1 General Issues
5.2 Linux
5.3 Windows

Appendix
A.1 OSP API Functions
A.2 Variables
A.3 Object Reference

A.3 Object Reference
The following is a complete reference to all of the major objects in AutoNOC, complete with parameters and data types.


Object

Folder

Binary Size

16

Functionality

Create Object
Create Folder
Bulk Action
Move
Duplicate
Delete

 

Object

User

Binary Size

73

Functionality

Delete

Password

Password
String [0 to 255 Chars]

Specify a password for this account.
Password (Verification)
String [0 to 255 Chars]

Enter the password again to verify that it was typed correctly.

User Details

User's Full Name
String [0 to 255 Chars]

The full name of the user is typically the user's real name such as John Doe.
User Description
String [0 to 255 Chars]

A description of the purpose of the user.
E-Mail Address
String [0 to 255 Chars]

Specify the e-mail address for this user. E-mail alerts sent to sets containing this user will be sent to this user address.
Phone Number
String [0 to 255 Chars]

A phone number that can be used to contact this user.
Pager Number
String [0 to 255 Chars]

A human dialable pager number that can be used to contact this person.
Fax Number
String [0 to 255 Chars]

A fax number that can be used to send faxes addressed to this person.
Pager Gateway (TAP)
String [0 to 255 Chars]

A TAP/IXO gateway phone number that can be used to send alphanumeric pages and messages to this user. Contact your cell phone / paging system service provider to get information about your TAP/IXO pager gateway number.
Pager Gateway Pin (TAP)
String [0 to 255 Chars]

A pin number to be used when dialing the TAP/IXO gateway to send a user alphanumeric pages.

Session

No Session Timeout
Boolean [TRUE/FALSE]

Disable the automatic 60 minute session timeout that occurs if a user doesn't click on anything and the display doesn't refresh.

Security

Select Set
Object

Choose the set containing the objects that should be used.

Administrator Privileges
Boolean [TRUE/FALSE]

Toggles whether this user has administration privileges. Administrators can edit users and change portal parameters and procedures.
Designer Privileges
Boolean [TRUE/FALSE]

Toggles whether or not this user has designer privileges. Designer privileges allow the user to modify the actual model.
Technician Privileges
Boolean [TRUE/FALSE]

Gives the user technician privileges which allows disabling, enabling, and hiding of probes and other alerts.

Allow Investigate
Boolean [TRUE/FALSE]

Allow this user to access the investigate page.
Allow Observe
Boolean [TRUE/FALSE]

Allow this user to access the observe page.
Allow Visualize
Boolean [TRUE/FALSE]

Allow this user to access the visualize page.
Allow Analyze
Boolean [TRUE/FALSE]

Allow this user to access the analyze page.
Allow Alarms
Boolean [TRUE/FALSE]

Allow this user to access the alarms page.

 

Object

Alarms

Binary Size

21

Children

Alarm

Functionality

Create Object
Create Folder
Bulk Action

 

Object

Devices

Binary Size

21

Children

Device

Functionality

Discover
Create Object
Create Folder
Bulk Action

 

Object

Reports

Binary Size

21

Children

Inventory List
Probe Analysis

Functionality

Create Object
Create Folder
Bulk Action

 

Object

Sets

Binary Size

21

Children

Set

Functionality

Create Object
Create Folder
Bulk Action

 

Object

Users

Binary Size

21

Children

User

Functionality

Create Object
Create Folder
Bulk Action

 

Object

Services

Binary Size

22

 

Object

Templates

Binary Size

21

Children

Probe Template
Log Template
Device Template
Interface Template

Functionality

Create Object
Create Folder
Bulk Action

 

Object

MIB Objects

Binary Size

21

 

Object

Inventory List

Binary Size

41

Functionality

Move
Duplicate
Delete

Schedule

Generate Schedule
Selection

Specifies when the report should be generated and mailed out.

E-Mail Delivery

To User Set
Object

Send the e-mail to all users within the specified set.

Objects

Select Set
Object

Choose the set containing the objects that should be used.

Display

Show on Analysis Page
Boolean [TRUE/FALSE]

Show this report on the analysis page.

Sorting

Sort Column
Unsigned [0..0]

Specify the column to sort the report table by with the first column being column 0.
Sort Order
Selection

Specify the sort order for this report.

 

Object

Probe Analysis

Binary Size

78

Functionality

Move
Duplicate
Delete

Schedule

Generate Schedule
Selection

Specifies when the report should be generated and mailed out.

E-Mail Delivery

To User Set
Object

Send the e-mail to all users within the specified set.

Objects

Select Set
Object

Choose the set containing the objects that should be used.

Display

Show on Analysis Page
Boolean [TRUE/FALSE]

Show this report on the analysis page.

Sorting

Sort Column
Unsigned [0..0]

Specify the column to sort the report table by with the first column being column 0.
Sort Order
Selection

Specify the sort order for this report.

Settings

Columns Shown
Selection

Select the columns to be computed and displayed in the report.
% of Time Expression
String [0 to 255 Chars]

The expression to use when evaluating probe records to determine if the value should be included in the included set.

 

Object

Health Report

Binary Size

49

Functionality

Move
Duplicate
Delete

Schedule

Generate Schedule
Selection

Specifies when the report should be generated and mailed out.

E-Mail Delivery

To User Set
Object

Send the e-mail to all users within the specified set.

Objects

Select Set
Object

Choose the set containing the objects that should be used.

Display

Show on Analysis Page
Boolean [TRUE/FALSE]

Show this report on the analysis page.

Sorting

Sort Column
Unsigned [0..0]

Specify the column to sort the report table by with the first column being column 0.
Sort Order
Selection

Specify the sort order for this report.

Minimum Healthy Level
Integer [0..255]

The minimum service level for this health trend report. Values below this level are ignored.
Minimum Healthy Level
Integer [0..255]

The maximum service level for this compliance report. Values between the minimum and maximum level are assumed to be 'healthy' values. Levels greater than this value are assumed to be 'unhealthy' values.

 

Object

Alarm

Binary Size

52

Children

Send E-Mail Action
Send Pager Message Action
Play Sound Action
Launch Application Action

Functionality

Create Object
Move
Duplicate
Delete

Trigger

Select Set
Object

Choose the set containing the objects that should be used.

Trip Expression
String [0 to 255 Chars]

Specify a boolean expression, that when applied to the object and it's records will cause the alarm to be tripped and the alarm will turn 'on'.

Settings

Fire On Alarm On
Boolean [TRUE/FALSE]

Fire the actions when the alarm turns on.
Fire On Alarm Off
Boolean [TRUE/FALSE]

Fire the actions when the alarm turns off.

Fire Every (Seconds)
Integer [0..-2147483648]

The minimum interval in seconds between repeat firings of the action when this alarm is on. Specify zero if you only wish the alarm to fire one time.
Condition Exists For (Seconds)
Integer [0..9999999]

The number of seconds that the triggering condition must be present in order for this alarm to turn on.
Reset Button (Seconds)
Integer [0..9999999]

Specifies how long in seconds the reset button will monitor but suppress this alarm when reset. If it is zero (0) then the alarm will be cleared immediately and could come back shortly if the condition is still present.

Compute Every (Seconds)
Integer [0..-2147483648]

The interval in seconds between which the alarm will be analyzed for any state changes.

Process Every Data Point (Slow)
Boolean [TRUE/FALSE]

Process every new data point since the last analysis of this alarm. When enabled, the software will back-scan data since the last processing of this alarm and analyze every data point change for the state of this object. This process is computationally expensive but results in highly accurate alarm analysis (multiple state changes since last alarm analysis are possible). When disabled, the software will evaluate only the current state of the objects and not all previous states since last analysis. This uses much less CPU power, but is more dependent on the computational interval.

 

Object

Send E-Mail Action

Binary Size

901

Functionality

Delete

Message

To User Set
Object

Send the e-mail to all users within the specified set.
To
String [0 to 255 Chars]

The e-mail address of the party or parties to send the e-mail to.
Subject
String [1 to 255 Chars]

The subject used when creating the message.
Message Body
String [0 to 65535 Chars]

The body of the message to send when this action fires.
Combine Responses
Boolean [TRUE/FALSE]

Combines responses for similar actions together. For instance, AutoNOC will combine multiple e-mail responses and mail them as one e-mail.

 

Object

Send Pager Message Action

Binary Size

126

Functionality

Delete

Settings

To User Set
Object

Send the pager message to all users within the specified set.
Pager Gateway (TAP)
String [0 to 255 Chars]

A TAP/IXO gateway phone number that can be used to send alphanumeric pages and messages to this user. Contact your cell phone / paging system service provider to get information about your TAP/IXO pager gateway number.
Pager Gateway Pin (TAP)
String [0 to 255 Chars]

A pin number to be used when dialing the TAP/IXO gateway to send a user alphanumeric pages.
Retries
Integer [0..-2147483648]

Number of retries to attempt when sending pager messages.
Message
String [0 to 255 Chars]

The message to send to the user pagers.

 

Object

Play Sound Action

Binary Size

70

Functionality

Delete

Settings

Sound File Path (*.WAV)
String [0 to 255 Chars]

The path to the sound file to play on the portal that fires this action. An example would be

 

Object

Send Trap Action

Binary Size

66

Functionality

Delete

 

Object

Launch Application Action

Binary Size

51

Functionality

Delete

Settings

Executable
String [0 to 255 Chars]

The full, absolute path to the executable to be run.
Directory
String [0 to 255 Chars]

The local directory to switch to when running the executable.
Arguments
String [0 to 255 Chars]

Command line arguments to pass to the executable.

 

Object

Set

Binary Size

109

Children

Device Criteria
Probe Criteria
Log Criteria
Record Criteria
Object Criteria
Schedule Criteria
Interface Criteria
User Criteria
Set Criteria

Functionality

Create Object
Move
Duplicate
Delete

Logic

Set Logic
Selection

Defines the logic for this set. Union logic will find the most expansive list of all objects meeting any of the set criteria. Intersection logic will find all objects meeting all of the defined criteria.
Available Bases Included Bases
Selection

Choose the types of objects that this set returns. If it is empty, than it will return all object types. These types are not user-defined. They represent the internal type of object that should be returned by this set.

Investigate

Visible Bases Limit To
Selection

Select the base object types to show in the investigate view.

Show on Investigate Page
Boolean [TRUE/FALSE]

Show this set on the investigate page.

Observe

Number Records Observed
Integer [0..0]

Specifies the number of records to display for this set on the observe tab.

Show on Observe Page
Boolean [TRUE/FALSE]

Show this set on the observe page.

Visualize

Show on Visualize Page
Boolean [TRUE/FALSE]

Show this set on the visualization tab page.
Show on Visualize World Map
Boolean [TRUE/FALSE]

Show this set on the world map of the visualization page.

Location

Country
Selection

The name of the country to assign to the results of this set.
Region
Selection

The region to assign to the results of this set.
City
Selection

The name of the city to assign to the results of this set.
Zip
String [0 to 255 Chars]

The zip code to assign to the results of this set.
Abbreviation
String [0 to 3 Chars]

Specify a 3-letter abbreviation for this object. If one isn't specified the software will invent an abbreviation for the object.

Latitude
Float [-90.000000..90.000000]

The geographical latitude to assign to the results of this set.
Longitude
Float [-180.000000..180.000000]

The geographical longitude to assign to the results of this set.
Altitude
Float [-5000.000000..500000.000000]

The altitude to assign to the results of this set.

Auto-Lookup Latitude and Longitude
Boolean [TRUE/FALSE]

Tells AutoNOC to use internal tables and resources to lookup that latitude and longitude for this location.

 

Object

Device Criteria

Binary Size

36

Functionality

Delete

Settings

Model Contains
String [0 to 255 Chars]

Limits the return result to devices containing the provided text in the model field.
Manufacturer Contains
String [0 to 255 Chars]

Limits the return result to devices containing the provided text in the manufacturer field.
Type Contains
String [0 to 255 Chars]

Limits the return result to devices containing the provided text in the type field.
IP Rule
String [0 to 255 Chars]

Specifies a rule that limits returned devices to devices having interfaces with assigned IP addresses within the bounds of the rule. For example, 192.168.1.* would find all devices in the 192.168.1.0 network. You can also use the TO keyword in order to specify a range. I.e., 192.168.1.5 TO 192.168.1.50 is a valid range IP rule for this field.
Devices Limit To
Object

Limit To

 

Object

Probe Criteria

Binary Size

32

Functionality

Delete

Settings

Category Contains
String [0 to 255 Chars]

Limits the resulting set to objects with a category containing the value provided.
Component Contains
String [0 to 255 Chars]

Limits the resulting set to objects with a component type containing the value provided. If no types specified, then there is no type limit.
Expression
String [0 to 255 Chars]

Specify an expression that is solved to determine whether this probe should be included in the current set or not. An example expression would be "%V>200" to indicate probes that have a current value greater than 200.

Templates

Available Limit To
Object

Choose the template of the type of probe that you wish to include in this set.

 

Object

User Criteria

Binary Size

24

Functionality

Delete

Settings

Users Limit To
Object

Limit To

 

Object

Schedule Criteria

Binary Size

43

Functionality

Delete

Settings

Exclude the Provided Schedule
Boolean [TRUE/FALSE]

When selected, queries during the provided schedule will be return empty sets. When not selected, queries willl only work during the schedule time period.

Monday
Boolean [TRUE/FALSE]

Toggle the schedule for Monday.
Tuesday
Boolean [TRUE/FALSE]

Toggle the schedule for Tuesday.
Wednesday
Boolean [TRUE/FALSE]

Toggle the schedule for Wednesday.
Thursday
Boolean [TRUE/FALSE]

Toggle the schedule for Thursday.
Friday
Boolean [TRUE/FALSE]

Toggle the schedule for Friday.
Saturday
Boolean [TRUE/FALSE]

Toggle the schedule for Saturday.
Sunday
Boolean [TRUE/FALSE]

Toggle the schedule for Sunday.

Start Time
String [0 to 255 Chars]

Begin Time
End Time
String [0 to 255 Chars]

End Time

 

Object

Set Criteria

Binary Size

21

Functionality

Delete

Settings

Available Sets Chosen Sets
Object

Select the sets to be be allowed by this set criteria.

Use Objects Inside Set(s)
Boolean [TRUE/FALSE]

When enabled, this criteria will use objects inside the specified set(s) rather than the sets themselves.

 

Object

Interface Criteria

Binary Size

24

Functionality

Delete

Settings

Interface Types Limit To
Object

Choose the types of interfaces that should be included. If no interfaces are selected, then all are included.

List

Interfaces Limit To
Object

Select specific interfaces to include in this set.

 

Object

Log Criteria

Binary Size

32

Functionality

Delete

Settings

Category Contains
String [0 to 255 Chars]

Limits the resulting set to objects with a category containing the value provided.
Component Contains
String [0 to 255 Chars]

Limits the resulting set to objects with a component type containing the value provided. If no types specified, then there is no type limit.
Expression
String [0 to 255 Chars]

Specify an expression that is solved to determine whether this probe should be included in the current set or not. An example expression would be "%V>200" to indicate probes that have a current value greater than 200.

Templates

Available Limit To
Object

Choose the template of the type of probe that you wish to include in this set.

 

Object

Record Criteria

Binary Size

20

Functionality

Delete

Settings

Record Expression
String [0 to 255 Chars]

Specify an expression for selecting which records inside of included event logs should be included.

 

Object

Object Criteria

Binary Size

24

Functionality

Delete

Settings

Name Contains
String [0 to 255 Chars]

Specify text that should be contained within the name if this object should be included.
Object Flags Limit To
Selection

Specify allowed object states to limit selection to within this set.

 

Object

Device (Derived)

Binary Size

97

Children

Category

Functionality

Discover
AutoNOC OSP Command Prompt
Bulk Action
Move
Duplicate
Delete

Template

Template
Object

Specifies a path to the template to use for this object.

Downtime

Begin Downtime
Specify a start time for when a device is down. During this time period all analysis related to this device will be ignored by the software.
End Downtime
Specify an end time for when a device is down. During this time period all analysis related to this device will be ignored by the software.

Logs

Enable SNMP Trap Log
Boolean [TRUE/FALSE]

When enabled, AutoNOC will log and store all traps received from this device.
Enable Syslog Logging
Boolean [TRUE/FALSE]

Toggles whether or not Syslog logging will be processed for this device.
Enable State Change Log
Boolean [TRUE/FALSE]

Enables the device state change log. This log tracks all service state changes by probes and logs within this device and creates a historical log categorizing them for analysis.

 

Object

Custom Component

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Interface (Derived)

Binary Size

81

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Template

Template
Object

Specifies a path to the template to use for this object.

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Storage

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Processor

Binary Size

94

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Main Memory

Binary Size

53

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Application

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Service

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Environment

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Category

Binary Size

20

Children

Interface
Storage
Processor
Main Memory
Application
Service
Cable Modem
Environment
Network
Custom Component

Functionality

Create Object
AutoNOC OSP Command Prompt
Delete
Bulk Action

 

Object

Cable

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Network

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

Link

Link to Object
Object

Specify an object to link this component to.

 

Object

Cable Modem

Binary Size

36

Children

Probe
Log

Functionality

AutoNOC OSP Command Prompt
Bulk Action
Delete

 

Object

Device Template

Binary Size

48

Functionality

Move
Duplicate
Delete

Information

Manufacturer
String [0 to 255 Chars]

Specifies a manufacturer for this device. For example an appropriate manufacturer could be Cisco, Microsoft, or Sun.
Model
String [0 to 255 Chars]

Specifies a manufacturer's model for this device. An appropriate model name could be Windows NT, 2600, or 410.
Type
String [0 to 255 Chars]

Specifies the type for the device. For example a device could be a server or a router and it would be appropriate to use the word server as the type.

SNMP Descriptions
Multiple Strings

Specify search text that appears in a devices ifDescr that AutoNOC will use to identify a device as a device of this type.

Components

Components Limit To
Selection

Select the types of allowed components to use when discovering the device.

Interfaces

Interfaces Limit To
Object

Select the interface types that devices based off of this template can make use of.

Probes

Probes Limit To
Object

Select the probes that devices using this template can make use of.

 

Object

Interface Template

Binary Size

28

Functionality

Move
Duplicate
Delete

Settings

IETF Interface ID
Integer [0..0]

Specifies the IETF assigned ID number for interfaces of this type.
IETF Name
String [0 to 255 Chars]

Specifies the IETF specified name for an interface of this type.

Probes

Probes Limit To
Object

Select the templates to limit this object to.

 

Object

Probe (Database/Derived)

Binary Size

46

Functionality

AutoNOC OSP Command Prompt
Delete

Template

Template
Object

Specifies a path to the template to use for this object.

 

Object

Probe Template

Binary Size

118

Functionality

AutoNOC OSP Command Prompt
Move
Duplicate
Delete

Visualize

Link Visualization
Selection

Visualize the state of this probe on links between components of devices
Abbreviation
String [0 to 3 Chars]

Specify a 3-letter abbreviation for this object. If one isn't specified the software will invent an abbreviation for the object.

Settings

Category
String [1 to 255 Chars]

Specifies the top level category to be used for this probe.
Component Type
Selection

Select one of the specialized components for this device.
Custom Component Name
String [0 to 255 Chars]

Specify a custom component for this template. If no name is specified, than the default name ot the component will be used.

Expression

Internal Record Format
Selection

Specifies the internal record format to use when storing the data contained within this object. Text is the most accurate format to use, however, text consumes extra disk space, and can require more CPU power. The use of lower precision formats will control how much or how little data is saved.
Graph Minimum
String [0 to 255 Chars]

The minimum value to be used when displaying this probe. Leave blank to automatically determine minimum value.
Graph Maximum
String [0 to 255 Chars]

The maximum value to be used when displaying this probe. Leave blank to automatically determine maximum value.
Display Format
String [0 to 255 Chars]

Format to use when displaying the values of this probe.
No Graph Zoom
Boolean [TRUE/FALSE]

Disables the automatic zooming of graphs for probes that use this template. This is useful when graphing percentages, or when you want the maximum to be the maximum, no matter what.
Show Graph
Boolean [TRUE/FALSE]

Toggle whether graphs should be displayed for this template.
Expression
String [0 to 65536 Chars]

The expression is the scripted equation that is used for calculating the state of this probe.
Component Rule
String [0 to 65536 Chars]

When this expression evaluates to true, the parent component will be hidden and ignored in terms of the GUI. This is useful for objects that have static representations but are not currently in operation such as switches.

 

Object

Log (Database/Derived)

Binary Size

46

Functionality