This appendix contains information on the CiscoWorks database table structures.
This section contains a chart depicting the relationship between the major tables in the CiscoWorks database and provides table structure characteristics.
Table C-1 lists the conventions used in defining fields.
Database Field Conventions
| Convention
| Description
|
|---|
| Int
| A whole number between 231 -1 (2,147,483,647) and -231 (-2,147,483,648) inclusive. Storage size is 4 bytes.
|
| Smallint
| A whole number between 215 -1 (32,767) and -215 (-32,768) inclusive. Storage size is 2 bytes.
|
| Tinyint
| A whole number between 0 and 255 inclusive. Storage size is 1 byte.
|
| NULL
| A field that does not have to be filled. The word NULL does not have to be entered, the field may be left blank if no data is to be entered.
|
Table-to-table links throughout the database structure are accomplished using id fields. Examples are: "device_id," "people_id," "admin_id," and so on.
Device Inventory Database Tables
Device inventory consists of all the information that you can associate with a specific device, including contact, address, phone, and vendor data.
Figure C-1 illustrates CiscoWorks database table interrelationships for device inventory.

Figure C-1: Device Inventory Database Tables Relationships
Tables C-2 through C-11 are used for device inventory. These tables include the table name, field names, field size, and field type found in the database table.
Admins Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Admins
| admin_id
| Smallint
|
|
|
| admin_name
| 32 Character
|
|
|
| admin_desc
| 64 Character
| Null
|
Devices Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Devices
| device_id
| Int
|
|
|
| device_type
| Smallint
| Null
|
|
| device_name
| 32 Character
|
|
|
| device_domain
| 255 Character
|
|
|
| device_desc
|
|
|
|
| community
|
|
|
|
| admin_id
| Smallint
|
|
|
| serial_number
| 32 Character
| Null
|
|
| vendor_id
| Smallint
|
|
|
| address_id
| Smallint
|
|
|
| location
| 64 Character
| Null
|
|
| software_desc
| 32 Character
| Null
|
|
| software_ver
| 16 Character
| Null
|
|
| hardware_desc
| 32 Character
| Null
|
|
| hardware_ver
| 16 Character
| Null
|
|
| loaded_conf
| Int
|
|
|
| conf_load_time
| Int
|
|
|
| conf_loader
| 64 Character
|
|
| Interfaces
| interface_id
| Tinyint
|
|
|
| device_id
| Int
|
|
|
| interface_type
| Smallint
| Null
|
|
| interface_name
| 32 Character
|
|
|
| interface_desc
| 64 Character
| Null
|
|
| hardware_addr
| 64 Character
| Null
|
|
| hardware_ver
| 16 Character
| Null
|
|
| line_id
| Int
|
|
| If Addresses
| device_id
| Int
|
|
|
| interface_id
| Tinyint
|
|
|
| protocol_id
| Smallint
|
|
|
| protocol_type
| Smallint
|
|
|
| protocol_addr
| 64 Character
|
|
Contacts Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Contacts
| device_id
| Int
|
|
|
| people_id
| Smallint
|
|
Lines Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Lines
| line_id
| Int
|
|
|
| line_group_id
| Int
|
|
|
| line_type
| Smallint
| Null
|
|
| line_desc
| 16 Character
| Null
|
Locations Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Locations
| address_id
| Smallint
|
|
|
| location
| 64 Character
|
|
|
| street
| 32 Character
| Null
|
|
| street_two
| 32 Character
| Null
|
|
| city
| 16 Character
| Null
|
|
| state
| 2 Character
| Null
|
|
| country
| 16 Character
| Null
|
|
| zip_code
| 16 Character
| Null
|
Networks Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Networks
| network_id
| Smallint
|
|
|
| network_name
| 32 Character
|
|
|
| admin_id
| Smallint
|
|
People Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| People
| people_id
| Smallint
|
|
|
| address_id
| Smallint
|
|
|
| last_name
| 16 Character
|
|
|
| first_name
| 16 Character
|
|
|
| middle_name
| 16 Character
| Null
|
|
| phone_number
| 16 Character
| Null
|
|
| email_addr
| 64 Character
| Null
|
|
| title
| 32 Character
| Null
|
|
| nic_id
| 8 Character
| Null
|
Phones Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Phones
| people_id
| Int
| Null
|
|
| phone_desc
| Int
| Null
|
|
| phone_number
| Smallint
| Null
|
|
| phone_id
| 64 Character
| Null
|
Protocol Types Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Protocol Types
| protocol_type
| Smallint
|
|
|
| type_desc
| 64 Character
|
|
Vendor Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Vendor
| vendor_id
| Smallint
|
|
|
| vendor_name
| 32 Character
|
|
|
| street
| 32 Character
| Null
|
|
| street_two
| 32 Character
| Null
|
|
| city
| 16 Character
| Null
|
|
| state
| 16 Character
| Null
|
|
| country
| 16 Character
| Null
|
|
| zip_code
| 16 Character
| Null
|
Polling Database Tables
Device polling consists of all the information that you want to gather from a device based on how you have set up your poll groups.
Figure C-2 illustrates CiscoWorks database table interrelationships in device polling.

Figure C-2: Device Polling Database Tables Relationships
The following database tables are used during device polling and described in the tables below.
- Polls_config
- Start_stop
- Pollers
- Attr
- Columns
Tables C-12 through C-16 are used for polling. These tables include the table name, field names, field size, and field type found in the database table.
Attr Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Attr
| attr_id
| Int
|
|
|
| snm_name
| Varchar
|
|
|
| ncs_name
| Varchar
| Null
|
|
| object_id
| Varchar
| Null
|
|
| iftable
| Int
| Null
|
Columns Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Columns
| poll_id
| Smallint
|
|
|
| column_name
| Varchar
|
|
|
| attr_id
| Int
|
|
|
| datatype
| Smallint
|
|
Pollers Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Pollers
| poller_host
| 15 Character
|
|
|
| poller_id
| Int
|
|
|
| pid
| Int
|
|
Polls_config Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Polls Config
| poll_id
| Int
|
|
|
| poller_id
| Varchar
|
|
|
| device_id
| Int
|
|
|
| attr_id
| Int
| Null
|
|
| inst
| Varchar
| Null
|
Start_Stop Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Start_Stop
| table_name
| 30 Character
|
|
|
| poller_id
| Varchar
|
|
|
| type
| Tinyint
|
|
|
| clock_time
| Datetime
|
|
|
| device_id
| Int
|
|
Device Configuration Database Tables
Device configuration consists of all the information that you want to gather from a device during device configuration.
Table C-17 is used for configuration polling. These tables include the table name, field names, field size, and field type found in the database table.
Device Configuration Table File Structure
| Table Name
| Field Name
| Field Size
| Field Type
|
|---|
| Device Config
| conf_id
| Int
|
|
|
| creator
| 64 Character
|
|
|
| time_created
| Int
|
|
|
| conf_stat
| 2 Character
|
|
|
| user_image
| Text
| Null
|
|
| machine_image
| Text
| Null
|
|
| comments
| Text
| Null
|
| Location
| device_id
| Int
|
|
|
| host_name
| 254 Character
|
|
|
| file_name
| 254 Character
|
|
| History
| device_id
| Int
|
|
|
| conf_id
| Int
|
|
|
| conf_ver
| Int
|
|
|
| software_ver
| 16 Character
|
|