As per Relevance of the word indicates, we have this rfc below:
Network Working Group B.
Request for Comments: 1658 Xyplex, Inc
Obsoletes: 1316 July 1994
Category: Standards
Definitions of Managed Objects for Character Stream
using SMIv
Status of this
This document specifies an Internet standards track protocol for
Internet community, and requests discussion and suggestions
improvements. Please refer to the current edition of the "
Official Protocol Standards" (STD 1) for the standardization
and status of this protocol. Distribution of this memo is unlimited
Table of
1. Introduction ................................................ 2
2. The SNMPv2 Network Management Framework ..................... 2
2.1 Object Definitions ......................................... 3
3. Overview .................................................... 3
3.1 Relationship to Interface MIB .............................. 4
4. Definitions ................................................. 4
5. Acknowledgements ............................................ 17
6. References .................................................. 17
7. Security Considerations ..................................... 18
8. Author's Address ............................................ 18
1.
This memo defines an extension to the Management Information
(MIB) for use with network management protocols in the
community. In particular, it defines objects for the management
character stream devices
2. The SNMPv2 Network Management
The SNMPv2 Network Management Framework consists of four
components. They are
o RFC 1442 [1] which defines the SMI, the mechanisms used
describing and naming objects for the purpose of management
o STD 17, RFC 1213 [2] defines MIB-II, the core set of
objects for the Internet suite of protocols
Stewart [Page 1]
RFC 1658 Character MIB July 1994
o RFC 1445 [3] which defines the administrative and
architectural aspects of the framework
o RFC 1448 [4] which defines the protocol used for
access to managed objects
The Framework permits new objects to be defined for the purpose
experimentation and evaluation
2.1. Object
Managed objects are accessed via a virtual information store,
the Management Information Base or MIB. Objects in the MIB
defined using the subset of Abstract Syntax Notation One (ASN.1)
defined in the SMI. In particular, each object object type is
by an OBJECT IDENTIFIER, an administratively assigned name.
object type together with an object instance serves to
identify a specific instantiation of the object. For
convenience, we often use a textual string, termed the descriptor,
refer to the object type
3.
The Character MIB applies to ports that carry a character stream
whether physical or virtual, serial or parallel, synchronous
asynchronous. The most common example of a character stream
is a hardware terminal port with an RS-232 interface. Another
hardware example is a parallel printer port, say with a
interface. The concept also includes virtual terminal ports, such
a software connection point for a remote console
The Character MIB is mandatory for all systems that offer
stream ports. This includes, for example, terminal servers
general-purpose time-sharing hosts, and even such systems as a
with a (virtual) console port. It may or may not include
ports that do not support network sessions, depending on the system'
needs
The Character MIB's central abstraction is a port. Physical
have a one-to-one correspondence with hardware ports. Virtual
are software entities analogous to physical ports, but with
hardware connector
Each port supports one or more sessions. A session represents
virtual connection that carries characters between the port and
partner. Sessions typically operate over a stack of
protocols. A typical session, for example, uses Telnet over TCP
Stewart [Page 2]
RFC 1658 Character MIB July 1994
The MIB comprises one base object and two tables, detailed in
following sections. The tables contain objects for ports
sessions
The MIB intentionally contains no distinction between what is
called permanent and operational or volatile data bases. For
purposes of this MIB, handling of such distinctions is
specific
3.1. Relationship to Interface
The Character MIB does not relate directly to the Interface MIB [1],
since it is not intrinsically a network interface. On the
hand, in most implementations where it is present, it will be above
physical sublayer interface, such as the RS-232-like [2]
Parallel-printer-like [3] MIBs. Such physical interfaces
are represented by a row in the interface table (ifTable),
by a value of ifIndex
4.
CHARACTER-MIB DEFINITIONS ::=
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE
Counter32, Integer32, Gauge32,
FROM SNMPv2-
AutonomousType,
FROM SNMPv2-
FROM IF-
transmission, mib-2
FROM RFC1213-
MODULE-COMPLIANCE, OBJECT-
FROM SNMPv2-CONF
char MODULE-
LAST-UPDATED "9405261700Z
ORGANIZATION "IETF Character MIB Working Group
CONTACT-
" Bob
Postal: Xyplex, Inc
295 Foster
Littleton, MA 01460
Tel: 508-952-4816
Fax: 508-952-4887
Stewart [Page 3]
RFC 1658 Character MIB July 1994
E-mail: rlstewart@eng.xyplex.com
"The MIB module for character stream devices."
::= { mib-2 19 }
PortIndex ::= TEXTUAL-
DISPLAY-HINT "d
STATUS
"A unique value, greater than zero, for
character port in the managed system. It
recommended that values are assigned
starting from 1. The value for each interface sub
layer must remain constant at least from one re
initialization of the entity's network
system to the next re-initialization
In a system where the character ports are
to hardware represented by an ifIndex, it
conventional, but not required, to make
character port index equal to the
ifIndex."
SYNTAX Integer32
-- Generic Character
charNumber OBJECT-
SYNTAX Integer32
MAX-ACCESS read-
STATUS
"The number of entries in charPortTable,
of their current state."
::= { char 1 }
-- the Character Port
charPortTable OBJECT-
SYNTAX SEQUENCE OF
MAX-ACCESS not-
STATUS
"A list of port entries. The number of entries
given by the value of charNumber."
::= { char 2 }
Stewart [Page 4]
RFC 1658 Character MIB July 1994
charPortEntry OBJECT-
SYNTAX
MAX-ACCESS not-
STATUS
"Status and parameter values for a character port."
INDEX { charPortIndex }
::= { charPortTable 1 }
CharPortEntry ::=
SEQUENCE {
PortIndex
DisplayString
INTEGER
AutonomousType
INTEGER
INTEGER
INTEGER
TimeTicks
INTEGER
INTEGER
INTEGER
INTEGER
Counter32,
Counter32,
INTEGER
INTEGER
Gauge32,
INTEGER
Stewart [Page 5]
RFC 1658 Character MIB July 1994
OCTET STRING
OCTET STRING
}
charPortIndex OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"A unique value for each character port,
corresponding to the same value of ifIndex when
character port is associated with a hardware
represented by an ifIndex."
::= { charPortEntry 1 }
charPortName OBJECT-
SYNTAX DisplayString (SIZE (0..32))
MAX-ACCESS read-
STATUS
"An administratively assigned name for the port
typically with some local significance."
::= { charPortEntry 2 }
charPortType OBJECT-
SYNTAX INTEGER { physical(1), virtual(2) }
MAX-ACCESS read-
STATUS
"The port's type, 'physical' if the port
an external hardware connector, 'virtual' if it
not."
::= { charPortEntry 3 }
charPortHardware OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"A reference to hardware MIB definitions specific
a physical port's external connector. For example
if the connector is RS-232, then the value of
object refers to a MIB sub-tree defining
specific to RS-232. If an agent is not
to have such values, the agent returns the
Stewart [Page 6]
RFC 1658 Character MIB July 1994
identifier
nullHardware OBJECT IDENTIFIER ::= { 0 0 }
"
::= { charPortEntry 4 }
charPortReset OBJECT-
SYNTAX INTEGER { ready(1), execute(2) }
MAX-ACCESS read-
STATUS
"A control to force the port into a clean,
state, both hardware and software, disconnecting
the port's existing sessions. In response to
get-request or get-next-request, the agent
returns 'ready' as the value. Setting the value
'execute' causes a reset."
::= { charPortEntry 5 }
charPortAdminStatus OBJECT-
SYNTAX INTEGER { enabled(1), disabled(2), off(3),
maintenance(4) }
MAX-ACCESS read-
STATUS
"The port's desired state, independent of
control. 'enabled' indicates that the port
allowed to pass characters and form new sessions
'disabled' indicates that the port is allowed
pass characters but not form new sessions. 'off
indicates that the port is not allowed to
characters or have any sessions. 'maintenance
indicates a maintenance mode, exclusive of
operation, such as running a test
'enabled' corresponds to ifAdminStatus 'up'.
'disabled' and 'off' correspond to
'down'. 'maintenance' corresponds to
'test'."
::= { charPortEntry 6 }
charPortOperStatus OBJECT-
SYNTAX INTEGER { up(1), down(2),
maintenance(3), absent(4), active(5) }
MAX-ACCESS read-
STATUS
"The port's actual, operational state,
Stewart [Page 7]
RFC 1658 Character MIB July 1994
of flow control. 'up' indicates able to
normally. 'down' indicates inability to
for administrative or operational reasons
'maintenance' indicates a maintenance mode
exclusive of normal operation, such as running
test. 'absent' indicates that port hardware is
present. 'active' indicates up with a user
(e.g. logged in).
'up' and 'active' correspond to ifOperStatus 'up'.
'down' and 'absent' correspond to
'down'. 'maintenance' corresponds to
'test'."
::= { charPortEntry 7 }
charPortLastChange OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"The value of sysUpTime at the time the port
its current operational state. If the current
was entered prior to the last reinitialization
the local network management subsystem, then
object contains a zero value."
::= { charPortEntry 8 }
-- charPortInFlowType is deprecated in favor
--
charPortInFlowType OBJECT-
SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
ctsRts(4), dsrDtr(5) }
MAX-ACCESS read-
STATUS
"The port's type of input flow control. 'none
indicates no flow control at this level or below
'xonXoff' indicates software flow control
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-
ports. Although not architecturally pure, they
included here for simplicity's sake."
::= { charPortEntry 9 }
Stewart [Page 8]
RFC 1658 Character MIB July 1994
-- charPortOutFlowType is deprecated in favor
--
charPortOutFlowType OBJECT-
SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
ctsRts(4), dsrDtr(5) }
MAX-ACCESS read-
STATUS
"The port's type of output flow control. 'none
indicates no flow control at this level or below
'xonXoff' indicates software flow control
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-
ports. Although not architecturally pure, they
included here for simplicy's sake."
::= { charPortEntry 10 }
charPortInFlowState OBJECT-
SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
MAX-ACCESS read-
STATUS
"The current operational state of input flow
on the port. 'none' indicates not applicable
'unknown' indicates this level does not know
'stop' indicates flow not allowed. 'go'
flow allowed."
::= { charPortEntry 11 }
charPortOutFlowState OBJECT-
SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
MAX-ACCESS read-
STATUS
"The current operational state of output
control on the port. 'none' indicates
applicable. 'unknown' indicates this level does
know. 'stop' indicates flow not allowed. 'go
indicates flow allowed."
::= { charPortEntry 12 }
charPortInCharacters OBJECT-
SYNTAX Counter32
MAX-ACCESS read-
Stewart [Page 9]
RFC 1658 Character MIB July 1994
STATUS
"Total number of characters detected as input
the port since system re-initialization and
the port operational state was 'up', 'active',
'maintenance', including, for example, framing,
control (i.e. XON and XOFF), each occurrence of
BREAK condition, locally-processed input, and
sent to all sessions."
::= { charPortEntry 13 }
charPortOutCharacters OBJECT-
SYNTAX Counter32
MAX-ACCESS read-
STATUS
"Total number of characters detected as output
the port since system re-initialization and
the port operational state was 'up', 'active',
'maintenance', including, for example, framing,
control (i.e. XON and XOFF), each occurrence of
BREAK condition, locally-created output, and
received from all sessions."
::= { charPortEntry 14 }
charPortAdminOrigin OBJECT-
SYNTAX INTEGER { dynamic(1), network(2), local(3),
none(4) }
MAX-ACCESS read-
STATUS
"The administratively allowed origin
establishing session on the port. 'dynamic'
'network' or 'local' session establishment. 'none
disallows session establishment."
::= { charPortEntry 15 }
charPortSessionMaximum OBJECT-
SYNTAX INTEGER (-1..2147483647)
MAX-ACCESS read-
STATUS
"The maximum number of concurrent sessions
on the port. A value of -1 indicates no maximum
Setting the maximum to less than the current
of sessions has unspecified results."
::= { charPortEntry 16 }
Stewart [Page 10]
RFC 1658 Character MIB July 1994
charPortSessionNumber OBJECT-
SYNTAX Gauge32
MAX-ACCESS read-
STATUS
"The number of open sessions on the port that are
the connecting, connected, or disconnecting state."
::= { charPortEntry 17 }
charPortSessionIndex OBJECT-
SYNTAX INTEGER (0..2147483647)
MAX-ACCESS read-
STATUS
"The value of charSessIndex for the port's first
only active session. If the port has no
session, the agent returns the value zero."
::= { charPortEntry 18 }
charPortInFlowTypes OBJECT-
SYNTAX OCTET STRING (SIZE (1))
MAX-ACCESS read-
STATUS
"The port's types of input flow control at
software level. Hardware-level flow control
independently controlled by the
hardware-level MIB
A value of zero indicates no flow control
Depending on the specific implementation, any
all combinations of flow control may be chosen
adding the values
128 xonXoff, recognizing XON and XOFF
64 enqHost, ENQ/ACK to allow input to
32 enqTerm, ACK to allow output to
"
::= { charPortEntry 19 }
charPortOutFlowTypes OBJECT-
SYNTAX OCTET STRING (SIZE (1))
MAX-ACCESS read-
STATUS
"The port's types of output flow control at
software level. Hardware-level flow control
independently controlled by the
Stewart [Page 11]
RFC 1658 Character MIB July 1994
hardware-level MIB
A value of zero indicates no flow control
Depending on the specific implementation, any
all combinations of flow control may be chosen
adding the values
128 xonXoff, recognizing XON and XOFF
64 enqHost, ENQ/ACK to allow input to
32 enqTerm, ACK to allow output to
"
::= { charPortEntry 20 }
charPortLowerIfIndex OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"The ifIndex value of the lower level hardware
this character port, zero if none."
::= { charPortEntry 21 }
-- the Character Session
charSessTable OBJECT-
SYNTAX SEQUENCE OF
MAX-ACCESS not-
STATUS
"A list of port session entries."
::= { char 3 }
charSessEntry OBJECT-
SYNTAX
MAX-ACCESS not-
STATUS
"Status and parameter values for a character
session."
INDEX { charSessPortIndex, charSessIndex }
::= { charSessTable 1 }
CharSessEntry ::=
SEQUENCE {
PortIndex
Stewart [Page 12]
RFC 1658 Character MIB July 1994
INTEGER
INTEGER
INTEGER
AutonomousType
INTEGER
Counter32,
Counter32,
InstancePointer
}
charSessPortIndex OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"The value of charPortIndex for the port to
this session belongs."
::= { charSessEntry 1 }
charSessIndex OBJECT-
SYNTAX INTEGER (1..2147483647)
MAX-ACCESS read-
STATUS
"The session index in the context of the port,
non-zero positive integer. Session indexes within
port need not be sequential. Session indexes may
reused for different ports. For example, port 1
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
implementation."
::= { charSessEntry 2 }
charSessKill OBJECT-
SYNTAX INTEGER { ready(1), execute(2) }
MAX-ACCESS read-
STATUS
Stewart [Page 13]
RFC 1658 Character MIB July 1994
"A control to terminate the session. In response
a get-request or get-next-request, the agent
returns 'ready' as the value. Setting the value
'execute' causes termination."
::= { charSessEntry 3 }
charSessState OBJECT-
SYNTAX INTEGER { connecting(1), connected(2),
disconnecting(3) }
MAX-ACCESS read-
STATUS
"The current operational state of the session
disregarding flow control. 'connected'
that character data could flow on the network
of session. 'connecting' indicates moving
nonexistent toward 'connected'. 'disconnecting
indicates moving from 'connected' or 'connecting'
nonexistent."
::= { charSessEntry 4 }
charSessProtocol OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"The network protocol over which the session
running. Other OBJECT IDENTIFIER values may
defined elsewhere, in association with
protocols. However, this document assigns those
known interest as of this writing."
::= { charSessEntry 5 }
wellKnownProtocols OBJECT IDENTIFIER ::= { char 4 }
protocolOther OBJECT IDENTIFIER ::= { wellKnownProtocols 1 }
protocolTelnet OBJECT IDENTIFIER ::= { wellKnownProtocols 2 }
protocolRlogin OBJECT IDENTIFIER ::= { wellKnownProtocols 3 }
protocolLat OBJECT IDENTIFIER ::= { wellKnownProtocols 4 }
protocolX29 OBJECT IDENTIFIER ::= { wellKnownProtocols 5 }
protocolVtp OBJECT IDENTIFIER ::= { wellKnownProtocols 6 }
charSessOperOrigin OBJECT-
SYNTAX INTEGER { unknown(1), network(2), local(3) }
MAX-ACCESS read-
STATUS
Stewart [Page 14]
RFC 1658 Character MIB July 1994
"The session's source of establishment."
::= { charSessEntry 6 }
charSessInCharacters OBJECT-
SYNTAX Counter32
MAX-ACCESS read-
STATUS
"This session's subset of charPortInCharacters."
::= { charSessEntry 7 }
charSessOutCharacters OBJECT-
SYNTAX Counter32
MAX-ACCESS read-
STATUS
"This session's subset of charPortOutCharacters."
::= { charSessEntry 8 }
charSessConnectionId OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"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
absence of a Telnet MIB) is the object identifier
tcpConnState. If an agent is not configured to
such values, the agent returns the
identifier
nullConnectionId OBJECT IDENTIFIER ::= { 0 0 }
"
::= { charSessEntry 9 }
charSessStartTime OBJECT-
SYNTAX
MAX-ACCESS read-
STATUS
"The value of sysUpTime in MIB-2 when the
entered connecting state."
::= { charSessEntry 10 }
Stewart [Page 15]
RFC 1658 Character MIB July 1994
-- conformance
charConformance OBJECT IDENTIFIER ::= { char 5 }
charGroups OBJECT IDENTIFIER ::= { charConformance 1 }
charCompliances OBJECT IDENTIFIER ::= { charConformance 2 }
-- compliance
charCompliance MODULE-
STATUS
"The compliance statement for SNMPv2
which have Character hardware interfaces."
MODULE -- this
MANDATORY-GROUPS { charGroup }
::= { charCompliances 1 }
-- units of
charGroup OBJECT-
OBJECTS { charNumber, charPortIndex, charPortName
charPortType, charPortHardware, charPortReset
charPortAdminStatus, charPortOperStatus
charPortLastChange
charPortInFlowState, charPortOutFlowState
charPortAdminOrigin, charPortSessionMaximum
charPortInFlowTypes, charPortOutFlowTypes
charPortInCharacters, charPortOutCharacters
charPortSessionNumber, charPortSessionIndex
charPortLowerIfIndex
charSessPortIndex, charSessIndex
charSessKill, charSessState
charSessProtocol, charSessOperOrigin
charSessInCharacters, charSessOutCharacters
charSessConnectionId, charSessStartTime }
STATUS
"A collection of objects providing
applicable to all Character interfaces."
::= { charGroups 1 }
Stewart [Page 16]
RFC 1658 Character MIB July 1994
5.
This memo was produced by the IETF Character MIB Working Group
6.
[1] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "
of Management Information for version 2 of the Simple
Management Protocol (SNMPv2)", RFC 1442, SNMP Research,Inc.,
Hughes LAN Systems, Dover Beach Consulting, Inc., Carnegie
University, April 1993.
[2] McCloghrie, K., and M. Rose, Editors, "Management
Base for Network Management of TCP/IP-based internets: MIB-II",
STD 17, RFC 1213, Hughes LAN Systems, Performance
International, March 1991.
[3] Galvin, J., and K. McCloghrie, "Administrative Model for
2 of the Simple Network Management Protocol (SNMPv2)", RFC 1445,
Trusted Information Systems, Hughes LAN Systems, April 1993.
[4] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "
Operations for version 2 of the Simple Network
Protocol (SNMPv2)", RFC 1448, SNMP Research,Inc., Hughes
Systems, Dover Beach Consulting, Inc., Carnegie
University, April 1993.
[5] McCloghrie, K., and F. Kastenholz, "Evolution of the
Group of MIB-II", RFC 1573, Hughes LAN Systems, FTP Software
January 1994.
[6] Stewart, B., "Definitions of Managed Objects for RS-232-
Hardware Devices using SMIv2", RFC 1659, Xyplex, Inc., July 1994.
[7] Stewart, B., "Definitions of Managed Objects for Parallel
printer-like Hardware Devices using SMIv2", RFC 1660, Xyplex
Inc., July 1994.
Stewart [Page 17]
RFC 1658 Character MIB July 1994
7. Security
Security issues are not discussed in this memo
8. Author's
Bob
Xyplex, Inc
295 Foster
Littleton, MA 01460
Phone: 508-952-4816
Fax: 508-952-4887
EMail: rlstewart@eng.xyplex.
Stewart [Page 18]
if you see any problems within the linking, don't worry be happy,
this is version 0.1 of the Relevance System and you gotta expect some crappy subroutines sometimes,
just be content we did not write this in Java, which would have made this "bigger and better" HAHAHHA.
RFC documents can be found at I.E.T.F.
Relevance System Copyright © 2002 Spectrum WorldResearch
other technical nosh by ServerMasters Corporation
collaboration of BobX
