DOCS-MCAST-AUTH-MIB
AI MIB Summary
The DOCS-MCAST-AUTH-MIB provides management objects for Cable Modem Termination Systems (CMTS) to monitor and control the authorization state of DOCSIS multicast sessions, specifically tracking active group memberships and access control policies for IP multicast traffic.
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.
Main OID:
docsMcastAuthMib.1.3.6.1.4.1.4491.2.1.19
43
Objects
Active
Status
8
Dependencies
Imported Objects
Objects
43 total| Object Name |
|---|
docsMcastAuthMibThis 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 .1.3.6.1.4.1.4491.2.1.19 |
docsMcastAuthMibObjects OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.19.1 |
docsMcastAuthCtrl OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.19.1.1 |
docsMcastAuthCtrlEnableThis 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'.rw Enumeration .1.3.6.1.4.1.4491.2.1.19.1.1.1 |
docsMcastAuthCtrlDefProfileNameListWhen 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.rw SnmpTagList (SNMP-TARGET-MIB) .1.3.6.1.4.1.4491.2.1.19.1.1.2 |
docsMcastAuthCtrlDefActionThis attribute defines the default authorization
action when no IP Multicast Session Rule is determined
to match a client's IP multicast join request.rw Enumeration .1.3.6.1.4.1.4491.2.1.19.1.1.3 |
docsMcastAuthCtrlDefMaxNumSessThis 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.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.1.4 |
docsMcastAuthCmtsCmStatusTableThis 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. SEQUENCE OF DocsMcastAuthCmtsCmStatusEntry .1.3.6.1.4.1.4491.2.1.19.1.2 |
docsMcastAuthCmtsCmStatusEntryThe conceptual row of docsMcastAuthCmtsCmStatus. DocsMcastAuthCmtsCmStatusEntry .1.3.6.1.4.1.4491.2.1.19.1.2.1 |
docsMcastAuthCmtsCmStatusCfgProfileNameListThis 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.ro SnmpTagList (SNMP-TARGET-MIB) .1.3.6.1.4.1.4491.2.1.19.1.2.1.1 |
docsMcastAuthCmtsCmStatusCfgListIdThis 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.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.2.1.2 |
docsMcastAuthCmtsCmStatusMaxNumSessThis 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.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.2.1.3 |
docsMcastAuthCmtsCmStatusCfgParamFlagThis 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.ro Bits .1.3.6.1.4.1.4491.2.1.19.1.2.1.4 |
docsMcastAuthProfileSessRuleTableThis 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. SEQUENCE OF DocsMcastAuthProfileSessRuleEntry .1.3.6.1.4.1.4491.2.1.19.1.3 |
docsMcastAuthProfileSessRuleEntryThe conceptual row of docsMcastAuthProfileSessRule.
The CMTS persists all instances of the ProfileSessRule
object across reinitializations. DocsMcastAuthProfileSessRuleEntry .1.3.6.1.4.1.4491.2.1.19.1.3.1 |
docsMcastAuthProfileSessRuleIdThis attribute provides a unique identifier for each
CMTS configured Multicast Authorization Profile
Session rule within a Multicast Authorization Profile
Name. Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.3.1.1 |
docsMcastAuthProfileSessRulePriorityThis 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.rw Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.3.1.2 |
docsMcastAuthProfileSessRulePrefixAddrTypeThis attribute identifies the address family for
the multicast session (S,G) which corresponds to the
SrcPrefixAddr and GrpPrefixAddr attributes respectively.rw InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.3.1.3 |
docsMcastAuthProfileSessRuleSrcPrefixAddrThis 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.rw InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.3.1.4 |
docsMcastAuthProfileSessRuleSrcPrefixLenThis 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.rw InetAddressPrefixLength (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.3.1.5 |
docsMcastAuthProfileSessRuleGrpPrefixAddrThis attribute identifies the prefix of a range of
destination IP multicast group addresses.rw InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.3.1.6 |
docsMcastAuthProfileSessRuleGrpPrefixLenThis attribute identifies the prefix of a range of
IP multicast group addresses.rw InetAddressPrefixLength (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.3.1.7 |
docsMcastAuthProfileSessRuleActionThis 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.rw Enumeration .1.3.6.1.4.1.4491.2.1.19.1.3.1.8 |
docsMcastAuthProfileSessRuleRowStatusThe status of this instance.rw RowStatus (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.19.1.3.1.9 |
docsMcastAuthStaticSessRuleTableThis 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. SEQUENCE OF DocsMcastAuthStaticSessRuleEntry .1.3.6.1.4.1.4491.2.1.19.1.4 |
docsMcastAuthStaticSessRuleEntryThe conceptual row of docsMcastAuthStaticSessRule.
The CMTS may persist all instances of the StaticSessRule
object across reinitializations. DocsMcastAuthStaticSessRuleEntry .1.3.6.1.4.1.4491.2.1.19.1.4.1 |
docsMcastAuthStaticSessRuleCfgListIdThis attribute contains a CMTS-derived value for
a set of multicast static session rules associated to
one or more CMs. Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.4.1.1 |
docsMcastAuthStaticSessRuleIdThis 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. Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.4.1.2 |
docsMcastAuthStaticSessRulePriorityThis 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.ro Unsigned32 .1.3.6.1.4.1.4491.2.1.19.1.4.1.3 |
docsMcastAuthStaticSessRulePrefixAddrTypeThis attribute identifies the address family for
the multicast session (S,G) which corresponds to the
SrcPrefixAddr and GrpPrefixAddr attributes respectively.ro InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.4.1.4 |
docsMcastAuthStaticSessRuleSrcPrefixAddrThis 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.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.4.1.5 |
docsMcastAuthStaticSessRuleSrcPrefixLenThis attribute identifies the prefix of a range of
Source (S) IP multicast group addresses. For ASM-based
sessions, this attribute is set to 0.ro InetAddressPrefixLength (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.4.1.6 |
docsMcastAuthStaticSessRuleGrpPrefixAddrThis attribute identifies the prefix of a range of
destination IP multicast group addresses.ro InetAddress (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.4.1.7 |
docsMcastAuthStaticSessRuleGrpPrefixLenThis attribute identifies the prefix of a range of
IP multicast group addresses.ro InetAddressPrefixLength (INET-ADDRESS-MIB) .1.3.6.1.4.1.4491.2.1.19.1.4.1.8 |
docsMcastAuthStaticSessRuleActionThis 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.ro Enumeration .1.3.6.1.4.1.4491.2.1.19.1.4.1.9 |
docsMcastAuthProfilesTableThis 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. SEQUENCE OF DocsMcastAuthProfilesEntry .1.3.6.1.4.1.4491.2.1.19.1.5 |
docsMcastAuthProfilesEntryThe conceptual row of docsMcastAuthProfiles.
The CMTS persists all instances of the Profiles
object across reinitializations DocsMcastAuthProfilesEntry .1.3.6.1.4.1.4491.2.1.19.1.5.1 |
docsMcastAuthProfilesNameThis attribute is a unique name or identifier for a
Multicast Authorization Profile. SnmpAdminString .1.3.6.1.4.1.4491.2.1.19.1.5.1.1 |
docsMcastAuthProfilesDescriptionThis attribute is a human readable description of
the Multicast Authorization Profile.rw SnmpAdminString (SNMP-FRAMEWORK-MIB) .1.3.6.1.4.1.4491.2.1.19.1.5.1.2 |
docsMcastAuthProfilesRowStatusThe status of this instance.rw RowStatus (SNMPv2-TC) .1.3.6.1.4.1.4491.2.1.19.1.5.1.3 |
docsMcastAuthMibConformance OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.19.2 |
docsMcastAuthMibCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.19.2.1 |
docsMcastAuthMibGroups OBJECT IDENTIFIER .1.3.6.1.4.1.4491.2.1.19.2.2 |