CABH-CAP-MIB

File: CABH-CAP-MIB.mib (29951 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
INET-ADDRESS-MIB CLAB-DEF-MIB SNMP-FRAMEWORK-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
Integer32 TimeStamp TruthValue
RowStatus DateAndTime PhysAddress
OBJECT-GROUP MODULE-COMPLIANCE InetAddressType
InetAddress InetPortNumber clabProjCableHome
SnmpAdminString

Defined Types

CabhCapMappingEntry  
SEQUENCE    
  cabhCapMappingIndex INTEGER
  cabhCapMappingWanAddrType InetAddressType
  cabhCapMappingWanAddr InetAddress
  cabhCapMappingWanPort InetPortNumber
  cabhCapMappingLanAddrType InetAddressType
  cabhCapMappingLanAddr InetAddress
  cabhCapMappingLanPort InetPortNumber
  cabhCapMappingMethod INTEGER
  cabhCapMappingProtocol INTEGER
  cabhCapMappingRowStatus RowStatus
  cabhCapMappingNumPorts Unsigned32
  cabhCapMappingRowDescr SnmpAdminString
  cabhCapMappingCreateTime DateAndTime
  cabhCapMappingLastUpdateTime DateAndTime
  cabhCapMappingDuration Integer32
  cabhCapMappingRemoteHostAddrType InetAddressType
  cabhCapMappingRemoteHostAddr InetAddress
  cabhCapMappingEnable TruthValue

CabhCapPassthroughEntry  
SEQUENCE    
  cabhCapPassthroughIndex INTEGER
  cabhCapPassthroughMacAddr PhysAddress
  cabhCapPassthroughRowStatus RowStatus

Defined Values

cabhCapMib 1.3.6.1.4.1.4491.2.4.3
This MIB module supplies the basic management objects for the CableHome Addressing Portal (CAP) portion of the PS.
MODULE-IDENTITY    

cabhCapObjects 1.3.6.1.4.1.4491.2.4.3.1
OBJECT IDENTIFIER    

cabhCapBase 1.3.6.1.4.1.4491.2.4.3.1.1
OBJECT IDENTIFIER    

cabhCapMap 1.3.6.1.4.1.4491.2.4.3.1.2
OBJECT IDENTIFIER    

cabhCapTcpTimeWait 1.3.6.1.4.1.4491.2.4.3.1.1.1
This object is the maximum inactivity time to wait before assuming TCP session is terminated. It has no relation to the TCP session TIME_WAIT state referred to in [RFC793].
OBJECT-TYPE    
  Unsigned32  

cabhCapUdpTimeWait 1.3.6.1.4.1.4491.2.4.3.1.1.2
The inactivity time to wait before destroying CAP mappings for UDP.
OBJECT-TYPE    
  Unsigned32  

cabhCapIcmpTimeWait 1.3.6.1.4.1.4491.2.4.3.1.1.3
The inactivity time to wait before destroying CAP mappings for ICMP.
OBJECT-TYPE    
  Unsigned32  

cabhCapPrimaryMode 1.3.6.1.4.1.4491.2.4.3.1.1.4
The Primary Packet-handling Mode of the Portal Services logical element (PS) of a CableHome compliant residential gateway device. This object configures operation of the PS packet handling functions. When the value of this object is napt(1), the PS is required to support the Network Address and Port Translation (NAPT) process in accordance with the NAPT requirements defined in IETF RFC 3022. When operating in NAPT Primary Packet Handling Mode, the PS supports the translation of multiple LAN-Trans IP addresses and their TCP/UDP ports into a single WAN-Data IP address and its TCP/UDP ports. When the value of this object is nat(2), the PS is required to support the Network Address Translation (NAT) process in accordance with the NAT equirements defined in IETF RFC 3022. When operating in NAT Primary Packet Handling Mode, the PS supports the translation of multiple LAN-Trans IP addresses into the same number of unique WAN-Data IP addresses. When the value of this object is passthrough(3), the PS is required to act as a transparent bridge in accordance with IEEE 802.1D. When operating in Passthrough Primary Packet Handling Mode, the PS does not translate network addresses, and bridges all traffic between its LAN and WAN interfaces. The PS MUST delete dynamically-created row entries from the cabhCapMappingTable, i.e. those with cabhCapMappingMethod = dynamic(2), when the value of cabhCapPrimaryMode changes. The PS MUST NOT delete statically-created row entries from the cabhCapMappingTable where cabhCapMappingMethod = static(1), when the value of cabhCapPrimaryMode changes.
OBJECT-TYPE    
  INTEGER napt(1), nat(2), passthrough(3)  

cabhCapSetToFactory 1.3.6.1.4.1.4491.2.4.3.1.1.5
Reading this object always returns false(2). When the cabhCapSetToFactory object is set to true(1), the PS must take the following actions: 1. Clear all entries in the cabhCapMappingTable and cabhCapPassthroughTable. 2. Reset the following objects to their factory default values: cabhCapTcpTimeWait, cabhCapUdpTimeWait, cabhCapIcmpTimeWait, cabhCapPrimaryMode
OBJECT-TYPE    
  TruthValue  

cabhCapLastSetToFactory 1.3.6.1.4.1.4491.2.4.3.1.1.6
The value of sysUpTime when cabhCapSetToFactory was last set to true. Zero if never reset.
OBJECT-TYPE    
  TimeStamp  

cabhCapUpnpPortForwardingEnable 1.3.6.1.4.1.4491.2.4.3.1.1.7
This MIB is effective only when the PS is performing NAPT. If this MIB object is set to false(2), the PS MUST disable the UPnP WANIpConnection Service in the CableHome PS. If this MIB object is set to true(1), the PS MUST enable the WANIpConnection service in the PS. When the primary packet handling mode of the PS is C-NAT (2) or Passthrough(3), setting this MIB to true(1) MUST return InconsistentValue error.
OBJECT-TYPE    
  TruthValue  

cabhCapUpnpTimeWait 1.3.6.1.4.1.4491.2.4.3.1.1.8
The inactivity time to wait before destroying CAP mappings created by UPnP control points. The value of 0 indicates inactivity time wait of infinity, i.e. a UPnP entry doesn't get destroyed based on inactivity period.
OBJECT-TYPE    
  Unsigned32  

cabhCapMappingTable 1.3.6.1.4.1.4491.2.4.3.1.2.1
This table contains IP address mappings between private network addresses, or network addresses and port numbers/ICMP Identifiers, assigned to devices on the subscriber's home LAN, and network addresses, or network addresses and port numbers/ICMP Identifiers on the WAN, presumed to be on a separate subnetwork than the private IP addresses. The CAP Mapping Table is used by the CableHome Address Portal (CAP) function of the PS to make packet forwarding decisions.
OBJECT-TYPE    
  SEQUENCE OF  
    CabhCapMappingEntry

cabhCapMappingEntry 1.3.6.1.4.1.4491.2.4.3.1.2.1.1
List of the private IP (LAN) address - to - cable operator assigned IP (WAN) address mappings stored in the PS and used by the PS to make packet forwarding decisions.
OBJECT-TYPE    
  CabhCapMappingEntry  

cabhCapMappingIndex 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.1
The Index into the CAP Mapping Table.
OBJECT-TYPE    
  INTEGER 1..65535  

cabhCapMappingWanAddrType 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.2
The IP address type assigned on the WAN side.
OBJECT-TYPE    
  InetAddressType  

cabhCapMappingWanAddr 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.3
The IP address assigned by the cable operator's address (DHCP) server, and comprising the WAN-side IP address of the CAP Mapping tuple. This object is populated either dynamically by LAN-to-WAN outbound traffic or statically by the cable operator.
OBJECT-TYPE    
  InetAddress  

cabhCapMappingWanPort 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.4
The TCP/UDP port number or ICMP Identifier on the WAN side. A port number/Identifier of 0 indicates either a NAT or a DMZ mapping. A non-zero port number/Identifier indicates a NAPT mapping. If the value of cabhCapMappingNumPorts MIB object is non-zero this MIB represents a starting TCP/UDP port number on the WAN side for which a mapping entry is created.
OBJECT-TYPE    
  InetPortNumber  

cabhCapMappingLanAddrType 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.5
The IP address type assigned on the LAN side.
OBJECT-TYPE    
  InetAddressType  

cabhCapMappingLanAddr 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.6
The IP address of the LAN-Trans IP Device. This object is populated either dynamically as a result of LAN-to-WAN outbound traffic or statically by the cable operator.
OBJECT-TYPE    
  InetAddress  

cabhCapMappingLanPort 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.7
The TCP/UDP port number or ICMP Identifier on the LAN side. A port number/Identifier of 0 indicates either a DMZ mapping or a NAT mapping. A non-zero port number/Identifier indicates a NAPT mapping. If the value of cabhCapMappingNumPorts MIB object is non-zero then this MIB represents a starting TCP/UDP port number on the LAN side for which a mapping entry is created.
OBJECT-TYPE    
  InetPortNumber  

cabhCapMappingMethod 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.8
Indicates how this mapping was created. Static means that it was provisioned, and dynamic means that it was handled by the PS itself. upnp (3) means that the CAP mapping entry was created by some UPnP compliant application.
OBJECT-TYPE    
  INTEGER static(1), dynamic(2), upnp(3)  

cabhCapMappingProtocol 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.9
The protocol for this mapping entry. The value of other(1) represents a protocol other than ICMP, TCP, and UDP. Thus, when the value other(1) is specified for the cabhCapMappingProtocol value of a CAP Mapping Table entry, TCP, UDP or ICMP packets MUST NOT be forwarded even if the WAN and LAN IP address and port tuple of the packet matches with mapping entry. The value of all(255) represents all protocol types. Thus, when the cabhCapMappingProtocol value all(255) is specified for an entry in the CAP Mapping Table, traffic of all protocol types MUST be forwarded accordingly f the WAN and LAN IP address and port tuple in the packet matches the mapping entry.
OBJECT-TYPE    
  INTEGER other(1), icmp(2), udp(3), tcp(4), all(255)  

cabhCapMappingRowStatus 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.10
The RowStatus interlock for the creation and deletion of a cabhCapMappingTable entry. Changing the value of the IP address or port number columns of the CAP Mapping Table may have an effect on active traffic, so the PS will prevent modification of this table's columns and return an inconsistentValue error when cabhCapMappingRowStatus object is active(1). The PS must not allow RowStatus to be set to notInService(2) by a manager. A newly created row cannot be set to active(1) until the corresponding instances of cabhCapMappingWanAddr, cabhCapMappingLanAddr, and cabhCapMappingProtocol have been set. If the manager attempts to populate a row entry in the table with a non-unique value for the combination of cabhCapMappingWanAddr and range of WAN port(s) (identified by cabhCapMappingWanPort to cabhCapMappingWanPort + cabhCapMappingNumPorts -1), or a non-unique value for the combination of cabhCapMappingLanAddr and range of LAN port(s) (identified by cabhCapMappingLanPort to cabhCapMappingLanPort + cabhCapMappingNumPorts - 1), the PS MUST prevent the creation of this row and return an inconsistentValue error. This prevents creation of entries with overlapping port ranges in the CAP table. If the manager attempts to populate a row entry with a zero value for cabhCapMappingWanPort and a non-zero value for cabhCapMappingLanPort or a row entry with a zero value for cabhCapMappingLanPort and a non-zero value for cabhCapMappingWanPort, the PS MUST prevent the creation of this row and return an inconsistentValue error. This prevents creation of invalid NAT or NAPT entries. If the manager attempts to populate a row entry with non-zero values for both cabhCapMappingWanPort and cabhCapMappingLanPort, but a zero value for cabhCapMappingNumPorts, the PS MUST prevent the creation of this row and return an inconsistentValue error. This prevents creation of NAPT entries. When Primary Packet-handling Mode is NAPT (cabhCapPrimaryMode is napt(1)), provisioned rows can be set to active(1) regardless of whether the value to which cabhCapMappingWanPort, cabhCapMappingLanPort, and cabhCapMappingNumPorts have been set is zero or nonzero. When Primary Packet-handling Mode is NAT (cabhCapPrimaryMode is nat(2)), a newly created row can not be set to active(1) if a non-zero value have been set for cabhCapMappingWanPort, cabhCapMappingLanPort and cabhCapMappingNumPorts. In NAPT Primary Packet-handling mode, a row entry with zero values for cabhCapMappingWanPort, cabhCapMappingLanPort, and cabhCapMappingNumPorts objects represents a DMZ entry.
OBJECT-TYPE    
  RowStatus  

cabhCapMappingNumPorts 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.11
This object represents number of ports available for port translation on both LAN and WAN side. When both cabhCapMappingWanPort and cabhCapMappingLanPort are set to zero, the PS MUST ignore this MIB object, and such a row entry represents either a DMZ entry (when primary packet handling mode is NAPT) or a NAT entry (when primary packet handling mode is NAT). When a row entry is created with non-zero values for cabhCapMappingWanPort, cabhCapMappingLanPort, and cabhCapMappingNumPorts the PS MUST translate range of ports on the WAN side (identified by cabhCapMappingWanPort to cabhCapMappingWanPort + cabhCapMappingNumPorts-1) to range of ports on the LAN side (identified by cabhCapMappingLanPort to cabhCapMappingLanPort + cabhCapMappingNumPorts-1). The PS MUST ignore this MIB for a CAP mapping entry with the value of cabhCapMappingProtocol equal to icmp(2).
OBJECT-TYPE    
  Unsigned32 1..65535  

cabhCapMappingRowDescr 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.12
A string value that can be used to describe the purpose or attributes of the CAP Mapping entry.
OBJECT-TYPE    
  SnmpAdminString Size(0..32)  

cabhCapMappingCreateTime 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.13
For dynamic(2) and upnp(3) CAP mapping entries the PS MUST set this MIB with date and time when the entry is created. The PS MUST set the value of this MIB to zero valued 11-byte string for static CAP mapping entries. This MIB object MUST NOT persist across the PS reboot.
OBJECT-TYPE    
  DateAndTime  

cabhCapMappingLastUpdateTime 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.14
The PS MUST set the value of this MIB to zero valued 11 byte string for static CAP mapping entries. For dynamic(2) CAP Mapping entries, the PS MUST set the value of this MIB to the value of cabhCapMappingCreateTime For upnp(3) CAP mapping entries the PS MUST set this MIB with date and time when the entry is last updated. When the upnp(3)entry is first created the PS MUST set this MIB with the value of cabhCapMappingCreateTime MIB. This MIB object MUST NOT persist across the PS reboot.
OBJECT-TYPE    
  DateAndTime  

cabhCapMappingDuration 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.15
When a value greater than zero is assigned to this object, the PS MUST remove the CAP entry after the time duration, represented by this object, elapses starting from cabhCapMappingLastUpdateTime. When a value of 0 is assigned to this object, the PS MUST retain the CAP mapping entry until reboot or reset. The PS MUST retain a CAP mapping entry with cabhCapMappingDuration MIB set to 0 and cabhCapMappingMethod set to static(1) across the reboots. The PS MUST NOT retain a CAP mapping entry with cabhCapMappingDuration MIB set to 0 and cabhCapMappingMethod set to upnp(3) across the reboots. When a value of -1 is assigned for this MIB the PS MUST ignore this MIB and MUST remove the CAP mapping entries based on TCP, UDP and ICMP inactivity time-wait depending upon their protocol type. When the cabhCapMappingMethod object is static(1), the default value for this object is 0. When the cabhCapMappingMethod object is dynamic(2), the PS MUST set the value of this object to -1. When the cabhCapMappingMethod object is upnp(3), the default value for this object is -1.
OBJECT-TYPE    
  Integer32 -1 | 0..2147483647  

cabhCapMappingRemoteHostAddrType 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.16
The IP address type for a remote host on the WAN side.
OBJECT-TYPE    
  InetAddressType  

cabhCapMappingRemoteHostAddr 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.17
The IP address of the remote host for a CAP mapping entry. The packet traversing through the PS is either originated from or is destined to this remote host. The value of all zeros for this MIB object indicates any IP address for a remote host.
OBJECT-TYPE    
  InetAddress  

cabhCapMappingEnable 1.3.6.1.4.1.4491.2.4.3.1.2.1.1.18
This MIB allows the PS to enable or disable a particular CAP mapping entry. When this MIB is set to true(1) for a CAP mapping entry, the PS MUST correctly route the traffic that matches this entry. When this MIB is set to false(2) for a CAP mapping entry, the PS MUST NOT route the traffic that matches this entry.
OBJECT-TYPE    
  TruthValue  

cabhCapPassthroughTable 1.3.6.1.4.1.4491.2.4.3.1.2.2
This table contains hardware addresses of LAN IP Devices for which the PS will bridge traffic at OSI Layer 2.
OBJECT-TYPE    
  SEQUENCE OF  
    CabhCapPassthroughEntry

cabhCapPassthroughEntry 1.3.6.1.4.1.4491.2.4.3.1.2.2.1
List of hardware addresses of LAN IP Devices for which the PS will bridge traffic at OSI Layer 2.
OBJECT-TYPE    
  CabhCapPassthroughEntry  

cabhCapPassthroughIndex 1.3.6.1.4.1.4491.2.4.3.1.2.2.1.1
The index into the CAP Passthrough Table.
OBJECT-TYPE    
  INTEGER 1..65535  

cabhCapPassthroughMacAddr 1.3.6.1.4.1.4491.2.4.3.1.2.2.1.2
Hardware address of the LAN IP Device for which the PS MUST bridge traffic at OSI Layer 2.
OBJECT-TYPE    
  PhysAddress Size(0..16)  

cabhCapPassthroughRowStatus 1.3.6.1.4.1.4491.2.4.3.1.2.2.1.3
The RowStatus interlock for the creation and deletion of a cabhCapPassthroughTable entry. Any writable object in each row can be modified at any time while the row is active(1).
OBJECT-TYPE    
  RowStatus  

cabhCapNotification 1.3.6.1.4.1.4491.2.4.3.2.0
OBJECT IDENTIFIER    

cabhCapConformance 1.3.6.1.4.1.4491.2.4.3.3
OBJECT IDENTIFIER    

cabhCapCompliances 1.3.6.1.4.1.4491.2.4.3.3.1
OBJECT IDENTIFIER    

cabhCapGroups 1.3.6.1.4.1.4491.2.4.3.3.2
OBJECT IDENTIFIER    

cabhCapBasicCompliance 1.3.6.1.4.1.4491.2.4.3.3.1.1
The compliance statement for devices that implement the CableHome Portal Services functionality.
MODULE-COMPLIANCE    

cabhCapGroup 1.3.6.1.4.1.4491.2.4.3.3.2.1
Group of objects for CableHome CAP MIB.
OBJECT-GROUP