ANCP-AN-MIB

File: ANCP-AN-MIB.mib (38109 bytes)

Imported modules

SNMPv2-SMI RMON2-MIB IF-MIB
INET-ADDRESS-MIB SNMPv2-CONF GSMP-MIB
SNMPv2-TC

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
mib-2 TimeTicks NOTIFICATION-TYPE
ZeroBasedCounter32 ifIndex InetAddressType
InetAddress InetPortNumber MODULE-COMPLIANCE
OBJECT-GROUP NOTIFICATION-GROUP GsmpVersion
GsmpNameType GsmpPartitionIdType RowStatus
TEXTUAL-CONVENTION TruthValue

Defined Types

GsmpSubVersion  
TEXTUAL-CONVENTION    
  current Unsigned32

AncpAnSessionCapabilities  
TEXTUAL-CONVENTION    
  current BITS topologyDiscovery(0), lineConfig(1), multicast(2), l2Oam(3)

AncpAnSessionConfigEntry  
SEQUENCE    
  ancpAnSessionConfigSessionId Unsigned32
  ancpAnSessionConfigRowStatus RowStatus
  ancpAnSessionConfigGsmpVersion GsmpVersion
  ancpAnSessionConfigGsmpSubVersion GsmpSubVersion
  ancpAnSessionConfigEncapsulationType INTEGER
  ancpAnSessionConfigCapabilities AncpAnSessionCapabilities
  ancpAnSessionConfigAliveTimer Unsigned32
  ancpAnSessionConfigPortReportShaper Unsigned32
  ancpAnSessionConfigAggregateReportShaper Unsigned32
  ancpAnSessionConfigTransportRetryTimer Unsigned32
  ancpAnSessionConfigAncpRetryTimer Unsigned32
  ancpAnSessionConfigAnName GsmpNameType
  ancpAnSessionConfigPartitionId GsmpPartitionIdType
  ancpAnSessionConfigWindowSize Unsigned32
  ancpAnSessionConfigNasIpAddressType InetAddressType
  ancpAnSessionConfigNasIpAddress InetAddress
  ancpAnSessionConfigEncapPortNumber InetPortNumber
  ancpAnSessionConfigNotifyDnEnable TruthValue
  ancpAnSessionConfigNotifyUpEnable TruthValue

AncpAnCurrentSessionEntry  
SEQUENCE    
  ancpAnCurrentSessionState INTEGER
  ancpAnCurrentSessionGsmpVersion GsmpVersion
  ancpAnCurrentSessionGsmpSubVersion GsmpSubVersion
  ancpAnCurrentSessionAnName GsmpNameType
  ancpAnCurrentSessionNasName GsmpNameType
  ancpAnCurrentSessionAnIpAddressType InetAddressType
  ancpAnCurrentSessionAnIpAddress InetAddress
  ancpAnCurrentSessionAnInstance Unsigned32
  ancpAnCurrentSessionNasInstance Unsigned32
  ancpAnCurrentSessionCapabilities AncpAnSessionCapabilities
  ancpAnCurrentSessionStartUptime TimeTicks
  ancpAnCurrentSessionDiscontinuityTime TimeTicks
  ancpAnCurrentSessionStatSentMessages ZeroBasedCounter32
  ancpAnCurrentSessionStatReceivedValidMessages ZeroBasedCounter32
  ancpAnCurrentSessionStatDiscardedMessages ZeroBasedCounter32

AncpAnInterfaceConfigEntry  
SEQUENCE    
  ancpAnInterfaceConfigPartitionId GsmpPartitionIdType

Defined Values

ancpAnMIB 1.3.6.1.2.1.1
The MIB module for entities implementing the access node side of the Access Node Control Protocol (ANCP). Copyright (C) The IETF Trust (2007). The initial version of this MIB module was published in RFC yyyy; for full legal notices see the RFC itself.
MODULE-IDENTITY    

ancpAnNotifications 1.3.6.1.2.1.1.0
OBJECT IDENTIFIER    

ancpAnObjects 1.3.6.1.2.1.1.1
OBJECT IDENTIFIER    

ancpAnConformance 1.3.6.1.2.1.1.2
OBJECT IDENTIFIER    

ancpAnPartitionsUsed 1.3.6.1.2.1.1.1.1
This object allows the manager to specify whether or not to use the 'Partition ID' field in the GSMP message header. When set to 'partitionsUnused' the application does not use partitions and the ancpAnSessionConfigPartitionId object MUST be zero for all sessions. In addition, rows SHOULD not be created in the ancpAnInterfaceConfigTable. When set to 'partitionsUsed' the application uses partitions and the ancpAnSessionConfigPartitionId object MUST be set, for every session, to a nonzero value. In such a case, rows are created in ancpAnInterfaceConfigTable. The default value zero in ancpAnInterfaceConfigPartitionId object means that the operator did not associate the interface with a particular partition. Note that modifying the value of this object is restricted. E.g., prior to setting it from 'partitionsUsed' to 'partitionsUnused' ancpAnSessionConfigRowStatus objects for all sessions should be set to notInService and the partition ID value MUST be set to zero. The value of this object is persistent.
OBJECT-TYPE    
  INTEGER partitionsUnused(1), partitionsUsed(2)  

ancpAnNextSessionId 1.3.6.1.2.1.1.1.2
The object reports the next index (potential value of ancpAnSessionConfigSessionId) which is available for creating a new row in ancpAnSessionConfigTable. If no such value is available (e.g., the table is full or any other reason) the object reports '0' (zero). An available value V becomes unavailable when a row is actually created with ancpAnSessionConfigSessionId=V and until then consecutive GET commands with this object may return the same value V. Note that eventually only one row creation with the value V can succeed. An unavailable value V becomes available again when a row with ancpAnSessionConfigSessionId=V in ancpAnSessionConfigTable is deleted.
OBJECT-TYPE    
  Unsigned32  

ancpAnSessionConfigTable 1.3.6.1.2.1.1.1.3
This table represents the ANCP sessions in the access node. An entry in this table needs to be configured (created) before an ANCP session might be started.
OBJECT-TYPE    
  SEQUENCE OF  
    AncpAnSessionConfigEntry

ancpAnSessionConfigEntry 1.3.6.1.2.1.1.1.3.1
An entry in the table showing the data for a specific actual or yet to be established session. If partitions are used, one session corresponds to one specific access node partition.
OBJECT-TYPE    
  AncpAnSessionConfigEntry  

ancpAnSessionConfigSessionId 1.3.6.1.2.1.1.1.3.1.1
A system generated index to distinguish between different sessions. Session may be actually established or just potential.
OBJECT-TYPE    
  Unsigned32 1..255  

ancpAnSessionConfigRowStatus 1.3.6.1.2.1.1.1.3.1.2
An object that allows entries in this table to be created, modified and deleted using the RowStatus convention. A SET operation to any other attribute in this row, when this object is set to 'active' (1), MUST be rejected with an SNMP error (e.g., inconsistentValue). In order to perform a SET operation to any other attribute in this table the manager MUST set this object to notInService (2). After setting the object back to 'active' the implementation MAY tear down the session and recreate it, depending on what session attributes have been modified.
OBJECT-TYPE    
  RowStatus  

ancpAnSessionConfigGsmpVersion 1.3.6.1.2.1.1.1.3.1.3
The maximum version number of the GSMP protocol that may be used in this session. The value of this object is persistent.
OBJECT-TYPE    
  GsmpVersion  

ancpAnSessionConfigGsmpSubVersion 1.3.6.1.2.1.1.1.3.1.4
The maximum subversion number of the GSMP protocol that may be used in this session. The value of this object is persistent.
OBJECT-TYPE    
  GsmpSubVersion  

ancpAnSessionConfigEncapsulationType 1.3.6.1.2.1.1.1.3.1.5
Required encapsulation for this session. The value of this object is persistent.
OBJECT-TYPE    
  INTEGER tcp(1)  

ancpAnSessionConfigCapabilities 0.3.1.3.6.1.2.1.1.1.3.1.6
ANCP capabilities supported by the AN in this session. When all bits are set to zero then this means that no capabilities are supported. The value of this object is persistent.
OBJECT-TYPE    
  AncpAnSessionCapabilities  

ancpAnSessionConfigAliveTimer 1.3.6.1.2.1.1.1.3.1.7
The timer specifies the nominal time between periodic adjacency protocol messages generated by the access node. It is a constant for the duration of an ANCP session. The timer is specified in units of 100ms. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 1..255  

ancpAnSessionConfigPortReportShaper 1.3.6.1.2.1.1.1.3.1.8
The timer specifies the nominal time between 2 EventReport messages related to the same port. It is a constant for the duration of a GSMP session. The timer is specified in units of 100ms. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 1..255  

ancpAnSessionConfigAggregateReportShaper 1.3.6.1.2.1.1.1.3.1.9
The timer specifies the nominal time between 2 EventReport messages related to any port. It is a constant for the duration of a GSMP session. The timer is specified in units of 10ms. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 1..2550  

ancpAnSessionConfigTransportRetryTimer 1.3.6.1.2.1.1.1.3.1.10
The timer specifies the nominal time between 2 transport connection setup attempts done by the access node. The transport protocol is specified in ancpAnSessionConfigEncapsulationType. The timer is specified in units of 100ms. A value 0 means that the access node will NOT initiate nor setup the transport connection. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 0..255  

ancpAnSessionConfigAncpRetryTimer 1.3.6.1.2.1.1.1.3.1.11
The timer specifies the nominal time between 2 ANCP connection setup attempts. The timer is specified in units of 100ms. A value 0 means that the access node will NOT spontaneously trigger an ANCP session. Whatever the setting of this timer, the access node shall always listen for ANCP session setup. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 0..255  

ancpAnSessionConfigAnName 1.3.6.1.2.1.1.1.3.1.12
The name of the access node. The first three octets must be an Organizationally Unique Identifier (OUI) that identifies the manufacturer of the access node. This can be (one of) the MAC address(es) of the access node on the network side. When set to zero, the access node shall autonomously decide on using the most appropriate MAC address of the access node. Then the actually used access node name can be read from ancpAnCurrentSessionAnName. The value of this object is persistent.
OBJECT-TYPE    
  GsmpNameType  

ancpAnSessionConfigPartitionId 1.3.6.1.2.1.1.1.3.1.13
The Id for this session's specific access node partition. This object has a meaning only if partitions are used (ancpAnPartitionsUsed='partitionsUsed') and is ignored otherwise. The value of this object is persistent.
OBJECT-TYPE    
  GsmpPartitionIdType  

ancpAnSessionConfigWindowSize 1.3.6.1.2.1.1.1.3.1.14
The maximum number of unacknowledged request messages that may be transmitted by the controller without the possibility of loss. This field is used to prevent request messages from being lost in the access node because of overflow in the receive buffer. The field is a hint to the controller. The value of this object is persistent.
OBJECT-TYPE    
  Unsigned32 1..65535  

ancpAnSessionConfigNasIpAddressType 1.3.6.1.2.1.1.1.3.1.15
The type of address in ancpAnSessionConfigNasIpAddress. The value of this object is persistent.
OBJECT-TYPE    
  InetAddressType  

ancpAnSessionConfigNasIpAddress 1.3.6.1.2.1.1.1.3.1.16
The IP address used for the ANCP session peer (NAS). The value of this object is persistent.
OBJECT-TYPE    
  InetAddress  

ancpAnSessionConfigEncapPortNumber 1.3.6.1.2.1.1.1.3.1.17
The port number used for the transport protocol establishment to the ANCP peer. The value of this object is persistent.
OBJECT-TYPE    
  InetPortNumber  

ancpAnSessionConfigNotifyDnEnable 1.3.6.1.2.1.1.1.3.1.18
This object specifies if ancpAnSessionDown notification should be generated when this session leaves the 'estab' state as given by ancpAnCurrentSessionState in the corresponding row in ancpAnCurrentSessionTable. The value of this object is persistent.
OBJECT-TYPE    
  TruthValue  

ancpAnSessionConfigNotifyUpEnable 1.3.6.1.2.1.1.1.3.1.19
This object specifies if ancpAnSessionUp notification should be generated when this session goes to 'estab' state as given by ancpAnCurrentSessionState in the corresponding row in ancpAnCurrentSessionTable. The value of this object is persistent.
OBJECT-TYPE    
  TruthValue  

ancpAnCurrentSessionTable 1.3.6.1.2.1.1.1.4
This table gives actual information of the sessions in the access node. A row in this table is created when the corresponding row in the ancpAnSessionConfigTable is created. A row in this table is deleted when the corresponding row in the ancpAnSessionConfigTable is deleted.
OBJECT-TYPE    
  SEQUENCE OF  
    AncpAnCurrentSessionEntry

ancpAnCurrentSessionEntry 1.3.6.1.2.1.1.1.4.1
An entry in the table showing the data for a specific actual session.
OBJECT-TYPE    
  AncpAnCurrentSessionEntry  

ancpAnCurrentSessionState 1.3.6.1.2.1.1.1.4.1.1
The state of this session. The null (1) state is returned if the proper encapsulation data is not yet configured, if the row is not in active status or if the session is in NULL state as defined in the GSMP specification.
OBJECT-TYPE    
  INTEGER null(1), synsent(2), synrcvd(3), estab(4)  

ancpAnCurrentSessionGsmpVersion 1.3.6.1.2.1.1.1.4.1.2
The actual version number of the GSMP protocol that is used in this session. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  GsmpVersion  

ancpAnCurrentSessionGsmpSubVersion 1.3.6.1.2.1.1.1.4.1.3
The actual subversion number of the GSMP protocol that may be used in this session. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  GsmpSubVersion  

ancpAnCurrentSessionAnName 1.3.6.1.2.1.1.1.4.1.4
The name of the access node used in this session. It should be the same as ancpAnSessionConfigAnName if that object is not set to zero. If ancpAnSessionConfigAnName is set to zero, then this object will contain the MAC address selected by the access node as described in the description of ancpAnSessionConfigAnName. The value of this object is used as value for the 'Sender Name' field in the header of the ANCP messages generated for this session by the AN.
OBJECT-TYPE    
  GsmpNameType  

ancpAnCurrentSessionNasName 1.3.6.1.2.1.1.1.4.1.5
The name of the NAS as advertised in the adjacency message. The value of this object is set to the value of the 'Sender Name' field in the header of the ANCP messages received on this session. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  GsmpNameType  

ancpAnCurrentSessionAnIpAddressType 1.3.6.1.2.1.1.1.4.1.6
The type of address in ancpAnCurrentSessionAnIpAddress.
OBJECT-TYPE    
  InetAddressType  

ancpAnCurrentSessionAnIpAddress 1.3.6.1.2.1.1.1.4.1.7
The IP address used for the access node.
OBJECT-TYPE    
  InetAddress  

ancpAnCurrentSessionAnInstance 1.3.6.1.2.1.1.1.4.1.8
The instance number used by the access node during this session. The Instance number is a 24-bit number that should be guaranteed to be unique within the recent past and to change when the link or node comes back up after going down. Zero is not a valid instance number. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  Unsigned32 0..16777215  

ancpAnCurrentSessionNasInstance 1.3.6.1.2.1.1.1.4.1.9
The instance number used by the NAS during this session. The Instance number is a 24-bit number that should be guaranteed to be unique within the recent past and to change when the link or node comes back up after going down. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  Unsigned32 0..16777215  

ancpAnCurrentSessionCapabilities 1.3.6.1.2.1.1.1.4.1.10
The common ANCP capabilities supported by the AN and NAS in this session. The object has the value 0 if no capabilities are supported or if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  AncpAnSessionCapabilities  

ancpAnCurrentSessionStartUptime 1.3.6.1.2.1.1.1.4.1.11
The value of sysUpTime when the session came to established state. This object has value 0 if ancpAnCurrentSessionState is not estab(4).
OBJECT-TYPE    
  TimeTicks  

ancpAnCurrentSessionDiscontinuityTime 1.3.6.1.2.1.1.1.4.1.12
The value of sysUpTime on the most recent occasion at which session's counters suffered a discontinuity. If no such discontinuities have occurred since then, this object contains the same value as ancpAnCurrentSessionStartUptime.
OBJECT-TYPE    
  TimeTicks  

ancpAnCurrentSessionStatSentMessages 1.3.6.1.2.1.1.1.4.1.13
The number of messages that have been sent in this session by the access node. All ANCP messages pertaining to this session after the session came to established state shall be counted, also including adjacency protocol messages and failure response messages. Discontinuities of this counter are indicated by ancpAnCurrentSessionDiscontinuityTime.
OBJECT-TYPE    
  ZeroBasedCounter32  

ancpAnCurrentSessionStatReceivedValidMessages 1.3.6.1.2.1.1.1.4.1.14
The number of messages that have been received and processed in this session by the access node. All ANCP messages pertaining to this session after the session came to established state shall be counted, also including adjacency protocol messages and failure response messages. Discontinuities of this counter are indicated by ancpAnCurrentSessionDiscontinuityTime.
OBJECT-TYPE    
  ZeroBasedCounter32  

ancpAnCurrentSessionStatDiscardedMessages 1.3.6.1.2.1.1.1.4.1.15
The number of messages that in this session have been received and discarded for whatever reason by the access node. All ANCP messages pertaining to this session after the session came to established state shall be counted, also including adjacency protocol messages and failure response messages. Discontinuities of this counter are indicated by ancpAnCurrentSessionDiscontinuityTime.
OBJECT-TYPE    
  ZeroBasedCounter32  

ancpAnInterfaceConfigTable 1.3.6.1.2.1.1.1.5
This table configures the association of user facing interfaces to ANCP partitions in the access node. An entry in this table needs to be added by the agent for each relevant user facing interface with the value of ancpAnInterfaceConfigPartitionId set to zero at the time of the creation of the row. A relevant user facing interface is created whenever a row is created in the ifTable of the IF-MIB that can be controlled by ANCP. When such an interface is deleted from the ifTable, the corresponding row in this table has to be removed by the agent. Rows should only be created by the agent when ancpAnPartitionsUsed is set to 'partitionsUsed'. If no partitions are used, then no rows should be created in this table.
OBJECT-TYPE    
  SEQUENCE OF  
    AncpAnInterfaceConfigEntry

ancpAnInterfaceConfigEntry 1.3.6.1.2.1.1.1.5.1
An entry in the table showing the partition id for a specific user facing interface
OBJECT-TYPE    
  AncpAnInterfaceConfigEntry  

ancpAnInterfaceConfigPartitionId 1.3.6.1.2.1.1.1.5.1.1
A partition Id associated with the related ifIndex. Upon creation of the row, the value is set to '00'H. The value of this object is persistent.
OBJECT-TYPE    
  GsmpPartitionIdType  

ancpAnSessionDown 1.3.6.1.2.1.1.0.1
This notification is generated whenever an ANCP session goes down. A session can go down for several reasons: 1) The ANCP session can be deleted by a manager from the ancpAnSessionConfigTable, and hence it will also be removed from the ancpAnCurrentSessionTable. 2) The session can go operational down due to some malfunction in the network, the AN, or the NAS. In this case, the ANCP session will be still in the ancpAnSessionConfigTable and ancpAnCurrentSessionTable, but the ancpAnCurrentSessionState moves from the estab state to another state.
NOTIFICATION-TYPE    

ancpAnSessionUp 1.3.6.1.2.1.1.0.2
This notification is generated when an ANCP session enters the estab state as given by ancpAnCurrentSessionState. Since ancpAnCurrentSessionAnInstance identifies the ANCP session uniquely the other attributes can be derived from this attribute.
NOTIFICATION-TYPE    

ancpAnGroups 1.3.6.1.2.1.1.2.1
OBJECT IDENTIFIER    

ancpAnCompliances 1.3.6.1.2.1.1.2.2
OBJECT IDENTIFIER    

ancpAnModuleCompliance 1.3.6.1.2.1.1.2.2.1
The compliance statement for agents that support the ANCP MIB module for access nodes.
MODULE-COMPLIANCE    

ancpAnConfigGroup 1.3.6.1.2.1.1.2.1.1
These objects apply to the configuration of ANCP sessions in access nodes.
OBJECT-GROUP    

ancpAnCurrentGroup 1.3.6.1.2.1.1.2.1.2
These objects show the operational state of all ANCP sessions configured in the access node.
OBJECT-GROUP    

ancpAnInterfaceGroup 1.3.6.1.2.1.1.2.1.3
These objects are used to assign user facing interface to partitions.
OBJECT-GROUP    

ancpAnNotificationsGroup 1.3.6.1.2.1.1.2.1.4
These notifications inform management stations about changes in the state of ANCP sessions.
NOTIFICATION-GROUP