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

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/