home *** CD-ROM | disk | FTP | other *** search
/ Unix System Administration Handbook 1997 October / usah_oct97.iso / rfc / 1600s / rfc1658.txt < prev    next >
Text File  |  1994-07-18  |  33KB  |  1,012 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                         B. Stewart
  8. Request for Comments: 1658                                  Xyplex, Inc.
  9. Obsoletes: 1316                                                July 1994
  10. Category: Standards Track
  11.  
  12.  
  13.       Definitions of Managed Objects for Character Stream Devices
  14.                               using SMIv2
  15.  
  16. Status of this Memo
  17.  
  18.    This document specifies an Internet standards track protocol for the
  19.    Internet community, and requests discussion and suggestions for
  20.    improvements.  Please refer to the current edition of the "Internet
  21.    Official Protocol Standards" (STD 1) for the standardization state
  22.    and status of this protocol.  Distribution of this memo is unlimited.
  23.  
  24. Table of Contents
  25.  
  26.    1. Introduction ................................................    2
  27.    2. The SNMPv2 Network Management Framework .....................    2
  28.    2.1 Object Definitions .........................................    3
  29.    3. Overview ....................................................    3
  30.    3.1 Relationship to Interface MIB ..............................    4
  31.    4. Definitions .................................................    4
  32.    5. Acknowledgements ............................................   17
  33.    6. References ..................................................   17
  34.    7. Security Considerations .....................................   18
  35.    8. Author's Address ............................................   18
  36.  
  37. 1.  Introduction
  38.  
  39.    This memo defines an extension to the Management Information Base
  40.    (MIB) for use with network management protocols in the Internet
  41.    community.  In particular, it defines objects for the management of
  42.    character stream devices.
  43.  
  44. 2.  The SNMPv2 Network Management Framework
  45.  
  46.    The SNMPv2 Network Management Framework consists of four major
  47.    components.  They are:
  48.  
  49.       o    RFC 1442 [1] which defines the SMI, the mechanisms used for
  50.            describing and naming objects for the purpose of management.
  51.  
  52.       o    STD 17, RFC 1213 [2] defines MIB-II, the core set of managed
  53.            objects for the Internet suite of protocols.
  54.  
  55.  
  56.  
  57.  
  58. Stewart                                                         [Page 1]
  59.  
  60. RFC 1658                     Character MIB                     July 1994
  61.  
  62.  
  63.       o    RFC 1445 [3] which defines the administrative and other
  64.            architectural aspects of the framework.
  65.  
  66.       o    RFC 1448 [4] which defines the protocol used for network
  67.            access to managed objects.
  68.  
  69.    The Framework permits new objects to be defined for the purpose of
  70.    experimentation and evaluation.
  71.  
  72. 2.1.  Object Definitions
  73.  
  74.    Managed objects are accessed via a virtual information store, termed
  75.    the Management Information Base or MIB.  Objects in the MIB are
  76.    defined using the subset of Abstract Syntax Notation One (ASN.1)
  77.    defined in the SMI.  In particular, each object object type is named
  78.    by an OBJECT IDENTIFIER, an administratively assigned name.  The
  79.    object type together with an object instance serves to uniquely
  80.    identify a specific instantiation of the object.  For human
  81.    convenience, we often use a textual string, termed the descriptor, to
  82.    refer to the object type.
  83.  
  84. 3.  Overview
  85.  
  86.    The Character MIB applies to ports that carry a character stream,
  87.    whether physical or virtual, serial or parallel, synchronous or
  88.    asynchronous.  The most common example of a character stream device
  89.    is a hardware terminal port with an RS-232 interface.  Another common
  90.    hardware example is a parallel printer port, say with a Centronics
  91.    interface.  The concept also includes virtual terminal ports, such as
  92.    a software connection point for a remote console.
  93.  
  94.    The Character MIB is mandatory for all systems that offer character
  95.    stream ports.  This includes, for example, terminal servers,
  96.    general-purpose time-sharing hosts, and even such systems as a bridge
  97.    with a (virtual) console port.  It may or may not include character
  98.    ports that do not support network sessions, depending on the system's
  99.    needs.
  100.  
  101.    The Character MIB's central abstraction is a port.  Physical ports
  102.    have a one-to-one correspondence with hardware ports. Virtual ports
  103.    are software entities analogous to physical ports, but with no
  104.    hardware connector.
  105.  
  106.    Each port supports one or more sessions.  A session represents a
  107.    virtual connection that carries characters between the port and some
  108.    partner.  Sessions typically operate over a stack of network
  109.    protocols.  A typical session, for example, uses Telnet over TCP.
  110.  
  111.  
  112.  
  113.  
  114. Stewart                                                         [Page 2]
  115.  
  116. RFC 1658                     Character MIB                     July 1994
  117.  
  118.  
  119.    The MIB comprises one base object and two tables, detailed in the
  120.    following sections.  The tables contain objects for ports and
  121.    sessions.
  122.  
  123.    The MIB intentionally contains no distinction between what is often
  124.    called permanent and operational or volatile data bases.  For the
  125.    purposes of this MIB, handling of such distinctions is implementation
  126.    specific.
  127.  
  128. 3.1.  Relationship to Interface MIB
  129.  
  130.    The Character MIB does not relate directly to the Interface MIB [1],
  131.    since it is not intrinsically a network interface.  On the other
  132.    hand, in most implementations where it is present, it will be above a
  133.    physical sublayer interface, such as the RS-232-like [2] or
  134.    Parallel-printer-like [3] MIBs.  Such physical interfaces typically
  135.    are represented by a row in the interface table (ifTable), identified
  136.    by a value of ifIndex.
  137.  
  138. 4.  Definitions
  139.  
  140.    CHARACTER-MIB DEFINITIONS ::= BEGIN
  141.  
  142.    IMPORTS
  143.        MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
  144.        Counter32, Integer32, Gauge32, TimeTicks
  145.            FROM SNMPv2-SMI
  146.        AutonomousType, InstancePointer
  147.            FROM SNMPv2-TC
  148.        InterfaceIndex
  149.            FROM IF-MIB
  150.        transmission, mib-2
  151.            FROM RFC1213-MIB
  152.        MODULE-COMPLIANCE, OBJECT-GROUP
  153.            FROM SNMPv2-CONF;
  154.  
  155.  
  156.    char MODULE-IDENTITY
  157.        LAST-UPDATED "9405261700Z"
  158.        ORGANIZATION "IETF Character MIB Working Group"
  159.        CONTACT-INFO
  160.                "        Bob Stewart
  161.                 Postal: Xyplex, Inc.
  162.                         295 Foster Street
  163.                         Littleton, MA 01460
  164.  
  165.                    Tel: 508-952-4816
  166.                    Fax: 508-952-4887
  167.  
  168.  
  169.  
  170. Stewart                                                         [Page 3]
  171.  
  172. RFC 1658                     Character MIB                     July 1994
  173.  
  174.  
  175.                 E-mail: rlstewart@eng.xyplex.com"
  176.        DESCRIPTION
  177.                "The MIB module for character stream devices."
  178.        ::= { mib-2 19 }
  179.  
  180.    PortIndex ::= TEXTUAL-CONVENTION
  181.        DISPLAY-HINT "d"
  182.        STATUS current
  183.        DESCRIPTION
  184.                "A unique value, greater than zero, for each
  185.                character port in the managed system.  It is
  186.                recommended that values are assigned contiguously
  187.                starting from 1.  The value for each interface sub-
  188.                layer must remain constant at least from one re-
  189.                initialization of the entity's network management
  190.                system to the next re-initialization.
  191.  
  192.                In a system where the character ports are attached
  193.                to hardware represented by an ifIndex, it is
  194.                conventional, but not required, to make the
  195.                character port index equal to the corresponding
  196.                ifIndex."
  197.        SYNTAX Integer32
  198.  
  199.  
  200.    -- Generic Character information
  201.  
  202.    charNumber OBJECT-TYPE
  203.        SYNTAX Integer32
  204.        MAX-ACCESS read-only
  205.        STATUS current
  206.        DESCRIPTION
  207.            "The number of entries in charPortTable, regardless
  208.            of their current state."
  209.        ::= { char 1 }
  210.  
  211.  
  212.    -- the Character Port table
  213.  
  214.    charPortTable OBJECT-TYPE
  215.        SYNTAX SEQUENCE OF CharPortEntry
  216.        MAX-ACCESS not-accessible
  217.        STATUS current
  218.        DESCRIPTION
  219.            "A list of port entries.  The number of entries is
  220.            given by the value of charNumber."
  221.        ::= { char 2 }
  222.  
  223.  
  224.  
  225.  
  226. Stewart                                                         [Page 4]
  227.  
  228. RFC 1658                     Character MIB                     July 1994
  229.  
  230.  
  231.    charPortEntry OBJECT-TYPE
  232.        SYNTAX CharPortEntry
  233.        MAX-ACCESS not-accessible
  234.        STATUS current
  235.        DESCRIPTION
  236.            "Status and parameter values for a character port."
  237.        INDEX { charPortIndex }
  238.        ::= { charPortTable 1 }
  239.  
  240.    CharPortEntry ::=
  241.        SEQUENCE {
  242.            charPortIndex
  243.                PortIndex,
  244.            charPortName
  245.                DisplayString,
  246.            charPortType
  247.                INTEGER,
  248.            charPortHardware
  249.                AutonomousType,
  250.            charPortReset
  251.                INTEGER,
  252.            charPortAdminStatus
  253.                INTEGER,
  254.            charPortOperStatus
  255.                INTEGER,
  256.            charPortLastChange
  257.                TimeTicks,
  258.            charPortInFlowType
  259.                INTEGER,
  260.            charPortOutFlowType
  261.                INTEGER,
  262.            charPortInFlowState
  263.                INTEGER,
  264.            charPortOutFlowState
  265.                INTEGER,
  266.            charPortInCharacters
  267.                Counter32,
  268.            charPortOutCharacters
  269.                Counter32,
  270.            charPortAdminOrigin
  271.                INTEGER,
  272.            charPortSessionMaximum
  273.                INTEGER,
  274.            charPortSessionNumber
  275.                Gauge32,
  276.            charPortSessionIndex
  277.                INTEGER,
  278.            charPortInFlowTypes
  279.  
  280.  
  281.  
  282. Stewart                                                         [Page 5]
  283.  
  284. RFC 1658                     Character MIB                     July 1994
  285.  
  286.  
  287.                OCTET STRING,
  288.            charPortOutFlowTypes
  289.                OCTET STRING,
  290.            charPortLowerIfIndex
  291.                InterfaceIndex
  292.        }
  293.  
  294.    charPortIndex OBJECT-TYPE
  295.        SYNTAX PortIndex
  296.        MAX-ACCESS read-only
  297.        STATUS current
  298.        DESCRIPTION
  299.            "A unique value for each character port, perhaps
  300.            corresponding to the same value of ifIndex when the
  301.            character port is associated with a hardware port
  302.            represented by an ifIndex."
  303.        ::= { charPortEntry 1 }
  304.  
  305.    charPortName OBJECT-TYPE
  306.        SYNTAX DisplayString (SIZE (0..32))
  307.        MAX-ACCESS read-write
  308.        STATUS current
  309.        DESCRIPTION
  310.            "An administratively assigned name for the port,
  311.            typically with some local significance."
  312.        ::= { charPortEntry 2 }
  313.  
  314.    charPortType OBJECT-TYPE
  315.        SYNTAX INTEGER { physical(1), virtual(2) }
  316.        MAX-ACCESS read-only
  317.        STATUS current
  318.        DESCRIPTION
  319.            "The port's type, 'physical' if the port represents
  320.            an external hardware connector, 'virtual' if it does
  321.            not."
  322.        ::= { charPortEntry 3 }
  323.  
  324.    charPortHardware OBJECT-TYPE
  325.        SYNTAX AutonomousType
  326.        MAX-ACCESS read-only
  327.        STATUS current
  328.        DESCRIPTION
  329.            "A reference to hardware MIB definitions specific to
  330.            a physical port's external connector.  For example,
  331.            if the connector is RS-232, then the value of this
  332.            object refers to a MIB sub-tree defining objects
  333.            specific to RS-232.  If an agent is not configured
  334.            to have such values, the agent returns the object
  335.  
  336.  
  337.  
  338. Stewart                                                         [Page 6]
  339.  
  340. RFC 1658                     Character MIB                     July 1994
  341.  
  342.  
  343.            identifier:
  344.  
  345.                nullHardware OBJECT IDENTIFIER ::= { 0 0 }
  346.            "
  347.        ::= { charPortEntry 4 }
  348.  
  349.    charPortReset OBJECT-TYPE
  350.        SYNTAX INTEGER { ready(1), execute(2) }
  351.        MAX-ACCESS read-write
  352.        STATUS current
  353.        DESCRIPTION
  354.            "A control to force the port into a clean, initial
  355.            state, both hardware and software, disconnecting all
  356.            the port's existing sessions.  In response to a
  357.            get-request or get-next-request, the agent always
  358.            returns 'ready' as the value.  Setting the value to
  359.            'execute' causes a reset."
  360.        ::= { charPortEntry 5 }
  361.  
  362.    charPortAdminStatus OBJECT-TYPE
  363.        SYNTAX INTEGER { enabled(1), disabled(2), off(3),
  364.                         maintenance(4) }
  365.        MAX-ACCESS read-write
  366.        STATUS current
  367.        DESCRIPTION
  368.            "The port's desired state, independent of flow
  369.            control.  'enabled' indicates that the port is
  370.            allowed to pass characters and form new sessions.
  371.            'disabled' indicates that the port is allowed to
  372.            pass characters but not form new sessions.  'off'
  373.            indicates that the port is not allowed to pass
  374.            characters or have any sessions. 'maintenance'
  375.            indicates a maintenance mode, exclusive of normal
  376.            operation, such as running a test.
  377.  
  378.            'enabled' corresponds to ifAdminStatus 'up'.
  379.            'disabled' and 'off' correspond to ifAdminStatus
  380.            'down'.  'maintenance' corresponds to ifAdminStatus
  381.            'test'."
  382.        ::= { charPortEntry 6 }
  383.  
  384.    charPortOperStatus OBJECT-TYPE
  385.        SYNTAX INTEGER { up(1), down(2),
  386.                         maintenance(3), absent(4), active(5) }
  387.        MAX-ACCESS read-only
  388.        STATUS current
  389.        DESCRIPTION
  390.            "The port's actual, operational state, independent
  391.  
  392.  
  393.  
  394. Stewart                                                         [Page 7]
  395.  
  396. RFC 1658                     Character MIB                     July 1994
  397.  
  398.  
  399.            of flow control.  'up' indicates able to function
  400.            normally.  'down' indicates inability to function
  401.            for administrative or operational reasons.
  402.            'maintenance' indicates a maintenance mode,
  403.            exclusive of normal operation, such as running a
  404.            test.  'absent' indicates that port hardware is not
  405.            present.  'active' indicates up with a user present
  406.            (e.g. logged in).
  407.  
  408.            'up' and 'active' correspond to ifOperStatus 'up'.
  409.            'down' and 'absent' correspond to ifOperStatus
  410.            'down'.  'maintenance' corresponds to ifOperStatus
  411.            'test'."
  412.        ::= { charPortEntry 7 }
  413.  
  414.    charPortLastChange OBJECT-TYPE
  415.        SYNTAX TimeTicks
  416.        MAX-ACCESS read-only
  417.        STATUS current
  418.        DESCRIPTION
  419.            "The value of sysUpTime at the time the port entered
  420.            its current operational state.  If the current state
  421.            was entered prior to the last reinitialization of
  422.            the local network management subsystem, then this
  423.            object contains a zero value."
  424.        ::= { charPortEntry 8 }
  425.  
  426.    -- charPortInFlowType is deprecated in favor of
  427.    -- charPortInFlowTypes
  428.  
  429.    charPortInFlowType OBJECT-TYPE
  430.        SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
  431.                         ctsRts(4), dsrDtr(5) }
  432.        MAX-ACCESS read-write
  433.        STATUS deprecated
  434.        DESCRIPTION
  435.            "The port's type of input flow control.  'none'
  436.            indicates no flow control at this level or below.
  437.            'xonXoff' indicates software flow control by
  438.            recognizing XON and XOFF characters.  'hardware'
  439.            indicates flow control delegated to the lower level,
  440.            for example a parallel port.
  441.  
  442.            'ctsRts' and 'dsrDtr' are specific to RS-232-like
  443.            ports.  Although not architecturally pure, they are
  444.            included here for simplicity's sake."
  445.        ::= { charPortEntry 9 }
  446.  
  447.  
  448.  
  449.  
  450. Stewart                                                         [Page 8]
  451.  
  452. RFC 1658                     Character MIB                     July 1994
  453.  
  454.  
  455.    -- charPortOutFlowType is deprecated in favor of
  456.    -- charPortOutFlowTypes
  457.  
  458.    charPortOutFlowType OBJECT-TYPE
  459.        SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
  460.                         ctsRts(4), dsrDtr(5) }
  461.        MAX-ACCESS read-write
  462.        STATUS deprecated
  463.        DESCRIPTION
  464.            "The port's type of output flow control.  'none'
  465.            indicates no flow control at this level or below.
  466.            'xonXoff' indicates software flow control by
  467.            recognizing XON and XOFF characters.  'hardware'
  468.            indicates flow control delegated to the lower level,
  469.            for example a parallel port.
  470.  
  471.            'ctsRts' and 'dsrDtr' are specific to RS-232-like
  472.            ports.  Although not architecturally pure, they are
  473.            included here for simplicy's sake."
  474.        ::= { charPortEntry 10 }
  475.  
  476.    charPortInFlowState OBJECT-TYPE
  477.        SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
  478.        MAX-ACCESS read-only
  479.        STATUS current
  480.        DESCRIPTION
  481.            "The current operational state of input flow control
  482.            on the port.  'none' indicates not applicable.
  483.            'unknown' indicates this level does not know.
  484.            'stop' indicates flow not allowed.  'go' indicates
  485.            flow allowed."
  486.        ::= { charPortEntry 11 }
  487.  
  488.    charPortOutFlowState OBJECT-TYPE
  489.        SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
  490.        MAX-ACCESS read-only
  491.        STATUS current
  492.        DESCRIPTION
  493.            "The current operational state of output flow
  494.            control on the port.  'none' indicates not
  495.            applicable.  'unknown' indicates this level does not
  496.            know.  'stop' indicates flow not allowed.  'go'
  497.            indicates flow allowed."
  498.        ::= { charPortEntry 12 }
  499.  
  500.    charPortInCharacters OBJECT-TYPE
  501.        SYNTAX Counter32
  502.        MAX-ACCESS read-only
  503.  
  504.  
  505.  
  506. Stewart                                                         [Page 9]
  507.  
  508. RFC 1658                     Character MIB                     July 1994
  509.  
  510.  
  511.        STATUS current
  512.        DESCRIPTION
  513.            "Total number of characters detected as input from
  514.            the port since system re-initialization and while
  515.            the port operational state was 'up', 'active', or
  516.            'maintenance', including, for example, framing, flow
  517.            control (i.e. XON and XOFF), each occurrence of a
  518.            BREAK condition, locally-processed input, and input
  519.            sent to all sessions."
  520.        ::= { charPortEntry 13 }
  521.  
  522.    charPortOutCharacters OBJECT-TYPE
  523.        SYNTAX Counter32
  524.        MAX-ACCESS read-only
  525.        STATUS current
  526.        DESCRIPTION
  527.            "Total number of characters detected as output to
  528.            the port since system re-initialization and while
  529.            the port operational state was 'up', 'active', or
  530.            'maintenance', including, for example, framing, flow
  531.            control (i.e. XON and XOFF), each occurrence of a
  532.            BREAK condition, locally-created output, and output
  533.            received from all sessions."
  534.        ::= { charPortEntry 14 }
  535.  
  536.    charPortAdminOrigin OBJECT-TYPE
  537.        SYNTAX INTEGER { dynamic(1), network(2), local(3),
  538.                         none(4) }
  539.        MAX-ACCESS read-write
  540.        STATUS current
  541.        DESCRIPTION
  542.            "The administratively allowed origin for
  543.            establishing session on the port.  'dynamic' allows
  544.            'network' or 'local' session establishment. 'none'
  545.            disallows session establishment."
  546.        ::= { charPortEntry 15 }
  547.  
  548.    charPortSessionMaximum OBJECT-TYPE
  549.        SYNTAX INTEGER (-1..2147483647)
  550.        MAX-ACCESS read-write
  551.        STATUS current
  552.        DESCRIPTION
  553.            "The maximum number of concurrent sessions allowed
  554.            on the port.  A value of -1 indicates no maximum.
  555.            Setting the maximum to less than the current number
  556.            of sessions has unspecified results."
  557.        ::= { charPortEntry 16 }
  558.  
  559.  
  560.  
  561.  
  562. Stewart                                                        [Page 10]
  563.  
  564. RFC 1658                     Character MIB                     July 1994
  565.  
  566.  
  567.    charPortSessionNumber OBJECT-TYPE
  568.        SYNTAX Gauge32
  569.        MAX-ACCESS read-only
  570.        STATUS current
  571.        DESCRIPTION
  572.            "The number of open sessions on the port that are in
  573.            the connecting, connected, or disconnecting state."
  574.        ::= { charPortEntry 17 }
  575.  
  576.    charPortSessionIndex OBJECT-TYPE
  577.        SYNTAX INTEGER (0..2147483647)
  578.        MAX-ACCESS read-only
  579.        STATUS current
  580.        DESCRIPTION
  581.            "The value of charSessIndex for the port's first or
  582.            only active session.  If the port has no active
  583.            session, the agent returns the value zero."
  584.        ::= { charPortEntry 18 }
  585.  
  586.    charPortInFlowTypes OBJECT-TYPE
  587.        SYNTAX OCTET STRING (SIZE (1))
  588.        MAX-ACCESS read-write
  589.        STATUS current
  590.        DESCRIPTION
  591.            "The port's types of input flow control at the
  592.            software level.  Hardware-level flow control is
  593.            independently controlled by the appropriate
  594.            hardware-level MIB.
  595.  
  596.            A value of zero indicates no flow control.
  597.            Depending on the specific implementation, any or
  598.            all combinations of flow control may be chosen by
  599.            adding the values:
  600.  
  601.            128  xonXoff, recognizing XON and XOFF characters
  602.            64   enqHost, ENQ/ACK to allow input to host
  603.            32   enqTerm, ACK to allow output to port
  604.            "
  605.        ::= { charPortEntry 19 }
  606.  
  607.    charPortOutFlowTypes OBJECT-TYPE
  608.        SYNTAX OCTET STRING (SIZE (1))
  609.        MAX-ACCESS read-write
  610.        STATUS current
  611.        DESCRIPTION
  612.            "The port's types of output flow control at the
  613.            software level.  Hardware-level flow control is
  614.            independently controlled by the appropriate
  615.  
  616.  
  617.  
  618. Stewart                                                        [Page 11]
  619.  
  620. RFC 1658                     Character MIB                     July 1994
  621.  
  622.  
  623.            hardware-level MIB.
  624.  
  625.            A value of zero indicates no flow control.
  626.            Depending on the specific implementation, any or
  627.            all combinations of flow control may be chosen by
  628.            adding the values:
  629.  
  630.            128  xonXoff, recognizing XON and XOFF characters
  631.            64   enqHost, ENQ/ACK to allow input to host
  632.            32   enqTerm, ACK to allow output to port
  633.            "
  634.        ::= { charPortEntry 20 }
  635.  
  636.    charPortLowerIfIndex OBJECT-TYPE
  637.        SYNTAX InterfaceIndex
  638.        MAX-ACCESS read-only
  639.        STATUS current
  640.        DESCRIPTION
  641.            "The ifIndex value of the lower level hardware supporting
  642.            this character port, zero if none."
  643.        ::= { charPortEntry 21 }
  644.  
  645.  
  646.    -- the Character Session table
  647.  
  648.    charSessTable OBJECT-TYPE
  649.        SYNTAX SEQUENCE OF CharSessEntry
  650.        MAX-ACCESS not-accessible
  651.        STATUS current
  652.        DESCRIPTION
  653.            "A list of port session entries."
  654.        ::= { char 3 }
  655.  
  656.    charSessEntry OBJECT-TYPE
  657.        SYNTAX CharSessEntry
  658.        MAX-ACCESS not-accessible
  659.        STATUS current
  660.        DESCRIPTION
  661.            "Status and parameter values for a character port
  662.            session."
  663.        INDEX { charSessPortIndex, charSessIndex }
  664.        ::= { charSessTable 1 }
  665.  
  666.    CharSessEntry ::=
  667.        SEQUENCE {
  668.            charSessPortIndex
  669.                PortIndex,
  670.            charSessIndex
  671.  
  672.  
  673.  
  674. Stewart                                                        [Page 12]
  675.  
  676. RFC 1658                     Character MIB                     July 1994
  677.  
  678.  
  679.                INTEGER,
  680.            charSessKill
  681.                INTEGER,
  682.            charSessState
  683.                INTEGER,
  684.            charSessProtocol
  685.                AutonomousType,
  686.            charSessOperOrigin
  687.                INTEGER,
  688.            charSessInCharacters
  689.                Counter32,
  690.            charSessOutCharacters
  691.                Counter32,
  692.            charSessConnectionId
  693.                InstancePointer,
  694.            charSessStartTime
  695.                TimeTicks
  696.        }
  697.  
  698.    charSessPortIndex OBJECT-TYPE
  699.        SYNTAX PortIndex
  700.        MAX-ACCESS read-only
  701.        STATUS current
  702.        DESCRIPTION
  703.            "The value of charPortIndex for the port to which
  704.            this session belongs."
  705.        ::= { charSessEntry 1 }
  706.  
  707.    charSessIndex OBJECT-TYPE
  708.        SYNTAX INTEGER (1..2147483647)
  709.        MAX-ACCESS read-only
  710.        STATUS current
  711.        DESCRIPTION
  712.            "The session index in the context of the port, a
  713.            non-zero positive integer.  Session indexes within a
  714.            port need not be sequential.  Session indexes may be
  715.            reused for different ports.  For example, port 1 and
  716.            port 3 may both have a session 2 at the same time.
  717.            Session indexes may have any valid integer value,
  718.            with any meaning convenient to the agent
  719.            implementation."
  720.        ::= { charSessEntry 2 }
  721.  
  722.    charSessKill OBJECT-TYPE
  723.        SYNTAX INTEGER { ready(1), execute(2) }
  724.        MAX-ACCESS read-write
  725.        STATUS current
  726.        DESCRIPTION
  727.  
  728.  
  729.  
  730. Stewart                                                        [Page 13]
  731.  
  732. RFC 1658                     Character MIB                     July 1994
  733.  
  734.  
  735.            "A control to terminate the session.  In response to
  736.            a get-request or get-next-request, the agent always
  737.            returns 'ready' as the value.  Setting the value to
  738.            'execute' causes termination."
  739.        ::= { charSessEntry 3 }
  740.  
  741.    charSessState OBJECT-TYPE
  742.        SYNTAX INTEGER { connecting(1), connected(2),
  743.                         disconnecting(3) }
  744.        MAX-ACCESS read-only
  745.        STATUS current
  746.        DESCRIPTION
  747.            "The current operational state of the session,
  748.            disregarding flow control.  'connected' indicates
  749.            that character data could flow on the network side
  750.            of session.  'connecting' indicates moving from
  751.            nonexistent toward 'connected'.  'disconnecting'
  752.            indicates moving from 'connected' or 'connecting' to
  753.            nonexistent."
  754.        ::= { charSessEntry 4 }
  755.  
  756.    charSessProtocol OBJECT-TYPE
  757.        SYNTAX AutonomousType
  758.        MAX-ACCESS read-only
  759.        STATUS current
  760.        DESCRIPTION
  761.            "The network protocol over which the session is
  762.            running.  Other OBJECT IDENTIFIER values may be
  763.            defined elsewhere, in association with specific
  764.            protocols.  However, this document assigns those of
  765.            known interest as of this writing."
  766.        ::= { charSessEntry 5 }
  767.  
  768.    wellKnownProtocols OBJECT IDENTIFIER ::= { char 4 }
  769.  
  770.    protocolOther  OBJECT IDENTIFIER ::= { wellKnownProtocols 1 }
  771.    protocolTelnet OBJECT IDENTIFIER ::= { wellKnownProtocols 2 }
  772.    protocolRlogin OBJECT IDENTIFIER ::= { wellKnownProtocols 3 }
  773.    protocolLat    OBJECT IDENTIFIER ::= { wellKnownProtocols 4 }
  774.    protocolX29    OBJECT IDENTIFIER ::= { wellKnownProtocols 5 }
  775.    protocolVtp    OBJECT IDENTIFIER ::= { wellKnownProtocols 6 }
  776.  
  777.  
  778.    charSessOperOrigin OBJECT-TYPE
  779.        SYNTAX INTEGER { unknown(1), network(2), local(3) }
  780.        MAX-ACCESS read-only
  781.        STATUS current
  782.        DESCRIPTION
  783.  
  784.  
  785.  
  786. Stewart                                                        [Page 14]
  787.  
  788. RFC 1658                     Character MIB                     July 1994
  789.  
  790.  
  791.            "The session's source of establishment."
  792.        ::= { charSessEntry 6 }
  793.  
  794.    charSessInCharacters OBJECT-TYPE
  795.        SYNTAX Counter32
  796.        MAX-ACCESS read-only
  797.        STATUS current
  798.        DESCRIPTION
  799.            "This session's subset of charPortInCharacters."
  800.        ::= { charSessEntry 7 }
  801.  
  802.    charSessOutCharacters OBJECT-TYPE
  803.        SYNTAX Counter32
  804.        MAX-ACCESS read-only
  805.        STATUS current
  806.        DESCRIPTION
  807.            "This session's subset of charPortOutCharacters."
  808.        ::= { charSessEntry 8 }
  809.  
  810.    charSessConnectionId OBJECT-TYPE
  811.        SYNTAX InstancePointer
  812.        MAX-ACCESS read-only
  813.        STATUS current
  814.        DESCRIPTION
  815.            "A reference to additional local MIB information.
  816.            This should be the highest available related MIB,
  817.            corresponding to charSessProtocol, such as Telnet.
  818.            For example, the value for a TCP connection (in the
  819.            absence of a Telnet MIB) is the object identifier of
  820.            tcpConnState.  If an agent is not configured to have
  821.            such values, the agent returns the object
  822.            identifier:
  823.  
  824.                nullConnectionId OBJECT IDENTIFIER ::= { 0 0 }
  825.            "
  826.        ::= { charSessEntry 9 }
  827.  
  828.    charSessStartTime OBJECT-TYPE
  829.        SYNTAX TimeTicks
  830.        MAX-ACCESS read-only
  831.        STATUS current
  832.        DESCRIPTION
  833.            "The value of sysUpTime in MIB-2 when the session
  834.            entered connecting state."
  835.        ::= { charSessEntry 10 }
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842. Stewart                                                        [Page 15]
  843.  
  844. RFC 1658                     Character MIB                     July 1994
  845.  
  846.  
  847.    -- conformance information
  848.  
  849.    charConformance OBJECT IDENTIFIER ::= { char 5 }
  850.  
  851.    charGroups      OBJECT IDENTIFIER ::= { charConformance 1 }
  852.    charCompliances OBJECT IDENTIFIER ::= { charConformance 2 }
  853.  
  854.  
  855.    -- compliance statements
  856.  
  857.    charCompliance MODULE-COMPLIANCE
  858.        STATUS  current
  859.        DESCRIPTION
  860.                "The compliance statement for SNMPv2 entities
  861.                which have Character hardware interfaces."
  862.  
  863.        MODULE  -- this module
  864.            MANDATORY-GROUPS { charGroup }
  865.        ::= { charCompliances 1 }
  866.  
  867.  
  868.    -- units of conformance
  869.  
  870.    charGroup    OBJECT-GROUP
  871.        OBJECTS { charNumber, charPortIndex, charPortName,
  872.                  charPortType, charPortHardware, charPortReset,
  873.                  charPortAdminStatus, charPortOperStatus,
  874.                  charPortLastChange,
  875.                  charPortInFlowState, charPortOutFlowState,
  876.                  charPortAdminOrigin, charPortSessionMaximum,
  877.                  charPortInFlowTypes, charPortOutFlowTypes,
  878.                  charPortInCharacters, charPortOutCharacters,
  879.                  charPortSessionNumber, charPortSessionIndex,
  880.                  charPortLowerIfIndex,
  881.                  charSessPortIndex, charSessIndex,
  882.                  charSessKill, charSessState,
  883.                  charSessProtocol, charSessOperOrigin,
  884.                  charSessInCharacters, charSessOutCharacters,
  885.                  charSessConnectionId, charSessStartTime }
  886.        STATUS  current
  887.        DESCRIPTION
  888.                "A collection of objects providing information
  889.                 applicable to all Character interfaces."
  890.        ::= { charGroups 1 }
  891.  
  892.    END
  893.  
  894.  
  895.  
  896.  
  897.  
  898. Stewart                                                        [Page 16]
  899.  
  900. RFC 1658                     Character MIB                     July 1994
  901.  
  902.  
  903. 5.  Acknowledgements
  904.  
  905.    This memo was produced by the IETF Character MIB Working Group.
  906.  
  907. 6.  References
  908.  
  909.    [1] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Structure
  910.        of Management Information for version 2 of the Simple Network
  911.        Management Protocol (SNMPv2)", RFC 1442, SNMP Research,Inc.,
  912.        Hughes LAN Systems, Dover Beach Consulting, Inc., Carnegie Mellon
  913.        University, April 1993.
  914.  
  915.    [2] McCloghrie, K., and M. Rose, Editors, "Management Information
  916.        Base for Network Management of TCP/IP-based internets: MIB-II",
  917.        STD 17, RFC 1213, Hughes LAN Systems, Performance Systems
  918.        International, March 1991.
  919.  
  920.    [3] Galvin, J., and K. McCloghrie, "Administrative Model for version
  921.        2 of the Simple Network Management Protocol (SNMPv2)", RFC 1445,
  922.        Trusted Information Systems, Hughes LAN Systems, April 1993.
  923.  
  924.    [4] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol
  925.        Operations for version 2 of the Simple Network Management
  926.        Protocol (SNMPv2)", RFC 1448, SNMP Research,Inc., Hughes LAN
  927.        Systems, Dover Beach Consulting, Inc., Carnegie Mellon
  928.        University, April 1993.
  929.  
  930.    [5] McCloghrie, K., and F. Kastenholz, "Evolution of the Interfaces
  931.        Group of MIB-II", RFC 1573, Hughes LAN Systems, FTP Software,
  932.        January 1994.
  933.  
  934.    [6] Stewart, B., "Definitions of Managed Objects for RS-232-like
  935.        Hardware Devices using SMIv2", RFC 1659, Xyplex, Inc., July 1994.
  936.  
  937.    [7] Stewart, B., "Definitions of Managed Objects for Parallel-
  938.        printer-like Hardware Devices using SMIv2", RFC 1660, Xyplex,
  939.        Inc., July 1994.
  940.  
  941.  
  942.  
  943.  
  944.  
  945.  
  946.  
  947.  
  948.  
  949.  
  950.  
  951.  
  952.  
  953.  
  954. Stewart                                                        [Page 17]
  955.  
  956. RFC 1658                     Character MIB                     July 1994
  957.  
  958.  
  959. 7.  Security Considerations
  960.  
  961.    Security issues are not discussed in this memo.
  962.  
  963. 8.  Author's Address
  964.  
  965.    Bob Stewart
  966.    Xyplex, Inc.
  967.    295 Foster Street
  968.    Littleton, MA 01460
  969.  
  970.    Phone: 508-952-4816
  971.    Fax: 508-952-4887
  972.    EMail: rlstewart@eng.xyplex.com
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.  
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.  
  995.  
  996.  
  997.  
  998.  
  999.  
  1000.  
  1001.  
  1002.  
  1003.  
  1004.  
  1005.  
  1006.  
  1007.  
  1008.  
  1009.  
  1010. Stewart                                                        [Page 18]
  1011.  
  1012.