DOCS-MCAST-AUTH-MIB
- Registered at
- 1.3.6.1.4.1.4491.2.1.19
- Last updated
- 2024-07-05 00:00
- Organization
- Cable Television Laboratories, Inc.
- Revisions
- 2024-07-05 00:00, 2023-11-22 00:00, 2023-06-01 00:00, 2007-12-06 00:00, 2006-12-07 17:00
- Namespace
- standard
- Source file
DOCS-MCAST-AUTH-MIB- Digest
sha256:afbc7df5f7414d0071bb842a50cab0bc4dc2433f1cc4cb969e647ff89cfce362
Description
This MIB module contains the management objects for the management of the CMTS Multicast Authorization Module. Copyright 1999-2024 Cable Television Laboratories, Inc. All rights reserved.
Contact
Postal: Cable Television Laboratories, Inc. 858 Coal Creek Circle Louisville, Colorado 80027-9750 U.S.A. Phone: +1 303-661-9100 Fax: +1 303-661-9199 E-mail: mibs@cablelabs.com
Imports
| From | Symbols |
|---|---|
| CLAB-DEF-MIB | clabProjDocsis |
| DOCS-IF3-MIB | docsIf3CmtsCmRegStatusId |
| INET-ADDRESS-MIB | InetAddress, InetAddressPrefixLength, InetAddressType |
| SNMP-FRAMEWORK-MIB | SnmpAdminString |
| SNMP-TARGET-MIB | SnmpTagList |
| SNMPv2-CONF | MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUP |
| SNMPv2-SMI | MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, Unsigned32, iso |
| SNMPv2-TC | DisplayString, RowStatus, TEXTUAL-CONVENTION |
Imported by
Nothing in this corpus imports this module.
Load order
Every file a consumer needs in order to load this module, dependencies first.
CLAB-DEF-MIB DIFFSERV-DSCP-TC DIFFSERV-MIB DOCS-CABLE-DEVICE-MIB DOCS-IETF-BPI2-MIB DOCS-IF-MIB DOCS-IF3-MIB DOCS-MCAST-AUTH-MIB IANAifType-MIB IF-MIB INET-ADDRESS-MIB INTEGRATED-SERVICES-MIB RFC1158-MIB RFC1271-MIB RMON-MIB RMON2-MIB SNMP-FRAMEWORK-MIB SNMP-TARGET-MIB SNMPv2-CONF SNMPv2-MIB SNMPv2-SMI SNMPv2-TC TOKEN-RING-RMON-MIB
Objects
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| docsMcastAuthMibObjects OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.19.1 | |||
| docsMcastAuthCtrl OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.19.1.1 | |||
| docsMcastAuthCtrlEnable OBJECT-TYPE 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'. | 1.3.6.1.4.1.4491.2.1.19.1.1.1 | INTEGER {other(0), enable(1), disable(2)} | read-write | current |
| docsMcastAuthCtrlDefProfileNameList OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.1.2 | SnmpTagList | read-write | current |
| docsMcastAuthCtrlDefAction OBJECT-TYPE This attribute defines the default authorization action when no IP Multicast Session Rule is determined to match a client's IP multicast join request. | 1.3.6.1.4.1.4491.2.1.19.1.1.3 | INTEGER {permit(1), deny(2)} | read-write | current |
| docsMcastAuthCtrlDefMaxNumSess OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.1.4 | Unsigned32 (0..65535) | read-write | current |
| docsMcastAuthCmtsCmStatusTable OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.2 | not-accessible | current | |
| docsMcastAuthCmtsCmStatusEntry OBJECT-TYPE The conceptual row of docsMcastAuthCmtsCmStatus. | 1.3.6.1.4.1.4491.2.1.19.1.2.1 | not-accessible | current | |
| docsMcastAuthCmtsCmStatusCfgProfileNameList OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.2.1.1 | SnmpTagList | read-only | current |
| docsMcastAuthCmtsCmStatusCfgListId OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.2.1.2 | Unsigned32 | read-only | current |
| docsMcastAuthCmtsCmStatusMaxNumSess OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.2.1.3 | Unsigned32 (0..65535) | read-only | current |
| docsMcastAuthCmtsCmStatusCfgParamFlag OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.2.1.4 | Bits {profile(0), staticMulticast(1), maxNumSessions(2)} | read-only | current |
| docsMcastAuthProfileSessRuleTable OBJECT-TYPE This table defines Operator configured profiles to be matched during the authorization process. This table supports the creation and deletion of multiple instances. Creation of a new entry in this table requires the following attributes to be set: docsMcastAuthProfileSessRuleSrcPrefixAddr docsMcastAuthProfileSessRulePrefixAddrType docsMcastAuthProfileSessRuleSrcPrefixLen docsMcastAuthProfileSessRuleGrpPrefixAddr docsMcastAuthProfileSessRuleGrpPrefixLen | 1.3.6.1.4.1.4491.2.1.19.1.3 | not-accessible | current | |
| docsMcastAuthProfileSessRuleEntry OBJECT-TYPE The conceptual row of docsMcastAuthProfileSessRule. The CMTS persists all instances of the ProfileSessRule object across reinitializations. | 1.3.6.1.4.1.4491.2.1.19.1.3.1 | not-accessible | current | |
| docsMcastAuthProfileSessRuleId OBJECT-TYPE This attribute provides a unique identifier for each CMTS configured Multicast Authorization Profile Session rule within a Multicast Authorization Profile Name. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.1 | Unsigned32 (1..4294967295) | not-accessible | current |
| docsMcastAuthProfileSessRulePriority OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.2 | Unsigned32 (0..255) | read-create | current |
| docsMcastAuthProfileSessRulePrefixAddrType OBJECT-TYPE This attribute identifies the address family (InetAddressType) for the multicast session (S,G) which corresponds to the docsMcastAuthProfileSessRuleSrcPrefixAddr and docsMcastAuthProfileSessRuleGrpPrefixAddr attributes respectively. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.3 | InetAddressType | read-create | current |
| docsMcastAuthProfileSessRuleSrcPrefixAddr OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.4 | InetAddress | read-create | current |
| docsMcastAuthProfileSessRuleSrcPrefixLen OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.5 | InetAddressPrefixLength | read-create | current |
| docsMcastAuthProfileSessRuleGrpPrefixAddr OBJECT-TYPE This attribute identifies the prefix of a range of destination IP multicast group addresses. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.6 | InetAddress | read-create | current |
| docsMcastAuthProfileSessRuleGrpPrefixLen OBJECT-TYPE This attribute identifies the prefix of a range of IP multicast group addresses. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.7 | InetAddressPrefixLength | read-create | current |
| docsMcastAuthProfileSessRuleAction OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.8 | INTEGER {accept(1), deny(2)} | read-create | current |
| docsMcastAuthProfileSessRuleRowStatus OBJECT-TYPE The status of this instance. | 1.3.6.1.4.1.4491.2.1.19.1.3.1.9 | RowStatus | read-create | current |
| docsMcastAuthStaticSessRuleTable OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.4 | not-accessible | current | |
| docsMcastAuthStaticSessRuleEntry OBJECT-TYPE The conceptual row of docsMcastAuthStaticSessRule. The CMTS may persist all instances of the StaticSessRule object across reinitializations. | 1.3.6.1.4.1.4491.2.1.19.1.4.1 | not-accessible | current | |
| docsMcastAuthStaticSessRuleCfgListId OBJECT-TYPE This attribute contains a CMTS-derived value for a set of multicast static session rules associated to one or more CMs. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.1 | Unsigned32 (1..4294967295) | not-accessible | current |
| docsMcastAuthStaticSessRuleId OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.2 | Unsigned32 (1..4294967295) | not-accessible | current |
| docsMcastAuthStaticSessRulePriority OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.3 | Unsigned32 (0..255) | read-only | current |
| docsMcastAuthStaticSessRulePrefixAddrType OBJECT-TYPE This attribute identifies the address family (InetAddressType) for the multicast session (S,G) which corresponds to the docsMcastAuthProfileSessRuleSrcPrefixAddr and docsMcastAuthProfileSessRuleGrpPrefixAddr attributes respectively. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.4 | InetAddressType | read-only | current |
| docsMcastAuthStaticSessRuleSrcPrefixAddr OBJECT-TYPE 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 Addresses are unicast host addresses. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.5 | InetAddress | read-only | current |
| docsMcastAuthStaticSessRuleSrcPrefixLen OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.6 | InetAddressPrefixLength | read-only | current |
| docsMcastAuthStaticSessRuleGrpPrefixAddr OBJECT-TYPE This attribute identifies the prefix of a range of destination IP multicast group addresses. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.7 | InetAddress | read-only | current |
| docsMcastAuthStaticSessRuleGrpPrefixLen OBJECT-TYPE This attribute identifies the prefix of a range of IP multicast group addresses. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.8 | InetAddressPrefixLength | read-only | current |
| docsMcastAuthStaticSessRuleAction OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.9 | INTEGER {permit(1), deny(2)} | read-only | current |
| docsMcastAuthStaticSessRuleSrcPrefixAddrType OBJECT-TYPE 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 Addresses are unicast host addresses. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.10 | InetAddressType | read-only | current |
| docsMcastAuthStaticSessRuleGrpPrefixAddrType OBJECT-TYPE This attribute identifies the prefix of a range of destination IP multicast group addresses. | 1.3.6.1.4.1.4491.2.1.19.1.4.1.11 | InetAddressType | read-only | current |
| docsMcastAuthProfilesTable OBJECT-TYPE 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. | 1.3.6.1.4.1.4491.2.1.19.1.5 | not-accessible | current | |
| docsMcastAuthProfilesEntry OBJECT-TYPE The conceptual row of docsMcastAuthProfiles. The CMTS persists all instances of the Profiles object across reinitializations | 1.3.6.1.4.1.4491.2.1.19.1.5.1 | not-accessible | current | |
| docsMcastAuthProfilesName OBJECT-TYPE This attribute is a unique name or identifier for a Multicast Authorization Profile. | 1.3.6.1.4.1.4491.2.1.19.1.5.1.1 | SnmpAdminString (SIZE(1..15)) | not-accessible | current |
| docsMcastAuthProfilesDescription OBJECT-TYPE This attribute is a human readable description of the Multicast Authorization Profile. | 1.3.6.1.4.1.4491.2.1.19.1.5.1.2 | SnmpAdminString | read-create | current |
| docsMcastAuthProfilesRowStatus OBJECT-TYPE The status of this instance. | 1.3.6.1.4.1.4491.2.1.19.1.5.1.3 | RowStatus | read-create | current |
| docsMcastAuthMibConformance OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.19.2 | |||
| docsMcastAuthMibCompliances OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.19.2.1 | |||
| docsMcastAuthMibGroups OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.19.2.2 |
Conformance
| Name | OID | Status |
|---|---|---|
| docsMcastAuthCompliance MODULE-COMPLIANCE The compliance statement for devices that implement the DOCSIS Multicast Authorization MIB. | 1.3.6.1.4.1.4491.2.1.19.2.1.1 | current |
| docsMcastAuthGroup OBJECT-GROUP Group of objects implemented in the CMTS. | 1.3.6.1.4.1.4491.2.1.19.2.2.1 | current |