Network Working Group M. Greene Request for Comments: 2320 Xedia Corp. Category: Standards Track J. Luciani Bay Networks, Inc. K. White IBM Corp. T. Kuo Bay Networks, Inc. April 1998 Definitions of Managed Objects for Classical IP and ARP Over ATM Using SMIv2 (IPOA-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 (1998). All Rights Reserved. Abstract The purpose of this memo is to define the Management Information Base (MIB) for supporting Classical IP and ARP over ATM as specified in Classical IP and ARP over ATM, refer to reference [3]. Support of an ATM interface by an IP layer will require implementation of objects from several Management Information Bases (MIBs) as well as their enhancement in order to enable usage of ATM transports. It is the intent of this MIB to fully adhere to all prerequisite MIBs unless explicitly stated. Deviations will be documented in corresponding conformance statements. The specification of this MIB will utilize the Structure of Management Information (SMI) for Version 2 of the Simple Network Management Protocol Version (refer to RFC 1902, reference [1]). Greene, et al. [Page 1] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 Table of Contents 1. Introduction............................................. 2 2. The SNMPv2 Network Management Framework.................. 3 2.1 Object Definitions...................................... 4 3. Structure of the MIB..................................... 4 3.1 Basic Support MIB Definitions........................... 5 3.1.1 ATM Logical IP Subnet (LIS) Table..................... 5 3.1.2 ATM Logical IP Subnet Interface Mapping Table......... 7 3.1.3 ATMARP Remote Server Table............................ 7 3.1.4 ATM VC Table.......................................... 8 3.1.5 ATM Config PVC Table.................................. 9 3.1.6 Notifications......................................... 10 3.2 Client Supported MIB Definitions........................ 10 3.2.1 ATMARP Client Table................................... 11 3.3 Server Supported MIB Definitions........................ 12 3.3.1 ATMARP Server Table................................... 12 3.3.2 Notifications......................................... 13 4. Definitions.............................................. 14 5. Security Considerations.................................. 48 6. Intellectual Property.................................... 49 7. Acknowledgments.......................................... 49 8. References............................................... 50 9. Authors' Addresses....................................... 51 10. Full Copyright Statement................................ 52 1. Introduction This document is a product of the Internetworking Over NBMA Working Group. Its purpose is to define a MIB module for extending the traditional MIBs supported by a TCP/IP implementation to support Classical IP and ARP over ATM. Many MIB related RFCs and Internet Drafts have been considered in the development of this document. The ones that are considered central to the extensions defined by this document are: o RFC 2011 - SNMPv2 Management Information Base for the Internet Protocol using SMIv2 [9]. The IP over ATM (IPOA) MIB provides extensions to the IP Group for handling IP over ATM flows. A basic understanding of the IP Group is essential for understanding this document. Greene, et al. [Page 2] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 o RFC 2233 - The Interfaces Group MIB (IF-MIB) using SMIv2, reference [2]. This document is important since it provides several very useful enhancements over the interface group defined in RFC 1213 (reference [5]) that aid in handling ATM related interfaces. o RFC 1695 - Definitions of Managed Objects for ATM Management [4] (ATM-MIB). Support of this MIB is REQUIRED for implementing the layers between AAL5 and ATM. The contents of this MIB will not explicitly be addressed here. The ATM-MIB provides a basis for managing ATM interface layering and management of: - ATM Switched Virtual Connections (SVCs) - ATM Permanent Virtual Connections (PVCs) The ATM Forum UNI ILMI MIB is specified by the ATM Forum in various versions of the UNI specification. The ILMI MIBs being defined are not supported via SNMP agents but via SNMP requests sent over an ATM network to an ATM entity encapsulated in an AAL5 header. Support of the ILMI MIB(s) is considered out of the scope of this document. 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 RFC 2119, reference [10]. 2. The SNMPv2 Network Management Framework The SNMPv2 Network Management Framework consists of seven major components. They are: o RFC 1902 [1] which defines the SMI, the mechanisms used for describing and naming objects for the purpose of management. o RFC 1903 [6] defines textual conventions for SNMPv2. o RFC 1904 [8] defines conformance statements for SNMPv2. o RFC 1905 [7] defines transport mappings for SNMPv2. o RFC 1906 [12] defines the protocol operations used for network access to managed objects. o RFC 1907 [13] defines the Management Information Base for SNMPv2. o RFC 1908 [14] specifies coexistence between SNMPv1 and SNMPv2. Greene, et al. [Page 3] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 The Framework permits new objects to be defined for the purpose of experimentation and evaluation. This memo specifies a MIB module that is compliant to the SNMPv2 SMI. A semantically identical MIB conforming to the SNMPv1 SMI can be produced through the appropriate translation. 2.1. Object Definitions Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. Objects in the MIB are defined using the subset of Abstract Syntax Notation One (ASN.1) defined in the SMI. In particular, each object type is named by an OBJECT IDENTIFIER, an administratively assigned name. The object type together with an object instance serves to uniquely identify a specific instantiation of the object. For human convenience, we often use a textual string, termed the descriptor, to refer to the object type. 3. Structure of the MIB The Classical ARP and IP over ATM (IPOA) MIB structure is split into three components: o Basic Support MIB Definitions o Client Supported MIB Definitions o Server Supported MIB Definitions All IP and ARP over ATM entities, both clients and ATMARP Servers, are REQUIRED to support the MIB definitions in the Basic Support MIB Definitions section. Clients need to additionally support the MIB definitions outlined in the Client specific section and ATMARP Servers MUST additionally support the ATMARP Server specific MIB definitions. Implementation of the Definitions of Managed Objects for ATM Management [4] defines the modeling of the various layers within an ATM Interface. This modeling is assumed as a prerequisite for the IPOA-MIB. The IPOA-MIB makes no assumptions on how this layering is actually implemented within a system. Several of the MIB tables defined by the IPOA-MIB, like the base TCP/IP MIBs, require that an ifIndex exist that points to an ATM Interface. Refer to the ATM-MIB [4] for the definition of ATM Interface layering. The use of an IP over ATM Virtual Interface layer is NOT explicitly REQUIRED by the IPOA-MIB. The use of virtual layers above an ATM-MIB defined interface layer is not absolutely necessary for modeling the Greene, et al. [Page 4] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 attachment of IP to an ATM network. The IPOA-MIB refers to use of a generic ifIndex object, whose value SHOULD reflect that of some specific ATM related interface as determined by an implementation. It is up to the implementers of this MIB to determine their own ATM interface layering (assuming compliance with the IF-MIB and the ATM- MIB). The Internet Assigned Numbers Authority (IANA) ifType ipOverAtm(114) was created for use by systems that require a virtual IP over ATM interface layer. The IF-MIB's ifStackTable SHOULD be used to show the relationship between virtual IP over ATM interfaces and the actual ATM physical interface layers. The current set of ifType values can be accessed via the IANA homepage at: "http://www.iana.org/iana/". 3.1. Basic Support MIB Definitions Basic support that MUST be implemented by both Clients and ATMARP Servers consists of: o ATM Logical IP Subnet (LIS) Table o ATM Logical IP Subnet Interface Mapping Table o ATMARP Remote Server Table o ATM VC Table o ATM Config PVC Table o Notifications 3.1.1. ATM Logical IP Subnet (LIS) Table The ATM Logical IP Subnet (LIS) Table defines the subnets that this system is a member of for purposes of reaching destinations over an ATM transport. The LIS table is indexed by the subnet address (ipoaLisSubnetAddr) and not ifIndex. The ipoaLisIfMappingTable described in the next section provides the mapping between Logical IP Subnets and the interface layer. It is possible that the same LIS can be reached via different ATM interfaces. The ipAddrTable and the ipoaClientTable provides the mapping from a local IP address to an ATM interface. One or more ipAddrTable entries can point to the same ipoaLisEntry. An ipAddrEntry's ipAdEntAddr ANDed with its ipAdEntNetMask SHOULD equal an ipoaLisEntry's ipoaLisSubnetAddr. Given that an interface can be multi-homed, each local IP address associated with an interface requires an entry in the ipAddrTable. Each ipAddrTable entry for a local IP address associated with an ATM interface SHOULD map to an entry in the ipoaLisTable. Greene, et al. [Page 5] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 The bulk of the objects in an ipoaLisEntry exists to control ATMARP for a particular LIS. In a PVC only environment it is implementation dependent as to whether this table should be supported: ipoaLisInactivityTimer ipoaLisMinHoldingTime ipoaLisQDepth ipoaLisMaxCalls ipoaLisCacheEntryAge ipoaLisRetries ipoaLisTimeout The value of an ipoaLisMaxCalls object defines the maximum number of VCs that can be established simultaneously per LIS. The value of an ipoaLisDefaultPeakCellRate object defines the best effort default peak cell rate in both the forward and backward directions when establishing VCCs (Virtual Channel Connections). Refer to RFC 1755, ATM Signaling Support for IP over ATM (reference [11]), for a definition of the use of this object's value. The ipAddrTable's ipAdEntReasmMaxSize is the "The size of the largest IP datagram which this entity can re-assemble from incoming IP fragmented datagrams received on this interface" and is different from the ipoaLisTable's ipoaLisDefaultMtu with is the default MTU used within an LIS. Note that this is the default MTU, not the actual MTU (which is represented as ipoaVcNegotiatedMtu in the ipoaVcTable). The ipoaLisRowStatus object enables entries in the ipoaLisTable to be created or deleted via SNMP. Creation of an ipoaLisTable entry results in the addition of a corresponding ipAddrTable entry and an ipoaLisIfMappingTable entry. Creation of multiple ipAddrTable entries and ipoaLisIfMappingTable entries for the same LIS is not addressed by this document. When ipoaLisRowStatus is changed from active(1) to notInService(2) or from active(1) to destroy(6), this has the side- effect of removing all entries from the ipNetToMediaTable that are associated with this LIS (in other words, it flushes the entity's ATMARP cache). It also removes the ipoaVcTable entries that were associated with those ipNetToMediaTable entries. Destroying the row removes the corresponding entries in the ipoaArpSrvrTable, ipoaArpClientTable, ipoaLisIfMappingTable, and the ipoaArpRemoteSrvrTable. Entries in both the ipNetToMediaTable and the ipoaVcTable that are associated with an ipoaConfigPvcEntry are not affected by changes to ipoaLisRowStatus. Greene, et al. [Page 6] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 3.1.2. ATM Logical IP Subnet Interface Mapping Table The ipoaLisIfMappingTable maps a LIS to all ATM interfaces from which it is configured to be supported. Each entry in the ipoaLisIfMappingTable SHOULD map to an ipAddrTable entry. It is also possible for a system, most commonly a switch, to have multiple LISs associated with the same ATM interface. 3.1.3. ATMARP Remote Server Table Entries in the ipoaArpRemoteSrvrTable exists to locally configure the remote ATMARP Servers that exist on a per LIS and interface basis. Classical IP and ARP over ATM [3] requires that at least one ATMARP Server be configured per LIS where SVC traffic is intended. PVC usage doesn't require use of ATMARP. No ipoaArpRemoteSrvrTable entries SHOULD be configured for a LIS where only PVCs will be used. An entry in the ipoaArpRemoteSrvrTable is indexed by the subnet address of the LIS (ipoaLisSubnetAddr), the ATM address of the remote ATMARP Server (ipoaArpRemoteSrvrAtmAddr) and an interface ifIndex (ipoaArpRemoteSrvrIfIndex) value. The object ipoaArpRemoteSrvrIpAddr in an ipoaArpRemoteSrvrEntry is set with the IP Address of the Remote ATMARP Server when a VC to the Remote ATMARP Server is established. A value of 0.0.0.0 SHOULD be used when the IP address of the Remote ATMARP Server is not known. Once ipoaArpRemoteSrvrIpAddr is set then the ipoaVcTable can be searched using ipoaArpRemoteSrvrIfIndex and ipoaArpRemoteSrvrIpAddr to find the VC in use to the Remote ATMARP Server. ipoaArpRemoteSrvrIfIndex is defined to have the textual convention of InterfaceIndexOrZero. Adding ipoaArpRemoteSrvrIfIndex to the index clause allows a system to have a VC to a ATMARP Remote Server on a per LIS and interface basis. An entry in this table SHOULD exist for each interface on a per LIS basis. Each interface would then have a separate VC to the Remote ATMARP Server for ATMARP purposes. An implementation that wants to use a single VC MAY use an ipoaArpRemoteSrvrIfIndex value of 0 when configuring an ipoaArpRemoteSrvrEntry for the associating LIS. If ipoaArpRemoteSrvrIfIndex is 0 then an implementation dependent method MAY be used for finding the VPI and VCI of the VC in use to the Remote ATMARP Server. For example, search the ipoaVcTable for a match between ipNetToMediaNetAddress and ipoaArpRemoteSrvrIpAddr from an ipoaArpRemoteSrvrEntry, ignoring ipNetToMediaIfIndex. Since a single VC is being used the first match SHOULD correspond to the correct VC. Greene, et al. [Page 7] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 If a PVC is intended to be used to communicate with a remote ATMARP Server then the ipoaConfigPvcTable MUST be used to create and activate the PVC prior to activating a ipoaArpRemoteSrvrEntry. The object ipoaArpRemoteSrvrRowStatus allows for row creation and deletion of entries in the ipoaArpRemoteSrvrTable. The objects ipoaArpRemoteSrvrAdminStatus and ipoaArpRemoteSrvrOperStatus exist to control and reflect the operational use of a Remote ATMARP Server defined by an ipoaArpRemoteSrvrEntry. The object ipoaArpRemoteSrvrOperStatus SHOULD have a value of up(1) when an SVC has been established to the Remote ATMARP Server or if using a PVC when the InATMARP reply with the IP Address of the Remote ATMARP Server has been received. The value of down(2) SHOULD be used to indicate that a VC to the Remote ATMARP Server doesn't exist. 3.1.4. ATM VC Table An entry in the ipoaVcTable SHOULD have at least one corresponding ipNetToMediaTable entry. Both tables use the ipNetToMediaTable's indexes ipNetToMediaIfIndex and ipNetToMediaNetAddress. The ipoaVcTable has the additional indexes ipoaVcVpi and ipoaVcVci. An ipoaVcEntry exists for every VC per ATM interface per destination IP address. Refer to the following diagram that illustrates the relationship between ipoaVcTable and the ipNetToMediaTable: ipoaVcTable ipNetToMediatable ------------------------------ ---------------------------- | ipNetToMediaIfIndex | | ipNetToMediaIfIndex | | ipNetToMediaNetAddress | | ipNetToMediaNetAddress | | ipoaVcVpi | | | | ipoaVcVci | | | | ipoaVcType | | | | ---> use IpoaAtmAddr TC | | ipNetToMediaPhysAddress | | ipoaVcNegotiatedEncapsType | | | | ipoaVcNegotiatedMtu | | | | | | ipNetToMediaType | ------------------------------ ---------------------------- ipoaVcType indicates if the entry is for an SVC or a PVC. An ipoaVcEntry, corresponding to an PVC, is created automatically when an ipoaConfigPvcEntry is created and the IP Address at the end of the PVC is discovered. The associating ipNetToMediaTable entry would have its ipNetToMediaType set to static(4). ipNetToMediaTable entries created during ATMARP processing have a ipNetToMediaType of dynamic(3). The process to locally configuring an ipNetToMediaTable entry and an ipoaVcTable entry for an SVC without using ATMARP is not within the scope of this document. Greene, et al. [Page 8] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 The objects ipoaVcVpi and ipoaVcVci are defined to have a MAX-ACCESS of not-accessible since they are only used for purposes of indexing an entry in the ipoaVcTable. 3.1.5. ATM Config PVC Table An entry in the ipoaVcTable is created after the InATMARP reply is successfully received for an ipoaConfigPvcEntry during its activation. InATMARP should return the IP Address of the other end of the PVC in order to have the needed indexes to create an ipNetToMediaEntry and an ipoaVcEntry. The corresponding ARP Cache entry SHOULD be deleted whenever a PVC becomes unusable. A Network Management Station wanting to create a PVC at a particular system for use as an IP transport would: o use the ATM-MIB, reference [4], to create the PVC o use the ipoaConfigPvcTable in the IPOA-MIB to configure the PVC for use by IP Refer to the following diagram that illustrates the relationship between the ipoaVcTable and the ipoaConfigPvcTable: ipoaVcTable ipoaConfigPvcTable ------------------------------ ---------------------------- | ipNetToMediaIfIndex | | ipNetToMediaIfIndex | | ipNetToMediaNetAddress | | | | ipoaVcVpi | | ipoaConfigPvcVpi | | ipoaVcVci | | ipoaConfigPvcVci | | ipoaVcType | | | | | | ipoaConfigPvcDefaultMtu | | ipoaVcNegotiatedEncapsType | | | | ipoaVcNegotiatedMtu | | | | | | ipoaConfigPvcRowStatus | ------------------------------ ---------------------------- When the ipoaVcEntry is created its ipoaVcType will be set to pvc(1), its ipoaVcNegotiatedEncapsType set to llcSnap(1), and its ipoaVcNegotiatedMtu set to 9180 octets by default. Classical IP and ARP over ATM [3] allows use of other MTU values for PVCs but considers the selection of a value other than 9180 to be out of scope. ipoaConfigPvcDefaultMtu can be used to configure the MTU to be used for the PVC. Both ends MUST have the same value configured. The associating ipNetToMediaTable entry would have its ipNetToMediaType set to static(4). Greene, et al. [Page 9] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 Changing ipoaConfigPvcRowStatus from active(1) to notInService(2) or from active(1) to destroy(6) has the side-effect of removing the corresponding ipNetToMediaTable, ipoaVcTable, and ipoaConfigPvcTable entries. 3.1.6. Notifications Both ATM clients and ATMARP Servers MUST support generation of an ipoaMtuExceeded notification. 3.2. Client Supported MIB Definitions The ATMARP Client Table is the only additional MIB table that a client MUST implement. Greene, et al. [Page 10] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 3.2.1. ATMARP Client Table An entry in the ipoaArpClientTable SHOULD have a corresponding ipAddrTable entry where both are indexed by the same ipAdEntAddr value. Refer to the following diagram that illustrates the relationship between ipoaArpClientTable and ipAddrTable entries: ipoaArpClientTable ipAddrTable ----------------------------------- ------------------------ | ipAdEntAddr | | ipAdEntAddr | | | | ipAdEntNetMask | | | | ipAdEntIfIndex | | ipoaArpClientAtmAddr | | | | ipoaArpClientSrvrInUse | | | | ipoaArpClientInArpInReqs | | | | ipoaArpClientInArpOutReqs | | | | ipoaArpClientInArpInReplies | | | | ipoaArpClientInArpOutReplies | | | | ipoaArpClientInArpInvalidInReqs | | | | ipoaArpClientInArpInvalidOutReqs| | | | ipoaArpClientArpInReqs | | | | ipoaArpClientArpOutReqs | | | | ipoaArpClientArpInReplies | | | | ipoaArpClientArpOutReplies | | | | ipoaArpClientArpInNaks | | | | ipoaArpClientArpOutNaks | | | | ipoaArpClientArpUnknownOps | | | | ipoaArpClientArpNoSrvrResps | | | | ipoaArpClientRowStatus | | | | | | ipAdEntBcastAddr | | | | ipAdEntReasmMaxSize | ----------------------------------- ------------------------ Both tables have the same index, ipAdEntAddr. The ipAddrTable's ipAdEntNetMask when ANDed with its corresponding ipAdEntAddr yield the subnet of the LIS which can be used as an index into the ipoaLisTable (ipoaLisSubnetAddr). The ipAddrTable's ipAdEntIfIndex points to an interface ifTable entry via an ifIndex value. The attachment point for IP into an ATM network is via an ATM interface's ifIndex. Each ipoaArpClientEntry MUST point to an ATM interface via its corresponding ipAddrEntry. ipoaArpClientAtmAddr is the local ATM address associated with the corresponding ATM ifTable entry. ipoaArpClientSrvrInUse is the ATM address of the ATMARP Server being used for a particular client. If SVCs are not being used then the value of this object is a zero-length OCTET STRING. Greene, et al. [Page 11] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 It is sometimes possible for a system to have multiple IP addresses configured within the same IP subnet. The indexing of this table would seem to preclude that. However, it is possible to have additional entries in the ipAddrTable with the same ifIndex and with the same subnet address. The mechanism for adding these multiple entries to the ipAddrTable (which is read-only) is beyond the scope of this document. The counter object ipoaArpClientInArpInvalidInReqs is "The number of times that this client detected an invalid InATMARP request." This object SHOULD be incremented when processing fails for an InATMARP request (e.g., for incorrect InATMARP request structure fields). The object ipoaArpClientInArpInvalidOutReqs is defined as "The number of times that this client did not receive an InATMARP reply." This is different from ipoaArpClientArpNoSrvrResps which counts the number of times no response was received from an ATMARP request. InATMARP retransmission processing is not controlled by objects in the ipoaLisTable. In general, the ipoaLisTable objects relate to ATMARP Server processing. Configuration of InATMARP retransmission processing is considered to be implementation dependent and not defined by the IPOA-MIB. Implementations SHOULD use local policy for defining both InATMARP timeout and retry count values. This policy would be expected to differ for sending an InATMARP Request over a PVC as opposed to an SVC. For transmission of an InATMARP Request over a SVC a timeout of 60 seconds with a retry count of 3 is suggested. InATMARP transmission over a PVC should differ since its retry limit may need to be infinite in order to ensure that InATMARP Request processing eventually occurs. 3.3. Server Supported MIB Definitions ATMARP Servers MUST support: o ATMARP Server Table o Notifications as defined in the following sections. This table exists only on a system where at least one ATMARP Server is present. 3.3.1. ATMARP Server Table This table defines the list of ATMARP Servers within a LIS. Each entry of the table defines each ATMARP Server's ATM address, the LIS it is a member of, and various InATMARP and ATMARP statistics. Greene, et al. [Page 12] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 An entry in this table provides information about an ATMARP Server within a LIS and is indexed by ipAdEntAddr (a local IP Address from an IP Address Table entry) and ipoaArpSrvrAddr (an ATM Address associated with the ATMARP Server). Entries MAY be created by a management application using the ipoaArpSrvrRowStatus object. Entries in this table MAY also be created by the system and not by a management application, for example via ILMI. Entries in this table MAY be deleted by setting the ipoaArpSrvrRowStatus object to destroy(6). This includes entries that were added by the system and not by a management application. On a host that supports multiple ATMARP Servers where the local IP address being associated with each ATMARP Server is the same (for example a non-multihomed host), the ATM Address (ipoaArpSrvrAddr) uniquely identifies a particular ATMARP Server. On a host supporting multiple ATMARP Servers having a single ATM Interface with a single ATM Address, the ipAdEntAddr MUST be used to uniquely identify an entry in the ipoaArpSrvrTable. The indexing of the ipoaArpSrvrTable does not allow entries with the same or no local IP Address (ipAdEntAddr) and the same ATM Address (ipoaArpSrvrAddr) to exist. The values of the index elements when combined to index a row must be unique. 3.3.2. Notifications An ATMARP Server MUST support the following notifications: o ipoaDuplicateIpAddress o ipoaLisCreate o ipoaLisDelete Generation of ipoaLisCreate and ipoaLisDelete notifications is controlled by the ipoaLisTrapEnable object. These notifications indicate when an ipoaLisEntry is either created or deleted. The purpose of these notifications is to enable Network Management Applications to dynamically discover the existence of ATMARP Server LIS participation in order to eventually determine LIS composition via subsequent SNMP queries. It is permissible for an ATM client-only system to support the ipoaLisTrapEnable object and generate ipoaLisCreate and ipoaLisDelete notifications. Greene, et al. [Page 13] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 4. Definitions IPOA-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, transmission, Integer32, IpAddress, Counter32, Gauge32 FROM SNMPv2-SMI TEXTUAL-CONVENTION, RowStatus FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF ipNetToMediaNetAddress, ipNetToMediaIfIndex, ipNetToMediaPhysAddress, ipAdEntAddr FROM IP-MIB -- The following textual conventions are defined locally within -- this MIB module. They have been prefixed with 'Ipoa' to -- distinguish them from their counterparts in the ATM-TC-MIB. -- This was done so that the IPOA-MIB could be advanced as -- a standards-based MIB without waiting for the ATM-TC-MIB. -- AtmConnKind, AtmAddr -- FROM ATM-TC-MIB InterfaceIndex, InterfaceIndexOrZero FROM IF-MIB ; ipoaMIB MODULE-IDENTITY LAST-UPDATED "9802090000Z" -- February 9, 1998 ORGANIZATION "IETF Internetworking Over NBMA Working Group (ion)" CONTACT-INFO "Maria Greene (greene@xedia.com) Xedia Corp. Jim Luciani (jluciani@BayNetworks.com) Bay Networks Kenneth White (kennethw@vnet.ibm.com) IBM Corp. Ted Kuo (tkuo@eos.ncsu.edu) Bay Networks" DESCRIPTION "This module defines a portion of the management Greene, et al. [Page 14] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 information base (MIB) for managing Classical IP and ARP over ATM entities." ::= { transmission 46 } -- Textual Conventions IpoaEncapsType ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "The encapsulation type used on a VC." SYNTAX INTEGER { llcSnap(1), vcMuxed(2), other(3) } IpoaVpiInteger ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "An integer large enough to contain the value of a VPI." SYNTAX Integer32 (0..255) IpoaVciInteger ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "An integer large enough to contain the value of a VCI." SYNTAX Integer32 (0..65535) IpoaAtmAddr ::= TEXTUAL-CONVENTION DISPLAY-HINT "1x" STATUS current DESCRIPTION "The ATM address used by the network entity. The semantics are implied by the length. The address types are: - no address (0 octets) - E.164 (8 octets) - NSAP (20 octets) In addition, when subaddresses are used IpoaAtmAddr may represent the concatenation of address and subaddress. The associated address types are: - E.164, E.164 (16 octets) - E.164, NSAP (28 octets) - NSAP, NSAP (40 octets) Greene, et al. [Page 15] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 Address lengths other than defined in this definition imply address types defined elsewhere. Note: The E.164 address is encoded in BCD format." SYNTAX OCTET STRING (SIZE(0..40)) IpoaAtmConnKind ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "The use of call control. The use is as follows: pvc(1) Virtual link of a PVC. Should not be used in a PVC/SVC (i.e., SPVC) crossconnect. svcIncoming(2) Virtual link established after a received signaling request to setup an SVC. svcOutgoing(3) Virtual link established after a transmitted or forwarded signaling request to setup an SVC. spvcInitiator(4) Virtual link at the PVC side of an SVC/PVC crossconnect, where the switch is the initiator of the SPVC setup. spvcTarget(5) Virtual link at the PVC side of an SVC/PVC crossconnect, where the switch is the target of the SPVC setup. An spvcInitiator is always cross-connected to an svcOutgoing, and an spvcTarget is always cross-connected to an svcIncoming." SYNTAX INTEGER { pvc(1), svcIncoming(2), svcOutgoing(3), spvcInitiator(4), spvcTarget(5) } -- Top-level structure of the MIB ipoaObjects OBJECT IDENTIFIER ::= { ipoaMIB 1 } ipoaNotifications OBJECT IDENTIFIER ::= { ipoaMIB 2 } ipoaConformance OBJECT IDENTIFIER ::= { ipoaMIB 3 } Greene, et al. [Page 16] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 -- MIB Objects ipoaLisTrapEnable OBJECT-TYPE SYNTAX INTEGER { enabled(1), disabled(2) } MAX-ACCESS read-write STATUS current DESCRIPTION "Indicates whether ipoaLisCreate and ipoaLisDelete traps should be generated by this system. By default, this object should have the value enabled(1) for systems where ATMARP Servers are present and disabled(2) on systems where only clients reside." ::= { ipoaObjects 1 } -- The ATM Logical IP Subnet (LIS) Table ipoaLisTable OBJECT-TYPE SYNTAX SEQUENCE OF IpoaLisEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "There is one entry in this table for every Logical IP Subnet (LIS) of which this system is a member. The bulk of the objects in an ipoaLisEntry exists to control ATMARP for a particular LIS. In a PVC only environment it is implementation dependent as to whether this table should be supported." ::= { ipoaObjects 2 } ipoaLisEntry OBJECT-TYPE SYNTAX IpoaLisEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Information about a single LIS of which this system is a member. Membership in a LIS is independent of the actual ATM interfaces being used. The ipoaLisTable defines all LISs that a system is a member of. The ipAddrTable and the ipoaClientTable provides the mapping from local IP address to ATM interface. The ipoaLisIfMappingTable provides the mappings between Logical IP Subnets and interfaces. Greene, et al. [Page 17] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 The ipoaLisTable is indexed by ipoaLisSubnetAddr (IP subnet address). An entry in the ipoaLisTable should exist for each ipAddrEntry that is associated with an ATM related interface used for Classical IP and ARP over ATM traffic. Its ipAdEntAddr and ipAdEntNetMask when ANDed together should equal the ipoaLisSubnetAddr of the corresponding ipoaLisEntry." INDEX { ipoaLisSubnetAddr } ::= { ipoaLisTable 1 } IpoaLisEntry ::= SEQUENCE { ipoaLisSubnetAddr IpAddress, ipoaLisDefaultMtu Integer32, ipoaLisDefaultEncapsType IpoaEncapsType, ipoaLisInactivityTimer Integer32, ipoaLisMinHoldingTime Integer32, ipoaLisQDepth Integer32, ipoaLisMaxCalls Integer32, ipoaLisCacheEntryAge Integer32, ipoaLisRetries Integer32, ipoaLisTimeout Integer32, ipoaLisDefaultPeakCellRate Integer32, ipoaLisActiveVcs Gauge32, ipoaLisRowStatus RowStatus } ipoaLisSubnetAddr OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The IP subnet address associated with this LIS." ::= { ipoaLisEntry 1 } ipoaLisDefaultMtu OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The default MTU used within this LIS. Note that the actual MTU used for a VC between two members of the LIS may be negotiated during connection setup and may be different than this value. The ipoaVcNegotiatedMtu object indicates the actual MTU in use for a particular VC." DEFVAL { 9180 } Greene, et al. [Page 18] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 ::= { ipoaLisEntry 2 } ipoaLisDefaultEncapsType OBJECT-TYPE SYNTAX IpoaEncapsType MAX-ACCESS read-create STATUS current DESCRIPTION "The default encapsulation to use on VCs created for this LIS. Note that the actual encapsulation type may be negotiated during connection setup and may be different than this value. The ipoaVcNegotiatedEncapsType object indicates the actual encapsulation in use for a particular VC." DEFVAL { llcSnap } ::= { ipoaLisEntry 3 } ipoaLisInactivityTimer OBJECT-TYPE SYNTAX Integer32 UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The time, in seconds, before a call established for an ipNetToMediaEntry on a client will timeout due to no traffic being passed on the VC. A value of 0 implies no time out." REFERENCE "RFC 1755, Sec. 3.4 VC Teardown" DEFVAL { 1200 } ::= { ipoaLisEntry 4 } ipoaLisMinHoldingTime OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The minimum amount of time, in seconds, that a call will remain open. If 0 then ipoaInactivityTimer will completely determine when a call is terminated." REFERENCE "RFC 1755, Sec. 3.4 VC Teardown" DEFVAL { 60 } ::= { ipoaLisEntry 5 } ipoaLisQDepth OBJECT-TYPE SYNTAX Integer32 (1..65535) UNITS "packets" Greene, et al. [Page 19] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 MAX-ACCESS read-create STATUS current DESCRIPTION "The maximum number of outstanding requests that are allowed while waiting for ATMARP replies and InATMARP replies for this LIS." DEFVAL { 1 } ::= { ipoaLisEntry 6 } ipoaLisMaxCalls OBJECT-TYPE SYNTAX Integer32 (1..65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The maximum number of SVCs that can be established simultaneously for this LIS." DEFVAL { 500 } ::= { ipoaLisEntry 7 } ipoaLisCacheEntryAge OBJECT-TYPE SYNTAX Integer32 (60..1200) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The time, in seconds, before an ipNetToMediaEntry will age out of the table. Note that the default value will be different for a client and a server. An ATMARP Server should use a default of 1200 and a client should use 900." DEFVAL { 900 } ::= { ipoaLisEntry 8 } ipoaLisRetries OBJECT-TYPE SYNTAX Integer32 (0..10) MAX-ACCESS read-create STATUS current DESCRIPTION "The number of times the ATMARP request will be retried when no response is received in the timeout interval indicated by ipoaLisTimeout." DEFVAL { 2 } ::= { ipoaLisEntry 9 } ipoaLisTimeout OBJECT-TYPE SYNTAX Integer32 (1..60) UNITS "seconds" MAX-ACCESS read-create Greene, et al. [Page 20] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 STATUS current DESCRIPTION "The time to wait, in seconds, before retransmission of an ARP request." DEFVAL { 10 } ::= { ipoaLisEntry 10 } ipoaLisDefaultPeakCellRate OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "This object is the signalling parameter that should be used when setting up all best effort VCCs (Virtual Channel Connections). This parameter applies to the forward and backward direction on a per best effort VCC basis. A value of zero implies that no configured default exists and that local policy should be used to determine the actual default to used during call setup. ATM Signaling Support for IP over ATM (RFC 1755) recommends 1/10th of the ATM interface's speed." ::= { ipoaLisEntry 11 } ipoaLisActiveVcs OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of active SVCs for this LIS." ::= { ipoaLisEntry 12 } ipoaLisRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object allows entries to be created and deleted in the ipoaLisTable. When the ipoaLisRowStatus deleted (by setting this object to destroy(6)), this has the side-effect of removing all entries from the ipNetToMediaTable that are associated with this LIS (in other words, it flushes the entity's ATMARP cache). It also removes the ipoaVcTable entries that were associated with those ipNetToMediaTable entries. Destroying the row also Greene, et al. [Page 21] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 removes the corresponding entries in the ipoaArpSrvrTable, ipoaArpClientTable, ipoaLisIfMappingTable, and ipoaArpRemoteSrvrTable. Entries in both the ipNetToMediaTable and the ipoaVcTable that are associated with a ipoaConfigPvcEntry are not affected by changes to ipoaLisRowStatus." REFERENCE "RFC 1903, 'Textual Conventions for Version 2 of the Simple Network Management Protocol (SNMPv2).'" ::= { ipoaLisEntry 13 } -- The ATM Logical IP Subnet Interface Mapping Table ipoaLisIfMappingTable OBJECT-TYPE SYNTAX SEQUENCE OF IpoaLisIfMappingEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "There is one entry in this table for every combination of ipoaLisEntry and IP over ATM interface." ::= { ipoaObjects 3 } ipoaLisIfMappingEntry OBJECT-TYPE SYNTAX IpoaLisIfMappingEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the ipoaLisIfMappingTable." INDEX { ipoaLisSubnetAddr, ipoaLisIfMappingIfIndex } ::= { ipoaLisIfMappingTable 1 } IpoaLisIfMappingEntry ::= SEQUENCE { ipoaLisIfMappingIfIndex InterfaceIndex, ipoaLisIfMappingRowStatus RowStatus } ipoaLisIfMappingIfIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS not-accessible STATUS current DESCRIPTION "The ipAdEntIfIndex object from an ipAddrEntry is used as an index to this table when its ipAdEntAddr is in the subnet implied by ipoaLisSubnetAddr." Greene, et al. [Page 22] RFC 2320 IP and ARP over ATM (IPOA) MIB April 1998 ::= { ipoaLisIfMappingEntry 1 } ipoaLisIfMappingRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object allows entries to be created and deleted in the ipoaLisIfMappingTable." REFERENCE "RFC 1903, 'Textual Conventions for Version 2 of the Simple Network Management Protocol (SNMPv2).'" ::= { ipoaLisIfMappingEntry 2 } -- The ATMARP Client Table ipoaArpClientTable OBJECT-TYPE SYNTAX SEQUENCE OF IpoaArpClientEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The ATMARP clients running on this system." ::= { ipoaObjects 4 } ipoaArpClientEntry OBJECT-TYPE SYNTAX IpoaArpClientEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Information about a single ATMARP Client. Clients can be started and stopped by adding and removing entries from this table. An entry in the ipoaArpClientTable has a corresponding entry in the ipAddrTable. Both are indexed by ipAdEntAddr. The ifIndex and subnet mask of a client entry are the ipAddrEntry's ipAdEntIfIndex and ipAdEntNetMask, respectively. Note that adding and removing entries from this table may have the same effect on the corresponding ipAddrTable entry. Row creation of an entry in this table requires that either the corresponding ipAddrTable entry exists or that ipAdEntIfIndex and ipAdEntNetMask be specified in the creation of an ipoaArpClientEntry at a minimum in order to create the corresponding ipAddrEntry. Specification of ipAdEntBcastAddr and ipAdEntReasmMaxSize to complete an ipAddrEntry is implementation dependent. Gr