Nets Users Guide
Copyright (C) 1999-2005
Mike McCauley and Hugh Irvine
Users Guide for the Nets network inventory and management system.
For Nets Revision 2.5
1.0 Introduction
Nets is a graphical source code product providing a flexible and extensible environment for maintaining essential computer and data communications network inventory, configuration and cost information in a platform and database independent manner.
Nets provides a physical model of the network, from which it is simple and straightforward to derive and display any number of textual, logical or graphical views.
This document is the Users Guide for the Nets system and describes the different screens and operations that are used to enter data, search for information and run reports.
Instructions and examples are also provided for operations such as importing and exporting databases, importing and using drawings and icons, using the network browser, reviewing notes associated with any network element stored in the database and perusing the audit trail to verify database operations.
2.0 Overview
Nets is a platform independent and database independent application that enables
Managers and Engineers to easily maintain accurate and up-to-date network data.
Nets is delivered with a standard set of database objects together with editing, viewing and reporting tools which provide the framework required to maintain a complete, detailed inventory of any computer network.
Nets includes an autodiscovery tool that can be used to populate the basic Nets database from the output of the nmap network scanner.
Nets is based on a set of fundamental network elements (represented as database objects), including the following:
- Locations - Points of Presence (POPs), telco exchanges, co-location facilities, etc.
- Racks - equipment racks used to house devices
- Devices - servers, workstations, routers, switches, patch panels, etc.
- Slots - devices may contain any number of slots
- Interfaces - those device elements that connect to links (ethernet, serial, FDDI, etc.)
- Cards - interfaces may be contained on cards, which may be inserted into slots
- Links - LAN, WAN or cable plant connections
- Protocols - typically TCP/IP, but any protocol is supported (IPX, Appletalk, etc.)
- Addresses - protocol addresses configured on interfaces (such as IP V4)
- Address Maps - graphical representations of IP address blocks and usage
- DNS Names - the DNS names that correspond to interface addresses
- Graphics - maps, drawings, digital photos and schematic diagrams of the network
All of these network elements and the database objects and operations associated with them are described in this manual. The complete set of Nets database objects and their definitions can be found in the Nets Database Schema.
3.0 Nets Database Objects
The Nets database defines a number of types of Nets objects. All of the objects of a given type are stored in a database table, which contains a number of columns corresponding to the data definitions for a Nets object. The Nets system provides a number of standard tools to create, modify, delete and report on every Nets object in the database.
3.1 Object Naming
Every Nets database object has a name which is used to identify the object within the Nets system. The object names are simply symbolic strings and can be set to whatever is most relevant to the network that is being managed. Duplicate names are permitted.
It is helpful when entering data into Nets, to follow a standard object naming scheme so that subsequent searches and use of the data in the database are as simple and meaningful as possible (expecially in a multi-user environment).
If a standard naming scheme is already in use within the organisation, it should be used (and possibly extended) so that the objects in Nets have similar (or identical) names to the real network objects.
If a naming scheme does not exist within the organisation, it is strongly recommended that a naming scheme derived from the existing network Domain Name System (DNS) definitions be adopted at the outset.
The network objects that are included in the example data set (called "exampledata.dat" in the Nets distribution) and that are used in this manual follow the DNS scheme. The domain name in the examples is "irvine.com.au", and objects are typically named as follows:
interface.device.irvine.com.au
portnumber.patchpanel.rack.irvine.com.au
The example data does not contain any Points of Presence (POP's), but if it did, the names would look like this:
interface.device.pop.irvine.com.au
It may also be useful to use the device internal names for interfaces, for example:
Serial1/1/3:17.device.pop.irvine.com.au
FastEthernet0/1.20.device.pop.irvine.com.au
Obviously, not all of these names will appear in the DNS zone files, however keeping the Nets names in a similar, related hierarchy will certainly simplify Nets use and operation. Note that some Nets names will map directly to DNS names, but it is important to remember that the name spaces are in fact different and distinct.
3.2 Hints for using Objects
The majority of the data in the Nets database will relate to real interfaces, devices, links, etc. However, there are some cases in which the use of "pseudo-objects" can simplify Nets usage. Pseudo-objects are virtual objects used as place-holders in the Nets system.
One example is keeping track of telecommunications links that have been ordered on a POP by POP basis. This will be much easier if the ordered links are connected to interfaces that are part of a pseudo-device at the POP location. This would be accomplished by creating a pseudo-device with interfaces connected to those links:
interface.telco-orders.pop.irvine.com.au
Once the telecommunications links have been installed, the links can be transfered to the corresponding interfaces of the real devices.
Another example of the use of pseudo-objects is the creation of sms, pager and email gateways used for automatic notification of Nets events. The telephone numbers and/or email addresses of these entities will be used to send messages when required:
Note: the gateways mentioned above are not included with this release of Nets.
There are many other situations in which this technique can be used.
4.0 Starting Nets
When Nets has been permanently installed, the main Nets user interface can be run with the following command:
On Windows, netsmain.pl can also be run by just double-clicking it in Windows Explorer. A Windows Shortcut to netsmain.pl can also be double-clicked.
Netsmain.pl understands a range of command line arguments:
netsmain.pl [-h] [-d] [-u username] [-p password]
[-dbsource dbi:xxx:yyy] [-dbusername name] [-dbauth auth]
[-c rcfile] [-home dir]
[configname=value] ... [scriptfilename] ...
- -h
- -d
- -u username
- -p password
- -dbsource dbi:xxx:yyy
- -dbusername name
- -dbauth auth
- -c rcfile
- -home dir
- configname=value
- scriptfilename
Prints some command line help to stdout and exits.
Turns debugging on. Messages are printed to stdout. This is equivalent to setting the Nets LogLevel to 4.
Attempts to log in to Nets with the given username. If the username/password combination authenticates, the user will be logged in without presenting a login dialog.
Attempts to log in to Nets with the given password.
Overrides DBSource in Sql.pm and the NETS_DBSOURCE environment variable. Specifies the database source name that Nets will use.
Overrides DBUsername in Sql.pm and the NETS_DBUSERNAME environment variable. Specifies the SQL user name that Nets will use to log in to the database.
Overrides DBAuth in Sql.pm and the NETS_DBAUTH environment variable. Specifies the SQL user password that Nets will use to log in to the database.
Reads the named Nets RC file, interpreting lines of the form name=value and using them to set Nets configuration variables.
Specifies an alternate directory to override the value for NetsDir.
Overrides configuration variable settings in Site.pm. Any number of variable settings can be specified.
Starts the Nets Scripting Language script running. Any number of script file names can be specified.
4.1 Nets Users
Nets provides a system of user names and logins, allowing various levels and ways of controlling access to Nets and its data.
Nets is delivered with 2 standard Nets users:
- ADMINISTRATOR
- DEFAULT
By default, this user has access to all parts of the Nets system and can change anything. The default password is ADMIN (this should be changed as soon as possible after installation).
This is the default user name for any user who does not have their own Nets username. It will be used if there is not a specific Nets user for the logged in user name. The default password is DEFAULT.
When the Nets main program (netsmain.pl) starts up, it logs in to the Nets system using the following logic:
- On Unix, the user name defaults to the users Unix username. On Windows, it defaults to `Windows User'.
- If NETS_USERNAME and/or NETS_PASSWORD environment variables are set, they are used.
- If -u and/or -p arguments are specified on the command line, they will be used as the user name and password.
- If there is both a user name and a password resulting from the above steps, Nets will attempt to log the user in silently (i.e. without presenting a Login dialog). If the named user (or DEFAULT) exists and the password is correct, the user will be logged in to Nets, else the next step is followed.
- The Login dialog is presented, allowing the user to enter their Nets username and password.
- If the entered user name (or DEFAULT) exists and the password is correct, the user will be logged in to Nets.
- After logging in, the user's details will be added to the CURRENT_NETSUSERS table in the Nets database for licensing purposes.
As can be seen from the above, Nets will try to log users in with a user name, and will fall back to the DEFAULT user name (if it exists). This means that it is possible to have specific user names and privileges for some users, and a generic login for other users.
4.2 Nets Login Screen
When a Nets user starts Nets with no parameters, the following login screen is displayed, into which the username and password must be entered:
4.3 Nets Main Screen
Once a Nets user has successfully logged on, they will be presented with the Nets Main Screen. The Main Screen contains a File Menu, an Edit Menu, a View Menu and a Help Menu. The Main Screen will always be present while Nets is running.
FIGURE 2. Nets Main Screen
The Nets username and the hostname of the user's workstation is displayed in the title bar and the message area of the Main Screen.
All of the screens in the Nets system have a similar format, with at a minimum a File Menu, an Edit Menu, a View Menu and a Help Menu.
In addition, the Nets Main Window contains shortcut buttons for the following editors:
All of the Nets object editors are described in Section 7.0 .
5.0 Nets User Interface
The Nets user interface has a number of common elements that are used throughout the Nets system. These elements include standard menus and menu items, text and numerical data entry and display areas, object selectors and the like.
FIGURE 3.
Example Nets Screen
The screen shown above illustrates the main elements of the user interface.
The standard menus are to the left under the title bar, while the help menu is to the right.
The left hand window shows the list of available objects and the scroll bar and scrolling arrows allow access to longer lists. Clicking on any list item will show the details for the corresponding database object in the display areas to the right of the list window.
The data fields are used to enter new data as well as display current data.The data entered into the data entry fields can be composed of strings, numbers, IP addresses, latitudes and longitudes, dates and times, etc. Some data fields have verification routines associated with them so that only data in the correct format can be entered.
5.1 Entering Dates and Times
Nets allows dates to be entered in a variety of formats, and there are many fast shorthand ways of entering dates in the past and the future. All times and dates are entered and displayed in the local time zone.
All dates stored and displayed in Nets include both the date and the time. Wherever a date can be entered, the time can also be entered. If a time is not specified, it always defaults to midnight at the beginning of the indicated day. If a time is entered, it must be in the format hh:mm(:ss). The seconds are optional. Times are in 24 hour time format. Some examples are:
Dates are stored and displayed in Nets including the full 4 digit year. When entering dates, shorthand years can be used, such as "99" or "00". Nets will make an educated guess about which year is meant.
During installation, the Nets administrator will have chosen the appropriate date format for local use. This controls how dates are printed in Nets, and also how exact dates must be entered.
Many of the shorthand date formats allow the use of contractions. For example, instead of "1 week", meaning 1 week in the future, "1w" is acceptable, and instead of "today", "tod" is acceptable.
5.1.1 Entering Time Intervals
Some data fields require an time interval to be entered to specify a period of time, as opposed to an exact date. time intervals can be intered in a variety of ways. Some examples are:
5.1.2 Using Dates in Searches
A number of list screens allow searchs for items by date. These screens include "Date from" and "to" fields. For example, on the View->Search for Object->Installed Packages screen, searches can be performed using these dates, and the date range searched can be limited by entering a start date/time and/or an end date/time. If neither the start nor the end date/time are entered, then all the matching date/times will be listed.
The dates and times entered may be any of the supported date/time formats. See Entering Dates and Times.
5.2 Nets Selector Menus
Many Nets screens employ selector menus as a means of simplifying data entry by allowing the user to directly select an object from a related table.
FIGURE 4. Example Selector
This figure shows the Address Family selector from the previous screen ( Figure 3 ). Selectors provide direct access to data objects contained in other database tables. Clicking on the selection bar will allow a particular object from another table to be referenced from this object, while clicking on the arrow button (->) will display the editor for the object.
These common user interface elements have been employed to provide standard editor screens and lister screens for all Nets database objects. The standard features of the editor screens and lister screens are described below.
5.3 Nets Editors
The Nets editors are used for all manual data entry into the database and also for viewing existing data. All Nets editors have the same format, with a File menu, an Edit menu, a View menu and a Help menu. In addition, a number of editors also have an optional Tools menu that provides useful functions relating to the specific database object that the editor is used for.
All editors also contain these buttons:
- OK
- Cancel
- Help
Saves the current data in the editor to the database.
Note: Nets maintains internal record numbers to avoid data collisions if more than one Nets user edits the same database object at the same time.
Cancel this operation. The window will disappear.
Some database objects (Device, Interface and Link) have more data fields that can fit comfortably on a single screen. The editors for these objects contain sub-panels, selectable by tabs, that group related information together for ease of access.
The common features of each editor menu are described in the following sections:
5.3.1 Editor File Menu
5.3.2 Editor Edit Menu
All object editors have an Edit menu, as shown below.
FIGURE 6. Example Editor Edit Menu
Every editor Edit menu contains:
- Cut
- Copy
- Paste
The selected object will be deleted from the database as soon as Cut is selected.
Caution - this action is immediate and cannot be undone.
Copy the contents of the data fields of this editor to the clipboard.
Paste the contents of the clipboard into the data fields of this editor. This is very useful for quickly creating new identical objects in the database, or for copying similar fields from one object type to another.
5.3.3 Editor View
All object editors have a View menu, as shown below.
TABLE 4. Sort Criteria in Object Lists
- Notes...
- Audit trail...
- Search...
- Refresh
Different sorts can produce identical results when used on some data lists.
Every Nets database object can have any number of notes attached to it. This menu item will bring up the Notes Editor to allow a new note to be added to the object, and existing notes to be examined.
Every operation in the Nets system will result in an entry being created in the audit trail. This menu item will bring up the audit trail for this object, showing the date and time, action and Nets user responsible for each operation to this object.
This menu item will bring up the Lister screen for this type of object to allow searching for a particular object. If an object is double-clicked in the lister, it will be displayed in the corresponding object editor.
This menu item will refresh the contents of this editor by re-reading data from the database, usually required after editing a related database object in a different editor.
5.4 Nets Listers
The Nets listers are used to list and search for objects in the database. All Nets listers have the same format, with a File menu, an Edit menu, a View menu and a Help menu.
Lister screens are divided into two parts. The top section allows search criteria to be specified, including such things as:
The top section of all listers also contain this button:
The bottom section of the screen displays the search results and double-clicking on any line will display the relevant object from the database in its corresponding editor.
The common features of each Lister menu are described in the following sections:
6.0 Nets File Menu
The Nets File Menu allows the user to initiate fundamental Nets actions, such as importing and exporting databases, saving and restoring window layouts, running scripts, installing packages and exiting Nets. Some of these actions are controlled by the user's permissions. Refer to the Nets User editor for details. ( Section 7.27 ).
FIGURE 11. Nets Main Screen File Menu
This screen shows the Nets File Menu.
The File menu items are described in the following sections.
6.1 Import Database
Nets users can import data into the database from an external file. This is useful for importing bulk data from another system, or initial loading of the database.
FIGURE 12. Nets Import Database
This screen shows the file selection dialog to choose a file to import.
The top data field shows the directory and display filter currently in use, while the bottom data field is used to enter a new file name to create in the current directory. The Directories list allows a different directory to be selected, while the Files list allows an existing file to be selected and overwritten.
Note: double-clicking on a file name will select and over-write the file directly.
6.2 Export Database
Nets users can export data from the database to an external file. This is useful for exporting bulk data to another system, or making portable backups of the database.
Note: every record in every table will be exported from the database to a file, in a format suitable for use with a subsequest Import Database.
6.3 Save Window Layout
Nets users can open as many different windows as desired, and position them on the screen as appropriate. The screen layout can be saved to the database on a per user basis with this menu item. The next time the user logs in, the Nets windows will be restored to their positions when they were last saved.
6.4 Restore Window Layout
Nets users can restore a previously saved window layout at any time by using this menu item. This can be useful if a user wishes to restore a normal window layout that has been changed during a Nets session.
6.5 Run Script
This menu item is used to run pre-defined Nets scripts. Nets scripts are background tasks that operate while the Nets program would otherwise be idle. Nets scripts are identified by the suffix .nsl (Nets Scripting Language). Refer to the Nets Developers Guide for further details regarding scripts.
Note: only users with appropriate permissions will be able to run scripts.
6.6 Install a Nets Package
This menu item is used to install Nets packagess.
Note: only users with appropriate permissions will be able to install packages.
FIGURE 15. Nets Install Package
This screen shows the Nets package installer.
A Nets package is a directory containing a `DESCRIPTION' file, together with the various package components and the instructions for installing them.
The Nets package installer is controlled by the following buttons:
- Browse ... - used to select a package to install
- Check - used to verify package contents before installation
- Install - used to perform the installation
- Cancel - used to exit the package installer before doing an installation
Nets packages are a convenient way for users and vendors to distribute additional Nets add-ons for installation into the Nets system. Refer to the Nets Developers Guide for further information regarding package development and contents.
6.7 Plugins
The Plugins menu item cascades to a list of the Nets Plugins that are installed on this system. Nets Plugins are typically installed from Nets Packages, one of which is the Autodiscovery from nmap log file ... (part of the standard Nets distribution).
6.7.1 Autodiscovery from nmap log file
Nets provides a means to populate the database with the output of the nmap scanner.
FIGURE 16. This screen is used to input the list of network elements from an nmap scan.
This screen shows the file selector to import the results of an nmap scan.
The nmap scanner can be found at the following URL:
The output from nmap should be generated as follows
Note: the output from an nmap scan will not provide a complete network inventory, however it will provide basic information that can be used to populate the database.
7.0
Nets Edit Menu
The Nets Edit Menu provides direct access to all Nets object editors. The Edit Menu also contains a "Create from Template..." item which allows a user to create multiple Nets objects at the same time, as defined by a Template file. This is a convenient method for combining many Nets edit operations into a single operation.
Note: many Nets Edit items group together two or more related Nets objects in cascaded sub-menus for ease and speed of access.
7.1 Create from Template (multiple objects)
To simplify data entry into Nets, Template files can be created by combining typical groups of Nets objects into a single file. Template files are usually used to create complicated devices with many interfaces all at once. There are several standard Templates included in the Nets distribution, and additional Templates can be created as required.
FIGURE 18. Nets Create from Template
This screen shows one of the standard Nets Templates (generic16connector) being used to create a new 16 port switch. The same Template can be used to create any 16 port device, including hubs, switches or patch panels.
Note: double-clicking on any line will display the corresponding object in the appropriate editor for that object.
7.2 Address (ADDRESS object)
One of the important uses for Nets is keeping track of protocol addresses. This is most often used with IP V4 addresses, but any addresses from any protocol family can be entered into the system.
When working with IP V4 addresses, it is useful to enter CIDR block definitions and subnet definitions as well as individual host addresses, as the Nets Address Map display will show all of this information through the use of different coloured display segments.
CIDR blocks are IP address allocations, either obtained from an IP address registry (ARIN, RIPE-NCC, APNIC, etc.), or internally used private address space (10.0.0.0 for example). Subnets (as defined by netmasks) are the local subdivisions of the IP address space that are used for local LAN segments, point-to-point WAN links, etc.
IP V4 addresses are also usually associated with DNS names, and Nets can be used to store the address to DNS name mappings.
7.3 Address State (ADDRESSSTATE object)
Address State is used to indicate whether an address is allocated, free, in use, etc.
7.4 Address Type (ADDRESSTYPE object)
The Address Type refers to the specific network protocol that an Address belongs to. This will usually be IP V4, but any protocol can be defined, in addition to the standard set of protocols included with Nets.
7.5 Administrative State (ADMINSTATE object)
Nets can be used to track a variety of administrative states. Additional administrative states can be defined on a per-site basis as required. Administrative states are used in the provisioning panels of Devices, Interfaces and Links to describe the current state of the provisioning process.
7.6 Bandwidth (BANDWIDTH object)
The bandwidth object is used to define different values to describe the data transmission capacity of telecommunications links. Refer to link editor in Section 7.24 .
7.7 Bundle (BUNDLE object)
Bundles refer to cable bundles, as are typically used in equipment rooms. The physical cables that correspond to Links are usually found in cable bundles.
Note: the use of this object is optional and may not be required in all cases.
7.8 Card (CARD object)
Cards are optional objects that can be used when one or more interfaces are built on a card that can be installed in a device slot. See the Interface Editor for details on how an interface can be related to a card.
7.10 Connector (CONNECTOR object)
Connectors are used to connect two links, either individually, or more generally in groups corresponding to switches, hubs or patch panels. See the Nets Device Editor for details regarding the grouping of multiple connectors into a device.
7.11 Connector Type (CONNECTORTYPE object)
Connectors can be of any type, many of which are pre-defined in Nets.
7.12 Contract (CONTRACT object)
Contract details can be maintained in Nets and Devices, Interfaces, Links and Locations may all refer to contracts for the purposes of leases, rental, maintenance, etc.
7.13 Contract State (CONTRACTSTATE object)
Contracts may be in different states, which may be defined here.
7.14 Contract Type (CONTRACTTYPE object)
Contracts may be of different types, which may be defined here.
7.15 Device (DEVICE object)
Devices are one of the most important objects in Nets. Devices are typically network elements such as workstations, servers, routers, switches, hubs, patch panels, etc. Pseudo-devices can also be used as place-holders for tracking equipment and/or telecommunications links that have been ordered but not yet delivered or installed.
Devices can be either active or passive. Active devices incorporate one or more interfaces, together with the corresponding network addresses and links. Passive devices such as switches, hubs and patch panels contain only connectors that connect to links.
Some devices contain both interfaces and connectors, and some devices can be included inside other devices. An example of such a device would be an intelligent switch with multiple VLAN support and a protocol address to connect to it for administrative purposes.
FIGURE 32. Nets Device Editor
This screen shows the Nets Device Editor. Note the "Costs", "Operation", "Provisioning" and "Rack" panels that contain groups of related data for ease of access.
7.15.13 Operation - Administrative interface
The administrative interface to access this device.
Optional. Used for remote access to router loopback interfaces for example.
7.15.16 Provisioning - Administrative status
The administrative status of this device (planned, ordered, installed, etc.).
7.17 Device Type (DEVICETYPE object)
Nets defines devices according to device type. Additional device types can be added to Nets at any time using this screen.
7.18 Drawing Object (DOBJ object)
Nets Drawing Objects are the visual elements added to maps, schematics and digital photographs to represent network elements (or other drawings).
Nets drawing objects include icons, text, lines and click-through areas. Each drawing object can represent any Nets object (including other drawings), thereby allowing great flexibility in defining and using groups and sets of drawings.
Note: it is much simpler and more straight-forward to create and manipulate drawing objects using the tools provided in the drawing viewer. Refer to Section 9.3.4 .
FIGURE 35. Nets Drawing Object Editor
This screen shows the Nets Drawing Object Editor. For examples of how to define and use drawing objects, refer to Section 9.0 of this manual.
7.19 Drawing (DRAWING object)
Nets drawings are the backgrounds upon which drawing objects are placed. Nets drawings can be prepared in any drawing program, can be scanned from maps or schematic diagrams, or can be imported from any digital camera. Nets supports drawing images in GIF, XBM or XPM formats in the standard release, and additional formats can be supported with the use of suitable Tk modules (available from CPAN, www.cpan.org). Refer to the Nets Installation and Administration Guide for details.
FIGURE 36. Nets Drawing Editor
This screen shows the Nets Drawing Editor. For examples of how to define and use drawings, refer to Section 9.0 of this manual.
Note: Filename refers to a file in the <NetsDir/images/drawings> directory.
7.20 Entity (ENTITY object)
Nets entities are people and/or companies for which contact details are kept.
Note: pseudo-entities can be used for sms, pager and email gateways.
7.21 Event Type (EVENTTYPE object)
Event Types are used in the Nets audit trail to keep track of database activity.
7.22 Interface (INTERFACE object)
Interfaces are important Nets objects. Interfaces are the active network elements contained in devices that have network protocols and network addresses (such as IP V4) assigned to them, and that are used to connect to links.
Interfaces are usually created as parts of devices, and interfaces connect to LAN and/or WAN links. Interfaces are also configured with addresses (and DNS names), connector types and MAC addresses (optional).
Interfaces that support channelized data streams (such as Frame Relay, ATM, etc.) can have sub-interfaces associated with them that can be used to connect to virtual circuits that have been defined for the links connected to these interfaces.
FIGURE 39. Nets Interface Editor
This screen shows the Nets Interface Editor. Note the "Costs", "Operation" and "Provisioning" panels that contain groups of related data for ease of access.
7.22.7 Sub-interface of
The parent interface that this interface is part of (for use with virtual circuits).
7.23 Interface Type (INTERFACETYPE object)
Interface Types are used to indicate what type a particular interface is. Additional interface types may be added at any time using this screen.
7.24 Link (LINK object)
Links are important Nets objects that describe all LAN and WAN links in the network. Links are configured with a link type, supplier, circuit identifier and additional operational and provisioning information.
Links that describe virtual circuits can be associated with the physical links that carry them and the virtual circuits can be connected to the corresponding sub-interfaces that the parent interface contains.
FIGURE 41. Nets Link Editor
This screen shows the Nets Link Editor. Note the "Costs", "Operation" and "Provisioning" panels that contain groups of related data for ease of access.
7.24.5 Bundle
The cable bundle this link is part of. Refer to Section 7.6 for details.
7.26 Location (LOCATION object)
Locations are defined for all POP's, offices, hosting facilities, etc. that are part of the network. Address details and contact details are maintained, as well as latitude and longitude references for use with maps.
7.27 Nets User (NETSUSER object)
Nets users are those users who are permitted to log in to the Nets system. The Nets administrator is typically the only user who is allowed to access user information.
7.28 Note (NOTE object)
Notes can be added to any Nets object through the View->Notes... menu item of any object editor. All notes associated with a particular object are time stamped and include the username of the Nets user who added the note.
7.29 Operating State (OPSTATE object)
Nets can be used to track a variety of operating states. Operating state reflects the current state of a device, interface or link. Additional operating states can be defined on a per-site basis as required.
7.30 Permission (PERMISSION object)
Nets users are granted permissions when they are created. Site-specific permissions can be added with this editor if required to enable or disable access to particular operations.
7.31 Preference (PREFERENCE object)
Nets users are given preferences when they are created. The set of preferences that are defined in Nets can be added to at any time as required.
Note: the default values for all preferences can be defined in the file Nets/Site.pm and can be over-ridden by various configuration files and run-time parameters.
7.32 Rack (RACK object)
Racks are usually used in locations such as telecommunications facilities and computer rooms to house network equipment. Racks are defined with height, width, depth and available power supply voltages.
7.33 Report (REPORT object)
Reports are used to generate useful summaries of the data stored in Nets. There are a set of standard reports included with Nets, however additional reports can be defined at any time as required.
FIGURE 50. Nets Report Editor
This screen shows the Nets Report Editor.
The Select Query field is where the SQL query to extract the data from the database for this report is defined. Any SQL query that is supported by the database can be used. Refer to the database documentation for SQL query details and syntax.
The Format field is where the SQL display format is defined for the query specified in the Select Query field above. A Format is only required if the default format is inadequate to display the results of the query defined above.
7.34 Slot (SLOT object)
Devices may optionally contain slots, which are defined here.
A device may have any number of slots, and the slots may also contain cards.
7.35 Slot Type (SLOTTYPE object)
Slots can be of different types. Additional slot types are defined here.
7.36 Software (SOFTWARE object)
A software object is normally an operating system or a software service installed on a device (and optionally related to an interface). In addition, configuration information can be maintained for particular software services.
7.37 Software Type (SOFTWARETYPE object)
Software types are used to describe each type of software associated with Nets devices. Additional software types can be added at any time as required.
8.0 Nets View Menu
The Nets View Menu allows a user to search for a variety of Nets objects, to display the Nets Network Browser, to display the Message Log, to display Reports, to display Drawings and Schematics and finally to display IP V4 Address Maps.
FIGURE 57. Nets Object Listers
This screen shows the list of Nets objects that can be searched on and listed.
8.1 Address (ADDRESS object)
The Address screen allows searches to be performed on addresses stored in Nets. Double-clicking on any address will display that address in the address editor.
8.2 Audit Trail (EVENT object)
The Nets audit trail contains a list of every login, database operation and administrative action to allow review of any or all Nets activity.
8.3 Bundle (BUNDLE object)
Cable bundles stored in Nets can be searched for and/or listed with this screen.
8.4 Connector (CONNECTOR object)
This screen can be used to search and/or list the connectors stored in Nets.
8.5 Contract (CONTRACT object)
This screen can be used to search and/or list the contracts stored in Nets.
8.7 Drawing (DRAWING object)
This screen allows searching and/or listing the drawings stored in Nets.
8.9 Interface (INTERFACE object)
This screen allows searches and/or listing the interfaces stored in Nets.
8.11 Location (LOCATION object)
This screen allows the searching and/or listing of locations stored in Nets.
8.14 Package (PACKAGE object)
This screen allows searching and/or listing the packages installed in Nets.
8.15 Permission (PERMISSION object)
This screen allows the searching and/or listing of the user permissions in Nets.
8.16 Preference (PREFERENCE object)
This screen allows the seraching and/or listing of Nets preferences.
8.17 Rack (RACK object)
This screen allows the searching and/or listing of the racks stored in Nets.
8.18 Report (REPORT object)
This screen allows the searching and/or listing of the reports used in Nets.
8.19 Software (SOFTWARE object)
This screen allows the searching and/or listing of software descriptions stored in Nets.
8.21 Network Browser
The network browser provides an alternative means for perusing, displaying and searching for objects in the Nets database, in a hierarchical manner similar to a graphical file manager.
At the top level, the network browser displays all of the locations stored in the database with an expander box (shown with a "+") next to it. Clicking on the expander box will display all of the objects related to the expanded object.
For example, expanding a location will display all of the devices and racks at that location, expanding a rack will display all of the devices in that rack, and expanding a device will display all of the slots, cards, interfaces and connectors in that device.
Double-clicking on any line in the network browser display will display the database object that the line corresponds to in the appropriate object editor.
8.22 Message Log
This screen allows the Nets message log to be viewed in real time. The message log shows the messages that Nets displays during operation. Messages are displayed at each of five log levels:
- Serious errors - only serious error conditions are logged.
- Warnings - warning conditions are logged.
- Notices - normal but significant conditions are logged.
- Info - informational messages are logged.
- Debug - detailed debugging information is logged.
Note: the message log level to be displayed can be altered by selecting the relevant item in the Log level option menu.
8.23 Reports
This screen allows access to Nets reports. Nets is delivered with a number of standard reports included, and additional reports can be defined as required.
A report is selected by using the View->Reports menu item.
The standard Nets reports include:
- All Device details - show details of all devices.
- Links by Location - show all links by location.
- Spare Links by Location - show spare links by location.
- Links by Rack - show all links by rack.
Note: report results may be saved to a file with File->Save Results As...
8.24 Drawings and Schematics
This screen allows access to the drawings and schematics stored in Nets.
Drawings are used to display Nets network information in a variety of graphical formats. Drawings consist of backgrounds such as maps, schematic diagrams, scanned images, digital photographs, etc, and foreground objects such as drill-down areas, icons, text, lines, etc.
Foreground objects will be highlighted when the mouse pointer hovers over an area or an icon is clicked. Double -clicking an area or an icon will display the Nets object that is associated with it, including other drawings. Right-clicking an area or icon will show the meta-data associated with the corresponding drawing object (DOBJ).
The Drawings shortcut button in the Nets Main Screen also displays this screen.
FIGURE 81. Nets Drawings and Schematics
Refer to Section 9.0 for more details regarding drawings and schematics.
8.25 IP V4 Address Map
The IP V4 address map displays all CIDR (classless inter-domain routing) blocks, subnets and host addresses stored in the Nets IP V4 address table. Different size address blocks, subnets and host addresses are all displayed in different colours to aid in visualization.
CIDR blocks are displayed first, with subnets (defined by netmask) displayed on top of the CIDR blocks, and host addresses displayed on top of subnets. CIDR blocks and subnets are IP addresses for which the netmask part is all zero (ie. 10.1.1.0 and 255.255.255.0, or 10.1.1.0/24). Host addresses are IP addresses with a non-zero value in the subnet portion of the address (ie. 10.1.1.1 and 255.255.255.0 or 10.1.1.1/24).
Single-clicking an address or address block will display the address (and the associated DNS name) in the bottom left corner of the window. Double-clicking on any address or address block will display that address in the address editor.
9.0
Drawings and Icons
Nets supports a wide variety of graphical representations of database objects. Any image in GIF, XBM or XPM format can be used directly and additional image formats can be supported by adding the appropriate image module to the underlying Nets graphics sub-system (see the Nets Installation and Administration Guide for details).
A standard set of maps and icons is provided and additional images can be added as required. Images can be prepared in any external graphics program and imported into Nets using the Drawing editor as described below. Images can also be scanned maps, drawings and schematics or photographs imported directly from a digital camera.
9.1 Drawings and Drawing Objects
There are two fundamental elements that are used in Nets drawings, the drawings themselves (DRAWING objects) which can be considered as backgrounds, and the objects (DOBJ objects) that are displayed on those backgrounds.