CISCO-WAN-VISM-TONE-PLAN-MIB

File: CISCO-WAN-VISM-TONE-PLAN-MIB.mib (36780 bytes)

Imported modules

SNMPv2-SMI SNMPv2-CONF SNMPv2-TC
CISCOWAN-SMI

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Integer32
MODULE-COMPLIANCE OBJECT-GROUP DisplayString
RowStatus ciscoWan

Defined Types

VismTonePlanEntry  
SEQUENCE    
  tonePlanIndex Integer32
  tonePlanEntryStatus INTEGER
  tonePlanProvisionFlag INTEGER
  tonePlanRegionName DisplayString
  tonePlanVersionNumber Integer32
  tonePlanFileName DisplayString

VismConfigToneDetectEntry  
SEQUENCE    
  vismConfigToneDetectNum Integer32
  vismEventCode Integer32
  vismConfigToneDetectRowStatus RowStatus
  vismFreqMaxDeviation Integer32
  vismFreqMaxPower Integer32
  vismFreqMinPower Integer32
  vismFreqPowerTwist Integer32
  vismFreqMaxDelay Integer32
  vismMinOnCadence Integer32
  vismMaxOffCadence Integer32
  vismFreqNumOfCadenceMatch Integer32
  vismFrequency1 Integer32
  vismFrequency2 Integer32
  vismFreqOnCadence Integer32
  vismFreqOffCadence Integer32

Defined Values

vismTonePlanGrpMIB 1.3.6.1.4.1.351.150.24
The MIB module is defined to configure the programmable Tone Plan feature on VISM.
MODULE-IDENTITY    

vismTonePlanGrpMIBObjects 1.3.6.1.4.1.351.150.24.1
OBJECT IDENTIFIER    

vismTonePlan 1.3.6.1.4.1.351.150.24.1.1
OBJECT IDENTIFIER    

vismTonePlanControlGrp 1.3.6.1.4.1.351.150.24.1.1.1
OBJECT IDENTIFIER    

vismTonePlanTableGrp 1.3.6.1.4.1.351.150.24.1.1.2
OBJECT IDENTIFIER    

vismConfigToneDetectGrp 1.3.6.1.4.1.351.150.24.1.1.3
OBJECT IDENTIFIER    

vismSequentialToneDetectGrp 1.3.6.1.4.1.351.150.24.1.1.4
OBJECT IDENTIFIER    

tonePlanCurrentSize 1.3.6.1.4.1.351.150.24.1.1.1.1
This object specifies the number of entries in vismTonePlanTable.
OBJECT-TYPE    
  Integer32  

vismTonePlanTable 1.3.6.1.4.1.351.150.24.1.1.2.1
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.
OBJECT-TYPE    
  SEQUENCE OF  
    VismTonePlanEntry

vismTonePlanEntry 1.3.6.1.4.1.351.150.24.1.1.2.1.1
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.
OBJECT-TYPE    
  VismTonePlanEntry  

tonePlanIndex 1.3.6.1.4.1.351.150.24.1.1.2.1.1.1
Serves as index to this table. However, the maximum entry allowed is specify in tonePlanCurrentSize.
OBJECT-TYPE    
  Integer32 1..1000  

tonePlanEntryStatus 1.3.6.1.4.1.351.150.24.1.1.2.1.1.2
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.
OBJECT-TYPE    
  INTEGER unused(1), configured(2), reloading(3), lostFile(4)  

tonePlanProvisionFlag 1.3.6.1.4.1.351.150.24.1.1.2.1.1.3
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.
OBJECT-TYPE    
  INTEGER builtIn(1), provisionable(2)  

tonePlanRegionName 1.3.6.1.4.1.351.150.24.1.1.2.1.1.4
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.
OBJECT-TYPE    
  DisplayString Size(1..64)  

tonePlanVersionNumber 1.3.6.1.4.1.351.150.24.1.1.2.1.1.5
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.
OBJECT-TYPE    
  Integer32 0..65535  

tonePlanFileName 1.3.6.1.4.1.351.150.24.1.1.2.1.1.6
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.
OBJECT-TYPE    
  DisplayString Size(1..32)  

vismConfigToneDetectTable 1.3.6.1.4.1.351.150.24.1.1.3.1
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.
OBJECT-TYPE    
  SEQUENCE OF  
    VismConfigToneDetectEntry

vismConfigToneDetectEntry 1.3.6.1.4.1.351.150.24.1.1.3.1.1
This is the primary entry in the vismConfigToneDetectTable. Each entry references a User configurable dual frequency tones that can be detected on VISM.
OBJECT-TYPE    
  VismConfigToneDetectEntry  

vismConfigToneDetectNum 1.3.6.1.4.1.351.150.24.1.1.3.1.1.1
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.
OBJECT-TYPE    
  Integer32 1..10  

vismEventCode 1.3.6.1.4.1.351.150.24.1.1.3.1.1.2
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.
OBJECT-TYPE    
  Integer32 0..255  

vismConfigToneDetectRowStatus 1.3.6.1.4.1.351.150.24.1.1.3.1.1.3
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'.
OBJECT-TYPE    
  RowStatus  

vismFreqMaxDeviation 1.3.6.1.4.1.351.150.24.1.1.3.1.1.4
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.
OBJECT-TYPE    
  Integer32 10..125  

vismFreqMaxPower 1.3.6.1.4.1.351.150.24.1.1.3.1.1.5
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.
OBJECT-TYPE    
  Integer32 0..30  

vismFreqMinPower 1.3.6.1.4.1.351.150.24.1.1.3.1.1.6
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.
OBJECT-TYPE    
  Integer32 10..35  

vismFreqPowerTwist 1.3.6.1.4.1.351.150.24.1.1.3.1.1.7
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.
OBJECT-TYPE    
  Integer32 0..15  

vismFreqMaxDelay 1.3.6.1.4.1.351.150.24.1.1.3.1.1.8
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.
OBJECT-TYPE    
  Integer32 0..100  

vismMinOnCadence 1.3.6.1.4.1.351.150.24.1.1.3.1.1.9
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.
OBJECT-TYPE    
  Integer32 3..100  

vismMaxOffCadence 1.3.6.1.4.1.351.150.24.1.1.3.1.1.10
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.
OBJECT-TYPE    
  Integer32 5..5000  

vismFreqNumOfCadenceMatch 1.3.6.1.4.1.351.150.24.1.1.3.1.1.11
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.
OBJECT-TYPE    
  Integer32 0..6  

vismFrequency1 1.3.6.1.4.1.351.150.24.1.1.3.1.1.12
Specifies the 1st frequency component of the dual frequency to be detected by the VISM.
OBJECT-TYPE    
  Integer32 280..3800  

vismFrequency2 1.3.6.1.4.1.351.150.24.1.1.3.1.1.13
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.
OBJECT-TYPE    
  Integer32 0..3800  

vismFreqOnCadence 1.3.6.1.4.1.351.150.24.1.1.3.1.1.14
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.
OBJECT-TYPE    
  Integer32 3..5000  

vismFreqOffCadence 1.3.6.1.4.1.351.150.24.1.1.3.1.1.15
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.
OBJECT-TYPE    
  Integer32 5..5000  

seqToneNumOfFrequencies 1.3.6.1.4.1.351.150.24.1.1.4.1
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.
OBJECT-TYPE    
  Integer32 1..10  

seqToneEventID 1.3.6.1.4.1.351.150.24.1.1.4.2
The eventID corresponding to the sequential frequency. Currently only supports Event 74 (SIT tone)
OBJECT-TYPE    
  Integer32 0..255  

seqToneDurationOfEachTone 1.3.6.1.4.1.351.150.24.1.1.4.3
Nominal tone duration of each single tone in counts of 10ms used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..65534  

seqToneGapBetweenEachTone 1.3.6.1.4.1.351.150.24.1.1.4.4
Nominal silence gap duration between each tone in 10ms used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..65534  

seqToneDurationDeviation 1.3.6.1.4.1.351.150.24.1.1.4.5
Tone duration deviation allowed in 10ms used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..4095  

seqToneMaximumGapDuration 1.3.6.1.4.1.351.150.24.1.1.4.6
Maximum tone duration allowed in 10ms used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..4095  

seqToneGapDurationDeviation 1.3.6.1.4.1.351.150.24.1.1.4.7
Tone duration deviation allowed in 10ms used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..4095  

seqToneFreqDeviation 1.3.6.1.4.1.351.150.24.1.1.4.8
Frequency deviation allowed (1 - 1000 Hz) used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 1..1000  

seqTonePowerLevelCeiling 1.3.6.1.4.1.351.150.24.1.1.4.9
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)
OBJECT-TYPE    
  Integer32 0..40  

seqTonePowerLevelFloor 1.3.6.1.4.1.351.150.24.1.1.4.10
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)
OBJECT-TYPE    
  Integer32 0..40  

seqToneFrequency1 1.3.6.1.4.1.351.150.24.1.1.4.11
1st frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency2 1.3.6.1.4.1.351.150.24.1.1.4.12
2nd frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency3 1.3.6.1.4.1.351.150.24.1.1.4.13
3rd frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency4 1.3.6.1.4.1.351.150.24.1.1.4.14
4th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency5 1.3.6.1.4.1.351.150.24.1.1.4.15
5th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency6 1.3.6.1.4.1.351.150.24.1.1.4.16
6th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency7 1.3.6.1.4.1.351.150.24.1.1.4.17
7th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency8 1.3.6.1.4.1.351.150.24.1.1.4.18
8th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency9 1.3.6.1.4.1.351.150.24.1.1.4.19
9th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

seqToneFrequency10 1.3.6.1.4.1.351.150.24.1.1.4.20
10th frequency in the SequentialTone to detect (280 - 3800), used with sequential tone detector on VISM DSP.
OBJECT-TYPE    
  Integer32 280..3800  

vismToneNotificationPrefix 1.3.6.1.4.1.351.150.24.2
OBJECT IDENTIFIER    

vismToneNotifications 1.3.6.1.4.1.351.150.24.2.0
OBJECT IDENTIFIER    

vismTonePlanMIBConformance 1.3.6.1.4.1.351.150.24.3
OBJECT IDENTIFIER    

vismTonePlanMIBCompliances 1.3.6.1.4.1.351.150.24.3.1
OBJECT IDENTIFIER    

vismTonePlanMIBGroups 1.3.6.1.4.1.351.150.24.3.2
OBJECT IDENTIFIER    

vismTonePlanMIBCompliance 1.3.6.1.4.1.351.150.24.3.1.1
Only three values 'createAndGo', 'destroy' and 'active' out of the six enumerated values need to be supported.
MODULE-COMPLIANCE    
  vismConfigToneDetectRowStatus INTEGER active(1), createAndGo(4), destroy(6)

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.
OBJECT-GROUP    

vismTonePlanTableGroup 1.3.6.1.4.1.351.150.24.3.2.2
This group contains objects related to configuration of VISM Tone Plan.
OBJECT-GROUP    

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.
OBJECT-GROUP    

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.
OBJECT-GROUP