DOCS-MCAST-AUTH-MIB

File: DOCS-MCAST-AUTH-MIB.mib (27558 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
SNMP-FRAMEWORK-MIB INET-ADDRESS-MIB SNMP-TARGET-MIB
DOCS-IF3-MIB CLAB-DEF-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
RowStatus OBJECT-GROUP MODULE-COMPLIANCE
SnmpAdminString InetAddressType InetAddress
InetAddressPrefixLength SnmpTagList docsIf3CmtsCmRegStatusId
clabProjDocsis

Defined Types

DocsMcastAuthCmtsCmStatusEntry  
SEQUENCE    
  docsMcastAuthCmtsCmStatusCfgProfileNameList SnmpTagList
  docsMcastAuthCmtsCmStatusCfgListId Unsigned32
  docsMcastAuthCmtsCmStatusMaxNumSess Unsigned32
  docsMcastAuthCmtsCmStatusCfgParamFlag BITS

DocsMcastAuthProfileSessRuleEntry  
SEQUENCE    
  docsMcastAuthProfileSessRuleId Unsigned32
  docsMcastAuthProfileSessRulePriority Unsigned32
  docsMcastAuthProfileSessRulePrefixAddrType InetAddressType
  docsMcastAuthProfileSessRuleSrcPrefixAddr InetAddress
  docsMcastAuthProfileSessRuleSrcPrefixLen InetAddressPrefixLength
  docsMcastAuthProfileSessRuleGrpPrefixAddr InetAddress
  docsMcastAuthProfileSessRuleGrpPrefixLen InetAddressPrefixLength
  docsMcastAuthProfileSessRuleAction INTEGER
  docsMcastAuthProfileSessRuleRowStatus RowStatus

DocsMcastAuthStaticSessRuleEntry  
SEQUENCE    
  docsMcastAuthStaticSessRuleCfgListId Unsigned32
  docsMcastAuthStaticSessRuleId Unsigned32
  docsMcastAuthStaticSessRulePriority Unsigned32
  docsMcastAuthStaticSessRulePrefixAddrType InetAddressType
  docsMcastAuthStaticSessRuleSrcPrefixAddr InetAddress
  docsMcastAuthStaticSessRuleSrcPrefixLen InetAddressPrefixLength
  docsMcastAuthStaticSessRuleGrpPrefixAddr InetAddress
  docsMcastAuthStaticSessRuleGrpPrefixLen InetAddressPrefixLength
  docsMcastAuthStaticSessRuleAction INTEGER

DocsMcastAuthProfilesEntry  
SEQUENCE    
  docsMcastAuthProfilesName SnmpAdminString
  docsMcastAuthProfilesDescription SnmpAdminString
  docsMcastAuthProfilesRowStatus RowStatus

Defined Values

docsMcastAuthMib 1.3.6.1.4.1.4491.2.1.19
This MIB module contains the management objects for the management of the CMTS Multicast Authorization Module. Copyright 1999-2007 Cable Television Laboratories, Inc. All rights reserved.
MODULE-IDENTITY    

docsMcastAuthMibObjects 1.3.6.1.4.1.4491.2.1.19.1
OBJECT IDENTIFIER    

docsMcastAuthCtrl 1.3.6.1.4.1.4491.2.1.19.1.1
OBJECT IDENTIFIER    

docsMcastAuthCtrlEnable 1.3.6.1.4.1.4491.2.1.19.1.1.1
This attribute enables the enforcement of Multicast Autorization feature. When this attribute is set to 'enable' Multicast Authorization is enforced; otherwise clients are permitted to join any IP multicast session. The factory default value of this attribute is 'disable'.
OBJECT-TYPE    
  INTEGER enable(1), disable(2)  

docsMcastAuthCtrlDefProfileNameList 1.3.6.1.4.1.4491.2.1.19.1.1.2
When IP Multicast Authorization is enforced, this attribute provides the default set of Multicast Authorization Profiles the CMTS enforces for a CM in the case that this CM didn't signal a set of profiles during the registration process. If the Default Multicast Authorization Group Name is zero length string, the DefAction attribute determines whether a join request is authorized when a CM registers without a Multicast Authorization Profile Set or a list of config File Session Rules. If the CMTS supports more than 1 profile name as a default, the CMTS enforces each of the profiles in order until the maximum number of profiles is reached. This attribute indicates one or more Multicast Authorization Profiles.
OBJECT-TYPE    
  SnmpTagList  

docsMcastAuthCtrlDefAction 1.3.6.1.4.1.4491.2.1.19.1.1.3
This attribute defines the default authorization action when no IP Multicast Session Rule is determined to match a client's IP multicast join request.
OBJECT-TYPE    
  INTEGER permit(1), deny(2)  

docsMcastAuthCtrlDefMaxNumSess 1.3.6.1.4.1.4491.2.1.19.1.1.4
This attribute indicates the default maximum number of multicast sessions that clients reached through a CM are allowed to join. If set to zero, the maximum number of sessions is not limited by the CMTS. A DefMaxNumSess value of 0 indicates that no dynamic joins are permitted.
OBJECT-TYPE    
  Unsigned32 0..65535  

docsMcastAuthCmtsCmStatusTable 1.3.6.1.4.1.4491.2.1.19.1.2
This object maintains per-CM status of Multicast Authorization policies to be applied to this CM. The CM acquires these policy parameters through the CM registration process, or in the absence of some or all of those parameters, from the Ctrl Object. This object is meaningful when the Control Enable attribute is set to 'enable'. In the process of authorizing a CM client's session request the CMTS must check rules defined in StaticSessRule object and then rules defined in ProfileSessRule object. In the case of multiple multicast session matches, the rule priority attribute defines the final selected session rule. The selection of a session rules when multiple matches have the same priority is vendor specific. The CMTS MAY report in the CmtsCmStatus object CMs that do not signal any IP Multicast Authorization Encodings in the registration process.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsMcastAuthCmtsCmStatusEntry

docsMcastAuthCmtsCmStatusEntry 1.3.6.1.4.1.4491.2.1.19.1.2.1
The conceptual row of docsMcastAuthCmtsCmStatus.
OBJECT-TYPE    
  DocsMcastAuthCmtsCmStatusEntry  

docsMcastAuthCmtsCmStatusCfgProfileNameList 1.3.6.1.4.1.4491.2.1.19.1.2.1.1
This attribute indicates the set of Profile Names associated with the CM. This attribute indicates the CM signaled 'IP Multicast Authorization Profile Name' encodings during the CM registration process, or in the absence of instances of that config file parameter, the DefProfileNameList attribute from the Ctrl object.
OBJECT-TYPE    
  SnmpTagList  

docsMcastAuthCmtsCmStatusCfgListId 1.3.6.1.4.1.4491.2.1.19.1.2.1.2
This attribute identifies the reference to a CMTS created Session Rule List based on the CM signaled 'IP Multicast Authorization Static Session Rule' encodings. The CMTS may reuse this attribute value to reference more than one CM that have signaled the same list of Session Rules to the CMTS. The value zero indicates that the CM did not signal Multicast Session Rules to the CMTS or the CMTS does not support the StaticSessRule, in which case, the CMTS ignores any CM signalled Session Rule endocings during registration.
OBJECT-TYPE    
  Unsigned32  

docsMcastAuthCmtsCmStatusMaxNumSess 1.3.6.1.4.1.4491.2.1.19.1.2.1.3
This attribute indicates the CM signaled value in Maximum Multicast Sessions Encoding during the CM registration process. If this value is missing the DefMaxNumSess attribute of the Ctrl object is used to determine the maximum number of multicast sessions this client may forward. The value 0 indicates that no dynamic joins are permitted. The value 65535 (the largest valid value) indicates that the CMTS permits any number of sessions to be joined by clients reached through the CM.
OBJECT-TYPE    
  Unsigned32 0..65535  

docsMcastAuthCmtsCmStatusCfgParamFlag 1.3.6.1.4.1.4491.2.1.19.1.2.1.4
This attribute represents the functions that are activated through the registration process. The bit 'profile' indicates whether the CM signaled 'IP Multicast Authorization Profile Name Subtype' encodings. The bit 'staticMulticast' indicates whether the CM signaled 'IP Multicast Authorization Static Session Rule Subtype' encodings. The bit 'maxNumSess' indicates whether the CM signaled the ' Maximum Multicast Sessions' encoding.
OBJECT-TYPE    
  BITS profile(0), staticMulticast(1), maxNumSessions(2)  

docsMcastAuthProfileSessRuleTable 1.3.6.1.4.1.4491.2.1.19.1.3
This object defines Operator configured profiles to be matched during the authorization process. This object supports the creation and deletion of multiple instances. Creation of a new instance of this object requires the following attributes to be set: PrefixAddrType SrcPrefixAddr SrcPrefixLen GrpPrefixAddr GrpPrefixLen.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsMcastAuthProfileSessRuleEntry

docsMcastAuthProfileSessRuleEntry 1.3.6.1.4.1.4491.2.1.19.1.3.1
The conceptual row of docsMcastAuthProfileSessRule. The CMTS persists all instances of the ProfileSessRule object across reinitializations.
OBJECT-TYPE    
  DocsMcastAuthProfileSessRuleEntry  

docsMcastAuthProfileSessRuleId 1.3.6.1.4.1.4491.2.1.19.1.3.1.1
This attribute provides a unique identifier for each CMTS configured Multicast Authorization Profile Session rule within a Multicast Authorization Profile Name.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsMcastAuthProfileSessRulePriority 1.3.6.1.4.1.4491.2.1.19.1.3.1.2
This attribute configures the rule priority for the static session rule. Permitted values for this attribute range from 0..255. Higher values indicate a higher priority. If more than one session rule matches a joined session, the session rule with the highest rule priority determines the authorization action.
OBJECT-TYPE    
  Unsigned32 0..255  

docsMcastAuthProfileSessRulePrefixAddrType 1.3.6.1.4.1.4491.2.1.19.1.3.1.3
This attribute identifies the address family for the multicast session (S,G) which corresponds to the SrcPrefixAddr and GrpPrefixAddr attributes respectively.
OBJECT-TYPE    
  InetAddressType  

docsMcastAuthProfileSessRuleSrcPrefixAddr 1.3.6.1.4.1.4491.2.1.19.1.3.1.4
This attribute identifies a specific Multicast Source Address defined for this rule. A Source Address that is all zeros is defined as 'all source addresses' (*, G). Source prefix addresses are unicast addresses.
OBJECT-TYPE    
  InetAddress  

docsMcastAuthProfileSessRuleSrcPrefixLen 1.3.6.1.4.1.4491.2.1.19.1.3.1.5
This attribute identifies the prefix of a range of Source (S) IP multicast group addresses. For Group or ASM based sessions this attribute is set to 0.
OBJECT-TYPE    
  InetAddressPrefixLength  

docsMcastAuthProfileSessRuleGrpPrefixAddr 1.3.6.1.4.1.4491.2.1.19.1.3.1.6
This attribute identifies the prefix of a range of destination IP multicast group addresses.
OBJECT-TYPE    
  InetAddress  

docsMcastAuthProfileSessRuleGrpPrefixLen 1.3.6.1.4.1.4491.2.1.19.1.3.1.7
This attribute identifies the prefix of a range of IP multicast group addresses.
OBJECT-TYPE    
  InetAddressPrefixLength  

docsMcastAuthProfileSessRuleAction 1.3.6.1.4.1.4491.2.1.19.1.3.1.8
This attribute specifies the authorization action for a session join attempt that matches the session rule. The value 'accept' indicates that the rule permits a matching multicast join request is allowed . The value 'deny' indicates that a matching multicast join request is denied.
OBJECT-TYPE    
  INTEGER accept(1), deny(2)  

docsMcastAuthProfileSessRuleRowStatus 1.3.6.1.4.1.4491.2.1.19.1.3.1.9
The status of this instance.
OBJECT-TYPE    
  RowStatus  

docsMcastAuthStaticSessRuleTable 1.3.6.1.4.1.4491.2.1.19.1.4
This object defines the Session authorization Rules based on the CM or group of CMs signaled in IP Multicast Join Authorization Static Session Subtype encoding This object reflects the Static Session rules that were included in the CM registration request message.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsMcastAuthStaticSessRuleEntry

docsMcastAuthStaticSessRuleEntry 1.3.6.1.4.1.4491.2.1.19.1.4.1
The conceptual row of docsMcastAuthStaticSessRule. The CMTS may persist all instances of the StaticSessRule object across reinitializations.
OBJECT-TYPE    
  DocsMcastAuthStaticSessRuleEntry  

docsMcastAuthStaticSessRuleCfgListId 1.3.6.1.4.1.4491.2.1.19.1.4.1.1
This attribute contains a CMTS-derived value for a set of multicast static session rules associated to one or more CMs.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsMcastAuthStaticSessRuleId 1.3.6.1.4.1.4491.2.1.19.1.4.1.2
This attribute provides an identifier for each Multicast Authorization Static Session rule in the IP Multicast Join Authorization Static Session SubType communicated by a CM or group of CMs during registration.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsMcastAuthStaticSessRulePriority 1.3.6.1.4.1.4491.2.1.19.1.4.1.3
This attribute defines the rule priority for the static session rule. Higher values indicate a higher priority. If more than one session rule matches a joined session, the session rule with the highest rule priority determines the authorization action.
OBJECT-TYPE    
  Unsigned32 0..255  

docsMcastAuthStaticSessRulePrefixAddrType 1.3.6.1.4.1.4491.2.1.19.1.4.1.4
This attribute identifies the address family for the multicast session (S,G) which corresponds to the SrcPrefixAddr and GrpPrefixAddr attributes respectively.
OBJECT-TYPE    
  InetAddressType  

docsMcastAuthStaticSessRuleSrcPrefixAddr 1.3.6.1.4.1.4491.2.1.19.1.4.1.5
This attribute identifies a specific Multicast Source Address defined for this rule. A Source Address that is all zeros is defined as 'all source addresses (*, G)'. Source Prefix Addresses are unicast host addresses.
OBJECT-TYPE    
  InetAddress  

docsMcastAuthStaticSessRuleSrcPrefixLen 1.3.6.1.4.1.4491.2.1.19.1.4.1.6
This attribute identifies the prefix of a range of Source (S) IP multicast group addresses. For ASM-based sessions, this attribute is set to 0.
OBJECT-TYPE    
  InetAddressPrefixLength  

docsMcastAuthStaticSessRuleGrpPrefixAddr 1.3.6.1.4.1.4491.2.1.19.1.4.1.7
This attribute identifies the prefix of a range of destination IP multicast group addresses.
OBJECT-TYPE    
  InetAddress  

docsMcastAuthStaticSessRuleGrpPrefixLen 1.3.6.1.4.1.4491.2.1.19.1.4.1.8
This attribute identifies the prefix of a range of IP multicast group addresses.
OBJECT-TYPE    
  InetAddressPrefixLength  

docsMcastAuthStaticSessRuleAction 1.3.6.1.4.1.4491.2.1.19.1.4.1.9
This attribute specifies the authorization action for a session join attempt that matches the session rule. The value 'accept' indicates that the rule permits a matching multicast join request is allowed. The value 'deny' indicates that a matching multicast join request is denied.
OBJECT-TYPE    
  INTEGER permit(1), deny(2)  

docsMcastAuthProfilesTable 1.3.6.1.4.1.4491.2.1.19.1.5
This object contains the description of the Multicast Authorization profiles for administrative purposes. This object supports the creation and deletion of multiple instances. Creation of a new instance of this object requires the Description attribute to be set.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsMcastAuthProfilesEntry

docsMcastAuthProfilesEntry 1.3.6.1.4.1.4491.2.1.19.1.5.1
The conceptual row of docsMcastAuthProfiles. The CMTS persists all instances of the Profiles object across reinitializations
OBJECT-TYPE    
  DocsMcastAuthProfilesEntry  

docsMcastAuthProfilesName 1.3.6.1.4.1.4491.2.1.19.1.5.1.1
This attribute is a unique name or identifier for a Multicast Authorization Profile.
OBJECT-TYPE    
  SnmpAdminString Size(1..15)  

docsMcastAuthProfilesDescription 1.3.6.1.4.1.4491.2.1.19.1.5.1.2
This attribute is a human readable description of the Multicast Authorization Profile.
OBJECT-TYPE    
  SnmpAdminString  

docsMcastAuthProfilesRowStatus 1.3.6.1.4.1.4491.2.1.19.1.5.1.3
The status of this instance.
OBJECT-TYPE    
  RowStatus  

docsMcastAuthMibConformance 1.3.6.1.4.1.4491.2.1.19.2
OBJECT IDENTIFIER    

docsMcastAuthMibCompliances 1.3.6.1.4.1.4491.2.1.19.2.1
OBJECT IDENTIFIER    

docsMcastAuthMibGroups 1.3.6.1.4.1.4491.2.1.19.2.2
OBJECT IDENTIFIER    

docsMcastAuthCompliance 1.3.6.1.4.1.4491.2.1.19.2.1.1
The compliance statement for devices that implement the DOCSIS Multicast Authorization MIB.
MODULE-COMPLIANCE    

docsMcastAuthGroup 1.3.6.1.4.1.4491.2.1.19.2.2.1
Group of objects implemented in the CMTS.
OBJECT-GROUP