1-- ***************************************************************** 2-- CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB.my 3-- 4-- MIB file for Cisco Service Control Subscribers. 5-- March 2007, Zaryab Munir. 6-- 7-- Copyright (c) 2007 by cisco Systems Inc. 8-- All rights reserved. 9-- 10-- **************************************************************** 11 12CISCO-SERVICE-CONTROL-SUBSCRIBERS-MIB DEFINITIONS ::= BEGIN 13 14IMPORTS 15 MODULE-IDENTITY, 16 OBJECT-TYPE, 17 Counter32, 18 NOTIFICATION-TYPE, 19 Unsigned32, 20 Gauge32 21 FROM SNMPv2-SMI 22 MODULE-COMPLIANCE, 23 NOTIFICATION-GROUP, 24 OBJECT-GROUP 25 FROM SNMPv2-CONF 26 SnmpAdminString 27 FROM SNMP-FRAMEWORK-MIB 28 RowStatus, 29 TruthValue, 30 StorageType 31 FROM SNMPv2-TC 32 entPhysicalIndex, 33 entPhysicalName 34 FROM ENTITY-MIB 35 ciscoMgmt 36 FROM CISCO-SMI; 37 38 39ciscoServiceControlSubscribersMIB MODULE-IDENTITY 40 LAST-UPDATED "200705220000Z" 41 ORGANIZATION "Cisco Systems, Inc." 42 CONTACT-INFO 43 "Cisco Systems 44 Customer Service 45 46 Postal: 170 W Tasman Drive 47 San Jose, CA 95134 48 USA 49 50 Tel: +1 800 553-NETS 51 52 E-mail: cs-excelsior-dev@cisco.com" 53 DESCRIPTION 54 "This MIB provides global and specific information on 55 subscribers managed by a service control entity, which is a 56 network element that monitors network traffic between network 57 subscribers based on user configured policies. 58 59 The network subscribers are the end users of the network with a 60 unique network address for each subscriber. 61 62 A specific subscriber is identified by this MIB by its 63 subscriber name which is assured to be unique, this id 64 is used to retrieve this specific subscriber's information." 65 REVISION "200705220000Z" 66 DESCRIPTION 67 "Initial version of this MIB module." 68 ::= { ciscoMgmt 628 } 69 70 71ciscoServiceControlSubscribersMIBNotifs OBJECT IDENTIFIER 72 ::= { ciscoServiceControlSubscribersMIB 0 } 73 74ciscoServiceControlSubscribersMIBObjects OBJECT IDENTIFIER 75 ::= { ciscoServiceControlSubscribersMIB 1 } 76 77ciscoServiceControlSubscribersMIBConform OBJECT IDENTIFIER 78 ::= { ciscoServiceControlSubscribersMIB 2 } 79 80 81cServiceControlSubscribersTable OBJECT-TYPE 82 SYNTAX SEQUENCE OF CServiceControlSubscribersEntry 83 MAX-ACCESS not-accessible 84 STATUS current 85 DESCRIPTION 86 "This table maintains list of subscribers of the service control 87 entity that has an entry in the entPhysicalTable of the 88 ENTITY-MIB. 89 90 An entry must be created in this table to monitor the subscriber 91 so that NMS application can query subscriber data from the 92 CISCO-SERVICE-CONTROL-DPI-MIB. 93 If the service control entity is not required to monitor a 94 particular subscriber, the corresponding entry is deleted by 95 setting the cServiceControlSubscribersRowStatus object to 96 'destroy'. 97 98 When the service control entity reboots, the entries associated 99 with this entity will be cleared." 100 ::= { ciscoServiceControlSubscribersMIBObjects 1 } 101 102cServiceControlSubscribersEntry OBJECT-TYPE 103 SYNTAX CServiceControlSubscribersEntry 104 MAX-ACCESS not-accessible 105 STATUS current 106 DESCRIPTION 107 "An entry (conceptual row) in the 108 cServiceControlSubscribersTable. 109 110 An entry is created to specify which subscriber 111 (cServiceControlSubscribersName) will be monitored by a service 112 control entity, identified by entPhysicalIndex in the 113 entPhysicalTable with its entPhysicalClass of 'module' or 114 'chassis'." 115 INDEX { 116 entPhysicalIndex, 117 cServiceControlSubscribersIndex 118 } 119 ::= { cServiceControlSubscribersTable 1 } 120 121CServiceControlSubscribersEntry ::= SEQUENCE { 122 cServiceControlSubscribersIndex Unsigned32, 123 cServiceControlSubscribersName SnmpAdminString, 124 cServiceControlSubscriberStorageType StorageType, 125 cServiceControlSubscribersRowStatus RowStatus 126} 127 128cServiceControlSubscribersIndex OBJECT-TYPE 129 SYNTAX Unsigned32 (1..2147483647 ) 130 MAX-ACCESS not-accessible 131 STATUS current 132 DESCRIPTION 133 "A unique subscriber entry index." 134 ::= { cServiceControlSubscribersEntry 1 } 135 136cServiceControlSubscribersName OBJECT-TYPE 137 SYNTAX SnmpAdminString 138 MAX-ACCESS read-create 139 STATUS current 140 DESCRIPTION 141 "The name of the subscriber to be monitored by this 142 service control entity." 143 ::= { cServiceControlSubscribersEntry 2 } 144 145cServiceControlSubscriberStorageType OBJECT-TYPE 146 SYNTAX StorageType 147 MAX-ACCESS read-create 148 STATUS current 149 DESCRIPTION 150 "This object specifies the storage type for this conceptual row. 151 The following columnar objects are allowed to be writable 152 when the storageType of this conceptual row is permanent(4): 153 cServiceControlSubscribersName" 154 DEFVAL { volatile } 155 ::= { cServiceControlSubscribersEntry 3 } 156 157cServiceControlSubscribersRowStatus OBJECT-TYPE 158 SYNTAX RowStatus 159 MAX-ACCESS read-create 160 STATUS current 161 DESCRIPTION 162 "The status of this conceptual row: 163 To create a row in this table, a manager must 164 set this object to either 'createAndGo' or 165 'createAndWait'. 166 Until instances of all corresponding columns are 167 appropriately configured, the value of the 168 corresponding instance of this object is 'notReady'. 169 In particular, a newly created row cannot be made 170 active until the appropriate columns have been set. 171 Default value will be automatically provisioned for those 172 objects not specified during row creation. 173 174 cServiceControlSubscribersName may not be modified while the 175 value of this object is 'active'. 176 177 An entry is deleted by setting the value of corresponding 178 instance of this object to 'destroy' or the subscriber is not 179 using the service anymore by disconnecting from the network. 180 181 The entries will be deleted when the service control entity 182 reboots." 183 ::= { cServiceControlSubscribersEntry 4 } 184 185 186 187cServiceControlSubscribersInfoTable OBJECT-TYPE 188 SYNTAX SEQUENCE OF CServiceControlSubscribersInfoEntry 189 MAX-ACCESS not-accessible 190 STATUS current 191 DESCRIPTION 192 "This table provides listing of subscribers data for a service 193 control entity that has an entry in the entPhysicalTable of the 194 ENTITY-MIB. 195 196 A subscriber of a service on the network is uniquely identified 197 by the cServiceControlSubscribersName. The subscriber may 198 either 199 be mapped to a network address known by the service control 200 entity, or may be anonymous. This table maintains statistical 201 data for subscribers known by the service control entity." 202 ::= { ciscoServiceControlSubscribersMIBObjects 2 } 203 204cServiceControlSubscribersInfoEntry OBJECT-TYPE 205 SYNTAX CServiceControlSubscribersInfoEntry 206 MAX-ACCESS not-accessible 207 STATUS current 208 DESCRIPTION 209 "An entry (conceptual row) in the 210 cServiceControlSubscribersInfoTable. This 211 entry lists information about the data regarding subscribers 212 management operations performed, and the current status of the 213 subscribers database on a service control entity that has an 214 entry in the entPhysicalTable. 215 216 entPhysicalIndex is index for this table which represents 217 entities of 'module' or 'chassis' entPhysicalClass." 218 INDEX { entPhysicalIndex } 219 ::= { cServiceControlSubscribersInfoTable 1 } 220 221CServiceControlSubscribersInfoEntry ::= SEQUENCE { 222 cServiceControlSubscribersNumIntroduced Gauge32, 223 cServiceControlSubscribersNumFree Gauge32, 224 cServiceControlSubscribersNumIpAddrMappings Gauge32, 225 cServiceControlSubscribersNumIpAddrMappingsFree Gauge32, 226 cServiceControlSubscribersNumIpRangeMappings Gauge32, 227 cServiceControlSubscribersNumIpRangeMappingsFree Gauge32, 228 cServiceControlSubscribersNumVlanMappings Gauge32, 229 cServiceControlSubscribersNumVlanMappingsFree Gauge32, 230 cServiceControlSubscribersNumActive Gauge32, 231 cServiceControlSubscribersNumUpdates Counter32, 232 cServiceControlSubscribersNumTpIpRanges Gauge32, 233 cServiceControlSubscribersNumTpIpRangesFree Gauge32, 234 cServiceControlSubscribersNumAnonymous Gauge32, 235 cServiceControlSubscribersNumWithSessions Gauge32, 236 cServiceControlSubscriberMappingFailedReason SnmpAdminString, 237 cServiceControlSubsribersMaxSupported Unsigned32 238} 239 240cServiceControlSubscribersNumIntroduced OBJECT-TYPE 241 SYNTAX Gauge32 242 MAX-ACCESS read-only 243 STATUS current 244 DESCRIPTION 245 "This object indicates the current number of subscribers that 246 have been introduced to the system. These subscribers may or may 247 not have IP address or VLAN mappings." 248 ::= { cServiceControlSubscribersInfoEntry 1 } 249 250cServiceControlSubscribersNumFree OBJECT-TYPE 251 SYNTAX Gauge32 252 MAX-ACCESS read-only 253 STATUS current 254 DESCRIPTION 255 "This object indicates the free subscriber space available in 256 the system. This is the number of subscribers that can be 257 introduced to the system in addition to the subscribers that are 258 already introduced to the system as maintained by 259 cServiceControlSubscribersNumIntroduced." 260 ::= { cServiceControlSubscribersInfoEntry 2 } 261 262cServiceControlSubscribersNumIpAddrMappings OBJECT-TYPE 263 SYNTAX Gauge32 264 MAX-ACCESS read-only 265 STATUS current 266 DESCRIPTION 267 "This object indicates the current number of subscriber 268 mappings to a single network address or to different network 269 addresses. Each address mapped to a subscriber constitutes a 270 subscriber mapping." 271 ::= { cServiceControlSubscribersInfoEntry 3 } 272 273cServiceControlSubscribersNumIpAddrMappingsFree OBJECT-TYPE 274 SYNTAX Gauge32 275 MAX-ACCESS read-only 276 STATUS current 277 DESCRIPTION 278 "This object indicates the number of free 'IP address to 279 subscriber' mappings that may be used for defining new mappings." 280 ::= { cServiceControlSubscribersInfoEntry 4 } 281 282cServiceControlSubscribersNumIpRangeMappings OBJECT-TYPE 283 SYNTAX Gauge32 284 MAX-ACCESS read-only 285 STATUS current 286 DESCRIPTION 287 "This object indicates the current number of 'IP-range to 288 subscriber' mappings. Each mapping instance corresponds to a 289 subscriber mapped to a range of IP addresses." 290 ::= { cServiceControlSubscribersInfoEntry 5 } 291 292cServiceControlSubscribersNumIpRangeMappingsFree OBJECT-TYPE 293 SYNTAX Gauge32 294 MAX-ACCESS read-only 295 STATUS current 296 DESCRIPTION 297 "This object indicates the number of free 'IP-range to 298 subscriber' mappings that may be used for defining new mappings." 299 ::= { cServiceControlSubscribersInfoEntry 6 } 300 301cServiceControlSubscribersNumVlanMappings OBJECT-TYPE 302 SYNTAX Gauge32 303 MAX-ACCESS read-only 304 STATUS current 305 DESCRIPTION 306 "This object indicates the current number of subscriber 307 mappings to a single VLAN ID or to different VLAN IDs. 308 Each VLAN ID mapped to a subscriber constitutes a 309 subscriber mapping." 310 ::= { cServiceControlSubscribersInfoEntry 7 } 311 312cServiceControlSubscribersNumVlanMappingsFree OBJECT-TYPE 313 SYNTAX Gauge32 314 MAX-ACCESS read-only 315 STATUS current 316 DESCRIPTION 317 "This object indicates the number of free 'VLAN to subscriber' 318 mappings that may be used for defining new mappings." 319 ::= { cServiceControlSubscribersInfoEntry 8 } 320 321cServiceControlSubscribersNumActive OBJECT-TYPE 322 SYNTAX Gauge32 323 MAX-ACCESS read-only 324 STATUS current 325 DESCRIPTION 326 "This object indicates the current number of active subscribers. 327 These subscribers necessarily have an IP address or VLAN 328 mappings that define the traffic that should be associated and 329 served according to the subscriber service agreement." 330 ::= { cServiceControlSubscribersInfoEntry 9 } 331 332cServiceControlSubscribersNumUpdates OBJECT-TYPE 333 SYNTAX Counter32 334 MAX-ACCESS read-only 335 STATUS current 336 DESCRIPTION 337 "This object indicates the accumulated number of subscribers 338 database updates received by the system." 339 ::= { cServiceControlSubscribersInfoEntry 10 } 340 341cServiceControlSubscribersNumTpIpRanges OBJECT-TYPE 342 SYNTAX Gauge32 343 MAX-ACCESS read-only 344 STATUS current 345 DESCRIPTION 346 "This object indicates the current number of 'Traffic Processor 347 IP address ranges' used. This object is equal to the total 348 number of network address ranges used to map to all the 349 subscribers in the system. For multiple traffic processor 350 systems, the address ranges are distributed between traffic 351 processors for dedicated processing of data belonging to the 352 mapped address space." 353 ::= { cServiceControlSubscribersInfoEntry 11 } 354 355cServiceControlSubscribersNumTpIpRangesFree OBJECT-TYPE 356 SYNTAX Gauge32 357 MAX-ACCESS read-only 358 STATUS current 359 DESCRIPTION 360 "This object indicates the number of free 'Traffic Processor IP 361 ranges'." 362 ::= { cServiceControlSubscribersInfoEntry 12 } 363 364cServiceControlSubscribersNumAnonymous OBJECT-TYPE 365 SYNTAX Gauge32 366 MAX-ACCESS read-only 367 STATUS current 368 DESCRIPTION 369 "This object indicates the current number of anonymous 370 subscribers." 371 ::= { cServiceControlSubscribersInfoEntry 13 } 372 373cServiceControlSubscribersNumWithSessions OBJECT-TYPE 374 SYNTAX Gauge32 375 MAX-ACCESS read-only 376 STATUS current 377 DESCRIPTION 378 "This object indicates the current number of subscribers with 379 open flows." 380 ::= { cServiceControlSubscribersInfoEntry 14 } 381 382cServiceControlSubscriberMappingFailedReason OBJECT-TYPE 383 SYNTAX SnmpAdminString 384 MAX-ACCESS read-only 385 STATUS current 386 DESCRIPTION 387 "This contains user readable description of the problem when 388 some external entity attempts to create illegal or inconsistent 389 subscriber mappings. For example, an attempt to map a 390 subscriber to incorrect address will culminate in the subscriber 391 name and the address to which mapping attempt is made and the 392 reason why the mapping attempt failed." 393 ::= { cServiceControlSubscribersInfoEntry 15 } 394 395cServiceControlSubsribersMaxSupported OBJECT-TYPE 396 SYNTAX Unsigned32 397 MAX-ACCESS read-only 398 STATUS current 399 DESCRIPTION 400 "This object indicates the max number of subscribers that can be 401 monitored by this service control entity." 402 ::= { cServiceControlSubscribersInfoEntry 16 } 403 404 405 406cServiceControlSubscribersNotifsEnable OBJECT-TYPE 407 SYNTAX TruthValue 408 MAX-ACCESS read-write 409 STATUS current 410 DESCRIPTION 411 "This object controls whether the system produces 412 cServiceControlSubscriberMapping notifications. A 'false' 413 value will prevent cServiceControlSubscriberMapping 414 notifications from being generated by this system." 415 ::= { ciscoServiceControlSubscribersMIBObjects 3 } 416 417cServiceControlSubscriberMapping NOTIFICATION-TYPE 418 OBJECTS { 419 entPhysicalName, 420 cServiceControlSubscriberMappingFailedReason 421 } 422 STATUS current 423 DESCRIPTION 424 "This notification is sent by the service control entity when 425 some external entity attempts to create illegal or inconsistent 426 subscriber mappings. The 427 cServiceControlSubscriberMappingFailedReason contains a message 428 describing the problem and entPhysicalName contains the name of 429 the service control entity generating the notification." 430 ::= { ciscoServiceControlSubscribersMIBNotifs 1 } 431-- Conformance 432 433cServiceControlSubscribersCompliances OBJECT IDENTIFIER 434 ::= { ciscoServiceControlSubscribersMIBConform 1 } 435 436cServiceControlSubscribersGroups OBJECT IDENTIFIER 437 ::= { ciscoServiceControlSubscribersMIBConform 2 } 438 439 440cServiceControlSubscribersCompliance MODULE-COMPLIANCE 441 STATUS current 442 DESCRIPTION 443 "The compliance statement for SNMP Agents which implement this 444 MIB." 445 MODULE -- this module 446 MANDATORY-GROUPS { 447 cServiceControlSubscribersObjectGroup, 448 cServiceControlSubscribersNotificationGroup, 449 cServiceControlSubscribersInfoObjectGroup, 450 cServiceControlSubscribersNotifsGroup 451 } 452 ::= { cServiceControlSubscribersCompliances 1 } 453 454-- Units of Conformance 455 456cServiceControlSubscribersObjectGroup OBJECT-GROUP 457 OBJECTS { 458 cServiceControlSubscribersName, 459 cServiceControlSubscribersRowStatus, 460 cServiceControlSubscriberStorageType 461 } 462 STATUS current 463 DESCRIPTION 464 "Group of objects for subscribers." 465 ::= { cServiceControlSubscribersGroups 1 } 466 467cServiceControlSubscribersNotificationGroup NOTIFICATION-GROUP 468 NOTIFICATIONS { cServiceControlSubscriberMapping } 469 STATUS current 470 DESCRIPTION 471 "Group of notifications for this MIB." 472 ::= { cServiceControlSubscribersGroups 2 } 473 474cServiceControlSubscribersInfoObjectGroup OBJECT-GROUP 475 OBJECTS { 476 cServiceControlSubscribersNumIntroduced, 477 cServiceControlSubscribersNumFree, 478 cServiceControlSubscribersNumIpAddrMappings, 479 cServiceControlSubscribersNumIpAddrMappingsFree, 480 cServiceControlSubscribersNumIpRangeMappings, 481 cServiceControlSubscribersNumIpRangeMappingsFree, 482 cServiceControlSubscribersNumVlanMappings, 483 cServiceControlSubscribersNumVlanMappingsFree, 484 cServiceControlSubscribersNumActive, 485 cServiceControlSubscribersNumUpdates, 486 cServiceControlSubscribersNumTpIpRanges, 487 cServiceControlSubscribersNumTpIpRangesFree, 488 cServiceControlSubscribersNumAnonymous, 489 cServiceControlSubscribersNumWithSessions, 490 cServiceControlSubscriberMappingFailedReason, 491 cServiceControlSubsribersMaxSupported 492 } 493 STATUS current 494 DESCRIPTION 495 "Group of objects for subscriber mappings subscriber 496 statistics." 497 ::= { cServiceControlSubscribersGroups 3 } 498 499cServiceControlSubscribersNotifsGroup OBJECT-GROUP 500 OBJECTS { cServiceControlSubscribersNotifsEnable } 501 STATUS current 502 DESCRIPTION 503 "A collection of objects providing configuration information 504 applicable to all subscriber mapping notifications." 505 ::= { cServiceControlSubscribersGroups 4 } 506 507END 508 509 510 511