Allied Telesis MIB Structure (SIP/MGCP/NCS) User manual

MIB Structure (SIP/MGCP/NCS)
Reference Manual
VoIPTalk
Rev C

Copyright © 2001 Allied Telesyn International, Corp.
960 Stewart Drive Suite B, Sunnyvale CA USA 94085
All rights reserved. No part of this publication may be reproduced without prior written permission from Allied
Telesyn International, Corp.
Ethernet is a registered trademark of Xerox Corporation. All other product names, company names, logos or other
designations mentioned herein are trademarks or registered trademarks of their respective 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 provided herein is subject to change without
notice. In no event shall Allied Telesyn International, Corp. be liable for any incidental, special, indirect, or
consequential damages whatsoever, including but not limited to lost of profit, arising out of or related to this manual
or the information contained herein, even if Allied Telesyn International, Corp. has been advised of, known, or should
have known, the possibility of such damages.

Contents MIB Reference Manual
VP500 Communication Unit iii
Contents
Chapter 1
MIB Structure ........................................................................................... 1
What is a MIB?............................................................................................................ 1
Allied Telesyn MIB Structure ...................................................................................................1
Storage Clauses......................................................................................................................2
Changing a Parameter Value..................................................................................................2
Switching Protocols .................................................................................................................2
Manual Conventions.................................................................................................... 3
MIB Version................................................................................................................. 4
Part 1: Provisioning MIB
Chapter 2
InterfaceGroup Parameters..................................................................... 7
Basic Interface Parameters ......................................................................................... 7
interfaceStaticGroup.................................................................................................... 7
interfaceDhcpGroup .................................................................................................... 8
interfaceQoSGroup Parameters.................................................................................. 8
interfaceVlanGroup Parameters.................................................................................. 9
Chapter 3
apaManager Parameters ....................................................................... 11
apaManager Basic Parameters................................................................................. 11
apaManagerStaticGroup ........................................................................................... 11
apaManagerDhcpGroup............................................................................................ 12
Chapter 4
apaUIGroup Parameters........................................................................ 13
apaUIMapRuleGroup Parameters............................................................................. 13
apaUIMapRulexGroup...........................................................................................................13

Contents MIB Reference Manual
VP500 Communication Unit iv
apaUIServicesGroup ................................................................................................. 14
apaUIServicesPortnGroup.....................................................................................................14
Chapter 5
gatewayGroup Parameters ................................................................... 17
gatewayGroup Basic Parameter................................................................................ 17
gatewayPortnGroup................................................................................................... 17
gatewayPermLocalSameACGroup............................................................................ 18
gatewayPermLocalDiffACGroup................................................................................ 18
gatewayPermLongDistSameACGroup...................................................................... 19
gatewayPermLongDistDiffACGroup.......................................................................... 19
gatewayPermLongDistDiffCCGroup.......................................................................... 20
Chapter 6
countryGroup Parameters .................................................................... 21
Country Parameters .................................................................................................. 21
Chapter 7
portGroup Parameters........................................................................... 23
General Parameters.................................................................................................. 23
portnDspGroup.......................................................................................................... 24
portnDspUserGainGroup.......................................................................................................24
portnDspCountrySpecificGroup.............................................................................................25
portnDspCodecGroup............................................................................................................25
portnDtmfGroup......................................................................................................... 27
Chapter 8
syslogGroup Parameters...................................................................... 29
syslogGroup Basic Parameters................................................................................. 29
syslogStaticGroup ..................................................................................................... 29
syslogDhcpGroup...................................................................................................... 30
Chapter 9
tftpGroup Parameters............................................................................ 31
tftpGroup Basic Parameters ...................................................................................... 31

Contents MIB Reference Manual
VP500 Communication Unit v
tftpServerStaticGroup................................................................................................ 31
tftpServerDhcpGroup................................................................................................. 32
Chapter 10
apaByPassGroup Parameters .............................................................. 33
apaByPassGroup Parameters................................................................................... 33
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 14
apaInfoGroup Parameters..................................................................... 41
apaInfoInterface Parameters..................................................................................... 41
apaInfoTftpGroup ...................................................................................................... 41
apaInfoFileConfigGroup ............................................................................................ 42
Chapter 15
configTrapGroup Parameters............................................................... 43
Config Trap Parameters ............................................................................................ 43

Contents MIB Reference Manual
VP500 Communication Unit vi
Chapter 16
sntpGroup Parameters.......................................................................... 45
General Parameters.................................................................................................. 45
sntpStaticGroup Parameters ..................................................................................... 45
sntpDhcpGroup Parameters...................................................................................... 46
sntpTimeZoneConfigGroup Parameters.................................................................... 46
Part 2: MGCP MIB
Chapter 17
mgcpConfiguration Parameters........................................................... 51
Introduction................................................................................................................ 51
General Parameter.................................................................................................... 51
mgcpConfigurationEpIdGroup................................................................................... 52
mgcpConfigurationCallAgentGroup........................................................................... 52
mgcpConfigurationCallAgentStaticGroup..............................................................................52
mgcpConfigurationCallAgentDhcpGroup ..............................................................................53
mgcpConfigurationRetransmissionGroup.................................................................. 53
mgcpConfigurationGenericMediaPackageGroup...................................................... 54
mgcpConfigurationDtmfPackageGroup..................................................................... 54
mgcpConfigurationLinePackageGroup...................................................................... 55
mgcpStatusGroup Parameters.................................................................................. 55
mgcpStatisticsGroup Parameters.............................................................................. 56
Part 3: SIP MIB
Chapter 18
sipUAGroup Parameters....................................................................... 59
Introduction................................................................................................................ 59
sipUA Basic Parameters............................................................................................ 59
sipUALogGroup......................................................................................................... 60
sipUALogStaticGroup............................................................................................................60
sipUALogDhcpGroup.............................................................................................................60
sipUAServerGroup .................................................................................................... 61

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

Contents MIB Reference Manual
VP500 Communication Unit viii

List of Tables MIB Reference Manual
VP500 Communication Unit vii
List of Tables
Table 1 –––– Allied Telesyn MIB Structure ........................................................................1
Table 2 –––– MIB Parameters Example.............................................................................3
Table 3 –––– MIB Version Parameters...............................................................................4
Table 4 –––– IP Interface Parameters................................................................................7
Table 5 –––– Interface Static Parameters ..........................................................................7
Table 6 –––– Interface DHCP Parameters.........................................................................8
Table 7 –––– Interface QoS Parameters............................................................................8
Table 8 –––– Interface VLAN Parameters..........................................................................9
Table 9 –––– Unit Manager Parameters...........................................................................11
Table 10 ––– Unit Manager Static Parameters.................................................................11
Table 11 ––– Unit Manager DHCP Parameters ...............................................................12
Table 12 ––– apaUIMapRulex Group Parameters ...........................................................13
Table 13 ––– Portn Call Forward Unconditional Parameters ...........................................14
Table 14 ––– Portn Call Forward Busy Parameters.........................................................15
Table 15 ––– Portn Call Forward No Answer Parameters................................................15
Table 16 ––– Gateway Group Basic Parameter...............................................................17
Table 17 ––– Gateway Port n Parameters .......................................................................17
Table 18 ––– Gateway 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............................19
Table 22 ––– Gateway Perm Long Distance Different CC Parameters............................20
Table 23 ––– Country Group Parameters.........................................................................21
Table 24 ––– Port Parameters..........................................................................................23
Table 25 ––– DSP Parameters.........................................................................................24
Table 26 ––– DSP User Gain Parameters........................................................................24
Table 27 ––– DSP Country Specific Parameter ...............................................................25
Table 28 ––– DSP Country Specific Gain Parameters.....................................................25
Table 29 ––– DSP Codec Parameter...............................................................................25
Table 30 ––– DSP Codec G711aLaw Parameters...........................................................26
Table 31 ––– DSP Codec G711uLaw Parameters...........................................................26
Table 32 ––– DSP Codec G723.1 Parameters.................................................................26
Table 33 ––– DSP Codec G729AB Parameters...............................................................27
Table 34 ––– DSP Codec T.38 Parameter.......................................................................27
Table 35 ––– DTMF Parameter........................................................................................27
Table 36 ––– Syslog Parameters .....................................................................................29
Table 37 ––– Syslog Static Parameters ...........................................................................29
Table 38 ––– Syslog DHCP Parameters ..........................................................................30
Table 39 ––– tftp Group Parameters................................................................................31
Table 40 ––– tftp Server Static Group Parameters...........................................................31
Table 41 ––– tftp Server DHCP Group Parameters .........................................................32

List of Tables MIB Reference Manual
VP500 Communication Unit viii
Table 42 ––– VP500 Bypass Group Parameters..............................................................33
Table 43 ––– APA System Group Parameters.................................................................35
Table 44 ––– APA Cmd Group Parameters .....................................................................37
Table 45 ––– SNMP Group Parameters...........................................................................39
Table 46 ––– apaInfoInterface Parameters......................................................................41
Table 47 ––– apaInfo TFTP Parameters..........................................................................41
Table 48 ––– apaInfo File Config Parameters..................................................................42
Table 49 ––– Config Trap Parameters .............................................................................43
Table 50 ––– SNTP General Parameters.........................................................................45
Table 51 ––– Static SNTP Parameters.............................................................................45
Table 52 ––– DHCP SNTP Parameters ...........................................................................46
Table 53 ––– SNTP Time Zone Parameters ....................................................................46
Table 54 ––– MGCP MIB Version Parameter...................................................................51
Table 55 ––– General Parameter.....................................................................................51
Table 56 ––– End Point 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 Parameters..........................................................54
Table 62 ––– DTMF Package Parameters .......................................................................54
Table 63 ––– Line Package Parameters ..........................................................................55
Table 64 ––– MGCP Status Parameters..........................................................................55
Table 65 ––– MGCP Statistics Parameters......................................................................56
Table 66 ––– SIP MIB Version Parameter........................................................................59
Table 67 ––– sipUA Group Parameters............................................................................59
Table 68 ––– sipUA Log Group Parameters.....................................................................60
Table 69 ––– sipUA Log Static Group Parameters...........................................................60
Table 70 ––– sipUA Log Group DHCP Parameters .........................................................60
Table 71 ––– sipUA Server Group Parameters................................................................61
Table 72 ––– sipUA Server Static Group Parameters......................................................61
Table 73 ––– sipUA Log Group Parameters.....................................................................61
Table 74 ––– sipUAn Group Parameters..........................................................................62
Table 75 ––– sipUAn AuthGroup Parameters..................................................................63
Table 76 ––– sipUA AuthGroup Parameters....................................................................63

VP500 Communication Unit 1
1MIB Structure
This document lists and explains all parameters in the Allied Telesyn
Management Information Base (MIB) structure. A description and
possible values are provided to help you make the required changes to
yoursystem.Pleasereadthecommentsverycarefullybeforechanging
a parameter’s value.
What is a MIB? A Management Information Base (MIB) specifies what variables the
networkelementsmaintain(theinformationthatcanbequeriedandset
by the manager). All variables are identified by object identifiers, a
hierarchical naming scheme consisting of long strings of numbers that
are normally abbreviated into a simple name, for human readability.
A MIB is structured like a tree. At thetop 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 the
tree as specific as the MIB can get.
Allied Telesyn
MIB Structure The current MIB structure has three individual MIB files:
Figure 1: MIB Structure
Table 1: Allied Telesyn MIB Structure
MIB Description
Provisioning MIB The Provisioning MIB allows you to set up all the parameters related to
the VP500 communication unit. The Provisioning MIB contains all the
functional parameters the unit uses to operate. All have been configured
by default upon start up.
MGCP MIB The MGCP MIB is used exclusively with VP500 communication units that
run the Media Gateway Control Protocol (MGCP).
SIP MIB The SIP MIB is used exclusively with VP500 communication units that
run the Session Initiation Protocol (SIP).

Chapter 1 - MIB Structure MIB Reference Manual
VP500 Communication Unit 2
All parameters in the MIBs have been configured by default upon start
up. However, if you need to modify some of these parameters (for
example, parameters related to the country in which you are), use a
SNMP browser.
Storage
Clauses In addition to the standard MIBs clauses, there are two STORAGE clauses for storage purpose:
Persistent
Volatile
Persistent Parameters
Persistent parameters are saved into the VP500 communication unit’s
memory and restored when the unit is rebooted or restarted. The only
way to change the value of a persistent parameter is to manually
update it with a SNMP browser or by provisioning a new configuration
file.
Volatile Parameters
Volatile parameters are lost every time the VP500 communication unit
is rebooted. This type of parameterincludes toggling parameters such
as requesting a configuration file or asoftware download. Statisticsare
also volatile parameters that are lost every time the unit is rebooted.
Changing a
Parameter
Value
Changing a parameter involves contacting the VP500 communication
unitwithany SNMPMIBbrowser.Youcanuse thebuilt-in SNMP editor
of the Unit Manager. Seethe IP Communication Server Administration
Manual for more details. Be sure that you use the MIB files that match
the version of the MIB located inside the current software build of the
unit.
You must then locate the proper parameter to modify and change its
value. Most of the parameters will require that you reboot the VP500
communication unit. A reboot may be software-initiated or manually
initiated with the power switch. It will delete all statistics stored and will
overwriteall volatile parametervalues in the configuration file.Areboot
will also reinitiate the entire unit’s initial provisioning sequence.
Switching
Protocols The MIB structure contains three MIB files, but only two are actually used at the same time:
Note: The AT-VP504E FXO communication units can only run the SIP
signaling protocol.

Chapter 1 - MIB Structure MIB Reference Manual
VP500 Communication Unit 3
With the SIP signalling protocol: the VP500
communication unit uses the Provisioning MIB and SIP
MIB.
With the MGCP signalling protocol: the VP500
communication unit uses the Provisioning MIB and
MGCP MIB.
You can switch between protocols and the proper MIB will be activated
upon restart.
XTo switch MIB according to the protocol used:
In the general Provisioning MIB, locate the signaling
ProtocolsSwitch variable under the signaling
ProtocolsGroup.
This variable allows you to switch from one protocol to
another.
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 more details, see:
•“Part 2: MGCP MIB” on page 49
•“Part 3: SIP MIB” on page 57
Manual Conven-
tions The MIB parameters are presented in a table such as the following:
The tables contain the following information:
Name: Full name of the parameter as displayed in the
MIB.
Access: The parameter may have one of two access
Note: If you are using AT-VP504E FXO communication units,
switching protocol is not possible because theseunits can only run the
SIP signaling protocol.
Table 2: MIB Parameters Example
Name Access Description Dynamic
provisionningMibVersion R-O MIB version.
Default Value: 1.0 N/A

Chapter 1 - MIB Structure MIB Reference Manual
VP500 Communication Unit 4
types:•R/W: the parameter is “Read/Write” and can be
edited.
•R-O: the parameter is “Read-Only” and cannot be
edited.
Description: Short description of the parameter as
displayedintheMIB.Whenpossible,thedefaultvaluefor
the parameter is provided.
Dynamic: Describes the update status of the parameter,
which can have three update types:
•Dynamic (Yes): The parameter value is updated
automatically. 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
effect.
•Not Applicable (N/A): Applies to read-only
parameters.
MIB Version The following parameters give the current version of the Provisioning
MIB and the VP500 communication unit model involved.
Table 3: MIB Version Parameters
Name Access Description Dynamic
provisionningMibVersion R-O MIB version.
Default Value: 1.0 N/A
analogGatewayID R-O VP500 communication unit model.
0 = APA III-1
1 = APA III-4 FXS
2 = APA III-4 FXO
3 = APA III-4 FXS/FXO
Default Value:
N/A

Part 1:
Provisioning MIB

VP500 Communication Unit 7
2InterfaceGroup Parameters
The Interface parameters allow you to set information pertaining to the
IP addresses used by the VP500 communication unit.
Basic Interface
Parameters The basic interface parameters allow you to define the VP500
communication unit’s network “signature”.
interfaceStatic-
Group The following parameters allow you to set static interface information
for the VP500 communication unit.
Table 4: IP Interface Parameters
Name Access Description Dynamic
interfaceQoSSignalingDSFiledValue R/W Signaling (SIP negociation) QoS Differentiated Services field
value.
Default Value: 184
Yes
interfaceQoSMediaDSFieldValue R/W Media (SIP negociation) QoS Differentiated Services 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 communication unit network
configuration.
0 = Static
1 = DHCP
Default Value: 1
No
interfaceDhcpServerIp R-O DHCP server IP address. The field is empty if no DHCP server
was found. N/A
Table 5: Interface Static Parameters
Name Access Description Dymanic
interfaceStaticPrimDnsIp R/W Static primary DNS server IP address.
Default Value: 192.168.0.10 No
interfaceStaticSecDnsIp R/W Static secondary DNS server IP address.
Default Value: 192.168.0.10 No
interfaceStaticDefaultRouterIp R/W Static default router IP address.
Default Value: 192.168.0.10 No
interfaceStaticSubnetMaskIp R/W Static subnet mask.
Default Value: 255.255.255.0 No
interfaceStaticLocalIp R/W Static local IP address.
Default Value: 192.168.0.1 No

Chapter 2 - InterfaceGroup Parameters MIB Reference Manual - Provisioning MIB
VP500 Communication Unit 8
interfaceDhcp-
Group The following parameters allow you to set DHCP information for the
VP500 communication unit.
interfaceQoS-
Group Parameters The following parameters allow you to define the 802.1q settings ofthe
VP500 communication unit.
Table 6: Interface DHCP Parameters
Name Access Description Dynamic
interfaceDhcpPrimDnsIp R-O Primary DNS server IP address provided by the DHCP server.
Default Value: 192.168.0.10 N/A
interfaceDhcpSecDnsIp R-O Secondary DNS server IP address provided by the DHCP server.
Default Value: 192.168.0.10 N/A
interfaceDhcpDefaultRouterIp R-O Default router IP address provided by the DHCP server.
Default Value: 192.168.0.10 N/A
interfaceDhcpSubnetMaskIp R-O Subnet mask provided by the DHCP server.
Default Value: 255.255.255.0 N/A
interfaceDhcpLocalIp R-O Local IP address provided by the DHCP server.
Default Value: 192.168.0.1 N/A
Table 7: Interface QoS Parameters
Name Access Description Dynamic
interfaceQoSSignalingIeee8021QFilterEnable R/W Enabling IEEE 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 the Ethernet header. Otherwise, each
signaling packet is tagged with the user priority defined below.
0 = Disable
1 = Enable
Default Value: 0
Yes
interfaceQoSSignalingIeee8021QUserPriority R/W IEEE 802.1Q VLAN user priority value for VoIP signaling packet.
This value is used to set the user priority in the TCI field of the
VLAN tag. Tagging user priority is applied only when the filter is
enabled. In the case where the filter for signaling protocol is
disabled and the VLAN option is enabled, the default user priority
declared under the VLAN group will be used. Otherwise, the user
priority set for signaling has precedence over the VLAN default
user priority.
• 7 = High priority
• 0 = Low priority
Default Value: 6
Yes
interfaceQoSMediaIeee8021QFilterEnable R/W Enabling IEEE 802.1Q VLAN user priority tagging for VoIP media
packet. This filter applies to any VoIP media protocol in use (e.g.
RTP, T.38). When the filter is disabled (as well as VLAN), no tag
is added to the Ethernet header. Otherwise, each signaling
packet is tagged with the user priority defined below.
0 = Disable
1 = Enable
Default Value: 0
Yes

Chapter 2 - InterfaceGroup Parameters MIB Reference Manual - Provisioning MIB
VP500 Communication Unit 9
interfaceVlan-
Group Parameters The following parameters allow you to define the VLAN settings of the
VP500 communication unit.
interfaceQoSMediaIeee8021QUserPriority R/W IEEE 802.1Q VLAN user priority value for VoIP media packet.
This value is used to set the user priority in the TCI field of the
VLAN tag. Tagging user priority is applied only when the filter is
enabled. In the case where the filter for signaling protocol is
disabled and the VLAN option is enabled, the default user priority
declared under the VLAN group will be used. Otherwise, the user
priority set for signaling has precedence over the VLAN default
user priority.
• 7 = High priority
• 0 = Low priority
Default Value: 6
Yes
Table 7: Interface QoS Parameters (Continued)
Name Access Description Dynamic
Table 8: Interface VLAN Parameters
Name Access Description Dynamic
interfaceVlanIeee8021QTaggingEnable R/W Enabling IEEE 802.1Q VLAN tagging. With this option enabled,
all 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: Enable this option only on compatible LAN
with equipment supporting the VLAN tagging. Otherwise, the Unit
may be unreachable. In this case, please use the reset button to
access and disable VLAN tagging - in the reset mode, tagging is
not permitted. See IEEE 802.1Q for more information on this
topic.
0 = Disable
1 = Enable
Default Value: 0
Yes
interfaceVlanIeee8021QVirtualLanID R/W IEEE 802.1Q Virtual LAN ID. This is theVID to be applied in the
TCI field when tagging is enabled. The value 1 is the default Port
VID (PVID) for bridge port. The 4095 VID (0xFFF) is reserved for
implementation use and it shall not be used in tag header.NOTE:
As per standard, some bridges may not support the full range of
VID.
Default Value: 1
Yes
interfaceVlanIeee8021QDefaultUserPriority R/W IEEE 802.1Q Virtual LAN default user priority. This is the user
priority to be applied in the TCI field when tagging is enabled.
This value applies to all protocols for which no priority filtering is
enabled (e.g. ARP, ICMP).
• 7 = High priority
• 0 = Low priority
Default Value: 6
Yes

Chapter 2 - InterfaceGroup Parameters MIB Reference Manual - Provisioning MIB
VP500 Communication Unit 10