CLAB-GRE-MIB

All MIBs › CLAB-GRE-MIB

Organization: Cable Television Laboratories, Inc.

Last Updated: 2015-02-04

Description: MIB for managing multiple GRE tunnels and traffic filters on CableLabs-compliant residential gateway devices

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is CLAB-GRE-MIB?

CLAB-GRE-MIB is a CableLabs residential-gateway MIB for configuring and monitoring multiple GRE tunnels and associated traffic filters on cable operator premises equipment. It exposes both configuration data -- tunnel enable state, remote endpoints, keepalive policy/timeout -- and status data through clabGRETunnelStatus, which reflects whether a given tunnel is actually up. Its monitoring value centers on tunnel/software health: an operator can tell whether a configured GRE tunnel is enabled but down, which is a direct indicator of a connectivity fault on the gateway, and can tune keepalive timing to control how quickly that fault is detected. It is part of the CableLabs DOCSIS residential-gateway MIB family and presumably builds on standard tunnel/interface conventions for its row-status and table structure. The CLAB-GRE-MIB MIB is deployed by cable operators managing fleets of gateways that use GRE tunneling for backhaul or service segregation.

IPNetwork Monitor allows you to monitor SNMP objects defined in CLAB-GRE-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

CableLabs DOCSIS residential gateways
cable modem/gateway devices supporting GRE tunneling

Monitoring Examples

An admin polling clabGRETunnelTable/Entry across a fleet of gateways would check clabGRETunnelStatus for each clabGRETunnelIndex to spot tunnels that are enabled (clabGRETunnelEnable true) but not actually up. clabGRETunnelRemoteEndpoints identifies which peer the tunnel should be reaching, useful when diagnosing a specific failed path. clabGRETunnelKeepAlivePolicy and clabGRETunnelKeepAliveTimeout let the operator understand how quickly a down tunnel would be detected and reflected in status.

What Can Be Monitored

GRE tunnel operational status (up/down)
number of configured tunnels and filters
tunnel enable/disable configuration
tunnel keepalive policy and timeout
remote tunnel endpoint configuration

Imported Objects

From CLAB-DEF-MIB

clabCommonMibs

OBJECT-IDENTITY

From SNMP-FRAMEWORK-MIB

SnmpAdminString

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Counter64
Integer32
MODULE-IDENTITY
OBJECT-TYPE
Unsigned32

From SNMPv2-TC

RowStatus
TruthValue

How to Use in IPNetwork Monitor

Example using clabGRETunnelStatsKeepAliveSent OID:

Select a CableLabs DOCSIS residential gateway (GRE tunnels) as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type clabGRETunnelStatsKeepAliveSent into the Find box to locate it in the OID tree, selecting the specific row/instance you want to monitor since this is a table column, then select it and click OK. It reports the number keepalive packets sent. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is a Counter64-type OID, Value bounds is the most useful condition here — trigger an alert if the counter increases sharply between polls relative to its normal baseline (in packets), since an unexpected spike often reflects a real change in traffic or activity. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
clabGREMib	1.3.6.1.4.1.4491.4.3			This MIB module contains the management objects for multiple GRE tunnels in residential gateway devices.
clabGREObjects	1.3.6.1.4.1.4491.4.3.1
U32 clabGRETunnelNumberOfEntries	1.3.6.1.4.1.4491.4.3.1.1	Unsigned32	read-only	Number of configured entries in the Tunnel table.
U32 clabGREFilterNumberOfEntries	1.3.6.1.4.1.4491.4.3.1.2	Unsigned32	read-only	Number of configured entries in the Filter table.
clabGRETunnelTable	1.3.6.1.4.1.4491.4.3.1.3		not-accessible	This table allows configuration and monitoring of GRE tunnels.
clabGRETunnelEntry	1.3.6.1.4.1.4491.4.3.1.3.1		not-accessible	This table allows configuration and monitoring of GRE tunnels.
U32 clabGRETunnelIndex	1.3.6.1.4.1.4491.4.3.1.3.1.1	Unsigned32	not-accessible	Table index. These ifIndex values are the GRE tunnel index number.
ROW clabGRETunnelRowStatus	1.3.6.1.4.1.4491.4.3.1.3.1.2	RowStatus	read-create	The RowStatus interlock for the creation and deletion of a table entry.
T/F clabGRETunnelEnable	1.3.6.1.4.1.4491.4.3.1.3.1.3	TruthValue	read-create	Enables or disable this GRE tunnel.
INT clabGRETunnelStatus	1.3.6.1.4.1.4491.4.3.1.3.1.4	INTEGER	read-only	The status of this tunnel. The errorMisconfigured value indicates that a necessary configuration value is undefined or invalid. The error value MAY be used by the CPE to indicate a locally defined error condition. retryWait indicates that all concentrators have been detected as failed and a FailureInterval is in progress before retrying again.
STR clabGRETunnelAlias	1.3.6.1.4.1.4491.4.3.1.3.1.5	SnmpAdminString	read-create	A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
OCT clabGRETunnelRemoteEndpoints	1.3.6.1.4.1.4491.4.3.1.3.1.6	OCTET STRING	read-create	Comma-separated list (up to 4 items) of strings (maximum item length 256). The Fully Qualified Domain Name (FQDN) or IP address of the remote GRE tunnel endpoint. If TunnelConcentratorServiceName is set, this field is ignored. If more than one name/address is supplied, they will be tried in turn, i.e. they are in decreasing order of precedence. IPv4 or IPv6 addresses are accepted.
INT clabGRETunnelKeepAlivePolicy	1.3.6.1.4.1.4491.4.3.1.3.1.7	INTEGER	read-create	The mechanism used to keep the tunnel from timing out.
U32 clabGRETunnelKeepAliveTimeout	1.3.6.1.4.1.4491.4.3.1.3.1.8	Unsigned32	read-create	Time to wait for a response to a keep alive message.
U32 clabGRETunnelKeepAliveThreshold	1.3.6.1.4.1.4491.4.3.1.3.1.9	Unsigned32	read-create	Number of KeepAlive messages unacknowledged by the ConnectedRemoteEndpoint before the Tunnel is perceived failed.
U32 clabGRETunnelKeepAliveCount	1.3.6.1.4.1.4491.4.3.1.3.1.10	Unsigned32	read-create	Number of keep-alive messages sent in a burst at regular intervals.
U32 clabGRETunnelKeepAliveInterval	1.3.6.1.4.1.4491.4.3.1.3.1.11	Unsigned32	read-create	Interval in seconds between keep-alive message bursts.
U32 clabGRETunnelKeepAliveFailureInterval	1.3.6.1.4.1.4491.4.3.1.3.1.12	Unsigned32	read-create	Time (in seconds) to wait after all available GRE concentrators fail to respond, before retrying first GRE concentrator address.
U32 clabGRETunnelKeepAliveRecoverInterval	1.3.6.1.4.1.4491.4.3.1.3.1.13	Unsigned32	read-create	Time (in seconds) to remain on a secondary GRE concentrator, with clients connected, before retrying primary GRE concentrator. Zero value means no limit. Setting to a small non-zero value will cause an immediate switch from a secondary GRE concentrator back to the primary.
INT clabGRETunnelDeliveryHeaderProtocol	1.3.6.1.4.1.4491.4.3.1.3.1.14	INTEGER	read-create	If ConcentratorServiceName or RemoteEndpoint FQDNs are provided, TunnelDeliveryHeaderProtocol determines whether IPv4 or IPv6 addresses are requested from DNS.
U32 clabGRETunnelDefaultDscpMark	1.3.6.1.4.1.4491.4.3.1.3.1.15	Unsigned32	read-create	If the specified entries in the Filter table do not match a packet, then the value of this parameter is applied to the delivery header of the packet.
STR clabGRETunnelConnectedRemoteEndpoint	1.3.6.1.4.1.4491.4.3.1.3.1.16	SnmpAdminString	read-only	The Fully Qualified Domain Name (FQDN) name or IP address of the currently connected remote GRE tunnel endpoint.
U32 clabGRETunnelInterfaceNumberOfEntries	1.3.6.1.4.1.4491.4.3.1.3.1.17	Unsigned32	read-only	Number of configured entries in the TunnelInterface table for this tunnel.
U32 clabGRETunnelTcpMssClamping	1.3.6.1.4.1.4491.4.3.1.3.1.18	Unsigned32	read-create	Specifies whether TCP MSS clamping is enabled on the tunnel. 0 disables clamping, 1 clamps the MSS depending on the interface MTU. A value > 1 will be used as clamping size. See Reference: RFC 4459
STR clabGRETunnelConcentratorServiceName	1.3.6.1.4.1.4491.4.3.1.3.1.19	SnmpAdminString	read-create	FQDN of GRE tunnel concentrator/gw service. If this is set, then a DNS query of type SRV will be used for discovering the FQDN of remote endpoints of GRE tunnel.
OCT clabGRETunnnelRemoteEndpointConnectivityState	1.3.6.1.4.1.4491.4.3.1.3.1.20	OCTET STRING	read-only	Comma-separated list (up to 4 items) of strings. Each item corresponds to one item in the RemoteEndpoints list, and contains one of the following strings: 'Reachable' indicates that the corresponding remote endpoint is responding to any configured KeepAlive messages. 'Unreachable' indicates that the remote endpoint has failed to adequately respond to the most recent KeepAlive attempt. 'NotInUse' indicates that the remote endpoint has not been used. 'NoKeepAlives' indicates that the KeepAlive policy is set to 'none'.
clabGRETunnelStatsTable	1.3.6.1.4.1.4491.4.3.1.4		not-accessible	This table provides statistical information of GRE tunnels. This table extends clabGRETunnelTable. The index used is imported from the clabGRETunnelTable. If a row is deleted from clabGRETunnelTable, then the extension row will also be deleted.
clabGRETunnelStatsEntry	1.3.6.1.4.1.4491.4.3.1.4.1		not-accessible	Each table entry provides statistical information on a GRE tunnel.
C64 clabGRETunnelStatsKeepAliveSentEx	1.3.6.1.4.1.4491.4.3.1.4.1.1	Counter64	read-only	Number keepalive packets sent.
C64 clabGRETunnelStatsKeepAliveReceived	1.3.6.1.4.1.4491.4.3.1.4.1.2	Counter64	read-only	Number keepalive packets received.
C64 clabGRETunnelStatsBytesSent	1.3.6.1.4.1.4491.4.3.1.4.1.3	Counter64	read-only	Number bytes sent.
C64 clabGRETunnelStatsBytesReceived	1.3.6.1.4.1.4491.4.3.1.4.1.4	Counter64	read-only	Number bytes received.
C64 clabGRETunnelStatsPacketsSent	1.3.6.1.4.1.4491.4.3.1.4.1.5	Counter64	read-only	Number packets sent.
C64 clabGRETunnelStatsPacketsReceived	1.3.6.1.4.1.4491.4.3.1.4.1.6	Counter64	read-only	Number packets received.
C64 clabGRETunnelStatsErrorsSent	1.3.6.1.4.1.4491.4.3.1.4.1.7	Counter64	read-only	Number packets received that were discarded. Because source network interface is down.
C64 clabGRETunnelStatsErrorsReceived	1.3.6.1.4.1.4491.4.3.1.4.1.8	Counter64	read-only	Number packets received that were in error. Because tunnel packets are not correct type. Eg. Received IP packet instead of L2 packets.
clabGRETunnelInterfaceTable	1.3.6.1.4.1.4491.4.3.1.5		not-accessible	This table contains information specific to network source interface whose traffic is mapped into a GRE tunnel.
clabGRETunnelInterfaceEntry	1.3.6.1.4.1.4491.4.3.1.5.1		not-accessible	List of individual source interface entries mapped into GRE tunnels.
U32 clabGRETunnelInterfaceIndex	1.3.6.1.4.1.4491.4.3.1.5.1.1	Unsigned32	not-accessible	The key for a unique instance of this object.
ROW clabGRETunnelInterfaceRowStatus	1.3.6.1.4.1.4491.4.3.1.5.1.2	RowStatus	read-create	The RowStatus interlock for the creation and deletion of a table entry.
T/F clabGRETunnelInterfaceEnable	1.3.6.1.4.1.4491.4.3.1.5.1.3	TruthValue	read-create	Enable or disable mapping traffic from network interface into GRE tunnel.
INT clabGRETunnelInterfaceStatus	1.3.6.1.4.1.4491.4.3.1.5.1.4	INTEGER	read-only	The status of this TunnelInterface. When Enable is false then Status SHOULD normally be Down (or NotPresent or Error if there is a fault condition on the interface). When Enable is changed to true then Status SHOULD change to Up if and only if the interface is able to transmit and receive network traffic; it SHOULD change to Dormant if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to Up if still operable when the expected actions have completed); it SHOULD change to LowerLayerDown if and only if the interface is prevented from entering the Up state because one or more of the interfaces beneath it is down; it SHOULD remain in the Error state if there is an error or other fault condition detected on the interface; it SHOULD remain in the NotPresent state if the interface has missing (typically hardware) components; it SHOULD change to Unknown if the state of the interface can not be determined for some reason.
STR clabGRETunnelInterfaceAlias	1.3.6.1.4.1.4491.4.3.1.5.1.5	SnmpAdminString	read-create	A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
STR clabGRETunnelInterfaceName	1.3.6.1.4.1.4491.4.3.1.5.1.6	SnmpAdminString	read-create	GRE tunnel interface name (The textual name of the tunnel interface as assigned by the CPE)
U32 clabGRETunnelInterfaceLastChange	1.3.6.1.4.1.4491.4.3.1.5.1.7	Unsigned32	read-only	The accumulated time in seconds since the tunnel interface entered its current operational state.
STR clabGRETunnelInterfaceLowerLayers	1.3.6.1.4.1.4491.4.3.1.5.1.8	SnmpAdminString	read-create	Comma-separated list of source ifIndex values whose traffic will be passed through the GRE tunnel associated with this TunnelInterface. Interface numbers are defined according to Annex A of the eRouter specification.
U32 clabGRETunnelInterfaceProtocolIdOverride	1.3.6.1.4.1.4491.4.3.1.5.1.9	Unsigned32	read-create	The protocol ID assigned to this TunnelInterface. The Protocol ID is the EtherType value used to identify the encapsulated payload. When set to 0 the CPE determines the Protocol Id.
T/F clabGRETunnelInterfaceUseChecksum	1.3.6.1.4.1.4491.4.3.1.5.1.10	TruthValue	read-create	Enable or disable optional checksum in outgoing GRE packets.
INT clabGRETunnelInterfaceKeyIdentifierGenerationPolicy	1.3.6.1.4.1.4491.4.3.1.5.1.11	INTEGER	read-create	Control over optional Key field in GRE header of outgoing packets. Disabled means key is not present, provisioned uses the value provided in the key field, generated means CPE will generate key.
U32 clabGRETunnelInterfaceKeyIdentifier	1.3.6.1.4.1.4491.4.3.1.5.1.12	Unsigned32	read-create	When KeyIdentifierGenerationPolicy is provisioned, this is the value for the Key header.
T/F clabGRETunnelInterfaceUseSequenceNumber	1.3.6.1.4.1.4491.4.3.1.5.1.13	TruthValue	read-create	Enable or disable optional sequence number field in outgoing GRE packets.
clabGRETunnelInterfaceStatsTable	1.3.6.1.4.1.4491.4.3.1.6		not-accessible	This table provides statistical information of GRE tunnel interfaces. This table extends clabGRETunnelInterfaceTable. The index used is imported from the clabGRETunnelInterfaceTable. If a row is deleted from clabGRETunnelInterfaceTable, then the extension row will also be deleted.
clabGRETunnelInterfaceStatsEntry	1.3.6.1.4.1.4491.4.3.1.6.1		not-accessible	Each table entry provides statistical information on a GRE tunnel.
C64 clabGRETunnelInterfaceStatsBytesSent	1.3.6.1.4.1.4491.4.3.1.6.1.1	Counter64	read-only	Number bytes sent.
C64 clabGRETunnelInterfaceStatsBytesReceived	1.3.6.1.4.1.4491.4.3.1.6.1.2	Counter64	read-only	Number bytes received.
C64 clabGRETunnelInterfaceStatsPacketsSent	1.3.6.1.4.1.4491.4.3.1.6.1.3	Counter64	read-only	Number packets sent.
C64 clabGRETunnelInterfaceStatsPacketsReceived	1.3.6.1.4.1.4491.4.3.1.6.1.4	Counter64	read-only	Number packets received.
C64 clabGRETunnelInterfaceStatsErrorsSent	1.3.6.1.4.1.4491.4.3.1.6.1.5	Counter64	read-only	Number packets received that were discarded. Because source network interface is down.
C64 clabGRETunnelInterfaceStatsErrorsReceived	1.3.6.1.4.1.4491.4.3.1.6.1.6	Counter64	read-only	Number packets received that were in error. Because tunnel packets are not correct type. Eg. Received IP packet instead of L2 packets.
C64 clabGRETunnelInterfaceStatsDiscardChecksumReceived	1.3.6.1.4.1.4491.4.3.1.6.1.7	Counter64	read-only	The total number of packets received by the tunnel interface that are discarded because of Checksum errors.
C64 clabGRETunnelInterfaceStatsDiscardSequenceNumberReceived	1.3.6.1.4.1.4491.4.3.1.6.1.8	Counter64	read-only	The total number of packets received by the tunnel interface that are discarded because of Sequence Number errors.
clabGREFilterTable	1.3.6.1.4.1.4491.4.3.1.7		not-accessible	This table contains settings to allow packets passing through any tunnel, a particular tunnel, or a particular tunnel interface to have defined header modifications made. Entries in this table are applied against the packets that are to be encapsulated within the GRE Tunnel based on the following conditions. Filter table entries are in priority order, with the lowest Order values being the highest priority. Only the first enabled matching entry is applied to each packet. * If the value of FilterAllInterfaces is true, then this entry applies to all Tunnel and TunnelInterface instances. * Otherwise, this filter applies to the Tunnel or TunnelInterface referenced by FilterInterface. * For enabled table entries, if FilterInterface is not valid, then the table entry is inoperable and the CPE MUST set Status to errorMisconfigured. For each packet, enabled entries are checked from lowest to highest Order, and the first table entry that matches according to the AllInterfaces, Interface, VlanIdCheck, and VlanIdExclude criteria is applied to the packet. All other Filter entries are ignored.
clabGREFilterEntry	1.3.6.1.4.1.4491.4.3.1.7.1		not-accessible	List of individual filter entries.
U32 clabGREFilterIndex	1.3.6.1.4.1.4491.4.3.1.7.1.1	Unsigned32	not-accessible	The key for a unique instance of this object.
ROW clabGREFilterRowStatus	1.3.6.1.4.1.4491.4.3.1.7.1.2	RowStatus	read-create	The RowStatus interlock for the creation and deletion of a table entry.
T/F clabGREFilterEnable	1.3.6.1.4.1.4491.4.3.1.7.1.3	TruthValue	read-create	Enable or disable this filter to modify packets.
INT clabGREFilterStatus	1.3.6.1.4.1.4491.4.3.1.7.1.4	INTEGER	read-only	The status of this filter. The errorMisconfigured value indicates that a necessary configuration value is undefined or invalid. The error value MAY be used by the CPE to indicate a locally defined error condition.
U32 clabGREFilterOrder	1.3.6.1.4.1.4491.4.3.1.7.1.5	Unsigned32	read-create	Position of the Filter entry in the order of precedence. A value of 1 indicates the first entry considered (highest precedence). For each packet, the highest ordered entry that matches the filter criteria is applied. All lower order entries are ignored. When this value is modified, if the value matches that of an existing entry, the Order value for the existing entry and all lower Order entries is incremented (lowered in precedence) to ensure uniqueness of this value. A deletion causes Order values to be compacted. When a value is changed, incrementing occurs before compaction. The value of Order on creation of a Filter table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).
STR clabGREFilterAlias	1.3.6.1.4.1.4491.4.3.1.7.1.6	SnmpAdminString	read-create	A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference.
STR clabGREFilterInterface	1.3.6.1.4.1.4491.4.3.1.7.1.7	SnmpAdminString	read-create	Filter criterion. This specifies the path name of a row in the Tunnel or TunnelInterface table to which the filter is applied.
T/F clabGREFilterAllInterfaces	1.3.6.1.4.1.4491.4.3.1.7.1.8	TruthValue	read-create	Filter criterion. If false, this filter only applies to the Tunnel or TunnelInterface referred to by FilterInterface. If true, this filter applies to all TunnelInterfaces for all Tunnels.
I32 clabGREFilterVlanIdCheck	1.3.6.1.4.1.4491.4.3.1.7.1.9	Integer32	read-create	Filter criterion. Current outer Ethernet VLAN ID as defined in 802.1Q. A value of -1 indicates this criterion is not used for filtering.
T/F clabGREFilterVlanIdExclude	1.3.6.1.4.1.4491.4.3.1.7.1.10	TruthValue	read-create	If false, the filter includes only those packets that match the VlanIdCheck entry, if specified. If true, the filter includes all packets except those that match the VlanIdCheck entry, if specified.
I32 clabGREFilterDscpMarkPolicy	1.3.6.1.4.1.4491.4.3.1.7.1.11	Integer32	read-create	The method is used to set the 6 bits of the DSCP field in the IPv4 header or traffic class in IPv6 header of the GRE packet. A value of -1 indicates copy from the upstream packet. A value of -2 indicates automatic marking of DSCP.
U32 clabGREFilterVlanTag	1.3.6.1.4.1.4491.4.3.1.7.1.12	Unsigned32	read-create	Add VLAN tag consists of 16bit of Tag Protocol Identifier (TPID) and 16 bit of Tag Control Identifier (TCI). Value of 0 will disable adding VLAN tag. Tag Protocol Identifier (TPID) should set to 0x8100.
clabGREMibConformance	1.3.6.1.4.1.4491.4.3.2
clabGREMibCompliances	1.3.6.1.4.1.4491.4.3.2.1
clabGRECompliance	1.3.6.1.4.1.4491.4.3.2.1.1			The compliance statement for entities which implement the GRE MIB.
clabGREMibGroups	1.3.6.1.4.1.4491.4.3.2.2
clabGREGroup	1.3.6.1.4.1.4491.4.3.2.2.1			A collection of objects providing instrumentation and control over GRE tunnels.

RFC description

CableLabs-defined MIB for Generic Routing Encapsulation (GRE) tunnel management; manages GRE tunnel configuration and statistics on cable equipment.

Start monitoring CableLabs DOCSIS residential gateways (GRE tunnels) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download CLAB-GRE-MIB