DOCS-MCAST-MIB 53 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470
  1. DOCS-MCAST-MIB DEFINITIONS ::= BEGIN
  2. IMPORTS
  3. MODULE-IDENTITY,
  4. OBJECT-TYPE,
  5. Counter32,
  6. Unsigned32
  7. FROM SNMPv2-SMI -- RFC 2578
  8. RowStatus,
  9. TruthValue,
  10. MacAddress
  11. FROM SNMPv2-TC -- RFC 2579
  12. OBJECT-GROUP,
  13. MODULE-COMPLIANCE
  14. FROM SNMPv2-CONF -- RFC 2580
  15. SnmpAdminString
  16. FROM SNMP-FRAMEWORK-MIB -- RFC 3411
  17. InetAddressType,
  18. InetAddress,
  19. InetAddressPrefixLength
  20. FROM INET-ADDRESS-MIB -- RFC 4001
  21. InterfaceIndex,
  22. ifIndex
  23. FROM IF-MIB -- RFC 2863
  24. CounterBasedGauge64
  25. FROM HCNUM-TC -- RFC 2865
  26. DocsBpkmDataEncryptAlg,
  27. DocsSAId
  28. FROM DOCS-IETF-BPI2-MIB -- RFC 4131
  29. ChSetId,
  30. Dsid
  31. FROM DOCS-IF3-MIB
  32. clabProjDocsis
  33. FROM CLAB-DEF-MIB;
  34. docsMcastMib MODULE-IDENTITY
  35. LAST-UPDATED "201504220000Z" -- April 22, 2015
  36. ORGANIZATION "Cable Television Laboratories, Inc."
  37. CONTACT-INFO
  38. "Postal: Cable Television Laboratories, Inc.
  39. 858 Coal Creek Circle
  40. Louisville, Colorado 80027-9750
  41. U.S.A.
  42. Phone: +1 303-661-9100
  43. Fax: +1 303-661-9199
  44. E-mail: mibs@cablelabs.com"
  45. DESCRIPTION
  46. "This MIB module contains the management objects for the
  47. management of Multicast over DOCSIS to support Multicast
  48. DSID forwarding and or bonded multicast.
  49. Copyright 1999-2014 Cable Television Laboratories, Inc.
  50. All rights reserved."
  51. REVISION "201504220000Z" -- April 22, 2015
  52. DESCRIPTION
  53. "Revised Version includes ECN
  54. OSSIv3.0-N-15.1288-1"
  55. REVISION "201407290000Z" -- July 29, 2014
  56. DESCRIPTION
  57. "Revised Version includes ECN
  58. OSSIv3.0-N-14.1151-2 and published as I24"
  59. REVISION "200708030000Z" -- August 3, 2007
  60. DESCRIPTION
  61. "Revised Version includes ECNs
  62. OSSIv3.0-N-07.0499-1
  63. OSSIv3.0-N-07.0473-3
  64. and is published as I04"
  65. REVISION "200612071700Z" -- Dec 7, 2006
  66. DESCRIPTION
  67. "Initial version, published as part of the CableLabs
  68. OSSIv3.0 specification CM-SP-OSSIv3.0-I01-061207."
  69. ::= { clabProjDocsis 18}
  70. -- Textual Conventions
  71. -- Object Definitions
  72. docsMcastMibObjects OBJECT IDENTIFIER ::= { docsMcastMib 1 }
  73. docsMcastCmtsGrpCfgTable OBJECT-TYPE
  74. SYNTAX SEQUENCE OF DocsMcastCmtsGrpCfgEntry
  75. MAX-ACCESS not-accessible
  76. STATUS current
  77. DESCRIPTION
  78. "This object controls the QoS, PHS and encryption settings
  79. for downstream forwarding of IP multicast sessions.
  80. An IP multicast session is replicated to one
  81. or more Downstream Channel Sets (DCSs), where each
  82. DCS is either a single downstream channel or a downstream
  83. bonding group of multiple channels. The CMTS determines
  84. on which DCSs to replicate a multicast session
  85. based on IP multicast membership reports ('joins')
  86. or other vendor-specific static configuration.
  87. The CmtsGrpCfg object allows for the configuration
  88. of a range of sessions through the SrcPrefixAddr and
  89. GrpPrefixAddr and SrcPrefixLen and GrpPrefixLen attributes.
  90. The CmtsGrpCfg object allows for the configuration
  91. of QoS, Encryption and PHS for multicast sessions. Cable
  92. operators can specify configuration rules for
  93. a range of multicast sessions through the tuple of
  94. (SrcPrefixAddr,SrcPrefixLen, GrpPrefixAddr, GrpPrefixLen)
  95. attributes in an entry. The QosConfigId attribute
  96. identifies the QoS rule, the EncryptionConfigId
  97. identifies the encryption rule and the PhsConfigId
  98. identifies the PHS rule for a particular entry.
  99. Even if an entry indicates a range of multicast sessions
  100. the Encryption and PHS rules are applied on a per-session
  101. basis. That is, a separate DSID is assigned
  102. to an individual multicast session from a range of multicast
  103. sessions identified by an entry in the CmtsGrpCfg
  104. object and a PHS rule (indicated by the PhsCfgId)
  105. is applied individually to each session which is
  106. identified by the DSID assigned for that session. Similarly,
  107. a separate SAID is assigned to individual multicast
  108. session from range identified by the CmtsGrpCfg
  109. object.
  110. The CmtsGrpQosConfigQosCtrl attribute from the CmtsGrpQosCfg
  111. object is used to determine if the traffic
  112. for a range of multicast sessions identified by an
  113. entry in the CmtsGrpCfg object will be transmitted in
  114. an 'Aggregate-Session' Group Service Flow or will
  115. be transmitted separately for each session using
  116. 'Single-Session' Group Service Flows. Even if the range
  117. of multicast sessions are transmitted on an 'Aggregate-Session'
  118. Group Service Flow, the PHS and Encryption
  119. rules are always applied individually to a multicast
  120. session on a per-session DSID basis prior to
  121. being transmitted on an 'Aggregate-Session' Group
  122. Service Flow (GSF).
  123. This object supports the creation and deletion of multiple
  124. instances.
  125. Creation of a new instance of this object requires the
  126. following attributes to be set
  127. RulePriority
  128. PrefixAddrType
  129. SrcPrefixAddr
  130. SrcPrefixLen
  131. GrpPrefixAddr
  132. GrpPrefixLen
  133. IpDsLow
  134. IpDsHigh
  135. IpDsMask"
  136. ::= { docsMcastMibObjects 1}
  137. docsMcastCmtsGrpCfgEntry OBJECT-TYPE
  138. SYNTAX DocsMcastCmtsGrpCfgEntry
  139. MAX-ACCESS not-accessible
  140. STATUS current
  141. DESCRIPTION
  142. "The conceptual row of docsMcastCmtsGrpCfg.
  143. The CMTS persists all instances of the CmtsGrpConfig object
  144. across system reinitializations."
  145. INDEX {
  146. docsMcastCmtsGrpCfgId
  147. }
  148. ::= { docsMcastCmtsGrpCfgTable 1 }
  149. DocsMcastCmtsGrpCfgEntry ::= SEQUENCE {
  150. docsMcastCmtsGrpCfgId
  151. Unsigned32,
  152. docsMcastCmtsGrpCfgRulePriority
  153. Unsigned32,
  154. docsMcastCmtsGrpCfgPrefixAddrType
  155. InetAddressType,
  156. docsMcastCmtsGrpCfgSrcPrefixAddr
  157. InetAddress,
  158. docsMcastCmtsGrpCfgSrcPrefixLen
  159. InetAddressPrefixLength,
  160. docsMcastCmtsGrpCfgGrpPrefixAddr
  161. InetAddress,
  162. docsMcastCmtsGrpCfgGrpPrefixLen
  163. InetAddressPrefixLength,
  164. docsMcastCmtsGrpCfgTosLow
  165. OCTET STRING,
  166. docsMcastCmtsGrpCfgTosHigh
  167. OCTET STRING,
  168. docsMcastCmtsGrpCfgTosMask
  169. OCTET STRING,
  170. docsMcastCmtsGrpCfgQosConfigId
  171. Unsigned32,
  172. docsMcastCmtsGrpCfgEncryptConfigId
  173. Unsigned32,
  174. docsMcastCmtsGrpCfgPhsConfigId
  175. Unsigned32,
  176. docsMcastCmtsGrpCfgRowStatus
  177. RowStatus
  178. }
  179. docsMcastCmtsGrpCfgId OBJECT-TYPE
  180. SYNTAX Unsigned32 (1..4294967295)
  181. MAX-ACCESS not-accessible
  182. STATUS current
  183. DESCRIPTION
  184. "This attribute represents the unique identifier
  185. of instances of this object. This attribute is
  186. the key that identifies unique instances of the CmtsGrpConfig
  187. object."
  188. ::= { docsMcastCmtsGrpCfgEntry 1 }
  189. docsMcastCmtsGrpCfgRulePriority OBJECT-TYPE
  190. SYNTAX Unsigned32 (0..255)
  191. MAX-ACCESS read-create
  192. STATUS current
  193. DESCRIPTION
  194. "This attribute indicates the priority of this entry
  195. used to resolve which instance of this object apply
  196. when a newly replicated multicast session matches
  197. multiple entries. Higher values indicate a higher
  198. priority. Valid values for this attribute are 0..63
  199. and 192..255 in order to not conflict with CMTS
  200. internally-created instances that use the range
  201. 64..191."
  202. ::= { docsMcastCmtsGrpCfgEntry 2 }
  203. docsMcastCmtsGrpCfgPrefixAddrType OBJECT-TYPE
  204. SYNTAX InetAddressType
  205. MAX-ACCESS read-create
  206. STATUS current
  207. DESCRIPTION
  208. "This attribute identifies the address family for
  209. the multicast session (S,G) of the GC which corresponds
  210. to the SrcPrefixAddr and GrpPrefixAddr attributes
  211. respectively."
  212. ::= { docsMcastCmtsGrpCfgEntry 3 }
  213. docsMcastCmtsGrpCfgSrcPrefixAddr OBJECT-TYPE
  214. SYNTAX InetAddress
  215. MAX-ACCESS read-create
  216. STATUS current
  217. DESCRIPTION
  218. "This attribute defines the IP source address prefix
  219. of the IP multicast session.
  220. Source prefix addresses are unicast host addresses."
  221. REFERENCE
  222. "RFC 3569.
  223. RFC 3306."
  224. ::= { docsMcastCmtsGrpCfgEntry 4 }
  225. docsMcastCmtsGrpCfgSrcPrefixLen OBJECT-TYPE
  226. SYNTAX InetAddressPrefixLength
  227. MAX-ACCESS read-create
  228. STATUS current
  229. DESCRIPTION
  230. "This attribute identifies the prefix of a range of
  231. Source (S) IP multicast group addresses. For Group or
  232. ASM based sessions this attribute is set to 0."
  233. DEFVAL { 0 }
  234. ::= { docsMcastCmtsGrpCfgEntry 5 }
  235. docsMcastCmtsGrpCfgGrpPrefixAddr OBJECT-TYPE
  236. SYNTAX InetAddress
  237. MAX-ACCESS read-create
  238. STATUS current
  239. DESCRIPTION
  240. "This attribute identifies the prefix of a range of
  241. destination IP multicast group addresses."
  242. ::= { docsMcastCmtsGrpCfgEntry 6 }
  243. docsMcastCmtsGrpCfgGrpPrefixLen OBJECT-TYPE
  244. SYNTAX InetAddressPrefixLength
  245. MAX-ACCESS read-create
  246. STATUS current
  247. DESCRIPTION
  248. "This attribute identifies the prefix of a range of
  249. IP multicast group addresses."
  250. REFERENCE
  251. "DOCSIS 3.0 Operation and Support System Interface
  252. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  253. Configuration Object Model section."
  254. DEFVAL { 0 }
  255. ::= { docsMcastCmtsGrpCfgEntry 7 }
  256. docsMcastCmtsGrpCfgTosLow OBJECT-TYPE
  257. SYNTAX OCTET STRING (SIZE (1))
  258. MAX-ACCESS read-create
  259. STATUS current
  260. DESCRIPTION
  261. "This attribute identifies the low value of a range
  262. of the TOS byte value to be defined in a packet classifier
  263. this GC instantiates in the GCR in order to limit the
  264. GCR-matched traffic to a particular set of DSCPs.
  265. This applies to the IPv4 TOS byte and the IPv6 Traffic
  266. Class byte.
  267. The IP TOS octet, as originally defined in RFC 791, has
  268. been superseded by the 6-bit Differentiated Services
  269. Field and the 2-bit Explicit Congestion Notification
  270. Field."
  271. REFERENCE
  272. "RFC 791.
  273. RFC 3260.
  274. RFC3168."
  275. ::= { docsMcastCmtsGrpCfgEntry 8 }
  276. docsMcastCmtsGrpCfgTosHigh OBJECT-TYPE
  277. SYNTAX OCTET STRING (SIZE(1))
  278. MAX-ACCESS read-create
  279. STATUS current
  280. DESCRIPTION
  281. "This attribute identifies the high value of a range
  282. of the TOS byte value to be defined in a packet classifier
  283. this GC instantiates in the GCR in order to limit
  284. the GCR-matched traffic to a particular set of DSCPs.
  285. This applies to the IPv4 TOS byte and the IPv6 Traffic
  286. Class byte.
  287. The IP TOS octet, as originally defined in RFC 791, has
  288. been superseded by the 6-bit Differentiated Services
  289. Field (DSField, RFC 3260) and the 2-bit Explicit
  290. Congestion Notification Field (ECN field, RFC 3168)."
  291. REFERENCE
  292. "RFC 791.
  293. RFC 3260.
  294. RFC 3168."
  295. ::= { docsMcastCmtsGrpCfgEntry 9 }
  296. docsMcastCmtsGrpCfgTosMask OBJECT-TYPE
  297. SYNTAX OCTET STRING (SIZE(1))
  298. MAX-ACCESS read-create
  299. STATUS current
  300. DESCRIPTION
  301. "This attribute identifies the mask value bitwise
  302. ANDed with a TOS byte value to be defined in a packet classifier
  303. this GC instantiates in the GCR in order to limit
  304. the GCR-matched traffic to a particular set of DSCPs.
  305. This applies to the IPv4 TOS byte and the IPv6 Traffic
  306. Class byte.
  307. The IP TOS octet, as originally defined in RFC 791, has
  308. been superseded by the 6-bit Differentiated Services
  309. Field (DSField, RFC 3260) and the 2-bit Explicit
  310. Congestion Notification Field (ECN field, RFC 3168)."
  311. REFERENCE
  312. "RFC 791.
  313. RFC 3260.
  314. RFC 3168."
  315. ::= { docsMcastCmtsGrpCfgEntry 10 }
  316. docsMcastCmtsGrpCfgQosConfigId OBJECT-TYPE
  317. SYNTAX Unsigned32 (0..65535)
  318. MAX-ACCESS read-create
  319. STATUS current
  320. DESCRIPTION
  321. "This attribute identifies an instance in CmtsGrpQosCfg
  322. for configuring the QoS for the replication
  323. of the sessions matching this CmtsGrpCfg instance.
  324. The value 0 indicates that all replications referenced
  325. by this CmtsGrpCfg instance will be forwarded to the
  326. default GSF."
  327. REFERENCE
  328. "DOCSIS 3.0 Operation and Support System Interface
  329. Specification CM-SP-OSSIv3.0-I04-070803, Multicast QoS
  330. Configuration Object Model section."
  331. DEFVAL { 0 }
  332. ::= { docsMcastCmtsGrpCfgEntry 11 }
  333. docsMcastCmtsGrpCfgEncryptConfigId OBJECT-TYPE
  334. SYNTAX Unsigned32 (0..65535)
  335. MAX-ACCESS read-create
  336. STATUS current
  337. DESCRIPTION
  338. "This attribute identifies an instance in CmtsGrpEncryptionCfg
  339. for configuring the encryption of replicationsderived
  340. from this GC.
  341. The value 0 indicates no encryption for all replications
  342. derived from this GC."
  343. REFERENCE
  344. "DOCSIS 3.0 Operation and Support System Interface
  345. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  346. Configuration Object Model section."
  347. DEFVAL { 0 }
  348. ::= { docsMcastCmtsGrpCfgEntry 12 }
  349. docsMcastCmtsGrpCfgPhsConfigId OBJECT-TYPE
  350. SYNTAX Unsigned32 (0..65535)
  351. MAX-ACCESS read-create
  352. STATUS current
  353. DESCRIPTION
  354. "This attribute identifies an instance in CmtsGrpPhsCfg
  355. that configures DSID-indexed PHS compression
  356. for all replications derived from this GC.
  357. The value 0 indicates no PHS compression for all replications
  358. derived from this GC."
  359. REFERENCE
  360. "DOCSIS 3.0 Operation and Support System Interface
  361. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  362. Configuration Object Model section."
  363. DEFVAL { 0 }
  364. ::= { docsMcastCmtsGrpCfgEntry 13 }
  365. docsMcastCmtsGrpCfgRowStatus OBJECT-TYPE
  366. SYNTAX RowStatus
  367. MAX-ACCESS read-create
  368. STATUS current
  369. DESCRIPTION
  370. "The status of this instance."
  371. ::= { docsMcastCmtsGrpCfgEntry 14 }
  372. docsMcastCmtsGrpEncryptCfgTable OBJECT-TYPE
  373. SYNTAX SEQUENCE OF DocsMcastCmtsGrpEncryptCfgEntry
  374. MAX-ACCESS not-accessible
  375. STATUS current
  376. DESCRIPTION
  377. "This object controls the configuration of the Security
  378. Association (SA) and the encryption algorithm
  379. used for multicast sessions.
  380. This object supports the creation and deletion of instances."
  381. ::= { docsMcastMibObjects 2}
  382. docsMcastCmtsGrpEncryptCfgEntry OBJECT-TYPE
  383. SYNTAX DocsMcastCmtsGrpEncryptCfgEntry
  384. MAX-ACCESS not-accessible
  385. STATUS current
  386. DESCRIPTION
  387. "The conceptual row of docsMcastCmtsGrpEncryptCfg.
  388. The CMTS persists all instances of the CmtsGrpEncryptionConfig
  389. object across system reinitializations."
  390. INDEX {
  391. docsMcastCmtsGrpEncryptCfgId
  392. }
  393. ::= { docsMcastCmtsGrpEncryptCfgTable 1 }
  394. DocsMcastCmtsGrpEncryptCfgEntry ::= SEQUENCE {
  395. docsMcastCmtsGrpEncryptCfgId
  396. Unsigned32,
  397. docsMcastCmtsGrpEncryptCfgCtrl
  398. INTEGER,
  399. docsMcastCmtsGrpEncryptCfgAlg
  400. DocsBpkmDataEncryptAlg,
  401. docsMcastCmtsGrpEncryptCfgRowStatus
  402. RowStatus
  403. }
  404. docsMcastCmtsGrpEncryptCfgId OBJECT-TYPE
  405. SYNTAX Unsigned32 (0..65535)
  406. MAX-ACCESS not-accessible
  407. STATUS current
  408. DESCRIPTION
  409. "This attribute specifies the unique identifier of
  410. instances of this object"
  411. ::= { docsMcastCmtsGrpEncryptCfgEntry 1 }
  412. docsMcastCmtsGrpEncryptCfgCtrl OBJECT-TYPE
  413. SYNTAX INTEGER {
  414. cmts(1),
  415. mgmt(2)
  416. }
  417. MAX-ACCESS read-create
  418. STATUS current
  419. DESCRIPTION
  420. "This attribute controls whether the CMTS can select
  421. the encryption algorithm or if this can be set manually
  422. using the Alg attribute. If this attribute is set
  423. to 'cmts', the CMTS can select the encryption algorithm
  424. for the Security Association (SA). If this attribute
  425. is set to 'mgmt', the Alg attribute is used to define
  426. the encryption algorithm for this SA."
  427. DEFVAL { mgmt }
  428. ::= { docsMcastCmtsGrpEncryptCfgEntry 2 }
  429. docsMcastCmtsGrpEncryptCfgAlg OBJECT-TYPE
  430. SYNTAX DocsBpkmDataEncryptAlg
  431. MAX-ACCESS read-create
  432. STATUS current
  433. DESCRIPTION
  434. "This attribute defines which encryption algorithm
  435. will be used for an SA referenced by this object when
  436. the Ctrl is set to 'mgmt'."
  437. REFERENCE
  438. "DOCSIS 3.0 Security Specification
  439. CM-SP-SECv3.0-I01-060804,Security-Capabilities
  440. section."
  441. DEFVAL { des56CbcMode }
  442. ::= { docsMcastCmtsGrpEncryptCfgEntry 3 }
  443. docsMcastCmtsGrpEncryptCfgRowStatus OBJECT-TYPE
  444. SYNTAX RowStatus
  445. MAX-ACCESS read-create
  446. STATUS current
  447. DESCRIPTION
  448. "The status of this instance."
  449. ::= { docsMcastCmtsGrpEncryptCfgEntry 4 }
  450. docsMcastCmtsGrpPhsCfgTable OBJECT-TYPE
  451. SYNTAX SEQUENCE OF DocsMcastCmtsGrpPhsCfgEntry
  452. MAX-ACCESS not-accessible
  453. STATUS current
  454. DESCRIPTION
  455. "This object controls the configuration of DSID-indexed
  456. PHS for multicast sessions. Configuration of
  457. PHS Rules via this table must not be based on the configuration
  458. of a range of sessions, but must be configured
  459. on a single multicast session.
  460. Creation of multiple instances of this object require
  461. the following attributes to be set:
  462. PhsField
  463. PhsMask
  464. PhsSize"
  465. ::= { docsMcastMibObjects 3}
  466. docsMcastCmtsGrpPhsCfgEntry OBJECT-TYPE
  467. SYNTAX DocsMcastCmtsGrpPhsCfgEntry
  468. MAX-ACCESS not-accessible
  469. STATUS current
  470. DESCRIPTION
  471. "The conceptual row of docsMcastCmtsGrpPhsCfg.
  472. The CMTS persists all instances of the CmtsGrpPhsConfig
  473. object across system reinitializations."
  474. INDEX {
  475. docsMcastCmtsGrpPhsCfgId
  476. }
  477. ::= { docsMcastCmtsGrpPhsCfgTable 1 }
  478. DocsMcastCmtsGrpPhsCfgEntry ::= SEQUENCE {
  479. docsMcastCmtsGrpPhsCfgId
  480. Unsigned32,
  481. docsMcastCmtsGrpPhsCfgPhsField
  482. OCTET STRING,
  483. docsMcastCmtsGrpPhsCfgPhsMask
  484. OCTET STRING,
  485. docsMcastCmtsGrpPhsCfgPhsSize
  486. Unsigned32,
  487. docsMcastCmtsGrpPhsCfgPhsVerify
  488. TruthValue,
  489. docsMcastCmtsGrpPhsCfgRowStatus
  490. RowStatus
  491. }
  492. docsMcastCmtsGrpPhsCfgId OBJECT-TYPE
  493. SYNTAX Unsigned32 (0..65535)
  494. MAX-ACCESS not-accessible
  495. STATUS current
  496. DESCRIPTION
  497. "This attribute identifies the unique identifier
  498. of a PHS rule that is referenced by the GrpConfig object."
  499. ::= { docsMcastCmtsGrpPhsCfgEntry 1 }
  500. docsMcastCmtsGrpPhsCfgPhsField OBJECT-TYPE
  501. SYNTAX OCTET STRING (SIZE (0..255))
  502. MAX-ACCESS read-create
  503. STATUS current
  504. DESCRIPTION
  505. "This attribute defines the bytes of the DOCSIS header
  506. which must be suppressed/restored by the sending/receiving
  507. device."
  508. ::= { docsMcastCmtsGrpPhsCfgEntry 2 }
  509. docsMcastCmtsGrpPhsCfgPhsMask OBJECT-TYPE
  510. SYNTAX OCTET STRING (SIZE (0..32))
  511. MAX-ACCESS read-create
  512. STATUS current
  513. DESCRIPTION
  514. "This attribute defines the bit mask which is used in
  515. combination with the PhsField to define which bytes
  516. in header must be suppressed/restored by the sending
  517. or receiving device.
  518. Each bit of this bit mask corresponds to a byte in the
  519. PhsField, with the least significant bit corresponding
  520. to the first byte of the PhsField.
  521. Each bit of the bit mask specifies whether or not the
  522. corresponding byte should be suppressed in the packet.
  523. A bit value of '1' indicates that the byte should be
  524. suppressed by the sending device and restored by the
  525. receiving device.
  526. A bit value of '0' indicates that the byte should not be
  527. suppressed by the sending device or restored by the
  528. receiving device.
  529. If the bit mask does not contain a bit for each byte in the
  530. PhsField then the bit mask is extended with bit values
  531. of '1' to be the necessary length."
  532. REFERENCE
  533. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  534. Specification CM-SP-MULPIv3.0-I01-060804,
  535. Payload Header Suppression Encodings section and
  536. Payload Header Suppression Mask (PHSM) in the Common
  537. Radio Frequency Interface Encodings Annex."
  538. ::= { docsMcastCmtsGrpPhsCfgEntry 3 }
  539. docsMcastCmtsGrpPhsCfgPhsSize OBJECT-TYPE
  540. SYNTAX Unsigned32 (0..255)
  541. UNITS "Bytes"
  542. MAX-ACCESS read-create
  543. STATUS current
  544. DESCRIPTION
  545. "This attribute specifies the number of bytes in the
  546. header to be suppressed and restored.
  547. The value of this object matches the number of bytes the
  548. bits indicated in the PhsField attribute."
  549. REFERENCE
  550. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  551. Specification CM-SP-MULPIv3.0-I01-060804, Payload Header
  552. Suppression Encodings section and Payload Header Suppression
  553. Size (PHSS) section in the Common Radio Frequency Interface
  554. Encodings Annex."
  555. ::= { docsMcastCmtsGrpPhsCfgEntry 4 }
  556. docsMcastCmtsGrpPhsCfgPhsVerify OBJECT-TYPE
  557. SYNTAX TruthValue
  558. MAX-ACCESS read-create
  559. STATUS current
  560. DESCRIPTION
  561. "This attribute specifies the Payload Header Suppression
  562. verification value of 'true' the sender must
  563. verify PhsField is the same as what is contained in the
  564. packet to be suppressed."
  565. REFERENCE
  566. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  567. Specification CM-SP-MULPIv3.0-I01-060804, Payload Header
  568. Suppression Encodings section and Payload Header Suppression
  569. Size (PHSS) section in the Common Radio Frequency Interface
  570. Encodings Annex."
  571. DEFVAL { false }
  572. ::= { docsMcastCmtsGrpPhsCfgEntry 5 }
  573. docsMcastCmtsGrpPhsCfgRowStatus OBJECT-TYPE
  574. SYNTAX RowStatus
  575. MAX-ACCESS read-create
  576. STATUS current
  577. DESCRIPTION
  578. "The status of this instance."
  579. ::= { docsMcastCmtsGrpPhsCfgEntry 6 }
  580. docsMcastCmtsGrpQosCfgTable OBJECT-TYPE
  581. SYNTAX SEQUENCE OF DocsMcastCmtsGrpQosCfgEntry
  582. MAX-ACCESS not-accessible
  583. STATUS current
  584. DESCRIPTION
  585. "This object configures the QoS configured for Multicast
  586. sessions replicated to any Downstream Channel
  587. Set. It does not control which particular DCSs to which
  588. the CMTS replicates a multicast session.
  589. An instance in this object is called a GQC entry. A GQC
  590. entry controls how the CMTS instantiates a Group Classifier
  591. Rule (GCR) on the DCS to match packets of the multicast
  592. session. A Group Classifier Rule (GCR) uses
  593. source and destination IP address and ToS criteria.
  594. A GQC entry controls how and with what QoS parameters
  595. a Group Service Flow (GSF) is created on a DCS. All downstream
  596. multicast packets are scheduled on a GSF. The
  597. QoS Type attribute of the GQC entry controls whether
  598. the CMTS creates one GSF for each single IP multicast
  599. session or whether the CMTS creates one GSF for the aggregate
  600. of all sessions that match the GQC criteria.
  601. The GQC instance contains a reference to a Service Class
  602. from docsIetfQosServiceClassTable. The Service
  603. Class defines the list of QoS parameters for the GSF(s)
  604. instantiated for the GQC entry.
  605. A CMTS identifies one Service Class as the Default Group
  606. QoS Service Class. The CMTS instantiates a Default
  607. Group Service Flow on each single-channel DCS based
  608. on the parameters of the Default Group QoS Service
  609. Class.
  610. The set of GCRs and GSFs instantiated on a DCS control
  611. how QoS is provided to multicast packets replicated
  612. to the DCS. For each multicast packet, the CMTS classifies
  613. the packet to the highest priority matching GCR
  614. on that DCS. The GCR refers to a single GSF, which controls
  615. the scheduling of the packets on the DCS. If the
  616. multicast packet does not match any GCR on the DCS, the
  617. packet is scheduled on the Default Group Service Flow
  618. of the DCS. The CMTS replicates unclassified multicast
  619. traffic to only DCSs consisting of a single downstream
  620. channel. Thus, the Maximum Sustained Traffic
  621. Rate QoS parameter of the Default Group Service Class
  622. limits the aggregate rate of unclassified multicast
  623. traffic on each downstream channel.
  624. The CMTS is expected to instantiate GCRs and GSFs controlled
  625. by the entries in this table only for the duration
  626. of replication of the multicast sessions matching
  627. the entry.
  628. This object supports the creation of multiple instances.
  629. Creation of new instances of this object require the
  630. following objects to be set:
  631. ServiceClassName
  632. QosCtrl
  633. AggSessLimit"
  634. ::= { docsMcastMibObjects 4}
  635. docsMcastCmtsGrpQosCfgEntry OBJECT-TYPE
  636. SYNTAX DocsMcastCmtsGrpQosCfgEntry
  637. MAX-ACCESS not-accessible
  638. STATUS current
  639. DESCRIPTION
  640. "The conceptual row of docsMcastCmtsGrpQosCfg.
  641. The CMTS persists all instances of the CmtsGrpQosConfig
  642. object across system reinitialization."
  643. INDEX {
  644. docsMcastCmtsGrpQosCfgId
  645. }
  646. ::= { docsMcastCmtsGrpQosCfgTable 1 }
  647. DocsMcastCmtsGrpQosCfgEntry ::= SEQUENCE {
  648. docsMcastCmtsGrpQosCfgId
  649. Unsigned32,
  650. docsMcastCmtsGrpQosCfgServiceClassName
  651. SnmpAdminString,
  652. docsMcastCmtsGrpQosCfgQosCtrl
  653. INTEGER,
  654. docsMcastCmtsGrpQosCfgAggSessLimit
  655. Unsigned32,
  656. docsMcastCmtsGrpQosCfgAppId
  657. Unsigned32,
  658. docsMcastCmtsGrpQosCfgRowStatus
  659. RowStatus
  660. }
  661. docsMcastCmtsGrpQosCfgId OBJECT-TYPE
  662. SYNTAX Unsigned32 (0..65535)
  663. MAX-ACCESS not-accessible
  664. STATUS current
  665. DESCRIPTION
  666. "This attribute identifies a unique Group QoS Configuration
  667. object instance."
  668. ::= { docsMcastCmtsGrpQosCfgEntry 1 }
  669. docsMcastCmtsGrpQosCfgServiceClassName OBJECT-TYPE
  670. SYNTAX SnmpAdminString (SIZE (1..15))
  671. MAX-ACCESS read-create
  672. STATUS current
  673. DESCRIPTION
  674. "This attribute identifies the Service Class Name
  675. reference for the set of QoS parameters for this GQC."
  676. REFERENCE
  677. "DOCSIS 3.0 Operation and Support System Interface
  678. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  679. Configuration Object Model section."
  680. DEFVAL { ''H }
  681. ::= { docsMcastCmtsGrpQosCfgEntry 2 }
  682. docsMcastCmtsGrpQosCfgQosCtrl OBJECT-TYPE
  683. SYNTAX INTEGER {
  684. singleSsession(1),
  685. aggregateSession(2)
  686. }
  687. MAX-ACCESS read-create
  688. STATUS current
  689. DESCRIPTION
  690. "This attribute identifies how Group Classifier Rules
  691. (GCRs) and Group Service Flows (GSFs) are instantiated
  692. when multiple sessions match the (S,G) criteria
  693. of this entry. If 'singleSession', the CMTS creates
  694. a unique GCR and a unique GSF for the session. If this
  695. object's value is 'aggregateSession', all sessions
  696. matching this criterion are aggregated into the
  697. same GSF."
  698. REFERENCE
  699. "DOCSIS 3.0 Operation and Support System Interface
  700. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  701. Configuration Object Model section."
  702. ::= { docsMcastCmtsGrpQosCfgEntry 3 }
  703. docsMcastCmtsGrpQosCfgAggSessLimit OBJECT-TYPE
  704. SYNTAX Unsigned32 (1..65535)
  705. MAX-ACCESS read-create
  706. STATUS current
  707. DESCRIPTION
  708. "This attribute identifies the maximum number of sessions
  709. that may be aggregated in an aggregated Service
  710. Flow. This value is ignored in case of a GQC entry with QosCtrl
  711. set to 'singleSession'."
  712. REFERENCE
  713. "DOCSIS 3.0 Operation and Support System Interface
  714. Specification CM-SP-OSSIv3.0-I01-061207, Multicast QoS
  715. Configuration Object Model section."
  716. ::= { docsMcastCmtsGrpQosCfgEntry 4 }
  717. docsMcastCmtsGrpQosCfgAppId OBJECT-TYPE
  718. SYNTAX Unsigned32
  719. MAX-ACCESS read-create
  720. STATUS current
  721. DESCRIPTION
  722. "This attribute allows the operator to configure a Cable
  723. Operator defined Application Identifier for multicast
  724. sessions, e.g., an Application Manager ID and
  725. Application Type.
  726. This Application Identifier can be used to influence
  727. admission control or other policies in the CMTS that
  728. are outside of the scope of this specification.
  729. This parameter is optional in defining QoS for
  730. multicast sessions.
  731. If the value of this attribute is different from the
  732. value of the AppId in the referenced SCN for this GQC
  733. instance, the value of this attribute is used."
  734. REFERENCE
  735. "DOCSIS 3.0 MAC and Upper Layer Protocols Interface
  736. Specification CM-SP-MULPIv3.0-I04-070518, Application
  737. Identifier section in the Common TLV Encodings Annex;
  738. PacketCable Multimedia Specification PKT-SP-MM-I03-051221,
  739. Policy Server and CMTS Interface section."
  740. DEFVAL { 0 }
  741. ::= { docsMcastCmtsGrpQosCfgEntry 5 }
  742. docsMcastCmtsGrpQosCfgRowStatus OBJECT-TYPE
  743. SYNTAX RowStatus
  744. MAX-ACCESS read-create
  745. STATUS current
  746. DESCRIPTION
  747. "The status of this instance."
  748. ::= { docsMcastCmtsGrpQosCfgEntry 6 }
  749. docsMcastCmtsReplSessTable OBJECT-TYPE
  750. SYNTAX SEQUENCE OF DocsMcastCmtsReplSessEntry
  751. MAX-ACCESS not-accessible
  752. STATUS current
  753. DESCRIPTION
  754. "This object describes the replication of IP Multicast
  755. sessions onto the different Downstream Channel
  756. Sets of a CMTS. Each DCS may be either a single downstream
  757. channel or a bonding group of multiple downstream
  758. channels. Each IP Multicast session is identified
  759. by a combination of IP source and IP Destination group
  760. address '(S,G). The CMTS replicates each IP packet
  761. in an (S,G) session onto one or more Downstream Channel
  762. Sets (DCSs), each of which is implemented in a MAC
  763. Domain. The CMTS assigns each replication a Downstream
  764. Service ID (DSID) that is unique per MAC Domain."
  765. ::= { docsMcastMibObjects 5}
  766. docsMcastCmtsReplSessEntry OBJECT-TYPE
  767. SYNTAX DocsMcastCmtsReplSessEntry
  768. MAX-ACCESS not-accessible
  769. STATUS current
  770. DESCRIPTION
  771. "The conceptual row of docsMcastCmtsReplSess."
  772. INDEX {
  773. docsMcastCmtsReplSessPrefixAddrType,
  774. docsMcastCmtsReplSessGrpPrefix,
  775. docsMcastCmtsReplSessSrcPrefix,
  776. docsMcastCmtsReplSessMdIfIndex,
  777. docsMcastCmtsReplSessDcsId,
  778. docsMcastCmtsReplSessServiceFlowId
  779. }
  780. ::= { docsMcastCmtsReplSessTable 1 }
  781. DocsMcastCmtsReplSessEntry ::= SEQUENCE {
  782. docsMcastCmtsReplSessPrefixAddrType
  783. InetAddressType,
  784. docsMcastCmtsReplSessGrpPrefix
  785. InetAddress,
  786. docsMcastCmtsReplSessSrcPrefix
  787. InetAddress,
  788. docsMcastCmtsReplSessMdIfIndex
  789. InterfaceIndex,
  790. docsMcastCmtsReplSessDcsId
  791. ChSetId,
  792. docsMcastCmtsReplSessServiceFlowId
  793. Unsigned32,
  794. docsMcastCmtsReplSessDsid
  795. Dsid,
  796. docsMcastCmtsReplSessSaid
  797. DocsSAId
  798. }
  799. docsMcastCmtsReplSessPrefixAddrType OBJECT-TYPE
  800. SYNTAX InetAddressType
  801. MAX-ACCESS not-accessible
  802. STATUS current
  803. DESCRIPTION
  804. "This attribute defines the address type for the GrpPrefix
  805. and SrcPrefix addresses."
  806. ::= { docsMcastCmtsReplSessEntry 1 }
  807. docsMcastCmtsReplSessGrpPrefix OBJECT-TYPE
  808. SYNTAX InetAddress
  809. MAX-ACCESS not-accessible
  810. STATUS current
  811. DESCRIPTION
  812. "This attribute defines the group G of a particular
  813. (S,G) IP multicast session."
  814. ::= { docsMcastCmtsReplSessEntry 2 }
  815. docsMcastCmtsReplSessSrcPrefix OBJECT-TYPE
  816. SYNTAX InetAddress
  817. MAX-ACCESS not-accessible
  818. STATUS current
  819. DESCRIPTION
  820. "This attribute identifies a specific Multicast Source
  821. Address. A Source Address that is all zeros is defined
  822. as 'all source addresses (*, G)'."
  823. REFERENCE
  824. "RFC 3569.
  825. RFC 3306."
  826. ::= { docsMcastCmtsReplSessEntry 3 }
  827. docsMcastCmtsReplSessMdIfIndex OBJECT-TYPE
  828. SYNTAX InterfaceIndex
  829. MAX-ACCESS not-accessible
  830. STATUS current
  831. DESCRIPTION
  832. "This attribute defines the MAC Domain Interface index
  833. of the channel to which the (S,G) session is replicated."
  834. ::= { docsMcastCmtsReplSessEntry 4 }
  835. docsMcastCmtsReplSessDcsId OBJECT-TYPE
  836. SYNTAX ChSetId
  837. MAX-ACCESS not-accessible
  838. STATUS current
  839. DESCRIPTION
  840. "This attribute provides the reference for the Downstream
  841. Channel Set within a MAC Domain that the multicast
  842. session (S,G) is replicated to."
  843. ::= { docsMcastCmtsReplSessEntry 5 }
  844. docsMcastCmtsReplSessServiceFlowId OBJECT-TYPE
  845. SYNTAX Unsigned32 (1..4294967295)
  846. MAX-ACCESS not-accessible
  847. STATUS current
  848. DESCRIPTION
  849. "This attribute indicates the service flow into which
  850. packets are classified for this replication of the
  851. multicast session (S,G)."
  852. ::= { docsMcastCmtsReplSessEntry 6 }
  853. docsMcastCmtsReplSessDsid OBJECT-TYPE
  854. SYNTAX Dsid
  855. MAX-ACCESS read-only
  856. STATUS current
  857. DESCRIPTION
  858. "This attribute defines the Downstream Service ID
  859. (DSID) label with which the CMTS labels all packets of
  860. the (S,G) session on the DCS of a MAC Domain. The DSID
  861. value is unique per MAC domain."
  862. ::= { docsMcastCmtsReplSessEntry 7 }
  863. docsMcastCmtsReplSessSaid OBJECT-TYPE
  864. SYNTAX DocsSAId
  865. MAX-ACCESS read-only
  866. STATUS current
  867. DESCRIPTION
  868. "This attribute defines the Security Association
  869. ID (SAID) of this multicast replication session. The
  870. value 0 indicates no SAID associated with this session."
  871. ::= { docsMcastCmtsReplSessEntry 8 }
  872. docsMcastDefGrpSvcClass OBJECT IDENTIFIER ::= { docsMcastMibObjects 6 }
  873. docsMcastDefGrpSvcClassDef OBJECT-TYPE
  874. SYNTAX SnmpAdminString (SIZE (0..15))
  875. MAX-ACCESS read-write
  876. STATUS current
  877. DESCRIPTION
  878. "This attribute references an instance of the SNMP
  879. table docsIetfQosServiceClassName object. This attribute
  880. is used to expand the QoS parameter Set of QoS
  881. for multicast sessions that uses a default QoS policy.
  882. The CMTS persists all instances of this attribute across
  883. reinitializations."
  884. REFERENCE
  885. "RFC 4323."
  886. DEFVAL { ''H }
  887. ::= { docsMcastDefGrpSvcClass 1 }
  888. docsMcastDsidPhsTable OBJECT-TYPE
  889. SYNTAX SEQUENCE OF DocsMcastDsidPhsEntry
  890. MAX-ACCESS not-accessible
  891. STATUS current
  892. DESCRIPTION
  893. "This object reports the set of DSID-Indexed PHS rules
  894. that are signaled between the CMTS and CMs as part
  895. of the Multicast Sessions setup. The attributes PhsMask,
  896. PhsSize and PhsVerify comes from the configuration
  897. object CmtsGrpPhsCfg. The value of the PhsField
  898. attribute is derived by the CMTS from the CmtsGrpCfg
  899. object parameters, and possibly other IP header informaton
  900. of the multicast session that the CMTS is capable
  901. of knowning prior to the multicast session setup.
  902. In cases where the PhsSize is longer than the CMTS
  903. knowledge of IP/TCP header fields, the CMTS extends
  904. the PhsMask with bits set to 0 until reaching the equivalent
  905. PhsSize value."
  906. ::= { docsMcastMibObjects 7}
  907. docsMcastDsidPhsEntry OBJECT-TYPE
  908. SYNTAX DocsMcastDsidPhsEntry
  909. MAX-ACCESS not-accessible
  910. STATUS current
  911. DESCRIPTION
  912. "The conceptual row of docsMcastDsidPhs.
  913. The ifIndex key corresponds to the MAC Domain interface
  914. where the PHSI-Indexed DSID is configured."
  915. INDEX {
  916. ifIndex,
  917. docsMcastDsidPhsDsid
  918. }
  919. ::= { docsMcastDsidPhsTable 1 }
  920. DocsMcastDsidPhsEntry ::= SEQUENCE {
  921. docsMcastDsidPhsDsid
  922. Dsid,
  923. docsMcastDsidPhsPhsField
  924. OCTET STRING,
  925. docsMcastDsidPhsPhsMask
  926. OCTET STRING,
  927. docsMcastDsidPhsPhsSize
  928. Unsigned32,
  929. docsMcastDsidPhsPhsVerify
  930. TruthValue
  931. }
  932. docsMcastDsidPhsDsid OBJECT-TYPE
  933. SYNTAX Dsid
  934. MAX-ACCESS not-accessible
  935. STATUS current
  936. DESCRIPTION
  937. "This attribute represents the 20-bit DSID associated
  938. with this PHS rule."
  939. ::= { docsMcastDsidPhsEntry 1 }
  940. docsMcastDsidPhsPhsField OBJECT-TYPE
  941. SYNTAX OCTET STRING (SIZE (0..255))
  942. MAX-ACCESS read-only
  943. STATUS current
  944. DESCRIPTION
  945. "This attribute defines the bytes of the header which
  946. must be suppressed/restored by the sending/receiving
  947. device."
  948. ::= { docsMcastDsidPhsEntry 2 }
  949. docsMcastDsidPhsPhsMask OBJECT-TYPE
  950. SYNTAX OCTET STRING (SIZE (0..32))
  951. MAX-ACCESS read-only
  952. STATUS current
  953. DESCRIPTION
  954. "This attribute defines the Payload Header Suppression
  955. mask in the header to be suppressed and restored."
  956. ::= { docsMcastDsidPhsEntry 3 }
  957. docsMcastDsidPhsPhsSize OBJECT-TYPE
  958. SYNTAX Unsigned32 (0..255)
  959. MAX-ACCESS read-only
  960. STATUS current
  961. DESCRIPTION
  962. "This attribute defines the number of bytes in the
  963. header to be suppressed and restored."
  964. ::= { docsMcastDsidPhsEntry 4 }
  965. docsMcastDsidPhsPhsVerify OBJECT-TYPE
  966. SYNTAX TruthValue
  967. MAX-ACCESS read-only
  968. STATUS current
  969. DESCRIPTION
  970. "This attribute, when set to 'true', indicates that
  971. the sender must verify that the PHS Field attribute
  972. value is the same is the same as what is contained in the
  973. packet to be suppressed."
  974. ::= { docsMcastDsidPhsEntry 5 }
  975. docsMcastStatsTable OBJECT-TYPE
  976. SYNTAX SEQUENCE OF DocsMcastStatsEntry
  977. MAX-ACCESS not-accessible
  978. STATUS current
  979. DESCRIPTION
  980. "The table contains statistics for the IP multicast session
  981. identified by the combination of IP source and IP destination
  982. group address (S,G)."
  983. ::= { docsMcastMibObjects 8}
  984. docsMcastStatsEntry OBJECT-TYPE
  985. SYNTAX DocsMcastStatsEntry
  986. MAX-ACCESS not-accessible
  987. STATUS current
  988. DESCRIPTION
  989. "The conceptual row of docsMcastStatsTable.
  990. The ifIndex key corresponds to the Ethernet interface
  991. where the IP Multicast session is configured."
  992. INDEX {
  993. ifIndex,
  994. docsMcastStatsGrpAddrType,
  995. docsMcastStatsGrpAddr,
  996. docsMcastStatsGrpPrefixLen,
  997. docsMcastStatsSrcAddrType,
  998. docsMcastStatsSrcAddr,
  999. docsMcastStatsSrcPrefixLen
  1000. }
  1001. ::= { docsMcastStatsTable 1 }
  1002. DocsMcastStatsEntry ::= SEQUENCE {
  1003. docsMcastStatsGrpAddrType
  1004. InetAddressType,
  1005. docsMcastStatsGrpAddr
  1006. InetAddress,
  1007. docsMcastStatsGrpPrefixLen
  1008. InetAddressPrefixLength,
  1009. docsMcastStatsSrcAddrType
  1010. InetAddressType,
  1011. docsMcastStatsSrcAddr
  1012. InetAddress,
  1013. docsMcastStatsSrcPrefixLen
  1014. InetAddressPrefixLength,
  1015. docsMcastStatsDroppedPkts
  1016. Counter32,
  1017. docsMcastStatsDroppedOctets
  1018. Counter32
  1019. }
  1020. docsMcastStatsGrpAddrType OBJECT-TYPE
  1021. SYNTAX InetAddressType
  1022. MAX-ACCESS not-accessible
  1023. STATUS current
  1024. DESCRIPTION
  1025. "This attribute indicates the address family of the address
  1026. contained in docsMcastStatsGrpAddr."
  1027. ::= { docsMcastStatsEntry 1 }
  1028. docsMcastStatsGrpAddr OBJECT-TYPE
  1029. SYNTAX InetAddress
  1030. MAX-ACCESS not-accessible
  1031. STATUS current
  1032. DESCRIPTION
  1033. "This attribute defines 'G' as the group address for a
  1034. particular (S,G) IP multicast session."
  1035. ::= { docsMcastStatsEntry 2 }
  1036. docsMcastStatsGrpPrefixLen OBJECT-TYPE
  1037. SYNTAX InetAddressPrefixLength
  1038. MAX-ACCESS not-accessible
  1039. STATUS current
  1040. DESCRIPTION
  1041. "This attribute defines the group address prefix length
  1042. of a particular (S,G) IP multicast session."
  1043. ::= { docsMcastStatsEntry 3 }
  1044. docsMcastStatsSrcAddrType OBJECT-TYPE
  1045. SYNTAX InetAddressType
  1046. MAX-ACCESS not-accessible
  1047. STATUS current
  1048. DESCRIPTION
  1049. "This attribute indicates the address family of the address
  1050. contained in docsMcastStatsSrcAddr."
  1051. ::= { docsMcastStatsEntry 4 }
  1052. docsMcastStatsSrcAddr OBJECT-TYPE
  1053. SYNTAX InetAddress
  1054. MAX-ACCESS not-accessible
  1055. STATUS current
  1056. DESCRIPTION
  1057. "This attribute defines 'S' as the source address for a
  1058. particular (S,G) IP multicast session. For the case of
  1059. Any Source Multicast (ASM), this attribute uses a value
  1060. of 0.0.0.0 for IPv4 or 0::/0 for IPv6."
  1061. ::= { docsMcastStatsEntry 5 }
  1062. docsMcastStatsSrcPrefixLen OBJECT-TYPE
  1063. SYNTAX InetAddressPrefixLength
  1064. MAX-ACCESS not-accessible
  1065. STATUS current
  1066. DESCRIPTION
  1067. "This attribute defines the source address prefix length
  1068. of a particular (S,G) IP multicast session."
  1069. ::= { docsMcastStatsEntry 6 }
  1070. docsMcastStatsDroppedPkts OBJECT-TYPE
  1071. SYNTAX Counter32
  1072. MAX-ACCESS read-only
  1073. STATUS current
  1074. DESCRIPTION
  1075. "This attribute returns a count of the packets dropped by the
  1076. CMTS Forwarder process for a particular IP multicast session
  1077. prior to replication to the outbound interface(s) (e.g., MAC
  1078. domain interfaces). These packet drops can occur whenever there
  1079. are no replications for this IP multicast session, or where an
  1080. IP multicast packet for the specific S,G is not forwarded to
  1081. the outbound interface(s)."
  1082. ::= { docsMcastStatsEntry 7 }
  1083. docsMcastStatsDroppedOctets OBJECT-TYPE
  1084. SYNTAX Counter32
  1085. MAX-ACCESS read-only
  1086. STATUS current
  1087. DESCRIPTION
  1088. "This attribute returns a count of the octets for packets
  1089. dropped by the CMTS Forwarder process for a particular IP
  1090. multicast session prior to replication to the outbound
  1091. interface(s)."
  1092. ::= { docsMcastStatsEntry 8 }
  1093. docsMcastCpeListTable OBJECT-TYPE
  1094. SYNTAX SEQUENCE OF DocsMcastCpeListEntry
  1095. MAX-ACCESS not-accessible
  1096. STATUS current
  1097. DESCRIPTION
  1098. "The table contains CPE information for the IP multicast session
  1099. identified by the combination of IP source and IP destination
  1100. group address (S,G), MAC Domain interface and CM MAC address."
  1101. ::= { docsMcastMibObjects 9}
  1102. docsMcastCpeListEntry OBJECT-TYPE
  1103. SYNTAX DocsMcastCpeListEntry
  1104. MAX-ACCESS not-accessible
  1105. STATUS current
  1106. DESCRIPTION
  1107. "The conceptual row of docsMcastCpeListTable.
  1108. The ifIndex key corresponds to the MAC Domain interface
  1109. where the IP Multicast session is configured."
  1110. INDEX {
  1111. ifIndex,
  1112. docsMcastCpeListGrpAddrType,
  1113. docsMcastCpeListGrpAddr,
  1114. docsMcastCpeListGrpPrefixLen,
  1115. docsMcastCpeListSrcAddrType,
  1116. docsMcastCpeListSrcAddr,
  1117. docsMcastCpeListSrcPrefixLen,
  1118. docsMcastCpeListCmMacAddr
  1119. }
  1120. ::= { docsMcastCpeListTable 1 }
  1121. DocsMcastCpeListEntry ::= SEQUENCE {
  1122. docsMcastCpeListGrpAddrType
  1123. InetAddressType,
  1124. docsMcastCpeListGrpAddr
  1125. InetAddress,
  1126. docsMcastCpeListGrpPrefixLen
  1127. InetAddressPrefixLength,
  1128. docsMcastCpeListSrcAddrType
  1129. InetAddressType,
  1130. docsMcastCpeListSrcAddr
  1131. InetAddress,
  1132. docsMcastCpeListSrcPrefixLen
  1133. InetAddressPrefixLength,
  1134. docsMcastCpeListCmMacAddr
  1135. MacAddress,
  1136. docsMcastCpeListDsid
  1137. Dsid,
  1138. docsMcastCpeListCpeMacAddr
  1139. MacAddress,
  1140. docsMcastCpeListCpeIpAddrType
  1141. InetAddressType,
  1142. docsMcastCpeListCpeIpAddr
  1143. InetAddress
  1144. }
  1145. docsMcastCpeListGrpAddrType OBJECT-TYPE
  1146. SYNTAX InetAddressType
  1147. MAX-ACCESS not-accessible
  1148. STATUS current
  1149. DESCRIPTION
  1150. "This attribute indicates the address family of the address
  1151. contained in docsMcastCpeListGrpAddr."
  1152. ::= { docsMcastCpeListEntry 1 }
  1153. docsMcastCpeListGrpAddr OBJECT-TYPE
  1154. SYNTAX InetAddress
  1155. MAX-ACCESS not-accessible
  1156. STATUS current
  1157. DESCRIPTION
  1158. "This attribute defines 'G' as the group address for a
  1159. particular (S,G) IP multicast session."
  1160. ::= { docsMcastCpeListEntry 2 }
  1161. docsMcastCpeListGrpPrefixLen OBJECT-TYPE
  1162. SYNTAX InetAddressPrefixLength
  1163. MAX-ACCESS not-accessible
  1164. STATUS current
  1165. DESCRIPTION
  1166. "This attribute defines the group address prefix length
  1167. of a particular (S,G) IP multicast session."
  1168. ::= { docsMcastCpeListEntry 3 }
  1169. docsMcastCpeListSrcAddrType OBJECT-TYPE
  1170. SYNTAX InetAddressType
  1171. MAX-ACCESS not-accessible
  1172. STATUS current
  1173. DESCRIPTION
  1174. "This attribute indicates the address family of the address
  1175. contained in docsMcastCpeListSrcAddr."
  1176. ::= { docsMcastCpeListEntry 4 }
  1177. docsMcastCpeListSrcAddr OBJECT-TYPE
  1178. SYNTAX InetAddress
  1179. MAX-ACCESS not-accessible
  1180. STATUS current
  1181. DESCRIPTION
  1182. "This attribute defines 'S' as the source address for a
  1183. particular (S,G) IP multicast session. For the case of
  1184. Any Source Multicast (ASM), this attribute uses a value
  1185. of 0.0.0.0 for IPv4 or 0::/0 for IPv6. "
  1186. ::= { docsMcastCpeListEntry 5 }
  1187. docsMcastCpeListSrcPrefixLen OBJECT-TYPE
  1188. SYNTAX InetAddressPrefixLength
  1189. MAX-ACCESS not-accessible
  1190. STATUS current
  1191. DESCRIPTION
  1192. "This attribute defines the source address prefix length
  1193. of a particular (S,G) IP multicast session."
  1194. ::= { docsMcastCpeListEntry 6 }
  1195. docsMcastCpeListCmMacAddr OBJECT-TYPE
  1196. SYNTAX MacAddress
  1197. MAX-ACCESS not-accessible
  1198. STATUS current
  1199. DESCRIPTION
  1200. "This attribute defines the CM MAC address of a particular
  1201. (S,G) IP multicast session."
  1202. ::= { docsMcastCpeListEntry 7 }
  1203. docsMcastCpeListDsid OBJECT-TYPE
  1204. SYNTAX Dsid
  1205. MAX-ACCESS read-only
  1206. STATUS current
  1207. DESCRIPTION
  1208. "This attribute defines the Downstream Service ID (DSID) label
  1209. with which the CMTS labels all packets of a particular (S,G)
  1210. IP multicast session."
  1211. ::= { docsMcastCpeListEntry 8 }
  1212. docsMcastCpeListCpeMacAddr OBJECT-TYPE
  1213. SYNTAX MacAddress
  1214. MAX-ACCESS read-only
  1215. STATUS current
  1216. DESCRIPTION
  1217. "This attribute returns the CPE MAC address for the (S,G)
  1218. IP multicast session."
  1219. ::= { docsMcastCpeListEntry 9 }
  1220. docsMcastCpeListCpeIpAddrType OBJECT-TYPE
  1221. SYNTAX InetAddressType
  1222. MAX-ACCESS read-only
  1223. STATUS current
  1224. DESCRIPTION
  1225. "This attribute indicates the address family of the address
  1226. contained in docsMcastCpeListCpeIpAddr."
  1227. ::= { docsMcastCpeListEntry 10 }
  1228. docsMcastCpeListCpeIpAddr OBJECT-TYPE
  1229. SYNTAX InetAddress
  1230. MAX-ACCESS read-only
  1231. STATUS current
  1232. DESCRIPTION
  1233. "This attribute returns the CPE IP address for the (S,G)
  1234. IP multicast session."
  1235. ::= { docsMcastCpeListEntry 11 }
  1236. docsMcastBandwidthTable OBJECT-TYPE
  1237. SYNTAX SEQUENCE OF DocsMcastBandwidthEntry
  1238. MAX-ACCESS not-accessible
  1239. STATUS current
  1240. DESCRIPTION
  1241. "The table contains the admitted aggregate bandwidth of IP
  1242. Multicast sessions onto the different Downstream Channel
  1243. Sets or MAC Domain Interfaces of a CMTS."
  1244. ::= { docsMcastMibObjects 10 }
  1245. docsMcastBandwidthEntry OBJECT-TYPE
  1246. SYNTAX DocsMcastBandwidthEntry
  1247. MAX-ACCESS not-accessible
  1248. STATUS current
  1249. DESCRIPTION
  1250. "The conceptual row of docsMcastBandwidthTable.
  1251. The ifIndex key corresponds to the MAC Domain interface
  1252. or DCS associated with the bandwidth data.
  1253. Note that for some vendors this CMTS cable interface will be a
  1254. cable-mac interface. For others, it will be a DOCSIS Downstream
  1255. Channel Set. In either case, this CMTS cable interface exists as
  1256. a row entry in the ifTable (and therefore has an ifIndex which can
  1257. be used as an index for this table)."
  1258. INDEX {
  1259. ifIndex
  1260. }
  1261. ::= { docsMcastBandwidthTable 1 }
  1262. DocsMcastBandwidthEntry ::= SEQUENCE {
  1263. docsMcastBandwidthAdmittedAggrBW CounterBasedGauge64,
  1264. docsMcastBandwidthAdmittedAggrLowWater CounterBasedGauge64,
  1265. docsMcastBandwidthAdmittedAggrHighWater CounterBasedGauge64
  1266. }
  1267. docsMcastBandwidthAdmittedAggrBW OBJECT-TYPE
  1268. SYNTAX CounterBasedGauge64
  1269. MAX-ACCESS read-only
  1270. STATUS current
  1271. DESCRIPTION
  1272. "This attribute represents the Admitted Multicast Aggregate
  1273. Bandwidth which is defined as the sum of the Minimum Reserved
  1274. Traffic Rates of each Group Service Flow that has been admitted
  1275. on a given CMTS cable interface."
  1276. ::= { docsMcastBandwidthEntry 1 }
  1277. docsMcastBandwidthAdmittedAggrLowWater OBJECT-TYPE
  1278. SYNTAX CounterBasedGauge64
  1279. MAX-ACCESS read-only
  1280. STATUS current
  1281. DESCRIPTION
  1282. "This attribute represents the low watermark threshold for
  1283. Admitted Multicast Aggregate Bandwidth events."
  1284. ::= { docsMcastBandwidthEntry 2 }
  1285. docsMcastBandwidthAdmittedAggrHighWater OBJECT-TYPE
  1286. SYNTAX CounterBasedGauge64
  1287. MAX-ACCESS read-only
  1288. STATUS current
  1289. DESCRIPTION
  1290. "This attribute represents the high watermark threshold for
  1291. Admitted Multicast Aggregate Bandwidth events."
  1292. ::= { docsMcastBandwidthEntry 3 }
  1293. -- Conformance Definitions
  1294. docsMcastMibConformance OBJECT IDENTIFIER ::= { docsMcastMib 2 }
  1295. docsMcastMibCompliances OBJECT IDENTIFIER
  1296. ::= { docsMcastMibConformance 1 }
  1297. docsMcastMibGroups OBJECT IDENTIFIER
  1298. ::= { docsMcastMibConformance 2 }
  1299. docsMcastCompliance MODULE-COMPLIANCE
  1300. STATUS current
  1301. DESCRIPTION
  1302. "The compliance statement for devices that implement the DOCSIS
  1303. Multicast MIB."
  1304. MODULE -- this MODULE
  1305. MANDATORY-GROUPS {
  1306. docsMcastGroup
  1307. }
  1308. ::= { docsMcastMibCompliances 1 }
  1309. docsMcastGroup OBJECT-GROUP
  1310. OBJECTS {
  1311. docsMcastCmtsReplSessDsid,
  1312. docsMcastCmtsReplSessSaid,
  1313. docsMcastDefGrpSvcClassDef,
  1314. docsMcastDsidPhsPhsField,
  1315. docsMcastDsidPhsPhsMask,
  1316. docsMcastDsidPhsPhsSize,
  1317. docsMcastDsidPhsPhsVerify,
  1318. docsMcastCmtsGrpCfgRulePriority,
  1319. docsMcastCmtsGrpCfgPrefixAddrType,
  1320. docsMcastCmtsGrpCfgSrcPrefixAddr,
  1321. docsMcastCmtsGrpCfgSrcPrefixLen,
  1322. docsMcastCmtsGrpCfgGrpPrefixAddr,
  1323. docsMcastCmtsGrpCfgGrpPrefixLen,
  1324. docsMcastCmtsGrpCfgTosLow,
  1325. docsMcastCmtsGrpCfgTosHigh,
  1326. docsMcastCmtsGrpCfgTosMask,
  1327. docsMcastCmtsGrpCfgQosConfigId,
  1328. docsMcastCmtsGrpCfgEncryptConfigId,
  1329. docsMcastCmtsGrpCfgPhsConfigId,
  1330. docsMcastCmtsGrpCfgRowStatus,
  1331. docsMcastCmtsGrpQosCfgServiceClassName,
  1332. docsMcastCmtsGrpQosCfgQosCtrl,
  1333. docsMcastCmtsGrpQosCfgAggSessLimit,
  1334. docsMcastCmtsGrpQosCfgAppId,
  1335. docsMcastCmtsGrpQosCfgRowStatus,
  1336. docsMcastCmtsGrpEncryptCfgCtrl,
  1337. docsMcastCmtsGrpEncryptCfgAlg,
  1338. docsMcastCmtsGrpEncryptCfgRowStatus,
  1339. docsMcastCmtsGrpPhsCfgPhsField,
  1340. docsMcastCmtsGrpPhsCfgPhsMask,
  1341. docsMcastCmtsGrpPhsCfgPhsSize,
  1342. docsMcastCmtsGrpPhsCfgPhsVerify,
  1343. docsMcastCmtsGrpPhsCfgRowStatus,
  1344. docsMcastStatsDroppedPkts,
  1345. docsMcastStatsDroppedOctets,
  1346. docsMcastCpeListDsid,
  1347. docsMcastCpeListCpeMacAddr,
  1348. docsMcastCpeListCpeIpAddrType,
  1349. docsMcastCpeListCpeIpAddr,
  1350. docsMcastBandwidthAdmittedAggrBW,
  1351. docsMcastBandwidthAdmittedAggrLowWater,
  1352. docsMcastBandwidthAdmittedAggrHighWater
  1353. }
  1354. STATUS current
  1355. DESCRIPTION
  1356. "Group of objects implemented in the CMTS."
  1357. ::= { docsMcastMibGroups 1 }
  1358. END