SNMP Traps
The traps supported by Prime Access Registrar enable a standard SNMP management station to receive trap messages from an Prime Access Registrar server. These messages contain information indicating whether a server was brought up or down, or that the proxied remote server is down or has come back online.
A trap is a network message of a specific format issued by an SNMP entity on behalf of a network management agent application. A trap is used to provide the management station with an asynchronous notification of an event.
When a trap is generated, a single copy of the trap is transmitted as a trap PDU to each destination contained within a list of trap recipients.
The list of trap recipients is shared by all events and is determined at server initialization time along with other trap configuration information. The list of trap recipients dictates where Prime Access Registrar traps are directed.
The configuration of any other SNMP agent on the host is ignored. By default, all traps are enabled but no trap recipients are defined. By default, no trap is sent until trap recipients are defined.
Traps are configured using the command line interface (CLI). After configuring traps, the configuration information is re initialized when a server reload or restart occurs.
Note SNMP queries and traps communication can be performed over IPv6.
When you configure traps, you must provide the following information:
- List of trap recipients (community string for each)
- Suppressing traps for any type of message
- Frequency of traps for any type of message
This topic contains the following sections:
Supported Traps
The traps supported by Prime Access Registrar enable the Prime Access Registrar server to notify interested management stations of events, failure, or impending failure conditions. Traps are a network message of a specific format issued by an SNMP entity on behalf of a network management agent application. Traps are used to provide the management station with an asynchronous notification of an event.
This section contains the following topics:
carServerStart
carServerStart signifies that the server has started on the host from which this notification was sent. This trap has one object, carNotifStartType, which indicates the start type. A firstStart indicates this is the server process’ first start. reload indicates this server process has an internal reload. This typically occurs after rereading some configuration changes, but reload indicates this server process did not quit during the reload process.
carServerStop
carServerStop signifies that the server has stopped normally on the host from which this notification was sent.
carInputQueueFull
carInputQueueFull indicates that the percentage of use of the packet input queue has reached its high threshold. This trap has two objects:
- carNotifInputQueueHighThreshold—indicates the high limit percentage of input queue usage
- carNotifInputQueueLowThreshold—indicates the low limit percentage of input queue usage
By default, carNotifInputQueueHighThreshold is set to 90% and carNotifInputQueueLowThreshold is set to 60%.
Note The values for these objects cannot be changed at this time. You will be able to modify them in a future release of Prime Access Registrar.
After this notification has been sent, another notification of this type will not be sent again until the percentage usage of the input queue goes below the low threshold.
If the percentage usage reaches 100%, successive requests might be dropped, and the server might stop responding to client requests until the queue drops down again.
carInputQueueNotVeryFull
carInputQueueNotVeryFull indicates that the percentage usage of the packet input queue has dropped below the low threshold defined in carNotifInputQueueLowThreshold. This trap has two objects:
- carNotifInputQueueHighThreshold—indicates the high limit percentage of input queue usage
- carNotifInputQueueLowThreshold—indicates the low limit percentage of input queue usage
After this type of notification has been sent, it will not be sent again until the percentage usage goes back up above the high threshold defined in carNotifInputQueueHighThreshold.
carDiaInputQueueFull
carDiaInputQueueFull signifies that the percentage of use of the Diameter packet input queue has reached its high threshold. This trap has two objects:
- carNotifDiaInputQueueHighThreshold—indicates the high limit percentage of Diameter packet input queue usage.
- carNotifDiaInputQueueLowThreshold—indicates the low limit percentage of the Diameter packet input queue usage.
If the percentage usage reaches 100%, successive request is dropped, and the server stops responding to client requests until the queue drops down again. After this notification is sent, this type of notification will not be sent again until the percentage usage of the input queue goes back down below the low threshold.
carDiaInputQueueNotFull
carDiaInputQueueNotFull signifies that the percentage of use of Diameter packet input queue has dropped below the low threshold defined in carNotifDiaInputQueueLowThreshold. This trap has two objects:
- carNotifDiaInputQueueHighThreshold—indicates the high limit percentage of Diameter packet input queue usage.
- carNotifDiaInputQueueLowThreshold—indicates the low limit percentage of the Diameter packet input queue usage.
After this type of notification has been sent, it will not be sent again until the percentage usage goes back up above the high threshold defined in carNotifDiaInputQueueHighThreshold.
carOtherAuthServerNotResponding
carOtherAuthServerNotResponding indicates that an authentication server is not responding to a request sent from this server. This trap has three objects:
- radiusAuthServerAddress—indicates the identity of the concerned server
- radiusAuthClientServerPortNumber—indicates the port number of the concerned server
- carAuthServerType—indicates the type of the concerned server
The index of these three objects identifies the entry in radiusAuthServerTable and carAccServerExtTable which maintains the characteristics of the concerned server.
Note One should not rely solely on carOtherAuthServerNotResponding for server state. Several conditions, including a restart of the Prime Access Registrar server, could result in either multiple carOtherAuthServerNotResponding notifications being sent or in a carOtherAuthServerResponding notification not being sent. NMS can query the carAuthServerRunningState in carAuthServerExtTable for the current running state of this server.
carOtherAuthServerResponding
carOtherAuthServerResponding signifies that an authentication server which had formerly been in a down state is now responding to requests from the Prime Access Registrar server. This trap has three objects:
- radiusAuthServerAddress—indicates the identity of the concerned server
- radiusAuthClientServerPortNumber—indicates the port number of the concerned server
- carAuthServerType—indicates the type of the concerned server
The index of these three objects identifies the entry in radiusAuthServerTable and carAccServerExtTable which maintains the characteristics of the concerned server.
One should not rely on receiving this notification as an indication that all is well with the network. Several conditions, including a restart of the Prime Access Registrar server, could result in either multiple carOtherAuthServerNotResponding notifications being sent or in a carOtherAuthServerResponding notification not being sent. The NMS can query the carAuthServerRunningState in carAuthServerExtTable for the current running state of this server.
carOtherAccServerNotResponding
carOtherAuthServerNotResponding signifies that an accounting server is not responding to the requests sent from this server. This trap has three objects:
- radiusAccServerAddress—indicates the identity of the concerned server
- radiusAccClientServerPortNumber—indicates the port number of the concerned server
- carAcchServerType—indicates the type of the concerned server
The index of these three objects identifies the entry in radiusAuthServerTable and arAccServerExtTable which maintains the characteristics of the concerned server.
One should not solely rely on this for server state. Several conditions, including the restart of the Prime Access Registrar server, could result in either multiple carOtherAccServerNotResponding notifications being sent or in a carOtherAccServerResponding notification not being sent. The NMS can query the carAccServerRunningState in carAccServerExtTable for current running state of this server.
carOtherAccServerResponding
carOtherAccServerResponding signifies that an accounting server that had previously sent a not responding message is now responding to requests from the Prime Access Registrar server. This trap has three objects:
- radiusAccServerAddress—indicates the identity of the concerned server
- radiusAccClientServerPortNumber—indicates the port number of the concerned server
- carAccServerType—indicates the type of the concerned server
The index of these three objects identifies the entry in radiusAuthServerTable and arAccServerExtTable which maintains the characteristics of the concerned server.
One should not rely on the reception of this notification as an indication that all is well with the network. Several conditions, including the restart of the Prime Access Registrar server, could result in either multiple carOtherAccServerNotResponding notifications being sent or in a carOtherAccServerResponding notification not being sent. The NMS can query the carAccServerRunningState in carAccServerExtTable for the current running state of this server.
carAccountingLoggingFailure
carAccountingLoggingFailure signifies that this Prime Access Registrar server cannot record accounting packets locally. This trap has two objects:
- carNotifAcctLogErrorReason—indicates the reason packets cannot be recorded locally
- carNotifAcctLogErrorInterval—indicates how long to wait until another notification of this type might be sent. A value of 0 (zero) indicates no time interval checking, meaning that no new notification can be sent until the error condition is corrected.
carLicenseUsage
carLicenseUsage signifies the percentage of transactions per second (TPS) usage or session usage from the available license values.
TPS
The TPS trap is generated when the Prime Access Registrar server reaches license usage slabs namely 80%, 90%, 100%, and 110%. These traps are generated only once for every slab during the increasing steady state. Increasing steady state is a state when Prime Access Registrars’ incoming request rate shows 80% of the license usage over a period of 20 minutes. These traps will be regenerated only if a increasing steady state is observed after a decreasing steady state.
Concurrent Session
The concurrent session trap is generated when the Prime Access Registrar server reaches 80%. The incoming traffic slabs defined for trap generation are 80%, 90%, 100%, and 110% of the licensed Concurrent Sessions. These traps are generated once for every slab during the increasing steady state.
carSigtranLicenseUsage
carSigtranLicenseUsageTrap signifies the percentage of SIGTRAN TPS usage or SIGTRAN session usage from the available license values.
carDiameterPeerDown
carDiameterPeerDown signifies that a Diameter peer is down. The identity of the peer is given by cdbpPeerIpAddress.
carDiameterPeerUp
carDiameterPeerUp signifies that a Diameter peer is up. The identity of the peer is given by cdbpPeerIpAddress.
carTPSCapacityFull
carTPSCapacityFull signifies that the TPS of the Prime Access Registrar server has reached the configured high threshold capacity. This trap has the following objects:
- carNotifTPSHighThreshold—indicates the maximum limit of the TPS of the Prime Access Registrar server.
- carNotifTPSLowThreshold—indicates the minimum limit of the TPS of the Prime Access Registrar server.
- carServerTPSUsage—indicates the current TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the TPS of Prime Access Registrar server reduces below the configured carNotifTPSLowThreshold value.
carTPSCapacityNotFull
carTPSCapacityNotFull signifies that the TPS of the Prime Access Registrar server has dropped below the configured low threshold capacity. This trap has the following objects:
- carNotifTPSHighThreshold—indicates the maximum limit of the TPS of the Prime Access Registrar server.
- carNotifTPSLowThreshold—indicates that the minimum limit of the TPS of the Prime Access Registrar server.
- carServerTPSUsage—indicates the current TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the TPS of Prime Access Registrar server increases beyond the configured carNotifTPSHighThreshold value.
carSigtranTPSCapacityFull
carSigtranTPSCapacityFull signifies that the SIGTRAN TPS of the Prime Access Registrar server has reached the configured high threshold capacity. This trap has the following objects:
- carNotifSigtranTPSHighThreshold—indicates the maximum limit of the SIGTRAN TPS of the Prime Access Registrar server.
- carNotifSigtranTPSLowThreshold—indicates the minimum limit of the SIGTRAN TPS of the Prime Access Registrar server.
- carServerSigtranTPSUsage—indicates the current SIGTRAN TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the SIGTRAN TPS of Prime Access Registrar server reduces below the configured carNotifSigtranTPSLowThreshold value.
carSigtranTPSCapacityNotFull
carSigtranTPSCapacityNotFull signifies that the SIGTRAN TPS of the Prime Access Registrar server has reached the configured low threshold capacity. This trap has the following objects:
- carNotifSigtranTPSHighThreshold—indicates the maximum limit of the SIGTRAN TPS of the Prime Access Registrar server.
- carNotifSigtranTPSLowThreshold—indicates the minimum limit of the SIGTRAN TPS of the Prime Access Registrar server.
- carServerSigtranTPSUsage—indicates the current SIGTRAN TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the SIGTRAN TPS of Prime Access Registrar server increases beyond the configured carNotifSigtranTPSHighThreshold value.
carSessionCapacityFull
carSessionCapacityFull signifies that the session TPS of the Prime Access Registrar server has reached the configured high threshold capacity. This trap has the following objects:
- carNotifSessionHighThreshold—indicates the maximum limit of the session TPS of the Prime Access Registrar server.
- carNotifSessionLowThreshold—indicates the minimum limit of the session TPS of the Prime Access Registrar server.
- carServerSessionUsage—indicates the current session TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the session TPS of Prime Access Registrar server reduces below the configured carNotifSessionLowThreshold value.
carSessionCapacityNotFull
carSessionCapacityNotFull signifies that the session TPS of the Prime Access Registrar server has reached the configured low threshold capacity. This trap has the following objects:
- carNotifSessionHighThreshold—indicates the maximum limit of the session TPS of the Prime Access Registrar server.
- carNotifSessionLowThreshold—indicates the minimum limit of the session TPS of the Prime Access Registrar server.
- carServerSessionUsage—indicates the current session TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the session TPS of Prime Access Registrar server increases beyond the configured carNotifSessionHighThreshold value.
carSigtranSessionCapacityFull
carSigtranSessionCapacityFull signifies that the SIGTRAN session TPS of the Prime Access Registrar server has reached the configured high threshold capacity. This trap has the following objects:
- carNotifSigtranSessionHighThreshold—indicates the maximum limit of the SIGTRAN session TPS of the Prime Access Registrar server.
- carNotifSigtranSessionLowThreshold—indicates the minimum limit of the SIGTRAN session TPS of the Prime Access Registrar server.
- carServerSessionUsage—indicates the current SIGTRAN session TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the SIGTRAN session TPS of Prime Access Registrar server reduces below the configured carNotifSigtranSessionLowThreshold value.
carSigtranSessionCapacityNotFull
carSigtranSessionCapacityNotFull signifies that the SIGTRAN session TPS of the Prime Access Registrar server has reached the configured low threshold capacity. This trap has the following objects:
- carNotifSigtranSessionHighThreshold—indicates the maximum limit of the SIGTRAN session TPS of the Prime Access Registrar server.
- carNotifSigtranSessionLowThreshold—indicates the minimum limit of the SIGTRAN session TPS of the Prime Access Registrar server.
- carServerSessionUsage—indicates the current SIGTRAN session TPS usage of the Prime Access Registrar server.
After this notification is sent, this type of notification will not be sent again until the SIGTRAN session TPS of Prime Access Registrar server increases beyond the configured carNotifSigtranSessionHighThreshold value.
carLicenseUsageReset
carLicenseUsageReset signifies that the server usage is nominal after exceeding the license thresholds. This notification carries the percentage of License Usage.
carSigtranLicenseUsageReset
carSigtranLicenseUsageReset signifies that server SIGTRAN usage is nominal after exceeding the license thresholds. This notification carries the percentage of SIGTRAN License Usage.
carReplicationSyncFailure
carReplicationSyncFailure notifies that there is a synchronization failure in Prime Access Registrar replication. This notification is triggered when there is a failure in sync message exchanges or upon out of sync configuration detection. This trap has four objects:
- carNotifReplicationMasterInetAddrType—indicates the type of Internet address of the Master, which could be IPv4 address, IPv6 address, or DNS domain name.
- carNotifReplicationMasterIPAddress—indicates the IP address of the Master referred to using the version-neutral IP address.
- carNotifReplicationMemberIPAddress—indicates the type of Internet address of the Member, which could be IPv4 address, IPv6 address, or DNS domain name.
- carNotifReplicationMemberInetAddrType—indicates the IP address of the Member referred to using the version-neutral IP address.
TLSClientConnectionUpTrap
TLSClientConnectionUpTrap is sent from Prime Access Registrar when first connection is established by a RADIUS-TLS client.
TLSClientConnectionClosedTrap
TLSClientConnectionClosedTrap is sent from Prime Access Registrar when all the connections are closed by the RADIUS-TLS client.
carReplicationSuccess
carReplicationSuccess notifies that replication synchronization, which had formerly been in a down state is now resolved. This trap has four objects:
- carNotifReplicationMasterInetAddrType—indicates the type of Internet address of the Master, which could be IPv4 address, IPv6 address, or DNS domain name.
- carNotifReplicationMasterIPAddress—indicates the IP address of the Master referred to using the version-neutral IP address.
- carNotifReplicationMemberIPAddress—indicates the type of Internet address of the Member, which could be IPv4 address, IPv6 address, or DNS domain name.
- carNotifReplicationMemberInetAddrType—indicates the IP address of the Member referred to using the version-neutral IP address.
Server Monitoring Traps
Prime Access Registrar provides an alternate server monitoring option using which high and low TPS thresholds can be monitored.
A new attribute ServerMonitorAltApproach is introduced in aregcmd CLI under //localhost/Radius/Advanced. When SNMP is enabled, this attribute to set to true, and TPSHighThreshold, TPSLowThreshold, and ServerMonitorLogFreqInsecs in //localhost/Radius/Advanced/ServerMonitor are set to non-zero values, four traps will be sent by Prime Access Registrar server in the following conditions:
- If the incoming TPS is maintained above configured TPSHighThreshold for a steady state period of five minutes, Prime Access Registrar sends the carTPSCapacityFull trap.
- If the incoming TPS is maintained at zero or below the configured TPSLowThreshold value for a steady state period of five minutes, Prime Access Registrar sends the carTPSCapacityNotFull trap.
- After reaching the TPSHighThreshold value, if the incoming TPS decreases below TPSHighThreshold, Prime Access Registrar sends the carTPSCapacityFullResetTrap trap.
- After reaching the TPSLowThreshold value, if the incoming TPS increases above TPSLowThreshold, Prime Access Registrar sends the carTPSCapacityNotFullResetTrap trap.
Table 1 lists the server monitor traps with the corresponding MIB objects.
Table 1 Server Monitor Trap MIB Objects
|
|
|
carTPSCapacityFullResetTrap |
carNotifTPSHighThreshold |
Indicates the maximum limit of the TPS of the Prime Access Registrar server. |
carNotifTPSLowThreshold |
Indicates that the minimum limit of the TPS of the Prime Access Registrar server. |
carServerTPSUsage |
Indicates the current TPS usage of the Prime Access Registrar server. |
carTPSCapacityNotFullResetTrap |
carNotifTPSHighThreshold |
Indicates the maximum limit of the TPS of the Prime Access Registrar server. |
carNotifTPSLowThreshold |
Indicates that the minimum limit of the TPS of the Prime Access Registrar server. |
carServerTPSUsage |
Indicates the current TPS usage of the Prime Access Registrar server. |
Note When ServerMonitorAltApproach attribute is set to TRUE, the TPSLowThreshold, TPSHighThreshold, and ServerMonitorLogFreqInsecs values in server monitor configuration must be greater than zero. However; the lowest value for the TPSLowThreshold is one and TPSHighThreshold value should be higher than the TPSLowThreshold value.
An example configuration for the TPS monitoring includes:
--> cd /r/advanced/servermonitor/
[ //localhost/Radius/Advanced/ServerMonitor ]
SigtranTPSHighThrehold = 0
SigtranTPSLowThreshold = 0
SigtranSMHighThreshold = 0
SigtranSMLowThreshold = 0
ServerMonitorLogFreqInsecs = 10
Set /Radius/Advanced/ServerMonitorAltApproach TRUE
IP Allocation Traps
Following traps are supported for the IP allocation feature:
- carIPCapacityFull—signifies that the number of IPs allocated by the Prime Access Registrar server has reached the configured high threshold capacity.
- carIPCapacityNotFull—signifies that the number of IPs allocated by the Prime Access Registrar server has reached the configured low threshold capacity.
Table 2 lists the IP allocation traps with the corresponding MIB objects.
Table 2 IP Allocation Traps MIB Objects
|
|
|
carIPCapacityFull |
carNotifIPHighThreshold |
Indicates the maximum limit of the IPs allocated by the Prime Access Registrar server. |
|
carNotifIPLowThreshold |
Indicates the minimum limit of the IPs allocated by the Prime Access Registrar server. |
|
carServerIPUsage |
Indicates the current number of IPs allocated by Prime Access Registrar server. |
Note After this notification is sent, this type of notification will not be sent again until the allocated number of IPs of the Prime Access Registrar server reduces below the configured carNotifIPLowThreshold value. |
carIPCapacityNotFull |
carNotifIPHighThreshold |
Indicates the maximum limit of the IPs allocated by the Prime Access Registrar server. |
|
carNotifIPLowThreshold |
Indicates the minimum limit of the IPs allocated by the Prime Access Registrar server. |
|
carServerIPUsage |
Indicates the current number of IPs allocated by Prime Access Registrar server. |
Note After this notification is sent, this type of notification will not be sent again until the allocated number of IPs of the Prime Access Registrar server increases beyond the configured carNotifIPHighThreshold value. |
Configuring Traps
The Prime Access Registrar SNMP implementation uses various configuration files to configure its applications.
This section contains the following topics:
SNMP Configuration
A sample configuration file is available in /cisco-ar/ucd-snmp/share/snmp/snmpd.conf. This configuration file is used to configure SNMP query permissions and trap recipients.
Configuring Trap Recipient
The following example shows the default configuration that sets up trap recipients for SNMP versions v1 and v2c.
Note Most sites use a single NMS, not two as shown below.
# -----------------------------------------------------------------------------
trapsink zubat trapcom 162
trap2sink ponyta trapcom 162
###############################################################################
Note trapsink is used in SNMP version 1; trap2sink is used in SNMP version 2.
trapcommunity defines the default community string to be used when sending traps. This command must appear prior to trapsink or trap2sink which use this community string.
trapsink and trap2sink are defined as follows:
trapsink hostname community port
trap2sink hostname community port
Community String
A community string is used to authenticate the trap message sender (SNMP agent) to the trap recipient (SNMP management station). A community string is required in the list of trap receivers.