Views

Difference between revisions of "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.

Jump to: navigation, search
(Replaced content with "please see Device Management System ")
 
(124 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Set DMS address via DHCP ==
+
please see [[Device_Management_System | Device Management System ]]
 
 
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  000000'''65'''
 
03  1d  68747470733a2f2f3'''9'''3'''3'''2E3'''1'''3'''2'''3'''2'''2E3'''1'''3'''1'''3'''4'''2E3'''9'''3'''6'''3a3434332f646d73
 
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 XML config 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>
 
 
 
=== Items ===
 
 
 
This section describes the items that can be configured on a CP device via a config.xml file.
 
 
 
==== Network related Items ====
 
 
 
{| {{DefaultTable}}
 
|-
 
! width="200" | Item name
 
! width="100" | Type
 
! width="400" | Details
 
! width="500" | 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
 
|}
 
 
 
 
 
The ItemList can be populated with the following Items
 
{| {{DefaultTable}}
 
|-
 
! width="200" | Item name
 
! width="100" | Type
 
! width="700" | Description
 
|-
 
| e164
 
| String
 
| your SIP user identity
 
|-
 
| reg-addr
 
| String
 
| your SIP server address
 
|-
 
| registrar-addr
 
| String
 
| your SIP registrar address
 
|-
 
| sgnl-gateway-addr-user
 
| String
 
| your SIP proxy server address
 
|-
 
| outbound-proxy-user
 
| Boolean
 
| true or false: send SIP requests via your configured SIP proxy server
 
|-
 
| server-type
 
| Enumeration
 
| 0=Other, 1=OpenScape Voice, 2=Broadsoft
 
|-
 
| realm
 
| String
 
| your SIP realm for Digest Authentication
 
|-
 
| sip-uder-id
 
| String
 
| your SIP user id for Digest Authentication
 
|-
 
| sip-pwd
 
| String
 
| your SIP password for Digest Authentication
 
|-
 
| session-timer
 
| Boolean
 
| true or false: enable or disable the SIP session timer
 
|-
 
| session-duration
 
| Integer
 
| 0-7200(s): If session-timer is enabled, refresh the session after configured value
 
|}
 

Latest revision as of 11:42, 23 June 2020

please see Device Management System