|
|
This appendix contains information on the CiscoWorks database table structures. The following tables are described:
Certain tables that exist in the Sybase database are not described in this appendix. These tables include the security tables and will normally not have to be accessed. It is highly recommended that you do not edit these tables.
This section provides a chart depicting the relationship between the major tables in the CiscoWorks database, and it provides table structure characteristics.
Table C-1 lists the conventions used in defining fields.
Table C-1 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 in. The word null does not have to be entered; the field may be left blank if no data is to be entered. |
| varchar | A variable character defined by number of characters in parentheses. |
| text | A text string. |
| image | A block of data. |
Table-to-table links throughout the database structure are accomplished using id fields, for example, device_id, people_id, admin_id, and so on.
The AutoInstall Manager application uses the autoinstall table to store data records on the following items. (See Table C-2.)
Table C-2 autoinstall Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| aim_id | int | AutoInstall ID. | |
| aim_state | tinyint | Device state. Disabled = 0. Enabled = 1. | |
| device_id | int | Device ID. Links to the devices table. | |
| dev_if_name | varchar (32) | NULL | Not used. |
| dev_if_addr | varchar (64) | NULL | IP address for the device. |
| dev_if_subn | varchar (64) | NULL | Subnet mask for the device. |
| helper_addr | varchar (64) | NULL | Helper address. |
| config_ver | int | NULL | Configuration file version to use. |
| neighbor_id | int | NULL | Device ID of the neighbor device from the devices table. |
| neigh_if_id | tinyint | NULL | Interface ID of the neighbor device used to access the if_addresses table. Links to the interfaces table. |
Device inventory consists of all the information that you can associate with a specific device, including contact, address, telephone, and vendor data.
Figure C-1 illustrates CiscoWorks database table interrelationships for device inventory.
Figure C-1 Device Inventory Database Tables Relationships
Table C-3 through Table C-14 are used for device inventory. These tables include the table name, field names, field size, and field type found in the database table.
Table C-3 admins Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| admin_id | smallint | Administration ID. | |
| admin_name | char (32) | Full name of administrator. | |
| admin_desc | 64 Character | NULL | Description of administrator duties or location. |
Table C-4 devices Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| device_id | int | Device ID. | |
| device_type | smallint | NULL | Specific Cisco device platform. |
| device_name | 32 Character | Name of Cisco device. | |
| device_domain | varchar (128) | NULL | Internet domain in which this device belongs. For example, cisco.com. |
| device_desc | varchar (255) | NULL | Description of Cisco device. |
| sysobject_id | varchar (64) | NULL | Identifies vendor and device type. |
| rd_community | char (32) | NULL | Read community string. |
| community | char (32) | NULL | Write community string. |
| enable_passwd | varchar (32) | NULL | Password to enable the device. |
| vty_passwd | varchar (32) | NULL | Password to allow terminal interaction with a Cisco device. |
| admin_id | smallint | Administration ID. Links to the admins table. | |
| serial_number | char (32) | NULL | Identification number for the device chassis. |
| vendor_id | smallint | Vendor ID. Links to the vendors table. | |
| address_id | smallint | Address ID. Links to the locations table. | |
| software_desc | varchar (254) | NULL | Description of current software release on the device. |
| software_ver | char (16) | NULL | Current software release version number. |
| hardware_desc | char (64) | NULL | Description of device hardware. |
| hardware_ver | char (16) | NULL | Current hardware version number. |
| platform_id | int | NULL | Identification number for the Cisco device type |
| has_flash | int | NULL | Indication of Flash memory capabilities. |
| has_env | int | NULL | Indication of Environmental card capabilities. |
| init_timestamp | datetime | NULL | Date and time that the device was initialized. |
| loaded_conf | int | NULL | The configuration file marked with the flag. |
| monitor_ints | char (1) | NULL | Indication of interfaces being monitored by the Device Monitor daemon. |
| monitor_env | char (1) | NULL | Indication that the Environmental card is being monitored by the Device Monitor daemon. |
| monitor_events | char (1) | NULL | Indication that the Device Monitor daemon is monitoring device events. |
| monitor_poll | int | NULL | Indication that there is polling occurring. |
Table C-5 interfaces Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| interface_id | tinyint | Interface ID. | |
| device_id | int | Device ID. Links to the devices table. | |
| interface_type | smallint | NULL | Type of interface (serial, Ethernet, and so on). |
| interface_name | char (32) | Name of the interface. | |
| interface_desc | char (64) | NULL | Description of the type of interface. |
| hardware_addr | char (64) | NULL | Description of device hardware. Links to the devices table. |
| hardware_ver | char (16) | NULL | Current hardware version number. Links to the devices table. |
| line_id | int | Line ID. Links to the lines table. |
Table C-6 ifaddresses Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| device_id | int | Device ID. Links to the devices table. | |
| interface_id | tinyint | Type of interface (serial, Ethernet, and so on). Links to interfaces table. | |
| protocol_id | smallint | Protocol ID. | |
| protocol_type | smallint | Type of protocol running on the device. Links to the protocols table. | |
| protocol_addr | char (64) | Protocol address. Links to the protocols table. |
Table C-7 contacts Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| device_id | int | Device ID. Links to the devices table. | |
| people_id | smallint | People ID. Links to the peoples table. |
Table C-8 lines Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| line_id | int | Line ID. | |
| line_group_id | int | Line group ID. | |
| line_type | smallint | NULL | Type of line used for this device: · 0 = no designation (default setting) · 1 = Ethernet thin wire · 2 = Ethernet thick wire · 3 = Ethernet twisted pair · 4 = serial line |
| line_desc | char (16) | NULL | Description of line. |
Table C-9 locations Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| address_id | smallint | Address ID. | |
| location | char (64) | Location of the device. | |
| street | char (32) | NULL | Street name. |
| street_two | char (32) | NULL | Second line for street name. |
| city | 16 Character | NULL | City name. |
| state | char (2) | NULL | State name. |
| country | char (16) | NULL | Country name. |
| zip_code | char (16) | NULL | Zip code or country code. |
Table C-10 networks Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| network_id | smallint | Network ID. | |
| network_name | char (32) | Name of the network where this device is located. | |
| admin_id | smallint | Administration ID. Links to the admins table. |
Table C-11 people Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| people_id | smallint | People ID. | |
| address_id | smallint | Address ID. Links to the locations table. | |
| last_name | char (16) | Last name of device contact person. | |
| first_name | char (16) | First name of device contact person. | |
| middle_name | char (16) | NULL | Middle name of device contact person. |
| phone_number | char (16) | NULL | Telephone number of device contact person. Links to the phones table. |
| email_addr | char (64) | NULL | Electronic mail address of device contact person. |
| title | char (32) | NULL | Job title of device contact person. |
| nic_id | char (8) | NULL | Internet NIC ID. |
Table C-12 phones Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| people_id | int | NULL | People ID. Links to the people table. |
| phone_desc | int | NULL | Description of telephone number. |
| phone_number | smallint | NULL | Telephone number. |
| phone_id | char (64) | NULL | Telephone ID. |
Table C-13 protocol types Table File StructureT
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| protocol_type | smallint | Type of protocol running on the device. | |
| type_desc | char (64) | Description of the protocol type. |
Table C-14 vendor Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| vendor_id | smallint | Vendor ID. | |
| vendor_name | char (32) | Name of the vendor where the device was purchased. | |
| street | char (32) | NULL | Street name of vendor. |
| street_two | char (32) | NULL | Second line for street name of vendor. |
| city | char (64) | NULL | City name for vendor. |
| state | char (64) | NULL | State name for vendor. |
| country | char (64) | NULL | Country name for vendor. |
| zip_code | char (64) | NULL | Zip code or country code for vendor. |
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. These tables are described in the following section.
The tables listed in Table C-15 through Table C-20 are used for polling. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-15 attr Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| attr_id | int | Attribute ID. | |
| snm_name | varchar | MIB element name in the SunNet Manager software. | |
| ncs_name | varchar | NULL | MIB element name in the CiscoWorks software. |
| object_id | varchar | NULL | MIB object ID. |
| iftable | int | NULL | Interfaces table flag. 0 = not iftable. 1 = iftable. |
Table C-16 columns Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| poll_id | smallint | Poll ID. | |
| column_name | varchar | Column of record in database. | |
| attr_id | int | Attribute ID. Links to the attr table. | |
| datatype | smallint | Sybase database type. |
Table C-17 pollers Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| poller_host | char (15) | Name of the workstation that nmpolld is running on. | |
| poller_id | int | Poller ID. | |
| pid | int | Process identification number. |
Table C-18 polls Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| poll_id | int | Poll ID. | |
| poll_name | varchar (80) | User-defined name for poll group.. | |
| table_name | char (30) | Table name for data repository table. | |
| poll_rate | int | NULL | Desired polling interval (secs). Defaults are -1 for tables to be deleted; 0 for tables to be disabled. |
Table C-19 polls_config Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| poll_id | int | Poll ID. | |
| poller_id | varchar | Poller ID. | |
| device_id | int | Device ID. Links to the devices table. | |
| attr_id | int | NULL | Attribute ID. Links to the attr table. |
| inst | varchar | NULL | Instance ID. Links to the interface tables interface ID. |
Table C-20 start_stop Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| table_name | char (3) | Name of polling table. | |
| poller_id | varchar | Poller ID. | |
| type | tinyint | Device status. 0 = start, 1 = stop, 2 = restart. | |
| clock_time | datetime | NULL | Date and time polling stopped, started, or restarted. |
| device_id | int | NULL | Device ID. Links to the devices table. |
Device configuration consists of all the information that you want to gather from a device during device configuration.
The tables listed in Table C-21 and Table C-22 are used for device configuration. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-21 device_config Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| conf_id | int | Configuration ID. | |
| creator | varchar (64) | Name of person who created or loaded configuration. | |
| time_created | int | Date and time configuration was created. | |
| conf_stat | char (2) | NULL | Date and time configuration was started. |
| user_image | text | NULL | Name of the Cisco configuration file image. |
| machine_image | text | Name of the compiled configuration file version. | |
| comments | text | Description of the configuration file. |
Table C-22 history Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| device_id | int | Device ID. Links to the devices table. | |
| conf_id | int | Configuration ID. Links to the device_config table. | |
| conf_ver | int | Version of the configuration file. | |
| software_ver | varchar (16) | Software release version. |
Domains consists of all the information on the collection of routers you have created to manage your network.
The tables listed in Table C-23 and Table C-24 are used for creating domains. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-23 domains Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| domain_id | int | Domain ID. | |
| domain_name | char (32) | Name of the domain. |
Table C-24 domain_devices Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| domain_id | int | Domain ID. Links to the domains table. | |
| device_id | int | Device ID. Links to the devices table. |
The Global Commands and Scheduler tables include information that CiscoWorks needs to send global commands to a device set.
The tables listed in Table C-25 through Table C-27 are used for the Global Command Manager application and the Scheduler utility. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-25 gcmds Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| gcmd_id | int | Global command ID. | |
| gcmd_name | char (32) | NULL | Name of global command. |
| command | text | NULL | Command syntax. |
| user_name | char (32) | NULL | Name of user. |
| status | int | NULL | Status of command. |
Table C-26 gcmds_domains Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| gcmd_id | int | Global command ID. Links to the gcmds table. | |
| domain_id | int | Domain ID. Links to the domains table. |
Table C-27 crons Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| cron_id | int | Cron ID. | |
| gcmd_id | int | Global command ID. Links to the gcmds table. | |
| cron_name | char (32) | NULL | Name of cron job in the Scheduler utility. |
| user_name | char (32) | NULL | Name of user. |
| command | text | NULL | Command syntax sent to Scheduler utility. Links to the gcmds table. |
| status | int | Status of command. Links to the gcmds table. | |
| minutes | int | Time in minutes of cron. | |
| hour | int | Time in hours of cron. | |
| day | int | Day of cron job. | |
| month | int | Month of cron job. | |
| week | int | Week of cron job. |
The configuration snap-in command tables include information that CiscoWorks needs to send snap-in commands to a device set.
The tables listed in Table C-28 and Table C-29 are used for the Configuration Snap-In Manager application. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-28 pccmdset Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| cfgcmdset_id | int | Configuration snap-in command ID. | |
| group_name | char (32) | Name of the set of commands. | |
| group_type | int | Type of snap-in commands. | |
| the_group | image | NULL | Set of snap-in commands. |
| domain | char (32) | Domain name. Links to the domains table. | |
| device_set | char (32) | The set of devices to which the command will be sent. | |
| device_set_type | int | The platform type of the device set. | |
| description | char (255) | A description of the configuration snap-in command. |
Table C-29 pcdevset Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| cfgdevset_id | int | Configuration snap-in device set ID. | |
| devset_name | char (32) | Name of the set of devices to which the command will be sent. | |
| domain | char (32) | Domain name. Links to the domains table. | |
| the_device | image | NULL | Contains the collection of devices. |
| ref_count | int | Reference count of the number of the command sets that link to the a device set. | |
| description | char (255) | A description of the device set. |
The software management tables consist of all the information that is required to perform the tasks for the Software Manager, Device Software Manager, and the Software Inventory Manager application.
The tables listed in Table C-30 and Table C-31 are used for the software management tasks. These tables include the table name, field names, field size, field type, and description of the database records.
Table C-30 controllers Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| controller_id | int | Controller ID. | |
| device_id | int | Device ID. Links to the devices table. | |
| controller | char (32) | Name of the controller card in the device. | |
| version | char (32) | Controller card microcode version. |
Table C-31 SysFiles Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| file_id | int | Software image file ID. | |
| file_name | varchar (128) | Software image file name. | |
| file_type | tinyint | Software image file type. | |
| rel_version | char (32) | Software image file release version. | |
| checksum | int | Checksum of the software image. | |
| length | int | Size of the software image file. | |
| platform | char (32) | NULL | Platform type. |
| interface | char (32) | NULL | Interface name for the controller card. |
| compressed | tinyint | NULL | Indication if the image file is compressed. |
| user_alias | char (32) | NULL | User-provided name for the software image file. |
| comments | text | NULL | Description or comments. |
The Log Manager application uses the ciscolog table to store data records on the following items. (See Table C-32.)
Table C-32 ciscolog Table File Structure
| Field Name | Field Size | Field Type | Description |
|---|---|---|---|
| msgid | int | Message ID. | |
| timestamp | datetime | Date and time of message. | |
| appl | char (30) | CiscoWorks application that generated message. | |
| device | char (30) | NULL | Device that generated message or that the message is about. |
| event | char (30) | NULL | Type of event. |
| netaddr | char (30) | NULL | Network IP address. |
| text1 | varchar (255) | NULL | Together these records contain the text of the log message. |
| text2 | varchar (255) | NULL | |
| text3 | varchar (255) | NULL | |
| text4 | varchar (255) | NULL |
|
Copyright 1988-1995 © Cisco Systems Inc.