This MIB module contains managed object definitions for the MANET SMF RSSA process defined in:
Macker, J., Ed., Simplified Multicast Forwarding, RFC 6621, May 2012.
Copyright (c) 2014 IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).
A threshold value for the 'smfNotifDpdmemoryOverflowEvents' object. If the number of occurrences exceeds this threshold within the previous number of seconds 'smfNotifDpdMemoryOverflowWindow', then the 'smfNotifDpdMemoryOverflowEvent' notification is sent.
The default value for this object is '1'.
smfNotifDpdMemoryOverflowWindow
1.3.6.1.3.126.0.1.2
TimeTicks
A time window value for the 'smfNotifDpdmemoryOverflowEvents' object. If the number of occurrences exceeds the 'smfNotifDpdMemoryOverflowThreshold' within the previous number of seconds 'smfNotifDpdMemoryOverflowWindow', then the 'smfNotifDpdMemoryOverflowEvent' notification is sent.
The default value for this object is '1'.
smfCfgAdminStatus
1.3.6.1.3.126.1.2.1
SmfStatus1 = enabled2 = disabledAn indication of the operability of an SMF function or feature. For example, the status of an interface: 'enabled' indicates that this interface is performing SMF functions and 'disabled' indicates that it is not. Similarly, for the status of the device: 'enabled' indicates that the device has enabled the SMF functions on the device and 'disabled' means that the device and all interfaces have disabled all SMF functions. · Integer32
The configured status of the SMF process on this device. 'enabled(1)' means that SMF is configured to run on this device. 'disabled(2)' means that the SMF process is configured off.
Prior to SMF functions being performed over specific interfaces, this object must first be 'enabled'. If this object is 'disabled', then no SMF functions are being performed on the device and all smfCfgIfAdminStatus objects MUST also be set to 'disabled'. When this object is changed from 'enabled' to 'disabled' by the manager, then all smfCfgIfAdminStatus objects MUST also be automatically set to 'disabled' by the agent.
The default value for this object SHOULD be 'enabled'.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgSmfSysUpTime
1.3.6.1.3.126.1.2.2
TimeTicks
The time (in hundredths of a second) since the system SMF process was last re-initialized. The SMF process is re-initialized when the value of the 'smfCfgAdminStatus' object transitions to 'enabled' from either a prior value of 'disabled' or upon initialization of this device.
smfCfgRouterIDAddrType
1.3.6.1.3.126.1.2.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The address type of the address used for the SMF ID of this router as specified in the 'smfCfgRouterID' next.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgRouterID
1.3.6.1.3.126.1.2.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The IP address used as the SMF router ID. This can be set by the management station. If not explicitly set, then the device SHOULD select a routable IP address assigned to this router for use as the 'smfCfgRouterID'.
The smfCfgRouterID is a logical identification that MUST be consistent across interoperable SMF neighborhoods, and it is RECOMMENDED to be chosen as the numerically largest address contained in a node's 'Neighbor Address List' as defined in NHDP. An smfCfgRouterID MUST be unique within the scope of the operating MANET network regardless of the method used for selecting it.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: For example, see
Appendix A.1 'E-CDS Relay Set Selection Overview'
and
Appendix C.1 'MPR-CDS Relay Set Selection Overview' in
RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgOperationalMode
1.3.6.1.3.126.1.2.5
Integer32 (1..2147483647)
The SMF RSS node operational mode and RSSA combination active on this local forwarder. This object is defined to be equal to the smfCapabilitiesIndex, which identifies the specific active operational mode and RSSA.
The default value for this object is '1', which corresponds to:
smfCapabilitiesOpModeID i 'cfOnly(1)' smfCapabilitiesRssaID i 'cF(1)'
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 7.2 'Reduced Relay Set Forwarding', and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgRssaMember
1.3.6.1.3.126.1.2.6
INTEGER1 = potential2 = always3 = never · Integer32
The RSSA downselects a set of forwarders for multicast forwarding. Sometimes it is useful to force an agent to be included or excluded from the resulting RSS. This object is a switch to allow for this behavior.
The value 'potential(1)' allows the selected RSSA to determine if this agent is included or excluded from the RSS.
The value 'always(2)' forces the selected RSSA to include this agent in the RSS.
The value 'never(3)' forces the selected RSSA to exclude this agent from the RSS.
The default setting for this object is 'potential(1)'. Other settings could pose operational risks under certain conditions. This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 7 'Relay Set Selection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
The current method for IPv4 duplicate packet detection.
The value 'hashBased(1)' indicates that the router's duplicate packet detection is based upon comparing a hash over the packet fields. This is the default setting for this object.
The value 'identificationBased(2)' indicates that the duplicate packet detection relies upon header information in the multicast packets to identify previously received packets.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 6.2 'IPv4 Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
The current method for IPv6 duplicate packet detection.
The values indicate the type of method used for duplicate packet detection as described the previous description for the object 'smfCfgIpv4Dpd'.
The default value for this object is 'hashBased(1)'.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 6.1 'IPv6 Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgMaxPktLifetime
1.3.6.1.3.126.1.2.9
Integer32 (0..65535) · Seconds
The estimate of the network packet traversal time.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 6 'SMF Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgDpdEntryMaxLifetime
1.3.6.1.3.126.1.2.10
Integer32 (0..65525) · Seconds
The maximum lifetime of a cached DPD record in the local device storage.
If the memory is running low prior to the MaxLifetime being exceeded, the local SMF devices should purge the oldest records first.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 6 'SMF Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgNhdpRssaMesgTLVIncluded
1.3.6.1.3.126.1.2.11
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
Indicates whether or not the associated NHDP messages include the RSSA Message TLV. This is an optional SMF operational setting. The value 'true(1)' indicates that this TLV is included; the value 'false(2)' indicates that it is not included.
It is RECOMMENDED that the RSSA Message TLV be included in the NHDP messages.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 8.1.1 'SMF Message TLV Type' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgNhdpRssaAddrBlockTLVIncluded
1.3.6.1.3.126.1.2.12
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
Indicates whether or not the associated NHDP messages include the RSSA Address Block TLV. This is an optional SMF operational setting. The value 'true(1)' indicates that this TLV is included; the value 'false(2)' indicates that it is not included.
The smfCfgNhdpRssaAddrBlockTLVIncluded is optional in all cases as it depends on the existence of an address block that may not be present. If this SMF device is configured with NHDP, then this object SHOULD be set to 'true(1)'.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 8.1.2 'SMF Address Block TLV Type' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfStateNodeRsStatusIncluded
1.3.6.1.3.126.1.3.1
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The current status of the SMF node in the context of the MANETs relay set. A value of 'true(1)' indicates that the node is currently part of the MANET Relay Set. A value of 'false(2)' indicates that the node is currently not part of the MANET Relay Set. Reference: See Section 7 'Relay Set Selection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfStateDpdMemoryOverflow
1.3.6.1.3.126.1.3.2
Counter32 · DPD Records
The number of DPD records that had to be flushed to prevent memory overruns for caching of these records. The number of records to be flushed upon a buffer overflow is an implementation specific decision.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6 'SMF Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv4MultiPktsRecvTotal
1.3.6.1.3.126.1.4.1.1
Counter32 · Packets
A counter of the total number of multicast IPv4 packets received by the device and delivered to the SMF process.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored.
smfPerfIpv4MultiPktsForwardedTotal
1.3.6.1.3.126.1.4.1.2
Counter32 · Packets
A counter of the total number of multicast IPv4 packets forwarded by the device.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored.
smfPerfIpv4DuplMultiPktsDetectedTotal
1.3.6.1.3.126.1.4.1.3
Counter32 · Packets
A counter of the total number of duplicate multicast IPv4 packets detected by the device. There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6.2 'IPv4 Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv4DroppedMultiPktsTTLExceededTotal
1.3.6.1.3.126.1.4.1.4
Counter32 · Packets
A counter of the total number of dropped multicast IPv4 packets by the device due to Time to Live (TTL) exceeded.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 5 'SMF Packet Processing and Forwarding' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv4TTLLargerThanPreviousTotal
1.3.6.1.3.126.1.4.1.5
Counter32 · Packets
A counter of the total number of IPv4 packets received that have a TTL larger than that of a previously received identical packet.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 5 'SMF Packet Processing and Forwarding' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv6MultiPktsRecvTotal
1.3.6.1.3.126.1.4.1.6
Counter32 · Packets
A counter of the total number of multicast IPv6 packets received by the device and delivered to the SMF process.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored.
smfPerfIpv6MultiPktsForwardedTotal
1.3.6.1.3.126.1.4.1.7
Counter32 · Packets
A counter of the total number of multicast IPv6 packets forwarded by the device.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored.
smfPerfIpv6DuplMultiPktsDetectedTotal
1.3.6.1.3.126.1.4.1.8
Counter32 · Packets
A counter of the total number of duplicate multicast IPv6 packets detected by the device.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6.1 'IPv6 Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv6DroppedMultiPktsTTLExceededTotal
1.3.6.1.3.126.1.4.1.9
Counter32 · Packets
A counter of the total number of dropped multicast IPv6 packets by the device due to TTL exceeded.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 5 'SMF Packet Processing and Forwarding' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv6TTLLargerThanPreviousTotal
1.3.6.1.3.126.1.4.1.10
Counter32 · Packets
A counter of the total number of IPv6 packets received that have a TTL larger than that of a previously received identical packet.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 5 'SMF Packet Processing and Forwarding' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv6HAVAssistsReqdTotal
1.3.6.1.3.126.1.4.1.11
Counter32 · Packets
A counter of the total number of IPv6 packets received that required the Hash Assist Value (HAV) for DPD.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6.1.1 'IPv6 SMF_DPD Option Header' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfPerfIpv6DpdHeaderInsertionsTotal
1.3.6.1.3.126.1.4.1.12
Counter32 · Packets
A counter of the total number of IPv6 packets received that the device inserted the DPD header option.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6.1.2 'IPv6 Identification-Based DPD' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
Table details
smfCapabilitiesTable
1.3.6.1.3.126.1.1.1
Index: smfCapabilitiesIndex
The smfCapabilitiesTable identifies the resident set of SMF Operational Modes and RSSA combinations that can run on this forwarder. Reference: See Section 7.2 'Reduced Relay Set Forwarding', Section 8.1.1 'SMF Message TLV Type', and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., May 2012.
smfCapabilitiesIndex
1.3.6.1.3.126.1.1.1.1.1
Integer32 (1..2147483647)
The index for this entry; a unique value, greater than zero, for each combination of a particular operational mode and RSSA available on this device. It is recommended that values are assigned contiguously starting from 1.
Rows in this table are automatically populated by the entity's management system on initialization.
By default, the agent should support at least the Classical Flooding 'cF' algorithm. All compliant SMF forwarders must support Classical Flooding. Hence, the first entry in this table MUST exist and MUST be defined as:
smfCapabilitiesIndex i '1' smfCapabilitiesOpModeID i 'cfOnly(1)' smfCapabilitiesRssaID i 'cF(1)'
The value for each combination MUST remain constant at least from one re-initialization of the entity's management system to the next re-initialization.
smfCapabilitiesOpModeID
1.3.6.1.3.126.1.1.1.1.2
IANAsmfOpModeIdTC1 = independent2 = routing3 = crossLayerAn index that identifies through reference to a specific SMF operations mode. There are basically three styles of SMF operation with reduced relay sets currently identified: Independent operation 'independent(1)' - SMF performs its own relay set selection using information from an associated MANET NHDP process.
CDS-aware unicast routing operation 'routing(2)'- a coexistent unicast routing protocol provides dynamic relay set state based upon its own control plane Connected Dominating Set (CDS) or neighborhood discovery information.
Cross-layer operation 'crossLayer(3)' - SMF operates using neighborhood status and triggers from a cross-layer information base for dynamic relay set selection and maintenance.
IANA MUST update this Textual Convention accordingly.
The definition of this Textual Convention with the addition of newly assigned values is updated periodically by the IANA, in the IANA-maintained registries. (The latest arrangements can be obtained by contacting the IANA.) Requests for new values SHOULD be made to IANA via email (iana@iana.org).Reference: See Section 7.2 'Reduced Relay Set Forwarding', and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012. · Integer32
This object identifies the particular operational mode for this device.
smfCapabilitiesRssaID
1.3.6.1.3.126.1.1.1.1.3
IANAsmfRssaIdTC1 = cF2 = sMPR3 = eCDS4 = mprCDSAn index that identifies through reference to specific RSSAs. Several are currently defined in the Appendices A, B, and C of RFC 6621.
Examples of RSSAs already identified within this Textual Convention (TC) are:
Classical Flooding (cF(1)) - is the standard flooding algorithm where each node in the next retransmits the information on each of its interfaces.
Source-Based Multipoint Relay (sMPR(2)) - this algorithm is used by Optimized Link State Routing (OLSR) and OLSR version 2 (OLSRv2) protocols for the relay of link state updates and other control information (RFC 3626, RFC 7181). Since each router picks its neighboring relays independently, sMPR forwarders depend upon previous hop information (e.g., source Media Access Control (MAC) address) to operate correctly.
Essential Connected Dominating Set (eCDS(3)) - defined in RFC 5614, this algorithm forms a single CDS mesh for the SMF operating region. Its packet-forwarding rules are not dependent upon previous hop knowledge in contrast to sMPR.
Multipoint Relay Connected Dominating Set (mprCDS(4)) - This algorithm is an extension to the basic sMPR election algorithm that results in a shared (non-source-specific) SMF CDS. Thus, its forwarding rules are not dependent upon previous hop information, similar to eCDS.
IANA MUST update this Textual Convention accordingly.
The definition of this Textual Convention with the addition of newly assigned values is updated periodically by the IANA, in the IANA-maintained registries. (The latest arrangements can be obtained by contacting the IANA.)
Requests for new values SHOULD be made to IANA via email (iana@iana.org).Reference: For example, see:
Section 8.1.1. 'SMF Message TLV Type' and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
RFC 3626 - Clausen, T., Ed., and P. Jacquet, Ed., 'Optimized Link State Routing Protocol (OLSR)', October 2003.
RFC 5614 - Ogier, R. and P. Spagnolo, 'Mobile Ad Hoc Network (MANET) Extension of OSPF Using Connected Dominating Set (CDS) Flooding', August 2009.
RFC 7181 - Clausen, T., Dearlove, C., Jacquet, P., and U. Herberg, 'The Optimized Link State Routing Protocol Version 2', April 2014. · Integer32
This object identifies the particular RSSA algorithm in this MIB module. Example RSSAs are found in the appendix of RFC 6621. Reference: For example, see Section 8.1.1 'SMF Message TLV Type', and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., May 2012.
smfCfgAddrForwardingTable
1.3.6.1.3.126.1.2.13
Index: smfCfgAddrForwardingIndex
The smfCfgAddrForwardingTable is essentially a filter table (if populated) that identifies addresses/packets to be forwarded via the local SMF flooding process. The IP Multicast MIB module in RFC 5132 manages objects related to standard IP multicast, which could be running in parallel to SMF on the device. RFC 5132 manages traditional IP-based multicast (based upon multicast routing mechanisms). The SMF-MIB module provides management for a MANET subnet-based flooding mechanism that may be used for multicast transport (through SMF broadcast) depending upon the MANET dynamics and other factors regarding the MANET subnet. Further, they may coexist in certain MANET deployments using the smfCfgAddrForwardingTable to hand certain IP multicast addresses to the SMF process and other IP multicast packets to be forwarded by other multicast mechanisms that are IP route based. SMF and the associated SMF-MIB module are experimental and these are some of the experiments to be had with SMF and the SMF-MIB module.
This is the (conceptual) table containing information on multicast addresses that are to be forwarded by the SMF process. This table represents an IP filters table for forwarding (or not) packets based upon their IP multicast address.
The SMF process can be configured to forward only those multicast addresses found within the smfCfgAddrForwardingTable. As such, addresses that are to be forwarded by the SMF process MUST be found within the address ranges configured within this table, unless this table is empty.
Each row is associated with a range of multicast addresses, and ranges for different rows must be disjoint. Different rows MAY share a common smfCfgAddrForwardingGroupName to administratively associate different rows.
The objects in this table are persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 9.1 'Forwarded Multicast Groups' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgAddrForwardingIndex
1.3.6.1.3.126.1.2.13.1.1
Integer32 (1..2147483647)
This object identifies a unique entry for a forwarding group. The index for this entry is a unique value, greater than zero, for each row. It is recommended that values are assigned contiguously starting from 1.
The value for each row index MUST remain constant from one re-initialization of the entity's management system to the next re-initialization.
smfCfgAddrForwardingGroupName
1.3.6.1.3.126.1.2.13.1.2
SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form.
To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279].
Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited.
The use of control codes should be avoided.
When it is necessary to represent a newline, the control code sequence CR LF should be used.
The use of leading or trailing white space should be avoided.
For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided.
For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding.
UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding.
Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object identifies a group name for a set of row entries in order to administratively associate a set of address ranges.
If there is no group name or this object is otherwise not applicable, then this object contains a zero-length string.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgAddrForwardingAddrType
1.3.6.1.3.126.1.2.13.1.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of the addresses in the multicast forwarding ranges identified by this table.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgAddrForwardingAddress
1.3.6.1.3.126.1.2.13.1.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The multicast group address that, when combined with smfCfgAddrForwardingAddrPrefixLength, gives the group prefix for this forwarding range. The InetAddressType is given by smfCfgAddrForwardingAddrType.
This address object is only significant up to smfCfgAddrForwardingAddrPrefixLength bits. The remaining address bits are set to zero. This is especially important for this index field. Any non-zero bits would signify an entirely different entry.
Legal values correspond to the subset of address families for which multicast address allocation is supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgAddrForwardingAddrPrefixLength
1.3.6.1.3.126.1.2.13.1.5
InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0.
An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row.
InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply.
The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d
The length in bits of the mask that, when combined with smfCfgAddrForwardingAddress, gives the group prefix for this forwarding range.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgAddrForwardingStatus
1.3.6.1.3.126.1.2.13.1.6
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
The status of this row, by which new entries may be created, or old entries deleted from this table.
smfCfgInterfaceTable
1.3.6.1.3.126.1.2.14
Index: smfCfgIfIndex
The SMF Interface Table describes the SMF interfaces that are participating in the SMF packet forwarding process. The ifIndex is from the interfaces group defined in the Interfaces Group MIB module (RFC 2863). As such, this table 'sparse augments' the ifTable specifically when SMF is to be configured to operate over this interface.
A conceptual row in this table exists if and only if either a manager has explicitly created the row or there is an interface on the managed device that automatically supports and runs SMF as part of the device's initialization process.
The manager creates a row in this table by setting the rowStatus to 'createAndGo' or 'createAndWait'. Row objects having associated DEFVAL clauses are automatically defined by the agent with these values during row creation, unless the manager explicitly defines these object values during the row creation.
As the smfCfgInterfaceTable sparsely augments the IfTable. Hence,
+ an entry cannot exist in smfCfgInterfaceTable without a corresponding entry in the ifTable.
+ if an entry in the ifTable is removed, the corresponding entry (if it exists) in the smfCfgInterfaceTable MUST be removed.
+ the smfCfgIfStatus can have a value of 'enabled' or 'disabled' independent of the current value of the ifAdminStatus of the corresponding entry in the ifTable.
The values of the objects smfCfgAdminStatus and smfCfgIfAdminStatus reflect the up-down status of the SMF process running on the device and on the specific interfaces, respectively. Hence,
+ the value of the smfCfgAdminStatus can be 'enabled' or 'disabled' reflecting the current running status of the SMF process on the device.
+ the value of the smfCfgIfAdminStatus can be 'enabled' or 'disabled' if the value of the smfCfgAdminStatus is set to 'enabled'.
+ if the value of the smfCfgAdminStatus is 'disabled', then the corresponding smfCfgIfAdminStatus objects MUST be set to 'disabled' in the smfCfgInterfaceTable.
+ once the value of the smfCfgAdminStatus changes from 'disabled' to 'enabled', it is up to the management system to make the corresponding changes to the smfCfgIfAdminStatus values back to 'enabled'. Reference: RFC 2863 - 'The Interfaces Group MIB', McCloghrie, K., and F. Kastenholtz, June 2000.
smfCfgIfIndex
1.3.6.1.3.126.1.2.14.1.1
InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d
The ifIndex for this SMF interface. This value MUST correspond to an ifIndex referring to a valid entry in the Interfaces Table. If the manager attempts to create a row for which the ifIndex does not exist on the local device, then the agent SHOULD issue a return value of 'inconsistentValue' and the operation SHOULD fail. Reference: RFC 2863 - 'The Interfaces Group MIB', McCloghrie, K., and F. Kastenholtz, June 2000.
smfCfgIfAdminStatus
1.3.6.1.3.126.1.2.14.1.2
SmfStatus1 = enabled2 = disabledAn indication of the operability of an SMF function or feature. For example, the status of an interface: 'enabled' indicates that this interface is performing SMF functions and 'disabled' indicates that it is not. Similarly, for the status of the device: 'enabled' indicates that the device has enabled the SMF functions on the device and 'disabled' means that the device and all interfaces have disabled all SMF functions. · Integer32
The SMF interface's administrative status. The value 'enabled' denotes that the interface is running the SMF forwarding process. The value 'disabled' denotes that the interface is currently external to the SMF forwarding process.
When the value of the smfCfgAdminStatus is 'disabled', then the corresponding smfCfgIfAdminStatus objects MUST be set to 'disabled' in the smfCfgInterfaceTable.
If this object is not equal to 'enabled', all associated entries in the 'smfPerfIpv4InterfacePerfTable' and the 'smfPerfIpv6InterfacePerfTable' MUST be deleted.
The default value for this object is 'enabled(1)'.
This object SHOULD be persistent and when written the device SHOULD save the change to non-volatile storage.
smfCfgIfSmfUpTime
1.3.6.1.3.126.1.2.14.1.3
TimeTicks
The time (in hundredths of a second) since this interface SMF process was last re-initialized. The interface SMF process is re-initialized when the value of the 'smfCfgIfAdminStatus' object transitions to 'enabled' from either a prior value of 'disabled' or upon initialization of this interface or this device.
smfCfgIfRowStatus
1.3.6.1.3.126.1.2.14.1.4
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object permits management of this table by facilitating actions such as row creation, construction, and destruction. The value of this object has no effect on whether other objects in this conceptual row can be modified. An entry may not exist in the 'active' state unless all objects in the entry have a defined appropriate value. For objects with DEFVAL clauses, the management station does not need to specify the value of these objects in order for the row to transit to the 'active' state; the default value for these objects is used. For objects that do not have DEFVAL clauses, the network manager MUST specify the value of these objects prior to this row transitioning to the 'active' state.
When this object transitions to 'active', all objects in this row SHOULD be written to non-volatile (stable) storage. Read-create objects in this row MAY be modified. When an object in a row with smfCfgIfRowStatus of 'active' is changed, then the updated value MUST be reflected in SMF and this new object value MUST be written to non-volatile storage.
The SMF StateNeighborTable describes the current one-hop neighbor nodes, their address and SMF RSSA, and the interface on which they can be reached. Reference: See Section 8 'SMF Neighborhood Discovery' and Section 8.1. 'SMF Relay Algorithm TLV Types' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfStateNeighborIpAddrType
1.3.6.1.3.126.1.3.3.1.1
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The one-hop neighbor IP address type.
Only the values 'ipv4(1)' and 'ipv6(2)' are supported.
smfStateNeighborIpAddr
1.3.6.1.3.126.1.3.3.1.2
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The one-hop neighbor Inet IPv4 or IPv6 address.
Only IPv4 and IPv6 addresses are supported.
smfStateNeighborPrefixLen
1.3.6.1.3.126.1.3.3.1.3
InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0.
An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row.
InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply.
The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d · bits
The prefix length. This is a decimal value that indicates the number of contiguous, higher-order bits of the address that make up the network portion of the address.
smfStateNeighborRSSA
1.3.6.1.3.126.1.3.3.1.4
IANAsmfRssaIdTC1 = cF2 = sMPR3 = eCDS4 = mprCDSAn index that identifies through reference to specific RSSAs. Several are currently defined in the Appendices A, B, and C of RFC 6621.
Examples of RSSAs already identified within this Textual Convention (TC) are:
Classical Flooding (cF(1)) - is the standard flooding algorithm where each node in the next retransmits the information on each of its interfaces.
Source-Based Multipoint Relay (sMPR(2)) - this algorithm is used by Optimized Link State Routing (OLSR) and OLSR version 2 (OLSRv2) protocols for the relay of link state updates and other control information (RFC 3626, RFC 7181). Since each router picks its neighboring relays independently, sMPR forwarders depend upon previous hop information (e.g., source Media Access Control (MAC) address) to operate correctly.
Essential Connected Dominating Set (eCDS(3)) - defined in RFC 5614, this algorithm forms a single CDS mesh for the SMF operating region. Its packet-forwarding rules are not dependent upon previous hop knowledge in contrast to sMPR.
Multipoint Relay Connected Dominating Set (mprCDS(4)) - This algorithm is an extension to the basic sMPR election algorithm that results in a shared (non-source-specific) SMF CDS. Thus, its forwarding rules are not dependent upon previous hop information, similar to eCDS.
IANA MUST update this Textual Convention accordingly.
The definition of this Textual Convention with the addition of newly assigned values is updated periodically by the IANA, in the IANA-maintained registries. (The latest arrangements can be obtained by contacting the IANA.)
Requests for new values SHOULD be made to IANA via email (iana@iana.org).Reference: For example, see:
Section 8.1.1. 'SMF Message TLV Type' and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
RFC 3626 - Clausen, T., Ed., and P. Jacquet, Ed., 'Optimized Link State Routing Protocol (OLSR)', October 2003.
RFC 5614 - Ogier, R. and P. Spagnolo, 'Mobile Ad Hoc Network (MANET) Extension of OSPF Using Connected Dominating Set (CDS) Flooding', August 2009.
RFC 7181 - Clausen, T., Dearlove, C., Jacquet, P., and U. Herberg, 'The Optimized Link State Routing Protocol Version 2', April 2014. · Integer32
The current RSSA running on the neighbor.
smfStateNeighborNextHopInterface
1.3.6.1.3.126.1.3.3.1.6
InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d
The interface ifIndex over which the neighbor is reachable in one-hop.
smfPerfIpv4InterfacePerfTable
1.3.6.1.3.126.1.4.2.1
Index: smfCfgIfIndex
The SMF Interface Performance Table describes the SMF counters per interface.
smfPerfIpv4MultiPktsRecvPerIf
1.3.6.1.3.126.1.4.2.1.1.1
Counter32 · Packets
A counter of the number of multicast IP packets received by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv4MultiPktsForwardedPerIf
1.3.6.1.3.126.1.4.2.1.1.2
Counter32 · Packets
A counter of the number of multicast IP packets forwarded by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv4DuplMultiPktsDetectedPerIf
1.3.6.1.3.126.1.4.2.1.1.3
Counter32 · Packets
A counter of the number of duplicate multicast IP packets detected by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv4DroppedMultiPktsTTLExceededPerIf
1.3.6.1.3.126.1.4.2.1.1.4
Counter32 · Packets
A counter of the total number of dropped multicast IPv4 packets by the SMF process on this device on this interface due to TTL exceeded.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv4TTLLargerThanPreviousPerIf
1.3.6.1.3.126.1.4.2.1.1.5
Counter32 · Packets
A counter of the total number of IPv4 packets received by the SMF process on this device on this interface that have a TTL larger than that of a previously received identical packet.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6InterfacePerfTable
1.3.6.1.3.126.1.4.2.2
Index: smfCfgIfIndex
The SMF Interface Performance Table describes the SMF counters per interface.
smfPerfIpv6MultiPktsRecvPerIf
1.3.6.1.3.126.1.4.2.2.1.1
Counter32 · Packets
A counter of the number of multicast IP packets received by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6MultiPktsForwardedPerIf
1.3.6.1.3.126.1.4.2.2.1.2
Counter32 · Packets
A counter of the number of multicast IP packets forwarded by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6DuplMultiPktsDetectedPerIf
1.3.6.1.3.126.1.4.2.2.1.3
Counter32 · Packets
A counter of the number of duplicate multicast IP packets detected by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6DroppedMultiPktsTTLExceededPerIf
1.3.6.1.3.126.1.4.2.2.1.4
Counter32 · Packets
A counter of the number of dropped multicast IP packets by the SMF process on this device on this interface due to TTL exceeded.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6TTLLargerThanPreviousPerIf
1.3.6.1.3.126.1.4.2.2.1.5
Counter32 · Packets
A counter of the total number of IPv6 packets received that have a TTL larger than that of a previously received identical packet by the SMF process on this device on this interface.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6HAVAssistsReqdPerIf
1.3.6.1.3.126.1.4.2.2.1.6
Counter32 · Packets
A counter of the total number of IPv6 packets received by the SMF process on this device on this interface that required the HAV assist for DPD.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
smfPerfIpv6DpdHeaderInsertionsPerIf
1.3.6.1.3.126.1.4.2.2.1.7
Counter32 · Packets
A counter of the total number of IPv6 packets received by the SMF process on this device on this interface that the device inserted the DPD header option.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled on this interface. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgIfSmfUpTime object also be monitored.
Trap details
smfNotifAdminStatusChange
1.3.6.1.3.126.0.0.1
smfCfgAdminStatusChange is a notification sent when the 'smfCfgAdminStatus' object changes.
smfCfgRouterIDAddrType
1.3.6.1.3.126.1.2.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The address type of the address used for the SMF ID of this router as specified in the 'smfCfgRouterID' next.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgRouterID
1.3.6.1.3.126.1.2.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The IP address used as the SMF router ID. This can be set by the management station. If not explicitly set, then the device SHOULD select a routable IP address assigned to this router for use as the 'smfCfgRouterID'.
The smfCfgRouterID is a logical identification that MUST be consistent across interoperable SMF neighborhoods, and it is RECOMMENDED to be chosen as the numerically largest address contained in a node's 'Neighbor Address List' as defined in NHDP. An smfCfgRouterID MUST be unique within the scope of the operating MANET network regardless of the method used for selecting it.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: For example, see
Appendix A.1 'E-CDS Relay Set Selection Overview'
and
Appendix C.1 'MPR-CDS Relay Set Selection Overview' in
RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgAdminStatus
1.3.6.1.3.126.1.2.1
SmfStatus1 = enabled2 = disabledAn indication of the operability of an SMF function or feature. For example, the status of an interface: 'enabled' indicates that this interface is performing SMF functions and 'disabled' indicates that it is not. Similarly, for the status of the device: 'enabled' indicates that the device has enabled the SMF functions on the device and 'disabled' means that the device and all interfaces have disabled all SMF functions. · Integer32
The configured status of the SMF process on this device. 'enabled(1)' means that SMF is configured to run on this device. 'disabled(2)' means that the SMF process is configured off.
Prior to SMF functions being performed over specific interfaces, this object must first be 'enabled'. If this object is 'disabled', then no SMF functions are being performed on the device and all smfCfgIfAdminStatus objects MUST also be set to 'disabled'. When this object is changed from 'enabled' to 'disabled' by the manager, then all smfCfgIfAdminStatus objects MUST also be automatically set to 'disabled' by the agent.
The default value for this object SHOULD be 'enabled'.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfNotifConfiguredOpModeChange
1.3.6.1.3.126.0.0.2
smfNotifConfiguredOpModeChange is a notification sent when the 'smfCfgOperationalMode' object changes.
smfCfgRouterIDAddrType
1.3.6.1.3.126.1.2.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The address type of the address used for the SMF ID of this router as specified in the 'smfCfgRouterID' next.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgRouterID
1.3.6.1.3.126.1.2.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The IP address used as the SMF router ID. This can be set by the management station. If not explicitly set, then the device SHOULD select a routable IP address assigned to this router for use as the 'smfCfgRouterID'.
The smfCfgRouterID is a logical identification that MUST be consistent across interoperable SMF neighborhoods, and it is RECOMMENDED to be chosen as the numerically largest address contained in a node's 'Neighbor Address List' as defined in NHDP. An smfCfgRouterID MUST be unique within the scope of the operating MANET network regardless of the method used for selecting it.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: For example, see
Appendix A.1 'E-CDS Relay Set Selection Overview'
and
Appendix C.1 'MPR-CDS Relay Set Selection Overview' in
RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfCfgOperationalMode
1.3.6.1.3.126.1.2.5
Integer32 (1..2147483647)
The SMF RSS node operational mode and RSSA combination active on this local forwarder. This object is defined to be equal to the smfCapabilitiesIndex, which identifies the specific active operational mode and RSSA.
The default value for this object is '1', which corresponds to:
smfCapabilitiesOpModeID i 'cfOnly(1)' smfCapabilitiesRssaID i 'cF(1)'
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: See Section 7.2 'Reduced Relay Set Forwarding', and the Appendices A, B, and C in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfNotifIfAdminStatusChange
1.3.6.1.3.126.0.0.3
smfCfgIfAdminStatusChange is a notification sent when the 'smfCfgIfAdminStatus' object changes.
smfCfgRouterIDAddrType
1.3.6.1.3.126.1.2.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The address type of the address used for the SMF ID of this router as specified in the 'smfCfgRouterID' next.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgRouterID
1.3.6.1.3.126.1.2.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The IP address used as the SMF router ID. This can be set by the management station. If not explicitly set, then the device SHOULD select a routable IP address assigned to this router for use as the 'smfCfgRouterID'.
The smfCfgRouterID is a logical identification that MUST be consistent across interoperable SMF neighborhoods, and it is RECOMMENDED to be chosen as the numerically largest address contained in a node's 'Neighbor Address List' as defined in NHDP. An smfCfgRouterID MUST be unique within the scope of the operating MANET network regardless of the method used for selecting it.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: For example, see
Appendix A.1 'E-CDS Relay Set Selection Overview'
and
Appendix C.1 'MPR-CDS Relay Set Selection Overview' in
RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
ifName
1.3.6.1.2.1.31.1.1.1.1
DisplayStringRepresents textual information taken from the NVT ASCII
character set, as defined in pages 4, 10-11 of RFC 854.
To summarize RFC 854, the NVT ASCII repertoire specifies:
- the use of character codes 0-127 (decimal)
- the graphics characters (32-126) are interpreted as US ASCII
- NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854
- the other 25 codes have no standard interpretation
- the sequence 'CR LF' means newline
- the sequence 'CR NUL' means carriage-return
- an 'LF' not preceded by a 'CR' means moving to the same column on the next line.
- the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.)
Any object defined using this syntax may not exceed 255 characters in length. SIZE (0..255) · OCTET STRING · hint 255a
The textual name of the interface. The value of this object should be the name of the interface as assigned by the local device and should be suitable for use in commands entered at the device's `console'. This might be a text name, such as `le0' or a simple port number, such as `1', depending on the interface naming syntax of the device. If several entries in the ifTable together represent a single interface as named by the device, then each will have the same value of ifName. Note that for an agent which responds to SNMP queries concerning an interface on some other (proxied) device, then the value of ifName for such an interface is the proxied device's local name for it.
If there is no local name, or this object is otherwise not applicable, then this object contains a zero-length string.
smfCfgIfAdminStatus
1.3.6.1.3.126.1.2.14.1.2
SmfStatus1 = enabled2 = disabledAn indication of the operability of an SMF function or feature. For example, the status of an interface: 'enabled' indicates that this interface is performing SMF functions and 'disabled' indicates that it is not. Similarly, for the status of the device: 'enabled' indicates that the device has enabled the SMF functions on the device and 'disabled' means that the device and all interfaces have disabled all SMF functions. · Integer32
The SMF interface's administrative status. The value 'enabled' denotes that the interface is running the SMF forwarding process. The value 'disabled' denotes that the interface is currently external to the SMF forwarding process.
When the value of the smfCfgAdminStatus is 'disabled', then the corresponding smfCfgIfAdminStatus objects MUST be set to 'disabled' in the smfCfgInterfaceTable.
If this object is not equal to 'enabled', all associated entries in the 'smfPerfIpv4InterfacePerfTable' and the 'smfPerfIpv6InterfacePerfTable' MUST be deleted.
The default value for this object is 'enabled(1)'.
This object SHOULD be persistent and when written the device SHOULD save the change to non-volatile storage.
smfNotifDpdMemoryOverflowEvent
1.3.6.1.3.126.0.0.4
smfNotifDpdMemoryOverflowEvents is sent when the number of memory overflow events exceeds the 'smfNotifDpdMemoryOverflowThreshold' within the previous number of seconds defined by the 'smfNotifDpdMemoryOverflowWindow'.
smfCfgRouterIDAddrType
1.3.6.1.3.126.1.2.3
InetAddressType1 = ipv42 = ipv6A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The address type of the address used for the SMF ID of this router as specified in the 'smfCfgRouterID' next.
Only the values ipv4(1) and ipv6(2) are supported.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage.
smfCfgRouterID
1.3.6.1.3.126.1.2.4
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (4 | 16) · OCTET STRING
The IP address used as the SMF router ID. This can be set by the management station. If not explicitly set, then the device SHOULD select a routable IP address assigned to this router for use as the 'smfCfgRouterID'.
The smfCfgRouterID is a logical identification that MUST be consistent across interoperable SMF neighborhoods, and it is RECOMMENDED to be chosen as the numerically largest address contained in a node's 'Neighbor Address List' as defined in NHDP. An smfCfgRouterID MUST be unique within the scope of the operating MANET network regardless of the method used for selecting it.
This object is persistent and, when written, the entity SHOULD save the change to non-volatile storage. Reference: For example, see
Appendix A.1 'E-CDS Relay Set Selection Overview'
and
Appendix C.1 'MPR-CDS Relay Set Selection Overview' in
RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.
smfStateDpdMemoryOverflow
1.3.6.1.3.126.1.3.2
Counter32 · DPD Records
The number of DPD records that had to be flushed to prevent memory overruns for caching of these records. The number of records to be flushed upon a buffer overflow is an implementation specific decision.
There is the potential for a counter discontinuity in this object if the system SMF process has been disabled and later enabled. In order to check for the occurrence of such a discontinuity when monitoring this counter object, it is recommended that the smfCfgSmfSysUpTime object also be monitored. Reference: See Section 6 'SMF Duplicate Packet Detection' in RFC 6621 - 'Simplified Multicast Forwarding', Macker, J., Ed., May 2012.