Any technical documentation that is made available by Grandstream Networks, Inc. is
proprietary and confidential and is considered the copyrighted work of Grandstream
Networks, Inc.
Trademarks
BroadWorks® and BroadWorks Assistant™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in this manual may be trademarks or
registered trademarks of their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 4 OF 25
1 Overview
This document describes the configuration procedures required for both the Grandstream
GXV-3000 / GXP-2000 / BT-200 to maximize the capabilities of BroadWorks.
The GXV-3000 / GXP-2000 are a few of the many access devices that interoperate with
BroadWorks.
The GXV-3000 / GXP-2000 uses the Session Initiation Protocol (SIP) to communicate
with BroadWorks for call control. It also translates voice to audio packets for transmission
across a packet network.
This guide describes the specific configuration items that are important for use with
BroadWorks. It does not describe the purpose and use of all configuration items on the
GXV-3000 / GXP-2000 / BT-200. For those details, see the GXV-3000 / GXP-2000 / BT-200 User Manual supplied by Grandstream
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 5 OF 25
2 BroadWorks Validation Package Support Level
Devices are validated according to BroadWorks Validation Packages. Each package
validates a subset of features or items. This section describes the device’s support level
for a BroadWorks Validation Package as well as the features or items in the package that
are not supported. Packages not applicable to the device are marked “Not applicable” in
the Items Not Supported column. For specific issues, see section
. For a complete list of items validated per package, see Appendix B: BroadWorks
Issues
Validation Package Test Items
BroadWorks Package Support Level Items Not Supported
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 6 OF 25
3 Device Capabilities and Known Interoperability Issues
This section describes the features supported by the GXV-3000 / GXP-2000 / BT-200, as
well as BroadWorks interoperability issues and impact. The following table describes
capabilities.
Verified Revisions shows the results of partner (vendor) testing of a specific BroadWorks
version with a specific partner’s device under test (DUT) version.
Compatible Revisions indicates the maintenance versions that should interface properly
with BroadWorks.
3.1 Capabilities
Device Type SIP Phone
Lines and Appearances GXV-3000 / GXP-2000 / BT-200: 3 lines / 4 lines / 1 line
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 8 OF 25
3.2 Interoperability Issues
This section lists the known interoperability issues between BroadWorks and partner
release(s). For more information on issues related to the particular software release, see
the partner release notes (generally, this should only be for GA partner releases).
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 9 OF 25
4 BroadWorks Device Identity/Profile
BroadWorks configurable device identify/profile is introduced in BroadWorks Release
14.0. This section applies only to BroadWorks Release 14.0 and later.
The following table identifies the required BroadWorks device identity/profile settings for
interoperability between the GXV-3000 / GXP-2000 / BT-200 and BroadWorks. For an
explanation of the profile parameters, refer to the BroadWorks Device Inventory Guide
For most of the parameters below, an “X” indicates the parameter function is supported
and/or required. If the item is blank, it is not supported.
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 10 OF 25
5 BroadWorks Device Type
This section applies to BroadWorks Release 14.0 and before.
The following BroadWorks device type should be used for Grandstream GXV-3000 / GXP2000 / BT-200, respectively.
Grandstream GXV-3000
Grandstream GXP-2000
Grandstream BT-200
The above device types require BroadWorks Release 13 MP<TBD>. If the BroadWorks
system is currently at a lower patch level, either apply the necessary patch or use the
following generic device type until the system can be patched accordingly.
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 11 OF 25
6 Configuration
Grandstream GXV-3000 / GXP-2000 / BT-200 can be configured via Web GUI Interface
as well as via Configuration File through TFTP or HTTP.
The GXV-3000 / GXP-2000 / BT-200 accepts configuration files in a proprietary binary
format which is produced by the Grandstream configuration tool. The configuration tool
creates a device configuration file based on a configuration template and the device’s
MAC address. All Grandstream products’ sample configuration templates are available on
Grandstream’s web site. A configuration template file contains all configuration
parameters available for a product, with comments describing allowed values of the
parameters. For a detailed parameter list, please refer to the corresponding firmware
release configuration template
When Grandstream device boots up or reboots, it will issue request for a binary
configuration file named “cfgxxxxxxxxxxxx”, where “xxxxxxxxxxxx” is the MAC address of
the device, i.e., “cfg000b820102ab”. The configuration file name should be in lower cases.
Grandstream offers free Configuration File generator software in both Linux/Unix and
Windows platform. Both Configuration File Generators can be downloaded from
Grandstream official web site at
The following examples describe how to set the parameters using a configuration file.
The GXV-3000 / GXP-2000 / BT-200 should be configured to load the configuration file
each time it resets or re-synchronizes. For detailed information on automated
provisioning, please check the GXV-3000 / GXP-2000 / BT-200 User Manual
Grandstream configuration tool user guide
[2].
[1] and the
[2].
The capabilities of the GXV-3000 / GXP-2000 / BT-200 have been verified for use with
BroadWorks based on the settings described in the following table. For more information
on the meaning, purpose, and applicability of the individual configuration items, see the
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 12 OF 25
6.1 System Level Configuration
This section describes system-wide configuration requirements for each GXV-3000 /
GXP-2000 / BT-200 to work with BroadWorks. Subscriber-specific settings are described
in the next section.
Step Command Purpose
System Configuration Items
Step 1
Step 2
Step 3
Set SIP Proxy/Domain.
SIP Server = as.broadworks.net
Set Outbound Proxy.
OutBound Proxy =
alg.broadworks.net
Enable DNS SRV lookup.
Use DNS SRV = “Yes”
Set the GXV-3000 / GXP-2000 /
BT-200 SIP server to the Fully
Qualified Domain Name (FQDN)
for the BroadWorks Application
Server cluster.
The domain must match the
domain configured for the
BroadWorks subscriber’s
line/port domain.
Set the outbound proxy to the
session border controller (SBC)
if one is deployed between the
GXV-3000 / GXP-2000 / BT-200
and BroadWorks.
If there are redundant SBCs, set
it to the FQDN for the SBC
cluster.
Enable DNS SRV lookups.
Step 4
Step 5
Step 6
Step 7
Step 8
Set register mode.
SIP Registration = “Yes”
Set SIP Timers.
Register Expiration = 60
Enable reliable response.
Enable 100rel = "Yes"
Enable negotiated DTMF type.
Send DTMF = “via RTP (RFC2833)”
Enable BroadSoft mode.
Special Feature = “Broadsoft”
Enable SIP register.
The default registration period is
60 minutes.
Reliable provisional response
(PRACK) should be enabled.
Set the GXV-3000 / GXP-2000 /
BT-200 to enable inband or RFC
2833 negotiated DTMF.
Set the GXV-3000 / GXP-2000 /
BT-200 in BroadSoft mode.
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 13 OF 25
6.2 Subscriber Level Configuration Parameters
This section identifies the device-specific parameters, including registration and
authentication. These settings must be unique across devices in order to be matched with
the settings for a BroadWorks subscriber.
Provisioning a subscriber to register with BroadWorks allows calls to terminate to the
subscriber’s line. Registration requires that a unique address of record (AoR) is
provisioned on BroadWorks and the phone; provisioning an AoR on BroadWorks consists
of setting the line/port parameter to a unique value within the Application Server cluster.
Grandstream GXV-3000 / GXP-2000 / BT-200 supports three SIP accounts (lines), four
SIP accounts, and 1 SIP account respectively. The follow example shows how to
configure subscriber elements for an account.
Step Command Purpose
Subscriber Configuration Items
Step 1
Step 2
Step 3
Step 4
Enable a line to be used.
Account Active = "Yes" ;
Set Register User ID for a line.
Example:
SIP User_ID = "2405551111" ;
Enable SIP Authentication for a
line.
Example:
Authenticate ID =
"1111@as.mycompany.com" ;
Authenticate Password = "welcome"
;
Configure display name for a
line.
Example:
Name = “Claire Smith” ;
Enable a line of GXV-3000 / GXP2000 / BT-200 in use.
The register user ID must
correspond with the line/port
setting on BroadWorks.
If the Authentication service is
configured on BroadWorks, these
parameters must be configured to
match the BroadWorks settings.
For a line, configure the name to
be displayed on the device.
2006 GRANDSTREAM. PROPRIETARY AND CONFIDENTIAL; DO NOT DUPLICATE, OR DISTRIBUTE. PAGE 14 OF 25
7 Enhanced IP Phone Configuration
Enhanced IP Phone Configuration is a BroadWorks feature that enables automatic
generation of device configuration files, given administrator-supplied templates.
For more information on the Enhanced IP Phone Configuration feature, see the Enhanced
IP Phone Configuration Guide
NOTE: BroadSoft does not manage or distribute template files for use with the Enhanced IP
Phone Configuration feature. Obtain template files from Grandstream or use the configuration
files obtained from Grandstream for the specific GXV-3000 / GXP-2000 / BT-200 firmware
release to create template files appropriate for your installation.
Since the GXV-3000 / GXP-2000 / BT-200 SIP phones require the configuration files be
converted into a binary format, an extra step must be performed when using this feature. After
the configuration files have been sent to the TFTP server and before the phone is reset, the
configuration files must be converted to binary format using Grandstream’s configuration tool. .
For detailed information on automated provisioning, please check the Grandstream configuration
tool user guide [2].
[3].
The GXV-3000 / GXP-2000 / BT-200 use only a phone-specific file to configure the
device. However, the Enhanced IP Phone Configuration feature requires a system and a
phone-specific file for each device. To satisfy the system file requirement, an empty file
(gxpDefault.txt, gxvDefault.txt) will need to be uploaded to BroadWorks as the system file.
This file will be sent to the FTP server but will not actually be used for the configuration file
generation. The group template file is used to build the configuration files for the devices
of this device type assigned to the group. For a sample GXV-3000 / GXP-2000 / BT-200
group template file, see Appendix A.
NOTE: The following samples are examples and should be used as a reference only. DO NOT CUT
AND PASTE THESE EXAMPLES TO GENERATE YOUR CONFIGURATION FILES. Use the
configuration files obtained from Grandstream with the specific release to generate your configuration
files.
System Default Parameters:
NOTE: This is an example file and should be used for reference only.