Cisco Network Module Enhanced Application Performance Assurance MIB Reference Guide
CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB

Table Of Contents

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Objects

cServiceControlSubscribersTable

cServiceControlSubscribersIndex (unsigned32)

cServiceControlSubscribersName (SnmpAdminString)

cServiceControlSubscriberStorageType (integer)

cServiceControlSubscribersRowStatus (integer)

cServiceControlSubscribersInfoTable

cServiceControlSubscribersNumIntroduced (gauge32)

cServiceControlSubscribersNumFree (gauge32)

cServiceControlSubscribersNumIpAddrMappings (gauge32)

cServiceControlSubscribersNumIpAddrMappingsFree (gauge32)

cServiceControlSubscribersNumIpRangeMappings (gauge32)

cServiceControlSubscribersNumIpRangeMappingsFree (gauge32)

cServiceControlSubscribersNumVlanMappings (gauge32)

cServiceControlSubscribersNumVlanMappingsFree (gauge32)

cServiceControlSubscribersNumActive (gauge32)

cServiceControlSubscribersNumUpdates (counter32)

cServiceControlSubscribersNumTpIpRanges (gauge32)

cServiceControlSubscribersNumTpIpRangesFree (gauge32)

cServiceControlSubscribersNumAnonymous (gauge32)

cServiceControlSubscribersNumWithSessions (gauge32)

cServiceControlSubscriberMappingFailedReason (SnmpAdminString)

cServiceControlSubsribersMaxSupported (unsigned32)

cServiceControlSubscribersNotifsEnable (integer)

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Notifications

cServiceControlSubscriberMappingFailedReason


CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB


CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Objects

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Notifications

This MIB provides global and specific information regarding subscribers managed by a service control entity, which is a network element that monitors network traffic between network subscribers based on user-configured policies. The network subscribers are the end users of the network with a unique network address for each subscriber.

A specific subscriber is identified by this MIB by the subscriber name (cServiceControlSubscribersName (SnmpAdminString), which is assured to be unique. This ID is used to retrieve information regarding the specified subscriber.

The service control entity is identified in the entPhysicalTable of the IDENTITY-MIB by having one of the following values assigned to entPhysicalVendorType :

cevChassisSCE2000

cevChassisSCE1000

cevNmeApaModule

A specific service control entity is identified by the value of the entPhysicalIndex of the corresponding entry in the entPhysicalTable .

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Objects

The CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB contains the following objects:

cServiceControlSubscribersTable

cServiceControlSubscribersIndex

cServiceControlSubscribersName

cServiceControlSubscriberStorageType

cServiceControlSubscribersRowStatus

cServiceControlSubscribersInfoTable

cServiceControlSubscribersNumIntroduced

cServiceControlSubscribersNumFree

cServiceControlSubscribersNumIpAddrMappings

cServiceControlSubscribersNumIpAddrMappingsFree

cServiceControlSubscribersNumIpRangeMappings

cServiceControlSubscribersNumIpRangeMappingsFree

cServiceControlSubscribersNumVlanMappings

cServiceControlSubscribersNumVlanMappingsFree

cServiceControlSubscribersNumActive

cServiceControlSubscribersNumUpdates

cServiceControlSubscribersNumTpIpRanges

cServiceControlSubscribersNumTpIpRangesFree

cServiceControlSubscribersNumAnonymous

cServiceControlSubscribersNumWithSessions

cServiceControlSubscriberMappingFailedReason

cServiceControlSubsribersMaxSupported

cServiceControlSubscribersNotifsEnable

cServiceControlSubscribersTable

This table maintains the list of subscribers of the service control entity.

An entry must be created in this table so that NMS application can query subscriber data from the CISCO-SERVICE-CONTROL-DPI-MIB and monitor the subscriber.

An entry is created for each subscriber (indentified by cServiceControlSubscribersName ) monitored by a service control entity.

If the service control entity is not required to monitor a particular subscriber, the corresponding entry is deleted by setting the cServiceControlSubscribersRowStatus (integer)object to destroy .

When the service control entity reboots, the entries associated with this entity will be cleared.

INDEX

entPhysicalIndex of the service control entity in the entPhysicalTable . (See the ENTITY-MIB).

cServiceControlSubscribersIndex

OBJECTS

cServiceControlSubscribersIndex (unsigned32)

cServiceControlSubscribersName (SnmpAdminString)

cServiceControlSubscriberStorageType (integer)

cServiceControlSubscribersRowStatus (integer)

cServiceControlSubscribersIndex (unsigned32)

A unique subscriber entry index.

Access : not-accessible

Valid Values

1..2147483647

cServiceControlSubscribersName (SnmpAdminString)

The name of the subscriber to be monitored by the service control entity.

Access : read-create

cServiceControlSubscriberStorageType (integer)

Specifies the storage type for this conceptual row. When the storageType is permanent (4), the object cServiceControlSubscribersName is writable.

Access : read-create

Valid Values (StorageType)

other (1)

volatile (2)

nonVolatile (3)

permanent (4)

readOnly (5)

Default Value : volatile

For more information regarding the StorageType syntax, see SNMPv2-TC

cServiceControlSubscribersRowStatus (integer)

The status of this conceptual row:

Please note the following guidelines:

To create a row: set this object to createAndGo or createAndWait

Until instances of all corresponding columns are appropriately configured, the value of the corresponding instance of this object is notReady .

A newly created row cannot be made active until the appropriate columns have been set.

Default value will be automatically provisioned for those objects not specified during row creation.

cServiceControlSubscribersName may not be modified while the value of this object is active .

An entry can be deleted by setting the value of corresponding instance of this object to destroy . (It is also automatically deleted when the subscriber disconnects from the network.)

The entries will be deleted when the service control entity reboots.

Access : read-create

Valid Values (RowStatus)

active (1)

notInService (2)

notReady (3)

createAndGo (4)

createAndWait (5)

destroy (6)

For more information regarding the RowStatus syntax, see SNMPv2-TC

cServiceControlSubscribersInfoTable

This table maintains global statistical data regarding the number of subscribers and subscriber mappings recognized by the service control entity.

One entry exists for each service control entity identified by its assigned entPhysicalIndex . Each entry in the table lists information and data regarding subscriber management operations performed, and the current status of the subscribers database on a specific service control entity.

INDEX

entPhysicalIndex of the service control entity in the entPhysicalTable . (See the ENTITY-MIB).

OBJECTS

cServiceControlSubscribersNumIntroduced (gauge32)

cServiceControlSubscribersNumFree (gauge32)

cServiceControlSubscribersNumIpAddrMappings (gauge32)

cServiceControlSubscribersNumIpAddrMappingsFree (gauge32)

cServiceControlSubscribersNumIpRangeMappings (gauge32)

cServiceControlSubscribersNumIpRangeMappingsFree (gauge32)

cServiceControlSubscribersNumVlanMappings (gauge32)

cServiceControlSubscribersNumVlanMappingsFree (gauge32)

cServiceControlSubscribersNumActive (gauge32)

cServiceControlSubscribersNumUpdates (counter32)

cServiceControlSubscribersNumTpIpRanges (gauge32)

cServiceControlSubscribersNumTpIpRangesFree (gauge32)

cServiceControlSubscribersNumAnonymous (gauge32)

cServiceControlSubscribersNumWithSessions (gauge32)

cServiceControlSubscriberMappingFailedReason (SnmpAdminString)

cServiceControlSubsribersMaxSupported (unsigned32)

cServiceControlSubscribersNumIntroduced (gauge32)

The current number of subscribers that have been introduced to the system. These subscribers may or may not have IP address or VLAN mappings.

Access : read-only

cServiceControlSubscribersNumFree (gauge32)

The free subscriber space available in the system. This is the number of additional subscribers that can be introduced to the system.

Access : read-only

cServiceControlSubscribersNumIpAddrMappings (gauge32)

The current number of 'IP address to subscriber' mappings (subscribers mapped to one or more discrete network addresses, as opposed to a range of IP addresses). Each mapped IP address constitutes a subscriber mapping.

Access : read-only

cServiceControlSubscribersNumIpAddrMappingsFree (gauge32)

The number of free 'IP address to subscriber' mappings available for defining new mappings.

Access : read-only

cServiceControlSubscribersNumIpRangeMappings (gauge32)

The current number of 'IP-range to subscriber' mappings. Each mapping instance corresponds to a subscriber mapped to a range of IP addresses.

Access : read-only

cServiceControlSubscribersNumIpRangeMappingsFree (gauge32)

The number of free 'IP-range to subscriber' mappings available for defining new mappings.

Access : read-only

cServiceControlSubscribersNumVlanMappings (gauge32)

The current number of subscriber mappings to a single VLAN ID or to different VLAN IDs. Each mapped VLAN ID constitutes a subscriber mapping

Access : read-only

cServiceControlSubscribersNumVlanMappingsFree (gauge32)

The number of free 'VLAN to subscriber' mappings available for defining new mappings.

Access : read-only

cServiceControlSubscribersNumActive (gauge32)

The current number of active subscribers. An active subscriber must have an IP address or VLAN mapping, defining the traffic that should be associated and served according to the subscriber service agreement..

Access : read-only

cServiceControlSubscribersNumUpdates (counter32)

The accumulated number of subscriber database updates received by the system.

Access : read-only

cServiceControlSubscribersNumTpIpRanges (gauge32)

The current number of 'Traffic Processor IP address ranges' used. This object is equal to the total number of network address ranges used to map to all the subscribers in the system.

For multiple traffic processor systems, the address ranges are distributed between traffic processors for dedicated processing of data belonging to the mapped address space.

Access : read-only

cServiceControlSubscribersNumTpIpRangesFree (gauge32)

The number of free 'Traffic Processor IP ranges' .

Access : read-only

cServiceControlSubscribersNumAnonymous (gauge32)

The current number of anonymous subscribers.

Access : read-only

cServiceControlSubscribersNumWithSessions (gauge32)

The current number of subscribers with open flows.

Access : read-only

cServiceControlSubscriberMappingFailedReason (SnmpAdminString)

A user-readable description of a problem due to an external entity attempting to create illegal or inconsistent subscriber mappings.

For example, if an attempt is made to map a subscriber to an incorrect address, the following information will be available in this object:

The subscriber name

The address to which the mapping attempt was made

The reason why the mapping attempt failed

Access : read-only

cServiceControlSubsribersMaxSupported (unsigned32)

The maximum number of subscribers that can be monitored by the specified service control entity.

Access : read-only

cServiceControlSubscribersNotifsEnable (integer)

Controls whether the system produces cServiceControlSubscriberMapping notifications. A 'false' value will prevent cServiceControlSubscriberMapping notifications from being generated by this system.

Access : read-write

Valid Values

true (1)

false (2)

CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB Notifications

cServiceControlSubscriberMappingFailedReason

This notification is sent by the service control entity when an external entity attempts to create illegal or inconsistent subscriber mappings.

The cServiceControlSubscribersNotifsEnable (integer)object contains a message describing the problem and entPhysicalName contains the name of the service control entity generating the notification.