SNMP Parameters

The SNMP parameters are described in the table below.

SNMP Parameters

Parameter

Description

'Disable SNMP'

configure system > snmp settings > disable

[DisableSNMP]

Enables and disables device management through SNMP.

[0] No = (Default) SNMP is enabled.
[1] Yes = SNMP is disabled.

configure system > snmp settings > port

[SNMPPort]

Defines the device's local (LAN) UDP port used for SNMP Get/Set commands.

The range is 100 to 3999. The default port is 161.

Note: For the parameter to take effect, a device restart is required.

[ChassisPhysicalAlias]

Defines the 'alias' name object for the physical entity as specified by a network manager, and provides a non-volatile 'handle' for the physical entity.
The valid range is a string of up to 255 characters.

[ChassisPhysicalAssetID]

Defines the user-assigned asset tracking identifier object for the device's chassis as specified by OVOC, and provides non-volatile storage of this information.
The valid range is a string of up to 255 characters.

[ifAlias]

Defines the textual name of the interface. The value is equal to the ifAlias SNMP MIB object.
The valid range is a string of up to 64 characters.

configure system > snmp trap > auto-send-keep-alive

[SendKeepAliveTrap]

Enables the device to send NAT keep-alive traps to the port of the SNMP network management station (e.g., AudioCodes OVOC). This is used for NAT traversal, and allows SNMP communication with OVOC management platform, located in the WAN, when the device is located behind NAT. It is needed to keep the NAT pinhole open for the SNMP messages sent from OVOC to the device. The device sends the trap periodically - every 9/10 of the time configured by the NATBindingDefaultTimeout parameter. The trap that is sent is acKeepAlive. For more information, refer to the SBC-Gateway Series SNMP Alarm Reference Guide.

[0] = (Default) Disable
[1] = Enable

To configure the port number, use the KeepAliveTrapPort parameter.

Note: For the parameter to take effect, a device restart is required.

[KeepAliveTrapPort]

Defines the port of the SNMP network management station to which the device sends keep-alive traps.

The valid range is 0 - 65534. The default is port 162.

To enable NAT keep-alive traps, use the [SendKeepAliveTrap] parameter.

[PM_EnableThresholdAlarms]

Enables the sending of the SNMP trap event acPerformanceMonitoringThresholdCrossing, which is sent every time the threshold (high or low) of a Performance Monitored object (e.g., acPMSIPSBCAttemptedCallsTable) is crossed.

[0] = (Default) Disable
[1] = Enable

Note: Once enabled, you can change the low and high threshold values per performance monitored object. For more information, refer to the SBC-Gateway Series SNMP Alarm Reference Guide.

'Call Duration for Short Calls'

configure voip > sbc settings > short-call-seconds

[ShortCallSeconds]

Defines the maximum duration (in seconds) of an SBC call for it to be considered a short call and included in the performance monitoring count for short calls (shortCallsCounterTotal and shortCallsCounter). The duration must be less than or equal to the configured value for the call to be considered a short call.

The valid value is 0 to 60. The default is 2. A value of 0 indicates calls of zero duration, which are calls that do not pass the device's Classification, Manipulation or Routing stages.

Note: The parameter is applicable only to the SBC application.

'Call Duration for Long Calls'

configure voip > sbc settings > long-call-minutes

[LongCallMinutes]

Defines the minimum duration (in minutes) of an SBC call for it to be considered a long call and included in the performance monitoring count for long calls (longCallsCounterTotal and longCallsCounter). The duration must be greater than or equal to the configured value for the call to be considered a long call.

The valid value is 0 to 60. The default is 30. A value of 0 indicates calls of zero duration, which are calls that do not pass the device's Classification, Manipulation or Routing stages.

Note: The parameter is applicable only to the SBC application.

[acUserInputAlarmDescription]

Defines the description of the input alarm.

[acUserInputAlarmSeverity]

Defines the severity of the input alarm.

configure system > snmp settings > alarm-history-table-max-size

[AlarmHistoryTableMaxSize]

Defines the maximum number of historical alarms that can be displayed in the Alarm History table. The parameter can be controlled by the Config Global Entry Limit MIB (located in the Notification Log MIB).

The valid range is 50 to 1000. The default is 500.

Note: For the parameter to take effect, a device restart is required.

configure system > snmp settings > active-alarm-table-max-size

[ActiveAlarmTableMaxSize]

Defines the maximum number of active alarms that can be displayed in the Active Alarms table.

When the table reaches this user-defined maximum capacity (i.e., full), the device sends the SNMP trap event, acActiveAlarmTableOverflow. If the table is full and a new alarm is raised by the device, the new alarm is not displayed in the table.

The valid range is 50 to 300. The default is 120.

For more information on the Active Alarms table, see Viewing Active Alarms.

Note:

For the parameter to take effect, a device restart is required.
To clear the acActiveAlarmTableOverflow trap, you must restart the device. The restart also deletes all the alarms in the Active Alarms table.

configure system > snmp alarm-settings > alarms-persistent-history

[AlarmsPersistentHistory]

Enables the device to store the alarms of the Alarms History table on its flash memory. When enabled, the alarms are not deleted from table upon a device restart.

[0] = (Default) Disabled
[1] = Enabled

For more information, see Storing Alarms History on Flash.

Note:

For the parameter to take effect, a device restart is required.
The device can't operate with OVOC when the parameter is enabled.

configure system > snmp alarm-settings > persistent-history-save-interval

[SavePersistentHistoryInterval]

Defines how often (in minutes) the device saves the alarms of the Alarms History table to its flash memory.

The valid value range is 1 to 50,000. The default is 1,440 (24 hours).

For more information, see Storing Alarms History on Flash.

no-alarm-for-disabled-port

[NoAlarmForDisabledPort]

Enables the device to not send the SNMP trap acBoardControllerFailureAlarm alarm. This alarm indicates a "disabled" telephony port, which is one that is not configured at all or that is configured but without a Trunk Group ID (i.e., Trunk Group ID is 0), in the Trunk Groups table.

[0] = (Default) Disabled. The device sends the SNMP trap for non-configured ports.
[1] = Enabled. The device doesn't send the SNMP trap for non-configured ports.

Note:

The parameter is applicable to all telephony ( digital) port types.
The parameter is applicable only to the Gateway application.

[ContextEngineID]

Defines the contextEngineID as mentioned in RFC 3411. An SNMP context is a collection of management information accessible by an SNMP entity. An item of management information may exist in more than one context and an SNMP entity potentially has access to many contexts. A context is identified by the snmpEngineID value of the entity hosting the management information (also called a contextEngineID) and a context name that identifies the specific context (also called a contextName).

Note:

For the parameter to take effect, a device restart is required.
When the device operates in HA mode, this parameter has the same value for both active and redundant devices (i.e., system identifier). If the devices return to Standalone mode (i.e., non-HA mode), you must configure the parameter to a 0 value on both devices. When the devices restart to Standalone mode, each device automatically sets this parameter to a unique value based on its serial number (S/N).

configure system > snmp settings > engine-id

[SNMPEngineIDString]

Defines the SNMP engine ID for SNMPv2/SNMPv3 agents. This is used for authenticating a user attempting to access the SNMP agent on the device.

The ID can be a string of up to 36 characters. The default is 00:00:00:00:00:00:00:00:00:00:00:00 (12 Hex octets characters). The provided key must be set with 12 Hex values delimited by a colon (":") in the format xx:xx:...:xx. For example, 00:11:22:33:44:55:66:77:88:99:aa:bb

Note:

For the parameter to take effect, a device restart is required.
Before setting the parameter, all SNMPv3 users must be deleted; otherwise, the parameter setting is ignored.
If the supplied key doesn't pass validation of the 12 Hex values input or it is set with the default value, the engine ID is generated according to RFC 3411.
When the device operates in HA mode, the parameter has the same value for both active and redundant devices (i.e., system identifier). If the two devices return to Standalone mode (i.e., non-HA mode), you must configure the parameter to a NULL value (i.e., no value) for both devices. When the devices restart to the Standalone mode, each device automatically sets the parameter to a unique value based on its' serial number (S/N).

'Trap Manager Host Name for IPv4'

configure system > snmp trap > manager-host-name

[SNMPTrapManagerHostName]

Defines an FQDN for IPv4 address resolution of the remote host used as an SNMP Trap Manager to receive traps sent by the device. The device sends the traps to the DNS-resolved IP address.

The valid range is a string of up to 99 characters.

For more information, see Configuring an SNMP Trap Destination with FQDN.

'Trap Manager Host Name for IPv6'

configure system > snmp trap > manager-ipv6-host-name

[SNMPIPv6TrapManagerHostName]

Defines an FQDN for IPv6 address resolution of the remote host used as an SNMP Trap Manager to receive traps sent by the device. The device sends the traps to the DNS-resolved IP address.

The valid range is a string of up to 99 characters.

For more information, see Configuring an SNMP Trap Destination with FQDN.

'Activity Trap'

configure troubleshoot > activity-trap

[EnableActivityTrap]

Enables the device to send an SNMP trap to notify of Web user activities in the Web interface. The activities to report are configured by the [ActivityListToLog] parameter (see Reporting Management User Activities).

[0] Disable (default)
[1] Enable

'IPv4 Interface Name'

configure system > snmp settings > interface-name

[SNMPInterface]

Assigns an IPv4 IP Interface (configured in the IP Interfaces table - see Configuring IP Network Interfaces) to the SNMP application for SNMP over IPv4.

By default, the OAMP IP Interface is assigned to SNMP over IPv4.

For more information, see Configuring SNMP Interfaces.

'IPv6 Interface Name'

configure system > snmp settings > interface-ipv6-name

[SNMPIPv6Interface]

Assigns an IPv6 IP Interface (configured in the IP Interfaces table - see Configuring IP Network Interfaces) to the SNMP application for SNMP over IPv6.

For more information, see Configuring SNMP Interfaces.

configure system > snmp settings > enable-authentication-trap

[EnableSnmpAuthenticationTrap]

Disables the sending of the Authentication Failure SNMP trap (authenticationFailure, OID 1.3.6.1.6.3.1.1.5.5).

[0] = Disable - trap is not sent.
[1] = (Default) Enable - trap is sent.

SNMP Community String Parameters

'Read Only Community Strings'

configure system > snmp settings > ro-community-string-psw

[SNMPReadOnlyCommunityStringsPassword_x]

Defines a read-only SNMP community string. Up to five read-only community strings can be configured. For more information, see Configuring SNMP Community Strings.

Note:

The parameter cannot be configured with wide characters.
The read-only community strings must be different to the read-write community strings.

'Read/Write Community Strings'

configure system > snmp settings > rw-community-string-psw

[SNMPReadWriteCommunityStringsPassword_x]

Defines a read-write SNMP community string. Up to five read-write community strings can be configured. For more information, see Configuring SNMP Community Strings.

Note:

The parameter cannot be configured with wide characters.
The read-write community strings must be different to the read-only community strings.

'Trap Community String'

configure system > snmp trap > community-string

[SNMPTrapCommunityStringPassword]

Defines the community string for SNMP traps. For more information, see Configuring SNMP Community Strings.

Note: The parameter cannot be configured with wide characters.