mibs/ietf/RFC1316-MIB

   1         RFC1316-MIB DEFINITIONS ::= BEGIN
   2
   3         IMPORTS
   4                 Counter, TimeTicks, Gauge
   5                         FROM RFC1155-SMI
   6                 DisplayString, mib-2
   7                         FROM RFC1213-MIB
   8                 OBJECT-TYPE
   9                         FROM RFC-1212;
  10
  11 -- this is the MIB module for character stream devices
  12
  13 char    OBJECT IDENTIFIER ::= { mib-2 19 }
  14
  15 -- Textual Conventions
  16
  17     AutonomousType    ::= OBJECT IDENTIFIER
  18
  19 -- The object identifier is an independently extensible type
  20 -- identification value.  It may, for example indicate a
  21 -- particular sub-tree with further MIB definitions, or
  22 -- define something like a protocol type or type of
  23 -- hardware.
  24
  25     InstancePointer   ::= OBJECT IDENTIFIER
  26
  27 -- The object identifier is a pointer to a specific instance
  28 -- of a MIB object in this agent's implemented MIB.  By
  29 -- convention, it is the first object in the conceptual row
  30 -- for the instance.
  31
  32 -- the generic Character group
  33
  34 -- Implementation of this group is mandatory for all
  35 -- systems that offer character ports
  36
  37 charNumber OBJECT-TYPE
  38     SYNTAX INTEGER
  39     ACCESS read-only
  40     STATUS mandatory
  41     DESCRIPTION
  42         "The number of entries in charPortTable, regardless
  43         of their current state."
  44     ::= { char 1 }
  45
  46
  47 -- the Character Port table
  48
  49 charPortTable OBJECT-TYPE
  50     SYNTAX SEQUENCE OF CharPortEntry
  51     ACCESS not-accessible
  52     STATUS mandatory
  53     DESCRIPTION
  54         "A list of port entries.  The number of entries is
  55         given by the value of charNumber."
  56     ::= { char 2 }
  57
  58 charPortEntry OBJECT-TYPE
  59     SYNTAX CharPortEntry
  60     ACCESS not-accessible
  61     STATUS mandatory
  62     DESCRIPTION
  63         "Status and parameter values for a character port."
  64     INDEX { charPortIndex }
  65     ::= { charPortTable 1 }
  66
  67 CharPortEntry ::=
  68     SEQUENCE {
  69         charPortIndex
  70             INTEGER,
  71         charPortName
  72             DisplayString,
  73         charPortType
  74             INTEGER,
  75         charPortHardware
  76             AutonomousType,
  77         charPortReset
  78             INTEGER,
  79         charPortAdminStatus
  80             INTEGER,
  81         charPortOperStatus
  82             INTEGER,
  83         charPortLastChange
  84             TimeTicks,
  85         charPortInFlowType
  86             INTEGER,
  87         charPortOutFlowType
  88             INTEGER,
  89         charPortInFlowState
  90             INTEGER,
  91         charPortOutFlowState
  92             INTEGER,
  93         charPortInCharacters
  94             Counter,
  95         charPortOutCharacters
  96             Counter,
  97         charPortAdminOrigin
  98             INTEGER,
  99         charPortSessionMaximum
 100             INTEGER,
 101         charPortSessionNumber
 102             Gauge,
 103         charPortSessionIndex
 104             INTEGER
 105     }
 106
 107 charPortIndex OBJECT-TYPE
 108     SYNTAX INTEGER
 109     ACCESS read-only
 110     STATUS mandatory
 111     DESCRIPTION
 112         "A unique value for each character port.  Its value
 113         ranges between 1 and the value of charNumber.  By
 114         convention and if possible, hardware port numbers
 115         come first, with a simple, direct mapping.  The
 116         value for each port must remain constant at least
 117         from one re-initialization of the network management
 118         agent to the next."
 119     ::= { charPortEntry 1 }
 120
 121 charPortName OBJECT-TYPE
 122     SYNTAX DisplayString (SIZE (0..32))
 123     ACCESS read-write
 124     STATUS mandatory
 125     DESCRIPTION
 126         "An administratively assigned name for the port,
 127         typically with some local significance."
 128     ::= { charPortEntry 2 }
 129
 130 charPortType OBJECT-TYPE
 131     SYNTAX INTEGER { physical(1), virtual(2) }
 132     ACCESS read-only
 133     STATUS mandatory
 134     DESCRIPTION
 135         "The port's type, 'physical' if the port represents
 136         an external hardware connector, 'virtual' if it does
 137         not."
 138     ::= { charPortEntry 3 }
 139
 140 charPortHardware OBJECT-TYPE
 141     SYNTAX AutonomousType
 142     ACCESS read-only
 143     STATUS mandatory
 144     DESCRIPTION
 145         "A reference to hardware MIB definitions specific to
 146         a physical port's external connector.  For example,
 147         if the connector is RS-232, then the value of this
 148         object refers to a MIB sub-tree defining objects
 149         specific to RS-232.  If an agent is not configured
 150         to have such values, the agent returns the object
 151         identifier:
 152
 153             nullHardware OBJECT IDENTIFIER ::= { 0 0 }
 154         "
 155     ::= { charPortEntry 4 }
 156
 157 charPortReset OBJECT-TYPE
 158     SYNTAX INTEGER { ready(1), execute(2) }
 159     ACCESS read-write
 160     STATUS mandatory
 161     DESCRIPTION
 162         "A control to force the port into a clean, initial
 163         state, both hardware and software, disconnecting all
 164         the port's existing sessions.  In response to a
 165         get-request or get-next-request, the agent always
 166         returns 'ready' as the value.  Setting the value to
 167         'execute' causes a reset."
 168     ::= { charPortEntry 5 }
 169
 170 charPortAdminStatus OBJECT-TYPE
 171     SYNTAX INTEGER { enabled(1), disabled(2), off(3),
 172                      maintenance(4) }
 173     ACCESS read-write
 174     STATUS mandatory
 175     DESCRIPTION
 176         "The port's desired state, independent of flow
 177         control.  'enabled' indicates that the port is
 178         allowed to pass characters and form new sessions.
 179         'disabled' indicates that the port is allowed to
 180         pass characters but not form new sessions.  'off'
 181         indicates that the port is not allowed to pass
 182         characters or have any sessions. 'maintenance'
 183         indicates a maintenance mode, exclusive of normal
 184         operation, such as running a test."
 185     ::= { charPortEntry 6 }
 186
 187 charPortOperStatus OBJECT-TYPE
 188     SYNTAX INTEGER { up(1), down(2),
 189                      maintenance(3), absent(4), active(5) }
 190     ACCESS read-only
 191     STATUS mandatory
 192     DESCRIPTION
 193         "The port's actual, operational state, independent
 194         of flow control.  'up' indicates able to function
 195         normally.  'down' indicates inability to function
 196         for administrative or operational reasons.
 197         'maintenance' indicates a maintenance mode,
 198         exclusive of normal operation, such as running a
 199         test.  'absent' indicates that port hardware is not
 200         present.  'active' indicates up with a user present
 201         (e.g. logged in)."
 202     ::= { charPortEntry 7 }
 203
 204 charPortLastChange OBJECT-TYPE
 205     SYNTAX TimeTicks
 206     ACCESS read-only
 207     STATUS mandatory
 208     DESCRIPTION
 209         "The value of sysUpTime at the time the port entered
 210         its current operational state.  If the current state
 211         was entered prior to the last reinitialization of
 212         the local network management subsystem, then this
 213         object contains a zero value."
 214     ::= { charPortEntry 8 }
 215
 216 charPortInFlowType OBJECT-TYPE
 217     SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
 218                      ctsRts(4), dsrDtr(5) }
 219     ACCESS read-write
 220     STATUS mandatory
 221     DESCRIPTION
 222         "The port's type of input flow control.  'none'
 223         indicates no flow control at this level or below.
 224         'xonXoff' indicates software flow control by
 225         recognizing XON and XOFF characters.  'hardware'
 226         indicates flow control delegated to the lower level,
 227         for example a parallel port.
 228
 229         'ctsRts' and 'dsrDtr' are specific to RS-232-like
 230         ports.  Although not architecturally pure, they are
 231         included here for simplicity's sake."
 232     ::= { charPortEntry 9 }
 233
 234 charPortOutFlowType OBJECT-TYPE
 235     SYNTAX INTEGER { none(1), xonXoff(2), hardware(3),
 236                      ctsRts(4), dsrDtr(5) }
 237     ACCESS read-write
 238     STATUS mandatory
 239     DESCRIPTION
 240         "The port's type of output flow control.  'none'
 241         indicates no flow control at this level or below.
 242         'xonXoff' indicates software flow control by
 243         recognizing XON and XOFF characters.  'hardware'
 244         indicates flow control delegated to the lower level,
 245         for example a parallel port.
 246
 247         'ctsRts' and 'dsrDtr' are specific to RS-232-like
 248         ports.  Although not architecturally pure, they are
 249         included here for simplicy's sake."
 250     ::= { charPortEntry 10 }
 251
 252 charPortInFlowState OBJECT-TYPE
 253     SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
 254     ACCESS read-only
 255     STATUS mandatory
 256     DESCRIPTION
 257         "The current operational state of input flow control
 258         on the port.  'none' indicates not applicable.
 259         'unknown' indicates this level does not know.
 260         'stop' indicates flow not allowed.  'go' indicates
 261         flow allowed."
 262     ::= { charPortEntry 11 }
 263
 264 charPortOutFlowState OBJECT-TYPE
 265     SYNTAX INTEGER { none(1), unknown(2), stop(3), go(4) }
 266     ACCESS read-only
 267     STATUS mandatory
 268     DESCRIPTION
 269         "The current operational state of output flow
 270         control on the port.  'none' indicates not
 271         applicable.  'unknown' indicates this level does not
 272         know.  'stop' indicates flow not allowed.  'go'
 273         indicates flow allowed."
 274     ::= { charPortEntry 12 }
 275
 276 charPortInCharacters OBJECT-TYPE
 277     SYNTAX Counter
 278     ACCESS read-only
 279     STATUS mandatory
 280     DESCRIPTION
 281         "Total number of characters detected as input from
 282         the port since system re-initialization and while
 283         the port operational state was 'up', 'active', or
 284         'maintenance', including, for example, framing, flow
 285         control (i.e. XON and XOFF), each occurrence of a
 286         BREAK condition, locally-processed input, and input
 287         sent to all sessions."
 288     ::= { charPortEntry 13 }
 289
 290 charPortOutCharacters OBJECT-TYPE
 291     SYNTAX Counter
 292     ACCESS read-only
 293     STATUS mandatory
 294     DESCRIPTION
 295         "Total number of characters detected as output to
 296         the port since system re-initialization and while
 297         the port operational state was 'up', 'active', or
 298         'maintenance', including, for example, framing, flow
 299         control (i.e. XON and XOFF), each occurrence of a
 300         BREAK condition, locally-created output, and output
 301         received from all sessions."
 302     ::= { charPortEntry 14 }
 303
 304 charPortAdminOrigin OBJECT-TYPE
 305     SYNTAX INTEGER { dynamic(1), network(2), local(3),
 306                      none(4) }
 307     ACCESS read-write
 308     STATUS mandatory
 309     DESCRIPTION
 310         "The administratively allowed origin for
 311         establishing session on the port.  'dynamic' allows
 312         'network' or 'local' session establishment. 'none'
 313         disallows session establishment."
 314     ::= { charPortEntry 15 }
 315
 316 charPortSessionMaximum OBJECT-TYPE
 317     SYNTAX INTEGER
 318     ACCESS read-write
 319     STATUS mandatory
 320     DESCRIPTION
 321         "The maximum number of concurrent sessions allowed
 322         on the port.  A value of -1 indicates no maximum.
 323         Setting the maximum to less than the current number
 324         of sessions has unspecified results."
 325     ::= { charPortEntry 16 }
 326
 327 charPortSessionNumber OBJECT-TYPE
 328     SYNTAX Gauge
 329     ACCESS read-only
 330     STATUS mandatory
 331     DESCRIPTION
 332         "The number of open sessions on the port that are in
 333         the connecting, connected, or disconnecting state."
 334     ::= { charPortEntry 17 }
 335
 336 charPortSessionIndex OBJECT-TYPE
 337     SYNTAX INTEGER
 338     ACCESS read-only
 339     STATUS mandatory
 340     DESCRIPTION
 341         "The value of charSessIndex for the port's first or
 342         only active session.  If the port has no active
 343         session, the agent returns the value zero."
 344     ::= { charPortEntry 18 }
 345
 346
 347 -- the Character Session table
 348
 349 charSessTable OBJECT-TYPE
 350     SYNTAX SEQUENCE OF CharSessEntry
 351     ACCESS not-accessible
 352     STATUS mandatory
 353     DESCRIPTION
 354         "A list of port session entries."
 355     ::= { char 3 }
 356
 357 charSessEntry OBJECT-TYPE
 358     SYNTAX CharSessEntry
 359     ACCESS not-accessible
 360     STATUS mandatory
 361     DESCRIPTION
 362         "Status and parameter values for a character port
 363         session."
 364     INDEX { charSessPortIndex, charSessIndex }
 365     ::= { charSessTable 1 }
 366
 367 CharSessEntry ::=
 368     SEQUENCE {
 369         charSessPortIndex
 370             INTEGER,
 371         charSessIndex
 372             INTEGER,
 373         charSessKill
 374             INTEGER,
 375         charSessState
 376             INTEGER,
 377         charSessProtocol
 378             AutonomousType,
 379         charSessOperOrigin
 380             INTEGER,
 381         charSessInCharacters
 382             Counter,
 383         charSessOutCharacters
 384             Counter,
 385         charSessConnectionId
 386             InstancePointer,
 387         charSessStartTime
 388             TimeTicks
 389     }
 390
 391 charSessPortIndex OBJECT-TYPE
 392     SYNTAX INTEGER
 393     ACCESS read-only
 394     STATUS mandatory
 395     DESCRIPTION
 396         "The value of charPortIndex for the port to which
 397         this session belongs."
 398     ::= { charSessEntry 1 }
 399
 400 charSessIndex OBJECT-TYPE
 401     SYNTAX INTEGER
 402     ACCESS read-only
 403     STATUS mandatory
 404     DESCRIPTION
 405         "The session index in the context of the port, a
 406         non-zero positive integer.  Session indexes within a
 407         port need not be sequential.  Session indexes may be
 408         reused for different ports.  For example, port 1 and
 409         port 3 may both have a session 2 at the same time.
 410         Session indexes may have any valid integer value,
 411         with any meaning convenient to the agent
 412         implementation."
 413     ::= { charSessEntry 2 }
 414
 415 charSessKill OBJECT-TYPE
 416     SYNTAX INTEGER { ready(1), execute(2) }
 417     ACCESS read-write
 418     STATUS mandatory
 419     DESCRIPTION
 420         "A control to terminate the session.  In response to
 421         a get-request or get-next-request, the agent always
 422         returns 'ready' as the value.  Setting the value to
 423         'execute' causes termination."
 424     ::= { charSessEntry 3 }
 425
 426 charSessState OBJECT-TYPE
 427     SYNTAX INTEGER { connecting(1), connected(2),
 428                      disconnecting(3) }
 429     ACCESS read-only
 430     STATUS mandatory
 431     DESCRIPTION
 432         "The current operational state of the session,
 433         disregarding flow control.  'connected' indicates
 434         that character data could flow on the network side
 435         of session.  'connecting' indicates moving from
 436         nonexistent toward 'connected'.  'disconnecting'
 437         indicates moving from 'connected' or 'connecting' to
 438         nonexistent."
 439     ::= { charSessEntry 4 }
 440
 441 charSessProtocol OBJECT-TYPE
 442     SYNTAX AutonomousType
 443     ACCESS read-only
 444     STATUS mandatory
 445     DESCRIPTION
 446         "The network protocol over which the session is
 447         running.  Other OBJECT IDENTIFIER values may be
 448         defined elsewhere, in association with specific
 449         protocols.  However, this document assigns those of
 450         known interest as of this writing."
 451     ::= { charSessEntry 5 }
 452
 453 wellKnownProtocols OBJECT IDENTIFIER ::= { char 4 }
 454
 455 protocolOther  OBJECT IDENTIFIER ::= {wellKnownProtocols 1}
 456 protocolTelnet OBJECT IDENTIFIER ::= {wellKnownProtocols 2}
 457 protocolRlogin OBJECT IDENTIFIER ::= {wellKnownProtocols 3}
 458 protocolLat    OBJECT IDENTIFIER ::= {wellKnownProtocols 4}
 459 protocolX29    OBJECT IDENTIFIER ::= {wellKnownProtocols 5}
 460 protocolVtp    OBJECT IDENTIFIER ::= {wellKnownProtocols 6}
 461
 462 charSessOperOrigin OBJECT-TYPE
 463     SYNTAX INTEGER { unknown(1), network(2), local(3) }
 464     ACCESS read-only
 465     STATUS mandatory
 466     DESCRIPTION
 467         "The session's source of establishment."
 468     ::= { charSessEntry 6 }
 469
 470 charSessInCharacters OBJECT-TYPE
 471     SYNTAX Counter
 472     ACCESS read-only
 473     STATUS mandatory
 474     DESCRIPTION
 475         "This session's subset of charPortInCharacters."
 476     ::= { charSessEntry 7 }
 477
 478 charSessOutCharacters OBJECT-TYPE
 479     SYNTAX Counter
 480     ACCESS read-only
 481     STATUS mandatory
 482     DESCRIPTION
 483         "This session's subset of charPortOutCharacters."
 484     ::= { charSessEntry 8 }
 485
 486 charSessConnectionId OBJECT-TYPE
 487     SYNTAX InstancePointer
 488     ACCESS read-only
 489     STATUS mandatory
 490     DESCRIPTION
 491         "A reference to additional local MIB information.
 492         This should be the highest available related MIB,
 493         corresponding to charSessProtocol, such as Telnet.
 494         For example, the value for a TCP connection (in the
 495         absence of a Telnet MIB) is the object identifier of
 496         tcpConnState.  If an agent is not configured to have
 497         such values, the agent returns the object
 498         identifier:
 499
 500             nullConnectionId OBJECT IDENTIFIER ::= { 0 0 }
 501         "
 502     ::= { charSessEntry 9 }
 503
 504 charSessStartTime OBJECT-TYPE
 505     SYNTAX TimeTicks
 506     ACCESS read-only
 507     STATUS mandatory
 508     DESCRIPTION
 509         "The value of sysUpTime in MIB-2 when the session
 510         entered connecting state."
 511     ::= { charSessEntry 10 }
 512
 513 END