Snom Mass Deployment V7, 3 Series User Manual

Overview | Introduction

firmware updates/ downgrades

Mass Deployment V7

Mass deployment (aka „Auto Provisioning“) is a function which is
implemented proprietorily in the default firmware of all snom 3xx
VoIP phones.

Mass deployment allows remote

configuration

and

maintenance

of an unlimited number of distinct snom phone types.

Mass Deployment is particularly useful for out-of-the-box
scenarios in larger phone installations.

Mass Deployment can be used to provide general and specific
configuration parameters to the phones (aka „Settings“, e.g.
language, timezone, tone scheme, SIP identity) and initiates

.

Slide 1

Overview | Methods

(3) M

l

(4) Aut

(5) Fi

o

DHCP

SIP Subscribe

S

S

bootfile

-

e

)

NOTIFY

Confi

provisioning

adapted

OEM

Mass Deployment V7

Implementation depends on the phone installation environment

Private Local Area Networks

(1) DHCP

Option 66/67

Setting Server URL is

set by DHCP Server

(

tftp-server-name/

nam

(2) Plug & Play

Broadcast

Setting Server

URL is set by SIP

Server via SIP

Any Network

anua

Redirection

N

Redirection

Reserved for Reserved for

DHCP

Option 66/67

Setting Server

URL is set by

Manual

guration

snom partners

(distributors)

etting Server

URL is set by

omatic

snom

server

x

Redirection

snom partner

(OEM)

etting Server

URL is

hardcoded in

Firmware

Slide 2

Setting Server | Types

Provisioning of configuration

Provisioning of

HTTPS

Yes

No

Mass Deployment V7

Setting Server provide configuration parameters and
firmware updates to snom phones.

• TFTP Server, e.g. tftp://mytftpserver

• HTTP (S) Server, e.g. http://provisioning.mycompany.com,
https://10.0.0.2

TFTP Yes From V7.2: Yes

HTTP Yes Yes

Slide 3

parameter

firmware images

Setting Server | Network

p

pg py

Redirection

Redirection

Redirection

Public

No

No

Yes

Yes

Yes

Mass Deployment V7

Setting Server can be hosted on private or public
servers de

Private

ending on the mass deployment method

DHCP Plug & Play Manual

Yes Yes Yes No No

Automatic

Fix

Slide 4

Configuration Parameters | Types

yg

Mass Deployment V7

(1) Write- protected system parameters

• are used internally and cannot be changed

• factory value is marked by „&“ symbol

• For example: mac&: 0004132YXXXX

(2) Unprotected system parameters

• are used internally and can only be changed via mass deployment

• For example: dst!: 3600 03.05.07 02:00:00 10.05.07 03:00:00

(3) Free configurable parameters

• are those settings which can be changed via the web user interface

• For example: dhcp!: on

Slide 5

Configuration Parameters | Settings“ page

Mass Deployment V7

All available configuration parameter types are listed
on the web user interface page „Settings“:

Slide 6

Configuration Parameters | WIKI (1)

•

http://wiki.snom.com/Snom3x0/Web_Interface/V6/Settings

Mass Deployment V7

A description of each configuration parameter and its relationship
to the web user interface configuration can be found on the WIKI:

• http://wiki.snom.com/Snom3x0/Web_Interface/V7/Settings

Slide 7

Configuration Parameters | WIKI (2)

•

http://wiki.snom.com/Settings/parameter_name

Mass Deployment V7

In Version 7 each web user interface configuration menu provides
direct access to the description page of the related parameter

Slide 8

Setting Files | Overview

General settings e.g. language$, timezone$, etc.

g

gyy

Internal parameters

update_server, update_filename, update_host_b, update_host_f

Mass Deployment V7

Setting files are container for configuration parameters.
Use as little parameters as necessary:

•

• Account specific settings, e.g. user_pname1$, user_name1$, user_realname1$, user_host1,
user_srtp1$ etc.

• Firmware Update related settings, e.g. firmware_status, update_policy, firmware_interval

Use „$“ flags at the beginning

•$ Æ The parameter is changeable, but will be overwritten on each reboot. In the web user
interface “Settings” page it will appear as ”!”.

•!

• & or no flag Æ will definitely overwrite existing setting and mark it „read-only“ Æ write

Æ Parameter will not be overwritten when it was chan

protection can only be removed by „Factory Reset“ or mass deployment.

Do NOT use

• Network parmeters (if DHCP is used), e.g. dhcp, gateway, dns_server1 etc.

• Setting server URL unless you want to redirect the phone to a different setting server

• Firmware parameters, i.e. firmware/ bootloader

•
sip_port, reset_settings, reboot_after_nr, watch_arp_cache etc.

Slide 9

, e.g.

ed manually by the user.

Æ use ONLY "firmware_status" instead

,

Setting Files | Syntax

8"?

•

<phone

settings>

<function

keys>, <phone

book>

<dialplan>

<firmware

Mass Deployment V7

Setting files are XML tagged ASCII- based files

• XML header is required

•<?xml version="1.0" encoding="utf-

• The following XML tags are supported

­settings>, <setting-files>, <settings>, <gui-languages>, <phrases>, <web­languages>, <w_phrases>

Configuration parameter

,

-

>

-

Flag ValueIdentity

,

,

-

Index

Slide 10

XML Provisioning | Container <setting-files>

more then one file type in one go

onto the phone

The fil

settings format used before firmware release 7 can be included

Mass Deployment V7

XML container is a file construct which allows to load

<setting-files> tag

• Should be the first XML file provided to the phone

•Contains URL's to all setting files to be provisioned

•

• Backwards compatible: Setting files encoded in the older plain

however the new dial plan format cannot be used in this case.

Slide 11

es are requested in the given order

,

XML Provisioning | Container Files

0

-

Mass Deployment V7

(1) XML Container file for general configuration files and
language files

•

http://ss/snom3x0.htm (due to backwards compatibility reasons in

mixed phone type environments use „htm“ extension instead of „xml“
for automatical phone recognition)

(2) XML Container file for specific configuration and language
files

•

http://ss/snom3x

MAC.htm (the „-MAC“ string is automatically

appended by the phone)

Slide 12

XML Provisioning | Container <setting-files>

(1) http://ss/snom3x0.htm

(2) http://ss/snom3x0

MAC.htm

Mass Deployment V7

Slide 13

-

XML Provisioning | Configuration Files

ttp

ss/snom3x0/genera

l

ttp ss s o ge e a

l

(6) XML Setti

file f

ifi

Mass Deployment V7

(3) XML Settings file for general configuration parameters

•

h

(4) XML Container file for general phone user interface
languages

•

http://ss/gui-lang.xml

(5) XML Container file for general web user interface

://

l.xm

anguages

•

http://ss/web-lang.xml

•

http://ss/snom3x0/MAC.xml

Slide 14

ngs

or spec

c configuration parameters

XML Provisioning | Container <setting-files>

(1) http://ss/snom3x0.htm

<setting

files>

<file url= http://ss/web

lang.xml />

(2) http://ss/snom3x0

MAC.htm

g

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>

­<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>

"

</setting-files>

-

"

-

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/MAC.xml"/>
…

</setting-files>

(6) http://ss/3x0/MAC.xml

Slide 15

XML Provisioning | Container <settings>

(1) http://ss/snom3x0.htm

<setting

files>

<file url= http://ss/web

lang.xml />

(2) http://ss/snom3x0

MAC.htm

g

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>

-

<?xml version="1.0" encoding="utf-8" ?>

<file url="http://ss/3x0/general.xml"/>

<settings>

<file url="http://ss/gui-lang.xml"/>

<phone-settings>…</phone-settings>

"

</setting-files>

-

"

<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dial-plan>…</dial-plan>

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/MAC.xml"/>
…

</setting-files>

Slide 16

-

</settings>

(6) http://ss/3x0/MAC.xml

<?xml version="1.0" encoding="utf-8" ?>
<settings>

<phone-settings>…</phone-settings>
…

</settings>

XML Provisioning | V7 | <phone-settings>

<ph

tti

>

and the

URL of the firmware configuration file

e

-

>

Value

<redirect_number perm= $ >253</redirect_number>

<firmware perm >http://ss/3x0/firmware.xml</firmware>

</phone

settings>

Mass Deployment V7

one-se

ngs

• Contains the main part of available configuration parameters

<?xml version="1.0" encoding="utf-8"?>

<phon

<language perm=“!">English</language>

…
<user_realname idx="1" perm=“&"></user_realname>

…

settings

=""

"

"

Configuration parameter

Slide 17

Identity

Index

Flag

XML Provisioning | Firmware Update Files

g

gyp

(8) Firmware image file for firmware update

Mass Deployment V7

Firmware updates / downgrades are defined in the firmware
confi

uration file whose URL must only be specified in the

<phone-settings> tag

(7) XML firmware configuration file

•

http://ss/3x0/firmware.xml (contains the URL of the firmware

image; do not use any flags)

•

http://ss/3x0/snom3x0-7.X-SIP-f.bin (firmware image file)

Slide 18

XML Provisioning | Firmware Update Files

(1) http://ss/snom3x0.htm

fil

"http://ss/

l"/

http://ss/3x0/

0

-

7.X

-

SIP

-

f.bin

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
<

e url=

web-lang.xm

>

…

</setting-files>

<?xml version="1.0" encoding="utf-8"?>
<phone-settings>

…

<firmware_status perm="">

http://ss/3x0/firmware.xml
</firmware_status>
…

</phone-settings>

<?xml version="1.0" encoding="utf-8" ?>
<settings>

<phone-settings>…</phone-settings>
<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dialplan>…</dialplan>

</settings>

(7) http://ss/3x0/firmware.xml

<?xml version="1.0" encoding="utf-8" ?>
<firmware-settings>

<firmware perm="">

snom3x

</firmware>

Slide 19

</firmware-settings>

XML Provisioning | <firmware-settings>

fil

g

s

g

e

-

>

g

g

yg

Mass Deployment V7

<firmware-settings>

• This XML file type must not be included in container setting
es

• The phone will download the firmware XML file specified in the

URL confi

• The setting

settings file of type

<?xml version="1.0" encoding="utf-8" ?>

<firmware-settings>

<firmware perm="">http://.../snom-7.1.9-SIP-f.bin</firmware>

</firmwar

Configuration parameter = firmware

ured under

firmware statu

firmware_status

<phone-settings>

settings

can ONLY be defined in the

_

Value = Firmware Image

Do not use any fla

Slide 20

XML Provisioning | Container <settings>

(1) http://ss/snom3x0.htm

<setting

files>

<file url= http://ss/web

lang.xml />

(2) http://ss/snom3x0

MAC.htm

g

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>

­<?xml version="1.0" encoding="utf-8" ?>

<file url="http://ss/3x0/general.xml"/>

<settings>

<file url="http://ss/gui-lang.xml"/>

<phone-settings>…</phone-settings>

"

</setting-files>

-

"

<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dial-plan>…</dial-plan>

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/MAC.xml"/>
…

</setting-files>

Slide 21

-

</settings>

(6) http://ss/3x0/MAC.xml

<?xml version="1.0" encoding="utf-8" ?>
<settings>

<function-keys>…</function-keys>
…

</settings>

XML Provisioning | <function-keys>

Mass Deployment V7

<function-keys>

• Defines the free function keys

<?xml version="1.0" encoding="utf-8"?>

<function-keys>

<fkey idx="0" context="active" perm="$">line</fkey>

Value

Index

<fkey idx="1" context="1" perm="&">dest
<sip:[e-mail];user=phone></fkey>
…
<fkey idx="53" context="12" perm="!">line</fkey>

</function-keys>

Context

Flag

Slide 22

XML Provisioning | Container <settings>

(1) http://ss/snom3x0.htm

<setting

files>

<file url= http://ss/web

lang.xml />

(2) http://ss/snom3x0

MAC.htm

g

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>

­<?xml version="1.0" encoding="utf-8" ?>

<file url="http://ss/3x0/general.xml"/>

<settings>

<file url="http://ss/gui-lang.xml"/>

<phone-settings>…</phone-settings>

"

</setting-files>

-

"

<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dial-plan>…</dial-plan>

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/MAC.xml"/>
…

</setting-files>

Slide 23

-

</settings>

(6) http://ss/3x0/MAC.xml

<?xml version="1.0" encoding="utf-8" ?>
<settings>

<phone-book>…</phone-book>

…

</settings>

XML Provisioning | <phone-book>

>

>

r

Mass Deployment V7

<phone-book>

• Defines the entries of the locally stored phone directory

<?xml version="1.0" encoding="utf-8"?>

<phone-book>

<item context="line1" type="none" index="0">
<name>Adrian</name
<number>42965</number>
</item
…

</phone-book>

Numbe

CategoryContext

Index of

entry

Name

Slide 24

XML Provisioning | Container <settings>

(1) http://ss/snom3x0.htm

<setting

files>

<file url= http://ss/web

lang.xml />

(2) http://ss/snom3x0

MAC.htm

g

/dial

Mass Deployment V7

(3) http://ss/3x0/general.xml

<?xml version="1.0" encoding="utf-8" ?>

­<?xml version="1.0" encoding="utf-8" ?>

<file url="http://ss/3x0/general.xml"/>

<settings>

<file url="http://ss/gui-lang.xml"/>

<phone-settings>…</phone-settings>

"

</setting-files>

-

"

<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dial-plan>…</dial-plan>

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/MAC.xml"/>
…

</setting-files>

Slide 25

-

</settings>

(6) http://ss/3x0/MAC.xml

<?xml version="1.0" encoding="utf-8" ?>
<settings>
<dial-plan>…<

…

</settings>

-plan>

XML Provisioning | <dialplan>

>

R

/>

User= type

is either

IP or

Mass Deployment V7

<dialplan>

• Dial plans enable the phone to support automatic dialing and
automatic generation of a secondary dial tone

MATCH=”pattern”

<?xml version="1.0" encoding="utf-8"?>

<dialplan

<template match="" timeout="" scheme="sip" user="Phone"

ewrite=""

</dialplan>

Rewrite=”altstrng”

Timeout=”sec”

”

”

Phone.

Slide 26

XML Provisioning | <dialplan>

match any character or use an asterisk () to match one or more characters. To

Ti

”

can be left empty

g

pg

Mass Deployment V7

MATCH=”pattern”

• is the dial pattern to match. While entering the pattern: use a period (.) to

*
have the phone generate a secondary dial tone when the part of the template
matches, use a comma (,).

meout=”sec

• is the number of seconds before a timeout will occur and the number will be
dialed as entered by the user. To have the number dial immediately, specify 0.

Rewrite=”altstrng”

• is the alternate string to be dialed instead of what the user enters. This field

.

User=”type”

• is either IP or Phone. Enter User=phone or User=IP to have the ta
automatically added to the dialed number. Currently User=phone is supported.

Slide 27

XML Provisioning | Language Support

e

p

ppg

gg

S

URL

•

<gui

languages>: Defines the language used on the

phone user interface

Mass Deployment V7

snom370:

several

languages (default “English”) come pre-installed

with the firmware

snom300, 320, 360:

on

language (default “English”) is pre-

installed with the firmware Æ additional languages can ONLY be

rovided via XML provisioning Æ the selected language will be

loaded on request into the phone’s RAM

XML language files must match the phone’s application firmware

• Download always the newest language files from: http://fox.snom.com/config, e.g.
http://fox.snom.com/config/snomlang-7.1.28.tgz

• Automatic language provisioning using http://fox.snom.com/config/settings.xml as

etting Server

Supported XML file tags:

-

• <web-languages>: Defines the language used on the

Slide 28

web user interface

XML Provisioning | <xxx-languages>

(1) http://ss/snom3x0.htm

fil

"http://ss/

l"/

name= Deutsch />

<?xml

8"

?>

Mass Deployment V7

(4) http://ss/gui-lang.xml

<?xml version="1.0" encoding="utf-8" ?>
<setting-files>

<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
<

e url=

web-lang.xm

>

…

</setting-files>

(5) http://ss/web-lang.xml

version="1.0" encoding="utf-

<web-languages>

<language url=http://ss/web_de.xml

name="Deutsch" />

…

</web-languages>

<?xml version="1.0" encoding="utf-8" ?>
<gui-languages>

<language url=http://ss/gui_de.xml

"

…

</gui-languages>

"

Slide 29

XML Provisioning | <xxx-languages>

language

g

>

your own translated

XML

gg p g_

T

Mass Deployment V7

<gui-languages> / <web-languages>

• may contain several XML language file URLs each for a different

• Each language file is unique for each firmware version and the name string
determines how the language will appear in the phone's interface language
list.

The URL specified either links

<?xml version="1.0" encoding="utf-8" ?>

<gui-languages>

<lan
…

</gui-languages>

Slide 30

to the official snom or to

language file.

uage url="http://ss/gui_de.xml" name="Deutsch" /

he name specified will appear in the

list of available languages

XML Provisioning | <phrases>

(1) http://ss/snom3x0.htm

fil

"http://ss/

l"/

name= Deutsch />

<?xml

8"

?>

Mass Deployment V7

<?xml version="1.0" encoding="utf-8" ?>

(4) http://ss/gui-lang.xml

<setting-files>

<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
<

e url=

web-lang.xm

>

…

</setting-files>

(5) http://ss/web-lang.xml

version="1.0" encoding="utf-

<web-languages>

<language url=http://ss/web_de.xml

name="Deutsch" />

…

</web-languages>

<?xml version="1.0" encoding="utf-8" ?>
<gui-languages>

<language url=http://ss/gui_de.xml

"

…

</gui-languages>

"

(on request) http://ss/web_de.xml

<?xml version="1.0" encoding="utf-8" ?>

<w_phrases>

<phrase i="0" n="lang_none" t="" />
…

</w_phrases>

Slide 31

XML Provisioning | <phrases> / <w_phrases>

<phrases> / <w_phrases>

phrases in different languages, e.g. gui_lang_EN.xml ,

<ph

>

phrase.

Mass Deployment V7

• The XML language file contains the phone / web user interfaces text

<?xml version="1.0" encoding="utf-8"?>

rases

<phrase i="0" n="lang_none" t="" />
<phrase i="1" n="lang_language_name" t="English" />
…
<phrase i="78" n="lang_tbook" t="Dir" />
…
<language i="0" t="English" />

</phrases>

“

”

The translation of the

The internal name of the

phrase.

The index of the phrases.

Slide 32

Plug & Play | Overview

Usage

using DHCP option 66/ 67

PnP i

Mass Deployment V7

• This is particularly useful for out of the box setup of devices without

Configuration

•

s enabled by default

Slide 33

Plug & Play | SIP SUBSCRIBE (SIP Trace)

(

)

()

Mass Deployment V7

Phone sends a SIP
multicast address

SUBSCRIBE

224.0.1.75

message to a

Slide 34

Plug & Play | SIP SUBSCRIBE (pcap)

Mass Deployment V7

Slide 35

Plug & Play | SIP NOTIFY

Mass Deployment V7

SIP servers which have membership to the group can respond to
the SUBSCRIBE and send NOTIFY messages with the setting
server HTTP URL in the body

The phone retrieves its settings from the URL specified.

Received from udp:192.168.100.10:5060 at 24/12/2001 00:00:19:293 (868 bytes):

NOTIFY sip:192.168.10.67:5060 SIP/2.0
…
To: <sip:[e-mail]>;tag=658512961
From: <sip:[e-mail]>;tag=91955270
Call-ID: 1930770594@192.168.10.67
CSeq: 3 NOTIFY
Content-Type: application/url
Subscription-State: terminated;reason=timeout
…

http://192.168.100.10/sipphone/sipphoneconfig.xml?mac={mac}

Slide 36

Automatic Redirection | Overview

(hardcoded in FW):

gp y g p

the setting server URL to their own setting server

Mass Deployment V7

Snom phones contact snom provisioning server first

•

http://provisioning.snom.com/snom3x0/snom3x0.php?mac={mac}

• Settings script does not deliver any settings back to the phone

Snom partner may request SSH accounts to redirect

Redirection is based on MAC address, registered
MAC addresses will be redirected

Slide 37

Automatic Redirection | Overview

Domain1

Wel

MACxx1

Mass Deployment V7

Customer SSH account

snom.com

Firewall

NAT solved

ProvDB

Domain2
Domain3

LAN

LAN

Registered
Phone

Domain1 config
Domain 1 FW

LAN

Domain1

MACxx1

MACxx2
MACxx3

Phones

come, account! Type help for help.
==> help
Welcome to the snom configuration tool.
You may use the following commands:

SHOW <mac> : Show the status of a phone.
REGISTER <mac> : Register a phone.
REG <mac> : Same as REGISTER.
DEREGISTER <mac>: Deregister a phone.
LIST : List all phones assigned.
BYE : Leave this tool.

A MAC address may be entered as 3 to 6 digit

hexadecimal number, case does not matter
(e.g. 2e4 --> 0004132202E4)

==> list
000413101214 00041310123C

Slide 38

Manual Redirection | Overview

Server option 66 / 67 available

Mass Deployment V7

Environments with few phones or without DHCP

Change the Setting URL field manually via the web or
phone user interface

Slide 39

Fix Redirection | Overview

projects

ill

th

OEM

tti

Mass Deployment V7

Setting URL can be hardcoded for large scale OEM

Assures full control over the phone since each factory
reset w

point to

e designated

se

ng server

Slide 40