CISCO-ANNOUNCEMENT-MIB

File: CISCO-ANNOUNCEMENT-MIB.mib (21650 bytes)

Imported modules

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

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
RowStatus MODULE-COMPLIANCE OBJECT-GROUP
InetAddress InetAddressType SnmpAdminString
cmgwIndex ciscoMgmt

Defined Types

CannoControlEntry  
SEQUENCE    
  cannoAudioFileServerName SnmpAdminString
  cannoDnResolution INTEGER
  cannoIpAddressType InetAddressType
  cannoIpAddress InetAddress
  cannoAgeTime Unsigned32
  cannoSubDirPath SnmpAdminString
  cannoReqTimeout Unsigned32
  cannoMaxPermanent Unsigned32

CannoAudioFileEntry  
SEQUENCE    
  cannoAudioFileNumber Unsigned32
  cannoAudioFileDescr SnmpAdminString
  cannoAudioFileName SnmpAdminString
  cannoAudioFileStatus INTEGER
  cannoAudioFileOperStatus INTEGER
  cannoAudioFilePlayNoc Unsigned32
  cannoAudioFileDuration Unsigned32
  cannoAudioFileType INTEGER
  cannoAudioFileAge Unsigned32
  cannoAudioFileAdminDeletion INTEGER
  cannoAudioFileRowStatus RowStatus

Defined Values

ciscoAnnouncementMIB 1.3.6.1.4.1.9.9.8888
This MIB defines the objects for announcement system supported on media gateway. With announcement system setup, media gateway will have the capability to play pre-recorded audio files. The audio files can be played in either direction over existing connections (calls) or towards the Time Division Multiplexed (TDM) network on a TDM endpoint that is terminated on the media gateway.
MODULE-IDENTITY    

ciscoAnnouncementMIBNotifs 1.3.6.1.4.1.9.9.8888.0
OBJECT IDENTIFIER    

ciscoAnnouncementMIBObjects 1.3.6.1.4.1.9.9.8888.1
OBJECT IDENTIFIER    

ciscoAnnouncementMIBConformance 1.3.6.1.4.1.9.9.8888.2
OBJECT IDENTIFIER    

cannoGeneric 1.3.6.1.4.1.9.9.8888.1.1
OBJECT IDENTIFIER    

cannoControlConfig 1.3.6.1.4.1.9.9.8888.1.1.1
OBJECT IDENTIFIER    

cannoAudioFileConfig 1.3.6.1.4.1.9.9.8888.1.1.2
OBJECT IDENTIFIER    

cannoControlTable 1.3.6.1.4.1.9.9.8888.1.1.1.1
The MIB objects in this table are used to control the announcement system of media gateway.
OBJECT-TYPE    
  SEQUENCE OF  
    CannoControlEntry

cannoControlEntry 1.3.6.1.4.1.9.9.8888.1.1.1.1.1
An entry in this table contains the control parameters of the announcement system on media gateway.
OBJECT-TYPE    
  CannoControlEntry  

cannoAudioFileServerName 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.1
This object specifies the domain name of an announcement file server that resides in an IP network and is reachable from the media gateway. The default value of this object is NULL string(size is 0). Before using any object in this table, this object should be configured to non NULL.
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

cannoDnResolution 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.2
This object specifies the domain name resolution for the domain name of the Announcement File server which is specified by the cannoAudioFileServerName object. If this object is set to internalOnly(1), the IP address associated with the file server (cannoAudioFileServerName) will be determined by the cannoIpAddress object.
OBJECT-TYPE    
  INTEGER internalOnly(1), externalOnly(2)  

cannoIpAddressType 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.3
This object specifies the IP address type of cannoIpAddress. This object is not applicable when cannoDnResolution is set to externalOnly(2).
OBJECT-TYPE    
  InetAddressType  

cannoIpAddress 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.4
This object specifies the IP address associated with the cannoAudioFileServerName. This object is not applicable when cannoDnResolution is set to externalOnly(2).
OBJECT-TYPE    
  InetAddress  

cannoAgeTime 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.5
This object specifies the maximum life-span(in minutes) of the dynamic announcement files in the cache. A dynamic announcement file starts aging as soon as it is brought into the cache from the file server. When a dynamic file age crosses the 'cannoAgeTime' threshold, the file will be removed from the cache. The value zero time specifies that 'cannoAgeTime' is disabled.
OBJECT-TYPE    
  Unsigned32 0..65535  

cannoSubDirPath 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.6
This object specifies the directory path under the default TFTP directory in the Announcement File server for announcement files. The individual characters in cannoSubDirPath may be alphanumeric characters, forward slashes, backward slashes, periods, dashes, and underscores, but no embedded spaces. The last character of cannoSubDirPath must not be a dash.
OBJECT-TYPE    
  SnmpAdminString Size(0..255)  

cannoReqTimeout 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.7
This object specifies the time for a play announcement request to be serviced. The cannoReqTimeout is the time within which an announcement must start playing after receiving announcement request. If the announcement system cannot start playing the announcement within cannoReqTimeout seconds since the request was received, the play request will be aborted. The value zero time specifies that 'cannoReqTimeout' is disabled.
OBJECT-TYPE    
  Unsigned32 0..50  

cannoMaxPermanent 1.3.6.1.4.1.9.9.8888.1.1.1.1.1.8
This object specifies the maximum number of permanent announcement files that can be added to the media gateway. The space on media gateway cache is reserved for the cannoMaxPermanent number of permanent announcement files and the permanent announcement files should be stored on media gateway cache forever until to be deleted. The value zero specifies that media gateway only support dynamic announcement file.
OBJECT-TYPE    
  Unsigned32 0..500  

cannoAudioFileTable 1.3.6.1.4.1.9.9.8888.1.1.2.1
The MIB objects in this table contain information to manage audio announcement files.
OBJECT-TYPE    
  SEQUENCE OF  
    CannoAudioFileEntry

cannoAudioFileEntry 1.3.6.1.4.1.9.9.8888.1.1.2.1.1
Each entry in the cannoAudioFileTable consists of management information for a specific announcement file, which include file descriptor, name, type, age, duration, number of cycles, status.
OBJECT-TYPE    
  CannoAudioFileEntry  

cannoAudioFileNumber 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.1
A unique index to identify announcement file to be used in media gateway.
OBJECT-TYPE    
  Unsigned32 1..9999  

cannoAudioFileDescr 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.2
A textual string containing information about the audio file. User can store any information to this object such as which customer using this audio file, usage of the audio file, etc..
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

cannoAudioFileName 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.3
This object specifies the name of a valid announcement file which has been stored in cannoAudioFileTable. This file name may include path or subdirectory information. The individual characters in this name may be alphanumeric characters, forward slashes, backward slashes, periods, dashes, and underscores, but no embedded spaces. The last character of the name must not be a dash or a forward slash.
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

cannoAudioFileStatus 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.4
This object indicates the status of the the audio file: cached (1): the file successfully downloaded to media gateway cache cache is the memory on media gateway which is used to store announcement files. loading (2): the file in process of downloading invalidFile(3): the file on Announcement File server is too large or corrupted loadFailed (4): timeout when trying to download the file notCached (5): the file is not in cache Note: The cache is the memory on media gateway which is used to store announcement files. Some of space on the cache is reserved for the permanent announcement files (refer to 'cannoMaxPermanent'), the rest of cache is for the dynamic announcement files. The 'notCached' is applicable only for the dynamic announcement files in the following cases: 1. The dynamic file age reaches to 'cannoAgeTime', the status of the file will be changed from 'cached' to 'notCached'. 2. If the cache is full for the dynamic files, and if user try to add a new dynamic file, the one of the dynamic files on cache will be removed by LRU algorithm. The status of that file will be changed from 'cached' to 'notCached'. 3. If there is no space for the dynamic files (whole cache is reserved for the permanent file), the status of the dynamic files is set to 'notCached'.
OBJECT-TYPE    
  INTEGER cached(1), loading(2), invalidFile(3), loadFailed(4), notCached(5)  

cannoAudioFileOperStatus 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.5
This object indicates the current operational status of the entry: inPlaying (1): the file is in playing notPlaying (2): the file is not in playing delPending (3): deletion is pending because the file is in playing
OBJECT-TYPE    
  INTEGER inPlaying(1), notPlaying(2), delPending(3)  

cannoAudioFilePlayNoc 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.6
This object specifies number of cycles the announcement file is played. This object is used only when the Play Announcement signal from the MGC does not include a 'cannoAudioFilePlayNoc' parameter. The value zero is used to represent an announcement that continuously plays or loops.
OBJECT-TYPE    
  Unsigned32 0..2147483647  

cannoAudioFileDuration 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.7
This object indicates the duration to play the announcement for one cycle, it is applicable only for the fixed announcement play. This object is used only when the Play Announcement signal from the MGC does not include a 'cannoAudioFileDuration' parameter. For the fixed announcement play, the 'cannoAudioFilePlayNoc' and the 'cannoAudioFileDuration' are used together to determine how long the announcement is to be played. The value zero indicates that this is a variable announcement play and only the 'cannoAudioFilePlayNoc' is used to determine the play time.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cannoAudioFileType 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.8
This object specifies announcement file type. dynamic(1) : Dynamic file can be removed from cache if file age(cannoAudioFileAge) reaches cannoAgeTime or according to LRU algorithm when cache is full permanent(2): Permanent file should be stored on cache forever except to be deleted. The max number of permanent file can be stored on cache is determined by cannoMaxPermanent.
OBJECT-TYPE    
  INTEGER dynamic(1), permanent(2)  

cannoAudioFileAge 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.9
This object indicates that announcement file age in cache, it is only for dynamic file. A dynamic announcement file starts aging as soon as it is brought into the cache from the Announcement File server. When the 'cannoAudioFileAge' reach to 'cannoAgeTime', then the file will be removed from cache. This object is not applicable for two cases: (1)For the permanent files, because the the permanent files should be stored on cache forever except to be deleted. (2)The 'cannoAgeTime' is set to zero which means the cannoAgeTime is infinite and 'cannoAudioFileAge' can never reach the cannoAgeTime.
OBJECT-TYPE    
  Unsigned32 0..65535  

cannoAudioFileAdminDeletion 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.10
This object specifies entry deletion behavior: gracefully(1): gateway will not stop the current announcement file playing (till it completes) while deleting this entry. forcefully(2): gateway will immediately stop current announcement file playing while deleting this entry
OBJECT-TYPE    
  INTEGER gracefully(1), forcefully(2)  

cannoAudioFileRowStatus 1.3.6.1.4.1.9.9.8888.1.1.2.1.1.11
This object is used to create or delete an entry. The mandatory objects for creating an entry in this table: 'cannoAudioFileName' The following objects are not allowed to be modified after the entry to be added: 'cannoAudioFileName' 'cannoAudioFileType'
OBJECT-TYPE    
  RowStatus  

cannoMIBCompliances 1.3.6.1.4.1.9.9.8888.2.1
OBJECT IDENTIFIER    

cannoMIBGroups 1.3.6.1.4.1.9.9.8888.2.2
OBJECT IDENTIFIER    

cannoMIBCompliance 1.3.6.1.4.1.9.9.8888.2.1.1
The compliance statement for Announcement File
MODULE-COMPLIANCE    

cannoControlGroup 1.3.6.1.4.1.9.9.8888.2.2.1
This group contains objects related to announcement system control on media gateway.
OBJECT-GROUP    

cannoAudioFileGroup 1.3.6.1.4.1.9.9.8888.2.2.2
This group contains objects related to announcement files on media gateway.
OBJECT-GROUP