CISCO-VOICE-TONE-CADENCE-MIB

File: CISCO-VOICE-TONE-CADENCE-MIB.mib (22185 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMP-FRAMEWORK-MIB
SNMPv2-CONF CISCO-MEDIA-GATEWAY-MIB CISCO-TC
CISCO-SMI

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
Gauge32 RowStatus StorageType
TEXTUAL-CONVENTION SnmpAdminString MODULE-COMPLIANCE
OBJECT-GROUP cmgwIndex CVoiceTonePlanIndex
CountryCode ciscoMgmt

Defined Types

CToneFrequency  
This Textual Convention defines frequency of the programmable tone to be played or detected. The format of frequency of the programmable tone is based on ITU E.180 Supplement 2. The frequency octet string is a combination of Frequency Expression, frequency conjuncture and frequency delimiter. Frequency Expression - The frequency expression is a single numeric value or a string of numeric values with the notation '+' or '/'. The numeric values are the frequency's decimal values in Hz. '+' - frequency conjuncture. The Frequency Expression to the left and to the right of this notation are emitted simultaneously. '/' - frequency delimiter. The Frequency Expression to the left of this notation is emitted before the Frequency Expression to the right. For example, the Payphone Recognition Tone of Australia is '1100+1750/750+1450', which means frequency 1100Hz and 1750Hz are emitted simultaneously, stopped for a period of time, followed by the simultaneously emission of 750Hz and 1450Hz.
TEXTUAL-CONVENTION    
  OCTET STRING Size(1..64)  

CToneAmplitude  
This Textual Convention defines amplitude expression of the programmable tone to be played or detected. This textual convention is a combination of Amplitude Expression, Amplitude conjuncture and Amplitude delimiter. Amplitude Expression - The amplitude expression is a single numeric value or a string of numeric values with the notation '+' or '/'. The numeric values are the amplitude's decimal values in dBm. The numeric values are usually negative. '+' - Amplitude conjuncture. The Amplitude Expression to the left and to the right of this notation are emitted simultaneously. The Amplitude Expression preceded this notation is the amplitude expression of the Frequency Expression preceded '+'. The Amplitude Expression followed this notation is the amplitude expression of the Frequency Expression followed '+'. '/' - Amplitude delimiter. The Amplitude Expression to the left of this notation is emitted before the Amplitude Expression to the right. The Amplitude Expression preceded this notation is the amplitude expression of the Frequency Expression preceded '/'. The Amplitude Expression followed this notation is the amplitude expression of the Frequency Expression followed '/'. For example, the amplitude of USA Recall Dial Tone is '-10+-10' and the frequency is '350+440'. It means amplitude of the both frequencies 350Hz and 440Hz are emitted simultaneously, each with amplitude expression -10 dBm.
TEXTUAL-CONVENTION    
  OCTET STRING Size(2..64)  

CToneCadence  
This Textual Convention defines cadence of the programmable tone to be played or detected. The format of cadence of the programmable tone is based on ITU E.180 Supplement 2. Cadence string consists of cadence units, digits, keywords and special characters. Cadence Units are digits where each unit is one second. No space is allowed in the cadence string. The keywords are 'on', 'off', 'CYCLES' and 'CONTINUOUS'. The special characters are '-', '*', '(', ')' and ','. 'on' - The number preceded this keyword is the duration of emission in second. 'off' - The number preceded this keyword is the duration of absence in second. 'CONTINUOUS' - The frequencies are sent out and stayed on indefinitely. An on-off Period is either the keyword 'CONTINUOUS' or a Cadence Unit followed by the keyword 'ON' or 'OFF'. '-' - Separator. It separates multiple on-off Periods. A Cadence List is a sequence of on-off Periods separated by the special character '-'. 'CYCLES' - When preceded by special character ',' and a number X, the Cadence List before the special character ',' is repeated X times. Cadence List - The parentheses are delimiters. It is used for the repetition. The entire Cadence List in the parentheses is to be repeated. Without the delimiter, only the first On-off Period is repeated. '*' - Repetition. When preceded by a number X, the On-off Period or the parenthesized Cadence List is to be repeated X times. ',' - Terminator. It terminates a Cadence List and announces the presence of the keyword, 'CYCLES'. When followed by a number X and then the keyword 'CYCLES', the preceded Cadence List is repeated X times For example, in United States, the cadence of confirmation tone is '3*100on-2*100off', the cadence of dial tone is '3*(100on-100off)-CONTINUOUS'. In United Kingdom, the cadence of payphone tone is '200on-200off-200on-200off'. Any thing other then the above notation is not supported.
TEXTUAL-CONVENTION    
  OCTET STRING Size(3..64)  

CvtcTonePlanEntry  
SEQUENCE    
  cvtcTonePlanId CVoiceTonePlanIndex
  cvtcTonePlanVifCount Gauge32
  cvtcTonePlanCountry CountryCode
  cvtcTonePlanVersion Unsigned32
  cvtcTonePlanFileName SnmpAdminString
  cvtcTonePlanStorageType StorageType
  cvtcTonePlanRowStatus RowStatus

CvtcToneIdEntry  
SEQUENCE    
  cvtcToneId Unsigned32
  cvtcToneName SnmpAdminString
  cvtcToneIdRowStatus RowStatus

CvtcProgrammableToneEntry  
SEQUENCE    
  cvtcProgrammableToneFrequency CToneFrequency
  cvtcProgrammableToneAmplitude CToneAmplitude
  cvtcProgrammableToneCadence CToneCadence
  cvtcProgrammableToneDuration Unsigned32
  cvtcProgrammableToneStorageType StorageType
  cvtcProgrammableToneRowStatus RowStatus

Defined Values

ciscoVoiceToneCadenceMIB 1.3.6.1.4.1.9.9.356
The MIB defines the attributes of the programmable tones specified in ITU-T E.180 Supplement 2. Each country has its own regulation to the generation and detection of the call progressing tones such as dial tone, busy tone, ring back tone. The tone attributes are programmable, for example frequency, amplitude, cadence and duration of the tone.
MODULE-IDENTITY    

ciscoVoiceToneCadenceMIBNotifs 1.3.6.1.4.1.9.9.356.0
OBJECT IDENTIFIER    

ciscoVoiceToneCadenceMIBObjects 1.3.6.1.4.1.9.9.356.1
OBJECT IDENTIFIER    

cVoiceToneCadenceConfig 1.3.6.1.4.1.9.9.356.1.1
OBJECT IDENTIFIER    

cvtcTonePlanTable 1.3.6.1.4.1.9.9.356.1.1.1
This table contains the configuration of tone plans for the programmable tones in different countries.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    CvtcTonePlanEntry

cvtcTonePlanEntry 1.3.6.1.4.1.9.9.356.1.1.1.1
An entry represents one tone plan which defines attributes of the programmable tones for a country. Each country can have more than one tone plans with different version. Each entry should have the unique combination of cvtcTonePlanCountry and cvtcTonePlanVersion. There are some system built-in tone plans. The built-in tone plans will be populated by the system automatically at the system start-up. They can not be created, deleted or modified by user. When an entry is created, the following objects must be provided: cvtcTonePlanCountry, cvtcTonePlanVersion, cvtcTonePlanFileName When an entry is active, it can not be modified. A system built-in tone plan can not be deleted. Only the entries added by user can be deleted.
Status: current Access: not-accessible
OBJECT-TYPE    
  CvtcTonePlanEntry  

cvtcTonePlanId 1.3.6.1.4.1.9.9.356.1.1.1.1.1
This object uniquely identifies the tone plan in the table.
Status: current Access: not-accessible
OBJECT-TYPE    
  CVoiceTonePlanIndex  

cvtcTonePlanVifCount 1.3.6.1.4.1.9.9.356.1.1.1.1.2
This object indicates the number of voice interfaces are using the tone plan.
Status: current Access: read-only
OBJECT-TYPE    
  Gauge32  

cvtcTonePlanCountry 1.3.6.1.4.1.9.9.356.1.1.1.1.3
This object specifies the country code (defined in ISO-3166) of the country that the tone plan is used for. The country specified by the country code should be registered in ITU E.180 Supplement 2. Any other entry in this table may have the identical country code, but the combination of cvtcTonePlanCountry and cvtcTonePlanVersion must be unique.
Status: current Access: read-create
OBJECT-TYPE    
  CountryCode  

cvtcTonePlanVersion 1.3.6.1.4.1.9.9.356.1.1.1.1.4
This object specifies the version of the tone plan for a country. One country may have many tone plans, therefore they may have the same country name, but the combination of cvtcTonePlanCountry and cvtcTonePlanVersion must be unique.
Status: current Access: read-create
OBJECT-TYPE    
  Unsigned32 0..100  

cvtcTonePlanFileName 1.3.6.1.4.1.9.9.356.1.1.1.1.5
This object specifies the valid file name stored on the media gateway's harddisk. The tone plan file can be transferred to the media gateway via FTP text file transfer mechanism. When creating a conceptual row, the tone plan file must be transferred to the media gateway already. If the entry is a built-in tone plan predefined in system, then this object will have the value of 'BUILT-IN'. Other provision-able tone plan files are not allowed to have the string 'BUILT-IN' as their names.
Status: current Access: read-create
OBJECT-TYPE    
  SnmpAdminString Size(1..64)  

cvtcTonePlanStorageType 1.3.6.1.4.1.9.9.356.1.1.1.1.6
This object specifies the storage type for this conceptual row. If this conceptual row represents a system built-in tone plan, the value of this object is readOnly (5). If this conceptual row represents an user defined tone plan, the value of this object is nonVolatile (3). The built-in tone plans will be added by the system automatically at the system start-up. They can not be added, deleted or modified by user.
Status: current Access: read-only
OBJECT-TYPE    
  StorageType  

cvtcTonePlanRowStatus 1.3.6.1.4.1.9.9.356.1.1.1.1.7
The entries for The system built-in tone plans will be added by the system at start-up, they can not be added, modified or deleted by user.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

cvtcToneIdTable 1.3.6.1.4.1.9.9.356.1.1.2
This table contains the identification of the programmable tones.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    CvtcToneIdEntry

cvtcToneIdEntry 1.3.6.1.4.1.9.9.356.1.1.2.1
An entry represents the identification for one programmable tone in a tone plan.
Status: current Access: not-accessible
OBJECT-TYPE    
  CvtcToneIdEntry  

cvtcToneId 1.3.6.1.4.1.9.9.356.1.1.2.1.1
This object uniquely identifies the programmable tone in a tone plan.
Status: current Access: not-accessible
OBJECT-TYPE    
  Unsigned32 1..65535  

cvtcToneName 1.3.6.1.4.1.9.9.356.1.1.2.1.2
This object specified the name of the programmable tone.
Status: current Access: read-create
OBJECT-TYPE    
  SnmpAdminString Size(1..64)  

cvtcToneIdRowStatus 1.3.6.1.4.1.9.9.356.1.1.2.1.3
The entries for ITU defined tones will be added by the system at start-up.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

cvtcProgrammableToneTable 1.3.6.1.4.1.9.9.356.1.1.3
This table contains the configurable attributes of the programmable tones for tone plan.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    CvtcProgrammableToneEntry

cvtcProgrammableToneEntry 1.3.6.1.4.1.9.9.356.1.1.3.1
An entry represents the configurable attributes for one programmable tone in a tone plan. The tone attributes are specified in ITU E.180 Supplement 2.
Status: current Access: not-accessible
OBJECT-TYPE    
  CvtcProgrammableToneEntry  

cvtcProgrammableToneFrequency 1.3.6.1.4.1.9.9.356.1.1.3.1.1
This object specified the frequency of the tone to be played or detected.
Status: current Access: read-create
OBJECT-TYPE    
  CToneFrequency  

cvtcProgrammableToneAmplitude 1.3.6.1.4.1.9.9.356.1.1.3.1.2
This object specified the amplitude expression of the tone to be played or detected.
Status: current Access: read-create
OBJECT-TYPE    
  CToneAmplitude  

cvtcProgrammableToneCadence 1.3.6.1.4.1.9.9.356.1.1.3.1.3
This object specified the cadence of the tone to be played or detected.
Status: current Access: read-create
OBJECT-TYPE    
  CToneCadence  

cvtcProgrammableToneDuration 1.3.6.1.4.1.9.9.356.1.1.3.1.4
This object specified the duration of the tone will be played. The value of 0 indicates that the tone will be played infinitely unless interrupted.
Status: current Access: read-create
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cvtcProgrammableToneStorageType 1.3.6.1.4.1.9.9.356.1.1.3.1.5
This object specifies the storage type for this conceptual row. If this conceptual row represents a programmable tone in a system built-in tone plan, the value of this object is permanent (4). If this conceptual row represents a programmable tone in an user defined tone plan, the value of this object is nonVolatile (3). If the value of this object is permanent (4), cvtcProgrammableToneDuration is the only object can be modified by the user.
Status: current Access: read-create
OBJECT-TYPE    
  StorageType  

cvtcProgrammableToneRowStatus 1.3.6.1.4.1.9.9.356.1.1.3.1.6
This object is used to add, delete or modify the entry of the table. When an entry is created, the following objects have to be provided: cvtcProgrammableToneFrequency, cvtcProgrammableToneAmplitude, cvtcProgrammableToneCadence.
Status: current Access: read-create
OBJECT-TYPE    
  RowStatus  

ciscoVoiceToneCadenceMIBConform 1.3.6.1.4.1.9.9.356.3
OBJECT IDENTIFIER    

cVoiceToneCadenceCompliances 1.3.6.1.4.1.9.9.356.3.1
OBJECT IDENTIFIER    

cVoiceToneCadenceGroups 1.3.6.1.4.1.9.9.356.3.2
OBJECT IDENTIFIER    

cVoiceToneCadenceCompliance 1.3.6.1.4.1.9.9.356.3.1.1
The compliance statement for entities which implement the CISCO-VOICE-TONE-CADENCE-MIB
Status: current Access: read-create
MODULE-COMPLIANCE    

cvtcToneConfigGroup 1.3.6.1.4.1.9.9.356.3.2.1
The collection of objects providing programmable tones and tone plans.
Status: current Access: read-create
OBJECT-GROUP