CHARACTER-MIB

File: CHARACTER-MIB.mib (21578 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC IF-MIB
RFC1213-MIB SNMPv2-CONF

Imported symbols

MODULE-IDENTITY OBJECT-TYPE NOTIFICATION-TYPE
Counter32 Integer32 Gauge32
TimeTicks AutonomousType InstancePointer
DisplayString InterfaceIndex transmission
mib-2 MODULE-COMPLIANCE OBJECT-GROUP

Defined Types

PortIndex  
A unique value, greater than zero, for each character port in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub- layer must remain constant at least from one re- initialization of the entity's network management system to the next re-initialization. In a system where the character ports are attached to hardware represented by an ifIndex, it is conventional, but not required, to make the character port index equal to the corresponding ifIndex.
TEXTUAL-CONVENTION    
  Integer32  

CharPortEntry  
SEQUENCE    
  charPortIndex PortIndex
  charPortName DisplayString
  charPortType INTEGER
  charPortHardware AutonomousType
  charPortReset INTEGER
  charPortAdminStatus INTEGER
  charPortOperStatus INTEGER
  charPortLastChange TimeTicks
  charPortInFlowType INTEGER
  charPortOutFlowType INTEGER
  charPortInFlowState INTEGER
  charPortOutFlowState INTEGER
  charPortInCharacters Counter32
  charPortOutCharacters Counter32
  charPortAdminOrigin INTEGER
  charPortSessionMaximum INTEGER
  charPortSessionNumber Gauge32
  charPortSessionIndex INTEGER
  charPortInFlowTypes OCTET STRING
  charPortOutFlowTypes OCTET STRING
  charPortLowerIfIndex InterfaceIndex

CharSessEntry  
SEQUENCE    
  charSessPortIndex PortIndex
  charSessIndex INTEGER
  charSessKill INTEGER
  charSessState INTEGER
  charSessProtocol AutonomousType
  charSessOperOrigin INTEGER
  charSessInCharacters Counter32
  charSessOutCharacters Counter32
  charSessConnectionId InstancePointer
  charSessStartTime TimeTicks

Defined Values

char 1.3.6.1.2.1.19
The MIB module for character stream devices.
MODULE-IDENTITY    

charNumber 1.3.6.1.2.1.19.1
The number of entries in charPortTable, regardless of their current state.
OBJECT-TYPE    
  Integer32  

charPortTable 1.3.6.1.2.1.19.2
A list of port entries. The number of entries is given by the value of charNumber.
OBJECT-TYPE    
  SEQUENCE OF  
    CharPortEntry

charPortEntry 1.3.6.1.2.1.19.2.1
Status and parameter values for a character port.
OBJECT-TYPE    
  CharPortEntry  

charPortIndex 1.3.6.1.2.1.19.2.1.1
A unique value for each character port, perhaps corresponding to the same value of ifIndex when the character port is associated with a hardware port represented by an ifIndex.
OBJECT-TYPE    
  PortIndex  

charPortName 1.3.6.1.2.1.19.2.1.2
An administratively assigned name for the port, typically with some local significance.
OBJECT-TYPE    
  DisplayString Size(0..32)  

charPortType 1.3.6.1.2.1.19.2.1.3
The port's type, 'physical' if the port represents an external hardware connector, 'virtual' if it does not.
OBJECT-TYPE    
  INTEGER physical(1), virtual(2)  

charPortHardware 1.3.6.1.2.1.19.2.1.4
A reference to hardware MIB definitions specific to a physical port's external connector. For example, if the connector is RS-232, then the value of this object refers to a MIB sub-tree defining objects specific to RS-232. If an agent is not configured to have such values, the agent returns the object identifier: nullHardware OBJECT IDENTIFIER ::= { 0 0 }
OBJECT-TYPE    
  AutonomousType  

charPortReset 1.3.6.1.2.1.19.2.1.5
A control to force the port into a clean, initial state, both hardware and software, disconnecting all the port's existing sessions. In response to a get-request or get-next-request, the agent always returns 'ready' as the value. Setting the value to 'execute' causes a reset.
OBJECT-TYPE    
  INTEGER ready(1), execute(2)  

charPortAdminStatus 1.3.6.1.2.1.19.2.1.6
The port's desired state, independent of flow control. 'enabled' indicates that the port is allowed to pass characters and form new sessions. 'disabled' indicates that the port is allowed to pass characters but not form new sessions. 'off' indicates that the port is not allowed to pass characters or have any sessions. 'maintenance' indicates a maintenance mode, exclusive of normal operation, such as running a test. 'enabled' corresponds to ifAdminStatus 'up'. 'disabled' and 'off' correspond to ifAdminStatus 'down'. 'maintenance' corresponds to ifAdminStatus 'test'.
OBJECT-TYPE    
  INTEGER enabled(1), disabled(2), off(3), maintenance(4)  

charPortOperStatus 1.3.6.1.2.1.19.2.1.7
The port's actual, operational state, independent of flow control. 'up' indicates able to function normally. 'down' indicates inability to function for administrative or operational reasons. 'maintenance' indicates a maintenance mode, exclusive of normal operation, such as running a test. 'absent' indicates that port hardware is not present. 'active' indicates up with a user present (e.g. logged in). 'up' and 'active' correspond to ifOperStatus 'up'. 'down' and 'absent' correspond to ifOperStatus 'down'. 'maintenance' corresponds to ifOperStatus 'test'.
OBJECT-TYPE    
  INTEGER up(1), down(2), maintenance(3), absent(4), active(5)  

charPortLastChange 1.3.6.1.2.1.19.2.1.8
The value of sysUpTime at the time the port entered its current operational state. If the current state was entered prior to the last reinitialization of the local network management subsystem, then this object contains a zero value.
OBJECT-TYPE    
  TimeTicks  

charPortInFlowType 1.3.6.1.2.1.19.2.1.9
The port's type of input flow control. 'none' indicates no flow control at this level or below. 'xonXoff' indicates software flow control by recognizing XON and XOFF characters. 'hardware' indicates flow control delegated to the lower level, for example a parallel port. 'ctsRts' and 'dsrDtr' are specific to RS-232-like ports. Although not architecturally pure, they are included here for simplicity's sake.
OBJECT-TYPE    
  INTEGER none(1), xonXoff(2), hardware(3), ctsRts(4), dsrDtr(5)  

charPortOutFlowType 1.3.6.1.2.1.19.2.1.10
The port's type of output flow control. 'none' indicates no flow control at this level or below. 'xonXoff' indicates software flow control by recognizing XON and XOFF characters. 'hardware' indicates flow control delegated to the lower level, for example a parallel port. 'ctsRts' and 'dsrDtr' are specific to RS-232-like ports. Although not architecturally pure, they are included here for simplicy's sake.
OBJECT-TYPE    
  INTEGER none(1), xonXoff(2), hardware(3), ctsRts(4), dsrDtr(5)  

charPortInFlowState 1.3.6.1.2.1.19.2.1.11
The current operational state of input flow control on the port. 'none' indicates not applicable. 'unknown' indicates this level does not know. 'stop' indicates flow not allowed. 'go' indicates flow allowed.
OBJECT-TYPE    
  INTEGER none(1), unknown(2), stop(3), go(4)  

charPortOutFlowState 1.3.6.1.2.1.19.2.1.12
The current operational state of output flow control on the port. 'none' indicates not applicable. 'unknown' indicates this level does not know. 'stop' indicates flow not allowed. 'go' indicates flow allowed.
OBJECT-TYPE    
  INTEGER none(1), unknown(2), stop(3), go(4)  

charPortInCharacters 1.3.6.1.2.1.19.2.1.13
Total number of characters detected as input from the port since system re-initialization and while the port operational state was 'up', 'active', or 'maintenance', including, for example, framing, flow control (i.e. XON and XOFF), each occurrence of a BREAK condition, locally-processed input, and input sent to all sessions.
OBJECT-TYPE    
  Counter32  

charPortOutCharacters 1.3.6.1.2.1.19.2.1.14
Total number of characters detected as output to the port since system re-initialization and while the port operational state was 'up', 'active', or 'maintenance', including, for example, framing, flow control (i.e. XON and XOFF), each occurrence of a BREAK condition, locally-created output, and output received from all sessions.
OBJECT-TYPE    
  Counter32  

charPortAdminOrigin 1.3.6.1.2.1.19.2.1.15
The administratively allowed origin for establishing session on the port. 'dynamic' allows 'network' or 'local' session establishment. 'none' disallows session establishment.
OBJECT-TYPE    
  INTEGER dynamic(1), network(2), local(3), none(4)  

charPortSessionMaximum 1.3.6.1.2.1.19.2.1.16
The maximum number of concurrent sessions allowed on the port. A value of -1 indicates no maximum. Setting the maximum to less than the current number of sessions has unspecified results.
OBJECT-TYPE    
  INTEGER -1..2147483647  

charPortSessionNumber 1.3.6.1.2.1.19.2.1.17
The number of open sessions on the port that are in the connecting, connected, or disconnecting state.
OBJECT-TYPE    
  Gauge32  

charPortSessionIndex 1.3.6.1.2.1.19.2.1.18
The value of charSessIndex for the port's first or only active session. If the port has no active session, the agent returns the value zero.
OBJECT-TYPE    
  INTEGER 0..2147483647  

charPortInFlowTypes 1.3.6.1.2.1.19.2.1.19
The port's types of input flow control at the software level. Hardware-level flow control is independently controlled by the appropriate hardware-level MIB. A value of zero indicates no flow control. Depending on the specific implementation, any or all combinations of flow control may be chosen by adding the values: 128 xonXoff, recognizing XON and XOFF characters 64 enqHost, ENQ/ACK to allow input to host 32 enqTerm, ACK to allow output to port
OBJECT-TYPE    
  OCTET STRING Size(1)  

charPortOutFlowTypes 1.3.6.1.2.1.19.2.1.20
The port's types of output flow control at the software level. Hardware-level flow control is independently controlled by the appropriate hardware-level MIB. A value of zero indicates no flow control. Depending on the specific implementation, any or all combinations of flow control may be chosen by adding the values: 128 xonXoff, recognizing XON and XOFF characters 64 enqHost, ENQ/ACK to allow input to host 32 enqTerm, ACK to allow output to port
OBJECT-TYPE    
  OCTET STRING Size(1)  

charPortLowerIfIndex 1.3.6.1.2.1.19.2.1.21
The ifIndex value of the lower level hardware supporting this character port, zero if none.
OBJECT-TYPE    
  InterfaceIndex  

charSessTable 1.3.6.1.2.1.19.3
A list of port session entries.
OBJECT-TYPE    
  SEQUENCE OF  
    CharSessEntry

charSessEntry 1.3.6.1.2.1.19.3.1
Status and parameter values for a character port session.
OBJECT-TYPE    
  CharSessEntry  

charSessPortIndex 1.3.6.1.2.1.19.3.1.1
The value of charPortIndex for the port to which this session belongs.
OBJECT-TYPE    
  PortIndex  

charSessIndex 1.3.6.1.2.1.19.3.1.2
The session index in the context of the port, a non-zero positive integer. Session indexes within a port need not be sequential. Session indexes may be reused for different ports. For example, port 1 and port 3 may both have a session 2 at the same time. Session indexes may have any valid integer value, with any meaning convenient to the agent implementation.
OBJECT-TYPE    
  INTEGER 1..2147483647  

charSessKill 1.3.6.1.2.1.19.3.1.3
A control to terminate the session. In response to a get-request or get-next-request, the agent always returns 'ready' as the value. Setting the value to 'execute' causes termination.
OBJECT-TYPE    
  INTEGER ready(1), execute(2)  

charSessState 1.3.6.1.2.1.19.3.1.4
The current operational state of the session, disregarding flow control. 'connected' indicates that character data could flow on the network side of session. 'connecting' indicates moving from nonexistent toward 'connected'. 'disconnecting' indicates moving from 'connected' or 'connecting' to nonexistent.
OBJECT-TYPE    
  INTEGER connecting(1), connected(2), disconnecting(3)  

charSessProtocol 1.3.6.1.2.1.19.3.1.5
The network protocol over which the session is running. Other OBJECT IDENTIFIER values may be defined elsewhere, in association with specific protocols. However, this document assigns those of known interest as of this writing.
OBJECT-TYPE    
  AutonomousType  

wellKnownProtocols 1.3.6.1.2.1.19.4
OBJECT IDENTIFIER    

protocolOther 1.3.6.1.2.1.19.4.1
OBJECT IDENTIFIER    

protocolTelnet 1.3.6.1.2.1.19.4.2
OBJECT IDENTIFIER    

protocolRlogin 1.3.6.1.2.1.19.4.3
OBJECT IDENTIFIER    

protocolLat 1.3.6.1.2.1.19.4.4
OBJECT IDENTIFIER    

protocolX29 1.3.6.1.2.1.19.4.5
OBJECT IDENTIFIER    

protocolVtp 1.3.6.1.2.1.19.4.6
OBJECT IDENTIFIER    

charSessOperOrigin 1.3.6.1.2.1.19.3.1.6
The session's source of establishment.
OBJECT-TYPE    
  INTEGER unknown(1), network(2), local(3)  

charSessInCharacters 1.3.6.1.2.1.19.3.1.7
This session's subset of charPortInCharacters.
OBJECT-TYPE    
  Counter32  

charSessOutCharacters 1.3.6.1.2.1.19.3.1.8
This session's subset of charPortOutCharacters.
OBJECT-TYPE    
  Counter32  

charSessConnectionId 1.3.6.1.2.1.19.3.1.9
A reference to additional local MIB information. This should be the highest available related MIB, corresponding to charSessProtocol, such as Telnet. For example, the value for a TCP connection (in the absence of a Telnet MIB) is the object identifier of tcpConnState. If an agent is not configured to have such values, the agent returns the object identifier: nullConnectionId OBJECT IDENTIFIER ::= { 0 0 }
OBJECT-TYPE    
  InstancePointer  

charSessStartTime 1.3.6.1.2.1.19.3.1.10
The value of sysUpTime in MIB-2 when the session entered connecting state.
OBJECT-TYPE    
  TimeTicks  

charConformance 1.3.6.1.2.1.19.5
OBJECT IDENTIFIER    

charGroups 1.3.6.1.2.1.19.5.1
OBJECT IDENTIFIER    

charCompliances 1.3.6.1.2.1.19.5.2
OBJECT IDENTIFIER    

charCompliance 1.3.6.1.2.1.19.5.2.1
The compliance statement for SNMPv2 entities which have Character hardware interfaces.
MODULE-COMPLIANCE    

charGroup 1.3.6.1.2.1.19.5.1.1
A collection of objects providing information applicable to all Character interfaces.
OBJECT-GROUP