Broadsoft DMS
The Wiki of Unify contains information on clients and devices, communications systems and unified communications. - Unify GmbH & Co. KG is a Trademark Licensee of Siemens AG.
Contents
Set DMS address via DHCP
When an IP phone is booting, it first obtains an IP address via DHCP. The DHCP server can provide the DMS address to the phone via Option 43 or Option 66.
Option 43
DHCP vendor specific option 43 can specify a voice VLAN ID and URL of a Broadsoft DMS server. IP phones will recognize vendor specific options only, if vendor string (here: "Siemens") matches correctly. All values are given in hexadecimal numbering format. Here is a detailed description of all DHCP option 43 bytes:
Tag Len Content (Example) 01 07 5369656d656e73 02 04 00000065 03 1d 68747470733a2f2f39332E3132322E3131342E39363a3434332f646d73 ff
There are three Tags, each with an explicit length value. List if tags is delimited by a ending ff
- Tag 01 specifies the vendor (here: Siemens)
- Tag: 01; Length: 07; Value: Siemens
- Tag 02 specifies VLAN ID of Voice VLAN (here: 101)
- Tag: 02; Length: 04; Value: 65 (Hex)
- Tag 03 specifies IP address of Broadsoft DMS (here: 93.122.114.96:443/dms)
- Tag: 03; Length: 1d; Value: https://93.122.114.96:443/dms (Hex)
- End of record
- End: ff (Hex)
Providing a VLAN ID is optional and only mentioned for completeness. You can find details for configuration of a VLAN ID here: http://wiki.unify.com/wiki/VLAN_ID_Discovery_over_DHCP
Option 66
The DHCP server needs to be configured to provide the DMS server URL via Option 66. Here is a detailed description of the Option 66 bytes
Option Len Content (Example) 42 1d 68747470733a2f2f39332e3132322e3131342e39363a3434332f646d73
Compared to Option 43, Option 66 does not have specific tags. It only has a length and content field. The above example provides the following URL in the content field
- DHCP option field: 42(Hex); Length: 1d; Content: https://93.122.114.96:443/dms (Hex)
Content of config.xml file
The content of the XML file provided by the DMS server has the following schema
<?xml version="1.0" encoding="utf-8"?>
<Message>
<Action>WriteItems</Action>
<ItemList>
<Item name="ITEMNAME">VALUE</Item>
</ItemList>
</Message>
Generic Items
This section describes the items that can be configured on a CP device via a config.xml file.
| Item name | Type | Details | Related WBM config item |
|---|---|---|---|
| ip-protocol-mode | Enumeration | 0=IPv4 only, 1=IPv6 only, 2=Dual stack mode IPv6_IPv4 | Admin -> Network -> General IP configuration -> Protocol mode |
| lldp-enabled | Boolean | LLDP-Med enabled. true or false | Admin -> Network -> General IP configuration -> LLDP-MED enabled |
| dhcp | Boolean | DHCPv4 enabled. true or false | Admin -> Network -> General IP configuration -> DHCP enabled |
| ipv6-dhcp-enabled | Boolean | DHCPv6 enabled. true or false | Admin -> Network -> General IP configuration -> DHCPv6 enabled |
| vlan-method | Enumeration | Discover VLAN via: 2=LLDP-Med, 1=DHCP, 0=manual | Admin -> Network -> General IP configuration -> VLAN discovery |
| vlan-id | Integer | only valid if vlan-method is set to manual | Admin -> Network -> General IP configuration -> VLAN ID |
| dns-domain-name | String | DNS-domain name, if not provided by DHCP server | Admin -> Network -> General IP configuration -> DNS domain |
| dns-server-addr | String | Primary DNS server, if not provided by DHCP server | Admin -> Network -> General IP configuration -> Primary DNS |
| dns-server-addr2 | String | Secondary DNS server, if not provided by DHCP server | Admin -> Network -> General IP configuration -> Secondary DNS |
| dhcp-reuse | Boolean | DHCPv4 reuse. true or false | Admin -> Network -> IPv4 configuration -> DHCP lease reuse |
| ipv6-dhcp-addr-reuse | Boolean | DHCPv6 reuse. true or false | Admin -> Network -> IPv6 configuration -> DHCPv6 lease reuse |
| reg-port | Integer | SIP server port | Admin -> Network -> Port configuration -> SIP server |
| registrar-port | Integer | SIP registrar port | Admin -> Network -> Port configuration -> SIP registrar |
| sgnl-gateway-port-user | Integer | SIP gateway port | Admin -> Network -> Port configuration -> SIP gateway |
| phone-port | Integer | SIP local phone port | Admin -> Network -> Port configuration -> SIP local |
| rtp-base-port | Integer | RTP base port | Admin -> Network -> Port configuration -> RTP base |
| port1 | Enumeration | LAN port speed setting. 0=Auto, 1=10/Half, 2=10/Full, 3=100/Half, 4=100/Full, 5=1000/Full | Admin -> Network -> Port configuration -> LAN port speed |
| port2 | Enumeration | PC port speed setting. 0=Auto, 1=10/Half, 2=10/Full, 3=100/Half, 4=100/Full, 5=1000/Full | Admin -> Network -> Port configuration -> PC port speed |
| port2-mode | Enumeration | PC port mode. 0=Disabled, 1=Enabled, 2=Mirror | Admin -> Network -> Port configuration -> PC port mode |
| port2-auto-mdix-enabled | Boolean | Enable Auto-MDIX on PC port. true or false | Admin -> Network -> Port configuration -> PC port autoMDIX |
| Item name | Type | Details | Related WBM config item |
|---|---|---|---|
| e164 | String | E164 number of device | Admin -> System -> System identity -> Terminal number |
| display-id-unicode | String | optional ID to display on main menu screen | Admin -> System -> System identity -> Display identity |
| use-display-id | Boolean | Enable Display identity. true or false | Admin -> System -> System identity -> Enable ID |
| hostname | String | Hostname of device (DDNS) | Admin -> System -> System identity -> Terminal number |
| automatic-hostname-type | Enumeration | Hostname construction. 0=None, 1=Configured hostname, 2=only E164, 3=Prefix E164 with configured hostname, 4=MAC | Admin -> System -> System identity -> DNS name construction |
| reg-addr | String | SIP server address | Admin -> System -> Registration -> SIP server address |
| registrar-addr | String | SIP registrar address | Admin -> System -> Registration -> SIP registrar address |
| sgnl-gateway-addr-user | String | SIP gateway address | Admin -> System -> Registration -> SIP gateway address |
| session-timer | Boolean | Enable SIP session timer. true or false | Admin -> System -> Registration -> Session timer enabled |
| session-duration | Integer | Session refresh after seconds. Depends on session timer | Admin -> System -> Registration -> Session duration (seconds) |
| reg-ttl | Integer | Registration timer (seconds) | Admin -> System -> Registration -> Registration timer (seconds) |
| server-type | Enumeration | SIP server type. 0=Other, 1=OpenScape Voice, 2=Broadsoft | Admin -> System -> Registration -> Server type |
| realm | String | SIP realm for digest authentication | Admin -> System -> Registration -> Realm |
| sip-uder-id | String | SIP username for digest authentication | Admin -> System -> Registration -> User ID |
| sip-pwd | String | SIP password for digest authentication | Admin -> System -> Registration -> Password |
| outbound-proxy-user | Boolean | Enable SIP gateway. true or false | Admin -> System -> SIP interface -> Outbound proxy |
| sip-transport-user | Enumeration | SIP transport type. 0=UDP, 1=TCP, 2=TLS | Admin -> System -> SIP interface -> SIP transport |
| transaction-timer | Integer | Transaction timer for call related SIP messages (milliseconds) | Admin -> System -> SIP interface -> Call transaction response timer (ms) |
| transaction-timer-f | Integer | Transaction timer for non call related SIP messages (milliseconds) | Admin -> System -> SIP interface -> NonCall transaction response timer (ms) |
| registration-backoff-timer | Integer | Backoff timer for Registration issues (seconds) | Admin -> System -> SIP interface -> Reg. backoff (seconds) |
| voip-connectivity-check-interval | Integer | Connectivity check intervall (seconds )for TCP and TLS | Admin -> System -> SIP interface -> Connectivity check timer (seconds) |
| media-negotiation-mode | Enumeration | Media negotiation. 0=Single IP, 1=ANAT, 2=ICE | Admin -> System -> SIP interface -> Media negotiation |
| sip-media-IP-mode | Enumeration | SIP media IP mode. 0=IPv4, 1=IPv6, 2=IPv4_IPv6, 3=IPv6_IPv4 | Admin -> System -> SIP interface -> Media IP mode |
| Item name | Type | Details | Related WBM config item |
|---|---|---|---|
| emergency-e164 | String | Emergency E164 number | Admin -> System -> Features -> Configuration -> Emergency number |
| voice-mail-e164 | String | Voicemail number | Admin -> System -> Features -> Configuration -> Voice mail number |
| uaCSTA-enabled | Boolean | Enable uaCSTA. true or false | Admin -> System -> Features -> Configuration -> Allow uaCSTA |
| server-based-features | Boolean | Enable server-based features. true or false | Admin -> System -> Features -> Configuration -> Server features |
| enable-bluetooth-interface | Boolean | Enable Bluetooth interface on CP600. true or false | Admin -> System -> Features -> Configuration -> Enable bluetooth interface |
| call-record-phone-number | String | Call recording number | Admin -> System -> Features -> Configuration -> Recorder address |
| call-record-auto-start | Boolean | Automatically start recording. true or falls | Admin -> System -> Features -> Configuration -> Recording mode |
| call-record-all-calls | Boolean | Record all calls. true or falls | Admin -> System -> Features -> Configuration -> Recording mode |
| call-record-audible-indication | Boolean | Audible indication of recording. true or false | Admin -> System -> Features -> Configuration -> Audible notification |
| call-record-audible-indication-continuous | Boolean | Repeat audible indication of recording. true or false | Admin -> System -> Features -> Configuration -> Audible notification |
| mwi-e164 | String | Message waiting server URI | Admin -> System -> Features -> Addressing -> MW server URI |
| conference-factory-uri | String | Server based conference URI | Admin -> System -> Features -> Addressing -> Conference |
Audio Codec Settings
Audio codecs require a special handling inside the config.xml file as they need to be send as a complete group. Example file below:
<?xml version="1.0" encoding="utf-8"?>
<Message>
<Action>WriteItems</Action>
<ItemList>
<Item name="codec-type" index="1">0</Item>
<Item name="codec-type" index="2">1</Item>
<Item name="codec-type" index="3">2</Item>
<Item name="codec-allowed" index="1">true</Item>
<Item name="codec-allowed" index="2">true</Item>
<Item name="codec-allowed" index="3">true</Item>
<Item name="codec-packet-size" index="1">2</Item>
<Item name="codec-packet-size" index="2">2</Item>
<Item name="codec-packet-size" index="3">2</Item>
<Item name="codec-rank" index="1">2</Item>
<Item name="codec-rank" index="2">1</Item>
<Item name="codec-rank" index="3">3</Item>
<Item name="audio-silence-suppression">false</Item>
</ItemList>
</Message>
| Item name | Item index | Type | Details |
|---|---|---|---|
| codec-type | 1,2 or 3 | Enumeration | 0=G.711, 1=G.722, 2=G.729 |
| codec-allowed | 1,2 or 3 | Boolean | Enables codec referred to by index value. true or false |
| codec-packet-size | 1,2 or 3 | Enumeration | Packet size for codec referred to by index value. 0=10ms, 1=20ms, 2=Automatic, 3=30ms, 4=60ms, 5=40ms |
| codec-rank | 1,2 or 3 | Enumeration | Set codec rank in SDP negotiation. 1=1st preference, 2=2nd preference, 3=3rd preference |
| audio-silence-suppression | no index | Boolean | Enables silence supression. true or false |
