Table Of Contents
PXM MIB Objects
Cisco Entity FRU Control MIB Objects
CISCO ENTITY FRU CONTROL MIB Textual Conventions
cefc Module Table
CISCO ENTITY FRU CONTROL MIB Notification
CISCO ENTITY FRU CONTROL MIB Conformance Information
Entity MIB Objects
Physical Table
Physical Entity Table
Physical Mapping Table
Last Change TimeStamp
Entity Conformance and Compliance Information
Entity Compliance Statements
Entity MIB Groupings
Sensor MIB Objects
SENSOR MIB Textual Conventions
SENSOR MIB Objects Table
Ent Sensor Threshold Table
SENSOR MIB Notification
SENSOR MIB Conformance Information
SENSOR MIB Units of Conformance
SNMPv2 MIB Objects
System Group
Object Resource Information
SNMP Group
Information for Notification
Well-Known Traps
Set Group
SNMPv2 Conformance and Compliance Statements
SNMPv2 Compliance Statements
SNMPv2 Units of Conformance
SNMPv2 Textual Conventions
Cisco VSI Controller MIB Objects
Cisco VSI Controller Terminology
Cisco VSI Controller Textual Conventions
Cisco VSI Controller Configuration Table
Cisco VSI Controller Conformance and Compliance Information
Cisco VSI Controller Compliance Statement
Cisco VSI Controller Units of Conformance
PXM MIB Objects
This chapter describes the Management Information Base (MIB) objects used for PXM45.
Contents of this chapter include:
•
Cisco Entity FRU Control MIB Objects
•
Entity MIB Objects
•
Sensor MIB Objects
•
SNMPv2 MIB Objects
•
Cisco VSI Controller MIB Objects
Cisco Entity FRU Control MIB Objects
This section describes the individual MIB objects that make up the PXM45-specific MIB files. The CISCO Entity Field Replaceable Unit (FRU) Control MIB resides in the ENTITY-MIB.my file. The CISCO Entity FRU CONTROL MIB is used to monitor and configure the operational FRU of the system listed in the ENTITY MIB (RFC 2037) entPhysicalTable.
The FRUs include assemblies such as power supplies, fans, processor modules, interface modules, and so forth.
The Cisco Entity FRU Control MIB objects include:
•
CISCO ENTITY FRU CONTROL MIB Textual Conventions
•
cefc Module Table
•
CISCO ENTITY FRU CONTROL MIB Notification
•
CISCO ENTITY FRU CONTROL MIB Conformance Information
CISCO ENTITY FRU CONTROL MIB Textual Conventions
The names of the textual conventions are specified in the object syntax.
Table 4-1 lists the textual conventions MIB objects.
Note
Textual conventions do not have object identifiers.
Table 4-1 Cisco Entity FRU Control Textual Conventions MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
PowerRedundancy Type |
Integer {notsupported (1), redundant (2), combined (3)} |
Contains the valid values of the power supply redundancy modes. The following are the values: • notsupported(1)—Indicates that only the requested administrative state (redundant [2] or combined [3]) is not supported by the system. This is the operational state. • redundant(2)—Signifies a single power supply output that powers the entire system, although there is more than one supply in the system. For example, a system with one 1000-watt supply and one 1300-watt supply can be rated to power 1000-watts of FRUs. • combined(3)—Specifies the combined output of the power supplies that are available to operate the system. For example, two 1000-watt supplies a combined-mode supply of 2000 watts to the system. Status: current |
none |
PowerAdminType |
Integer {on(1), off(2)} |
Sets the administratively desired FRU power state types. Valid values are the following: • on (1) • Turn FRU on and off (2) • Turn FRU off Status: current |
none |
PowerOperType |
Integer {offEnvOther(1), on(2), offAdmin(3), offDenied(4), offEnvPower(5), offEnvTemp(6), offEnvFan(7)} |
Sets the operational FRU status types. The following are the values: • offEnvOther(1)—Specifies that FRU is powered off because of a problem not listed below. • on(2)—Specifies that FRU is powered on. • offAdmin(3)—Turns administratively off. • offDenied(4)—Specifies that FRU is powered off because the available system power is insufficient. • offEnvPower(5)—Turns the FRU is powered off because of a power problem. For example, the FRU power translation (DC-DC converter) or distribution failed. • offEnvTemp(6)—Turns the FRU power off because of a temperature problem. • offEnvFan(7)—Turns the FRU power off because of fan problems. Status: current |
none |
FRUCurrentType |
Integer ( -1000000000..1000000000 ) |
Shows a current measurement on the system power supply primary output in cefcPowerUnits. Range is from negative 1 million to positive one million amperes. A negative value expresses the current used by the FRU. A positive value expresses the current supplied by the FRU. Status: current |
none |
ModuleAdminType |
Integer {enabled (1), disabled (2), reset (3), outOfServiceAdmin (4)} |
Sets the administratively desired module states. The following are the values: • enabled (1)—Determines that the module is operational. • disabled (2)—Determines that the module is not operational. • reset (3)—Resets the module. • outOfServiceAdmin (4)—Turns the module power on, but it is out of service. This value is set by CLI. Status: current |
none |
ModuleOperType |
Integer {unknown(1), ok(2), disabled(3), okButDiagFailed(4), boot(5), selfTest(6), failed(7), missing(8), mismatchWithParent(9), mismatchConfig(10), diagFailed(11), dormant(12), outOfServiceAdmin(13), outOfServiceEnvTemp(14)} |
Displays the operational module states. The following are the values: • unknown(1)—Specifies that the module is not in one of the other recognized operational states. • ok(2)—States the module is operational. • disabled(3)—Disables the module administratively. • okButDiagFailed(4)—Specifies that the module is operational but there is some diagnostic information available. This is a transitional state. • boot(5)—Brings up the image of the module. After boot, it starts its operational software and transitions to the appropriate state. This is a transitional state. • selfTest(6)—Performs a self-test of the module. This is a transitional state. • failed(7)—Specifies that the module has failed due to some condition not stated above. This is a failure state. • missing(8)—Specifies that the module is provisioned, but it is missing. This is a failure state. • mismatchWithParent(9)—Indicates that the module is not compatible with parent entity. Module is not provisioned; the wrong type of module is plugged in. This state is cleared by plugging in the appropriate module. This is a failure state. |
none |
ModuleOperType (continued) |
|
• mismatchConfig(10)—Indicates that the module is not compatible with the current configuration. The module was provisioned correctly earlier; however, the module has been replaced by an incompatible module. This state is resolved by clearing the configuration or by replacing the appropriate module. This is a failure state. • diagFailed(11)—Specifies that the module diagnostic test failed due to a hardware failure. This is a failure state. • dormant(12)—Specifies that the module is waiting for an external or internal event to become operational. • outOfServiceAdmin(13)—Turns on the module administratively; however, it is out of service. • outOfServiceEnvTemp(14)—Turns on the module administratively; however, it is out of service due to an environmental temperature problem. An out-of-service module consumes less power and consequently can cool down. Status: current |
|
ModuleResetReasonType |
Integer {unknown(1), powerUp(2), parityError(3), clearConfigReset(4), manualReset(5)} |
Describes the reason for the last module reset operation. The following are the values: • unknown(1)—Source of the reset is not identified. • powerUp(2)—Indicates a system powerup operation. • parityError(3)—Indicates a parity error that occurred during the system bring up operation. • clearConfigReset(4)—Resets due to clear configuration operation. • manualReset(5)—Resets due to an administrative request. Status: current |
none |
cefc Module Table
The object identifier for each MIB object is listed in Table 4-2.
Table 4-2 cefc Module Table Object Identifiers
|
Name
|
Object Identifier
|
cefcModuleTable |
::= { cefcModule 1 } |
cefcModuleEntry |
::= { cefcModuleTable 1 } |
cefcModuleAdminStatus |
::= { cefcModuleEntry 1 } |
cefcModuleOperStatus |
::= { cefcModuleEntry 2 } |
cefcModuleResetReason |
::= { cefcModuleEntry 3 } |
cefcModuleStatusLastChangeTime |
::= { cefcModuleEntry 4 } |
The MIB objects are listed in Table 4-3.
Table 4-3 cefc Module Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
cefcModuleTable |
Sequence of cefcModuleEntry |
Lists the operation and administrative status information for ENTITY MIB entPhysicalTable entries for the FRUs of type PhysicalClass module(9). Max-Access: not-accessible Status: current |
none |
cefcModuleEntry |
cefcModuleEntry |
Lists the operation and administrative status information for ENTITY MIB entPhysicalTable entries for FRUs of type PhysicalClass module (9). Entries are created by the agent at the system power-up or module insertion. Entries are deleted by the agent upon module removal. Max-Access: not-accessible Status: current The index contains entPhysicalIndex. |
none |
cefcModuleAdminStatus |
ModuleAdminType |
Provides administrative control of the module. Max-Access: read-write Status: current |
none |
cefcModuleOperStatus |
ModuleOperType |
Shows the operational state of the module. Max-Access: read-only Status: current |
none |
cefcModuleResetReason |
ModuleResetReasonType |
Identifies the reason for the last reset performed on the module. Max-Access: read-only Status: current |
none |
cefcModuleStatusLast ChangeTime |
TimeStamp |
Displays the value of sysUpTime when the cefcModuleOperStatus is changed. Max-Access: read-only Status: current |
none |
CISCO ENTITY FRU CONTROL MIB Notification
According to RFC 2578, a notification is used to describe unsolicited transmissions of management information. NOTIFICATION-TYPE conveys the syntax and semantics of a notification.
The object identifier for the MIB object is listed in Table 4-4.
Table 4-4 CISCO ENTITY FRU CONTROL MIB Notification Object Identifier
|
Name
|
Object Identifier
|
cefcModuleStatusChange |
::= { cefcMIBNotifications 1 } |
One MIB object is listed in Table 4-5.
Table 4-5 CISCO ENTITY FRU CONTROL MIB Notification MIB Object
|
Name
|
Objects
|
Description
|
Default Value
|
cefcModuleStatusChange |
cefcModuleOperStatus, cefcModuleStatusLast ChangeTime |
Generates the value of cefcModuleOperStatus changes. NMS uses this object to update the status of the module it is managing. Status: current |
none |
CISCO ENTITY FRU CONTROL MIB Conformance Information
The information on conformance is specific to SNMPv2 as listed in Table 4-6 and Table 4-7.
Table 4-6 CISCO ENTITY FRU CONTROL MIB Units of Conformance
|
Name
|
Object Identifier
|
cefcMIBModuleGroup |
::= { cefcMIBGroups 3 } |
Table 4-7 CISCO ENTITY FRU CONTROL MIB Units of Conformance Object
|
Name
|
Objects
|
Description
|
Default Value
|
cefcMIBModuleGroup |
cefcModuleAdminStatus, cefcModuleOperStatus, cefcModuleResetReason, cefcModuleStatusLast ChangeTime |
Provides a collection of objects that are used to obtain the operational state and redundancy state of the modules. Status: current |
none |
Entity MIB Objects
This section describes the individual MIB objects that make up the PXM45-specific MIB files. The ENTITY MIB resides in the ENTITY-MIB.my file. This MIB module represents multiple logical entities supported by a single SNMP agent.
The entity MIB objects include:
•
Physical Table
•
Physical Entity Table
•
Physical Mapping Table
•
Last Change TimeStamp
•
Entity Conformance and Compliance Information
Physical Table
The physical table defines the textual conventions.
Note
The physical table group does not contain any object identifiers.
Physical Table MIB objects are listed in Table 4-8.
Table 4-8 Physical Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
PhysicalIndex |
Integer (1..2147483647) |
Specifies an arbitrary value that uniquely identifies the physical entity. The value can be a small positive integer; index values for different physical entities are not necessarily contiguous. Status: current |
none |
PhysicalClass |
Integer {other(1), unknown(2), chassis(3), backplane(4), container(5), (for example, a chassis slot or daughter-card holder) powerSupply(6), fan(7), sensor(8), module(9), (for example, a plug-in card or daughter-card) port(10), stack(11) (for example, a stack of multiple chassis entities)} |
Specifies an enumerated value that provides an indication of the general hardware type of a particular physical entity. There are no restrictions as to the number of entPhysicalEntries of each entPhysicalClass that must be instantiated by an agent. The following are the definitions for enumeration: • other—Needs to know the physical entity class. It does not match any of the supported values. • unknown—Needs to know the physical entity class. It is unknown to the agent. • chassis—Needs to know if the physical entity class is an overall container for networking equipment. Any class of physical entity except a stack is contained within a chassis, and a chassis is contained only within a stack. • backplane—Needs to know if the physical entity class is a device for aggregating and forwarding networking traffic, such as a shared backplane in a modular Ethernet switch. An agent can model a backplane as a single physical entity, which is actually implemented as multiple discrete physical components (within a chassis or stack). • container—Needs to know if the physical entity class is capable of containing one or more removable physical entities, possibly of different types. For example, each (empty or full) slot in a chassis is modeled as a container. All removable physical entities are modeled within a container entity, such as field-replaceable modules, fans, or power supplies. All known containers are modeled by the agent, including empty containers. |
none |
PhysicalClass (continued) |
|
• powerSupply—Needs to know if the physical entity class is a power-supplying component. • fan—Needs to know if the physical entity class is a fan or other heat-reduction component. • sensor—Needs to know if the physical entity class is a sensor, such as a temperature sensor within a router chassis. • module—Needs to know if the physical entity class is a self-contained subsystem. If it is removable, it is modeled within a container entity; otherwise, it is modeled directly within another physical entity, for example, a chassis or another module. • port—Needs to know if the physical entity class is a networking port, capable of receiving or transmitting networking traffic. • stack—Needs to know if the physical entity class is a super-container (possibly virtual), intended to group together multiple, chassis entities. A stack is used by a virtual cable or a real interconnect cable. A stack can also be attached to multiple chassis or is comprised of multiple interconnect cables. A stack is not modeled within any other physical entities, but a stack is contained within another stack. Only chassis entities are contained within a stack. Status: current |
|
SnmpEngineId OrNone |
Octet String (SIZE(0..32))—empty string or SnmpEngineID |
Specifies a specially formatted SnmpEngineID string for use with the ENTITY MIB. If an instance of syntax object SnmpEngineIdOrNone has a nonzero length, the object encoding and semantics are defined by the SnmpEngineID textual convention (refer to RFC 2571). If an instance of syntax object SnmpEngineIdOrNone contains a zero-length string, no appropriate SnmpEngineID is associated with the logical entity (that is, SNMPv3 is not supported). Status: current |
none |
Physical Entity Table
The object identifiers are listed in Table 4-9.
Table 4-9 Physical Entity Table Object Identifiers
|
Name
|
Object Identifier
|
EntPhysicalTable |
::= { entityPhysical 1 } |
entPhysicalEntry |
::= { entPhysicalTable 1 } |
entPhysicalIndex |
::= { entPhysicalEntry 1 } |
entPhysicalDescr |
::= { entPhysicalEntry 2 } |
entPhysicalVendorType |
::= { entPhysicalEntry 3 } |
entPhysicalContainedIn |
::= { entPhysicalEntry 4 } |
entPhysicalClass |
::= { entPhysicalEntry 5 } |
entPhysicalParentRelPos |
::= { entPhysicalEntry 6 } |
entPhysicalName |
::= { entPhysicalEntry 7 } |
entPhysicalHardwareRev |
::= { entPhysicalEntry 8 } |
entPhysicalFirmwareRev |
::= { entPhysicalEntry 9 } |
entPhysicalSoftwareRev |
::= { entPhysicalEntry 10 } |
entPhysicalSerialNum |
::= { entPhysicalEntry 11 } |
entPhysicalMfgName |
::= { entPhysicalEntry 12 } |
entPhysicalModelName |
::= { entPhysicalEntry 13 } |
entPhysicalAlias |
::= { entPhysicalEntry 14 } |
entPhysicalAssetID |
::= { entPhysicalEntry 15 } |
entPhysicalIsFRU |
::= { entPhysicalEntry 16 } |
The MIB objects are described in Table 4-10.
Table 4-10 Physical Entity Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
EntPhysicalTable |
Sequence of EntPhysicalEntry |
Contains one row per physical entity. There is always at least one row for an overall physical entity. Max-Access: not-accessible Status: current |
none |
entPhysicalEntry |
entPhysicalEntry |
Provides information about a particular physical entity. Each entry provides objects entPhysicalDescr, entPhysicalVendorType, and entPhysicalClass to help an NMS identify and characterize the entry. The objects entPhysicalContainedIn and entPhysicalParentRelPos relate this entry to other entries in this table. For the OID1 values assigned to the entPhysicalVendorType, see Table 1-8, Table 1-9, and Table 1-10. Max-Access: not-accessible Status: current The index contains entPhysicalIndex. |
none |
entPhysicalIndex |
PhysicalIndex |
Specifies the index for this entry. Max-Access: not-accessible Status: current |
none |
entPhysicalDescr |
SnmpAdminString |
Provides a textual description for a physical entity. This object contains a string that identifies the manufacturer name for the physical entity, and is set to a different value for each version or model of the physical entity. Max-Access: read-only Status: current |
none |
entPhysicalVendorType |
AutonomousType |
Indicates the vendor-specific hardware type of the physical entity. Note This is different from the definition of MIB-II sysObjectID. An agent sets this object to a enterprise-specific registration identifier value indicating the specific equipment type in detail. The associated instance of entPhysicalClass is used to indicate the general type of hardware device. If no vendor-specific registration identifier exists for this physical entity, or the value is unknown by this agent, the value { 0 0 } is returned. For OID values of this object, see Table 1-8, Table 1-9, and Table 1-10. Max-Access: read-only Status: current |
none |
entPhysicalContainedIn |
Integer (0..2147483647) |
Specifies the value of entPhysicalIndex for the physical entity containing this object. A value of 0 indicates this physical entity is not contained in any other physical entity. Note The set of containment relationships defines a strict hierarchy; that is, recursion is not allowed. In the event a physical entity is contained by more than one physical entity (for example, double-wide modules), this object can identify the containing entity with the lowest value of entPhysicalIndex. Max-Access: read-only Status: current |
none |
entPhysicalClass |
PhysicalClass |
Indicates the general hardware type of the physical entity. An agent can set this object to the standard enumeration value that most accurately indicates the general class of the physical entity, or the primary class if there is more than one. If no appropriate standard registration identifier exists for this physical entity, the value other(1) is returned. If the value is unknown by this agent, the value unknown(2) is returned. Max-Access: read-only Status: current |
none |
entPhysicalParentRelPos |
Integer (-1..2147483647) |
Indicates the relative position of this child component among all its sibling components. Sibling components are defined as entPhysicalEntries, which share the same instance values of each of the entPhysicalContainedIn and entPhysicalClass objects. An NMS can use this object to identify the relative ordering for all sibling components of a particular parent (identified by the entPhysicalContainedIn instance in each sibling entry). This value can match any external labeling of the physical component if possible. For example, for a container (card slot) labeled as slot #3, entPhysicalParentRelPos should have the value 3. Note The entPhysicalEntry for the module plugged in slot 3 can have an entPhysicalParentRelPos value of 1. If the physical position of this component does not match any external numbering or visible ordering, user documentation or other external reference material should be used to determine the parent-relative position. If this is not possible, the agent should assign a consistent (but possibly arbitrary) ordering to a given set of sibling components, based on internal representation of the components. |
none |
entPhysicalParentRelPos (continued) |
|
If the agent cannot determine the parent-relative position, or if the associated value of entPhysicalContainedIn is 0, the value -1 is returned. Otherwise, a nonnegative integer is returned, which indicates the parent-relative position of this physical entity. Parent-relative ordering normally starts from 1 and continues to n. For example, n represents the highest positioned child entity. If the physical entities, for example, slots, are labeled from a starting position of 0, the first sibling is associated with a entPhysicalParentRelPos value 0. Note This ordering can be sparse or dense, depending on agent implementation. The actual values returned are not globally meaningful, as each parent component can use different numbering algorithms. The ordering is meaningful only among siblings of the same parent component. The agent can retain parent-relative position values across reboots, either through algorithmic assignment or use of nonvolatile storage. Max-Access: read-only Status: current |
|
entPhysicalName |
SnmpAdminString |
Specifies the textual name of the physical entity. The value of this object can be the name of the component as assigned by the local device, and can be suitable for use in commands entered at the device console. This can be a text name, such as console, or a simple component number (for example, port or module number) such as 1, depending on the physical component naming syntax of the device. If there is no local name, or this object is not applicable, this object contains a zero-length string. Note The value of entPhysicalName for two physical entities can be the same if the console interface does not distinguish between them, for example, slot-1 and the card in slot-1. Max-Access: read-only Status: current |
none |
entPhysicalHardwareRev |
SnmpAdminString |
Specifies the vendor-specific hardware revision string for the physical entity. The preferred value is the hardware revision identifier printed on the component itself (if present). Note If revision information is stored internally in a nonprintable format, (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific hardware revision string is associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current |
none |
entPhysicalFirmwareRev |
SnmpAdminString |
Specifies the vendor-specific firmware revision string for the physical entity. Note If revision information is stored internally in a non-printable format (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific firmware programs are associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current |
none |
entPhysicalSoftwareRev |
SnmpAdminString |
Specifies the vendor-specific software revision string for the physical entity. Note If revision information is stored internally in a nonprintable format (for example, binary), the agent must convert the information to a printable format in an implementation-specific manner. If no specific software programs are associated with the physical component, or this information is unknown to the agent, this object can contain a zero-length string. Max-Access: read-only Status: current |
none |
entPhysicalSerialNum |
SnmpAdminString (SIZE (0..32)) |
Specifies the vendor-specific serial number string for the physical entity. The preferred value is the serial number string printed on the component itself (if present). On the first instantiation of an physical entity, the associated value entPhysicalSerialNum is set to the correct vendor-assigned serial number, if this information is available to the agent. If a serial number is unknown or nonexistent, the entPhysicalSerialNum is set to a zero-length string instead. Note The implementations can identify the serial numbers of all installed physical entities, which do not provide write access to the entPhysicalSerialNum object. Agents which cannot provide nonvolatile storage for the entPhysicalSerialNum strings are not required to implement write access for this object. Not every physical component has a serial number, or needs one. Physical entities for which the associated value of the entPhysicalIsFRU object is equal to false(2) (for example, the repeater ports within a repeater module) do not need a unique serial number. An agent does not need to provide write access for such entities and can return a zero-length string. If write access is implemented for an instance of entPhysicalSerialNum, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalSerialNum instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity entPhysicalIndex value. Max-Access: read-write Status: current |
none |
entPhysicalMfgName |
SnmpAdminString |
Specifies the manufacturer name of the physical component. The preferred value is the manufacturer name string printed on the component itself (if present). Note The comparisons between instances of the entPhysicalModelName, entPhysicalFirmwareRev, entPhysicalSoftwareRev, and the entPhysicalSerialNum objects, are only meaningful among entPhysicalEntries with the same value of entPhysicalMfgName. If the manufacturer name string associated with the physical component is unknown to the agent, this object contains a zero-length string. Max-Access: read-only Status: current |
none |
entPhysicalModelName |
SnmpAdminString |
Specifies the model name identifier string associated with this physical component. It is different for each vendor. The preferred value is the manufacturer-visible part number, which is printed on the component itself. If the model name string associated with the physical component is unknown to the agent, this object contains a zero-length string. Max-Access: read-only Status: current |
none |
entPhysicalAlias |
SnmpAdminString (SIZE (0..32)) |
Specifies an alias name for the physical entity as specified by a network manager, and provides a nonvolatile handle for the physical entity. On the first instantiation of a physical entity, the value of entPhysicalAlias is set to the zero-length string. However, the agent sets the value to a locally unique default value, instead of a zero-length string. If write access is implemented for an instance of entPhysicalAlias, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalAlias instance associated with the same physical entity. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity entPhysicalIndex value. Max-Access: read-write Status: current |
none |
entPhysicalAssetID |
SnmpAdminString (SIZE (0..32)) |
Specifies a user-assigned asset tracking identifier for the physical entity as specified by a network manager, and provides nonvolatile storage of this information. On the first instantiation of a physical entity, the value entPhysicalAssetID is set to the zero-length string. Not every physical component will have an asset tracking identifier, or even need one. Physical entities where the associated value of the entPhysicalIsFRU object is equal to false(2) (that is, the repeater ports within a repeater module), do not a unique asset tracking identifier. An agent does not have to provide write access for such entities, and may instead return a zero-length string. If write access is implemented for an instance of entPhysicalAssetID, and a value is written into the instance, the agent must retain the supplied value in the entPhysicalAssetID instance associated with the same physical entity for as long as that entity remains instantiated. This includes instantiations across all reinitializations and reboots of the network management system, including those which result in a change of the physical entity entPhysicalIndex value. If no asset tracking information is associated with the physical component, this object contains a zero-length string. Max-Access: read-write Status: current |
none |
entPhysicalIsFRU |
TruthValue |
Indicates whether or not this physical entity is a FRU. If this object contains the value true(1), this entPhysicalEntry identifies a field replaceable unit. For all entPhysicalEntries which represent components that are permanently contained within a field replaceable unit, the value false(2) is returned for this object. Max-Access: read-only Status: current |
none |
Physical Mapping Table
The object identifier for each MIB object is listed in Table 4-11.
Table 4-11 Physical Mapping Table Object Identifiers
|
Name
|
Object Identifier
|
entPhysicalContainsTable |
::= { entityMapping 3 } |
entPhysicalContainsEntry |
::= { entPhysicalContainsTable 1 } |
entPhysicalChildIndex |
::= { entPhysicalContainsEntry 1 } |
The MIB objects are listed in Table 4-12.
Table 4-12 Physical Mapping Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
entPhysicalContainsTable |
Sequence of entPhysicalContainsEntry |
Shows the container relationships between physical entities. This table provides all the information found by constructing the virtual containment tree for a given entPhysicalTable, but in a more direct format. If a physical entity is contained by more than one other physical entity (for example, double-wide modules), this table can include these additional mappings, which cannot be represented in the entPhysicalTable virtual containment tree. Max-Access: not-accessible Status: current |
none |
entPhysicalContainsEntry |
entPhysicalContainsEntry |
Indicates a single container or containee relationship. Max-Access: not-accessible Status: current The indexes are the following: • entPhysicalIndex • entPhysicalChildIndex |
none |
entPhysicalChildIndex |
PhysicalIndex |
Specifies the value entPhysicalIndex for the contained physical entity. Max-Access: read-only Status: current |
none |
Last Change TimeStamp
The object identifier for the MIB object is shown in Table 4-13.
Table 4-13 Last Change TimeStamp Object Identifier
|
Name
|
Object Identifier
|
entLastChangeTime |
::= { entityGeneral 1 } |
The MIB object is listed in Table 4-14.
Table 4-14 Last Change TimeStamp MIB Object
|
Name
|
Syntax
|
Description
|
Default Value
|
entLastChangeTime |
TimeStamp |
Specifies the value of sysUpTime when a conceptual row is created, modified, or deleted in these tables: • entPhysicalTable • entLogicalTable • entLPMappingTable • entAliasMappingTable • entPhysicalContainsTable Max-Access: read-only Status: current |
none |
Entity Conformance and Compliance Information
The object identifiers are listed in Table 4-15.
Table 4-15 Entity Conformance Groups
|
Name
|
Object Identifier
|
entityConformance |
::= { entityMIB 3 } |
entityCompliances |
::= { entityConformance 1 } |
entityGroups |
::= { entityConformance 2 } |
Entity Compliance Statements
One compliance object identifier is listed in Table 4-16.
Table 4-16 Entity Compliance Object Identifier
|
Name
|
Object Identifier
|
entPhysicalAssetID |
::= { entityCompliances 2 } |
A list of the objects for compliance is listed in Table 4-17.
Table 4-17 Entity Compliance Objects
|
Name
|
Mandatory Groups
|
Description
|
Default Value
|
entity2Compliance |
entityPhysicalGroup, entityPhysical2Group, entityGeneralGroup entityNotificationsGroup |
Describes the compliance statement for SNMP entities that implement version 2 of the entity MIB. Status: current |
none |
entityLogical2Group |
none |
Specifies the implementation of this group is not mandatory for agents which model all MIB object instances within a single naming scope. |
none |
entityMappingGroup |
none |
Implementation of the entPhysicalContainsTable is mandatory for all agents. Implementation of the entLPMappingTable and entAliasMappingTables are not mandatory for agents which model all MIB object instances within a single naming scope. Note The entAliasMappingTable can be useful for all agents; however, implementation of the entityLogicalGroup or entityLogical2Group is required to support this table. |
none |
entPhysicalSerialNum |
none |
Specifies read and write access are not required for agents that cannot identify serial number information for physical entities, and cannot provide non-volatile storage for NMS-assigned serial numbers. Write access is not required for agents that can identify serial number information for physical entities, but cannot provide non-volatile storage for NMS-assigned serial numbers. Write access is not required for physical entities for physical entities for which the associated value of the entPhysicalIsFRU object is equal to false(2). Min-Access: not-accessible |
none |
entPhysicalAlias |
none |
Specifies write access is required only if the associated entPhysicalClass value is equal to chassis(3). Min-Access: read-only |
none |
entPhysicalAssetID |
none |
Specifies read and write access is not required for agents that cannot provide non-volatile storage for NMS-assigned asset identifiers. Write access is not required for physical entities for which the associated value of entPhysicalIsFRU is equal to false(2). Min-Access: not-accessible |
none |
Entity MIB Groupings
The object identifiers are listed in Table 4-18.
Table 4-18 Entity MIB Groupings Object Identifiers
|
Name
|
Object Identifier
|
entityPhysicalGroup |
::= { entityGroups 1 } |
entityMappingGroup |
::= { entityGroups 3 } |
entityGeneralGroup |
::= { entityGroups 4 } |
entityNotificationsGroup |
::= { entityGroups 5 } |
entityPhysical2Group |
::= { entityGroups 6 } |
entityLogical2Group |
::= { entityGroups 7 } |
The object groups are listed in Table 4-19.
Table 4-19 Entity MIB Groupings Objects
|
Name
|
Objects
|
Description
|
Default Value
|
entityPhysicalGroup |
entPhysicalDescr, entPhysicalVendorType, entPhysicalContainedIn, entPhysicalClass, entPhysicalParentRelPos, entPhysicalName |
Specifies the collection of objects used to represent physical system components, which provide management information for a single agent. Status: current |
none |
entityMappingGroup |
entLPPhysicalIndex, entAliasMappingIdentifier, entPhysicalChildIndex |
Specifies the collection of objects used to represent the associations between multiple logical entities, physical components, interfaces, and port identifiers. A single agent provides management information for the applicable objects. Status: current |
none |
entityGeneralGroup |
entLastChangeTime |
Specifies the collection of objects used to represent general entity information. A single agent provides management information. Status: current |
none |
entityNotificationsGroup |
entConfigChange |
Specifies the collection of notifications used to indicate consistent Entity MIB data and general status information. Note The entityNotificationsGroup object applicable to the notification group. entConfigChange is a notification object. Status: current |
none |
entityPhysical2Group |
entPhysicalHardwareRev, entPhysicalFirmwareRev, entPhysicalSoftwareRev, entPhysicalSerialNum, entPhysicalMfgName, entPhysicalModelName, entPhysicalAlias, entPhysicalAssetID, entPhysicalIsFRU |
Specifies the collection of objects used to represent physical system components. A single agent provides management information. This group augments the objects contained in the entityPhysicalGroup. Status: current |
none |
entityLogical2Group |
entLogicalDescr, entLogicalType, entLogicalTAddress, entLogicalTDomain, entLogicalContextEngineID, entLogicalContextName |
Specifies the collection of objects used to represent the list of logical entities. A single SNMP entity provides management information. Status: current |
none |
Sensor MIB Objects
This section describes the individual MIB objects that make up the PXM45-specific MIB files. The SENSOR MIB resides in the CISCO-ENTITY-SENSOR-MIB.my file. It is used to monitor the values of sensors in the ENTITY MIB (refer to RFC 2037) entPhysicalTable.
The Sensor MIB objects include:
•
SENSOR MIB Textual Conventions
•
SENSOR MIB Objects Table
•
Ent Sensor Threshold Table
•
SENSOR MIB Notification
•
SENSOR MIB Conformance Information
SENSOR MIB Textual Conventions
The names of the textual conventions are specified in the object syntax.
The MIB objects are listed in Table 4-20.
Note
Textual Conventions do not have any object identifiers.
Table 4-20 SENSOR MIB Textual Conventions MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
SensorDataType |
Integer {other (1), unknown (2), voltsAC (3), voltsDC (4), amperes (5), watts (6), hertz (7), celsius (8), percentRH (9), rpm (10), cmm (11), truthvalue (12), specialEnum (13)} |
Describes the valid values that are used for SensorDataType. Status: current The following are the values for SensorDataType: |
none |
|
Sensor Measurement
|
Valid Value
|
other(1) |
Measure other than those listed below |
unknown(2) |
Unknown measurement, or arbitrary, relative numbers |
voltsAC(3) |
Electric potential |
voltsDC(4) |
Electric potential |
amperes(5) |
Electric current |
watts(6) |
Power |
hertz(7) |
Frequency |
celsius(8) |
Temperature |
percentRH(9) |
Percent relative humidity |
rpm(10) |
Shaft revolutions per minute |
cmm(11) |
Cubic meters per minute (airflow) |
truthvalue(12) |
Value takes {true(1), false(2)} |
specialEnum(13) |
Value takes user-defined enumerated values |
SensorDataScale |
Integer {yocto (1), zepto (2), atto (3), femto (4), pico (5), nano (6), micro (7), milli (8), Units (9), kilo (10), mega (11), giga (12), tera (13), exa (14), peta (15), zetta (16), yotta (17)} |
Displays the International System of Units prefixes. Status: current The following list the prefix and the value: |
none |
|
Prefix
|
Value
|
yocto (1) |
10-24 |
zepto (2) |
10-21 |
atto (3) |
10-18 |
femto (4) |
10-15 |
pico (5) |
10-12 |
nano (6) |
10-9 |
micro (7) |
10-6 |
milli (8) |
10-3 |
Units (9) |
100 |
kilo (10) |
103 |
mega (11) |
106 |
giga (12) |
109 |
tera (13) |
1012 |
exa (14) |
1015 |
peta (15) |
1018 |
zetta (16) |
1021 |
yotta (17) |
1024 |
SensorPrecision |
Integer (-8..9) |
Determines the number of decimal places in the fractional part of a SensorValue fixed-point number. When the range is from -8 to -1, SensorPrecision is the number of accurate digits in a SensorValue fixed-point number. SensorPrecision is 0 for nonfixed-point numbers. Agents must choose a value for SensorPrecision so that the precision and accuracy of a SensorValue is correctly indicated. For example, a temperature sensor that measures from 0° to 100° C in 0.1° increments of ±0.05° would have a SensorPrecision of 1, a SensorDataScale of Units (0), and a SensorValue ranging from 0 to 1000. The SensorValue is interpreted as (°C * 10). If that temperature sensor precision were 0.1° but the accuracy is only ±0.5°, the SensorPrecision would be set to 0. The SensorValue is interpreted as degrees C. Another example, a fan rotation speed sensor that measures RPM from 0 to 10,000 in 100 RPM increments, with an accuracy of +50/-37 RPM, can have a SensorPrecision of -2, a SensorDataScale of Units(9), and a SensorValue ranging from 0 to 10000. The 10s and 1s digits of SensorValue is always 0. Status: current |
none |
SensorValue |
Integer (-1000000000..1000000000) |
Measures AC volts, DC volts, amperes, watts, hertz, Celsius, and cmm. SensorValue is a fixed point number ranging from -999,999,999 to +999,999,999. Use the value -1000000000 to indicate underflow. Use the value +1000000000 to indicate overflow. Use SensorPrecision to indicate how many fractional digits the SensorValue has. For sensors that measure percent RH, this item is a number ranging from 0 to 100. For sensors that measure RPM, this item can take only nonnegative values, 0..999999999. For sensors of type truthvalue, this item can take only two values: true(1) and false(2). For sensors of type specialEnum, this item can take any value in the range (-1000000000..1000000000), but the meaning of each value is specific to the sensor. For sensors of type other and unknown, this item can take any value in the range (-1000000000..1000000000), but the meaning of the values are specific to the sensor. Use ENTITY MIB entPhysicalTable and entPhysicalVendorType to learn about the sensor type. For OID1 values assigned to entPhysicalVendorType, see Table 1-8, Table 1-9, and Table 1-10. Status: current |
none |
SensorStatus |
Integer {ok (1), unavailable (2), nonoperational (3)} |
Indicates the operational status of the sensor. Status: current The following are the values for SensorStatus: |
none |
|
Sensor Measurement
|
Valid Value
|
ok (1) |
The agent can read the sensor value. |
unavailable (2) |
The agent presently cannot report the sensor value. |
nonoperational (3) |
The sensor can have a hard failure (disconnected wire), or a soft failure such as out-of-range, jittery, or fluctuating readings. |
SensorValue UpdateRate |
Integer (0..999999999) |
Indicates the interval in seconds between updates to the sensor value. A value of 0 indicates one or more of the following: • Sensor value is updated on demand (when polled by the agent for a get-request). • Sensor value changes (event-driven). Agent does not know the rate. Status: current |
none |
SensorThreshold Severity |
Integer {other (1), minor (10), major (20)} |
Indicates the sensor threshold severity. Status: current The following are the values for SensorThresholdSeverity: |
none |
|
Sensor Measurement
|
Valid Value
|
other (1) |
Indicates a severity other than those listed below. |
minor (10) |
Minor problem threshold. |
major (20) |
Major problem threshold. |
SensorThreshold Relation |
Integer {lessThan (1), lessOrEqual (2), greaterThan (3), greaterOrEqual (4), equalTo (5), notEqualTo (6)} |
Displays the sensor threshold relational operator types. Status: current The following are the values for SensorThresholdRelation: |
none |
|
Sensor Threshold
|
Valid Value
|
lessThan(1) |
Sensor value is less than the threshold value. |
lessOrEqual(2) |
Sensor value is less than or equal to the threshold value. |
greaterThan(3) |
Sensor value is greater than the threshold value. |
greaterOrEqual(4) |
Sensor value is greater than or equal to the threshold value. |
equalTo(5) |
Sensor value is equal to the threshold value. |
notEqualTo(6) |
Sensor value is not equal to the threshold value. |
SENSOR MIB Objects Table
The object identifier for each MIB object is listed in Table 4-21.
Table 4-21 SENSOR MIB Object Identifiers
|
Name
|
Object Identifier
|
entSensorValueTable |
::= { entSensorValues 1 } |
entSensorValueEntry |
::= { entSensorValueTable 1 } |
entSensorType |
::= { entSensorValueEntry 1 } |
entSensorScale |
::= { entSensorValueEntry 2 } |
entSensorPrecision |
::= { entSensorValueEntry 3 } |
entSensorValue |
::= { entSensorValueEntry 4 } |
entSensorStatus |
::= { entSensorValueEntry 5 } |
entSensorValueTimeStamp |
::= { entSensorValueEntry 6 } |
entSensorValueUpdateRate |
::= { entSensorValueEntry 7 } |
The MIB objects are described in Table 4-22.
Table 4-22 SENSOR MIB Objects Table
|
Name
|
Syntax
|
Description
|
Default Value
|
entSensorValueTable |
Sequence of entSensorValueEntry |
Lists the type, scale, and present value of a sensor listed in the ENTITY MIB entPhysicalTable. Max-Access: not-accessible Status: current |
none |
entSensorValueEntry |
entSensorValueEntry |
Describes the present reading of a sensor, the measurement units and scale, and the sensor operational status. Max-Access: not-accessible Status: current The index contains entPhysicalIndex. |
none |
entSensorType |
SensorDataType |
Indicates the type of data reported by the entSensorValue. This object is set by the agent at startup and the value does not change during operation. Max-Access: read-only Status: current |
none |
entSensorScale |
SensorDataScale |
Indicates the exponent to apply to sensor values reported by entSensorValue. This object is set by the agent at start-up and the value does not change during operation. Max-Access: read-only Status: current |
none |
entSensorPrecision |
SensorPrecision |
Indicates the number of decimal places of precision in fixed-point sensor values reported by entSensorValue. This object is set to 0 when entSensorType is not a fixed-point type voltsAC (1), voltsDC (2), amperes (3), watts (4), hertz (5), celsius (6), or cmm (9). This object is set by the agent at start-up and the value does not change during operation. Max-Access: read-only Status: current |
none |
entSensorValue |
SensorValue |
Reports the most recent measurement seen by the sensor. To correctly display or interpret this object value, you must also know entSensorType, entSensorScale, and entSensorPrecision. However, you can compare entSensorValue with the threshold values given in entSensorThresholdTable without any semantic knowledge. Max-Access: read-only Status: current |
none |
entSensorStatus |
SensorStatus |
Indicates the present operational status of the sensor. Max-Access: read-only Status: current |
none |
entSensorValueTime Stamp |
TimeStamp |
Indicates the age of the value reported by entSensorValue. Max-Access: read-only Status: current |
none |
entSensorValueUpdateRate |
SensorValueUpdateRate |
Indicates the rate that the agent updates entSensorValue. Units: seconds Max-Access: read-only Status: current |
none |
Ent Sensor Threshold Table
The object identifier for each MIB object is listed in Table 4-23.
Table 4-23 Ent Sensor Threshold Table Object Identifiers
|
Name
|
Object Identifier
|
entSensorThresholdTable |
::= { entSensorThresholds 1 } |
entSensorThresholdEntry |
::= { entSensorThresholdTable 1 } |
entSensorThresholdIndex |
::= { entSensorThresholdEntry 1 } |
entSensorThresholdSeverity |
::= { entSensorThresholdEntry 2 } |
entSensorThresholdRelation |
::= { entSensorThresholdEntry 3 } |
entSensorThresholdValue |
::= { entSensorThresholdEntry 4 } |
entSensorThresholdEvaluation |
::= { entSensorThresholdEntry 5 } |
entSensorThresholdNotificationEnable |
::= { entSensorThresholdEntry 6 } |
The MIB objects are described in Table 4-24.
Table 4-24 Ent Sensor Threshold Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
entSensorThreshold Table |
Sequence of entSensorThresholdEntry |
Lists the threshold severity, relation, and comparison value for a sensor listed in the ENTITY MIB entPhysicalTable. Max-Access: not-accessible Status: current |
none |
entSensorThreshold Entry |
entSensorThresholdEntry |
Describes the thresholds for a sensor, the threshold severity, the threshold value, the relation, and the evaluation of the threshold. Only entities of type sensor (8) are listed in this table. Only preconfigured thresholds are listed in this table. Users can create sensor-value monitoring instruments in different ways, such as Remote Network Monitoring (RMON) alarm, or Expression-MIB. Entries are created by the agent at system startup and FRU insertion. Entries are deleted by the agent at FRU removal. Max-Access: not-accessible Status: current The following are the indexes: • entPhysicalIndex • entSensorThresholdIndex |
none |
entSensorThreshold Index |
Integer32 (1..99999999) |
Specifies an index that uniquely identifies an entry in the entSensorThreshold table. This index permits the same sensor to have several different thresholds. Max-Access: not-accessible Status: current |
none |
entSensorThreshold Severity |
SensorThresholdSeverity |
Indicates the severity of the sensor threshold. Max-Access: read-only Status: current |
none |
entSensorThreshold Relation |
SensorThresholdRelation |
Indicates the relation between sensor value (entSensorValue) and threshold value (entSensorThresholdValue), which are required to trigger the alarm when evaluating the relation. entSensorValue is on the left of entSensorThresholdRelation and entSensorThresholdValue is on the right. In pseudo-code, the evaluation-alarm mechanism is the following:
if (entSensorStatus == ok) then
if (evaluate(entSensorValue,
entSensorThresholdRelation,
entSensorThresholdValue))
if (entSensorThresholdNotificationEnable ==
true)) then
raise_alarm(entSensorThresholdAlarmOID);
Max-Access: read-only Status: current |
none |
entSensorThreshold Value |
SensorValue |
Indicates the value of the threshold. To correctly display or interpret this object value, you must also know entSensorType, entSensorScale, and entSensorPrecision. However, you can directly compare entSensorValue with the threshold values given in entSensorThresholdTable without any semantic knowledge. Max-Access: read-only Status: current |
none |
entSensorThreshold Evaluation |
TruthValue |
Indicates the result of the most recent evaluation of the threshold. If the threshold condition is true, entSensorThresholdEvaluation is true(1). If the threshold condition is false, entSensorThresholdEvaluation is false(2). Thresholds are evaluated at the rate indicated by entSensorValueUpdateRate. Max-Access: read-only Status: current |
none |
entSensorThreshold NotificationEnable |
TruthValue |
Controls the generation of entSensorThresholdNotification for this threshold. When this object is true (1), the generation of entSensorThresholdNotification is enabled. When this object is false(2), the generation of entSensorThresholdNotification is disabled. This object controls only the generation of entSensorThresholdNotification. Max-Access: read-write Status: current |
none |
SENSOR MIB Notification
According to RFC 2578, a notification is used to describe unsolicited transmissions of management information. NOTIFICATION-TYPE conveys the syntax and semantics of a notification.
The object identifier for the MIB object is listed in Table 4-25.
Table 4-25 SENSOR MIB Notification Object Identifier
|
Name
|
Object Identifier
|
entSensorThresholdNotification |
::= { entitySensorMIBNotifications 1 } |
The MIB object is listed in Table 4-26.
Table 4-26 SENSOR MIB Notification MIB Object
|
Name
|
Objects
|
Description
|
Default Value
|
entSensorThreshold Notification |
entSensorThresholdValue, entSensorValue |
Generates a notification each time the sensor value crosses the threshold listed in entSensorThresholdTable. The agent implementation facilitates a prompt evaluation of threshold and generation. Status: current |
none |
SENSOR MIB Conformance Information
The object identifier used for the SENSOR MIB conformance is listed in Table 4-27.
Table 4-27 SENSOR MIB Conformance Group
|
Name
|
Object Identifier
|
entitySensorMIBComplianceV01 |
::= { entitySensorMIBCompliances 1 } |
Table 4-28 lists one object for conformance.
Table 4-28 SENSOR MIB Conformance Object
|
Name
|
Module
|
Description
|
Default Value
|
entitySensorMIB ComplianceV01 |
PXM45 |
Lists sensors in the entPhysicalTable. The entitySensorMIBComplianceV01 object must implement this group as an ENTITY MIB. Status: current The mandatory groups are: • entitySensorValueGroup • entitySensorThresholdGroup • entitySensorThresholdNotificationGroup |
none |
SENSOR MIB Units of Conformance
The object identifier is listed in Table 4-29 for units of conformance.
Table 4-29 SENSOR MIB Units of Conformance
|
Name
|
Object Identifier
|
entitySensorValueGroup |
::= { entitySensorMIBGroups 1 } |
entitySensorThresholdGroup |
::= { entitySensorMIBGroups 2 } |
entitySensorThresholdNotificationGroup |
::= { entitySensorMIBGroups 3 } |
Table 4-30 lists the MIB objects for units of conformance.
Table 4-30 SENSOR MIB Units of Conformance Objects
|
Name
|
Objects
|
Description
|
Default Value
|
entitySensorValue Group |
entSensorType, entSensorScale, entSensorPrecision, entSensorValue, entSensorStatus, entSensorValueTimeStamp, entSensorValueUpdateRate |
Describes and monitors the values of the ENTITY MIB entPhysicalTable entries of sensors. Status: current |
none |
entitySensorThresholdGroup |
entSensorThresholdSeverity, entSensorThresholdRelation, entSensorThresholdValue, entSensorThresholdEvaluation, entSensorThresholdNotificationEnable |
Describes and monitors the thresholds for sensors. Status: current |
none |
entitySensorThresholdNotificationGroup |
none |
Monitors the sensor threshold activity for this collection of notifications. Note This notification is commented out because SMIC does not recognize the Notification Group. Notifications: entSensorThresholdNotification Status: current |
none |
SNMPv2 MIB Objects
This section describes the individual MIB objects that comprise SNMPv2. The objects reside in the SNMPv2-MIB.my file.
The SNMPv2 MIB objects include:
•
System Group
•
Object Resource Information
•
SNMP Group
•
Information for Notification
•
Well-Known Traps
•
Set Group
•
SNMPv2 Conformance and Compliance Statements
•
SNMPv2 Textual Conventions
System Group
The system group comprises a collection of objects that are common to all managed systems.
The following is the main object identifier for the snmpMIBObjects:
The object identifier for each MIB object is listed in Table 4-31. For possible values for the system group, see Table 1-11.
Table 4-31 System Group Object Identifiers
|
Name
|
Object Identifier
|
sysDescr |
::= { system 1 } |
sysObjectID |
::= { system 2 } |
sysUpTime |
::= { system 3 } |
sysContact |
::= { system 4 } |
sysName |
::= { system 5 } |
sysLocation |
::= { system 6 } |
sysServices |
::= { system 7 } |
The MIB objects are listed in Table 4-32.
Table 4-32 System Group MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
sysDescr |
DisplayString (SIZE (0..255)) |
Defines the textual description of the entity. This value includes a the full name and version identification of the system hardware type, software operating system, and networking software. Max-Access: read-only Status: current |
none |
sysObjectID |
OBJECT IDENTIFIER |
Specifies the vendor authoritative identification of the network management subsystem that is contained in the entity. This value is allocated within the Structure of Management Information (SMI) enterprise subtree 1.3.6.1.4.1. It provides an easy and unambiguous means for determining the type of box being managed. For example, if vendor Flintstones, Inc., is assigned the subtree 1.3.6.1.4.1.4242, it can assign the identifier 1.3.6.1.4.1.4242.1.1 to Fred Router. For the possible OID values assigned to sysObjectID, see Table 1-11. Max-Access: read-only Status: current |
none |
sysUpTime |
TimeTicks |
Determines the time (in hundredths of a second) since the network management portion of the system is last reinitialized. Max-Access: read-only Status: current |
none |
sysContact |
DisplayString (SIZE (0..255)) |
Specifies the textual identification of the contact person for this managed node along with information on how to contact this person. If no contact information is known, the value is the zero-length string. Max-Access: read-write Status: current |
none |
sysName |
DisplayString (SIZE (0..255)) |
Determines an administratively-assigned name for this managed node. By convention, this is the node fully-qualified domain name. If the name is unknown, the value is the zero-length string. Max-Access: read-write Status: current |
none |
sysLocation |
DisplayString (SIZE (0..255)) |
Determines the physical location of this node (for example, telephone closet, third floor). If the location is unknown, the value is the zero-length string. Max-Access: read-write Status: current |
none |
sysServices |
INTEGER (0..127) |
Indicates the value for the set of services that this entity can potentially offer. The value is a sum. This sum initially takes the value 0. For each layer, L, in the range 1 to 7, this node performs transactions for 2 raised to (L - 1) is added to the sum. For example, a node that performs only routing functions can have a value of 4 (2^(3-1)). In contrast, a node which is a host offering application services can have a value of 72 (2^(4-1) + 2^(7-1)). Max-Access: read-only Status: current For systems including Open System Interconnection (OSI) protocols, layers 5 and 6 can also be counted. Note The context of the Internet suite of protocols contains values that are calculated accordingly. The following are the supported layers: |
none |
|
Layer
|
Function
|
1 |
Physical—Supports repeaters. |
2 |
Datalink/Subnetwork—Supports bridges. |
3 |
Internet—Supports Internet Protocol (IP). |
4 |
End-To-End—Supports Transmission Control Protocol (TCP). |
7 |
Application—Supports Simple Management Transfer Protocol (SMTP). |
Object Resource Information
The object resource information comprises a collection of objects, which describe the SNMPv2 entity either statically or dynamically configured to support various MIB modules.
The object identifier for each MIB object is shown in Table 4-33. For the values that are used for the object resource information, see Table 1-11.
Table 4-33 Object Resource Information Object Identifiers
|
Name
|
Object Identifier
|
sysORLastChange |
::= { system 8 } |
sysORTable |
::= { system 9 } |
sysOREntry |
::= { sysORTable 1 } |
sysORIndex |
::= { sysOREntry 1 } |
sysORID |
::= { sysOREntry 2 } |
sysORDescr |
::= { sysOREntry 3 } |
sysORUpTime |
::= { sysOREntry 4 } |
The MIB objects are listed in Table 4-34.
Table 4-34 Object Resource Information MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
sysORLastChange |
TimeStamp |
Specifies the value of sysUpTime at the time of the most recent change in state or value of any instance of sysORID. Max-Access: read-only Status: current |
none |
sysORTable |
SEQUENCE OF SysOREntry |
Lists the capabilities of the local SNMPv2 entity that acts as an agent role with respect to various MIB modules. SNMPv2 entities, which are dynamically configured to support MIB modules, can have a dynamically-varying number of conceptual rows. Max-Access: not-accessible Status: current |
none |
sysOREntry |
SysOREntry |
Contains an entry (conceptual row) in the sysORTable. Max-Access: not-accessible Status: current The index contains sysORIndex. |
none |
sysORIndex |
INTEGER (1..2147483647) |
Specifies the auxiliary variable that is used to identify instances of the columnar objects in the sysORTable. Max-Access: not-accessible Status: current |
none |
sysORID |
OBJECT IDENTIFIER |
Specifies an authoritative identification of a capabilities statement with respect to various MIB modules. They are supported by the local SNMPv2 entity that acts as an agent role. Max-Access: read-only Status: current |
none |
sysORDescr |
DisplayString |
Defines a textual description of the capabilities identified by the corresponding instance of sysORID. Max-Access: read-only Status: current |
none |
sysORUpTime |
TimeStamp |
Specifies the value sysUpTime at the time this conceptual row is last instantiated. Max-Access: read-only Status: current |
none |
SNMP Group
The SNMP group comprises a collection of objects that provide the basic instrumentation and control of an SNMP entity.
The following is the main object identifier for snmp:
The object identifier for each MIB object is listed in Table 4-35. For values that are used for the SNMP group, see Table 1-11.
Table 4-35 SNMP Group Object Identifiers
|
Name
|
Object Identifier
|
snmpInPkts |
::= { snmp 1 } |
snmpInBadVersions |
::= { snmp 3 } |
snmpInBadCommunityNames |
::= { snmp 4 } |
snmpInBadCommunityUses |
::= { snmp 5 } |
snmpInASNParseErrs |
::= { snmp 6 } |
snmpEnableAuthenTraps |
::= { snmp 30 } |
snmpSilentDrops |
::= { snmp 31 } |
snmpProxyDrops |
::= { snmp 32 } |
The SNMP Group MIB objects are listed in Table 4-36.
Table 4-36 SNMP Group MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
snmpInPkts |
Counter32 |
Specifies the total number of messages delivered to the SNMP entity from the transport service. Max-Access: read-only Status: current |
none |
snmpInBadVersions |
Counter32 |
Determines the total number of SNMP messages delivered to the SNMP entity and used for an unsupported SNMP version. Max-Access: read-only Status: current |
none |
snmpInBadCommunityNames |
Counter32 |
Determines the total number of SNMP messages delivered to the SNMP entity that used a SNMP community name not known to the entity. Max-Access: read-only Status: current |
none |
snmpInBadCommunityUses |
Counter32 |
Determines the total number of SNMP messages delivered to the SNMP entity that represented a SNMP operation. This operation is not allowed by the SNMP community named in the message. Max-Access: read-only Status: current |
none |
snmpInASNParseErrs |
Counter32 |
Determines the total number of ASN.1 or Basic Encoding rules (BER) errors encountered by the SNMP entity when decoding received SNMP messages. Max-Access: read-only Status: current |
none |
snmpEnableAuthenTraps |
INTEGER { enabled(1), disabled(2) } |
Indicates whether the SNMP entity is permitted to generate authenticationFailure traps. The value of this object overrides any configuration information. It provides a means whereby all authenticationFailure traps are disabled. Note It is strongly recommended that this object be stored in nonvolatile memory, so that it remains constant across reinitializations of the NMS. Max-Access: read-write Status: current |
none |
snmpSilentDrops |
Counter32 |
Determines the total number of GetRequest-PDU, GetNextRequest-PDU, GetBulkRequest-PDU, SetRequest-PDU, and InformRequest-PDU delivered to the SNMP entity. The snmpSilentDrops object is silently dropped because the size of a reply that contains an alternate Response-PDU with an empty variable-bindings field, which is greater than either a local constraint or the maximum message size associated with the originator of the request. Max-Access: read-only Status: current |
none |
snmpProxyDrops |
Counter32 |
Determines the total number of GetRequest-PDU, GetNextRequest-PDU, GetBulkRequest-PDU, SetRequest-PDU, and InformRequest-PDU delivered to the SNMP entity. The snmpProxyDrops object is silently dropped because the transmission of the (possibly translated) message to a proxy target failed in a manner (other than a time-out) that no Response-PDU is returned. Max-Access: read-only Status: current |
none |
Information for Notification
The notification information comprises a collection of objects which allow the SNMPv2 entity, when acting as an agent role, to be configured to generate the SNMPv2-Trap-PDU.
The following is the main object identifier for the snmpTrap:
The object identifier for each MIB object is listed in Table 4-37. For values that are used for the information for notification, see Table 1-11.
Table 4-37 Information for Notification Object Identifiers
|
Name
|
Object Identifier
|
snmpTrapOID |
::= { snmpTrap 1 } |
snmpTrapEnterprise |
::= { snmpTrap 3 } |
The MIB objects are listed in Table 4-38.
Table 4-38 Information for Notification MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
snmpTrapOID |
OBJECT IDENTIFIER |
Specifies the authoritative identification of the notification currently being sent. This variable occurs as the second varbind in every SNMPv2-Trap-PDU and InformRequest-PDU. Max-Access: accessible-for-notify Status: current |
none |
snmpTrapEnterprise |
OBJECT IDENTIFIER |
Specifies the authoritative identification of the enterprise associated with the trap currently being sent. When a SNMPv2 proxy agent is mapping an RFC1157Trap-PDU into a SNMPv2-Trap-PDU, this variable occurs as the last varbind. Max-Access: accessible-for-notify Status: current |
none |
Well-Known Traps
The following is the main object identifier for the snmpTraps:
Note
Both linkDown (::= { snmpTraps 3 })and linkUp (::= { snmpTraps 4 }) traps are defined in
RFC 1573. RFC 1213 defines egpNeighborLoss (::= { snmpTraps 6 }).
The object identifier for each MIB object is listed in Table 4-39. For possible values for the traps,
see Table 1-11.
Table 4-39 Well-Known Traps Object Identifiers
|
Name
|
Object Identifier
|
coldStart |
::= { snmpTraps 1 } |
warmStart |
::= { snmpTraps 2 } |
authenticationFailure |
::= { snmpTraps 5 } |
The MIB objects are listed in Table 4-40.
Table 4-40 Well-Known Traps MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
coldStart |
none |
Signifies that the SNMPv2 entity acts as an agent role. This trap reinitializes itself so the configuration is altered. Status: current |
none |
warmStart |
none |
Signifies that the SNMPv2 entity acts as an agent role This trap reintializes itself so the configuration is unaltered. Status: current |
none |
authenticationFailure |
none |
Signifies that the SNMPv2 entity acts as an agent role. This trap receives a protocol message that is not properly authenticated. While all implementations of the SNMPv2 must be capable of generating this trap, the snmpEnableAuthenTraps object indicates whether this trap is generated. Status: current |
none |
Set Group
The set group comprises a collection of objects which allow several cooperating SNMPv2 entities, all acting as a manager role, to coordinate their use of the SNMPv2 set operation.
The following is the main object identifier for snmpSet:
The object identifier for the MIB object is listed in Table 4-41. For values that are used for the set group, see Table 1-11.
Table 4-41 Set Group Object Identifier
|
Name
|
Object Identifier
|
snmpSetSerialNo |
::= { snmpSet 1 } |
One MIB object is listed in Table 4-42 for the set group.
Table 4-42 Set Group MIB Object
|
Name
|
Syntax
|
Description
|
Default Value
|
snmpSetSerialNo |
TestAndIncr |
Specifies an advisory lock used to allow several cooperating SNMPv2 entities, which all act as a manager role, to coordinate their use of the SNMPv2 Set operation. This object is used for coarse-grain coordination. To achieve fine-grain coordination, one or more similar objects are appropriately defined within each MIB group. Max-Access: read-write Status: current |
none |
SNMPv2 Conformance and Compliance Statements
The information on conformance is specific to SNMPv2. Table 4-43 lists the groups.
Table 4-43 SNMPv2 Conformance Groups
|
Name
|
Object Identifier
|
snmpMIBConformance |
::= { snmpMIB 2 } |
snmpMIBCompliances |
::= { snmpMIBConformance 1 } |
snmpMIBGroups |
::= { snmpMIBConformance 2 } |
SNMPv2 Compliance Statements
The compliance statement is used to support SNMPv2. The following are the mandatory groups:
•
snmpGroup
•
snmpSetGroup
•
systemGroup
•
snmpBasicNotificationsGroup
The compliance object identifier is listed in Table 4-44.
Table 4-44 SNMPv2 Compliance Object Identifier
|
Name
|
Object Identifier
|
snmpCommunityGroup |
::= { snmpMIBCompliances 2 } |
A list of the MIB objects is listed in Table 4-45.
Table 4-45 SNMPv2 Compliance MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
snmpBasicCompliance |
none |
Specifies the compliance statement for the SNMPv2 entities that implement the SNMPv2 MIB. Status: current |
none |
snmpCommunityGroup |
none |
Supports community-based authentication. This group is mandatory for SNMPv2 entities. |
none |
SNMPv2 Units of Conformance
The object identifiers for each MIB object is listed in Table 4-46.
Table 4-46 SNMPv2 Units of Conformance Object Identifiers
|
Name
|
Object Identifier
|
snmpGroup |
::= { snmpMIBGroups 8 } |
snmpCommunityGroup |
::= { snmpMIBGroups 9 } |
snmpSetGroup |
::= { snmpMIBGroups 5 } |
systemGroup |
::= { snmpMIBGroups 6 } |
snmpBasicNotificationsGroup |
::= { snmpMIBGroups 7 } |
The SNMPv2 units of conformance objects are listed in Table 4-47.
Table 4-47 SNMPv2 Objects Used for Units of Conformance
|
Name
|
Objects
|
Description
|
Default Value
|
snmpGroup |
snmpInPkts, snmpInBadVersions, snmpInASNParseErrs, snmpSilentDrops, snmpProxyDrops, snmpEnableAuthenTraps |
Specifies a collection of objects that provides instrumentation and control of an SNMPv2 entity. Status: current |
none |
snmpCommunityGroup |
snmpInBadCommunity Names, snmpInBadCommunity Uses |
Specifies a collection of objects that provides basic instrumentation of a SNMPv2 entity that supports community-based authentication. Status: current |
none |
snmpSetGroup |
snmpSetSerialNo |
Specifies a collection of objects that allows several cooperating SNMPv2 entities, which all act as a manager role, to coordinate their use of the SNMPv2 Set operation. Status: current |
none |
systemGroup |
sysDescr, sysObjectID, sysUpTime, sysContact, sysName, sysLocation, sysServices, sysORLastChange, sysORID, sysORUpTime, sysORDescr |
Defines objects that are common to all managed systems for the system group. Status: current |
none |
snmpBasicNotificationsGroup |
coldStart, authenticationFailure |
Specifies the two notifications that an SNMPv2 entity is required to implement. Status: current |
none |
SNMPv2 Textual Conventions
This section describes the SNMPv2 textual conventions, which reside in the SNMPv2-TC.my file. The names of the textual conventions are specified in the object syntax.
Note
Textual conventions do not have any object identifiers.
The SNMPv2 textual conventions are listed in Table 4-48.
Table 4-48 SNMPv2 Textual Conventions MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
DisplayString |
OCTET STRING (SIZE (0..255)) |
Represents textual information taken from the Network Virtual Terminal (NVT) ASCII character set. For more detailed information, refer to RFC 854. To summarize RFC 854, the following issues are the NVT ASCII: • Use of character codes 0-127 (decimal). • The graphics characters (32-126) are interpreted as US ASCII. • NUL1 , LF2 , CR3 , BEL4 , BS5 , HT6 , VT7 , and FF8 are defined in RFC 854. • The other 25 codes have no standard interpretation. • The sequence CR LF means new line. • The sequence CR NUL means carriage-return. • The LF sequence not preceded by a CR means moving to the same column on the next line. • The sequence CR x for any x other than LF or NUL is illegal. This also means that a string may end with either CR LF or CR NUL but not with CR). Any object defined using this syntax may not exceed 255 characters in length. Display Hint: 255a Status: current |
none |
PhysAddress |
OCTET STRING |
Represents the media or physical-level addresses. Display Hint: 1x Status current |
none |
MacAddress |
OCTET STRING (SIZE (6)) |
Represents an 802 MAC address represented in the canonical order defined by IEEE 802.1a. For example, if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires MAC addresses to be transmitted most significant bit first. Display Hint: 1x Status: current |
none |
TruthValue |
INTEGER { true(1), false(2) } |
Represents a boolean value. Status: current |
none |
TestAndIncr |
INTEGER (0..2147483647) |
Represents integer-valued information used for atomic operations. When the management protocol is used to specify that an object instance having this syntax is modified, the new value supplied by means of the management protocol must precisely match the value presently held by the instance. If not, the management protocol Set operation fails with an error of inconsistentValue. Otherwise, if the current value is the maximum value of 2^31-1 (2147483647 decimal), the value held by the instance is wrapped to zero; otherwise, the value held by the instance is incremented by one. Note Regardless of whether the management protocol Set operation succeeds, the variable- binding in the request and response PDUs are identical. The value of the ACCESS clause for objects having this syntax is either read-write or read-create. When an instance of a columnar object having this syntax is created, any value can be supplied by means of the management protocol. When the network management portion of the system is reinitialized, the value of every object instance having this syntax must either be incremented from the value prior to the reinitialization, or (if the value prior to the reinitialization is unknown) be set to a pseudo-randomly generated value. Status: current |
none |
AutonomousType |
OBJECT IDENTIFIER |
Represents an independently extensible type identification value. The value indicates a particular sub-tree contains further MIB definitions, or defines a particular type of protocol or hardware. Status: current |
none |
VariablePointer |
OBJECT IDENTIFIER |
Represents a pointer to a specific object instance. For example, the instances can be either sysContact.0 or ifInOctets.3. Status: current |
none |
RowPointer |
OBJECT IDENTIFIER |
Represents a pointer to a conceptual row. The value is the name of the instance of the first accessible columnar object in the conceptual row. For example, ifIndex.3 can point to the third row in the ifTable. Note If the if ifIndex object is not-accessible, ifDescr.3 can be used instead. Status: current |
none |
RowStatus |
INTEGER { -- the following two values are states: -- these values may be read or written active(1), notInService(2),
-- the following value is a state: -- this value may be read, but not written notReady(3),
-- the following three values are -- actions: these values may be written, -- but are never read createAndGo(4), createAndWait(5), destroy(6)} |
Manages the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The following are the defined values for the status column: • active—Indicates that the conceptual row is available for use by the managed device; • notInService—Indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device. • notReady—Indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device. • createAndGo—Specifies this value is supplied by a management station to create a new instance of a conceptual row. The status is automatically set to active and is made available for use by the managed device. • createAndWait—Specifies this value is supplied by a management station to create a new instance of a conceptual row, and is not made available for use by the managed device. • destroy—Specifies this value is supplied by a management station to delete all of the instances associated with an existing conceptual row. Five of the six values except notReady can be specified in a management protocol Set operation. Only three values will be returned in response to a management protocol retrieval operation: notReady, notInService, or active. When queried, an existing conceptual row has the following three states: 1. The row is either available for use by the managed device. The status column contains the value active. 2. The row is not available for use by the managed device, though the agent has sufficient information to make it so the status column contains the value notInService. 3. The row is not available for use by the managed device, and an attempt to make it so will fail because the agent has insufficient information. The state column contains the value notReady. For more detailed information, refer to the SNMPv2-TC.my file. Status: current |
none |
TimeStamp |
TimeTicks |
Determines the value of the sysUpTime object which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. Status: current |
none |
TimeInterval |
INTEGER (0..2147483647) |
Specifies a period of time that is measured in units of 0.01 sec. Status: current |
none |
DateAndTime |
OCTET STRING (SIZE (8 | 11)) |
Specifies the date and time. For example, the following is displayed for Tuesday May 26, 1992 at 1:30:15 PM EDT:
1992-5-26,13:30:15.0,-4:0
Note If only the local time is known, the time zone information (fields 8 to 10) is not present. Display Hint: 2d-1d-1d,1d:1d:1d.1d,1a1d:1d Status: current The following are the date and time specifications: |
none |
|
Field
|
Octets
|
Contents
|
Range
|
1 |
1-2 |
year |
0..65536 |
2 |
3 |
month |
1..12 |
3 |
4 |
day |
1..31 |
4 |
5 |
hour |
0..23 |
5 |
6 |
minutes |
0..59 |
6 |
7 |
seconds (use 60 for leap-second) |
0..60 |
7 |
8 |
deci-seconds |
0..9 |
8 |
9 |
direction from UTC |
'+'/ '-' |
9 |
10 |
hours from UTC |
0..11 |
10 |
11 |
minutes from UTC |
0..59 |
StorageType |
INTEGER { other(1), -- eh? volatile(2), -- e.g., in RAM nonVolatile(3), -- e.g., in NVRAM permanent(4), -- e.g., partially in ROM readOnly(5) -- e.g., completely in ROM } |
Describes the memory realization of a conceptual row. A row is volatile(2) and is lost upon reboot. A row is nonVolatile(3), permanent(4), or readOnly(5) and is backed up by stable storage. A row is permanent(4) and is changed but not deleted. A row is readOnly(5) and is not changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be modified. Conversely, if the value is either other(1), volatile(2), or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). Every usage of this textual convention is required to specify the columnar objects that a permanent(4) row at a minimum must allow to be writable. Status: current |
none |
TDomain |
OBJECT IDENTIFIER |
Denotes a kind of transport service. Some possible values, such as snmpUDPDomain, are defined in the Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2). Status: current |
none |
TAddress |
OCTET STRING (SIZE (1..255)) |
Denotes a transport service address. For snmpUDPDomain, a TAddress is six octets long, the initial 4 octets containing the IP-address in network-byte order, and the last 2 containing the UDP port in network-byte order. For more detailed information on snmpUDPDomain, refer to Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2). Status: current |
none |
Cisco VSI Controller MIB Objects
This section describes the individual MIB objects used to configure an ATM switch to have Virtual Switch Interface (VSI) Controller information. The VSI Controller resides in the CISCO-VSI-CONTROLLER-MIB.my file.
The Cisco VSI controller MIB objects include:
•
Cisco VSI Controller Terminology
•
Cisco VSI Controller Textual Conventions
•
Cisco VSI Controller Configuration Table
•
Cisco VSI Controller Conformance and Compliance Information
Cisco VSI Controller Terminology
The terms used for the VSI Controller are listed in Table 4-49.
Table 4-49 Terms Used for the VSI Controller
|
Term
|
Description
|
VSI |
Describes the hardware-independent switch control protocol. This allows a switch, for example, a node, to be controlled by a multiple controllers such as PNNI and Label Switch Controller (LSC). These control planes are internal or external to the switch. The VSI interface defines the messages, and associated functions that allow communication between the controller and the switch. This interface is expected to support all types of connections, for example, voice, data, Frame Relay, and ATM, used for Permanent Virtual Circuit (PVC), Soft Permanent Virtual Connection (SPVC), and Switched Virtual Circuit (SVC). |
VSI Master |
Requests connections and receives switch-generic information for the software component, and controls one or more VSI Slaves. This can run on the switch or a dedicated controller platform, which is the master module. It performs the interface to the higher layer networking software and handles all VSI-related functions. |
VSI Slave |
Converts generic connection requests into hardware-specific requests, and hardware-specific information into generic information for the software component. VSI Slave runs on the switch. A centralized slave has a single point of control for making connections and controlling interfaces, while a distributed slave allows for multiple slaves to coexist on the same switch. |
Controller |
Describes the software and hardware that manages topology and network resources. It also performs the VSI Master function. The Controller performs source routing for end-to-end SVCs, which includes general call acceptance Generic Connection Admission Control (GCAC) and setup calls with other controllers. PNNI and Multiprotocol Label Switching (MPLS) are examples for the Controller. |
Controller Shelf |
Specifies a Controller Shelf that is a switch containing at least one VSI Controller, which is controlling a different switch. Also, it will contain local controllers. |
Cisco VSI Controller Textual Conventions
The names of the textual conventions are specified in the object syntax.
A list of the MIB objects is listed in Table 4-50.
Note
Textual conventions do not contain object identifiers.
Table 4-50 Cisco VSI Controller Textual Convention MIB Objects
|
Name
|
Description
|
Syntax
|
Default Value
|
CvcControllerShelfLocation |
Specifies the location of the controller shelf. The values include: • internal(1)—Specifies that the controller resides on the same shelf as the switch. • external(2)—Specifies that the controller resides on the external platform. The controller shelf is connected to the switch by an ATM link. Status: current |
INTEGER{internal(1), external(2)} |
none |
CvcControllerType |
Describes the type of controller that is a VSI Master. The values include: • par(1)—Portable Auto Route (PAR). This is a VSI Master controller that implements Cisco proprietary protocol for network routing and topology in a network, which contains only Cisco switches. • pnni(2)—Private Network-to-Network Interface (PNNI) controller. The PNNI protocol is used between private ATM Switches and between groups of ATM switches. This protocol is defined for distributing topology information between switches and clusters of switches. • lsc(3)—Label Switch Controller (LSC). The LSC implements the MPLS protocol. The LSC is a router which is capable of controlling the operation of a separate ATM switch, so that both of them function as a single ATM-LSR (ATM Label Switch Router). LSC controls the operation of the ATM switch using a Switch Control Protocol, which allows the LSC to setup and remove cross-connections on the ATM switch. It is used to discover the configuration and capabilities of the controlled switch, and to gather statistics from the controlled switch. Status: current |
INTEGER {par(1), pnni(2), lsc(3)} |
none |
Cisco VSI Controller Configuration Table
The object identifiers are listed in Table 4-51.
Table 4-51 VSI Controller Configuration Table Object Identifiers
|
Name
|
Object Identifier
|
cvcConfTable |
::= { cvcConfController 1 } |
cvcConfEntry |
::= { cvcConfTable 1 } |
cvcConfControllerID |
::= { cvcConfEntry 1} |
cvcConfControllerType |
::= { cvcConfEntry 2} |
cvcConfControllerShelfLocation |
::= { cvcConfEntry 3} |
cvcConfControllerLocation |
::= { cvcConfEntry 4} |
cvcConfControllerName |
::= { cvcConfEntry 5 } |
cvcConfVpi |
::= { cvcConfEntry 6 } |
cvcConfVci |
::= { cvcConfEntry 7 } |
cvcConfRowStatus |
::= { cvcConfEntry 8 } |
A list of the MIB objects is listed in Table 4-52.
Table 4-52 Cisco VSI Controller Configuration Table MIB Objects
|
Name
|
Syntax
|
Description
|
Default Value
|
cvcConfTable |
SEQUENCE OF CvcConfEntry |
Contains the entries for the VSI controllers. This table is used to inform the VSI slaves about the existence of the VSI controllers, and how the VSI slaves can reach the controller. When an entry is created and activated, the information in these entries is advertised to all the VSI slaves, using a system-dependent implementation. Max-Access: not-accessible Status: current |
none |
cvcConfEntry |
CvcConfEntry |
Provides an entry for a VSI Controller. The entries in this table are created by setting the cvcConfRowStatus object to createAndGo(4). The entries in this table are deleted by setting the cvcConfRowStatus object to destroy(6). The entries are created, modified, and deleted through the CLI. Max-Access: not-accessible Status: current The index is cvcConfControllerID. |
none |
cvcConfControllerID |
Integer32 (1..2147483647) |
Specifies the unique value for the VSI Controller, for example, VSI Master. The VSI Slave uses this value in the message to identify the VSI Master Controller. Max-Access: not-accessible Status: current |
none |
cvcConfController Type |
CvcControllerType |
Identifies the controller type. This object cannot be modified if the associated cvcConfRowStatus is equal to active(1). Max-Access: read-create Status: current |
none |
cvcConfController ShelfLocation |
CvcControllerShelfLocation |
Identifies the location of the controller shelf. This object is set only during row creation. Max-Access: read-create Status: current |
none |
cvcConfController Location |
Integer32 (1..2147483647) |
Identifies the location of the controller. The cvcConfControllerLocation object can contain the logical slot number of the module where the controller is running on the same shelf as the switch. This object can contain the value of the interface on the module where the controller is running on an external shelf connected to the switch. If the associated cvcConfRowStatus is equal to active(1), this object cannot be modified. Max-Access: read-create Status: current |
none |
cvcConfController Name |
DisplayString |
Specifies the name chosen by the user for the VSI Controller. If the user does not set the value for this object, it contains an octet string of length zero. cvcConfControllerName object cannot be modified if the associated cvcConfRowStatus is equal to active(1). Max-Access: read-create Status: current |
none |
cvcConfVpi |
Integer32 (0..4095) |
Specifies the VPI that is used for connecting to the controller, which is external to the switch. This object has significance only if cvcConfControllerShelfLocation is external(2). The cvcConfVpi object cannot be modified if the associated cvcConfRowStatus is equal to active(1). Max-Access: read-create Status: current |
none |
cvcConfVci |
Integer32 (32..65535) |
Specifies the start value of VCI that is used for connecting to the controller which is external to the switch. This object has significance only if cvcConfControllerShelfLocation is external(2). cvcConfVci object cannot be modified if the associated cvcConfRowStatus is equal to active(1). Max-Access: read-create Status: current |
none |
cvcConfRowStatus |
RowStatus |
Adds, deletes, and modifies the controller configuration. The row is created by setting this object to createAndGo(4). The row is deleted by setting this object to destroy(6). When this object contains value active(1), the objects in the row are not modified. Max-Access: read-create Status: current |
none |
Cisco VSI Controller Conformance and Compliance Information
The object identifiers are listed in Table 4-53 for conformance.
Table 4-53 Cisco VSI Controller Conformance Groups
|
Name
|
Object Identifier
|
cvcMIBConformance |
::= {ciscoVSIControllerMIB 3} |
cvcMIBCompliances |
::= {cvcMIBConformance 1} |
cvcMIBGroups |
::= {cvcMIBConformance 2} |
Cisco VSI Controller Compliance Statement
The compliance object identifier is listed in Table 4-54.
Table 4-54 Cisco VSI Controller Object Identifier
|
Name
|
Object Identifier
|
cvcConfGroupExternal |
::= {cvcMIBCompliances 1} |
The objects for compliance are listed in Table 4-55.
Table 4-55 Cisco VSI Controller Compliance Objects
|
Name
|
Groups
|
Description
|
Default Value
|
cvcMIBCompliance |
cvcConfGroup |
Describes the compliance statement for the Cisco VSI Controller group. Status: current |
none |
cvcConfGroupExternal |
none |
Specifies this group is required only for controllers running on a shelf external to the switch. |
none |
Cisco VSI Controller Units of Conformance
The object identifiers for Cisco VSI Controller units of conformance are listed in Table 4-56.
Table 4-56 Cisco VSI Controller Units of Conformance Object Identifiers
|
Name
|
Object Identifier
|
cvcConfGroup |
::= { cvcMIBGroups 1} |
cvcConfGroupExternal |
::= { cvcMIBGroups 2} |
The Cisco VSI Controller units of conformance objects are listed in Table 4-57.
Table 4-57 Cisco VSI Controller Objects Used for Units of Conformance
|
Name
|
Groups
|
Description
|
Default Value
|
cvcConfGroup |
cvcConfControllerType, cvcConfControllerShelfLocation, cvcConfControllerLocation, cvcConfControllerName, cvcConfRowStatus |
Configures the VSI controllers that run on the same shelf as the switch. Status: current |
none |
cvcConfGroupExternal |
cvcConfVpi, cvcConfVci |
Configures the VSI controllers that run on the shelf external to the switch. Status: current |
none |