Request for Comments: 4404 F5 Networks
Category: Standards Track A. Rijhsinghani
Accton Technology Corporation
February 2006
Definitions of Managed Objects for Fibre Channel Over TCP/IP (FCIP)
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 (2006).
Abstract
This memo defines a portion of the Management Information Base (MIB)
for use with network management protocols in TCP/IP-based internets.
In particular, it defines objects for managing Fibre Channel Over
TCP/IP (FCIP) entities, which are used to interconnect Fibre Channel
(FC) fabrics with IP networks.
Table of Contents
1. The Internet-Standard Management Framework ......................2
2. Overview of FCIP Management Model ...............................2
3. Relationship to Other MIBs ......................................4
4. MIB Definitions .................................................6
5. Security Considerations ........................................29
6. IANA Considerations ............................................30
7. Acknowledgements ...............................................30
8. Normative References ...........................................30
9. Informative References .........................................31
1. 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].
2. Overview of FCIP Management Model
Note that the Fibre Channel Over TCP/IP (FCIP) Entity is fully
described in [RFC3821] from a functional point of view. A collection
of multiple instances of FCIP Entities and the corresponding FC
Entities, described in [FCBB2], within an SNMP Context is referred to
as an FCIP device here. This section describes FCIP from a
management point of view.
+------------------------------------------+
| FCIP Device |
| |
| +-----------+ +-----------+ |
| |FCIP Entity| |FCIP Entity| |
| | | | | |
| | | | | |
| +--+--+--+--+ +--+--+--+--+ |
| | | | | | | |
| | | | | | | |
| FCIP Links FCIP Links |
| |
+------------------------------------------+
The FCIP device provides an IP-based interconnection model for
interconnecting FC fabric elements. In this model, the FCIP devices
along with the IP network on which they are running provide a new
FCIP transport network.
This IP-based FCIP Interconnection Model supports the following
topology:
o The FCIP-based transport network is formed by interconnecting the
FCIP devices.
o Each FCIP device has one or more FCIP Entities or Instances.
o Peer FCIP Entities are connected by FCIP Links attached to
VE_ports/B_Access.
o Each FCIP Link Endpoint contains one or more Data Engines.
o The FCIP device can work as a stand-alone box or as part of a FC
fabric element.
Each FCIP Entity managed by this MIB is referred to as an FCIP
Instance. The MIB is broken up as follows:
2.1. FCIP Entity Instances Table
The FCIP Entity table contains information about this entity’s
existing instances of FCIP entities.
2.2. FCIP Link Table
The FCIP link table contains information about this FCIP device’s
existing FCIP links.
2.3. FCIP TCP Connection Table
The FCIP TCP Connection table contains information about existing TCP
connections. Each FCIP link within an FCIP entity contains one or
more TCP connections. The FCIP entity employs a Data Engine for each
TCP connection for handling FC frame encapsulation, de-encapsulation,
and transmission of FCIP frames on the connection.
2.4. FCIP Dynamic Route Table
The FCIP dynamic route table contains routing information that is
dynamically discovered by this FCIP device. The FCIP device may use
the SLPv2 protocol [RFC3822] in conjunction with other protocols,
such as Fabric Shortest Path First (FSPF), to dynamically discover
other FCIP entities and populate this table to map destination
domains to FCIP Links.
2.5. FCIP Static Route Table
The FCIP static route table contains routing information that is
statically configured into this FCIP device by the Network Admin. In
the absence of dynamic discovery of remote FCIP entities, the Network
Manager can configure remote domains and FCIP Entities that are
reachable by this device into this table.
At any point in time, both the static and dynamic routing tables can
be active. If a DID is present in both tables, information in the
static route table will take precedence over the entry in the dynamic
route table for the same DID.
2.6. FCIP Discovery Domain Table
The FCIP Discovery Domain Table maps this device’s FCIP Entities into
FCIP Discovery Domains.
2.7. FCIP Link Error Table
The FCIP Link Errors Table contains counters that indicate error
conditions on an FCIP Link.
3. Relationship to Other MIBs
Objects accessible from other MIB modules applicable to FCIP devices
have not been included in this MIB module. The following subsections
list all applicable MIB modules that should be present with FCIP-
MGMT-MIB.
3.1. Relationship to the ’TCP’ Group
This group is mandatory for all systems that implement TCP. Objects
relevant to TCP must be obtained from this group [RFC4022].
3.2. Relationship to the ’interfaces’ MIB
The ’interfaces’ group is defined as being mandatory for all systems
and contains information on an entity’s interfaces. Each
logical/virtual interface created as an FCIP Link should be
represented as a row in the ifTable with a unique ifIndex value and a
value of ifType ’fcipLink’ (224) for each such interface. For a
complete list of interface types, refer to the IANA registry at
"http://www.iana.org/assignments/smi-numbers". These are the only
ifIndex values of relevance to an FCIP Entity because FCIP runs on
top of TCP/IP.
FCIP runs over TCP. Thus, by definition, there is no ifTable
interface directly beneath it, and so ifStackLowerLayer is always 0.
For any protocol using FCIP (i.e., above FCIP), FCIP appears to be a
regular FC interface. As stated in [RFC4044], a regular "FC
interface will typically have no other ifTable rows stacked on top of
it", and thus, ifStackHigherLayer is typically zero.
3.3. Relationship to the Fibre Channel Management MIB
The Fibre Channel Management MIB [RFC4044] is assumed for FC
functionality managed objects.
3.4. Specific Interface Group MIB Objects
The following table provides specific implementation guidelines for
applying the objects defined in the Interfaces Group MIB to FCIP
Links. For those objects not listed here, refer to their generic
definitions in [RFC2863].
Object Guidelines
ifType ’fcipLink’ (224)
ifSpeed The ifSpeed for the physical interface(s)
over which the FCIP Link runs.
ifPhysAddress There is no physical address corresponding
to an FCIP Link (only World Wide Name, WWN).
Reported as 0.
ifAdminStatus Write access is not required, and support
for ’testing’ is not required.
ifOperStatus Support for ’testing’ is not required.
The value ’dormant’ has no meaning for
FCIP Links.
ifInOctets The number of octets of FCIP information
ifHCInOctets contained in received frames in TCP
streams, starting with FCIP header.
ifInUcastPkts The number of FCIP frames received
ifHCInUcastPkts on this FCIP Link.
ifOutOctets The number of octets of FCIP information
ifHCOutOctets contained in transmitted frames in TCP
streams, starting with FCIP header.
ifOutUcastPkts The number of FCIP frames transmitted
ifHCOutUcastPkts on this FCIP Link.
ifInMulticastPkts These counters are not incremented.
ifInBroadcastPkts
ifOutMulticastPkts
ifOutBroadcastPkts
ifHCInMulticastPkts
ifHCInBroadcastPkts
ifHCOutMulticastPkts
ifHCOutBroadcastPkts
ifLinkUpDownTrapEnable Default is ’disabled’.
ifPromiscuousMode This will be ’false’.
ifConnectorPresent This will be ’false’.
4. MIB Definitions
The following MIB module has IMPORTS from [RFC2578], [RFC2579],
[RFC4001], [RFC4044], [RFC2863], [RFC2580], and [RFC3411]. In
REFERENCE clauses, it refers to [FC-SW-3], [RFC3821], [RFC2883],
[RFC1323], [RFC2474] and [RFC3822].
FCIP-MGMT-MIB DEFINITIONS ::= BEGIN
IMPORTS
OBJECT-TYPE,
MODULE-IDENTITY,
Unsigned32,
Counter32,
mib-2 FROM SNMPv2-SMI
TEXTUAL-CONVENTION,
TruthValue, RowStatus, TimeStamp FROM SNMPv2-TC
InetAddressType,
InetAddress,
InetPortNumber FROM INET-ADDRESS-MIB
FcNameIdOrZero FROM FC-MGMT-MIB
InterfaceIndex FROM IF-MIB
MODULE-COMPLIANCE,
OBJECT-GROUP FROM SNMPv2-CONF
SnmpAdminString FROM SNMP-FRAMEWORK-MIB;
fcipMIB MODULE-IDENTITY
LAST-UPDATED "200602060000Z"
ORGANIZATION "IETF IPFC Working Group"
CONTACT-INFO "Anil Rijhsinghani
Accton Technology Corporation
5 Mount Royal Ave
Marlboro, MA 01752 USA.
Ravi Natarajan
F5 Networks
2460 North First Street, Suite 100
San Jose, CA 95131 USA."
DESCRIPTION
"The module defines management information specific to
FCIP devices.
Copyright(C) The Internet Society (2006). This version
of this MIB module is part of RFC 4404; see the RFC
itself for full legal notices."
REVISION "200602060000Z"
DESCRIPTION
"Initial version of this module, published as RFC 4404."
::= { mib-2 224 }
fcipObjects OBJECT IDENTIFIER ::= { fcipMIB 1 }
fcipConformance OBJECT IDENTIFIER ::= { fcipMIB 2 }
fcipConfig OBJECT IDENTIFIER ::= { fcipObjects 1 }
-- ******************************************************************
-- Textual conventions
--
FcipDomainIdInOctetForm ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The Domain ID of a FC entity in octet form
to support the concatenation(000000h||Domain_ID)
format defined in the FSPF routing protocol."
REFERENCE
"FC-SW-3 section 4.8"
SYNTAX OCTET STRING (SIZE(1))
FcipEntityMode ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The type of port mode provided by an FCIP Entity
for an FCIP Link. An FCIP Entity can be an E-Port
mode for one of its FCIP Link Endpoints or a B-Port
mode for another of its FCIP Link Endpoints."
REFERENCE
"FC-BB, rev 4.7, 2 May 1997, section 3."
SYNTAX INTEGER {
ePortMode(1),
bPortMode(2)
}
FcipEntityId ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The FCIP entity identifier as defined in RFC 3821."
REFERENCE
"RFC 3821, Section 7.1, FCIP Special Frame Format"
SYNTAX OCTET STRING (SIZE(8))
-- ******************************************************************
-- The FCIP group
--
-- This group defines the global scalar objects applicable to FCIP
-- devices only
--
fcipDynIpConfType OBJECT-TYPE
SYNTAX INTEGER {
slpv2(1),
none(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The type of discovery protocol used to discover remote
FCIP entities. The value of this object is persistent
across system restarts."
::= { fcipConfig 1 }
fcipDeviceWWN OBJECT-TYPE
SYNTAX FcNameIdOrZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The World Wide Name of this FCIP device."
::= { fcipConfig 2 }
fcipEntitySACKOption OBJECT-TYPE
SYNTAX INTEGER {
enabled(1),
disabled(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indication of whether the TCP Selective Acknowledgement
Option is enabled at this FCIP device to let the receiver
acknowledge multiple lost packets in a single ACK for faster
recovery."
REFERENCE
"The Selective Ack option is defined in RFC 2883."
::= { fcipConfig 3 }
-- ******************************************************************
-- The FCIP Entity Table
--
fcipEntityInstanceTable OBJECT-TYPE
SYNTAX SEQUENCE OF FcipEntityInstanceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Information about this FCIP device’s existing instances of
FCIP entities."
REFERENCE
"RFC 3821, Section 5.4, FCIP Entity"
::= { fcipConfig 4 }
fcipEntityInstanceEntry OBJECT-TYPE
SYNTAX FcipEntityInstanceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row of the FCIP entity table with information
about a particular FCIP entity. Once a row has been
created, it is non-volatile across agent restarts until it
is deleted."
INDEX { fcipEntityId }
::= { fcipEntityInstanceTable 1 }
FcipEntityInstanceEntry ::=
SEQUENCE {
fcipEntityId FcipEntityId,
fcipEntityName SnmpAdminString,
fcipEntityAddressType InetAddressType,
fcipEntityAddress InetAddress,
fcipEntityTcpConnPort InetPortNumber,
fcipEntitySeqNumWrap TruthValue,
fcipEntityPHBSupport TruthValue,
fcipEntityStatus RowStatus
}
fcipEntityId OBJECT-TYPE
SYNTAX FcipEntityId
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The FCIP entity identifier."
REFERENCE
"RFC 3821, Section 7.1, FCIP Special Frame Format"
::= { fcipEntityInstanceEntry 1 }
fcipEntityName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..32))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"An administratively-assigned name for this FCIP entity."
::= { fcipEntityInstanceEntry 2 }
fcipEntityAddressType OBJECT-TYPE
SYNTAX InetAddressType
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The type of Internet address by which the entity is
reachable. Only address types IPv4 and IPv6 are supported."
::= { fcipEntityInstanceEntry 3 }
fcipEntityAddress OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The Internet address for the entity, if configured. The
format of this address is determined by the value of the
fcipEntityAddressType object."
::= { fcipEntityInstanceEntry 4 }
fcipEntityTcpConnPort OBJECT-TYPE
SYNTAX InetPortNumber
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"A TCP port other than the FCIP Well-Known port on which the
FCIP entity listens for new TCP connection requests. It
contains the value zero(0) if the FCIP Entity only listens
on the Well-Known port."
DEFVAL { 0 }
::= { fcipEntityInstanceEntry 5 }
fcipEntitySeqNumWrap OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of whether the FCIP Entity supports protection
against sequence number wrap."
REFERENCE
"The PAWS option is defined in RFC 1323."
::= { fcipEntityInstanceEntry 6 }
fcipEntityPHBSupport OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of whether the FCIP Entity supports PHB IP
quality of service (QoS)."
REFERENCE
"Per hop behavior is defined in RFC 2474, definition of the
Differentiated Services Field."
::= { fcipEntityInstanceEntry 7 }
fcipEntityStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object specifies the operational status of the row.
When a management station sets the status to active(1), then
the values for the objects fcipEntityName,
fcipEntityAddressType, and fcipEntityAddress should be
supplied as part of the set request. The values of the
objects fcipEntityName, fcipEntityAddressType, and
fcipEntityAddress can be changed if the row status is in
active state. The object fcipEntityTcpConnPort takes the
default value zero(0), if no value is supplied at the time
of row creation.
Setting the status to destroy(6) deletes the specified FCIP
entity instance row from the table. It also deletes all the
rows corresponding to the specified FCIP entity from the
fcipLinkTable and fcipTcpConnTable tables."
::= { fcipEntityInstanceEntry 8 }
-- ******************************************************************
-- The FCIP Link Table
--
fcipLinkTable OBJECT-TYPE
SYNTAX SEQUENCE OF FcipLinkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Information about FCIP links that exist on this device."
::= { fcipConfig 5 }
fcipLinkEntry OBJECT-TYPE
SYNTAX FcipLinkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row of the FCIP link table containing
information about a particular FCIP link. The values of the
read-create objects in this table are persistent across
system restarts."
INDEX { fcipEntityId, fcipLinkIndex }
::= { fcipLinkTable 1 }
FcipLinkEntry ::=