All MIBs › CISCO-WAN-VISM-TONE-PLAN-MIB
Organization: Cisco Systems, Inc.
Last Updated: 2003-12-17
Category: Telephony and VoIP, Vendor: Cisco Devices
Description:
Manages Cisco VISM tone plan configuration for country-specific telephony tone generation.
Imported Objects
From CISCOWAN-SMI
| ciscoWan | OBJECT-IDENTITY |
From SNMPv2-CONF
| MODULE-COMPLIANCE | |
| OBJECT-GROUP |
From SNMPv2-SMI
| Integer32 | |
| MODULE-IDENTITY | |
| OBJECT-TYPE |
From SNMPv2-TC
| DisplayString | |
| RowStatus |
What Is CISCO-WAN-VISM-TONE-PLAN-MIB?
CISCO-WAN-VISM-TONE-PLAN-MIB is a Cisco-proprietary MIB for the Voice Interworking Service Module (VISM), a Cisco WAN switching card used for voice-over-IP and voice-over-ATM trunking. It exposes configuration objects for the programmable "tone plan" feature, which defines country/region-specific telephony tones (dial tone, busy tone, ringback, etc.) that the VISM card generates. Its relevance to hardware/software status monitoring is centered on configuration/provisioning state—tracking which tone plan file and region is currently loaded, its version, and whether provisioning is complete—rather than classic hardware health counters like temperature or power. It is used alongside other Cisco WAN VISM MIBs (such as the RTP connection and announcement MIBs) since all describe features of the same VISM media gateway card. CISCO-WAN-VISM-TONE-PLAN-MIB SNMP monitoring is typically deployed on Cisco WAN switching platforms (e.g., MGX 8000 series) equipped with VISM cards providing PSTN/VoIP trunking in carrier or enterprise telephony networks.
IPNetwork Monitor allows you to monitor SNMP objects defined in CISCO-WAN-VISM-TONE-PLAN-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.
What Can Be Monitored
- active tone plan region and version
- tone plan provisioning/file status
- tone plan file size vs. expected
- tone detection channel configuration
Supported Devices
- Cisco WAN switching platforms with VISM (Voice Interworking Service Module) cards, e.g. Cisco MGX 8000 series
Monitoring Examples
An administrator would poll vismTonePlanTable/vismTonePlanEntry, indexed by tonePlanIndex, to check tonePlanRegionName, tonePlanVersionNumber, and tonePlanEntryStatus to confirm the correct country tone plan file is provisioned and active. A tonePlanProvisionFlag stuck in a non-ready state, or a mismatch in tonePlanCurrentSize versus the expected file size, would indicate a failed or incomplete tone plan upload. The related vismConfigToneDetectTable/vismConfigToneDetectNum objects would be checked to confirm tone-detection channels are correctly configured for that region.
OIDs
| OID symbolic | OID numeric | Type | Access | Description |
|---|---|---|---|---|
| vismTonePlanGrpMIB | 1.3.6.1.4.1.351.150.24 | The MIB module is defined to configure the programmable Tone Plan feature on VISM. | ||
| vismTonePlanGrpMIBObjects | 1.3.6.1.4.1.351.150.24.1 | |||
| vismTonePlan | 1.3.6.1.4.1.351.150.24.1.1 | |||
| vismTonePlanControlGrp | 1.3.6.1.4.1.351.150.24.1.1.1 | |||
| I32 tonePlanCurrentSize | 1.3.6.1.4.1.351.150.24.1.1.1.1 | Integer32 | read-only | This object specifies the number of entries in vismTonePlanTable. |
| vismTonePlanTableGrp | 1.3.6.1.4.1.351.150.24.1.1.2 | |||
| vismTonePlanTable | 1.3.6.1.4.1.351.150.24.1.1.2.1 | not-accessible | This table contains configuration information about different Tone Plans. The first 32 entries of the table are 'provisionable' followed by an implementation specific number of 'builtIn' entries. | |
| vismTonePlanEntry | 1.3.6.1.4.1.351.150.24.1.1.2.1.1 | not-accessible | An entry in the vismTonePlanTable. Each entry consists of configuration information for a specific Tone Plan. The vismTonePlanTable is of fixed size with a predefined number of entries, where each entry contains usable information or not depending upon the value of the tonePlanEntryStatus MIB object. The configuration is retained after VISM card reboots. tonePlanRegionName, tonePlanVersionNumber, and tonePlanFileName can be modified only if the tonePlanProvisionFlag is 'provisionable' and tonePlanEntryStatus is 'configured' when loading a new tone plan (see MIB object tonePlanEntryStatus below). After the new tone plan is loaded, these three MIB objects may not be modified. To change these objects, the entry in this table must be deleted, and all objects re-added with new corrected values. The rest of the entries of this table, (the 'builtIn' ones) cannot be modified after the table is build at reload time. | |
| I32 tonePlanIndex | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.1 | Integer32 | not-accessible | Serves as index to this table. However, the maximum entry allowed is specify in tonePlanCurrentSize. |
| INT tonePlanEntryStatus | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.2 | INTEGER | read-write | This attribute specifies the status of this entry as to whether this entry (row) contains usable Tone Plan configuration information (object is set to 'configured'), or if it is empty (object is set to 'unused'), or if is temporarily (object is set to 'reloading') or permanently (object is set to 'lostFile') unusable. This tone plan information for this row can be used by a DS-1 line only if this object has a value of 'configured (2)'. To add a configured entry in the vismTonePlanTable table, there must be an existing empty row with its entry status set to 'unused(1)'. Then before this empty row in the vismTonePlanTable table can be changed to 'configured', it must, in one single operation, be given all the usable values necessary to be stored in the tonePlanRegionName, tonePlanVersionNumber and tonePlanFileName MIB objects for this row. In addition, those values for the tonePlanRegionName and tonePlanVersionNumber MIB objects pair must be unique with respect to every other row of the vismTonePlanTable. Then, as this existing empty row is set with all three valid entries for the tonePlanRegionName, tonePlanVersionNumber, and tonePlanFileName MIB objects, the Entry Status MIB object for this row will be finally, internally, set to 'configured(2)'. This final 'configured' status is the direct result of correctly setting these three MIB objects with valid data. In no case will an external manager be able to directly set this MIB object to 'configured(2)' by a SNMP set command, for such a single stand alone command will be rejected. Once a table entry is set to 'configured(2)' with valid tonePlanRegionName, tonePlanVersionNumber, and tonePlanFileName MIB objects for this row, then these MIB objects may not be modified by any subsequent SNMP set command. In the case where a row needs to have these objects changed, this entry must be cleared from the table (paragraph below) and a new entry added by the add process above. Once an entry exists in the vismTonePlanTable table it may be cleared and set to unused by setting this MIB object to 'unused(1)'. But before the entry status of any entry in this table can be set to 'unused(1)', there is a check to make sure there is no vismDsx1TonePlanRegion MIB object and vismDsx1TonePlanVersion MIB object pair in the dsx1VismCnfGrpTable MIB table that may point to or refer to this table entry (row) with its unique tonePlanRegionName and tonePlanVersionNumber. Once the entry status of an entry in this table is set to 'unused(1)', all the other MIB objects for this table row are set to defaults or to NULL. Once an entry is 'configured', if a subsequent card reset occurs the VISM card will attempt to restore all of the configuration information by doing the normal download of the latest MIB database, set all 'configured (2)' MIB objects to 'reloading (3)', and then do an automatic background process to retrieve all of the tone plan files from the server since they were not downloaded by the PXM. If this retrieval of the tone plan files succeeds then this MIB object will be set back to 'configured (2)'. If this file retrieval does not succeed, then this MIB object will be set to 'lostFile (4)'. In no way will an external manager be able to directly set this MIB object to 'reloading (3)' or 'lostFile (4)' by a SNMP set command. |
| INT tonePlanProvisionFlag | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.3 | INTEGER | read-only | This attribute specifies whether this entry contains predefined Tone Plan configuration information from internal firmware code (object is set to 'builtIn') or if it has been configured with tone plan configuration information that has been downloaded from the PXM (object is set to unused). Only entries that are provisionable may have their tonePlanEntryStatus MIB object marked as unused in this table. BuiltIn entries may not be marked as unused. |
| STR tonePlanRegionName | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.4 | DisplayString | read-write | The region (or country) for which this tone plan is defined. Any other entry in this table may have an identical name, but the combination of tonePlanRegionName and tonePlanVersionNumber must be unique. This field may be from 1 to 64 alphabetic, numeric, or underscore characters long, with no embedded spaces. A NULL entry will consist of a single space character of length one. |
| I32 tonePlanVersionNumber | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.5 | Integer32 | read-write | This attribute specifies this entry's version number for a tone plan for a region. Multiple tone plans may be defined for each region, but each of these tone plans must have a unique tonePlanRegionName and tonePlanVersionNumber. When a new tone plan is added for a region, it should be added with a newer(larger) version number. Allowed values are in range (1..65535) but a value of zero being set in this object means that this object is a NULL entry. |
| STR tonePlanFileName | 1.3.6.1.4.1.351.150.24.1.1.2.1.1.6 | DisplayString | read-write | This is the name of a valid file stored on the TFTP server which contains the tone definitions. A missing or invalid file name will cause a failure in the configuration of this entry. If this entry points to a build-in tone plan predefined in firmware, then this name will be: 'BUILTIN'. Provisionable file names are not allowed to have the string 'BUILTIN' as their names. This field may be from 1 to 32 alphabetic, numeric, or underscore characters (no embedded spaces) long for a valid entry. A NULL entry will consist of a single space character of length one. |
| vismConfigToneDetectGrp | 1.3.6.1.4.1.351.150.24.1.1.3 | |||
| vismConfigToneDetectTable | 1.3.6.1.4.1.351.150.24.1.1.3.1 | not-accessible | This table contains the list of user configurable dual frequency tones that can be detected on VISM. The call agent can request the VISM to detect any of the tones defined in this table. Entries to this table can only be added or deleted, not modified. Individual parameters within a row cannot be changed without deleting and re-adding the entry. | |
| vismConfigToneDetectEntry | 1.3.6.1.4.1.351.150.24.1.1.3.1.1 | not-accessible | This is the primary entry in the vismConfigToneDetectTable. Each entry references a User configurable dual frequency tones that can be detected on VISM. | |
| I32 vismConfigToneDetectNum | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.1 | Integer32 | read-only | This is the index of this table. Currently only tones 1 to 10 are used and call agent can request up to ten tones to be detected on different endpoints at any point in time. |
| I32 vismEventCode | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.2 | Integer32 | read-create | This is the secondary index of this table. Call agent can request supervision tone detection indexed by this field. The values of event code are mapped from the subscriber line event codes defined in RFC2833. Currently VISM supports detection of only a handful of supervision tones like Ringing, Busy, Dial-Tone and SIT tones. |
| ROW vismConfigToneDetectRowStatus | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.3 | RowStatus | read-create | Controls the creation and deletion of a Config Tone. An entry may be created using the 'createAndGo' option. When the row is successfully created, the vismConfigToneDetectRowStatus would be set to 'active' by the agent. An entry may be deleted by setting the vismConfigToneDetectRowStatus to 'destroy'. |
| I32 vismFreqMaxDeviation | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.4 | Integer32 | read-create | Specifies the maximum frequency deviation to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismFreqMaxPower | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.5 | Integer32 | read-create | Specifies the maximum frequency power to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismFreqMinPower | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.6 | Integer32 | read-create | Specifies the minimum frequency power to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismFreqPowerTwist | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.7 | Integer32 | read-create | Specifies the maximum frequency power twist permitted between the two frequencies used by VISM when detecting a dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismFreqMaxDelay | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.8 | Integer32 | read-create | Specifies the maximum frequency delay to be used by VISM when detecting a dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. It is measured in units of 10ms. |
| I32 vismMinOnCadence | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.9 | Integer32 | read-create | Specifies the minimum tone cycle ON time that is necessary for the VISM to detect the dual frequency tone. The vismMinOnCadence has to be less than vismFreqOnCadence value. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismMaxOffCadence | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.10 | Integer32 | read-create | Specifies the maximum tone cycle OFF time that is necessary for the VISM to detect the dual frequency tone. The vismMaxOffCadence should be greater than vismFreqOffCadence value. Please refer the VISM configuration guide for standard values to be used for this field. |
| I32 vismFreqNumOfCadenceMatch | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.11 | Integer32 | read-create | Specifies the number of pairs of the dual frequency that needs to be detected. Currently ten pairs of frequency can be detected by the DSP. |
| I32 vismFrequency1 | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.12 | Integer32 | read-create | Specifies the 1st frequency component of the dual frequency to be detected by the VISM. |
| I32 vismFrequency2 | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.13 | Integer32 | read-create | Specifies the 2nd frequency component of the dual frequency to be detected by the DSP. A value of 0 means this is a single frequency. The range of 1 to 279 is not a valid range in the DSP. |
| I32 vismFreqOnCadence | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.14 | Integer32 | read-create | The On time in each cycle of the dual frequency to be detected by the DSP. The vismFreqOnCadence has to be less than vismMinOnCadence value. It is measured in units of 10ms. |
| I32 vismFreqOffCadence | 1.3.6.1.4.1.351.150.24.1.1.3.1.1.15 | Integer32 | read-create | The Off time in each cycle of the dual frequency to be detected by the DSP. The vismFreqOffCadence should be lesser than the vismMaxOffCadence value. It is measured in units of 10ms. |
| vismSequentialToneDetectGrp | 1.3.6.1.4.1.351.150.24.1.1.4 | |||
| I32 seqToneNumOfFrequencies | 1.3.6.1.4.1.351.150.24.1.1.4.1 | Integer32 | read-write | The number of single frequencies which have to be detected by the sequential tone detector command on VISM. The frequencies should specified below (seqToneFrequency1 to seqToneFrequency10). This number should correspond to the non-zero frequency values seqToneFrequency1 to seqToneFrequency10. |
| I32 seqToneEventID | 1.3.6.1.4.1.351.150.24.1.1.4.2 | Integer32 | read-write | The eventID corresponding to the sequential frequency. Currently only supports Event 74 (SIT tone) |
| I32 seqToneDurationOfEachTone | 1.3.6.1.4.1.351.150.24.1.1.4.3 | Integer32 | read-write | Nominal tone duration of each single tone in counts of 10ms used with sequential tone detector on VISM DSP. |
| I32 seqToneGapBetweenEachTone | 1.3.6.1.4.1.351.150.24.1.1.4.4 | Integer32 | read-write | Nominal silence gap duration between each tone in 10ms used with sequential tone detector on VISM DSP. |
| I32 seqToneDurationDeviation | 1.3.6.1.4.1.351.150.24.1.1.4.5 | Integer32 | read-write | Tone duration deviation allowed in 10ms used with sequential tone detector on VISM DSP. |
| I32 seqToneMaximumGapDuration | 1.3.6.1.4.1.351.150.24.1.1.4.6 | Integer32 | read-write | Maximum tone duration allowed in 10ms used with sequential tone detector on VISM DSP. |
| I32 seqToneGapDurationDeviation | 1.3.6.1.4.1.351.150.24.1.1.4.7 | Integer32 | read-write | Tone duration deviation allowed in 10ms used with sequential tone detector on VISM DSP. |
| I32 seqToneFreqDeviation | 1.3.6.1.4.1.351.150.24.1.1.4.8 | Integer32 | read-write | Frequency deviation allowed (1 - 1000 Hz) used with sequential tone detector on VISM DSP. |
| I32 seqTonePowerLevelCeiling | 1.3.6.1.4.1.351.150.24.1.1.4.9 | Integer32 | read-write | Maximum ceiling power level of the sequential frequency tone (absolute value in dBm) used with sequential tone detector on VISM DSP. Range from 0 to 40 (0 to -40dB) |
| I32 seqTonePowerLevelFloor | 1.3.6.1.4.1.351.150.24.1.1.4.10 | Integer32 | read-write | Lowest (floor) power level of the sequential frequency tone (absolute value in dBm) used with sequential tone detector on VISM DSP. Range from 0 to 40 (0 to -40dB) |
| I32 seqToneFrequency1 | 1.3.6.1.4.1.351.150.24.1.1.4.11 | Integer32 | read-write | 1st frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency2 | 1.3.6.1.4.1.351.150.24.1.1.4.12 | Integer32 | read-write | 2nd frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency3 | 1.3.6.1.4.1.351.150.24.1.1.4.13 | Integer32 | read-write | 3rd frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency4 | 1.3.6.1.4.1.351.150.24.1.1.4.14 | Integer32 | read-write | 4th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency5 | 1.3.6.1.4.1.351.150.24.1.1.4.15 | Integer32 | read-write | 5th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency6 | 1.3.6.1.4.1.351.150.24.1.1.4.16 | Integer32 | read-write | 6th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency7 | 1.3.6.1.4.1.351.150.24.1.1.4.17 | Integer32 | read-write | 7th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency8 | 1.3.6.1.4.1.351.150.24.1.1.4.18 | Integer32 | read-write | 8th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency9 | 1.3.6.1.4.1.351.150.24.1.1.4.19 | Integer32 | read-write | 9th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| I32 seqToneFrequency10 | 1.3.6.1.4.1.351.150.24.1.1.4.20 | Integer32 | read-write | 10th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP. |
| vismToneNotificationPrefix | 1.3.6.1.4.1.351.150.24.2 | |||
| vismToneNotifications | 1.3.6.1.4.1.351.150.24.2.0 | |||
| vismTonePlanMIBConformance | 1.3.6.1.4.1.351.150.24.3 | |||
| vismTonePlanMIBCompliances | 1.3.6.1.4.1.351.150.24.3.1 | |||
| vismTonePlanMIBCompliance | 1.3.6.1.4.1.351.150.24.3.1.1 | The complaince statement for VISM Tone Plan group which implements vismTonePlanGrp MIB. | ||
| vismTonePlanMIBGroups | 1.3.6.1.4.1.351.150.24.3.2 | |||
| vismTonePlanControlGroup | 1.3.6.1.4.1.351.150.24.3.2.1 | This group contains objects related to control of VISM Tone Plan Table. | ||
| vismTonePlanTableGroup | 1.3.6.1.4.1.351.150.24.3.2.2 | This group contains objects related to configuration of VISM Tone Plan. | ||
| vismConfigToneDetectTableGroup | 1.3.6.1.4.1.351.150.24.3.2.3 | This group contains objects related to configuration of VISM dual frequency detect tones. | ||
| vismSequentialToneDetectGroup | 1.3.6.1.4.1.351.150.24.3.2.4 | This group contains objects related to configuration of VISM sequential single frequency tone detection. |
RFC description
Cisco WAN MIB defining tone plan management objects for Voice over IP Signaling Module (VISM) devices for tone generation and detection configuration.
Start monitoring Cisco MGX WAN switches with VISM (Voice Interworking Service Module) cards (legacy) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.