Request for Comments: 3873 M. Belinchon
Category: Standards Track Ericsson
September 2004
Stream Control Transmission Protocol (SCTP)
Management Information Base (MIB)
Status of this Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2004).
Abstract
The Stream Control Transmission Protocol (SCTP) is a reliable
transport protocol operating on top of a connectionless packet
network such as IP. It is designed to transport public switched
telephone network (PSTN) signaling messages over the connectionless
packet network, but is capable of broader applications.
This memo defines the Management Information Base (MIB) module which
describes the minimum set of objects needed to manage the
implementation of the SCTP.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Abbreviations. . . . . . . . . . . . . . . . . . . . . . 2
2. The Internet-Standard Management Framework . . . . . . . . . . 3
3. MIB Structure. . . . . . . . . . . . . . . . . . . . . . . . . 3
3.1. SCTP Objects . . . . . . . . . . . . . . . . . . . . . . 4
3.1.1. SCTP Statistics. . . . . . . . . . . . . . . . . 4
3.1.2. SCTP Parameters. . . . . . . . . . . . . . . . . 5
3.1.3. MIB Tables . . . . . . . . . . . . . . . . . . . 5
3.1.3.1. Association Table. . . . . . . . . . . 5
3.1.3.2. Reverse Lookup Table . . . . . . . . . 8
3.2. Conformance. . . . . . . . . . . . . . . . . . . . . . . 9
4. Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . 9
5. Compiling Notes. . . . . . . . . . . . . . . . . . . . . . . . 42
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.1. Normative References . . . . . . . . . . . . . . . . . . 42
6.2. Informative References . . . . . . . . . . . . . . . . . 43
7. Security Considerations. . . . . . . . . . . . . . . . . . . . 44
8. Acknowledgments. . . . . . . . . . . . . . . . . . . . . . . . 45
9. Authors’ Addresses . . . . . . . . . . . . . . . . . . . . . . 45
10. Full Copyright Statement . . . . . . . . . . . . . . . . . . . 46
1. Introduction
This memo defines the Management Information Base (MIB) module which
describes managed objects for implementations of the SCTP.
The document starts with a brief description of the SNMP framework
and continues with the MIB explanation and security consideration
sections among others.
The managed objects in this MIB module are based on [RFC2012] update:
"Management Information Base for the Transmission Control Protocol
(TCP)" referred as [TCPMIB] (work in progress), and RFC 3291 "Textual
Conventions for Internet Network Addresses" [RFC3291].
Terms related to the SCTP architecture are explained in [RFC2960].
Other specific abbreviations are listed below.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
1.1. Abbreviations
DNS - Domain Name System
IANA - Internet Assigned Numbers Authority
IETF - Internet Engineering Task Force
IP - Internet Protocol
MIB - Management Information Base
RFC - Request For Comments
RTO - Retransmission Time Out
SCTP - Stream Control Transmission Protocol
SMI - Structure of Management Information
SNMP - Simple Network Management Protocol
TCB - Transmission Control Block
TCP - Transmission Control Protocol
2. The Internet-Standard Management Framework
For a detailed overview of the documents that describe the current
Internet-Standard Management Framework, please refer to section 7 of
RFC 3410 [RFC3410].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. MIB objects are generally
accessed through the Simple Network Management Protocol (SNMP).
Objects in the MIB are defined using the mechanisms defined in the
Structure of Management Information (SMI). This memo specifies a MIB
module that is compliant to the SMIv2, which is described in STD 58,
RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580
[RFC2580].
3. MIB Structure
This chapter explains the main objects this MIB defines. A detailed
view of the MIB structure with the OID values is below.
MIB-2 {1 3 6 1 2 1}
+--(104)sctpMIB
|
+--(1) sctpObjects
| |
| +--(1) sctpStats
| | |
| | +-- <scalars>
| |
| +--(2)sctpParameters
| | |
| | +-- <scalars>
| |
| +--(3) sctpAssocTable
| |
| +--(4) sctpAssocLocalAddrTable
| |
| +--(5) sctpAssocRemAddrTable
| |
| +--(6) sctpLookupLocalPortTable
| |
| +--(7) sctpLookupRemPortTable
| |
| +--(8) sctpLookupRemHostNameTable
| |
| +--(9) sctpLookupRemPrimIPAddrTable
| |
| +--(10) sctpLookupRemIPAddrTable
|
|
+--(2)sctpMibConformance
|
+--(1) sctpMibCompliances
| |
| +--(1) sctpMibCompliance
|
+--(2) sctpMibGroups
|
+--(1) sctpLayerParamsGroup
|
+--(2) sctpStatsGroup
|
+--(3) sctpPerAssocParamsGroup
|
+--(4) sctpInverseGroup
The main groups are explained further in the MIB definition.
3.1. SCTP Objects
This branch contains the SCTP statistics and general parameters (both
of them scalars) and the SCTP MIB tables.
3.1.1. SCTP Statistics
The SCTP MIB includes both Counter32s and Counter64s to deal with
statistics. Counter64s are used for those counters, which are likely
to wrap around in less than one hour, according to [RFC2863].
In addition Gauge32 is also used.
3.1.1.1. State-Related Statistics
These statistics are based on the TCP model, but adapted to the SCTP
states. They store the number of successful association attempts,
how many associations have been initiated by the local or the remote
SCTP layer, and the number of associations terminated in a graceful
(by means of SHUTDOWN procedure) or ungraceful way (by means of CLOSE
procedure).
3.1.1.2. Statistics for traffic Measurements
This set of objects specifies statistics related to the whole SCTP
layer. There are, e.g., statistics related to both SCTP packets and
SCTP chunks.
Statistics related to a specific association, or local/remote IP
addresses are defined inside their associated table.
3.1.2. SCTP Parameters
This section of the MIB contains the general variables for the SCTP
protocol. Maximum, minimum, initial and default values are listed
here.
SCTP RTO mechanism definition is based on the TCP MIB [TCPMIB]. In
SCTP, only options ’other’ and ’vanj’ are valid since SCTP defines
Van Jacobson’s algorithm (vanj) as the one to be used to calculate
RTO. ’Other’ is left for future use.
3.1.3. MIB Tables
There are several tables included in the SCTP MIB. The first group
deals with the SCTP association variables and is composed of a main
and two extended tables. The second group is a bunch of tables used
to perform reverse lookups.
It is NOT possible to create rows in any table (sctpAssocTable,
sctpAssocLocalAddrTable, sctpRemAddrTable and Reverse Lookup tables)
using SNMP.
It is NOT possible to delete rows in any table using SNMP except in
sctpAssocTable under the particular conditions explained below.
3.1.3.1. Association Table
The sctpAssocTable is the main MIB table, where all the association
related information is stored on a per association basis. It is
structured according to expanded tables. The main table is called
sctpAssocTable and is indexed by sctpAssocId (the association
identification). This is a value that uniquely identifies an
association. The MIB does not restrict what value must be written
here, however it must be unique within the table.
The sctpAssoc index is also shared by two more tables:
- sctpAssocLocalAddrTable: to store the local IP address(es).
- sctpAssocRemAddrTable: to store the remote addresses and the
per-remote-address related information.
Entries in the sctpAssocTable are created when trying to establish
the association, i.e., when sending the COOKIE-ECHO message
(originating side) or the COOKIE-ACK message (server side). At this
point, i.e., at established state, all entry fields are filled in
with valid values.
Note: The following representation is a conceptual mode of describing
the relationship between the tables in this MIB. Note that the real
relationship of the tables is by sharing an index, so tables are not
truly within tables. Every entry is explained when defining the
corresponding objects in the MIB.
mib-2 {1 3 6 1 2 1}
+--(104)sctpMIB
|
+--(1) sctpObjects
| |
. .
. .
|
+--(3) sctpAssocTable
| |
| +--(1) sctpAssocId (index)
| |
| +--(2) sctpAssocRemHostName
| |
| +--(3) sctpAssocLocalPort
| |
| +--(4) sctpAssocRemPort
| |
| +--(5) sctpAssocRemPrimAddrType
| |
| +--(6) sctpAssocRemPrimAddr
| |
| +--(7) sctpAssocHeartBeatInterval
| |
| +--(8) sctpAssocState
| |
| +--(9) sctpAssocInStreams
| |
| +--(10) sctpAssocOutStreams
| |
| +--(11) sctpAssocMaxRetr
| |
| +--(12) sctpAssocPrimProcess
| |
| +--(13) sctpAssocT1expireds
| |
| +--(14) sctpAssocT2expireds
| |
| +--(15) sctpAssocRtxChunks
| |
| +--(16) sctpAssocStartTime
| |
| +--(17) sctpAssocDiscontinuityTime
|
|
+--(4) sctpAssocLocalAddrTable
| |
| |--(-) sctpAssocId (shared index)
| |
| +--(1) sctpAssocLocalAddrType(index)
| |
| +--(2) sctpAssocLocalAddr (index)
| |
| +--(3) sctpAssocLocalAddrStartTime
|
|
+--(5) sctpAssocRemAddrTable
| |
| |--(-) sctpAssocId (shared index)
| |
| +--(1) sctpAssocRemAddrType (index)
. |
. +--(2) sctpAssocRemAddr (index)
. |
+--(3) sctpAssocRemAddrActive
|
+--(4) sctpAssocRemAddrHBActive
|
+--(5) sctpAssocRemAddrRTO
|
+--(6) sctpAssocRemAddrMaxPathRtx
|
+--(7) sctpAssocRemAddrRtx
|
+--(8) sctpAssocRemAddrStartTime
Both sctpAssocLocalAddrTable and sctpAssocRemAddrTable are indexed by
addresses. ’Addr’ and ’AddrType’ use the syntax InetAddress and
InetAddressType defined in the Textual Conventions for Internet
Network Address (RFC3291). The InetAddressType TC has codepoints for
unknown, IPv4, IPv6, non-global IPv4, non-global IPv6, and DNS
addresses, but only the IPv4 and IPv6 address types are required to
be supported by implementations of this MIB module. Implementations
that connect multiple zones are expected to support the non-global
IPv4 and non-global IPv6 address types as well.
Note that DNS addresses are not used in this MIB module. They are
always resolved to the on-the-wire form prior to connection setup,
and the on-the-wire form is what appears in the MIB objects.
The sctpAssocLocalAddrTable table will have as many entries as local
IP addresses have been defined for the association. The
sctpAssocRemAddrTable table will contain as many entries as remote IP
addresses are known to reach the peer. For the multihoming concept
see reference RFC2960.
To keep the name of the remote peer (when provided by the peer at
initialization time), an entry has been created in the sctpAssocTable
called sctpAssocRemHostName. When no DNS name is provided by the
remote endpoint, this value will be NULL (zero-length string).
Otherwise, the received DNS name will be stored here.
If it is necessary to abort an existing association, the value
deleteTCB(9) must be written in the variable sctpAssocState. That is
the only way to delete rows in any of the mentioned tables.
3.1.3.2. Reverse Lookup Table
There are five reverse lookup tables to help management applications
efficiently access conceptual rows in other tables. These tables
allow management applications to avoid expensive tree walks through
large numbers of associations.
All of these tables are optional. If these tables are implemented,
an entry in them must be created after the entry in the main table
(sctpAssocTable) associated with it has been created. This ensures
that the field indexing the lookup table exists.
The defined reverse lookup tables allow for performing a lookup using
the following variables:
- Local Port: It allows a management application to find all the
associations that use a specific local port
- Remote Port: It allows a management application to find all the
associations that use a specific remote port
- Remote Host Name: It allows a management application to find
all the associations with a specific host name.
- Remote Primary IP Address: It allows a management application
to find all the associations that use a specific remote IP
address as primary.
- Remote IP address: a management application to find all the
associations that use a specific remote IP address.
As an example the picture below shows the table to look up by local
port.
MIB-2 {1 3 6 1 2 1}
+--(104)sctpMIB
|
+--(1) sctpObjects
| |
. .
. .
| |
| +--(6) sctpLookupLocalPortTable
| | |
. . +--(-) sctpAssocLocalPort (shared index)
. . |
+--(-) sctpAssocId (shared index)
|
+--(1) sctpLookupLocalPortStartTime
It is not possible for the operator to either create or delete rows
in these tables. The rows in this table will dynamically appear and
be removed as the corresponding entries in sctpAssocTable are.
3.2. Conformance
The conformance section recommends all the inverse lookup tables in
this MIB as optional. General layer and per association parameters
and statistics are considered mandatory.
IP addresses use the global IPv4 and global IPv6 address formats.
Unknown value and DNS name formats are not used. Names, if present,
are stored in the sctpRemoteHostName variable.
4. Definitions
SCTP-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, Integer32, Unsigned32, Gauge32,
Counter32, Counter64, mib-2
FROM SNMPv2-SMI -- [RFC2578]
TimeStamp, TruthValue
FROM SNMPv2-TC -- [RFC2579]
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF -- [RFC2580]
InetAddressType, InetAddress, InetPortNumber
FROM INET-ADDRESS-MIB; -- [RFC3291]
sctpMIB MODULE-IDENTITY
LAST-UPDATED "200409020000Z" -- 2nd September 2004
ORGANIZATION "IETF SIGTRAN Working Group"
CONTACT-INFO
"
WG EMail: sigtran@ietf.org
Web Page:
http://www.ietf.org/html.charters/sigtran-charter.html
Chair: Lyndon Ong
Ciena Corporation
0480 Ridgeview Drive
Cupertino, CA 95014
USA
Tel:
Email: lyong@ciena.com
Editors: Maria-Carmen Belinchon
R&D Department
Ericsson Espana S. A.
Via de los Poblados, 13
28033 Madrid
Spain
Tel: +34 91 339 3535
Email: Maria.C.Belinchon@ericsson.com
Jose-Javier Pastor-Balbas
R&D Department
Ericsson Espana S. A.
Via de los Poblados, 13
28033 Madrid
Spain
Tel: +34 91 339 1397
Email: J.Javier.Pastor@ericsson.com
"
DESCRIPTION
"The MIB module for managing SCTP implementations.
Copyright (C) The Internet Society (2004). This version of
this MIB module is part of RFC 3873; see the RFC itself for
full legal notices. "
REVISION "200409020000Z" -- 2nd September 2004
DESCRIPTION " Initial version, published as RFC 3873"
::= { mib-2 104 }
-- the SCTP base variables group
sctpObjects OBJECT IDENTIFIER ::= { sctpMIB 1 }
sctpStats OBJECT IDENTIFIER ::= { sctpObjects 1 }
sctpParams OBJECT IDENTIFIER ::= { sctpObjects 2 }
-- STATISTICS
-- **********
-- STATE-RELATED STATISTICS
sctpCurrEstab OBJECT-TYPE
SYNTAX Gauge32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of associations for which the current state is
either ESTABLISHED, SHUTDOWN-RECEIVED or SHUTDOWN-PENDING."
REFERENCE
"Section 4 in RFC2960 covers the SCTP Association state