The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Embedded Resource Manager (ERM)-MIB feature introduces MIB support for the ERM feature. The ERM feature tracks resource usage information for every registered resource owner and resource user. The ERM-MIB feature allows you to monitor the usage of resources by gathering resource usage information using MIB objects. The network manager can use the information collected by the ERM-MIB objects to ensure the optimal use of the resources.
Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for ERM-MIB" section.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
•Configuration Examples for ERM-MIB
•Feature Information for ERM-MIB
Simple Network Management Protocol (SNMP) must be enabled on the router before notifications (traps) can be configured or before SNMP GET operations can be performed.
The ERM-MIB feature introduces network management support for ERM through the use of ERM-MIB table entries, MIB objects, and MIB trap notification objects that are defined in CISCO-ERM-MIB.my.
To use the ERM-MIB feature, you should understand the following concepts:
•ERM Configuration MIB Objects
The ERM Show MIB objects are read-only objects. You can use these MIB objects to obtain information about resource owners, resource user type, resource users or groups, resource owner and resource user relationships, and resource monitors in the system.
Table 1 describes the ERM Show MIB objects.
You can use cermResOwnerTable to obtain information about all resource owners in the system. The index entries for cermResOwnerTable are entPhysicalIndex, cermResOwnerSubEntityId, and cermResOwnerId.
The cermResOwnerTable defines the following MIB objects:
•cermResOwnerSubEntityId
•cermResOwnerId
•cermResOwnerName
•cermResOwnerMeasurementUnit
•cermResOwnerThresholdIsConfigurable
•cermResOwnerResUserCount
•cermResOwnerResGroupCount
You can use cermResOwnerSubTypeTable to obtain sub-type specific information. The cermResOwnerSubTypeTable is an extension of the cermResOwnerTable. The index entries for cermResOwnerSubTypeTable are entPhysicalIndex, cermResOwnerSubEntityId, cermResOwnerId, and cermResOwnerSubTypeId.
Each resource owner will have one or more entries in this table. For example, the CPU resource owner has three sub-types: process, interrupt, and total.
Some resource owners may not have any sub-types, such as the IPC resource owner. In such cases this table will contain a single entry with cermResOwnerSubTypeId as 0 and cermResOwnerSubTypeName as an empty string.
You can obtain all sub-type related information specified in this table by querying the corresponding resource owner.
The cermResOwnerSubTypeTable defines the following objects:
•cermResOwnerSubTypeId
•cermResOwnerSubTypeName
•cermResOwnerSubTypeUsagePct
•cermResOwnerSubTypeUsage
•cermResOwnerSubTypeMaxUsage
•cermResOwnerSubTypeGlobNotifSeverity
You can use cermResOwnerSubTypeThresholdTable to obtain applied threshold details for each resource owner sub-type. This object is an extension of the cermResOwnerSubTypeTable.
The index entries for cermResOwnerSubTypeThresholdTable are entPhysicalIndex, cermResOwnerSubEntityId, cermResOwnerId, cermResOwnerSubTypeId, and cermResOwnerSubTypeThreshSeverity. You can obtain all threshold details corresponding to a resource owner sub-type by querying the corresponding resource owner.
The cermResOwnerSubTypeThresholdTable defines the following objects:
•cermResOwnerSubTypeThreshSeverity
•cermResOwnerSubTypeRisingThresh
•cermResOwnerSubTypeRisingInterval
•cermResOwnerSubTypeFallingThresh
•cermResOwnerSubTypeFallingInterval
You can use cermResUserTypeTable to obtain information about a resource user type. Each resource user type in the system has an entry in cermResUserTypeTable. The index entries for this object are entPhysicalIndex, cermResUserTypeSubEntityId, and cermResUserTypeId.
The cermResUserTypeTable defines the following objects:
•cermResUserTypeSubEntityId
•cermResUserTypeId
•cermResUserTypeName
•cermResUserTypeResOwnerCount
•cermResUserTypeResUserCount
•cermResUserTypeResGroupCount
You can use cermResUserTable to obtain information about each resource user in the system. This object is an extension of cermResUserTypeTable. The index entries for cermResUserTable are entPhysicalIndex, cermResUserTypeSubEntityId, cermResUserTypeId, and ermResUserId.
The cermResUserTable defines the following objects:
•cermResUserId
•cermResUserName
•cermResUserPriority
•cermResUserResGroupId
You can use cermResGroupTable to obtain information about every resource group available in the system. This object is an extension of cermResUserTypeTable. The index entries for cermResGroupTable are entPhysicalIndex, cermResUserTypeSubEntityId, cermResUserTypeId, and cermResGroupId.
The cermResGroupTable defines the following objects:
•cermResGroupId
•cermResGroupName
•cermResGroupUserInstanceCount
You can use cermResGroupResUserTable to obtain the list of resource users available in a particular resource group. This object is an extension of cermResGroupTable. The index entries for cermResGroupResUserTable are entPhysicalIndex, cermResUserTypeSubEntityId, cermResUserTypeId, cermResGroupId, and cermResGroupResUserId.
The cermResGroupResUserTable defines the following object:
•cermResGroupResUserId
You can use cermResOwnerResUserOrGroupTable to obtain information about each resource owner- user relationship or resource owner-group relationship in the system. This object is an extension of cermResOwnerSubTypeTable.
The index entries for cermResOwnerResUserOrGroupTable are entPhysicalIndex, cermResOwnerSubEntityId, cermResOwnerId, cermResOwnerSubTypeId, cermResOwnerResUserTypeId, and cermResOwnerResUserOrGroupId.
This table can be used for the following tasks:
•To obtain the list of resource users registered for a specific resource owner.
•To obtain usage, max-usage, user local and per user global current notification levels for a given resource owner sub-type and resource user relation.
The cermResOwnerResUserOrGroupTable defines the following objects:
•cermResOwnerResUserTypeId
•cermResOwnerResUserOrGroupId
•cermResUserOrGroupFlag
•cermResUserOrGroupUsagePct
•cermResUserOrGroupUsage
•cermResUserOrGroupMaxUsage
•cermResUserOrGroupNotifSeverity
•cermResUserOrGroupGlobNotifSeverity
You can use cermResOwnerResUserOrGroupThresholdTable to obtain threshold information about each resource owner sub-type and resource user relationship. This object is an extension of the cermResOwnerResUserOrGroupTable.
The index entries for cermResOwnerResUserOrGroupThresholdTable are entPhysicalIndex, cermResOwnerSubEntityId, cermResOwnerId, cermResOwnerSubTypeId, cermResOwnerResUserTypeId, cermResOwnerResUserOrGroupId, cermResUserOrGroupThreshIsUserGlob, and cermResUserOrGroupThreshSeverity.
The cermResOwnerResUserOrGroupThresholdTable defines the following objects:
•cermResUserOrGroupThreshIsUserGlob
•cermResUserOrGroupThreshSeverity
•cermResUserOrGroupThreshFlag
•cermResUserOrGroupRisingThresh
•cermResUserOrGroupRisingInterval
•cermResUserOrGroupFallingThresh
•cermResUserOrGroupFallingInterval
You can use cermResUserTypeResOwnerTable to obtain the list of resource owners present in a resource user type. This object is an extension of the cermResUserTypeTable.
The index entries for cermResUserTypeResOwnerTable are entPhysicalIndex, cermResUserTypeSubEntityId, cermResUserTypeId, and cermResUserTypeResOwnerId.
The cermResUserTypeResOwnerTable defines the following objects:
•cermResUserTypeResOwnerId
You can use cermResMonitorTable to obtain the list of resource monitors in the system. The index entries for this object are entPhysicalIndex, cermResMonitorSubEntityId, and cermResMonitorId.
The cermResMonitorTable defines the following objects:
•cermResMonitorSubEntityId
•cermResMonitorId
•cermResMonitorName
You can use cermResMonitorResOwnerResUserTable to obtain resource-related information that is tracked by a resource monitor. This object is an extension of cermResMonitorTable.
The index entries for cermResMonitorResOwnerResUserTable are entPhysicalIndex, cermResMonitorSubEntityId, cermResMonitorId, cermResMonitorResOwnerId, cermResMonitorResUserTypeId, and cermResMonitorResUserId.
The cermResMonitorResOwnerResUserTable defines the following objects:
•cermResMonitorResOwnerId
•cermResMonitorResUserTypeId
•cermResMonitorResUserId
•cermResMonitorResPolicyName
You can use cermResMonitorPolicyTable to obtain the list of resource policies that are tracked by a resource monitor. This object is an extension of the cermResMonitorTable. The index entries for cermResMonitorPolicyTable are entPhysicalIndex, cermResMonitorSubEntityId, cermResMonitorId, and cermResMonitorPolicyName.
The cermResMonitorPolicyTable defines the following object:
•cermResMonitorPolicyName
You can use the ERM Configuration MIB objects to perform the following tasks:
•Creating, Modifying, or Deleting a Resource Policy
•Configuring Threshold Values and Intervals for Resource Owner Sub-types in a Resource Policy
•Creating or Deleting a Resource Group
•Creating or Deleting a User Instance in a Resource Group
•Applying an Existing Resource Policy to a Resource User or Group
Table 2 describes the ERM Configuration MIB objects.
You can use the scalar object cermScalarsGlobalPolicyName to impose and indicate if a global resource policy is applied in the system. If no global resource policy is applied in the system, then this object will contain empty string. This object has read-write access permission. Setting this scalar object to an existing global resource policy name, will result in applying the global resource policy to the system.
You can use cermConfigPolicyTable to create, modify, or delete a resource policy. The index entry for this object is cermPolicyName.
The cermConfigPolicyTable defines the following objects:
•cermPolicyName
•cermPolicyIsGlobal
•cermPolicyUserTypeName
•cermPolicyLoggingEnabled
•cermPolicySnmpNotifEnabled
•cermPolicyStorageType
•cermPolicyRowStatus
You can use cermConfigPolicyResOwnerThreshTable to configure rising or falling threshold values and rising or falling intervals for resource owner sub-types in a resource policy. This object is an extension of the cermConfigPolicyTable.
The index entries for cermConfigPolicyResOwnerThreshTable are cermPolicyName, cermPolicyPhysicalIndex, cermConfigPolicyResOwnerSubEntityId, cermConfigPolicyResOwnerId, cermConfigPolicyResOwnerSubTypeId, ermConfigPolicyIsUserGlobal, and cermConfigPolicyThresholdLevel.
The cermConfigPolicyResOwnerThreshTable defines the following objects:
•cermPolicyPhysicalIndex
•cermConfigPolicyResOwnerSubEntityId
•cermPolicyResOwnerId
•cermPolicyResOwnerSubTypeId
•cermPolicyIsUserGlobal
•cermPolicyThresholdLevel
•cermPolicyRisingThreshold
•cermPolicyRisingInterval
•cermPolicyFallingThreshold
•cermPolicyFallingInterval
•cermPolicyResOwnerThreshStorageType
•cermPolicyResOwnerRowStatus
You can use cermConfigResGroupTable to create or delete a resource group in the system. The index entry for this object is cermConfigResGroupName.
The cermConfigResGroupTable defines the following objects:
•cermConfigResGroupName
•cermConfigResGroupUserTypeName
•cermConfigResGroupStorageType
•cermConfigResGroupRowStatus
You can use cermConfigResGroupUserTable to create or delete a user instance in a given resource group. This object is an extension of the cermConfigResGroupTable.
The index entries for cermConfigResGroupUserTable are cermConfigResGroupName and cermConfigResGroupUserName.
The cermConfigResGroupUserTable defines the following objects:
•cermConfigResGroupUserName
•cermConfigResGroupUserStorageType
•cermConfigResGroupUserRowStatus
You can use cermConfigPolicyApplyTable to apply an existing resource policy to a resource user or resource group. The index entries for this object are cermPolicyApplyUserOrGroupName and cermPolicyApplyUserOrGroupFlag.
The cermConfigPolicyApplyTable defines the following objects:
•cermPolicyApplyUserOrGroupName
•cermPolicyApplyUserOrGroupFlag
•cermPolicyApplyPolicyName
•cermPolicyApplyStorageType
•cermPolicyApplyRowStatus
You can configure ERM Notification MIB objects to receive global or user-specific notification on policy violation. There are three types of ERM Notification MIB objects.
Table 3 describes the ERM Notification MIB objects.
You can use cermNotifsEnabled to determine if the generation of traps for ERM policy violation notifications is allowed.
When this object is set to true, it allows generation of traps for the ERM policy violation related notifications ciscoErmGlobalPolicyViolation and ciscoErmLocalPolicyViolation.
You can use ciscoErmGlobPolicyViolation to receive global notification on policy violation.
The notification object ciscoErmGlobPolicyViolation defines the following objects:
•cermResOwnerName
•cermResOwnerSubTypeName
•cermNotifsThresholdSeverity
•cermNotifsThresholdValue
•cermNotifsDirection
•cermNotifsPolicyName
You can use ciscoErmUserPolicyViolation to receive a user-specific notification on policy violation.
The notification object ciscoErmUserPolicyViolation contains the following objects:
•cermResOwnerName
•cermResOwnerSubTypeName
•cermResUserTypeName
•cermResUserName
•cermResUserOrGroupThreshFlag
•cermNotifsThresholdIsUserGlob
•cermNotifsThresholdSeverity
•cermNotifsThresholdValue
•cermNotifsDirection
•cermNotifsPolicyName
This section contains the following procedures:
•Enabling ERM-MIB Notification Traps (required)
•Configuring the Router to Send SNMP Notification Traps for ERM to a Host (required)
You can enable ERM-MIB notification traps, which are generated when resource usage exceeds the threshold value. The ERM-MIB notification traps will be sent to the host that is configured to receive traps.
1. enable
2. configure terminal
3. snmp-server enable traps resource-policy
4. end
Perform this task to enable the router to send SNMP notifications traps defined in ERM-MIB to a host.
•SNMP must be enabled on your network.
•Create an SNMP server community to receive information on MIB objects and traps using the snmp-server community command.
1. enable
2. show running-config [options]
3. configure terminal
4. snmp-server host {hostname | ip-address} [vrf vrf-name] [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port] [notification-type]
5. end
This section provides the following configuration example:
•Configuring the Router to Send SNMP Notifications for ERM to a Host: Example
The following example shows how to configure the router to send SNMP notifications for ERM to a host:
Router# configure terminal
Router(config)# snmp-server community public rw
Router(config)# snmp-server enable traps resource-policy
Router(config)# snmp-server host 209.165.201.30 version 2c public
Router(config)# end
The following sections provide references related to the ERM-MIB feature.
|
|
---|---|
Cisco IOS commands |
|
Embedded Resource Manager |
|
Network Management commands: complete command syntax, command mode, command history, defaults, usage guidelines, and examples |
|
|
---|---|
None |
— |
|
|
---|---|
•CISCO-ERM-MIB.my |
To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL: |
|
|
---|---|
RFC 1902 |
Structure of Management Information for Version 2 of the Simple Network Management Protocol (SNMPv2) |
Table 4 lists the features in this module and provides links to specific configuration information. Only features that were introduced or modified in Cisco IOS Release 12.2(33)SRB and Cisco IOS Release 15.0(1)M or later releases appear in the table.
Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 4 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature.