Snom Mass Deployment V7 User manual

Overview | Introduction
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
(S
configuration parameters to the phones
(
aka „
S
ettings“, e.g.
language, timezone, tone scheme, SIP identity) and initiates
firmware updates/ downgrades
firmware
updates/
downgrades
.
Slide 1

Overview | Methods
Mass Deployment V7
Implementation depends on the phone installation environment
Private Local Area Networks Any Network
(3) M l
(4) A t ti
(5) Fi
(1) DHCP
DHCP
(2) Plug & Play
SIP Subscribe
(3)
M
anua
l
Redirection
(4)
A
u
t
oma
ti
c
Redirection
(5)
Fi
x
Redirection
N
o
Reserved for Reserved for
DHCP
Option 66/67
SIP
Subscribe
Broadcast DHCP
Option 66/67
snom partners
(distributors)
snom partner
(OEM)
Si S
Si S
Setting Server URL is
set by DHCP Server
(
tftp-server-name/
btfil
)
Setting Server
URL is set by SIP
Server via SIP
NOTIFY
Setting Server
URL is set by
Manual
Cfi ti
S
ett
i
ng
S
erver
URL is set by
snom
provisioning
S
ett
i
ng
S
erver
URL is
hardcoded in
adapted
OEM
b
oo
tfile
-
nam
e
)
NOTIFY
C
on
fi
gura
ti
on
provisioning
server
adapted
OEM
Firmware
Slide 2

Setting Server | Types
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
Provisioning of configuration
Provisioning of
Provisioning
of
configuration
parameter
Provisioning
of
firmware images
TFTP Yes From V7.2: Yes
HTTP Yes Yes
HTTPS
Yes
No
HTTPS
Yes
No
Slide 3

Setting Server | Network
Mass Deployment V7
Setting Server can be hosted on private or public
servers de
p
endin
g
on the mass de
p
lo
y
ment method
pg py
DHCP Plug & Play Manual
Redirection
Automatic
Redirection
Fix
Redirection
Redirection
Redirection
Redirection
Private Yes Yes Yes No No
P blic
No
No
Yes
Yes
Yes
P
u
blic
No
No
Yes
Yes
Yes
Slide 4

Configuration Parameters | Types
Mass Deployment V7
(1) Write- protected system parameters
• are used internall
y
and cannot be chan
g
ed
yg
• 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)
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/V6/Settings
•
http://wiki
.
snom
.
com/Snom3x0/Web
_
Interface/V6/Settings
•http://wiki.snom.com/Snom3x0/Web_Interface/V7/Settings
Slide 7

Configuration Parameters | WIKI (2)
Mass Deployment V7
In Version 7 each web user interface configuration menu provides
direct access to the description page of the related parameter
•
http://wiki snom com/Settings/parameter name
•
http://wiki
.
snom
.
com/Settings/parameter
_
name
Slide 8

Setting Files | Overview
Mass Deployment V7
Setting files are container for configuration parameters.
Use as little parameters as necessary:
•
General settings e.g. language$, timezone$, etc.
General
settings
e.g.
language$,
timezone$,
etc.
• 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 ”!”.
•!
ÆParameter will not be overwritten when it was chan
g
ed manuall
y
b
y
the user.
gyy
• & or no flag Æwill definitely overwrite existing setting and mark it „read-only“ Æwrite
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 Æuse ONLY "firmware_status" instead
•
Internal parameters
e g update server update filename update host b update host f
Internal
parameters
,
e
.
g
.
update
_
server
,
update
_
filename
,
update
_
host
_
b
,
update
_
host
_
f
,
sip_port, reset_settings, reboot_after_nr, watch_arp_cache etc.
Slide 9

Setting Files | Syntax
Mass Deployment V7
Setting files are XML tagged ASCII- based files
• XML header is required
?l i "10" di "f
8"?
•<
?
xm
l
vers
i
on=
"1
.
0"
enco
di
ng=
"
ut
f
-
8"?
>
• The following XML tags are supported
•
<phone
-
settings>
<function
-
keys> <phone
-
book>
<dialplan>
<firmware
-
•
<phone
settings>
,
<function
keys>
,
<phone
book>
,
<dialplan>
,
<firmware
settings>, <setting-files>, <settings>, <gui-languages>, <phrases>, <web-
languages>, <w_phrases>
Configuration parameter Flag ValueIdentity
Index
Slide 10

XML Provisioning | Container <setting-files>
Mass Deployment V7
XML container is a file construct which allows to load
more then one file type in one go
onto the phone
more
then
one
file
type
in
one
go
onto
the
phone
<setting-files> tag
•Should be the first XML file provided to the phone
•ContainsURL's to all setting files to be provisioned
Th fil d
ih i d
•
Th
e
fil
es are requeste
d
i
n t
h
e g
i
ven or
d
er
•Backwards compatible: Setting files encoded in the older plain
settings format used before firmware release 7 can be included
settings
format
used
before
firmware
release
7
can
be
included
,
however the new dial plan format cannot be used in this case.
Slide 11

XML Provisioning | Container Files
Mass Deployment V7
(1) XML Container file for general configuration files and
language files
• http://ss/snom3x0.htm
(
due to backwards compatibilit
y
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
0
-
MAC.htm
(
the „
-
MAC“ string is automaticall
y
appended by the phone)
Slide 12

XML Provisioning | Container <setting-files>
Mass Deployment V7
(1) http://ss/snom3x0 htm
(1)
http://ss/snom3x0
.
htm
(2) http://ss/snom3x0
MAC htm
(2)
http://ss/snom3x0
-
MAC
.
htm
Slide 13

XML Provisioning | Configuration Files
Mass Deployment V7
(3) XML Settings file for general configuration parameters
• h
ttp
://
ss
/
s
n
o
m
3
x
0
/
ge
n
e
r
a
l.xm
l
ttp ss s o ge e a
(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
l
anguages
• http://ss/web-lang.xml
(6) XML S tti fil f ifi fi ti t
(6)
XML
S
e
tti
ngs
fil
e
f
or spec
ifi
c con
fi
gura
ti
on parame
t
ers
• http://ss/snom3x0/MAC.xml
Slide 14

XML Provisioning | Container <setting-files>
Mass Deployment V7
(1) http://ss/snom3x0 htm
(3) http://ss/3x0/general.xml
<?xml version="1.0" encoding="utf-8" ?>
<setting
files>
(1)
http://ss/snom3x0
.
htm
<setting
-
files>
<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
<file url=
"
http://ss/web
-
lang xml
"
/>
<file
url= http://ss/web
lang
.
xml />
</setting-files>
(2) http://ss/snom3x0
MAC htm
<?xml version="1.0" encodin
g
="utf-8" ?>
(2)
http://ss/snom3x0
-
MAC
.
htm
(6) http://ss/3x0/MAC.xml
g
<setting-files>
<file url="http://ss/3x0/MAC.xml"/>
…
</setting-files>
Slide 15

XML Provisioning | Container <settings>
Mass Deployment V7
(1) http://ss/snom3x0 htm
<?xml version="1.0" encoding="utf-8" ?>
<setting
files>
(1)
http://ss/snom3x0
.
htm
(3) http://ss/3x0/general.xml
<?xml version="1.0" encoding="utf-8" ?>
<settings>
<phone-settings>…</phone-settings>
<setting
-
files>
<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
<file url=
"
http://ss/web
-
lang xml
"
/>
<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dial-plan>…</dial-plan>
/i
<file
url= http://ss/web
lang
.
xml />
</setting-files>
(2) http://ss/snom3x0
MAC htm
<
/
sett
i
ngs>
<?xml version="1.0" encodin
g
="utf-8" ?>
(2)
http://ss/snom3x0
-
MAC
.
htm
(6) http://ss/3x0/MAC.xml
g
<setting-files>
<file url="http://ss/3x0/MAC.xml"/>
…
<?xml version="1.0" encoding="utf-8" ?>
<settings>
h
i/h
i
</setting-files> <p
h
one-sett
i
ngs>…<
/
p
h
one-sett
i
ngs>
…
</settings>
Slide 16

XML Provisioning | V7 | <phone-settings>
Mass Deployment V7
<h
tti >
<
p
h
one-se
tti
ngs
>
• Contains the main part of available configuration parameters
and the
URL of the firmware configuration file
<?xml version="1.0" encoding="utf-8"?>
and
the
URL
of
the
firmware
configuration
file
Value
<phon
e
-
settings
>
<language perm=“!">English</language>
<redirect number perm=
"
$
"
>253</redirect number>
Value
<redirect
_
number
perm= $ >253</redirect
_
number>
…
<user_realname idx="1" perm=“&"></user_realname>
<firmware perm
=""
>http://ss/3x0/firmware.xml</firmware>
<firmware
perm >http://ss/3x0/firmware.xml</firmware>
…
</phone
-
settings>
</phone
settings>
Configuration parameter Flag
Identity
Index
Slide 17

XML Provisioning | Firmware Update Files
Mass Deployment V7
Firmware updates / downgrades are defined in the firmware
confi
g
uration file whose URL must onl
y
be s
p
ecified in the
gyp
<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)
(8) Firmware image file for firmware update
(8)
Firmware
image
file
for
firmware
update
• http://ss/3x0/snom3x0-7.X-SIP-f.bin (firmware image file)
Slide 18

XML Provisioning | Firmware Update Files
Mass Deployment V7
(1) http://ss/snom3x0 htm
<?xml version="1.0" encoding="utf-8" ?>
(1)
http://ss/snom3x0
.
htm
(3) http://ss/3x0/general.xml
<setting-files>
<file url="http://ss/3x0/general.xml"/>
<file url="http://ss/gui-lang.xml"/>
fil l "htt // / b
ll"/
<?xml version="1.0" encoding="utf-8" ?>
<settings>
<phone-settings>…</phone-settings>
<
fil
e ur
l
=
"htt
p:
//
ss
/
we
b
-
l
ang.xm
l"/
>
…
</setting-files>
<function-keys>…</function-keys>
<phone-book>…</phone-book>
<dialplan>…</dialplan>
/i
<?xml version="1.0" encoding="utf-8"?>
<phone-settings>
…
<
/
sett
i
ngs>
(7) http://ss/3x0/firmware.xml
<firmware_status perm="">
http://ss/3x0/firmware.xml
</firmware_status>
<?xml version="1.0" encoding="utf-8" ?>
<firmware-settings>
<firmware perm="">
htt // /3 0/ 3 0
7X
SIP
fbi
…
</phone-settings>
htt
p:
//
ss
/3
x
0/
snom
3
x
0
-
7
.
X
-
SIP
-
f
.
bin
</firmware>
</firmware-settings>
Slide 19

XML Provisioning | <firmware-settings>
Mass Deployment V7
<firmware-settings>
• This XML file type must not be included in container setting
fil
fil
es
• The phone will download the firmware XML file specified in the
URL confi
g
ured under firmware statu
s
g
_
• The setting firmware_status can ONLY be defined in the
settings file of type
<phone-settings>
<?xml version="1.0" encoding="utf-8" ?>
<firmware-settings>
Value = Firmware Image
<firmware perm="">http://.../snom-7.1.9-SIP-f.bin</firmware>
</firmwar
e
-
settin
g
s
>
Do not use an
y
fla
g
g
Configuration parameter = firmware
yg
Slide 20