Allied Telesis MIB Structure (SIP/MGCP/NCS), Reference Manual

Page 1: ...MIB Structure SIP MGCP NCS Reference Manual VoIPTalk Rev C...

Page 2: ...espective owners Allied Telesyn International Corp reserves the right to make changes in specifications and other information contained in this document without prior written notice The information pr...

Page 3: ...tions 3 MIB Version 4 Part 1 Provisioning MIB Chapter 2 InterfaceGroup Parameters 7 Basic Interface Parameters 7 interfaceStaticGroup 7 interfaceDhcpGroup 8 interfaceQoSGroup Parameters 8 interfaceVla...

Page 4: ...eACGroup 19 gatewayPermLongDistDiffACGroup 19 gatewayPermLongDistDiffCCGroup 20 Chapter 6 countryGroup Parameters 21 Country Parameters 21 Chapter 7 portGroup Parameters 23 General Parameters 23 portn...

Page 5: ...Chapter 11 apaSystemGroup Parameters 35 apaSystemGroup Parameters 35 Chapter 12 apaCmdGroup Parameters 37 apaCmdGroup Parameters 37 Chapter 13 snmpGroup Parameters 39 snmpGroup Parameters 39 Chapter...

Page 6: ...EpIdGroup 52 mgcpConfigurationCallAgentGroup 52 mgcpConfigurationCallAgentStaticGroup 52 mgcpConfigurationCallAgentDhcpGroup 53 mgcpConfigurationRetransmissionGroup 53 mgcpConfigurationGenericMediaPac...

Page 7: ...Contents MIB Reference Manual VP500 Communication Unit vii sipUAServerStaticGroup 61 sipUAServerDhcpGroup 61 sipUAnGroup 62 sipUAnAuthGroup 63 sipUAAuthGroup 63 Appendix A List of MIB Parameters 65...

Page 8: ...Contents MIB Reference Manual VP500 Communication Unit viii...

Page 9: ...Perm Local Same AC Parameters 18 Table 19 Gateway Perm Local Diff AC Parameters 18 Table 20 Gateway Perm Long Distance Same AC Parameters 19 Table 21 Gateway Perm Long Distance Different AC Parameters...

Page 10: ...nt Id Parameters 52 Table 57 Call Agent Parameters 52 Table 58 Call Agent Static Group 52 Table 59 Call Agent DHCP Group 53 Table 60 Retransmission Parameters 53 Table 61 Generic Media Package Paramet...

Page 11: ...tructured like a tree At the top of the tree is the most general information available about a network Each branch of the tree then gets more detailed into a specific network area with the leaves of t...

Page 12: ...or a software download Statistics are also volatile parameters that are lost every time the unit is rebooted Changing a Parameter Value Changing a parameter involves contacting the VP500 communication...

Page 13: ...r Set the signalingProtocolsSwitch variable to 0 MGCP or 1 SIP The default value is 1 SIP The VP500 communication unit reboots automatically After the unit restarts it will use the selected MIB For mo...

Page 14: ...atically You do not need to restart the VP500 communication unit Not dynamic No The parameter value is not updated automatically You must restart the VP500 communication unit for the change to take ef...

Page 15: ...Part 1 Provisioning MIB...

Page 16: ......

Page 17: ...ervices field value Default Value 184 Yes interfaceMacAddress R O VP500 communication unit Ethernet MAC address Default Value 0090F8FFFFFF N A interfaceUseDhcp R W Select the provenance of the VP500 c...

Page 18: ...EE 802 1Q VLAN user priority tagging for VoIP signaling packet This filter applies to any VoIP signaling protocol in use e g MGCP or SIP When the filter is disabled as well as VLAN no tag is added to...

Page 19: ...ll packets are tagged with the Virtual ID VID specified below The default user priority is to be applied in case of general protocol or when signaling or media protocol filtering is disabled WARNING E...

Page 20: ...Chapter 2 InterfaceGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 10...

Page 21: ...e R W Enable the Unit Manager 0 Disable 1 Enable Default Value 1 No apaManagerUseDhcp R W Select the provenance of the Unit Manager configuration 0 Static 1 DHCP Default Value 1 Yesa apaManagerTrapRet...

Page 22: ...anager DHCP Parameters Name Access Description Dynamic apaManagerDhcpVendorSpecificCode R W DHCP Unit Manager vendor specific code Default Value 200 Yes apaManagerDhcpPrimHost R O Unit Manager IP addr...

Page 23: ...per rule number from 1 to 4 Table 12 apaUIMapRulex Group Parameters Name Access Description Dynamic apaUIMapRulexEnable R W Enable Dial Map Rule n 0 Disable 1 Enable Default Value 1 Yes apaUIMapRulexD...

Page 24: ...rameter description is identical for each port For clarity s sake only one generic set of parameters is described in this manual When browsing through the Provisioning MIB replace the n letter in the...

Page 25: ...W Address to which the phone call will be unconditionally forwarded Address format userInfo host portNumber where userInfo user name or telephone number optional host domain name or IP address portNum...

Page 26: ...Chapter 4 apaUIGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 16...

Page 27: ...Name Access Description Dynamic gatewayGeneralDialPrefix R W Prefix that must be dialed before any other numbers on a port used in FXO mode Default Value Yes Note Each port of the VP500 communication...

Page 28: ...he field is empty when no prefix is required the destination call is local with the same area code as countryAreaCode Default Value Yes gatewayPermLocalSameACAllowed R W Semi colon separated list of n...

Page 29: ...rmLongDistSameACPrefix R W Prefix that must be dialed before the destination number The field is empty when no prefix is required the destination call is long distance with the same area code as count...

Page 30: ...ble 21 Gateway Perm Long Distance Different AC Parameters Continued Name Access Description Dynamic Table 22 Gateway Perm Long Distance Different CC Parameters Name Access Description Dynamic gatewayP...

Page 31: ...t Value 1 Yes countryAreaCode R W Area code associated to the current location of the VP500 communication unit Default Value 819 Yes countrySelection R W Select the default country that may be used fo...

Page 32: ...Chapter 6 countryGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 22...

Page 33: ...from 1 to 4 Table 24 Port Parameters Name Access Description Dynamic portnEnable R W Enable VP500 communication unit port n 0 Disable 1 Enable Default Value 1 Yes portnAnalogLineType R W The analog te...

Page 34: ...conds Default Value 30 No Table 24 Port Parameters Continued Name Access Description Dynamic Table 25 DSP Parameters Name Access Description Dynamic portnDspMaxJitterBufferLen R W Port n maximum jitte...

Page 35: ...SpecificGainConfiguration R W Select port n country specific gain configuration 0 Use custom configuration 1 Use default country configuration Default Value 1 No portnDspCountrySpecificGainBaseInput R...

Page 36: ...iption Dynamic portnDspCodecG711uLawEnable R W Enable G 711 u Law PCMU on Port n 0 Disable 1 Enable Default Value 1 Yes portnDspCodecG711uLawPTimeMin R W Port n minimum packetization time ptime for PC...

Page 37: ...values are 10 20 30 and 40 The default value is used if the value is invalid Default Value 10 Yes portnDspCodecG729ABPTimeMax R W Port n maximun packetization time ptime for G 729 AB in ms WARNING Va...

Page 38: ...Chapter 7 portGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 28...

Page 39: ...ingMask R W Select the syslog mask 0 Absolutely no Tracing 1 Critical errors 2 Error conditions 3 Warning conditions 4 Informational messages 5 Debug level messages use with care Higher level mask inc...

Page 40: ...log daemon Table 38 Syslog DHCP Parameters Name Access Description Dynamic syslogDhcpVendorSpecificCode R W DHCP Syslog server vendor specific code Default Value 110 Yes syslogDhcpHost R O Syslog serv...

Page 41: ...ommunication unit software file name to download when the Rescue application starts Default Value apa_emergency bin Yes tftpUseDhcp R W Select the provenance of the TFTP server configuration 0 Static...

Page 42: ...Parameters Name Access Description Dynamic tftpServerDhcpVendorSpecificCode R W DHCP TFTP server vendor specific code Default Value 117 Yes tftpServerDhcpHost R O TFTP server IP address or domain nam...

Page 43: ...or of the Bypass connector Table 42 VP500 Bypass Group Parameters Name Access Description Dynamic apaByPassModeAlwaysEnable R W Always enable VP500 communication unit bypass mode 0 Disable 1 Enable De...

Page 44: ...Chapter 10 apaByPassGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 34...

Page 45: ...ystemOperationalStatusConfigFile R O TFTP system operational configuration file download status 0 Idle 1 Success 2 Fail 3 In Progress 4 Listening Default Value 0 N A apaSystemLastRomCheck R O Last ROM...

Page 46: ...Chapter 11 apaSystemGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 36...

Page 47: ...t Shutdown harware reset immediately 6 Graceful Shutdown harware reset when all calls have terminated 7 Reset all statistics 8 Other Default Value Yes apaCmdConfigurationMode R W Select the VP500 comm...

Page 48: ...t to download a file from TFTP server 0 Off 1 On Default Value 0 Yes apaCmdRestart R W Instruct the VP500 communication unit to reboot 0 Off 1 On Default Value 0 Yes apaCmdRequestConfiguration R W Sel...

Page 49: ...the contact person for this managed node together with information on how to contact this person If no contact information is known the value is the zero length string Yes snmpSystemName R W An admini...

Page 50: ...Chapter 13 snmpGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 40...

Page 51: ...aInfoInterfaceSecDnsIpAddress R O Secondary DNS server IP address Default Value 192 168 0 10 N A apaInfoInterfaceDefaultRouterIpAddress R O Default router IP address Default Value 192 168 0 10 N A apa...

Page 52: ...e 48 apaInfo File Config Parameters Name Access Description Dynamic apaInfoFileConfigFileName R O Configuration File name to download from the TFTP Server Default Value sip cfg N A apaInfoFileConfigFi...

Page 53: ...iption Dynamic configTrapApaConfigInformation N A The Unit Manager is trapped with the SIP Analog Gateway ID the MAC address and the request configuration of the VP500 communication unit the unit requ...

Page 54: ...Chapter 15 configTrapGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 44...

Page 55: ...nutes before sending a SNTP time request to the SNTP server Values range from 2 to 1440 seconds Default Value 1440 Yes sntpSynchronizationPeriodOnError R W Interval in minutes before sending a SNTP ti...

Page 56: ...Parameters Name Access Description Dynamic sntpTimeZoneUseTimeZoneSelection R W Enable the use of pre configured time zone selection available 0 Use custom time zone configuration 1 Use pre configure...

Page 57: ...ce Manual Provisioning MIB VP500 Communication Unit 47 sntpTimeZoneCustomTimeZoneIsValid R O Validate custom time zone entered 0 Not valid 1 Valid Default Value 0 N A Table 53 SNTP Time Zone Parameter...

Page 58: ...Chapter 16 sntpGroup Parameters MIB Reference Manual Provisioning MIB VP500 Communication Unit 48...

Page 59: ...Part 2 MGCP MIB...

Page 60: ......

Page 61: ...This variable allows you to switch from one protocol to another Set the signalingProtocolsSwitch variable to 0 MGCP Reboot the VP500 communication unit After the VP500 communication unit restarts it...

Page 62: ...StaticGatewayFqdn R W Static Fully Qualified Domain Name FQDN of the unit No Table 57 Call Agent Parameters Name Access Description Dynamic mgcpConfigurationCallAgentUseDhcp R W Select the provenance...

Page 63: ...ic code Default Value 207 No mgcpConfigurationCallAgentDhcpSecondary Address R O Secondary Call Agent address provided by DHCP server Can be a dotted IP string or a FQDN address Default Value 192 168...

Page 64: ...eneric Media Package Parameters Name Access Description Dynamic mgcpConfigurationGenericMediaPackageRt Duration R W Ring back tone timeout value in ms Default Value 180000 No mgcpConfigurationGenericM...

Page 65: ...tter dial tone timeout value in ms Default Value 16000 No mgcpConfigurationLinePackageOtDuration R W Off hook warning tone timeout value in ms Default Value 65535000 No Table 64 MGCP Status Parameters...

Page 66: ...Statistics Parameters Name Access Description Dynamic mgcpStatisticsNumberOfActiveConnections R O Number of active connections Default Value 0 N A mgcpStatisticsTotalNumberOfConnections R O Total num...

Page 67: ...Part 3 SIP MIB...

Page 68: ......

Page 69: ...to 1 SIP Reboot the VP500 communication unit After the VP500 communication unit restarts it will use the SIP MIB sipUA Basic Parameters The following parameters allow you to define basic SIP User Agen...

Page 70: ...nance of the SIP logging client configuration 0 Static 1 DHCP Default Value 1 Yesa a Only when at least one of the variables xxUseDhcp was set to 1 before starting the VP500 unit Table 69 sipUA Log St...

Page 71: ...00 unit Table 72 sipUA Server Static Group Parameters Name Acccess Description Dynamic sipUAServerStaticRegistrarHost R W Static SIP registrar server IP address or domain name Default Value 192 168 0...

Page 72: ...specific code Default Value 205 Yes sipUAServerDhcpOutboundProxyHost R O SIP outbound proxy server IP address or domain name provided by DHCP server Default Value 192 168 0 10 N A sipUAServerDhcpOutb...

Page 73: ...sionExpirationDelay variable If an INVITE does not get an answer then the call is terminated This option allows to detect the end of a call caused by a communication problem on the network If sipUAnMu...

Page 74: ...l SIP MIB VP500 Communication Unit 64 sipUAAuthValid R O This value is set to 1 Value sipUAAuthUsrPwd is valid 0 Value sipUAAuthUsrPwd has a syntax error Default Value 1 N A Table 76 sipUA AuthGroup P...

Page 75: ...pPrimHost 12 apaManagerDhcpPrimTrapPort 12 apaManagerDhcpVendorSpecificCode 12 apaManagerEnable 11 apaManagerStaticPrimHost 11 apaManagerStaticPrimTrapPort 11 apaManagerTrapRetransmissionPeriod 11 apa...

Page 76: ...lowAll 20 gatewayPermLongDistDiffACAllowed 20 gatewayPermLongDistDiffACPrefix 19 gatewayPermLongDistDiffCCAllowAll 20 gatewayPermLongDistDiffCCAllowed 20 gatewayPermLongDistDiffCCPrefix 20 gatewayPerm...

Page 77: ...ionEpIdLocalNameTerm1 52 mgcpConfigurationEpIdStaticGatewayFqdn 52 mgcpConfigurationGenericMediaPackageRbkDuration 54 mgcpConfigurationGenericMediaPackageRtDuration 54 mgcpConfigurationLinePackageBzDu...

Page 78: ...ecificGainBaseOutput 25 portnDspCountrySpecificGainBaseOutputOffset 25 portnDspCountrySpecificGainConfiguration 25 portnDspCountrySpecificLoopCurrent 25 portnDspEchoCancelControl 24 portnDspMaxJitterB...

Page 79: ...ticProxyPort 61 sipUAServerStaticRegistrarHost 61 sipUAServerStaticRegistrarPort 61 sipUAServerUseDhcp 61 sipUAServiceAdminStatus 59 sipUAServiceOperStatus 59 sipUAServiceStartTime 59 snmpAgentPort 39...

Page 80: ...leName 31 tftpServerDhcpEmergencyHost 32 tftpServerDhcpEmergencyPort 32 tftpServerDhcpEmergencyVendorSpecificCode 32 tftpServerDhcpHost 32 tftpServerDhcpPort 32 tftpServerDhcpVendorSpecificCode 32 tft...