CISCO-SUBSCRIBER-SESSION-MIB

SubSessionType1 = all2 = other3 = pppSubscriber4 = pppoeSubscriber5 = l2tpSubscriber6 = l2fSubscriber7 = ipInterfaceSubscriber8 = ipPktSubscriber9 = ipDhcpv4Subscriber10 = ipRadiusSubscriber11 = l2MacSubscriber12 = l2Dhcpv4Subscriber13 = l2RadiusSubscriberAn enumerated integer-value describing the type of subscriber session. This value has the intent of refining the interface type assigned to a subscriber session. The interface type assigned to a subscriber session groups those types of subscriber sessions with similar interface semantics. A PPP subscriber session consists of a PPP connection (RFC-1661) and has an interface type of 'ppp'. The following subscriber types refine PPP subscriber sessions: 'pppSubscriber' A PPP connection initiated over a circuit (e.g., an ISDN line or ATM VC) using the LCP (RFC-1661). 'pppoeSubscriber' A PPP connection over Ethernet (RFC-2516), initiated by a PADI (PPPoE Active Discovery Initiation) packet. 'l2tpSubscriber' A PPP connection over an L2TP tunnel (RFC-2661), initiated by an Incoming-Call-Request control message. 'l2fSubscriber' A PPP connection over an L2F tunnel (RFC-2341), initiated by a L2F_OPEN message with a non-zero MID. An IP subscriber session consists of the routed traffic associated with a subscriber IP address having an interface type of 'ipSubscriber'. Routed traffic describes IP traffic that transits at least one router. If a subscriber's IP address is not unique to the system, further distinguishing characteristics, such as VRF or MAC address, form part of the subscriber's identity. The following subscriber types refine IP subscriber sessions: 'ipInterfaceSubscriber' An IP subcriber session provisioned by the system's configuration which consists of all traffic received by the interface to which the provisioning applies. 'ipPktSubscriber' An IP subscriber session initiated by the receipt of the first packet received with an unclassified source IP address. 'ipDhcpv4Subscriber' An IP subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'ipRadiusSubscriber' An IP subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). An L2 subscriber session consists of the non-routed traffic associated with a subscriber IP address having an interface type of 'l2Subscriber'. Non-routed traffic describes IP traffic that doesn't transit a router, meaning that the subscriber must be directly connected to the system or have a connection through an L2 access network (e.g., bridges, switches, and tunnels). The following subscriber types refine L2 subscriber sessions: 'l2MacPacketSubscriber' An L2 subscriber session initiated by the receipt of the first layer 2 packet with an unclassified source MAC address. 'l2Dhcpv4Subscriber' An L2 subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'l2RadiusSucriber' An L2 subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). The system should assign the value 'other' to any subscriber session not recognized by the implementation of a MIB module using this textual convention. The value 'all' represents a special value used to indicate all subscriber session types. For example, a scope of aggregation that includes all subscriber session types uses this value to indicate this fact.Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994. R. Droms, 'Dynamic Host Configuration Protocol', RFC-2131, March 1997. A. Valencia, M. Littlewood, T. Kolar, 'Cisco Layer Two Forwarding Protocol (L2F)', RFC-2341, May 1998. L. Mamakos, K. Lidl, J. Evarts, D. Carrel, D. Simone, and R. Wheeler, 'A Method for Transmitting PPP Over Ethernet (PPPoE)', RFC-2516, February 1999. W. Townsley, A. Valencia, A. Rubens, G. Pall, G. Zorn, and B. Palter, 'Layer Two Tunneling Protocol (L2TP)', RFC-2661, August 1999. C. Rigney, S. Willens, A. Rubens, and W. Simpson, 'Remote Authentication Dial-In User Service (RADIUS)', RFC-2865, June 2000. · Integer32

This object indicates the type of subscriber session.

INTEGER1 = none2 = other3 = static4 = localPool5 = dhcpv46 = dhcpv67 = userProfileIpAddr8 = userProfileIpSubnet9 = userProfileNamedPool · Integer32

This object indicates how the system assigns IP addresses to the subscriber: 'none' The system does not an involvement in (or is it aware of) the assignment an subscriber IP addresses. For example, a system does not have an involvement in the assignment of subscriber IP addresses for IP interface subscriber sessions. 'other' The system assigns subscriber IP addresses using a method not recognized by this MIB module. 'static' Subscriber IP addresses have been configured correctly for the service domain. The system does not have an involvement in the assignment of the IP address. 'localPool' The system assigns subscriber IP addresses from a locally configured pool of IP addresses. 'dhcpv4' The system assigns subscriber IP addresses are using the DHCPv4. 'dhcpv6' The system assigns subscriber IP addresses using the DHCPv6. 'userProfileIpAddr' The system assigns subscriber IP addresses from a user profile. 'userProfileIpSubnet' The system assigns the subscriber an IP subnet from a user profile. 'userProfileNamedPool' The system assigns subscriber IP addresses from a locally configured named pool specified by a user profile.

SubSessionState1 = other2 = pending3 = upAn enumerated integer-value describing the state of a subscriber session: 'other' The subscriber session is in a state not recognized by the implementation of a MIB module using this textual convention. 'pending' The subscriber session is in the PENDING state; that is, the subscriber session has been initiated and the system is in the process of establishing the subscriber session. 'up' The subscriber session is in the UP state; that is, the system has established the subscriber session. · Integer32

This object indicates the operational state of the subscriber session.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates whether the system has successfully authenticated the subscriber session. 'false' The subscriber session is operationally up, but in the UNAUTHENTICATED state. 'true' The subscriber session is operationally up, but in the AUTHENTICATED state.

SubSessionRedundancyMode1 = none2 = other3 = active4 = standbyAn enumerated integer-value describing the redundancy mode in which a subscriber session is operating: 'none' The subscriber session is not part of a redundant configuration. 'other' The subscriber session is part of a redundant configuration and is in a state not recognized by this MIB module. 'active' The subscriber session is part of a redundant configuration and is forwarding traffic from the subscriber. 'standby' The subscriber session is part of a redundant configuration and ready to become active in the case of a fail-over event (e.g., linecard failure). · Integer32

This object indicates the redundancy mode in which the subscriber session is operating.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

This object indicates when the subscriber session was created (i.e., when the subscriber session was initiated).

DynamicTemplateNameA string-value that identifies a dynamic template. The semantics of the string-value are the same as those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (1..64) · OCTET STRING

This object indicates the row in the cdtTemplateTable (defined by the CISCO-DYNAMIC-TEMPLATE-MIB) describing the derived configuration for the subscriber session. Observe that the value of cdtTemplateType corresponding to the referenced row must be 'derived'.

SubSessionIdentitiesA bit string describing a set of subscriber session identities: 'ifIndex' The ifIndex assigned to the interface representing the subscriber session. 'subscriberLabel' The arbitrary integer-value assigned by the system to uniquely identify the subscriber session within the scope of the system. 'macAddress' The subscriber's MAC address. 'nativeVrf' The name of the VRF on which the subscriber session originates. 'nativeIpAddress' The IP address assigned to the subscriber session on the customer-facing side of the system. 'domainVrf' The name of the VRF to which the system transfers the subscriber session traffic. 'domainIpAddress' The IP address assigned to the subscriber session on the service-facing side of the system. 'pbhk' The Port-Bundle Host Key (PBHK) uniquely identifying the subscriber session. A PBHK consists of a source IP address and a TCP port number. 'remoteId' The name identifying the 'calling station' or access multiplexor providing access to the subscriber. 'circuitId' The name identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. 'nasPort' An octet string identifying the port on the Network Access Server (NAS) that provides access to the subscriber. 'domain' The subscriber's domain name. 'username' The subscriber's username. 'dnis' The Dialed Number Identification Service (DNIS) number (or called-party number) dialed by the subscriber. 'acctSessionId' The subscriber's accounting session identifier. 'media' The type of media providing access to the subscriber. 'mlpNegotiated' Indicates whether the subscriber session was established using multi-link PPP negotiation. 'protocol' The type of protocol providing access to the subscriber. 'serviceName' The name identifying the service associated with the subscriber. 'dhcpClass' The name of the class matching the DHCP DISCOVER message received from the subscriber. 'tunnelName' The name of the VPDN used to carry the subscriber session. · BITS

This object indicates the subscriber identities that the system has successfully collected for the subscriber session. Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is invalid. If the bit is '1', then the value of the corresponding column represents the value of the subscriber identity collected by the system. The following list specifies the mappings between the bits and the columns: 'subscriberLabel' => csubSessionSubscriberLabel 'macAddress' => csubSessionMacAddress 'nativeVrf' => csubSessionNativeVrf 'nativeIpAddress' => csubSessionNativeIpAddrType, csubSessionNativeIpAddr, csubSessionNativeIpMask 'nativeIpAddress2'=> csubSessionNativeIpAddrType2, csubSessionNativeIpAddr2, csubSessionNativeIpMask2 'domainVrf' => csubSessionDomainVrf 'domainIpAddress' => csubSessionDomainIpAddrType, csubSessionDomainIpAddr, csubSessionDomainIpMask 'pbhk' => csubSessionPbhk 'remoteId' => csubSessionRemoteId 'circuitId' => csubSessionCircuitId 'nasPort' => csubSessionNasPort 'domain' => csubSessionDomain 'username' => csubSessionUsername 'acctSessionId' => csubSessionAcctSessionId 'dnis' => csubSessionDnis 'media' => csubSessionMedia 'mlpNegotiated' => csubSessionMlpNegotiated 'protocol' => csubSessionProtocol 'dhcpClass' => csubSessionDhcpClass 'tunnelName' => csubSessionTunnelName Observe that the bit 'ifIndex' should always be '1'. This identity maps to the ifIndex assigned to the subscriber session. Observe that the bit 'serviceName' maps to one or more instance of ccbptPolicyMap (defined by the CISCO-CBP-TARGET-MIB).

SubscriberLabelA positive integer-value uniquely identifying a subscriber session within the scope of a system. The value '0' is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Unsigned32 · hint x

This object indicates a positive integer-value uniquely identifying the subscriber session within the scope of the system. This column is valid only if the 'subscriberLabel' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

MacAddressRepresents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

This object indicates the MAC address of the subscriber. This column is valid only if the 'macAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberVRFA string-value identifying a VRF associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the VRF originating the subscriber session. This column is valid only if the 'nativeVrf' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA 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

This object indicates the type of IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

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 (0..255) · OCTET STRING

This object indicates the IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

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 (0..255) · OCTET STRING

This object indicates the corresponding mask for the IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberVRFA string-value identifying a VRF associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the VRF to which the system transfers the subscriber session's traffic. This column is valid only if the 'domainVrf' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA 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

This object indicates the type of IP address assigned to the subscriber on the service-facing side of the system. This column is valid only if the 'domainIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

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 (0..255) · OCTET STRING

This object indicates the IP address assigned to the subscriber on the service-facing side of the system. This column is valid only if the 'domainIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

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 (0..255) · OCTET STRING

This object indicates the corresponding mask for the IP address assigned to the subscriber on the service-facing side of the system. This column is valid only if the 'domainIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberPbhkAn octet string specifying a Port-Bundle Host Key (PBHK) identifying a subscriber. The octet string has the following format: Octets Field ------------------------------ 1-4 subscriber IP address 5-6 TCP port number Observe that the subscriber IP address is always an IPv4 address. The value '000000'H is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. SIZE (6) · OCTET STRING · hint 1x:

This object indicates the PBHK identifying the subscriber. This column is valid only if the 'pbhk' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberRemoteIdA string-value identifying the 'calling station', access multiplexor, or access switch providing access to a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the Remote-Id identifying the 'calling station' or AN supporting the circuit that provides access to the subscriber. This column is valid only if the 'remoteId' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberCircuitIdA string-value identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the Circuit-Id identifying the circuit supported by the 'calling station' or AN providing access to the subscriber. This column is valid only if the 'circuitId' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberNasPortAn octet string identifying port on the Network Access Server (NAS) that provides access to the subscriber. The value '000000'H is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. SIZE (0..64) · OCTET STRING · hint 1x:

This object indicates the NAS port-identifier identifying the port on the NAS providing access to the subscriber. This column is valid only if the 'nasPort' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberDomainA string-value specifying the domain associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the domain associated with the subscriber. This column is valid only if the 'domain' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberUsernameA string-value specifying the username identifying a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the username identifying the subscriber. This column is valid only if the 'username' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberAcctSessionIdAn positive, integer-value specifying the accounting session ID assigned to a subscriber. The value '0' is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Unsigned32 · hint x

This object indicates the accounting session identifier assigned to the subscriber session. This column is valid only if the 'accountingSid' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberDnisA string-value specifying the Dialed Number Identification Service (DNIS) number (or called-party number) dialed by a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the DNIS number dialed by the subscriber to access the 'calling station' or AN. This column is valid only if the 'dnis' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberMediaType1 = other2 = async3 = atm4 = ethernet5 = ip6 = isdn7 = mpls8 = syncAn enumerated integer-value describing the type of media providing access to the subscriber: 'other' The implementation of the MIB module using this textual convention does not recognize the type of media providing access to the subscriber. 'async' An asynchronous serial line provides access to the subscriber. 'atm' An ATM network provides access to the subscriber. 'ethernet' An Ethernet-based network provides access to the subscriber. 'ip' An IP network provides access to the subscriber. 'isdn' An ISDN line provides access to the subscriber. 'mpls' An MPLS network provides access to the subscriber. 'sync' A synchronous serial line provides access to the subscriber. The value 'other' cannot be written to an instance of an object. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Integer32

This object indicates the type of media providing access to the subscriber. This column is valid only if the 'media' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates whether the subscriber session was established using multi-link PPP negotiation. This column is valid only if the 'mlpNegotiated' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberProtocolType1 = other2 = atom3 = ip4 = psdn5 = ppp6 = vpdnAn enumerated integer-value describing the type of protocol providing access to the subscriber: 'other' The implementation of the MIB module using this textual convention does not recognize the type of protocol providing access to the subscriber. 'atom' Any Transport over MPLS (AToM) provides access to the subscriber. 'ip' The Internet Protocol (IP) provides access to the subscriber. 'psdn' A Public Switched Data Network (PSDN) provides access to the subscriber. 'ppp' The Point-to-Point Protocol (PPP) provides access to the subscriber. 'vpdn' A Virtual Private Data Network (VPDN) provides access to the subscriber. The value 'other' cannot be written to an instance of an object. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Integer32

This object indicates the type of protocol providing access to the subscriber. This column is valid only if the 'protocol' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberDhcpClassA string-value specifying the name of the class matching the DHCP DISCOVER message received from the subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the name of the class matching the DHCP DISCOVER message received from the subscriber. This column is valid only if the 'dhcpClass' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberTunnelNameA string-value specifying the name of the VPDN used to carry a subscriber's session. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the name of the VPDN used to carry the subscriber session to the system. This column is valid only if the 'tunnelName' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubscriberLocationNameA string-value specifying the location associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the location of the subscriber

SubscriberServiceNameA string-value specifying the subscriber service associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object indicates the name used to identify the services subscribed by a particular session.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

This object indicates when the subscriber session is updated with new policy information.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA 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

This object indicates the type of IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'. In Dual stack scenarios both 'csubSessionNativeIpAddrType' and 'csubSessionNativeIpAddrType2' will be valid

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 (0..255) · OCTET STRING

This object indicates the IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

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 (0..255) · OCTET STRING

This object indicates the corresponding mask for the IP address assigned to the subscriber on the customer-facing side of the system. This column is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubSessionAvailableIdentities is '1'.

SubSessionType1 = all2 = other3 = pppSubscriber4 = pppoeSubscriber5 = l2tpSubscriber6 = l2fSubscriber7 = ipInterfaceSubscriber8 = ipPktSubscriber9 = ipDhcpv4Subscriber10 = ipRadiusSubscriber11 = l2MacSubscriber12 = l2Dhcpv4Subscriber13 = l2RadiusSubscriberAn enumerated integer-value describing the type of subscriber session. This value has the intent of refining the interface type assigned to a subscriber session. The interface type assigned to a subscriber session groups those types of subscriber sessions with similar interface semantics. A PPP subscriber session consists of a PPP connection (RFC-1661) and has an interface type of 'ppp'. The following subscriber types refine PPP subscriber sessions: 'pppSubscriber' A PPP connection initiated over a circuit (e.g., an ISDN line or ATM VC) using the LCP (RFC-1661). 'pppoeSubscriber' A PPP connection over Ethernet (RFC-2516), initiated by a PADI (PPPoE Active Discovery Initiation) packet. 'l2tpSubscriber' A PPP connection over an L2TP tunnel (RFC-2661), initiated by an Incoming-Call-Request control message. 'l2fSubscriber' A PPP connection over an L2F tunnel (RFC-2341), initiated by a L2F_OPEN message with a non-zero MID. An IP subscriber session consists of the routed traffic associated with a subscriber IP address having an interface type of 'ipSubscriber'. Routed traffic describes IP traffic that transits at least one router. If a subscriber's IP address is not unique to the system, further distinguishing characteristics, such as VRF or MAC address, form part of the subscriber's identity. The following subscriber types refine IP subscriber sessions: 'ipInterfaceSubscriber' An IP subcriber session provisioned by the system's configuration which consists of all traffic received by the interface to which the provisioning applies. 'ipPktSubscriber' An IP subscriber session initiated by the receipt of the first packet received with an unclassified source IP address. 'ipDhcpv4Subscriber' An IP subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'ipRadiusSubscriber' An IP subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). An L2 subscriber session consists of the non-routed traffic associated with a subscriber IP address having an interface type of 'l2Subscriber'. Non-routed traffic describes IP traffic that doesn't transit a router, meaning that the subscriber must be directly connected to the system or have a connection through an L2 access network (e.g., bridges, switches, and tunnels). The following subscriber types refine L2 subscriber sessions: 'l2MacPacketSubscriber' An L2 subscriber session initiated by the receipt of the first layer 2 packet with an unclassified source MAC address. 'l2Dhcpv4Subscriber' An L2 subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'l2RadiusSucriber' An L2 subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). The system should assign the value 'other' to any subscriber session not recognized by the implementation of a MIB module using this textual convention. The value 'all' represents a special value used to indicate all subscriber session types. For example, a scope of aggregation that includes all subscriber session types uses this value to indicate this fact.Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994. R. Droms, 'Dynamic Host Configuration Protocol', RFC-2131, March 1997. A. Valencia, M. Littlewood, T. Kolar, 'Cisco Layer Two Forwarding Protocol (L2F)', RFC-2341, May 1998. L. Mamakos, K. Lidl, J. Evarts, D. Carrel, D. Simone, and R. Wheeler, 'A Method for Transmitting PPP Over Ethernet (PPPoE)', RFC-2516, February 1999. W. Townsley, A. Valencia, A. Rubens, G. Pall, G. Zorn, and B. Palter, 'Layer Two Tunneling Protocol (L2TP)', RFC-2661, August 1999. C. Rigney, S. Willens, A. Rubens, and W. Simpson, 'Remote Authentication Dial-In User Service (RADIUS)', RFC-2865, June 2000. · Integer32

This object indicates the type of the subscriber session.

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

This object indicates the ifIndex assigned to the subscriber session.

INTEGER1 = physical2 = interface · Integer32

This object indicates format of the csubAggStatsPoint for this entry. The format for the csubAggStatsPoint is as follows: csubAggStatsPointType csubAggStatsPoint ---------------------- ------------------ 'physical' PhysicalIndex 'interface' InterfaceIndex

Unsigned32 (1..4294967295)

Reference: A. Bierman and K. McCloghrie, 'Entity MIB (Version 3)', RFC-4133, August 2005.

This object should be read with csubAggStatsPointType always. This object indicates one of the determining factors affecting the 'scope of aggregation' for the set of statistics contained by the row. The value indicated by this object should be interpreted as the identifier for the point type specific base table. For point types of 'physical', the type specific base table is the entPhysicalTable and this value is a PhysicalIndex. For point types of 'interface', the type specific base table is the ifTable and this value is an InterfaceIndex. If this column indicates a physical entity which has an entPhysicalClass of 'chassis', then the 'scope of aggregation' may includes those subscriber sessions maintained by all nodes contained by the system. If this column indicates a physical entity which has an entPhysicalClass of 'module' (e.g., a line card), then the 'scope of aggregation' may include those subscriber sessions maintained by the nodes contained by the module. If this column indicates a physical entity which has an entPhysicalClass of 'cpu', then the 'scope of aggregation' may include those subscriber sessions maintained by the node running on the processor. Aggregation points with entPhysicalTable / ifTable overlap: For interfaces which map directly to physical 'port' class entities in the entPhysicalTable, the preferred representation as aggregation points is the 'physical' point type and PhysicalIndex identifier.

SubSessionType1 = all2 = other3 = pppSubscriber4 = pppoeSubscriber5 = l2tpSubscriber6 = l2fSubscriber7 = ipInterfaceSubscriber8 = ipPktSubscriber9 = ipDhcpv4Subscriber10 = ipRadiusSubscriber11 = l2MacSubscriber12 = l2Dhcpv4Subscriber13 = l2RadiusSubscriberAn enumerated integer-value describing the type of subscriber session. This value has the intent of refining the interface type assigned to a subscriber session. The interface type assigned to a subscriber session groups those types of subscriber sessions with similar interface semantics. A PPP subscriber session consists of a PPP connection (RFC-1661) and has an interface type of 'ppp'. The following subscriber types refine PPP subscriber sessions: 'pppSubscriber' A PPP connection initiated over a circuit (e.g., an ISDN line or ATM VC) using the LCP (RFC-1661). 'pppoeSubscriber' A PPP connection over Ethernet (RFC-2516), initiated by a PADI (PPPoE Active Discovery Initiation) packet. 'l2tpSubscriber' A PPP connection over an L2TP tunnel (RFC-2661), initiated by an Incoming-Call-Request control message. 'l2fSubscriber' A PPP connection over an L2F tunnel (RFC-2341), initiated by a L2F_OPEN message with a non-zero MID. An IP subscriber session consists of the routed traffic associated with a subscriber IP address having an interface type of 'ipSubscriber'. Routed traffic describes IP traffic that transits at least one router. If a subscriber's IP address is not unique to the system, further distinguishing characteristics, such as VRF or MAC address, form part of the subscriber's identity. The following subscriber types refine IP subscriber sessions: 'ipInterfaceSubscriber' An IP subcriber session provisioned by the system's configuration which consists of all traffic received by the interface to which the provisioning applies. 'ipPktSubscriber' An IP subscriber session initiated by the receipt of the first packet received with an unclassified source IP address. 'ipDhcpv4Subscriber' An IP subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'ipRadiusSubscriber' An IP subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). An L2 subscriber session consists of the non-routed traffic associated with a subscriber IP address having an interface type of 'l2Subscriber'. Non-routed traffic describes IP traffic that doesn't transit a router, meaning that the subscriber must be directly connected to the system or have a connection through an L2 access network (e.g., bridges, switches, and tunnels). The following subscriber types refine L2 subscriber sessions: 'l2MacPacketSubscriber' An L2 subscriber session initiated by the receipt of the first layer 2 packet with an unclassified source MAC address. 'l2Dhcpv4Subscriber' An L2 subscriber session initiated by the receipt of a DHCPv4 DISCOVER packet (RFC-2131). 'l2RadiusSucriber' An L2 subscriber session initiated by the receipt of a RADIUS Access-Request packet (RFC-2865). The system should assign the value 'other' to any subscriber session not recognized by the implementation of a MIB module using this textual convention. The value 'all' represents a special value used to indicate all subscriber session types. For example, a scope of aggregation that includes all subscriber session types uses this value to indicate this fact.Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994. R. Droms, 'Dynamic Host Configuration Protocol', RFC-2131, March 1997. A. Valencia, M. Littlewood, T. Kolar, 'Cisco Layer Two Forwarding Protocol (L2F)', RFC-2341, May 1998. L. Mamakos, K. Lidl, J. Evarts, D. Carrel, D. Simone, and R. Wheeler, 'A Method for Transmitting PPP Over Ethernet (PPPoE)', RFC-2516, February 1999. W. Townsley, A. Valencia, A. Rubens, G. Pall, G. Zorn, and B. Palter, 'Layer Two Tunneling Protocol (L2TP)', RFC-2661, August 1999. C. Rigney, S. Willens, A. Rubens, and W. Simpson, 'Remote Authentication Dial-In User Service (RADIUS)', RFC-2865, June 2000. · Integer32

This object indicates one of the determining factors affecting the 'scope of aggregation' for the statistics contained by the row. If the value of this column is 'all', then the 'scope of aggregation' may include all subscriber sessions, regardless of type. If the value of this column is not 'all', then the 'scope of aggregation' may include subscriber sessions of the indicated subscriber session type.

Gauge32 · sessions

This object indicates the current number of subscriber sessions within the 'scope of aggregation' that are in the PENDING state.

Gauge32 · sessions

This object indicates the current number of subscriber sessions within the 'scope of aggregation' that are in the UP state.

Gauge32 · sessions

This object indicates the current number of subscriber session within the 'scope of aggregation' that have been authenticated.

Gauge32 · sessions

This object indicates the current number of subscriber session within the 'scope of aggregation' that have not been authenticated.

Gauge32 · sessions

This object indicates the current number of subscriber sessions within the 'scope of aggregation' that are less resource intensive.

Gauge32 · sessions

This object indicates the current number of subscriber sessions within the 'scope of aggregation' that are redundant (i.e., sessions with a csubSessionRedundancyMode of 'standby').

Gauge32 · sessions

This object indicates the highest number of subscriber sessions within the 'scope of aggregation' observed simultaneously in the UP state since the last discontinuity time.

Gauge32 · seconds

This object indicates the average time subscriber sessions within the 'scope of aggregation' spent in the UP state. The system calculates this average over all subscriber sessions maintained by all nodes contained by the 'scope of aggregation' since the last discontinuity time.

Gauge32 · sessions per minute

This object indicates the average rate (per minute) at which the nodes contained by the 'scope of aggregation' have established new subscriber sessions.

Gauge32 · sessions per hour

This object indicates the average rate (per hour) at which the nodes contained by the 'scope of aggregation' have established new subscriber sessions.

Counter64 (0..18446744073709551615) · engagements

This object indicates the number of times that nodes contained within the 'scope of aggregation' have engaged the subscriber session throttle since the last discontinuity time. The mechanics of a subscriber session throttle vary with subscriber session type and implementation. However, the general concept of the throttle prevents a node from having to deal with more than a configured number of requests to establish subscriber sessions from the same CPE within the a configured interval of time. When the number of requests exceeds the configured threshold within the configured interval, then the node processing the requests engages the throttle. Typically, when a node engages a throttle, it drops requests from the CPE for some period of time, after which the node disengages the throttle. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime.

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' created since the discontinuity time. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime.

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that were in the PENDING state and terminated for reasons other than disconnect since the last discontinuity time. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime.

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned to the UP state since the last discontinuity time. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned from the UNAUTHENTICATED to the AUTHENTICATED state since the last discontinuity time. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions terminated due to a disconnect event since the last discontinuity time. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of csubAggStatsDiscontinuityTime

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of subscriber sessions that are less resource intensive

Counter64 (0..18446744073709551615) · sessions

This object indicates the total number of differential traffic classes on subscriber sessions. IP ACLs are used to create differential flows(Traffic Classes). Each Traffic Class can have a different set of features applied.

PerfTotalCountA counter associated with a performance measurements aggregating the previous valid 15 minute measurement intervals. (Intervals for which no valid data was available are not counted) · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' created during the last 24 hours. The system calculates the value of this column by summing the values of all instances of csubAggStatsIntCreatedSessions that expand this row and have a corresponding csubAggStatsIntValid of 'true'.

PerfTotalCountA counter associated with a performance measurements aggregating the previous valid 15 minute measurement intervals. (Intervals for which no valid data was available are not counted) · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that were in the PENDING state and terminated for reasons other than disconnect during the last 24 hours. The system calculates the value of this column by summing the values of all instances of csubAggStatsIntFailedSessions that expand this row and have a corresponding csubAggStatsIntValid of 'true'.

PerfTotalCountA counter associated with a performance measurements aggregating the previous valid 15 minute measurement intervals. (Intervals for which no valid data was available are not counted) · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned to the UP state during the last 24 hours. The system calculates the value of this column by summing the values of all instances of csubAggStatsIntUpSessions that expand this row and have a corresponding csubAggStatsIntValid of 'true'.

PerfTotalCountA counter associated with a performance measurements aggregating the previous valid 15 minute measurement intervals. (Intervals for which no valid data was available are not counted) · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned from the UNAUTHENTICATED to the AUTHENTICATED state during the last 24 hours. The system calculates the value of this column by summing the values of all instances of csubAggStatsIntAuthSessions that expand this row and have a corresponding csubAggStatsIntValid of 'true'.

PerfTotalCountA counter associated with a performance measurements aggregating the previous valid 15 minute measurement intervals. (Intervals for which no valid data was available are not counted) · Gauge32 · sessions

This object indicates the total number of subscriber sessions terminated due to a disconnect event during the last 24 hours. The system calculates the value of this column by summing the values of all instances of csubAggStatsIntDiscSessions that expand this row and have a corresponding csubAggStatsIntValid of 'true'.

Gauge32 (0..899) · seconds

This object indicates the time that has elapsed since the beginning of the current 15-minute measurement interval. If, for some reason, such as an adjustment in the system's time-of-day clock, the current interval exceeds the maximum value, then the value of this column will be the maximum value.

Gauge32 (0..96) · intervals

This object indicates the number of intervals for which data was collected. The value of this column will be '96' unless the measurement was started (or restarted) within 1,440 minutes, in which case the value will be the number of complete 15-minute intervals for which the system has at least some data. In certain cases it is possible that some intervals are unavailable, in which case the value of this column will be maximum interval number for which data is available.

Gauge32 (0..96) · intervals

This object indicates the number of intervals in the range from 0 to csubCurrValidIntervals for which no data is available. This object will typically be '0' except in certain circumstances when some intervals are unavailable.

Gauge32 (0..96) · intervals

This object indicates the current number of differential traffic classes on subscriber sessions currently UP. IP ACLs are used to create differential flows (Traffic Classes).Each Traffic Class can have a different set of features applied.

PerfCurrentCountA counter associated with a performance measurement in a current 15 minute measurement interval. The value of this counter starts from zero and is increased when associated events occur, until the end of the 15 minute interval. At that time the value of the counter is stored in the first 15 minute history interval, and the CurrentCount is restarted at zero. In the case where the agent has no valid data available for the current interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' created during the current 15-minute interval.

PerfCurrentCountA counter associated with a performance measurement in a current 15 minute measurement interval. The value of this counter starts from zero and is increased when associated events occur, until the end of the 15 minute interval. At that time the value of the counter is stored in the first 15 minute history interval, and the CurrentCount is restarted at zero. In the case where the agent has no valid data available for the current interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that were in the PENDING state and terminated for reasons other than disconnect during the current 15-minute interval.

PerfCurrentCountA counter associated with a performance measurement in a current 15 minute measurement interval. The value of this counter starts from zero and is increased when associated events occur, until the end of the 15 minute interval. At that time the value of the counter is stored in the first 15 minute history interval, and the CurrentCount is restarted at zero. In the case where the agent has no valid data available for the current interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned to the UP state during the current 15-minute interval.

PerfCurrentCountA counter associated with a performance measurement in a current 15 minute measurement interval. The value of this counter starts from zero and is increased when associated events occur, until the end of the 15 minute interval. At that time the value of the counter is stored in the first 15 minute history interval, and the CurrentCount is restarted at zero. In the case where the agent has no valid data available for the current interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned from the UNAUTHENTICATED to the AUTHENTICATED state during the current 15-minute interval.

PerfCurrentCountA counter associated with a performance measurement in a current 15 minute measurement interval. The value of this counter starts from zero and is increased when associated events occur, until the end of the 15 minute interval. At that time the value of the counter is stored in the first 15 minute history interval, and the CurrentCount is restarted at zero. In the case where the agent has no valid data available for the current interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). · Gauge32 · sessions

This object indicates the total number of subscriber sessions terminated due to a disconnect event during the current 15-minute interval.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

The date and time (as determined by the system's clock) of the most recent occurrence of an event affecting the continuity of the aggregation statistics for this aggregation point.

Unsigned32 (1..96)

This object indicates the interval number identifying the 15-minute measurement interval for which aggregated subscriber session performance data was successfully collected by the system. The interval identified by the value '1' represents the most recent 15-minute measurement interval, and the interval identified by the value (n) represents the interval immediately preceding the interval identified by the value (n-1).

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates whether the data for the 15-minute measurement interval is valid.

PerfIntervalCountA counter associated with a performance measurement in a previous 15 minute measurement interval. In the case where the agent has no valid data available for a particular interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). In a system supporting a history of n intervals with IntervalCount(1) and IntervalCount(n) the most and least recent intervals respectively, the following applies at the end of a 15 minute interval: - discard the value of IntervalCount(n) - the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1 - the value of IntervalCount(1) becomes that of CurrentCount - the TotalCount, if supported, is adjusted. · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' created during the 15-minute measurement interval.

PerfIntervalCountA counter associated with a performance measurement in a previous 15 minute measurement interval. In the case where the agent has no valid data available for a particular interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). In a system supporting a history of n intervals with IntervalCount(1) and IntervalCount(n) the most and least recent intervals respectively, the following applies at the end of a 15 minute interval: - discard the value of IntervalCount(n) - the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1 - the value of IntervalCount(1) becomes that of CurrentCount - the TotalCount, if supported, is adjusted. · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that were in the PENDING state and terminated for reasons other than disconnect during the 15-minute measurement interval.

PerfIntervalCountA counter associated with a performance measurement in a previous 15 minute measurement interval. In the case where the agent has no valid data available for a particular interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). In a system supporting a history of n intervals with IntervalCount(1) and IntervalCount(n) the most and least recent intervals respectively, the following applies at the end of a 15 minute interval: - discard the value of IntervalCount(n) - the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1 - the value of IntervalCount(1) becomes that of CurrentCount - the TotalCount, if supported, is adjusted. · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned to the UP state during the 15-minute measurement interval.

PerfIntervalCountA counter associated with a performance measurement in a previous 15 minute measurement interval. In the case where the agent has no valid data available for a particular interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). In a system supporting a history of n intervals with IntervalCount(1) and IntervalCount(n) the most and least recent intervals respectively, the following applies at the end of a 15 minute interval: - discard the value of IntervalCount(n) - the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1 - the value of IntervalCount(1) becomes that of CurrentCount - the TotalCount, if supported, is adjusted. · Gauge32 · sessions

This object indicates the total number of subscriber sessions within the 'scope of aggregation' that transitioned from the UNAUTHENTICATED to the AUTHENTICATED state during the 15-minute measurement interval.

PerfIntervalCountA counter associated with a performance measurement in a previous 15 minute measurement interval. In the case where the agent has no valid data available for a particular interval the corresponding object instance is not available and upon a retrieval request a corresponding error message shall be returned to indicate that this instance does not exist (for example, a noSuchName error for SNMPv1 and a noSuchInstance for SNMPv2 GET operation). In a system supporting a history of n intervals with IntervalCount(1) and IntervalCount(n) the most and least recent intervals respectively, the following applies at the end of a 15 minute interval: - discard the value of IntervalCount(n) - the value of IntervalCount(i) becomes that of IntervalCount(i-1) for n >= i > 1 - the value of IntervalCount(1) becomes that of CurrentCount - the TotalCount, if supported, is adjusted. · Gauge32 · sessions

This object indicates the total number of subscriber sessions terminated due to a disconnect event during the 15-minute measurement interval.

Unsigned32

This threshold, if non-zero, indicates the rising threshold for the value of csubAggStatsUpSessions for the aggregation point, When the current sample of csubAggStatsUpSessions is greater than or equal to this threshold, and the value of csubAggStatsUpSessions for the last sample interval was less than this thershold, the csubSessionRisingNotif is triggered. If the value of this threshold is 0, the threshold is not evaluated.

Unsigned32

This threshold, if non-zero, indicates the falling threshold for the value of csubAggStatsUpSessions for the aggregation point, When the current sample of csubAggStatsUpSessions is less than or equal to this threshold, and the value of csubAggStatsUpSessions for the last sample interval was greater than this thershold, the csubSessionFallingNotif is triggered. If the value of this threshold is 0, the threshold is not evaluated.

Unsigned32 (0..100)

This threshold, if non-zero, indicates the delta falling threshold as a percentage of the value of csubAggStatsUpSessions for the aggregation point, The delta as a percentage of csubAggStatsUpSessions (delta_percent) is calculated as follows: current value of csubAggStatsUpSessions = value(n) previous sampled value of csubAggStatsUpSessions = value(n-1) delta_percent = ((value(n-1) - value(n)) / value(n-1)) * 100 If the delta_percent value of the current evaluation interval is greater than the value of this threshold, a csubSessionDeltaPercentLossNotif is triggered. If the value of this threshold is 0, the threshold is not evaluated.

Unsigned32 (0..900)

The value of this object sets the number of seconds between samples for threshold evaluation. For implementations capable of per-session event evaluation of thresholds this object represents the maximum number of seconds between samples.

SubscriberJobIdentifierAn arbitrary positive, integer-value uniquely identifying a subscriber session job. (1..4294967295) · Unsigned32

This object indicates an arbitrary, positive integer-value uniquely identifying the subscriber session job.

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 specifies the status of the subscriber session job. The following columns must be valid before activating a subscriber session job: - csubJobStorage - csubJobType - csubJobControl However, these objects specify a default value. Thus, it is possible to use create-and-go semantics without setting any additional columns. An implementation must allow the EMS/NMS to modify any column when this column is 'active', including columns defined in tables that have a one-to-one or sparse dependent relationship on this table.

StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32

This object specifies what happens to the subscriber session job upon restart.

INTEGER1 = noop2 = query3 = clear · Integer32

This object specifies the type of subscriber session job: 'noop' This type of job does nothing and simply serves as a convenient default value for newly created jobs, thereby allowing create-and-go row creation without having to specify the type of job. 'query' This type of job starts a subscriber session query. The system searches for any subscriber sessions matching the configured criteria and sorts them into a resulting report. Upon activation of a subscriber session with this value, the system automatically creates corresponding rows in the csubJobMatchParamsTable and csubQueryParamsTable. 'clear' This type of job causes the system to terminated all subscriber sessions matching configured criteria. Upon activation of a subscriber session with this value, the system automatically creates a corresponding row in the csubJobMatchParamsTable.

INTEGER1 = noop2 = start3 = abort4 = release · Integer32

This object specifies an action relating to the subscriber session job: 'noop' This action does nothing. 'start' If the corresponding instance of csubJobType is 'noop', then this action simply causes the system to set the corresponding instances of csubJobState and csubJobFinishedReason to 'finished' and 'normal', respectively. If the corresponding instance of csubJobType is not 'noop' and the system is not executing a subscriber session job, then this action causes the system immediately execute the subscriber session job. If the corresponding instance of csubJobType is not 'noop' and the system is already executing a subscriber session job, then this action causes the system to put the job on the subscriber session job queue. 'abort' If the subscriber session job is in the subscriber session job queue, then this action causes the system to remove the job from the queue. If the system is executing the subscriber session job, then this action causes the system to stop the job. 'release' This action causes the system to destroy any corresponding rows in the csubJobReportTable. The system only accepts this action for a previously executed subscriber session job having a corresponding instance of csubJobType set to 'query'. Any attempt to issue this action under other circumstances will result in a response indicating an error-status of 'inconsistentValue'. When read, this column is always 'noop'.

INTEGER1 = idle2 = pending3 = inProgress4 = finished · Integer32

This object indicates the current state of the subscriber session job: 'idle' This state indicates that the system has not executed the subscriber session job since it was created. 'pending' This state indicates that the subscriber session job is waiting in the subscriber session job queue. 'inProgress' This state indicates that the system is executing the subscriber session job. Observe that the system may execute more than one subscriber session job at a time. 'finished' This state indicates that the system has executed the subscriber session job and it has finished. The corresponding instance of csubJobFinishedReason indicates further details regarding the reason why the job finished.

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

This object indicates the value of sysUpTime when the system started executing the subscriber session job. This value will be '0' when the corresponding instance of csubJobState is 'idle' or 'pending'.

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

This object indicates the value of sysUpTime when the system finished executing the subscriber session job, for whatever reason. This value will be '0' when the corresponding instance of csubJobState is 'idle', 'pending', or 'inProgress'.

INTEGER1 = invalid2 = other3 = normal4 = aborted5 = insufficientResources6 = error · Integer32

This object indicates the reason why the system finished executing the subscriber session job: 'invalid' Indicates that the corresponding instance of csubJobState is either 'idle', 'pending', or 'inProgress'. 'other' Indicates that the system finished executing the subscriber session job abnormally for a reason not recognized by this MIB module. 'normal' Indicates that the system finished executing the subscriber session job with no problems. 'aborted' Indicates that the system finished executing the subscriber session job as the result of the EMS/NMS writing 'abort' to the corresponding instance of csubJobControl. 'insufficientResources' Indicates that the system finished executing the subscriber session job abnormally due to insufficient resources to continue. 'error' Indicates that the system encountered an error that prevented it from completing the job.

SubSessionIdentitiesA bit string describing a set of subscriber session identities: 'ifIndex' The ifIndex assigned to the interface representing the subscriber session. 'subscriberLabel' The arbitrary integer-value assigned by the system to uniquely identify the subscriber session within the scope of the system. 'macAddress' The subscriber's MAC address. 'nativeVrf' The name of the VRF on which the subscriber session originates. 'nativeIpAddress' The IP address assigned to the subscriber session on the customer-facing side of the system. 'domainVrf' The name of the VRF to which the system transfers the subscriber session traffic. 'domainIpAddress' The IP address assigned to the subscriber session on the service-facing side of the system. 'pbhk' The Port-Bundle Host Key (PBHK) uniquely identifying the subscriber session. A PBHK consists of a source IP address and a TCP port number. 'remoteId' The name identifying the 'calling station' or access multiplexor providing access to the subscriber. 'circuitId' The name identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. 'nasPort' An octet string identifying the port on the Network Access Server (NAS) that provides access to the subscriber. 'domain' The subscriber's domain name. 'username' The subscriber's username. 'dnis' The Dialed Number Identification Service (DNIS) number (or called-party number) dialed by the subscriber. 'acctSessionId' The subscriber's accounting session identifier. 'media' The type of media providing access to the subscriber. 'mlpNegotiated' Indicates whether the subscriber session was established using multi-link PPP negotiation. 'protocol' The type of protocol providing access to the subscriber. 'serviceName' The name identifying the service associated with the subscriber. 'dhcpClass' The name of the class matching the DHCP DISCOVER message received from the subscriber. 'tunnelName' The name of the VPDN used to carry the subscriber session. · BITS

This object specifies the subscriber identities that the system uses to determine the subscriber sessions the job executes on. Each bit in this bit string corresponds to one or more columns in this table. If the bit is '0', then the value of the corresponding columns are invalid. If the bit is '1', then the value of corresponding columns are valid. The following list specifies the mappings between the bits and the columns: 'subscriberLabel' => csubJobMatchSubscriberLabel 'macAddress' => csubJobMatchMacAddress 'nativeVrf' => csubJobMatchNativeVrf 'nativeIpAddress' => csubJobMatchNativeIpAddrType, csubJobMatchNativeIpAddr, csubJobMatchNativeIpMask, 'domainVrf' => csubJobMatchDomainVrf 'domainIpAddress' => csubJobMatchDomainIpAddrType, csubJobMatchDomainIpAddr, csubJobMatchDomainIpMask 'pbhk' => csubJobMatchPbhk 'remoteId' => csubJobMatchRemoteId 'circuitId' => csubJobMatchCircuitId 'nasPort' => csubJobMatchNasPort 'domain' => csubJobMatchDomain 'username' => csubJobMatchUsername 'acctSessionId' => csubJobMatchAcctSessionId 'dnis' => csubJobMatchDnis 'media' => csubJobMatchMedia 'mlpNegotiated' => csubJobMatchMlpNegotiated 'protocol' => csubJobMatchProtocol 'serviceName' => csubJobMatchServiceName 'dhcpClass' => csubJobMatchDhcpClass 'tunnelName' => csubJobMatchTunnelName Observe that the bit 'ifIndex' has no meaning, as subscriber session jobs do not match against this subscriber session identity.

BITS

This object specifies other parameters relating to subscriber sessions a subscriber session job may match against. Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is invalid. If the bit is '1', then the value of the corresponding column represents the value of the parameter identity the system should match against for the corresponding subscriber session job. The following list specifies the mappings between bits and the columns: 'danglingDuration' => csubJobMatchDanglingDuration 'state' => csubJobMatchState 'authenticated' => csubJobMatchAuthenticated 'redundancyMode' => csubJobMatchRedundancyMode

SubscriberLabelA positive integer-value uniquely identifying a subscriber session within the scope of a system. The value '0' is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Unsigned32 · hint x

This object specifies the subscriber label that the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'subscriberLabel' bit of the corresponding instance of csubJobMatchIdentities is '1'.

MacAddressRepresents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:

This object specifies the MAC address that the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'macAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberVRFA string-value identifying a VRF associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the native VRF the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'nativeVrf' bit of the corresponding instance of csubJobMatchIdentities is '1'.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA 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

This object specifies the type of Internet address specified by csubJobMatchNativeIpAddr and csubJobMatchNativeIpMask. This value is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

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 (0..255) · OCTET STRING

This object specifies the native IP address that the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

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 (0..255) · OCTET STRING

This object specifies the mask used when matching the native IP address against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'nativeIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberVRFA string-value identifying a VRF associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the domain VRF the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'domainVrf' bit of the corresponding instance of csubJobMatchIdentities is '1'.

InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA 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

This object specifies the type of Internet address specified by csubJobMatchDomainIpAddr and csubJobMatchDomainIpMask. This value is valid only if the 'domainIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

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 (0..255) · OCTET STRING

This object specifies the domain IP address that the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'domainIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

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 (0..255) · OCTET STRING

This object specifies the mask used when matching the domain IP address against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'domainIpAddress' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberPbhkAn octet string specifying a Port-Bundle Host Key (PBHK) identifying a subscriber. The octet string has the following format: Octets Field ------------------------------ 1-4 subscriber IP address 5-6 TCP port number Observe that the subscriber IP address is always an IPv4 address. The value '000000'H is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. SIZE (6) · OCTET STRING · hint 1x:

This object specifies the PBHK that the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'pbhk' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberRemoteIdA string-value identifying the 'calling station', access multiplexor, or access switch providing access to a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the Remote-Id the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'remoteId' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberCircuitIdA string-value identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the Circuit-Id the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'circuitId' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberNasPortAn octet string identifying port on the Network Access Server (NAS) that provides access to the subscriber. The value '000000'H is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. SIZE (0..64) · OCTET STRING · hint 1x:

This object specifies the NAS port-identifier the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'nasPort' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberDomainA string-value specifying the domain associated with a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the domain the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'domain' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberUsernameA string-value specifying the username identifying a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the username the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'username' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberAcctSessionIdAn positive, integer-value specifying the accounting session ID assigned to a subscriber. The value '0' is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Unsigned32 · hint x

This object specifies the accounting session identifier the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'accountingSid' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberDnisA string-value specifying the Dialed Number Identification Service (DNIS) number (or called-party number) dialed by a subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the DNIS number the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'dnis' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberMediaType1 = other2 = async3 = atm4 = ethernet5 = ip6 = isdn7 = mpls8 = syncAn enumerated integer-value describing the type of media providing access to the subscriber: 'other' The implementation of the MIB module using this textual convention does not recognize the type of media providing access to the subscriber. 'async' An asynchronous serial line provides access to the subscriber. 'atm' An ATM network provides access to the subscriber. 'ethernet' An Ethernet-based network provides access to the subscriber. 'ip' An IP network provides access to the subscriber. 'isdn' An ISDN line provides access to the subscriber. 'mpls' An MPLS network provides access to the subscriber. 'sync' A synchronous serial line provides access to the subscriber. The value 'other' cannot be written to an instance of an object. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Integer32

This object specifies the media type the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'media' bit of the corresponding instance of csubJobMatchIdentities is '1'.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object specifies the MLP negotiated flag the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'mlpNegotiated' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberProtocolType1 = other2 = atom3 = ip4 = psdn5 = ppp6 = vpdnAn enumerated integer-value describing the type of protocol providing access to the subscriber: 'other' The implementation of the MIB module using this textual convention does not recognize the type of protocol providing access to the subscriber. 'atom' Any Transport over MPLS (AToM) provides access to the subscriber. 'ip' The Internet Protocol (IP) provides access to the subscriber. 'psdn' A Public Switched Data Network (PSDN) provides access to the subscriber. 'ppp' The Point-to-Point Protocol (PPP) provides access to the subscriber. 'vpdn' A Virtual Private Data Network (VPDN) provides access to the subscriber. The value 'other' cannot be written to an instance of an object. However, it serves as a convenient value when an instance of an object using this textual convention is not valid. · Integer32

This object specifies the protocol type the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'protocol' bit of the corresponding instance of csubJobMatchIdentities is '1'.

CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411]. Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a

This object specifies the service name the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'serviceName' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberDhcpClassA string-value specifying the name of the class matching the DHCP DISCOVER message received from the subscriber. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the DHCP class name the system matches against subscriber sessions in the process of executing a subscriber session job. This value is valid only if the 'dhcpClass' bit of the corresponding instance of csubJobMatchIdentities is '1'.

SubscriberTunnelNameA string-value specifying the name of the VPDN used to carry a subscriber's session. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB (RFC-3411). The null string is not a valid value. However, it serves as a convenient value when an instance of an object using this textual convention is not valid.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..255) · OCTET STRING · hint 255a

This object specifies the tunnel name the system matches against subscriber session in the process of executing a subscriber session job. This value is valid only if the 'tunnelName' bit of the corresponding instance of csubJobMatchIdentities is '1'.

Unsigned32 (0..3600)

This object specifies the minimum interval of time a subscriber session can remain dangling in order for the system to consider it a match in the process of executing a subscriber session job. A 'dangling' subscriber session is one in the PENDING state. The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid. This value is valid only if the 'danglingDuration' bit of the corresponding instance of csubJobMatchOtherParams is '1'.

SubSessionState1 = other2 = pending3 = upAn enumerated integer-value describing the state of a subscriber session: 'other' The subscriber session is in a state not recognized by the implementation of a MIB module using this textual convention. 'pending' The subscriber session is in the PENDING state; that is, the subscriber session has been initiated and the system is in the process of establishing the subscriber session. 'up' The subscriber session is in the UP state; that is, the system has established the subscriber session. · Integer32

This object specifies the state of a subscriber session in order for the system to consider a match in the process of executing a subscriber session job. The value 'other' is not valid and an implementation should not allow it to be written to this column. This value is valid only if the 'state' bit of the corresponding instance of csubJobMatchOtherParams is '1'.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object specifies whether a subscriber session should be unauthenticated for the system to consider a match in the process of executing a subscriber session job. If this column is 'false', then the subscriber session job matches subscriber sessions that are unauthenticated. If this column is 'true', then the subscriber session job matches subscriber session that are authenticated. This value is valid only if the 'authenticated' bit of the corresponding instance of csubJobMatchParams is '1'.

SubSessionRedundancyMode1 = none2 = other3 = active4 = standbyAn enumerated integer-value describing the redundancy mode in which a subscriber session is operating: 'none' The subscriber session is not part of a redundant configuration. 'other' The subscriber session is part of a redundant configuration and is in a state not recognized by this MIB module. 'active' The subscriber session is part of a redundant configuration and is forwarding traffic from the subscriber. 'standby' The subscriber session is part of a redundant configuration and ready to become active in the case of a fail-over event (e.g., linecard failure). · Integer32

This object specifies the redudancy mode of the subscriber session in order for the system to consider a match in the process of executing a subscriber session job. The value 'other' is not valid and an implementation should not allow it to be written to this column. This value is valid only if the 'redundancyMode' bit of the corresponding instance of csubJobMatchOtherParams is '1'.

SubSessionIdentity1 = other2 = ifIndex3 = subscriberLabel4 = macAddress5 = nativeVrf6 = nativeIpAddress7 = domainVrf8 = domainIpAddress9 = pbhk10 = remoteId11 = circuitId12 = nasPort13 = domain14 = username15 = acctSessionId16 = dnis17 = media18 = mlpNegotiated19 = protocol20 = serviceName21 = dhcpClass22 = tunnelNameAn enumerated integer-value describing a subscriber session identity: 'other' The implementation of the MIB module using this textual convention does not recognize the subscriber session identity. 'ifIndex' The ifIndex assigned to the interface representing the subscriber session. 'subscriberLabel' The arbitrary integer-value assigned by the system to uniquely identify the subscriber session within the scope of the system. 'macAddress' The subscriber's MAC address. 'nativeVrf' The name of the VRF on which the subscriber session originates. 'nativeIpAddress' The IP address assigned to the subscriber session on the customer-facing side of the system. 'domainVrf' The name of the VRF to which the system transfers the subscriber session traffic. 'domainIpAddress' The IP address assigned to the subscriber session on the service-facing side of the system. 'pbhk' The Port-Bundle Host Key (PBHK) uniquely identifying the subscriber session. A PBHK consists of a source IP address and a TCP port number. 'remoteId' The name identifying the 'calling station', access multiplexor, or access switch providing access to the subscriber. 'circuitId' The name identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. 'nasPort' An octet string identifying the port on the Network Access Server (NAS) that provides access to the subscriber. 'domain' The subscriber's domain name. 'username' The subscriber's username. 'acctSessionId' The subscriber's accounting session identifier. 'dnis' The Dialed Number Identification Service (DNIS) number (or called-party number) dialed by the subscriber. 'media' The type of media providing access to the subscriber. 'mlpNegotiated' Indicates whether the subscriber session was established using multi-link PPP negotiation. 'protocol' The type of protocol providing access to the subscriber. 'dhcpClass' The name of the class matching the DHCP DISCOVER message received from the subscriber. 'serviceName' The name identifying the service associated with the subscriber. 'tunnelName' The name of the VPDN used to carry the subscriber session. · Integer32

This object specifies the first subscriber identity that the system uses when sorting subscriber sessions into the final report corresponding to a subscriber session query. It is not valid to set this column to 'other' or 'ifIndex'.

SubSessionIdentity1 = other2 = ifIndex3 = subscriberLabel4 = macAddress5 = nativeVrf6 = nativeIpAddress7 = domainVrf8 = domainIpAddress9 = pbhk10 = remoteId11 = circuitId12 = nasPort13 = domain14 = username15 = acctSessionId16 = dnis17 = media18 = mlpNegotiated19 = protocol20 = serviceName21 = dhcpClass22 = tunnelNameAn enumerated integer-value describing a subscriber session identity: 'other' The implementation of the MIB module using this textual convention does not recognize the subscriber session identity. 'ifIndex' The ifIndex assigned to the interface representing the subscriber session. 'subscriberLabel' The arbitrary integer-value assigned by the system to uniquely identify the subscriber session within the scope of the system. 'macAddress' The subscriber's MAC address. 'nativeVrf' The name of the VRF on which the subscriber session originates. 'nativeIpAddress' The IP address assigned to the subscriber session on the customer-facing side of the system. 'domainVrf' The name of the VRF to which the system transfers the subscriber session traffic. 'domainIpAddress' The IP address assigned to the subscriber session on the service-facing side of the system. 'pbhk' The Port-Bundle Host Key (PBHK) uniquely identifying the subscriber session. A PBHK consists of a source IP address and a TCP port number. 'remoteId' The name identifying the 'calling station', access multiplexor, or access switch providing access to the subscriber. 'circuitId' The name identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. 'nasPort' An octet string identifying the port on the Network Access Server (NAS) that provides access to the subscriber. 'domain' The subscriber's domain name. 'username' The subscriber's username. 'acctSessionId' The subscriber's accounting session identifier. 'dnis' The Dialed Number Identification Service (DNIS) number (or called-party number) dialed by the subscriber. 'media' The type of media providing access to the subscriber. 'mlpNegotiated' Indicates whether the subscriber session was established using multi-link PPP negotiation. 'protocol' The type of protocol providing access to the subscriber. 'dhcpClass' The name of the class matching the DHCP DISCOVER message received from the subscriber. 'serviceName' The name identifying the service associated with the subscriber. 'tunnelName' The name of the VPDN used to carry the subscriber session. · Integer32

This object specifies the second subscriber identity that the system uses when sorting subscriber sessions into the final report corresponding to a subscriber session query. If it is the desire to have the final report sorted on a single subscriber identity, then this column should be 'other'.

SubSessionIdentity1 = other2 = ifIndex3 = subscriberLabel4 = macAddress5 = nativeVrf6 = nativeIpAddress7 = domainVrf8 = domainIpAddress9 = pbhk10 = remoteId11 = circuitId12 = nasPort13 = domain14 = username15 = acctSessionId16 = dnis17 = media18 = mlpNegotiated19 = protocol20 = serviceName21 = dhcpClass22 = tunnelNameAn enumerated integer-value describing a subscriber session identity: 'other' The implementation of the MIB module using this textual convention does not recognize the subscriber session identity. 'ifIndex' The ifIndex assigned to the interface representing the subscriber session. 'subscriberLabel' The arbitrary integer-value assigned by the system to uniquely identify the subscriber session within the scope of the system. 'macAddress' The subscriber's MAC address. 'nativeVrf' The name of the VRF on which the subscriber session originates. 'nativeIpAddress' The IP address assigned to the subscriber session on the customer-facing side of the system. 'domainVrf' The name of the VRF to which the system transfers the subscriber session traffic. 'domainIpAddress' The IP address assigned to the subscriber session on the service-facing side of the system. 'pbhk' The Port-Bundle Host Key (PBHK) uniquely identifying the subscriber session. A PBHK consists of a source IP address and a TCP port number. 'remoteId' The name identifying the 'calling station', access multiplexor, or access switch providing access to the subscriber. 'circuitId' The name identifying the circuit on the 'calling station', access multiplexor, or access switch that provides access to the subscriber. 'nasPort' An octet string identifying the port on the Network Access Server (NAS) that provides access to the subscriber. 'domain' The subscriber's domain name. 'username' The subscriber's username. 'acctSessionId' The subscriber's accounting session identifier. 'dnis' The Dialed Number Identification Service (DNIS) number (or called-party number) dialed by the subscriber. 'media' The type of media providing access to the subscriber. 'mlpNegotiated' Indicates whether the subscriber session was established using multi-link PPP negotiation. 'protocol' The type of protocol providing access to the subscriber. 'dhcpClass' The name of the class matching the DHCP DISCOVER message received from the subscriber. 'serviceName' The name identifying the service associated with the subscriber. 'tunnelName' The name of the VPDN used to carry the subscriber session. · Integer32

This object specifies the third subscriber identity that the system uses when sorting subscriber sessions into the final report corresponding to a subscriber session query. If it is the desire to have the final report sorted on one or two subscriber identities, then this column should be 'other'.

Gauge32

This object indicates the number of subscriber sessions that matched the corresponding subscriber session query. The value of this column should be '0' unless the corresponding value of csubJobState is 'finished'. The value of this column should be '0' after the EMS/NMS sets the corresponding csubJobControl to 'release'.

Unsigned32 (1..4294967295)

This object indicates an positive, integer-value that uniquely identifies the entry in the table. The value of this object starts at '1' and monotonically increases for each subscriber session job inserted into the subscriber session job queue. If the value of this object is '4294967295', the system will reset it to '1' when it inserts the next subscriber session job into the subscriber session job queue.

SubscriberJobIdentifierAn arbitrary positive, integer-value uniquely identifying a subscriber session job. (1..4294967295) · Unsigned32

This object indicates the identifier associated with the subscriber session job.

Unsigned32 (1..4294967295)

This object indicates an arbitrary, positive, integer-value that uniquely identifies this entry in a report. This auxiliary value is necessary, as the corresponding subscriber session job can specify up to three subscriber identities on which to sort the subscriber sessions that end up in the final report.

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

This object indicates the ifIndex-value assigned to the subscriber session that satisfied the match criteria specified by the corresponding subscriber session job having a csubJobType of 'query'.