Home/Catalog/CISCO-COMMON-ROLES-MIB

CISCO-COMMON-ROLES-MIB

AI MIB Summary

The CISCO-COMMON-ROLES-MIB manages the vendor-neutral definition of user access roles and their associated permission rules (operations on features) to synchronize access control between CLI privilege levels and SNMP View-based Access Control (VACM) groups on Cisco devices. It provides a unified framework for mapping role-based access rights across multiple management interfaces, ensuring consistent enforcement of command and data visibility regardless of the access method used.

MIB module for managing the common roles between access methods like Command Line Interface (CLI), SNMP and XML interfaces. Every user on a device is associated with a role. A user role defines access rights afforded to the users that belog to this role. A role specifies which commands/operations a user is able to perform on what information. SNMP uses VACM (View-based Access Control Model) group to define access rights. Both SNMPv1/v2c community and SNMPv3 user have to belong to a group in order to access information. CLI uses proprietary mechanisms to define the access rights. Most of them depend on the underlying operating system. Groups created from SNMP are not same as the roles created from CLI unless they are synchronized. In addition to this, views make up the roles in VACM where was some kind of internal rules make the roles in the CLI. This MIB describes a framework in which a role defined independent of access methods. It is up to the the particular access method to convert this framework information into the native information. For example, SNMP needs to convert common role framework to VACM. Note that this framework could be also used for any other access methods other than SNMP and CLI. The framework needs a list of features and list of operations they can support. Features provide the data context and are system dependent. Operations are the actions that can be done on the data. The role are defined in terms of rules. Rules are essentially access rights which specify if a certain operation on a feature is permitted or not. An extension to this MIB module has been defined in CISCO-COMMON-ROLES-EXT-MIB to provide support for a framework which has compound features, i.e., features defined as group of other features, and also to provide another option for how a user's access can be restricted.
Main OID:
ciscoCommonRolesMIB.1.3.6.1.4.1.9.9.361
35
Objects
Active
Status
5
Dependencies

Imported Objects

Objects

35 total
Object Name
ciscoCommonRolesMIBMIB module for managing the common roles between access methods like Command Line Interface (CLI), SNMP and XML interfaces. Every user on a device is associated with a role. A user role defines access rights afforded to the users that belog to this role. A role specifies which commands/operations a user is able to perform on what information. SNMP uses VACM (View-based Access Control Model) group to define access rights. Both SNMPv1/v2c community and SNMPv3 user have to belong to a group in order to access information. CLI uses proprietary mechanisms to define the access rights. Most of them depend on the underlying operating system. Groups created from SNMP are not same as the roles created from CLI unless they are synchronized. In addition to this, views make up the roles in VACM where was some kind of internal rules make the roles in the CLI. This MIB describes a framework in which a role defined independent of access methods. It is up to the the particular access method to convert this framework information into the native information. For example, SNMP needs to convert common role framework to VACM. Note that this framework could be also used for any other access methods other than SNMP and CLI. The framework needs a list of features and list of operations they can support. Features provide the data context and are system dependent. Operations are the actions that can be done on the data. The role are defined in terms of rules. Rules are essentially access rights which specify if a certain operation on a feature is permitted or not. An extension to this MIB module has been defined in CISCO-COMMON-ROLES-EXT-MIB to provide support for a framework which has compound features, i.e., features defined as group of other features, and also to provide another option for how a user's access can be restricted.
MODULE-IDENTITY
.1.3.6.1.4.1.9.9.361
ciscoCommonRolesNotifications
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.0
ciscoCommonRolesMIBObjects
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.1
ccrInfo
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.1.1
commonRoleFeatureTableThis table lists all the features and the operations supported by the features on the system.
SEQUENCE OF CommonRoleFeatureEntry
.1.3.6.1.4.1.9.9.361.1.1.1
commonRoleFeatureEntryAn entry (conceptual row) in the commonRoleFeatureTable containing information about features and the operations supported by each of the features.
CommonRoleFeatureEntry
.1.3.6.1.4.1.9.9.361.1.1.1.1
commonRoleFeatureIndexAn arbitrary index for this entry.
Unsigned32 (1..4294967295 )
.1.3.6.1.4.1.9.9.361.1.1.1.1.1
commonRoleFeatureNameName of the feature. For example, strings like 'ip', 'snmp-server' and 'vsan' are valid feature names.ro
SnmpAdminString
.1.3.6.1.4.1.9.9.361.1.1.1.1.2
commonRoleFeatureOperationThe operation associated with this feature.ro
CommonRoleOperation
.1.3.6.1.4.1.9.9.361.1.1.1.1.3
commonRoleSupportedOperTableThis table lists all the access methods supported on device and the operations supported by each of the access methods. The operations listed in CommonRoleOperation may not be supported by all the access methods. For example, suppose that in the future, a new operation 'create' is added to CommonRoleOperation. CLI may not support it; but may be supported by XML. So this operation would not apply to CLI. This table captures the supported operations for each of the access methods.
SEQUENCE OF CommonRoleSupportedOperEntry
.1.3.6.1.4.1.9.9.361.1.1.2
commonRoleSupportedOperEntryAn entry (conceptual row) in the commonRoleSupportedOperTable which lists the operations supported by the local device for a particular access method.
CommonRoleSupportedOperEntry
.1.3.6.1.4.1.9.9.361.1.1.2.1
commonRoleAccessMethodAccess method supported on this system.
Enumeration
.1.3.6.1.4.1.9.9.361.1.1.2.1.1
commonRoleSupportedOperationOperations supported by the access method. clear - Clear operation config - Config/Set operation debug - Debug operation show - Show/Get operation exec - Exec/Set Operation read - Read operation readWrite - Read/Write operation .ro
Bits
.1.3.6.1.4.1.9.9.361.1.1.2.1.2
ccrRoleConfig
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.1.2
commonRoleMaxRolesMaximum number of common roles that can be configured this device. i.e., the maximum number of entries in the commonRoleTable.ro
Unsigned32 (1..65535 )
.1.3.6.1.4.1.9.9.361.1.2.1
commonRoleTableThis table lists all the common roles configured on this device.Common roles are the user roles which are common across SNMP and CLI.
SEQUENCE OF CommonRoleEntry
.1.3.6.1.4.1.9.9.361.1.2.2
commonRoleEntryAn entry (conceptual row) in the commonRoleTable.
CommonRoleEntry
.1.3.6.1.4.1.9.9.361.1.2.2.1
commonRoleNameName of the common role.
SnmpAdminString
.1.3.6.1.4.1.9.9.361.1.2.2.1.1
commonRoleDescriptionDescription of the common role.rw
SnmpAdminString
.1.3.6.1.4.1.9.9.361.1.2.2.1.2
commonRoleScopeRestrictionThis object indicates if there is a scope restriction for this role. If the value of this object is 'none', then there no scope restriction. If it is 'vsan', the two objects commonRoleScope1 and commonRoleScope2 provide the list of Virtual Storage Area Networks (VSANs) which this role can access. The object commonRoleScope1 provides list of VSANs from 0 through 2047 and commonRoleScope2 provides from 2048 through 4095. Each octet within the value of the the two objects specifies a set of eight VSANs. The first octet specifies VSANs 0 through 7 for commonRoleScope1 and VSANs 2048 through 2054 for commonRoleScope2. Similarly, the second octet specifies VSANs 8 through 15 and VSANs 2055 through 2062 for commonRoleScope2, etc. Within each octet, the most significant bit represents the lowest numbered VSAN, and the least significant bit represents the highest numbered VSAN. Thus, each VSAN, is represented by a single bit within the value of this object. A role can access a VSAN if and only if that bit has a value of '1'. If these objects have a value which are less than 256 bytes long, then the VSANs which are not represented are not considered to be in these list. If both the scope objects are zero-length strings, then this role can not access any VSANs if this object is `vsan'. The role can access all the VSANs if the this object is 'none'. Also, both commonRoleScope1 and commonRoleScope2 are invalid if this object is 'none'. Other means of restricting the scope of a role can be defined in the future by extending this object with additional enumerations. Each such addition will define the restriction and any parameters it might have, which might or might not be specified via the corresponding values of commonRoleScope1 and commonRoleScope2.rw
Enumeration
.1.3.6.1.4.1.9.9.361.1.2.2.1.3
commonRoleScope1This object provides the scope for the role. The actual meaning of this object depends the value of commonRoleScopeRestriction and is defined in that object.rw
OCTET STRING
.1.3.6.1.4.1.9.9.361.1.2.2.1.4
commonRoleScope2This object provides the scope for the role. The actual meaning of this object depends the value of commonRoleScopeRestriction and is defined in that object.rw
OCTET STRING
.1.3.6.1.4.1.9.9.361.1.2.2.1.5
commonRoleRowStatusStatus of this role.rw
RowStatus (SNMPv2-TC)
.1.3.6.1.4.1.9.9.361.1.2.2.1.6
ccrRuleConfig
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.1.3
commonRoleMaxRulesPerRoleMaximum number of rules that can be configured for a role.ro
Unsigned32 (1..65535 )
.1.3.6.1.4.1.9.9.361.1.3.1
commonRoleRuleTableThis table lists all the rules configured for roles defined in the commonRoleTable. Each rule defines a feature and related access-level which provides either permit or deny access to the feature information. Entries in this table are also created/deleted using commonRoleRuleRowStatus. A row in this table cannot be made 'active' until a value is explicitly provided for that row's instances of following objects : - commonRoleRuleOperation Also, the following objects cannot be modified when 'commonRoleRuleRowStatus' is 'active' : - commonRoleRuleFeatureName - commonRoleRuleOperation - commonRoleRuleOperPermitted To modify the above objects, the entry must be deleted and re-created with new value of above objects.
SEQUENCE OF CommonRoleRuleEntry
.1.3.6.1.4.1.9.9.361.1.3.2
commonRoleRuleEntryAn entry (conceptual row) in the commonRoleRuleTable.
CommonRoleRuleEntry
.1.3.6.1.4.1.9.9.361.1.3.2.1
commonRoleRuleIndexA sequential number starting from 1, and less than or equal to commonRoleMaxRulesPerRole, which identifies a rule.
Unsigned32 (1..4294967295 )
.1.3.6.1.4.1.9.9.361.1.3.2.1.1
commonRoleRuleFeatureNameName of the feature. If this is a zero-length string, then this rule applies to all the features supported on the system as enumerated in commonRoleFeatureTable.rw
SnmpAdminString
.1.3.6.1.4.1.9.9.361.1.3.2.1.2
commonRoleRuleOperationThe operation permitted for this rule.rw
CommonRoleOperation
.1.3.6.1.4.1.9.9.361.1.3.2.1.3
commonRoleRuleOperPermittedThis object tells if the operation `commonRoleRuleOperation' is permitted on the feature `commonRoleFeatureName'. The operation is permitted if the value of this object is `true'. If the value of the object is 'false', the operation is not permitted.rw
TruthValue (SNMPv2-TC)
.1.3.6.1.4.1.9.9.361.1.3.2.1.4
commonRoleRuleRowStatusStatus of this rule.rw
RowStatus (SNMPv2-TC)
.1.3.6.1.4.1.9.9.361.1.3.2.1.5
ciscoCommonRolesMIBConformance
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.2
ciscoCommonRolesMIBCompliances
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.2.1
ciscoCommonRolesMIBGroups
OBJECT IDENTIFIER
.1.3.6.1.4.1.9.9.361.2.2
CISCO-COMMON-ROLES-MIB - SNMP MIB Reference | MIBs Explorer