|
|
This appendix describes the layout of the Sybase 10 database tables used by CiscoWorks Blue Maps and CiscoWorks Blue SNA View applications. It includes these major sections:
| Caution Do not modify database table information. Sybase-knowledgeable users should see the schema files located in $CWBROOT/etc. |
Table B-1 lists the conventions, used in defining fields in the database tables, that designate different types of data.
| Convention | Description |
|---|---|
int | Whole number between 231 -1 (2,147,483,647) and -231 (-2,147,483,648), inclusive. Storage size is 4 bytes. |
smallint | Whole number between 215 -1 (32,767) and -215 (-32,768), inclusive. Storage size is 2 bytes. |
tinyint | Whole number between 0 and 255, inclusive. Storage size is 1 byte. |
NULL | Field does not have to be filled in. Do not enter the word NULL; leave field blank. |
varchar | Variable character defined by the number of characters in parentheses. |
text | Text string. |
image | Block of data. |
The database program uses "_id" fields (such as device_id, people_id, and admin_id) to make table-to-table links throughout the database structure. Each table is referenced both by a symbolic name (like Client List table) and its actual database name (client_list).
This section contains database tables used by both the RSRB and DLSw Maps applications and includes the following sections.
The Client List table (client_list) shown in Table B-2 contains a list of GUI applications that are registered with the monitor daemon so that views can be updated. There is one record for each client. The monitor daemon initializes its client list by reading entries from this table at startup; it updates the table by adding an entry for each registration request received and by deleting an entry for each deregistration request received. To clear the client list, start the monitor daemon with the -c option, or edit this table to remove client records.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
ip_address | int | NOT NULL | IP address of client |
udp_port | smallint | NOT NULL | UDP port on which this client listens |
requests | smallint | NULL | Specify RSRB or DLSw |
The Devices table (devices) shown in Table B-3 stores necessary information about known devices. There is one record for each device.When the status field changes, or when a device is added or removed, the display is updated.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL UNIQUE | Unique device ID generated by Sybase at time of insertion into table; used as primary index to table |
device_name | char(32) | NOT NULL UNIQUE | Device name or IP address |
rd_community | char(32) | NULL | Read community string |
community | char(32) | NULL | Write community string |
platform_id | int | NULL | Platform type |
disc_status | smallint | NULL | Discovery status |
protocols | smallint | NULL | Contains a bit to represent each protocol enabled on the router device; facilitates determination of protocols configured on the device |
status | smallint | NULL | Status is either active (111) or inactive (113) at time of insertion into the table; field changes at discovery time depending on the SNMP response |
properties | smallint | NULL | Used by DLSw to mark a device as a key device |
update_time | smalldatetime | NULL | Updated to current Sybase time when status field is changed; time is seconds since January 1, 1970 |
The Interface table (if_table) shown in Table B-4 is used to store information about the interface such as the device ID, type, and physical address.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID generated by Sybase at time of insertion into table; used as primary index to table |
if_index | smallint | NULL | Interface index |
if_type | smallint | NULL | Type of the interface |
if_phy_addr | varbinary(12) | NULL | Physical address of the interface |
The IP Address table (ipaddr_table) shown in Table B-5 is used to store all of the IP addresses configured on each router. This table is used to correlate the IP addresses of all of the routers obtained from the seed file or network management system database. Maps uses the IP Address table to show only one icon for a router even though there might be more than one alias entered in the Maps application.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID generated by Sybase at time of insertion into table; used as primary index to table |
ip_address | int | NOT NULL | IP address used by the router |
ip_netmask | int | NOT NULL | IP mask used by the router |
if_index | smallint | NULL | Interface index on router where IP address is found |
The Locate Router table (locate_rtr_table) shown in Table B-6 is used to generate the unique device ID for each new device and it also stores the DSQUERY and DBNAME environment variables that are used to identify the database that contains the device information. An entry is made in this table the first time that the device is discovered.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | IDENTITY | Unique device ID generated by Sybase at time of insertion into table; used as primary index to table |
dsquery | char(30) | NOT NULL | Sybase dataserver name where device name is stored |
dbname | char(30) | NULL | Database name |
device_name | varchar(100) | NOT NULL | Device name or IP address |
ip_address | int | NOT NULL | IP address used by the router for that protocol |
The Logical Views table (logical_views) shown in Table B-7 associates a sequence number with each type of view. This sequence number is passed to the GUI with every view. Sequence numbers are updated by several Sybase triggers set on devices, peer tables, and PU tables. When a change occurs in any of those tables that causes a view to change, the sequence number is incremented. By checking the sequence number, the GUI determines whether a view is up-to-date.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
type | smallint | NOT NULL | View type |
sequence | int | NULL | Sequence number of this view |
The PU Dependency table (pu_dependents) shown in Table B-8 contains information, taken from the Routing Information Field (RIF) data, about the path that a PU session takes through the network. There is one record for each device in the path. Each record contains the PU name of the device, the device type, and the device name.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
pu_name | varchar(30) | NOT NULL | PU name in the format PU_NAME.DOMAIN |
device_type | smallint | NULL | Type of device as specified in the PU's RIF data |
device_name | varchar(100) | NOT NULL | Name of device as specified in PU's RIF data |
The Process table (process_table) shown in Table B-9 records the status and owner's name for each Maps daemon. The daemons update this table when they are started.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
id | smallint | NOT NULL UNIQUE | Process ID number of a daemon, as assigned by CiscoWorks Blue |
status | smallint | NULL | Current status of this daemon |
name | char(20) | NULL | Logical name of the owner of this daemon |
unix_id | int | NULL | Process ID number of a daemon, as assigned by the operating system |
dtime | datetime | NULL | Date and time of this daemon's startup |
parameters | char(30) | NULL | Command line parameters used to start this daemon |
The Ring Bridge table (ring_bridge) shown in Table B-10 maintains information about the relationships between real rings and virtual rings on every known RSRB or DLSw device. This table maps directly to the (ring, bridge, ring) tuples extracted from the RIF of each device. Given a (ring, bridge, ring) tuple, Maps can determine the referenced device. Maps parses the PU's RIF to extract (ring, bridge, ring) tuples. And by referring to this tuple, Maps can determine the dependency list for the PU.
There is typically one virtual ring defined per router, so this table will have no more entries than the number of real Token Ring interfaces on the router. In terms of router configuration commands, every occurrence of the following router command results in one entry in the Ring Bridge table.
source-bridge real-ring bridge-no virtual-ring
The total number of entries in this table is an indication of the number of Token Rings in the network that are bridged using RSRB or DLSw.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Index into this table (from the Devices table) |
ring1 | smallint | NULL | Ring number for first Token Ring (1) |
type1 | smallint | NULL | Indicates whether ring 1 is real or virtual. |
bridge | smallint | NULL | Bridge number between Token Rings 1 and 2 |
ring2 | smallint | NULL | Ring number for Token Ring 2 |
type2 | smallint | NULL | Indicates whether Token Ring 2 is real or virtual |
This section describes the database tables used by just the RSRB Maps application. It contains the following sections:
The Address ID table (addr_id) shown in Table B-11 maps the IP address used for RSRB to the device ID. There is typically one IP address per device for RSRB, but there can be multiple IP addresses if the router defines more than one virtual ring. This table is used to establish peer relationships between routers by matching IP addresses in the Peer Table.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID from the Device table |
ip_address | int | NULL | IP address used by this device for RSRB |
The Membership table (membership) shown in Table B-12 maintains a list of all devices connected or attached to a real or virtual ring. It is used for displaying views centered on virtual rings and in determining which real rings are associated with each of the routers in the view.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Index into this table; unique ID of this device from the Devices table |
ring_no | smallint | NOT NULL | Virtual or real ring number of this device |
ring_type | smallint | NOT NULL | Indicates whether the ring is real or virtual |
The Peer table (peer_table) shown in Table B-13 contains information about RSRB peers defined on every device. There is one record per peer definition per router. The poller constantly updates the status of the peers in this table. There are triggers for additions and deletions to this table.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Index into this table from the Devices table |
vring | smallint | NULL | The virtual ring on which the peer is defined |
pindex | smallint | NULL | Peer index to allow retrieval of statistical information about a given peer relationship |
ip_addr | int | NULL | Remote IP address of the peer, if any |
encap | smallint | NULL | Encapsulation |
state | smallint | NULL | Current state of this peer; a trigger on this field causes update of the sequence number for RSRB-related views |
latest | smallint | NULL | Used by the poller for updating peer entries |
This section describes the database tables used by just the DLSw Maps application. It contains the following sections:
The DLSw Address table (dlsw_addr_id) shown in Table B-14 correlates each device ID with an IP address.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID |
ip_address | int | NULL | IP address used by this device |
sequence | int | NULL | Sequence number used for focus view; incremented by 1 for each state change to device's peer connections as recorded in DLSw Circuit table |
The DLSw Circuit table (dlsw_circuits) shown in Table B-15 stores the circuit information.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID |
mac1 | binary(12) | NULL | Local MAC address |
sap1 | binary(2) | NULL | Local SAP |
if_index | smallint | NULL | Interface index |
dlc_type | smallint | NULL | Data-link connection type |
rif | binary(18) | NULL | Route information |
mac2 | binary(12) | NULL | Remote MAC address |
sap2 | binary(2) | NULL | Remote SAP |
location | smallint | NULL | Location |
domain | smallint | NULL | Transport domain |
remote_addr | int | NULL | Remote transport address |
origin | smallint | NULL | Origin |
state | smallint | NULL | State of the circuit |
update_time | int | NULL | Time when state field was last confirmed; time is the number of seconds since January 1, 1970 |
The DLSw Peer table (dlsw_peers) shown in Table B-16 stores information about the DLSw peer device such as the device ID, domain, local and remote address, and status of the peer connection.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
device_id | numeric(9,0) | NOT NULL | Unique device ID |
domain | smallint | NULL | Transport mechanism |
local_addr | int | NULL | Local transport address |
remote_addr | int | NULL | Remote transport address |
state | smallint | NULL | Status of the peer connection |
config_index | smallint | NULL | Configuration index |
type | smallint | NULL | Setup type |
change_time | int | NULL | Time when state field changed; time is the number of seconds since January 1, 1970 |
update_time | int | NULL | Time when state field was last confirmed; time is the number of seconds since January 1, 1970 |
This section contains database tables that are available only when CiscoWorks Blue SNA View is installed on the workstation. These tables are described here, rather than in an appendix of the CiscoWorks Blue SNA View Workstation Installation and User Guide, so that you can find all database tables in one place. This section contains the following subsections:
The Logical Unit table (lu_table) shown in Table B-17 contains information about each LU. There is one record for each known LU. Because LU status changes are linked to PU status changes, there is no trigger mechanism to update sequence numbers in the Logical Views table (shown earlier in the section "Logical Views Table").
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
pu_name | char(10) | NULL | PU to which this LU is attached |
lu_name | char(18) | UNIQUE | LU name, as defined in VTAM, in the format LU_NAME.DOMAIN |
status | smallint | NULL | Status of the LU is the same as the status of the PU to which it is attached |
The Physical Unit table (pu_table) shown in Table B-18 contains information about all discovered PUs. It is initially populated by the SNA View discovery process, but is constantly updated by the Status Manager. For each PU, this table contains the PU name, MAC address, RIF (if available), PU type, local and remote MAC addresses, local and remote SAPs, and current status. The PU_ID, a unique number that SNA View assigns to each PU, is the primary index into this table. There is one record for each PU_ID. There is a trigger on the status column that increments the sequence number for the PU/LU view in the Logical Views table.
| Field Name | Field Type | Field Value | Description |
|---|---|---|---|
pu_id | numeric(9,0) | IDENTITY | Unique identifier of this PU |
pu_name | varchar(17) | NOT NULL | PU name, as defined in VTAM, in the format PU_NAME.DOMAIN |
pu_type | smallint | NULL | PU type; Type 2.1 is stored as 21 |
status | smallint | NULL | Current status of this PU |
pu_mac | binary(12) | NULL | Local MAC address (PU MAC address) |
ncp_mac | binary(12) | NULL | Remote MAC address |
pu_sap | binary(2) | NULL | Local SAP |
ncp_sap | binary(2) | NULL | Remote SAP |
xid | binary(4) | NULL | VTAM node ID |
rif | binary(18) | NULL | Ring information field (RIF) data |
ring_no | smallint | NULL | The real Token Ring number on which this PU resides, or 0 if there is no RIF for this PU from which to extract the number |
Posted: Thu Aug 19 11:04:32 PDT 1999
Copyright 1989-1999©Cisco Systems Inc.