innovaphone wiki - User contributions [en]

Howto:Configure the innovaphone Voicemail

2018-06-21T16:12:39Z

Aschild: Added link to DECT MWI howto

The innovaphone voicemail (VM) is implemented as a PBX object.
An answering machine can be assigned to each PBX user.
The VM is script-driven and controlled by means of DTMF touchtones.
It features a built-in WebDAV client, enabling the VM to communicate to an external WebDAV server, which serves as the mass-storage for audio files, script files and user-directories.
The VM script and pre-recorded audio files are subject to be provided by innovaphone.
Message Waiting Indication (MWI) is supported.



==Applies To==
This information applies to

* innovaphone PBX, V6 and Higher

==Supporting The innovaphone Voicemail==
===Tracing===
For a decent supportable trace
*Activate the '''trace''' checkmark within the UI of the voicemail object
*Append the parameter '''$_trace=251''' to the configured script URL, alike so:<code type="text">
https://1.2.3.4/drive/CF0/de/vm.xml?$_trace=251
</code>
*Activate the '''PBX''' checkmark within the [[Reference12r1:Maintenance/Diagnostics/Tracing]] page
==More Information==

===System Requirements===
Voicemail license: The innovaphone voicemail requires licensing. The number of acquired voicemail licenses must be equal or greater than the number of PBX basic licenses.

WebDAV server, e.g.: Apache 2.x, IIS W2K, IIS W3K, or with V6 sr1 the compat flash drive (no external WebDAV server needed)

Innovaphone will provide you with an XML script, that represents the actual voicemail. In addition you will get a set of files with *.g711a, *.g711u and *.g729 extensions. These files contain the audio snippets and the menu prompts, that the voicemail requires.

==Installation, WebDAV==
A few preconditions are assumed as basis for the following few installation and configuration steps:

* The number of the VM object is 66.

* The number of a sample user test is 49.

* The IP address of the WebDAV server is 192.168.0.5.

* The root directory, that contains the VM script and the pre-recorded audio files is c:\Inetpub\webdav\vm\en which corresponds to the URL http://192.168.0.5/webdav/vm/.

* The file name of the voicemail XML script is vm.xml.

===Creating the Voicemail Object===
Proceed to Administration/PBX/Objects.
*Select Voicemail from the drop-down list and click on new.
*Enter Long Name, Name.
*Enter 66 as Number.
*Enter the Script URL as http://192.168.0.5/webdav/vm/vm.xml.
**'''Note:'''Meanwhile it is recommended to enter it as: http://192.168.0.5/webdav/vm/vm.xml?$_pbxfwd=true (see [[#URL Query String Variables]])

===Distributing the Voicemail Script and Pre-Recorded Audio Files===
The download section offers ZIP files and a Windows installation program. See [[#Download]] for how to find the download site.
* ZIP files
**Download the ZIP file for the language your are interested in (e.g. ''vm-de'', ''vm-en'', ...) from the ''apps'' package on the [http://download.innovaphone.com/ice/6.00/ innovaphone download area, V6 Apps].
**Un-ZIP the file. This step creates a language specific sub-directory that may be copied onto the CF-card.
* Windows installation program
**Download the installation program for the ''innovaphone voicemail'' from the [http://download.innovaphone.com innovaphone download area].
**Start the installer program (innovaphone-voicemail-install.exe).
**The installer will be asking for a target directory. Enter ''c:\Inetpub\webdav\vm\''. Now, the installer will copy all of the localized voicemail files into language specific sub-directories. The english files will remain under the absolute path ''c:\Inetpub\webdav\vm\en\''.

===Configuration===
Please note, that a user's VM number is the number of the VM object, that you assigned here, plus the user's number.

Example: If a user has the number 49 and the number of the VM object is 66, then the user's corresponding VM number will be 6649.

===IP Phone Configuration===
====V6, SR1: Recommended Configuration====
A user may wish to manually activate or deactivate a CFU diversion to his VM.
* Browse to the IP phone of the user 49:test:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Call Forwarding'' and click on ''new''.
* A new window will open. Enter ''AM-on'' under ''Idle State/Text''.
* Enter AM-off under ''Active State [1]/Text''.
* Enter ''6649'' into ''Active State [1]/Text/Always/Number''.
* Click on ''OK''.

An additional function key is required to present the MWI and to quick-dial the VM:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Message Waiting'' and click on new.
* A new window will open. Enter ''AM'' under ''Idle State/Text''.
* Select the ''letter'' icon under ''Active State/Icon''.
* If you desire, then choose ''LED/blink''.
* Enter ''6649'' into ''Message Center Account/Number''.
* Click on ''OK''.

====V6, SR2: Recommended Configuration====
The SR2 configuration adapts to mass-deployment requirements, in such that the set of required configuration parameters can be distributed identically among all affected phones.

A user may wish to manually activate or deactivate a CFU diversion to his VM.
* Browse to the IP phone of the user 49:test:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Call Forwarding'' and click on ''new''.
* A new window will open. Enter ''AM-on'' under ''Idle State/Text''.
* Enter ''AM-off'' under ''Active State [1]/Text''.
* Enter ''66'' into ''Active State [1]/Text/Always/Number''.
* Click on ''OK''.

An additional function key is required to present the MWI and to quick-dial the VM:
* Proceed to ''Configuration/RegistrationX/Function Keys''.
* Select a free function key, choose ''Message Waiting'' and click on new.
* A new window will open. Enter ''AM'' under ''Idle State/Text''.
* Select the letter ''icon'' under ''Active State/Icon''.
* If you desire, then choose ''LED/blink''.
* Enter ''66'' into ''Message Center Account/Number''.
* Activate the ''Append Own Number'' checkmark.
* Click on ''OK''.

====Deploying the MWI Function Key By An Update Script====
From on V6,SR2 the MWI key configuration can be designed to be applicable for all phones. The following excerpt shows how the resulting configuration line would look alike for our example.

mod cmd PHONE USER-UI/0 fkey-edit /id 0 /fkey_id 0 /fkey_type mwi /label mwi-off /icon letter /mwi.label mwi-on /mwi.icon letter-black /mwi.led blink /mwi.e164 66 /mwi.ext on /op OK

* ''/mwi.e164 66'' defines the MC number ''66''
* ''/mwi.ext on'' activates the ''Append Own Number'' checkmark

===Webserver Aspects===
WebDAV in Common: As stated above, WebDAV is required for the VM to work.

What is WebDAV? In its long form it reads "Web-based Distributed Authoring And Versioning" and is specified in RFC2518.
Technically is WebDAV a set of protocol extensions to the HTTP protocol.
These extensions allow for some file i/o operations,that aren't covered by HTTP:
*Renaming, moving, copying a file file.
*Properties: That is, information retrieval about a certain file. E.g. the file creation time.

===Webserver Authentication===
If HTTP Authentication is required, configure a triple of ''URL,User,Password'' underneath ''Configuration/General/HTTP-Client''.

In our example ''http://192.168.0.5/webdav/'' may be entered as ''URL''. Every URL that head-matches this URL and requires authentication will be authenticated with the user,password provided here.

===Apache Webserver 2.x===
The Apache supports WebDAV from on version 2.0 natively.

However, WebDAV must be enabled to be run. Please find the respective documentation page at apache.org under http://httpd.apache.org/docs/2.0/mod/mod_dav.html .

Test Environment: Our test environment was a RedHat Linux 8.x.
The configuration file for httpd resides under /etc/httpd/conf/httpd.conf .
The voicemail is located underneath /var/www/webdav/vm/.

Open httpd.conf with a text editor.
*Ensure the modules required for WebDAV are being loaded
<code apache>
LoadModule dav_module modules/mod_dav.so
LoadModule dav_fs_module modules/mod_dav_fs.so
</code>

*Ensure, that WebDAV is enabled and that an alias is being created for webdav
<code apache>
Dav On
Alias /webdav "/var/www/webdav"
</code>

*In our test environment we didn't restrict access to the webdav directory
<code apache>
Options Indexes MultiViews
Allow from all
</code>

An important aspect is the fact, that we had to apply chmod -R 766 to the /var/www/webdav directory. chmod -R 666 didn't suffice.

Without doing so, i.e. granting the read-/write-/execute-access, we received Forbidden responses when e.g. trying to read the filenames within a directory.

A potential delay source can be reverse DNS lookups. A webserver is trying to retrieve a DNS name for every source address it receives requests from. The drawback is, that every HTTP request is being delayed by the amount of time it takes to complete the reverse DNS lookup.

Within httpd.conf we therefore wrote ''HostNameLookups Off'', in order to avoid DNS requests for logging purposes.

Please note further that access restrictions with DNS names, instead of IP addresses, will
bypass this setting, i.e. will make the ''HostNameLookups Off'' -setting ineffective.

===Microsoft Internet Information Server (IIS), W2K===
As a testbed an IIS 5.0 was utilized on a Windows 2000 server. By default WebDAV is already enabled within IIS 5.0. However, no data is published.

*To publish data simply.
Create a new virtual directory webdav within the default website by means of the IIS Admin. Allow read, write and browse operations being executed on that directory and underneath.
Use the Windows Explorer to modify the security settings of the directory (and underneath) and set it to full access for everyone (It is left up to the Windows experts how to restrict this further).

===Microsoft Internet Information Server (IIS6), W2003 ===
In contrast to Windows 2000 Server, Windows Server 2003 does not come with WebDAV being already enabled. In addition File extensions with *.g711a, *.g711u and *.g729 must be configured as a new Mime-Type. You must enable WebDAV from within the IIS Admin first. Files with the extension *.g711a, *.g711u and *.g729 will not be returned.

*You must add *.g711a, *.g711u *.g729 as a Mime-Type, otherwise the audio files won't be accessible.
Pls. see: MS KB article Q326965 http://support.microsoft.com/kb/326965/en-us ,respectively http://support.microsoft.com/kb/326965/de-de for how to do this.

Browse to http://192.168.0.5/webdav/vm/ and try to download a g711a-file and a g729-file from within your browser. This step will prove, that the Mime-Types were successfully added.

'''Note:''' After the new Mime-Types were added an IIS6 restart seemed to be a MUST.

===Microsoft Internet Information server (IIS7)===
Two possibilities for authentication are available.

====HTTPS With Basic Authentication====
IIS7 does NOT support HTTP ''Basic Authentication'' without HTTPS/TLS. Therefore it is mandatory to run WebDAV towards the IIS7 on HTTPS and not on HTTP.
*Within the Voicemail object a "<nowiki>https://..</nowiki>"-URL must be configured.
*Under ''General/HTTP/Client'' a user/password tupel must be configured for the "<nowiki>https://..</nowiki>"-URL.
*Within the IIS Admin it must be ensured that ''Basic Authentication'' is allowed.
*Try calling the voicemail object. The request for the voicemail script is going to fail.
*Watch out for a rejected certificate under ''General/Certificates'' and trust that certificate.
*Try calling again the voicemail object. This time the request for the voicemail script should be succeeding.

====HTTP With Digest Authentication====
{{FIXME|reason="Information is vague. Practical confirmation needed. Detailing needed."}}
A user account must be configured within the Active Directory to allow it's password be cached. This is simply because the digest authentication needs to derive a challenge value from a password. That user account/password tupel must in turn be utilized for the innovaphone HTTP client.

We have had reports that digest authentication does not work with some IIS7 servers. Evaluation has shown that these servers do require <code>MD5-sess</code> instead of <code>MD5</code> as endpoint authentication type.

Microsoft states ''For security reasons, Windows-based digest authentication only supports MD5-sess encryption over domain controllers that are running under Windows Server 2003.'' [http://technet.microsoft.com/en-us/library/ms191264.aspx]. This suggests that authenticated HTTP access from an innovaphone box to an IIS7 using a domain account may not work at all as long as we do not support MD5-sess (which we don't do as of this writing (January 2012)). A possible fix may be to use a local server account (although this has not been tested).

===Microsoft Internet Information server (IIS7.5)===
Despite an allegedly configured server role ''WebDAV Publishing'' a WebDAV-connect wasn't possible until adding a ''WebDAV Authoring Rule'' by means of the IIS Admin.
*'''Access for''' Entire Content
*'''Grant Conten Access For''' All Users
*'''Rights''' Read, Source, Write

Before administrating this step a ''PROPFIND'' was always honored by a ''405/Method Not Allowed''.

===innovaphone own WebDav Server (Compact flash card slot)===
Please see [[#Installation, CompactFlash Card|Installation, CompactFlash Card]] below.

===Testing WebDAV Access===
From within the Windows Explorer go to Tools/Map Network Drive.
*Select Web folder or FTP site.
*Enter the URL http://192.168.0.5/webdav/ and proceed.

Now you may test whether you can read files, write files, delete files, create directories.

===User-Related Files And Directories===
Our sample user has the number 49 and the name test. When this user calls his box 6649 for the first time, the VM will create a directory for him and underneath a pair of additional directories. The new directories for the user test are:

*…/webdav/vm/test/. New voicemails will be copied here.
*…/webdav/vm/test/personal. The personal greeting message resides here.
*…/webdav/vm/test/store. When a message is stored, it is copied into this location.

If the directory creation fails, the call to the VM will be forcedly disconnected.

===PIN Administration===
Initially, there is a default PIN active. When being asked for a PIN, enter 8765.

The PIN can be changed by means of menu option 4.

The PIN can be reset administratively to the default by just deleting ''.../personal/pin.txt'' within a user's directory.

You should '''change the default PIN''' to a different value before installing the Voice Mail. This is done with a text editor in the ''vm.xml'' script. Change the value <code>8765</code> in function ''CheckPin'' and function ''EnterPin''.

===URL Query String Variables===

URL Query String Variables are generally passed on to a script.

The following variables control the script's behaviour and may be applied within the configured script-URL alike: http://192.168.0.5/webdav/vm/vm.xml?$_nopin=true.

Multiple variables can be combined by an ampersand (&) alike: http://192.168.0.5/webdav/vm/vm.xml?$_nopin=true&$_pbxcoder=g711a.

* $_nopin. Controls, whether a PIN must be entered.
**true: Voicemail owner doesn't need to enter a PIN when calling from his extension.
**false (default): A PIN must be entered
(Note: A PIN must always be entered when calling from "foreign" extensions)

* $_initdelay: Controls, whether an initial silence prompt is going to be played to a caller. From on script version ['''vm.xml 60096'''].
** 0(default): No silence prompt will be played.
** a value greater than 0: A silence prompt of ''N'' seconds is going to be played. For hosting scenarios the recommended value is '1'.

* $_pbxcoder. Allows to restrain the offered coder list, when executing <pbx-prompt> for files with "*.$coder" extensions.
** The internal default is: $_pbxcoder=g729,g711a,g711u,g723

* $_pbxfwd
** true: diversions will be executed on <pbx-fwd>
** false (default): diversions won't be executed on <pbx-fwd>

* $_pbxmwidir. Allows to configure a parent directory for all user sub-directories and for all MWI operations. As default there is no such directory active.

* $_pbxremhold
** true (default): Rules whether caller will be sent a REMOTE-HOLD while executing <pbx-fwd>.
** false: No REMOTE-HOLD is sent

* $_noctl (from on v8hotfix8)
**true: Control-calls (calls without media) will be rejected
**false (default): no rejection

* $_divconn (from on v9hotfix17)
**true: Auto-Connect for calls being recognized as diverted or transferred calls
***Note: Until V11r1sr2 the former default was ''true''
**false(default): No automated connection for diverted/transferred calls.
'''Note:''' It is recommended to configure '''$_divconn=false''' in scenarios with remote media streaming(via an active registration at the VM object).

* $_trace, decimal number: Controls verbosity of tracing outputs. The following values can be added. Everything can be traced by simply entering 255 (i.e. ''$_trace=255'').
** 1: errors, 2: interpreter, 4: parsing, 8: code, 16: store operations, 32: http operations (during <exec>), 64: <debug> statements, 128: webmedia

*$_leg2tweak (from on v9hotfix21) controls <pbx-getcallinfo out-leg2=".."/>
**true(default): set leg2 to <ext-nr> from <vm-nr>+<ext-nr>
**false: set leg2 according to received divertingInfoLeg2 facility

*$_trailhash (from on v9hotfix21) controls <pbx-getcallinfo out-cdpn=".."/>
**true: pass trailing (en-bloc) '#' into cdpn
**false(default): don't pass trailing (en-bloc) '#' into cdpn

* $_pbxfwdrel controls <pbx-fwd> (from on v10sr5)
**conn: release all interpreter resources after a successful connect. No further scripting affects the call.
**imm: release all interpreter resources immediately on the execution of the <pbx-fwd> statement. No further scripting affects the call.
**false(default): No tweaks apply. The script interpreter remains active.

*$app activates settings, necessary for the App Platform's Voicemail App (v13r1 and later only)
**on: Activate internal settings for the Voicemail App (only use this setting if the voicemail runs on the new App Platform)
**off(default): No tweaks apply.

==Installation, CompactFlash Card==
Instead of using a WebDAV server you may want to use the local CompactFlash card as mass storage device. This section outlines how this can be accomplished.
=== Installing the Voicemail on a CompactFlash Card ===
Please see the article [[Howto:Installing the voicemail/music on hold on a compact flash card|Howto:Installing the voicemail on a compact flash card]].

The aforementioned configuration scenario, within the above chapter: [[#Installation, WebDAV|Installation, WebDav]], does also apply for an installation on a CompactFlash card. Please, refer to that chapter if you look for informations on how to generally configure a basic voicemail scenario, including the affected ip phone configuration.

==Advanced Configuration==
=== Maximum Message Length ===
By default, voicemail messages are limited to 50 seconds each.
To change the maximum length (e.g. to 5 minutes), you have to change the following code line

<pbx-record url="$vm" sec="50"/>

to

<pbx-record url="$vm" sec="300"/>

=== Change Filename of the Recorded Messages of Voicemail ===

By default the vm.xml records the voice messages in the CF at UserBox with an Unique Name, type of GUID + Extension and this is also what is send to the user email when we set that option. Example : 2110d5f4e909d311baab0090332901b6-202.wav

We can change this filename format by editing the vm.xml approx. line 63:

replace

<store-getnew root="$sub" out-url="$vm"/>
<lib-strcat string="$vm" string2="-" out-string="$vm" />
<lib-strcat string="$vm" string2="$cgpn" out-string="$vm" />
<lib-strcat string="$vm" string2=".g711a" out-string="$vm" />

with

<store-getstat root="" name="NULL" out-wday="$wday" out-mday="$mday" out-mon="$mon" out-year="$year" out-hour="$hour" out-min="$min"/>
<store-get root="$sub" name="Date_" out-url="$vm"/>
<lib-strcat string="$vm" string2="$year" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$mon" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$mday" out-string="$vm" />
<lib-strcat string="$vm" string2="_time_" out-string="$vm" />
<lib-strcat string="$vm" string2="$hour" out-string="$vm" />
<lib-strcat string="$vm" string2="_" out-string="$vm" />
<lib-strcat string="$vm" string2="$min" out-string="$vm" />
<lib-strcat string="$vm" string2="_number-" out-string="$vm" />
<lib-strcat string="$vm" string2="$cgpn" out-string="$vm" />
<lib-strcat string="$vm" string2=".g711a" out-string="$vm" />

Doing this will obtain a filename with Date, Hour, Number and CGPN.

===Leave Message to the VoiceMail Box of the original called User===
By default the VoiceMail stores the voice message to the Mailbox of the Object performing diversion to the VoiceMail. E.g. if "User A" creates a call forward to the VoiceMail, the Mailbox is used to store the message is from "User A". In case "User A" creates a call forward to a Waiting Queue or Call Broadcast, and than from Call Broadcast Group to the VoiceMail, the message will be stored in the Mailbox of the Call Broadcast Group.

To change this behaviour and to store the Message always to the Mailbox of the originally called User, change the vm.xml as following:

search the line:

<code xml>
<pbx-getcallinfo out-cgpn="$cgpn" out-cdpn="$cdpn" out-leg2="$leg2"/>
</code>

and replace them with the following

<code xml>
<pbx-getcallinfo out-cgpn="$cgpn" out-cdpn="$cdpn" out-leg2="$leg2" out-leg2-orig="$leg3"/>
</code>

add the following code after the line

<code xml>
<switch var="$leg3">
<case not-equal="">
<assign out="$leg2" value="$leg3"/>
<assign out="$_pbxcdpn" value="$leg3"/>
</case>
</switch>
</code>

===Sending of additional MWIs===
* [[Howto:How To Send Additional MWIs within a PBX|How To Send Additional MWIs within a PBX]]
The article deals with the question how a single voicemail box can be shared among a few users.
===Custom Personal Announcement===
* [[Howto:Deploy A Custom Personal Announcement For the innovaphone Voicemail|Deploy A Custom Personal Announcement For the innovaphone Voicemail]]
Explains where to copy an externally generated personal announcement file.
===A Simple Recording Solution On-Top of The innovaphone Voicemail===
* [[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail|A Simple Recording Solution On-Top of The innovaphone Voicemail]]
This article explains how a simple recording solution could be set up on-top of an innovaphone Voicemail.
===Send Email MWI Notification From The innovaphone Voicemail===
*[[Howto:Send Email MWI Notification From The innovaphone Voicemail|Send Email MWI Notification From The innovaphone Voicemail]]
This functionality is available from on SR2 and allows to send MWI notifications by email.

==Quick Reference For innovaphone Voicemail==
* [[Howto:Quick Reference For innovaphone Voicemail|Quick Reference For innovaphone Voicemail]]
The article outlines the menu structure and provides a few operational hints from a user's perspective.

==Known Problems==
The VM makes use of V6’s media negotiation capabilities.
This is why V5 endpoints are not supported.

*[[Support:Voicemail Calls Hanging Around In PBX Call Monitor|Support:Voicemail Calls Hanging Around In PBX Call Monitor]]
*[[Support:Voicemail: Voicebox Not Configurable With "Send Number" set|Support: Voicemail: Voicebox Not Configurable With "Send Number" set]]
* When the voicebox is created upon the first call to the users voicemail, you must not have the ''Send Number'' property configured in the calling user object. Otherwise, the voicebox will be created for the wrong number
* [[Support:Voicemail Fails With "Missing Voicemail License!"|Support:Voicemail Fails With "Missing Voicemail License!"]]
*[[Support:Voicemail Fails With "Authentication Required"|Support:Voicemail Fails With "Authentication Required"]]
*[[Support:Webdav_Access_Slow_From_Windows_7_/_Vista|Support:Webdav Access Slow From Windows 7 /Vista]]
* You can not have a voice mailbox for users that have a slash (<code>/</code>) in the ''Long Name''. For such user, when calling the voice mail, a spoken error message ''an error occured'' is heard
** de: ''es ist leider ein Fehler aufgetreten''
* If the voicemail URL is a webdav server on a LinuxAP, the dns domain name of the URL must be typed in lower cases, otherwise changes to the welcome and personal message (name_greetings and personal_greetings) won't be correctly saved.
* If the voicemail is located on a webdav server on a LinuxAP make sure the folder of the voicemail has for group and owner "www-data" and not "root". Otherwise you cannot create user folders.

== Related Articles ==

===Voicemail Installation===

* [[Howto:How to setup an V6 IP Phone for innovaphone voicemail usage]]
* [[Howto:Send Email MWI Notification From The innovaphone Voicemail]]
* [[Howto:Quick Reference For innovaphone Voicemail]]
* [[Howto:Forward your Mobile's Mailbox to your innovaphone Voicemail]]
* [[Howto:MWI for DECT]]

===Voicemail on Compact Flash===

* [[Howto:General information for compact flash cards]]
* [[Howto:Installing the voicemail/music on hold on a compact flash card]]

===Voicemail Customising===

* [[Howto:Deploy A Custom Personal Announcement For the innovaphone Voicemail]]
*[[Howto:Does innovaphone voicemail support multiple announcements?]]
* [[Howto:How To Send Additional MWIs within a PBX]]
*[[Howto:Send Email from the innovaphone Voicemail without saving data on the CF]]
*[[Howto:Localize Voice Mail Messages]]

===Voicemail Scripting===

*[[Howto:Implement a simple caller notification]]
*[[Howto:Getting started with your own PBX voicemail script]]
*[[Howto:Debug_your_own_PBX_voicemail_script]]
*[[Howto:A Simple Recording Solution On-Top of The innovaphone Voicemail]]
*[[Howto:Voicemail Scripting And Projektcode, PIN, Auth Code]]
*[[Howto:Simple ACD with Voicemail XML Script]]
*[[Howto:Control Call Forward with Voicemail XML Script]]
*[[Howto:Using the Voicemail object as a post call review]]
*[[Howto:Voice_Mail_multiple_announcements_with_and_without_possibility_to_leave_a_message]]
*[[Howto:Speaking_Clock_with_Voicemail_XML_Script]]
*[[Howto:Absence_Memo_with_VoiceMail_XML_Script]]

== Download ==
The voicemail product can currently be found on the [http://download.innovaphone.com/ice/6.00/#apps apps section] of the innovaphone download site. This product is suitable for PBX firmware ''versions 6 and up''.

[[Category:Howto|{{PAGENAME}}]]

Howto:Voice Mail multiple announcements with and without possibility to leave a message

2018-03-19T08:34:04Z

Aschild: FR voice prompts hinzugefügt

{{Template:3rd_Party_Input}}
==Applies To==
This information provides several enhancements to the standard Voice Mail script such as e.g. to provide multiple announcements.

==More Information==
=== English ===
Here you will find a customized voice mail version with several announcements as AB or as announcement only.

The following points have been enhanced:

* DECT integration
* Up to nine personal announcements per user, by default only one announcement is active.
* The possibility to use the announcements as pure announcements without leaving a message
* For new messages, the 3 must not be pressed from the main menu to query but it jumps there immediately
* When interrogating the messages, the number of the caller who has been transmitted is announced
* If there is no text on the voice mail, a variable "$ _basicnumber" can be passed with the root number in the script Example: http://192.168.1.10/webdav/vm-de/vm.xml?$_nopin=true&$_basicnumber=0714237508
* There is now the possibility to play a public announcement before the name announcement. Just put the file "de_customer_public_name" into the voicemail directory.
* It is now possible to play a public announcement before the number announcement. Simply put the file "de_customer_public_box" into the voicemail directory.

==== New Announcements ====
Announcements are unfortunately only available in German (see below).

==== Configuration ====
A working voicemail is expected and then only the files from the download need to be replaced.

=== German ===
Hier finden Sie eine angepasste Voice Mail Version mit mehreren Ansagen als AB oder als nur Ansage.

Folgende Punkte wurden angepasst:

* DECT Integration
* Bis zu neun persönliche Ansagen pro User, per default ist nur eine Ansage aktiv.
* Die möglichkeit die Ansagen auch als reine Ansagen zu verwenden ohne eine Nachricht zu hinterlassen
* Bei neuen Mitteilungen muss aus dem Hauptmenü die 3 zum Abfragen nicht gedrückt werden sondern es springt sofort dort hin
* Beim Abfragen der Nachrichten wird die Rufnummer des Anrufers die übermittelt wurde angesagt
* Wenn kein Text auf der Voice Mail ist kann eine Variable "$_basicnumber" mit der Stammrufnummer im Script übergeben werden Beispiel: http://192.168.1.10/webdav/vm-de/vm.xml?$_nopin=true&$_basicnumber=0714237508
*Es gibt jetzt die Möglichkeit eine Öffentliche Ansage vor der Namensansage abzuspielen. Dazu einfach die Datei "de_customer_public_name" in das Voicemail Verzeichnis legen.
*Es gibt jetzt die Möglichkeit eine Öffentliche Ansage vor der Nummernansage abzuspielen. Dazu einfach die Datei "de_customer_public_box" in das Voicemail Verzeichnis legen.

==== Neue Ansagen ====
Folgende Ansagedateien wurden erweitert:
; de_menu_voicebox_greetings_personal_2 : Um die aktuelle persönliche Ansage als Anrufbeantworter zu aktivieren, drücken sie vier
: Um die aktuelle persönliche Ansage ohne Anrufbeantworter funktion zu aktivieren, drücken sie fünf

; de_menu_voicebox_greetings_personal_3 : Um mehrere Ansagen zu aktivieren, wählen sie sechs.
:Um mehrere Ansagen zu deaktivieren, wählen sie sieben.
:Um in das Hauptmenü zurückzukehren, wählen Sie Stern.

; de_select_greeting : Bitte wählen Sie die gewünschte Ansagennummer zwischen eins und neun

; de_please_enter_the_boxnr : Bitte geben Sie ihre Voice Mail Nummer ein

; de_received_by_number : empfangen von Rufnummer

; de_aktiv_rec : Ihre Ansage wurde als Anrufbeantworter aktiviert

; de_aktiv_norec : Ihre Ansage wurde ohne Anrufbeantworterfunktion aktiviert

====Konfiguration====
Es wird eine funktionierende VoiceMail erwartet und dann müssen nur die Dateien aus dem Download ersetzt bzw. ergänzt werden.

==Known Problems==
Please tell us mailto:olaf.gruen@business-voice.de

== Related Articles ==
See [[Howto:Configure_the_innovaphone_Voicemail#Related_Articles]]

== Download ==
[[Media:VM_erweiterung_v2.zip]] 
[[Media:VM_erweiterung_v2_fr.zip]] 
[[Image:Anleitung.png]] 



[[Category:Sample|{{PAGENAME}}]]

Howto:Gigaset N510 PRO - Gigaset - Testreport

2017-10-26T09:52:01Z

Aschild: /* Known problems */

==Summary==

The Gigaset N510IP PRO DECT base-station supports all required innovaphone features and is therefore qualified as [[Howto:What_is_a_%22recommended_product%22%3F|recommended product]].

The usage of wideband codecs of the phone were tested successfully. The integration of the innovaphone voicemail in the Gigaset solution is possible. The message waiting indication will be displayed on the handsets. The handsets support 3-party conference calls.

The Gigaset N510IP PRO DECT base-station was tested successfully also in a [[Howto:Hosting#Overview | hosted setup]]. The test results are the same as if the N510IP is used in a normal (in the same LAN as the PBX) setup. It is not required to activate MediaRelay on the Frontend.

==Certification Status==

{{Template:Compat Status "tested"}}





Testing of this product has been finalized September 6th, 2013.

==Version==
Firmware Version:
* 42.078 (420780000000 / V42.00)

innovaphone Firmware:
* V10 SR3
* TSP 8150

== Test Setup ==
[[Image:Testreport_Terminals_SIP_or_H323_1.PNG]]

==Device Setup==

{| border="1"
!Tested feature
!Result
|----
|Register Device w/o specific configuration (requires DHCP)
|No
|----
|DHCP is default
|Yes
|----
|DHCP yields timeserver and time displays correctly
|No, set static to public NTP server
|----
|SNTP config has TZ string for timezone/dst autoconfig
|No, set static to public NTP server
|----
|DHCP yields correct default gateway
|Yes
|----
|Device supports magic registration (e.g. by serial)
|No
|----
|Fixed registrations works
|Yes
|----
|Device registers w/o Extension (just by name)
|Yes
|----
|Device registers by name with non-latin1 characters (e.g. UserÄÖÜ)
|Yes
|----
|Device registers by extension
|Yes
|----
|Device registers with password
|Yes
|----
|Device registers multiple identities
|Yes
|----
|2nd GK is supported
|According to [https://gigaset.atlassian.net/wiki/pages/viewpage.action?pageId=28540959 gigaset-wiki] only by DNS according to RFC3263
|----
|Device supports Redirection of Registration (Master redirects to Slave)
|No
|----
|Device supports STUN protocol
|Yes
|----
|Device sends NAT - keepalive messages
|Yes
|----
|Device refreshes the PBX registration
|Yes
|----
|Device supports SIP over TCP
|Not tested in LAN setup. Not usable for Hosting Setup, TCP connection is close immediately after SIP-TCP messages was sent. As a result - in a hosting setup the phone is not reachable for incoming calls.
|----
|Device supports SRTP
|Not tested, needs SIPS
|----
|Device supports SIPS (SIP over TLS)
|Not OK, registration fails
|----
|Device supports HTTPS
|Not for Admin access on the Web-page, probably as HTTP-client to retrieve firmware/configuration from remote servers
|----
|Device supports VAD (Voice activity detection)
|Not tested, according to manual supported
|----
|Supported menu languages
|many, check [http://gigaset.com/de/de/pages/index.html product specifications]
|----
|3-party conference
|Yes
|}

==Test Results==

=== Basic Call ===

{| border="1"
!Tested feature
!Result with MR
|----
|call using g711a
|Yes
|----
|call using g711u
|Yes
|----
|call using g729
|Yes
|----
|call using g722
|Yes
|----
|Overlapped sending
|No
|----
|Device sets up an early media channel for incoming calls
|N/A
|----
|Device sets up an early media channel for outgoing calls
|Yes
|----
|Device shows called id number
|Yes
|----
|Device shows called id name
|Yes
|----
|Device shows called id display info
|Yes
|----
|Fax using T.38
|N/A
|----
|CGPN can be suppressed
|Yes
|----
|Reverse Media Negotiation
|Yes
|----
|Device shows CDPN/CGPN on incoming call
|Yes
|----
|Device shows CDPN/CGPN on outgoing call
|Yes
|----
|Device shows connected number
|No
|----
|Device shows diverting number
|No
|----
|Device supports distinctive ringing
|Yes
|----
|Device supports asymetric codec negotiation
|Not tested
|----
|Device supports codec renegotiation during a conversation
|Yes
|----
|Device shows correct display message in case of busy CDPN
|Yes
|----
|Device shows correct display message in case of not existing CDPN
|No, it says "Not available"
|----
|Device shows correct display message in case that the call is declined
|Yes
|----
|3party conference possible
|Yes
|----
|Device supports display updates during call(needed for Directory Search object)
|No
|----
|Long Time Call (>30 min) works?
|Yes
|----
|Incoming SRTP call - SRTP not enabled on DUT
|Yes
|----
|Incoming SRTP call - SRTP enabled on DUT
|Not tested, requires sips
|----
|Voice Quality OK?
|Yes
|}

=== DTMF ===

{| border="1"
!Tested feature
!Result
|----
|DTMF tones sent correctly
|OK
|----
|DTMF tones received correctly
|OK, DTMFs are sent as RTP-Events (no DTMF dependent function on Gigaset device)
|}

=== Hold/Retrieve ===

{| border="1"
!Tested feature
!Result
|----
|Device handles incoming hold correctly
|Yes
|----
|Device can put a call on hold using correctly(inactive or sendonly)
|Yes
|}

=== Transfer with consultation ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Transfer without consultation (alerting only) ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Blind Transfer ===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls inno2. inno1 transfers to testphone.
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|}

=== Blind Transfer (alerting only)===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|}

=== Broadcast Group & Waiting Queue ===

{| border="1"
!Tested feature
!Result
|----
|testphone makes call to a Broadcast Group. inno1 picks up.
|Yes
|----
|inno1 makes call to a Broadcast Group. testphone picks up.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up before announcement is played.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up after announcement is played.
|Yes
|----
|inno1 makes call to a Waiting Queue. testphone picks up.
|Yes
|}

=== DTMF Features ===

{| border="1"
!Tested feature
!Result
|----
|CFU Activate/Deactivate
|Ok
|----
|CFB Activate/Deactivate
|Ok
|----
|CFNR Activate/Deactivate
|Ok
|----
|Pickup Group
|Ok
|----
|Pickup Directed
|Ok
|----
|Park/Unpark
|Ok
|----
|Park To/Unpark From
|Ok
|----
|Call Completion Busy
|Nok, Gigaset rejects incoming call for starting CCBS/CCNR
|----
|Call Completion Cancel
|Not tested, since CCBS/CCNR does not work
|----
|Join Group/Leave Group
|Ok
|----
|Join All Groups/Leave All Groups
|Ok
|----
|Enable mobility/Disable mobility
|Not tested, feature is invoked by mobile phone
|----
|Enable mobility cw/Disable mobility cw
|Not tested, feature is invoked by mobile phone
|----
|Set presence
|Ok
|}

==Other Features==

===Directory===

{| border="1"
!Tested feature
!Result
|----
|Device built-in directory
|----
|Exists
|Yes
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

*It is possible to configure a connection to an online source like DE - Klicktel. Please take a look into the manual or configuration.
*It is possible to import and export the local Phonebook.
*You can add the call to the local phonebook from the call-list.

{| border="1"
!Tested feature
!Result
|----
|External LDAP Server supported
|Yes, tested with Estos Metadir. PBX not supported as external LDAP server and LDAPS not supported.
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

===Keys===

{| border="1"
!Tested feature
!Result
|----
|Device has speed dial keys
|Yes, depending on handset
|----
|Device has programmable function keys
|Yes, depending on handset
|----
|Device has partner keys
|No
|}

===CTI Features (with SOAP / TAPI / myPBX) ===

{| border="1"
!Tested feature
!Result
|----
|User Call - outgoing call
|Ok
|----
|User Connect - Answer incoming call
|Ok
|----
|User Reject - Reject alerting call
|Ok
|----
|User Disconnect - Disconnect active call
|Ok
|----
|User Hold - Put connected call on hold
|Ok
|----
|User Hold Retrieve - Retrieve call on hold
|Ok
|----
|User Transfer - Transfer with Consult
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Transfer with Consult (Alerting only)
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Blind Transfer
|Ok, Ok(Tapi/Soap)
|----
|3PTY - Make 3rd Party Call
|Nok(myPBX), Nok(Tapi/Soap)
|----
|Connected Number Update on Display
|No
|}

* tested with myPBX and TSP(8150)only

== Configuration ==

=== innovaphone configuration ===
Add a new PBX object of type "user": 
[[Image:Siemens Gigaset N510IP PRO - PBX_Userobject.png]]

=== 3rd party product configuration ===

====IP Configuration====

First you have to configure the general ''IP Configuration'' for the base-station.

* IP Address
* Subnet Mask
* Default Gateway
* DNS

[[Image:Siemens Gigaset N510IP PRO - Gigaset_IP_Configuration_ENG.png]]

====Telephony Connection====

In the next step you have to create a registration from the DECT/IP base-station to the PBX. Go to ''Telephony->Connections'' and ''edit'' the first entry.

Click on ''Select Provider'' and choose your country and ''innovaphonePBX''. This will ensure that all settings are configured correctly.

The device still needs the IP address of the PBX to register at and the name of the user for whom the registration shall be made. Click on ''Show advanced settings'' in order to enter as ''Domain'' name the IP address of your innovaphone PBX.

Please note that the registration credentials configured at the Gigaset phone use the ''number'' of the corresponding PBX object, not its name. Registration by using the name is also possible, but will result in CGPN display problems when making calls from the Gigaset phone to a mobility enabled user.

When using the Reverse Proxy, you have to set the protocol to TCP instead of UDP

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Telefonie_Connection_ENG.png]]

====Number Assignment====

If you have more than one DECT handset registered to your base-station, you can use the ''Telephony->Number Assignment'' menu to assign a DECT handset to a specific PBX registration.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Number_Assignment.png]]

To work with CTI clients like myPBX we need to configure the Call Manager with the handset that should handle this CTI calls and the mode (headset/handsfree).

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Call_Manager.png]]

====Voicemail====
To get the current voicemail status displayed on your DECT handset, you have to enter the corresponding innovaphone voicemail number in the ''Telephony->Network Mailbox'' menu.
[[Image:Siemens Gigaset N510IP PRO - Gigaset_VM_ENG.png]]

====Phone Directory - Adress Book====

You can import/export and save the local phonebook. Have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Phone_Directory_ENG.png]]

====Enhanced VoIP Settings====

If the device is used in a hosted setup, make sure that the following settings are configured:
* Automatic Negotiation of DTMF transmission: '''Yes'''
* Find target addr. automatically: '''Yes'''

At last you can configure some enhanced VoIP Settings like the handling of the "R" button. For more information have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_advanced_VoIP_Settings_ENG.png]]

=== Known problems ===

==== innovaphone PBX Version 12 ====

With the upcomming version 12 from innovaphone AG we have implemented the security feature [https://tools.ietf.org/html/rfc3261#section-22.4 SIP digest authentication] . If the client did not support this feature the PBX will reject the registration.
With the N510 Firmware 42.240, November 2016 and later this problem is fixed on Gigaset side.

There is a config option to avoid this if you use a older firmware. '''But it is not recommended to disable this feature. It's a security feature.'''

http://ip-of-pbx/!config change SIP /disable-digest-replay-check
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

==== MoH ====
Customer reported that even when choosing as Providerprofile ''innovaphonePBX'', MoH was not audible when a call was put on hold by the Gigaset device. The reason for this is that the Gigaset signals the hold using a "sendonly" instead of an "inactive" SDP-attribute.
To fix this error, you can configure the innovaphone PBX to ignore the wrong hold-signaling:

http://ip-of-pbx/!config add SIP /take-sendonly-as-inactive
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

Please keep in mind that this option will affect all SIP/UDP communication. So if you have for example another 3rd party SIP-device, which wants to play its own MOH - it will not work anymore.

==== Usernames with whitespace ====
Customer reported that when registering a Gigaset-device at an object-name with whitespace (e.g. John Doe), because of a bug on the Gigaset SIP-stack ut will not be possible to put a remote device on hold. As a workaround, don't remove the whitespace from the object-name (e.g. JohnDoe).

==== Recalling DECT device after transfer =====
With firmware v43, when you make a call transfer from a DECT phone to somewhere else, ~15 seconds you receive a recall call on the DECT phone.
Make a downgrade to v42 to work arround the problem.
The same happens in the gigaset N720 multi cell environment with firmwares above 098

[[Category:Compat|{{PAGENAME}}]]

Howto:Send Email MWI Notification From The innovaphone Voicemail

2017-09-11T15:22:57Z

Aschild: SMTP port specification

==Applies To==
This information applies to

'''Note: The required Voicemail is not suitable for V6 SR1 environments'''.

* innovaphone PBX, V6 SR2
* innovaphone Voicemail, Build 07-60049

==More Information==
Email notifications about newly received voicemails can be sent towards the owner of a voicebox.
The mechanism is not reliable, because there is no spooling implemented. Currently, there will be one transmission attempt per email.

The destination email address can be taken from a file, that is to be located within the ''../personal'' directory of a voicebox. Alternatively may the email address be configured into a user's URL parameter within the corresping PBX object.

Such an email consists of a subject "You have received a new voicemail from: xxx", where ''xxx'' stands for the number of the calling party. There is additional [[#Send Voicemail As Email Attachment|functionality]] available to attach a voicemail as a wave file (a-law, u-law encoded) to an email.

The email will be sent by means of the Simple Mail Transfer Protocol (SMTP). The protocols SMTPS/SMTP over TLS/STARTTLS are '''not supported''' at the moment - a [[Support:DVL-Feature_Requests#Support_for_SMTPS.2FSMTP_over_TLS|pending feature request exists]] already.

As SMTP Authentication mechanisms are supported (as of the writing of this arcticle): PLAIN, LOGIN and CRAM-MD5

===Installation===
* Install the above mentioned VoiceMail build or later as usual.
* In the VoiceMail folder where vm.xml is placed you will find ''email.xml''. This file contains the SMTP configuration and must be edited to adjust it to your needs.
* Ensure that the IP configuration (Default Gateway, DNS server) is appropriate.

===Provisioning Of Destination Email Addresses===
Email addresses must be configured manually. The script file email.xml firstly looks into a user's E-Mail parameter (only on the first configured E-Mail). If no value found in the E-Mail parameter, the user's URL parameter is used at second place and then the user's personal file mail.txt, in order to find an email destination. Since the URL parameter may be used in other contexts, the script ensures that a non-empty URL parameter contains the '@' character as an indication that it deals with an email address.

====By E-Mail Parameter====
The email address can be taken from a user's E-Mail parameter.

Provisioning of a user's email address by [[Reference10:PBX/Objects|E-Mail parameter]]
* Proceed to ''PBX/Objects''.
* Open the desired Object GUI by clicking on it.
* Enter the email address into the ''E-Mail'' edit field. The email address may be entered raw as e.g. ''pbxuser@mycompany.com''.
Repeat these steps for each voicebox.

====By URL Parameter====
The email address can be taken from a user's URL parameter.

Provisioning of a user's email address by URL parameter
* Proceed to ''Administration/PBX/Objects''.
* Open the desired Object GUI by clicking on it.
* Enter the email address into the ''URL'' edit field. The email address may be entered raw as e.g. ''pbxuser@mycompany.com'' or as mailto-URL alike e.g. mailto:pbxuser@mycompany.com.
Repeat these steps for each voicebox.

====By File====
The email address can be taken from the mass storage.
The destination email address can be written into a file.

Provisioning of a user's email address by file
* Within a text editor open up a new file.
* Enter the user's email address, e.g.: ''pbxuser@mycompany.com''
* Save the file as ''...yyy/personal/mail.txt'', where ''yyy'' stands for the directory name of the user's voicebox.
Repeat these steps for each voicebox.

===Configure the SMTP Agent===
By default the email will be sent with the sender- and destination- email address being identical. In addition will the email be sent alike a Mail Transfer Agent (MTA) does.

You can configure the content of the above mentioned file email.xml, in order to provide a different sender email address.

You can also control that emails are to be sent alike a Mail User Agent (MUA) does, or in other words: alike a regular email SMTP client does.

Open up the file email.xml within a text editor.

* In order to modify the sender email address, modify the line
<pre>
<assign out="$from" value="$to"/>
</pre>
into e.g.
<pre>
<assign out="$from" value="voicemail@mycompany.com"/>
</pre>

PLEASE NOTE (obsolete with V11) : if your smtp server requires authorization, you will also need to edit the following line at the end of the email.xml file:
<pre>
<exec url="mailto:$to?from=$to&subject=$subject&subject=$cgpn&srv=$server&usr=$user&pwd=$password&file=$file"/>
</pre>
to
<pre>
<exec url="mailto:$to?from=$from&subject=$subject&subject=$cgpn&srv=$server&usr=$user&pwd=$password&file=$file"/>
</pre>
otherwise sender address and authorization credentials won't match and you will get an "authorization failed" error

MTA-to-MTA communication may fail, depending on policies implemented within the receiving MTA. Therefore, it is desirable to turn our sending MTA into a simple MUA. That is, emails are to be sent via an SMTP provider server. Such a server is often termed as an ''Outgoing SMTP Server''.

Open up the file email.xml within a text editor.

To configure an outgoing SMTP server, modify the lines
<pre>
<assign out="$server" value=""/>
<assign out="$user" value=""/>
<assign out="$password" value=""/>
</pre>
into e.g.
<pre>
<assign out="$server" value="smtpserver.myprovider.com"/>
<assign out="$user" value="myuser"/>
<assign out="$password" value="mypassword"/>
</pre>
Note : the server value can be also with port configured like this : ''smtpserver.myprovider.com:port''
==== mailto: URL Query Arguments ====
The SMTP agent is configured using query args. The following args are recognized

; from : sets the senders's email address. Must be a valid email address thus. E.g. <code>?from=user@company.tld</code>
; subject : sets the email's subject. The values of multiple occurrences of the ''subject'' query arg will be concatenated. E.g. <code>?subject=foo&subject=bar</code> yield ''foobar'' as subject. Empty by default.
; body : sets the email's body. The values of multiple occurrences of the ''body'' query arg will be concatenated. E.g. <code>?body=foo&body=bar</code> yield ''foobar'' as body. Empty by default.
; srv : sets the SMTP server address (that is, the address of the SMTP server the mail is sent to). Must be either an IP address or a DNS name. Empty by default. If you need another port than 25, just add :<portnr> at then end of to the srv
; usr : sets the user name to be used for authentication towards the SMTP server. Empty by default.
; pwd : sets the password to be used for authentication towards the SMTP server. Empty by default.
; fromname : sets the sender's display name. ''Voicemail'' by default.
; toname : sets the recipients's display name. ''Voicemail User'' by default.
; host : sets the local SMTP name (used in SMTP HELO or ELOH command). ''[127.0.0.1]'' by default.

Please note that the mailto: URL in email.xml must be noted as valid XML code. Special characters (most notably the ampersand ''&'') must be quoted thus, e.g. <code>?subject=foo&amp;subject=bar</code>

==== MS Exchange 2003====
An in-house test yielded the following approach, allowing to talk to the Exchange 2003 MTA-wise.
The file email.xml was left as-is, except the following line has been set to the dotted decimal IP address of the exchange machine.
<pre>
<assign out="$server" value="172.16.0.4"/>
</pre>
or when you smtp server is listening on port 2525 instead of 25
<pre>
<assign out="$server" value="172.16.0.4:2525"/>
</pre>
This allowed an intranet PBX to send emails to Exchange users, where the source- destination email address were identical.

===Send Voicemail As Email Attachment===
Emails won't carry a voicemail attachment by default. The file email.xml can be edited, in order to send voicemails as wave files together with the notification email.

Open up the file email.xml within a text editor, modify the line

<assign out="$file" value=""/>

into

<assign out="$file" value="$vm"/>

The wave files will inform about themselves as to contain a-law-, respectively u-law content.
From on Windows XP SP2 the Mediaplayer will contain the required codecs.

===Testing===
* Call a user with a CFU into his/her voicebox.
* Leave a voicemail, tear down (on-hook) the call.
* The owner of the voicebox should now have received an email.

===Troubleshooting===
Before contacting the support, you are asked to create a trace file covering the transmission attempt for an email.

The following lines in the configuration must be changed manually, from:
<pre>
config change DNS0
config change SMTP0
</pre>
into
<pre>
config change DNS0 /trace
config change SMTP0 /trace
</pre>

Activate the trace checkmark at the affected voicemail object. In addition should the voicemail object's trace flags be set to the value ''59'' alike: ''http://192.168.0.1/drive/CF0/vm.xml?$_trace=59''.



[[Category:Howto|{{PAGENAME}}]]

Howto:Send Email MWI Notification From The innovaphone Voicemail

2017-09-11T15:22:09Z

Aschild: SMTP port specification

==Applies To==
This information applies to

'''Note: The required Voicemail is not suitable for V6 SR1 environments'''.

* innovaphone PBX, V6 SR2
* innovaphone Voicemail, Build 07-60049

==More Information==
Email notifications about newly received voicemails can be sent towards the owner of a voicebox.
The mechanism is not reliable, because there is no spooling implemented. Currently, there will be one transmission attempt per email.

The destination email address can be taken from a file, that is to be located within the ''../personal'' directory of a voicebox. Alternatively may the email address be configured into a user's URL parameter within the corresping PBX object.

Such an email consists of a subject "You have received a new voicemail from: xxx", where ''xxx'' stands for the number of the calling party. There is additional [[#Send Voicemail As Email Attachment|functionality]] available to attach a voicemail as a wave file (a-law, u-law encoded) to an email.

The email will be sent by means of the Simple Mail Transfer Protocol (SMTP). The protocols SMTPS/SMTP over TLS/STARTTLS are '''not supported''' at the moment - a [[Support:DVL-Feature_Requests#Support_for_SMTPS.2FSMTP_over_TLS|pending feature request exists]] already.

As SMTP Authentication mechanisms are supported (as of the writing of this arcticle): PLAIN, LOGIN and CRAM-MD5

===Installation===
* Install the above mentioned VoiceMail build or later as usual.
* In the VoiceMail folder where vm.xml is placed you will find ''email.xml''. This file contains the SMTP configuration and must be edited to adjust it to your needs.
* Ensure that the IP configuration (Default Gateway, DNS server) is appropriate.

===Provisioning Of Destination Email Addresses===
Email addresses must be configured manually. The script file email.xml firstly looks into a user's E-Mail parameter (only on the first configured E-Mail). If no value found in the E-Mail parameter, the user's URL parameter is used at second place and then the user's personal file mail.txt, in order to find an email destination. Since the URL parameter may be used in other contexts, the script ensures that a non-empty URL parameter contains the '@' character as an indication that it deals with an email address.

====By E-Mail Parameter====
The email address can be taken from a user's E-Mail parameter.

Provisioning of a user's email address by [[Reference10:PBX/Objects|E-Mail parameter]]
* Proceed to ''PBX/Objects''.
* Open the desired Object GUI by clicking on it.
* Enter the email address into the ''E-Mail'' edit field. The email address may be entered raw as e.g. ''pbxuser@mycompany.com''.
Repeat these steps for each voicebox.

====By URL Parameter====
The email address can be taken from a user's URL parameter.

Provisioning of a user's email address by URL parameter
* Proceed to ''Administration/PBX/Objects''.
* Open the desired Object GUI by clicking on it.
* Enter the email address into the ''URL'' edit field. The email address may be entered raw as e.g. ''pbxuser@mycompany.com'' or as mailto-URL alike e.g. mailto:pbxuser@mycompany.com.
Repeat these steps for each voicebox.

====By File====
The email address can be taken from the mass storage.
The destination email address can be written into a file.

Provisioning of a user's email address by file
* Within a text editor open up a new file.
* Enter the user's email address, e.g.: ''pbxuser@mycompany.com''
* Save the file as ''...yyy/personal/mail.txt'', where ''yyy'' stands for the directory name of the user's voicebox.
Repeat these steps for each voicebox.

===Configure the SMTP Agent===
By default the email will be sent with the sender- and destination- email address being identical. In addition will the email be sent alike a Mail Transfer Agent (MTA) does.

You can configure the content of the above mentioned file email.xml, in order to provide a different sender email address.

You can also control that emails are to be sent alike a Mail User Agent (MUA) does, or in other words: alike a regular email SMTP client does.

Open up the file email.xml within a text editor.

* In order to modify the sender email address, modify the line
<pre>
<assign out="$from" value="$to"/>
</pre>
into e.g.
<pre>
<assign out="$from" value="voicemail@mycompany.com"/>
</pre>

PLEASE NOTE (obsolete with V11) : if your smtp server requires authorization, you will also need to edit the following line at the end of the email.xml file:
<pre>
<exec url="mailto:$to?from=$to&subject=$subject&subject=$cgpn&srv=$server&usr=$user&pwd=$password&file=$file"/>
</pre>
to
<pre>
<exec url="mailto:$to?from=$from&subject=$subject&subject=$cgpn&srv=$server&usr=$user&pwd=$password&file=$file"/>
</pre>
otherwise sender address and authorization credentials won't match and you will get an "authorization failed" error

MTA-to-MTA communication may fail, depending on policies implemented within the receiving MTA. Therefore, it is desirable to turn our sending MTA into a simple MUA. That is, emails are to be sent via an SMTP provider server. Such a server is often termed as an ''Outgoing SMTP Server''.

Open up the file email.xml within a text editor.

To configure an outgoing SMTP server, modify the lines
<pre>
<assign out="$server" value=""/>
<assign out="$user" value=""/>
<assign out="$password" value=""/>
</pre>
into e.g.
<pre>
<assign out="$server" value="smtpserver.myprovider.com"/>
<assign out="$user" value="myuser"/>
<assign out="$password" value="mypassword"/>
</pre>
Note : the server value can be also with port configured like this : ''smtpserver.myprovider.com:port''
==== mailto: URL Query Arguments ====
The SMTP agent is configured using query args. The following args are recognized

; from : sets the senders's email address. Must be a valid email address thus. E.g. <code>?from=user@company.tld</code>
; subject : sets the email's subject. The values of multiple occurrences of the ''subject'' query arg will be concatenated. E.g. <code>?subject=foo&subject=bar</code> yield ''foobar'' as subject. Empty by default.
; body : sets the email's body. The values of multiple occurrences of the ''body'' query arg will be concatenated. E.g. <code>?body=foo&body=bar</code> yield ''foobar'' as body. Empty by default.
; srv : sets the SMTP server address (that is, the address of the SMTP server the mail is sent to). Must be either an IP address or a DNS name. Empty by default. If you need another port than 25, just add :<portnr> at then end of to the srv
; usr : sets the user name to be used for authentication towards the SMTP server. Empty by default.
; pwd : sets the password to be used for authentication towards the SMTP server. Empty by default.
; fromname : sets the sender's display name. ''Voicemail'' by default.
; toname : sets the recipients's display name. ''Voicemail User'' by default.
; host : sets the local SMTP name (used in SMTP HELO or ELOH command). ''[127.0.0.1]'' by default.

Please note that the mailto: URL in email.xml must be noted as valid XML code. Special characters (most notably the ampersand ''&'') must be quoted thus, e.g. <code>?subject=foo&amp;subject=bar</code>

==== MS Exchange 2003====
An in-house test yielded the following approach, allowing to talk to the Exchange 2003 MTA-wise.
The file email.xml was left as-is, except the following line has been set to the dotted decimal IP address of the exchange machine.
<pre>
<assign out="$server" value="172.16.0.4"/>
</pre>
This allowed an intranet PBX to send emails to Exchange users, where the source- destination email address were identical.

===Send Voicemail As Email Attachment===
Emails won't carry a voicemail attachment by default. The file email.xml can be edited, in order to send voicemails as wave files together with the notification email.

Open up the file email.xml within a text editor, modify the line

<assign out="$file" value=""/>

into

<assign out="$file" value="$vm"/>

The wave files will inform about themselves as to contain a-law-, respectively u-law content.
From on Windows XP SP2 the Mediaplayer will contain the required codecs.

===Testing===
* Call a user with a CFU into his/her voicebox.
* Leave a voicemail, tear down (on-hook) the call.
* The owner of the voicebox should now have received an email.

===Troubleshooting===
Before contacting the support, you are asked to create a trace file covering the transmission attempt for an email.

The following lines in the configuration must be changed manually, from:
<pre>
config change DNS0
config change SMTP0
</pre>
into
<pre>
config change DNS0 /trace
config change SMTP0 /trace
</pre>

Activate the trace checkmark at the affected voicemail object. In addition should the voicemail object's trace flags be set to the value ''59'' alike: ''http://192.168.0.1/drive/CF0/vm.xml?$_trace=59''.



[[Category:Howto|{{PAGENAME}}]]

Reference10:Concept Linux Application Platform

2017-08-28T09:50:43Z

Aschild: /* Linux Application Platform (IPxx10 or IPx11 Gateways) */

==Introduction==

The innovaphone Linux Application Platform permits to install innovaphone or custom applications for certain purposes, like Reporting or a Fax Server. 
It also allows to backup/restore configuration files, uninstall applications or see and backup logs. 
 
The Linux distribution Debian 7.1 (Wheezy) is used and linux kernel is 3.4.10 (IPxx10) and 3.2.0.4 (VM) 
 
The architecture of the platform is armel. 
 

==Requirements==

There are three ways to use the innovaphone Linux Application Platform:

===On an IPxx10 Gateway===
* An IP810, IP0010, IP3010 or IP6010 Gateway
* Firmware Version 10
* A compact flash card with UDMA support (minimum 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

===On an IPx11 Gateway===
* An IP0011, IP311, IP411, IP811 or IP3011 Gateway
* Firmware Version 11r2
* An SSD mSATA

===As a Virtual Machine===
* VMWare Player/VMWare Workstation

* Minimal Requirements for the Virtual Machine:
1vCPU ( we run 800 MHZ CPU on our IPXX10 Gateways, so similar speed or higher it's enough, nevertheless depending on the operations/load you could need more CPU speed/vCPU)
512 MB RAM
8GB Disk

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages: The IPxx10/IPx11 package to run on the gateways or a VMware image for VMware

===Default Credentials===
* Web/Webdav: '''admin'''/'''linux'''
* Root-Login (e.g. with Putty): '''root'''/'''iplinux'''

===Disk space calculation===
See [[Reference10:Concept_Reporting#Calculation_of_required_disk_space]].


It is strongly recommended that you try to precalculate the needed disk space and that you choose a suiting disk size.


===Disk space usage after first time installation===

====IPxx10/IPx11 Gateways====

* /dev/sda1: 32 MB (fat32 partition with two kernels, which are started by the IPxx10 or IPx11)
* /dev/sda2: 524 MB (ext2 initial installation partition)
* /dev/sda3: 120 MB (swap partition)
* /dev/sda4: 620 MB / xx GB depending of the size of the used CF card (ext4 partition, which is actually booted)

All in all about 1.3 GB are already in use after the initial installation.

====VMWare====

* /dev/sda1: 674 MB (ext2 initial installation partition)
* /dev/sda2: 120 MB (swap partition)
* /dev/sda3: 767 MB / xx GB depending of your pre installation configuration (ext3 partition, which is actually booted)

All in all about 1.6 GB are already in use after the initial installation.

===Linux Application Platform (IPxx10 or IPx11 Gateways)===

It is recommended to use CF-Cards with sizes of 8GB or more and the card '''must''' support UDMA! 
* Enable Linux under Linux General.
[[image:IPxx10_Linux_-_enable.png]]
* Be sure that "Autostart Linux" is disabled until the installation process is finished.
* You need to enable Proxy-ARP on ETH0 or ETH1 [[ Reference:Configuration/ETH/IP|here ]], so your gateway and the linux appliance will share the same physical interface. Simply go to '''IP4 > ETH0 (if used) > IP''' and check '''Proxy ARP'''
* Decompress the downloaded package. You should have an image file like <code>linux_ipxx10_armel.img</code> now. This works for both '''IPxx10''' and '''IPx11''' hardware!
* Upload the decompressed file over the gateways web interface under [[ Reference10:General/Compact-Flash/Image ]] (IPxx10) or [[ Reference12:General/SSD/Image ]] (IPx11). Unmount the CF card/SSD if necessary. Select "Part 1" before starting the upload!
[[image:IPxx10_Linux_-_upload_image.jpg]]
* Reset the box (which also activates the config change of step 1).
* Configure IP under [[ Reference10:Linux/IP ]]: select either "Disabled" to assign a static IP or ETH0/ETH1 to receive an IP-Address from DHCP-Server behind ETH0 or ETH1.
* Configure the kernel file, which you find under [[ Reference10:General/Compact-Flash/General#Browse_CF_Content ]] on [[ Reference10:Linux/General ]] '''Linux kernel file'''
** IPxx10 hardware: <code>Image-6010-3.4.10</code>
** IPx11 hardware: <code>Image-IPx11-4.4.0</code>
* Configure <code>root=/dev/sda2</code> under [[ Reference10:Linux/General ]] '''Kernel command line'''.
* If you want, configure the autostart flag.
* Submit your changes.
* Click the [[ Reference10:Linux/General ]] '''Start'''-Link. The page refreshes until Linux gets an IP and then tries to get a link to the Linux Web Server, which can take some time for the first time installation (~ 5 minutes to 2 hours, for a IP411 ~15 minutes).
[[Image:device_conf.jpg]]
* Open the Linux Web Server to see the installation progress (which might take several minutes too). The default credentials are '''admin'''/'''linux''' for both platforms.
[[Image:installation.jpg]]
* The output of the installation log is stored on the Linux AP under <code>/var/log/init_install.log</code>. In case you have no access to the web server but a console or SSH access, you can check the installation progress in this log file. E.g. login to the console with root/iplinux and run follwong command: <code>more /var/log/init_install.log</code>. In case you have an SSH connection to the Linux AP, you can download this file using [http://winscp.net WinSCP] tool.
* Enter the innovaphone device IP address (optional port allowed) and admin credentials when the installation has finished. Now wait until the page refrehses. The web server credentials are now the innovaphone device admin credentials, e.g. '''admin'''/'''ip6010'''.
** If the device couldn't be reconfigured, you will get an error message '''Command line at the PBX could not be changed...''' In this case, you have to open [[ Reference10:Linux/General ]] on your device, click stop and enter <code>root=/dev/sda4</code> under '''Kernel command line'''. Then start again. Your Linux webserver credentials will be '''admin'''/'''linux''' in this case.
* Linux install has finished.
* You will see now <code>root=/dev/sda4</code> under [[ Reference10:Linux/General ]] since Linux is running in on the fourth partition. You shouldn't change that unless you want to install Linux again.

===Linux Application Platform (VMWare)===

* Decompress the downloaded archive. You should have two files: '''IP-Debian.vmx''' and '''IP-Debian.vmdk'''.
* We can open using Vmware Player/Workstation, if you wish to run on Vsphere 4.x or later please convert it by the same method it's done with the IPVA (see [[Reference10:Concept_Innovaphone_Virtual_Appliance#VMware_vSphere | Using VMware vSphere]])
* Now you have two possibilities (example for VMWare Player, VMWare Workstation should be similar):
** If you want to assign more than 8 GB virtual flash:
*** Do '''not''' directly start/doubleclick the vmx file!
*** Start the VMware Player and Open the vmx file with '''Open a Virtual Machine'''.
*** Open '''Edit virtual machine settings'''.
*** Select the hard disk and '''Expand''' it under '''Utilities''' to the wished size.
*** Apply the change and klick '''Play virtual machine'''.
** If 8 GB are enough, simply double click the vmx file and Linux will start.
* The first time, a script will automatically configure a new partition, the web server etc., which will take some time. The waiting time depends on the CPU of the computer running the vmware player. In some cases the waiting time can be up to 30 minutes, in most cases the installation finishes in about 2-5 minutes.
* In the meantime, fetch your IP from the VMWare Player screen or login as root and get your IP address with the command '''ifconfig'''.
* Login to the web server to see the installation progress (it may take some minutes until the web server is up).
* Linux will restart automatically after the first time installation has finished.
* Linux install has finished.

===Hotfix Installation===
If you have already installed the latest version of the Linux Application Platform, simply download the Linux...HotfixIncremental for your platform (VM or IPxx10/IPx11) or if you have missed some hotfixes, download the Linux...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

====Refreshing issue on installation====
You might get a PHP error when the browser is refreshing during the installation. Just refresh (F5) the page and you'll get the installation progress again.

=== Upgrade from a previous major Release ===
For instructions how to upgrade from a previous major release (such as V9 to V10), see ''Upgrading Linux Application Platform'' in [[Howto:Firmware_Upgrade_V9_V10|Firmware Upgrade V9 V10]].

===Static IP===
The Linux itself '''must''' be running in DHCP client mode to run properly. If you want to assign a static IP address, do it like this:

* On an IPxx10/IPxx11: assign a static IP under [[Reference10:Linux/IP]], this will do an internal DHCP response to the Linux that's running as DHCP client mode.
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file.

===IPxx10/IPxx11 Transit network for Linux===
When running Linux on an innovaphone device IPxx10/IPxx11 there is no dedicated network interface for the Linux machine. Instead we have a special transit network between the Linux and the device. The Linux will always operate as DHCP Client mode.

Any ARP request done by the Linux machine will always get the same ARP result that will be the internal "NIC" inside the device, so all packets are always sent to the same IPxx10/IPxx11 device that works as a router. When the packet sent by the Linux machine arrives the innovaphone device, it will follow the IP routing table of the device itself.

In case we have a single network (voice) we will have no problem since the default gateway is just one. However, if we wish to split into two networks (voice and data) and the Linux machine should have a different default gateway, this has no effect since IP routing is based on the innovaphone device IP routing table, because we can't have two default gateways at the same time.

==Administration==

===General===

====Configure IP====

The IP configuration on the Linux Application Platform is '''only''' available on a '''VM'''! A static IP for a Linux Application Platform for an IPxx10/IPxx11 can be configured on your gateway under Linux/IP.

* Mode: either DHCP Client or Static
* [IP Address]: the desired static IP address
* [Subnet Mask]
* [Gateway]
* [DNS Server]
* [Alternate DNS Server]

The optional parameters in [] can be only configured, if '''Static''' is selected as mode.

====Change the root credentials====

Here you can change the credentials of the Linux root user. 
Default password: '''iplinux'''

====Configure Authenticated URLs====

Configure credentials for authenticated URLs. These credentials will be used in automatic backups. 
You can add/remove Urls with the '''+''' and '''-''' at the right side of the list.

* URL: the URL, e.g. https://172.16.123.123/backup
* User: the user for this URL
* Password: the password for this URL

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

Default is Europe/Berlin but you can change that to a valid timezone (an error is given if timezone not present). 

====Change postgresql admin password====

If innovaphone Reporting is installed, you can configure another password for the postgres admin user. 
Default password: '''postgres'''.

===Web Server===

We use lighttpd version 1.4.32. The linux web server user is '''www-data''' and group user also '''www-data'''. Root directory for the web-server is '''/var/www/innovaphone'''. This information is mainly relevant if you plan to develope custom applications and integrate them into linux application platform.

Default users and password for the different levels on the Linux application plattform (see figure below):
[[image:Linux_Application_hierarki.PNG]]

====Change web server properties and public access to the web/webdav====
* Force HTTPS: enables redirection for HTTP to HTTPS
* Public Web Paths: these paths are not password protected, e.g. '/ap'
* Public Webdav Paths: these webdav paths are not password protected, e.g. '/backup'
** These paths are by default readonly. You can set the 'Write' flag to make the path also writable. This flag will be anyway ignored if credentials are provided. 

''<IPadr>''<code>/webdav/</code> is the root directory for webdav files. If you want to access a directory/file without credentials you have to add this directory to the Public Webdav Paths.

Example: <code>/webdav/background/</code> Here you have the background pictures for your Phones. 
Public Webdav Paths: <code>/background</code> or <code>/background/a</code> 
Now you have a public access to the folder background. 

* Enter a single '<code>/</code>' for a public root directory. All sub directories and files will be also public then. 
* If you enter e.g. '<code>/update/</code>', the directory 'update' and all sub directories/files will be public. 
* If you enter e.g. '<code>/update</code>', only the directory 'update' and its files will be public.

Important: Linux file names are case sensitive (so <code>/Update</code> is not equal <code>/update</code>)!.

====Change the Linux web server credentials====

Here you can change the credentials for Web Server access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change the Linux webdav access credentials====

Here you can change the credentials for webdav access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change application access credentials====

If you have installed an application, which has the lighttpd-auth property set in its configuration file, you can configure a separate user/password for the applications web site. 
If you want to disable the separate authentication, leave the '''user''' field empty and enter the currently configured password. The authentication will be the same as the root web server authentication afterwards. 
One can just login on the application web site with this access.

A configured access overrides a configured public web path to '/apps/application-name'!

====Configure mutual TLS====

If you need mutual TLS for innovaphone devices with a certificate signed by innovaphone, you can activate mutual TLS for a configurable '''port'''. 
Currently we're just supporting client certificates signed by innovaphone's ''innovaphone Device Certification Authority''. 
 
The physical mutual TLS path is '''/var/www/innovaphone/mtls'''. Here you can put your script files, e.g. mtls.php. 
You then call this script file by '''https://linux-ip:mtls-port/mtls.php''', as this path is the document root for the configured port.

'''How to upload the script:'''

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference10:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphone-applicationnamelogs=====

Saves log files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportinglogs'''

=====saveinnovaphone-applicationnamecfgs=====

Saves all neccessary configuration files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingcfgs'''

=====saveinnovaphone-applicationnamedb=====

Saves ddbb if existing as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingdb'''

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Relay Hosts===

The Application Platform contains a mail client which speaks SMTP.
The SMTP daemon (postfix) looks up by default the DNS MX record of the recipient email address. 
Relay SMTP hosts can also be configured to deliver the mails. Each relay host is related to a '''sender''' mail address or a '''sender''' mail domain. TLS is used if the host supports it. 
Examples of the server entry:
; mydomain.com: MX record to the domain
; smtphost: host name with MX record lookup
; [gateway.example.com]: host name with DNS lookup
; [an.ip.add.ress]: IP address without DNS lookup
The form [hostname] turns off MX lookups. See also [http://www.postfix.org/postconf.5.html#relayhost the postfix documentation]. 
If anonymous SMTP is to be used, user and password must be left empty.
 

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

Currently innovaphone Reporting and innovaphone Faxserver are using these relay hosts, if entered.

===Database===

The innovaphone database is created to store e.g. relay hosts.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The database user is '''innovaphone''' with default password '''innovaphone'''.
This password may be changed here.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

For the PgAdmin III it is imporant to use innovaphone as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone - Password: innovaphone

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
The following scripts are used to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference10:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=127

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|| TRACE_LDAP || 64
|-
|| TRACE_XML || 128
|-
|}

So currently all trace options are enabled with the level '''255'''.

Default trace level are "0"

==Appendix==
===Creating own applications===
See [[Reference10:Concept Linux Application]]

===Tools===

====WinSCP====

[https://winscp.net WinSCP] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference10:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference10:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference10:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference10:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

* adduser
* apt
* apt-utils
* aptitude
* aptitude-common
* base-files
* base-passwd
* bash
* binutils
* bsdmainutils
* bsdutils
* bzip2
* ca-certificates
* comerr-dev
* coreutils
* cpio
* cpp
* cpp-4.7
* cpp-4.6
* cron
* curl
* dash
* db-util
* db5.1-util
* debconf
* debconf-i18n
* debian-archive-keyring
* debianutils
* diffutils
* dmidecode
* dmsetup
* dos2unix
* dovecot-common
* dovecot-core
* dovecot-pgsql
* dovecot-pop3d
* dovecot-sieve
* dpkg
* e2fslibs
* e2fsprogs
* file
* findutils
* gamin
* gcc
* gcc-4.7
* gcc-4.6
* gcc-4.6-base
* gcc-4.7-base
* gettext-base
* gnupg
* gpgv
* grep
* groff-base
* grub-common
* grub-legacy
* gzip
* hdparm
* hostname
* ifupdown
* info
* initramfs-tools
* initscripts
* insserv
* install-info
* iproute
* iptables
* iputils-ping
* isc-dhcp-client
* isc-dhcp-common
* klibc-utils
* kmod
* krb5-multidev
* libacl1
* libapt-inst1.5
* libapt-pkg4.12
* libasprintf0c2
* libattr1
* libblkid1
* libboost-iostreams1.49.0
* libbsd0
* libbz2-1.0
* libbz2-dev
* libc-bin
* libc-client2007e
* libc-dev-bin
* libc6
* libc6-dev
* libcap2
* libclass-isa-perl
* libcomerr2
* libcurl3
* libcurl4-openssl-dev
* libcwidget3
* libdb5.1
* libdevmapper1.02.1
* libedit2
* libept1.4.12
* libexpat1
* libfcgi-dev
* libfcgi0ldbl
* libffi5
* libfreetype6
* libfuse2
* libgamin-dev
* libgamin0
* libgcc1
* libgcrypt11
* libgcrypt11-dev
* libgdbm-dev
* libgdbm3
* libglib2.0-0
* libgmp10
* libgnutls-dev
* libgnutls-openssl27
* libgnutls26
* libgnutlsxx27
* libgomp1
* libgpg-error-dev
* libgpg-error0
* libgpgme11
* libgpm2
* libgssapi-krb5-2
* libgssrpc4
* libidn11
* libidn11-dev
* libitm1
* libk5crypto3
* libkadm5clnt-mit8
* libkadm5srv-mit8
* libkdb5-6
* libkeyutils1
* libklibc
* libkmod2
* libkrb5-3
* libkrb5-dev
* libkrb5support0
* libldap-2.4-2
* libldap2-dev
* liblocale-gettext-perl
* liblzma5
* libmagic1
* libmemcache-dev
* libmemcache0
* libmount1
* libmpc2
* libmpfr4
* libmysqlclient18
* libncurses5
* libncursesw5
* libnewt0.52
* libnfnetlink0
* libonig2
* libopts25
* libp11-kit-dev
* libp11-kit0
* libpam-modules
* libpam-modules-bin
* libpam-pgsql
* libpam-runtime
* libpam0g
* libpam0g-dev
* libparted0debian1
* libpcre3
* libpcre3-dev
* libpcrecpp0
* libpipeline1
* libpng12-0
* libpng12-dev
* libpopt0
* libpq-dev
* libpq5
* libprocps0
* libpth20
* libqdbm14
* libquadmath0
* libreadline6
* librtmp-dev
* librtmp0
* libsasl2-2
* libsasl2-modules
* libselinux1
* libsemanage-common
* libsemanage1
* libsepol1
* libsigc++-2.0-0c2a
* libslang2
* libsqlite3-0
* libsqlite3-dev
* libss2
* libssh2-1
* libssh2-1-dev
* libssl-dev
* libssl1.0.0
* libstdc++6
* libtasn1-3
* libtasn1-3-dev
* libtext-charwidth-perl
* libtext-iconv-perl
* libtext-wrapi18n-perl
* libtinfo5
* libtokyocabinet9
* libudev0
* libusb-0.1-4
* libustr-1.0-1
* libuuid-perl
* libuuid1
* libwrap0
* libxapian22
* libxml2
* libxml2-dev
* libxml2-utils
* linux-base
* linux-image-3.2.0-4-686-pae
* linux-libc-dev
* locales
* login
* logrotate
* lsb-base
* lsb-release
* make
* makedev
* man-db
* manpages
* manpages-dev
* mawk
* mime-support
* mlock
* module-init-tools
* mount
* multiarch-support
* mysql-common
* nano
* ncurses-base
* ncurses-bin
* net-tools
* netbase
* netcat-traditional
* ntp
* ntpdate
* openssh-client
* openssh-server
* openssl
* parted
* passwd
* patch
* perl-base
* php-pear
* php-xml-parser
* php-xml-serializer
* php5-cgi
* php5-cli
* php5-common
* php5-curl
* php5-imap
* php5-pgsql
* php5-xcache
* pkg-config
* postfix
* postfix-pcre
* postfix-pgsql
* postgresql-9.1
* postgresql-client-9.1
* postgresql-client-common
* postgresql-common
* procps
* psmisc
* python
* python-minimal
* python2.7
* python2.7-minimal
* rdate
* readline-common
* rsyslog
* sasl2-bin
* sed
* sensible-utils
* shared-mime-info
* ssh
* ssl-cert
* sudo
* sysv-rc
* sysvinit
* sysvinit-utils
* tar
* tasksel
* tasksel-data
* traceroute
* tzdata
* ucf
* udev
* util-linux
* uuid-dev
* vim
* vim-common
* vim-runtime
* vim-tiny
* wget
* whiptail
* xz-utils
* zlib1g
* zlib1g-dev
* lighttpd-mod-webdav
* lighttpd

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference10:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix! 
 
Please do '''not''' perform an update/upgrade yourself, as this will break future hotfix/application releases. Sometimes we deliver debian packages in our hotfixes and dependencies might be broken if you update/upgrade yourself.

====I want to do it anyway!!!====
Ok, save your application/ap configuration and data files and install our latest '''FULL''' release without any hotfix. Restore the configuration/data files and perform your update/upgrade. Now you can be happy, if everything still works fine... 
Perform these steps for each new hotfix release, as you might not be able to apply a new hotfix.

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

The same can be done for application specific passwords, e.g. Reporting.
In this case, use the file '''/home/lighttpd/innovaphone-reporting-htdigest.user'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentioned above should be only the last try to get the data and could work or not.
To be always on the save site use a standby Linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

=== How to recover from a broken File System ===
Sometimes you may find messages in the ''kern.log'' log file (in ''var/log'') like

Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): initial error at 1500329378: ext4_journal_start_sb:328
Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): last error at 1500329378: ext4_journal_start_sb:328

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

* Open the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda4'' to <code>root=/dev/sda2</code>
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line
** on the command prompt, use <code>e2fsck -p -f /dev/sda4</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda2'' to <code>root=/dev/sda4</code>
** start Linux again
:: This will run Linux on the original partition.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the LAP and any applications and restore your backups.

<internal>
Internal: How to recover from a disk-is-full Condition: [http://wiki-intern.innovaphone.com/index.php?title=Reporting#Vergr.C3.B6.C3.9Fern_der_Partition_.28VM.29]
</internal>
[[Category:Concept|Linux Application Platform]]

Reference10:Concept Linux Application Platform

2017-08-28T09:47:38Z

Aschild: /* Linux Application Platform (IPxx10 or IPx11 Gateways) */

==Introduction==

The innovaphone Linux Application Platform permits to install innovaphone or custom applications for certain purposes, like Reporting or a Fax Server. 
It also allows to backup/restore configuration files, uninstall applications or see and backup logs. 
 
The Linux distribution Debian 7.1 (Wheezy) is used and linux kernel is 3.4.10 (IPxx10) and 3.2.0.4 (VM) 
 
The architecture of the platform is armel. 
 

==Requirements==

There are three ways to use the innovaphone Linux Application Platform:

===On an IPxx10 Gateway===
* An IP810, IP0010, IP3010 or IP6010 Gateway
* Firmware Version 10
* A compact flash card with UDMA support (minimum 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

===On an IPx11 Gateway===
* An IP0011, IP311, IP411, IP811 or IP3011 Gateway
* Firmware Version 11r2
* An SSD mSATA

===As a Virtual Machine===
* VMWare Player/VMWare Workstation

* Minimal Requirements for the Virtual Machine:
1vCPU ( we run 800 MHZ CPU on our IPXX10 Gateways, so similar speed or higher it's enough, nevertheless depending on the operations/load you could need more CPU speed/vCPU)
512 MB RAM
8GB Disk

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages: The IPxx10/IPx11 package to run on the gateways or a VMware image for VMware

===Default Credentials===
* Web/Webdav: '''admin'''/'''linux'''
* Root-Login (e.g. with Putty): '''root'''/'''iplinux'''

===Disk space calculation===
See [[Reference10:Concept_Reporting#Calculation_of_required_disk_space]].


It is strongly recommended that you try to precalculate the needed disk space and that you choose a suiting disk size.


===Disk space usage after first time installation===

====IPxx10/IPx11 Gateways====

* /dev/sda1: 32 MB (fat32 partition with two kernels, which are started by the IPxx10 or IPx11)
* /dev/sda2: 524 MB (ext2 initial installation partition)
* /dev/sda3: 120 MB (swap partition)
* /dev/sda4: 620 MB / xx GB depending of the size of the used CF card (ext4 partition, which is actually booted)

All in all about 1.3 GB are already in use after the initial installation.

====VMWare====

* /dev/sda1: 674 MB (ext2 initial installation partition)
* /dev/sda2: 120 MB (swap partition)
* /dev/sda3: 767 MB / xx GB depending of your pre installation configuration (ext3 partition, which is actually booted)

All in all about 1.6 GB are already in use after the initial installation.

===Linux Application Platform (IPxx10 or IPx11 Gateways)===

It is recommended to use CF-Cards with sizes of 8GB or more and the card '''must''' support UDMA! 
* Enable Linux under Linux General.
[[image:IPxx10_Linux_-_enable.png]]
* Be sure that "Autostart Linux" is disabled until the installation process is finished.
* You need to enable Proxy-ARP on ETH0 or ETH1 [[ Reference:Configuration/ETH/IP|here ]], so your gateway and the linux appliance will share the same physical interface. Simply go to '''IP4 > ETH0 (if used) > IP''' and check '''Proxy ARP'''
* Decompress the downloaded package. You should have an image file like <code>linux_ipxx10_armel.img</code> now. This works for both '''IPxx10''' and '''IPx11''' hardware!
* Upload the decompressed file over the gateways web interface under [[ Reference10:General/Compact-Flash/Image ]] (IPxx10) or [[ Reference12:General/SSD/Image ]] (IPx11). Unmount the CF card/SSD if necessary. Select "Part 1" before starting the upload!
[[image:IPxx10_Linux_-_upload_image.jpg]]
* Reset the box (which also activates the config change of step 1).
* Configure IP under [[ Reference10:Linux/IP ]]: select either "Disabled" to assign a static IP or ETH0/ETH1 to receive an IP-Address from DHCP-Server behind ETH0 or ETH1.
* Configure the kernel file, which you find under [[ Reference10:General/Compact-Flash/General#Browse_CF_Content ]] on [[ Reference10:Linux/General ]] '''Linux kernel file'''
** IPxx10 hardware: <code>Image-6010-3.4.10</code>
** IPx11 hardware: <code>Image-IPx11-4.4.0</code>
* Configure <code>root=/dev/sda2</code> under [[ Reference10:Linux/General ]] '''Kernel command line'''.
* If you want, configure the autostart flag.
* Submit your changes.
* Click the [[ Reference10:Linux/General ]] '''Start'''-Link. The page refreshes until Linux gets an IP and then tries to get a link to the Linux Web Server, which can take some time for the first time installation (~ 5 minutes to 2 hours, for a IP411 ~13 minutes).
[[Image:device_conf.jpg]]
* Open the Linux Web Server to see the installation progress (which might take several minutes too). The default credentials are '''admin'''/'''linux''' for both platforms.
[[Image:installation.jpg]]
* The output of the installation log is stored on the Linux AP under <code>/var/log/init_install.log</code>. In case you have no access to the web server but a console or SSH access, you can check the installation progress in this log file. E.g. login to the console with root/iplinux and run follwong command: <code>more /var/log/init_install.log</code>. In case you have an SSH connection to the Linux AP, you can download this file using [http://winscp.net WinSCP] tool.
* Enter the innovaphone device IP address (optional port allowed) and admin credentials when the installation has finished. Now wait until the page refrehses. The web server credentials are now the innovaphone device admin credentials, e.g. '''admin'''/'''ip6010'''.
** If the device couldn't be reconfigured, you will get an error message '''Command line at the PBX could not be changed...''' In this case, you have to open [[ Reference10:Linux/General ]] on your device, click stop and enter <code>root=/dev/sda4</code> under '''Kernel command line'''. Then start again. Your Linux webserver credentials will be '''admin'''/'''linux''' in this case.
* Linux install has finished.
* You will see now <code>root=/dev/sda4</code> under [[ Reference10:Linux/General ]] since Linux is running in on the fourth partition. You shouldn't change that unless you want to install Linux again.

===Linux Application Platform (VMWare)===

* Decompress the downloaded archive. You should have two files: '''IP-Debian.vmx''' and '''IP-Debian.vmdk'''.
* We can open using Vmware Player/Workstation, if you wish to run on Vsphere 4.x or later please convert it by the same method it's done with the IPVA (see [[Reference10:Concept_Innovaphone_Virtual_Appliance#VMware_vSphere | Using VMware vSphere]])
* Now you have two possibilities (example for VMWare Player, VMWare Workstation should be similar):
** If you want to assign more than 8 GB virtual flash:
*** Do '''not''' directly start/doubleclick the vmx file!
*** Start the VMware Player and Open the vmx file with '''Open a Virtual Machine'''.
*** Open '''Edit virtual machine settings'''.
*** Select the hard disk and '''Expand''' it under '''Utilities''' to the wished size.
*** Apply the change and klick '''Play virtual machine'''.
** If 8 GB are enough, simply double click the vmx file and Linux will start.
* The first time, a script will automatically configure a new partition, the web server etc., which will take some time. The waiting time depends on the CPU of the computer running the vmware player. In some cases the waiting time can be up to 30 minutes, in most cases the installation finishes in about 2-5 minutes.
* In the meantime, fetch your IP from the VMWare Player screen or login as root and get your IP address with the command '''ifconfig'''.
* Login to the web server to see the installation progress (it may take some minutes until the web server is up).
* Linux will restart automatically after the first time installation has finished.
* Linux install has finished.

===Hotfix Installation===
If you have already installed the latest version of the Linux Application Platform, simply download the Linux...HotfixIncremental for your platform (VM or IPxx10/IPx11) or if you have missed some hotfixes, download the Linux...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

====Refreshing issue on installation====
You might get a PHP error when the browser is refreshing during the installation. Just refresh (F5) the page and you'll get the installation progress again.

=== Upgrade from a previous major Release ===
For instructions how to upgrade from a previous major release (such as V9 to V10), see ''Upgrading Linux Application Platform'' in [[Howto:Firmware_Upgrade_V9_V10|Firmware Upgrade V9 V10]].

===Static IP===
The Linux itself '''must''' be running in DHCP client mode to run properly. If you want to assign a static IP address, do it like this:

* On an IPxx10/IPxx11: assign a static IP under [[Reference10:Linux/IP]], this will do an internal DHCP response to the Linux that's running as DHCP client mode.
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file.

===IPxx10/IPxx11 Transit network for Linux===
When running Linux on an innovaphone device IPxx10/IPxx11 there is no dedicated network interface for the Linux machine. Instead we have a special transit network between the Linux and the device. The Linux will always operate as DHCP Client mode.

Any ARP request done by the Linux machine will always get the same ARP result that will be the internal "NIC" inside the device, so all packets are always sent to the same IPxx10/IPxx11 device that works as a router. When the packet sent by the Linux machine arrives the innovaphone device, it will follow the IP routing table of the device itself.

In case we have a single network (voice) we will have no problem since the default gateway is just one. However, if we wish to split into two networks (voice and data) and the Linux machine should have a different default gateway, this has no effect since IP routing is based on the innovaphone device IP routing table, because we can't have two default gateways at the same time.

==Administration==

===General===

====Configure IP====

The IP configuration on the Linux Application Platform is '''only''' available on a '''VM'''! A static IP for a Linux Application Platform for an IPxx10/IPxx11 can be configured on your gateway under Linux/IP.

* Mode: either DHCP Client or Static
* [IP Address]: the desired static IP address
* [Subnet Mask]
* [Gateway]
* [DNS Server]
* [Alternate DNS Server]

The optional parameters in [] can be only configured, if '''Static''' is selected as mode.

====Change the root credentials====

Here you can change the credentials of the Linux root user. 
Default password: '''iplinux'''

====Configure Authenticated URLs====

Configure credentials for authenticated URLs. These credentials will be used in automatic backups. 
You can add/remove Urls with the '''+''' and '''-''' at the right side of the list.

* URL: the URL, e.g. https://172.16.123.123/backup
* User: the user for this URL
* Password: the password for this URL

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

Default is Europe/Berlin but you can change that to a valid timezone (an error is given if timezone not present). 

====Change postgresql admin password====

If innovaphone Reporting is installed, you can configure another password for the postgres admin user. 
Default password: '''postgres'''.

===Web Server===

We use lighttpd version 1.4.32. The linux web server user is '''www-data''' and group user also '''www-data'''. Root directory for the web-server is '''/var/www/innovaphone'''. This information is mainly relevant if you plan to develope custom applications and integrate them into linux application platform.

Default users and password for the different levels on the Linux application plattform (see figure below):
[[image:Linux_Application_hierarki.PNG]]

====Change web server properties and public access to the web/webdav====
* Force HTTPS: enables redirection for HTTP to HTTPS
* Public Web Paths: these paths are not password protected, e.g. '/ap'
* Public Webdav Paths: these webdav paths are not password protected, e.g. '/backup'
** These paths are by default readonly. You can set the 'Write' flag to make the path also writable. This flag will be anyway ignored if credentials are provided. 

''<IPadr>''<code>/webdav/</code> is the root directory for webdav files. If you want to access a directory/file without credentials you have to add this directory to the Public Webdav Paths.

Example: <code>/webdav/background/</code> Here you have the background pictures for your Phones. 
Public Webdav Paths: <code>/background</code> or <code>/background/a</code> 
Now you have a public access to the folder background. 

* Enter a single '<code>/</code>' for a public root directory. All sub directories and files will be also public then. 
* If you enter e.g. '<code>/update/</code>', the directory 'update' and all sub directories/files will be public. 
* If you enter e.g. '<code>/update</code>', only the directory 'update' and its files will be public.

Important: Linux file names are case sensitive (so <code>/Update</code> is not equal <code>/update</code>)!.

====Change the Linux web server credentials====

Here you can change the credentials for Web Server access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change the Linux webdav access credentials====

Here you can change the credentials for webdav access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change application access credentials====

If you have installed an application, which has the lighttpd-auth property set in its configuration file, you can configure a separate user/password for the applications web site. 
If you want to disable the separate authentication, leave the '''user''' field empty and enter the currently configured password. The authentication will be the same as the root web server authentication afterwards. 
One can just login on the application web site with this access.

A configured access overrides a configured public web path to '/apps/application-name'!

====Configure mutual TLS====

If you need mutual TLS for innovaphone devices with a certificate signed by innovaphone, you can activate mutual TLS for a configurable '''port'''. 
Currently we're just supporting client certificates signed by innovaphone's ''innovaphone Device Certification Authority''. 
 
The physical mutual TLS path is '''/var/www/innovaphone/mtls'''. Here you can put your script files, e.g. mtls.php. 
You then call this script file by '''https://linux-ip:mtls-port/mtls.php''', as this path is the document root for the configured port.

'''How to upload the script:'''

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference10:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphone-applicationnamelogs=====

Saves log files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportinglogs'''

=====saveinnovaphone-applicationnamecfgs=====

Saves all neccessary configuration files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingcfgs'''

=====saveinnovaphone-applicationnamedb=====

Saves ddbb if existing as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingdb'''

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Relay Hosts===

The Application Platform contains a mail client which speaks SMTP.
The SMTP daemon (postfix) looks up by default the DNS MX record of the recipient email address. 
Relay SMTP hosts can also be configured to deliver the mails. Each relay host is related to a '''sender''' mail address or a '''sender''' mail domain. TLS is used if the host supports it. 
Examples of the server entry:
; mydomain.com: MX record to the domain
; smtphost: host name with MX record lookup
; [gateway.example.com]: host name with DNS lookup
; [an.ip.add.ress]: IP address without DNS lookup
The form [hostname] turns off MX lookups. See also [http://www.postfix.org/postconf.5.html#relayhost the postfix documentation]. 
If anonymous SMTP is to be used, user and password must be left empty.
 

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

Currently innovaphone Reporting and innovaphone Faxserver are using these relay hosts, if entered.

===Database===

The innovaphone database is created to store e.g. relay hosts.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The database user is '''innovaphone''' with default password '''innovaphone'''.
This password may be changed here.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

For the PgAdmin III it is imporant to use innovaphone as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone - Password: innovaphone

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
The following scripts are used to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference10:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=127

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|| TRACE_LDAP || 64
|-
|| TRACE_XML || 128
|-
|}

So currently all trace options are enabled with the level '''255'''.

Default trace level are "0"

==Appendix==
===Creating own applications===
See [[Reference10:Concept Linux Application]]

===Tools===

====WinSCP====

[https://winscp.net WinSCP] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference10:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference10:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference10:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference10:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

* adduser
* apt
* apt-utils
* aptitude
* aptitude-common
* base-files
* base-passwd
* bash
* binutils
* bsdmainutils
* bsdutils
* bzip2
* ca-certificates
* comerr-dev
* coreutils
* cpio
* cpp
* cpp-4.7
* cpp-4.6
* cron
* curl
* dash
* db-util
* db5.1-util
* debconf
* debconf-i18n
* debian-archive-keyring
* debianutils
* diffutils
* dmidecode
* dmsetup
* dos2unix
* dovecot-common
* dovecot-core
* dovecot-pgsql
* dovecot-pop3d
* dovecot-sieve
* dpkg
* e2fslibs
* e2fsprogs
* file
* findutils
* gamin
* gcc
* gcc-4.7
* gcc-4.6
* gcc-4.6-base
* gcc-4.7-base
* gettext-base
* gnupg
* gpgv
* grep
* groff-base
* grub-common
* grub-legacy
* gzip
* hdparm
* hostname
* ifupdown
* info
* initramfs-tools
* initscripts
* insserv
* install-info
* iproute
* iptables
* iputils-ping
* isc-dhcp-client
* isc-dhcp-common
* klibc-utils
* kmod
* krb5-multidev
* libacl1
* libapt-inst1.5
* libapt-pkg4.12
* libasprintf0c2
* libattr1
* libblkid1
* libboost-iostreams1.49.0
* libbsd0
* libbz2-1.0
* libbz2-dev
* libc-bin
* libc-client2007e
* libc-dev-bin
* libc6
* libc6-dev
* libcap2
* libclass-isa-perl
* libcomerr2
* libcurl3
* libcurl4-openssl-dev
* libcwidget3
* libdb5.1
* libdevmapper1.02.1
* libedit2
* libept1.4.12
* libexpat1
* libfcgi-dev
* libfcgi0ldbl
* libffi5
* libfreetype6
* libfuse2
* libgamin-dev
* libgamin0
* libgcc1
* libgcrypt11
* libgcrypt11-dev
* libgdbm-dev
* libgdbm3
* libglib2.0-0
* libgmp10
* libgnutls-dev
* libgnutls-openssl27
* libgnutls26
* libgnutlsxx27
* libgomp1
* libgpg-error-dev
* libgpg-error0
* libgpgme11
* libgpm2
* libgssapi-krb5-2
* libgssrpc4
* libidn11
* libidn11-dev
* libitm1
* libk5crypto3
* libkadm5clnt-mit8
* libkadm5srv-mit8
* libkdb5-6
* libkeyutils1
* libklibc
* libkmod2
* libkrb5-3
* libkrb5-dev
* libkrb5support0
* libldap-2.4-2
* libldap2-dev
* liblocale-gettext-perl
* liblzma5
* libmagic1
* libmemcache-dev
* libmemcache0
* libmount1
* libmpc2
* libmpfr4
* libmysqlclient18
* libncurses5
* libncursesw5
* libnewt0.52
* libnfnetlink0
* libonig2
* libopts25
* libp11-kit-dev
* libp11-kit0
* libpam-modules
* libpam-modules-bin
* libpam-pgsql
* libpam-runtime
* libpam0g
* libpam0g-dev
* libparted0debian1
* libpcre3
* libpcre3-dev
* libpcrecpp0
* libpipeline1
* libpng12-0
* libpng12-dev
* libpopt0
* libpq-dev
* libpq5
* libprocps0
* libpth20
* libqdbm14
* libquadmath0
* libreadline6
* librtmp-dev
* librtmp0
* libsasl2-2
* libsasl2-modules
* libselinux1
* libsemanage-common
* libsemanage1
* libsepol1
* libsigc++-2.0-0c2a
* libslang2
* libsqlite3-0
* libsqlite3-dev
* libss2
* libssh2-1
* libssh2-1-dev
* libssl-dev
* libssl1.0.0
* libstdc++6
* libtasn1-3
* libtasn1-3-dev
* libtext-charwidth-perl
* libtext-iconv-perl
* libtext-wrapi18n-perl
* libtinfo5
* libtokyocabinet9
* libudev0
* libusb-0.1-4
* libustr-1.0-1
* libuuid-perl
* libuuid1
* libwrap0
* libxapian22
* libxml2
* libxml2-dev
* libxml2-utils
* linux-base
* linux-image-3.2.0-4-686-pae
* linux-libc-dev
* locales
* login
* logrotate
* lsb-base
* lsb-release
* make
* makedev
* man-db
* manpages
* manpages-dev
* mawk
* mime-support
* mlock
* module-init-tools
* mount
* multiarch-support
* mysql-common
* nano
* ncurses-base
* ncurses-bin
* net-tools
* netbase
* netcat-traditional
* ntp
* ntpdate
* openssh-client
* openssh-server
* openssl
* parted
* passwd
* patch
* perl-base
* php-pear
* php-xml-parser
* php-xml-serializer
* php5-cgi
* php5-cli
* php5-common
* php5-curl
* php5-imap
* php5-pgsql
* php5-xcache
* pkg-config
* postfix
* postfix-pcre
* postfix-pgsql
* postgresql-9.1
* postgresql-client-9.1
* postgresql-client-common
* postgresql-common
* procps
* psmisc
* python
* python-minimal
* python2.7
* python2.7-minimal
* rdate
* readline-common
* rsyslog
* sasl2-bin
* sed
* sensible-utils
* shared-mime-info
* ssh
* ssl-cert
* sudo
* sysv-rc
* sysvinit
* sysvinit-utils
* tar
* tasksel
* tasksel-data
* traceroute
* tzdata
* ucf
* udev
* util-linux
* uuid-dev
* vim
* vim-common
* vim-runtime
* vim-tiny
* wget
* whiptail
* xz-utils
* zlib1g
* zlib1g-dev
* lighttpd-mod-webdav
* lighttpd

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference10:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix! 
 
Please do '''not''' perform an update/upgrade yourself, as this will break future hotfix/application releases. Sometimes we deliver debian packages in our hotfixes and dependencies might be broken if you update/upgrade yourself.

====I want to do it anyway!!!====
Ok, save your application/ap configuration and data files and install our latest '''FULL''' release without any hotfix. Restore the configuration/data files and perform your update/upgrade. Now you can be happy, if everything still works fine... 
Perform these steps for each new hotfix release, as you might not be able to apply a new hotfix.

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

The same can be done for application specific passwords, e.g. Reporting.
In this case, use the file '''/home/lighttpd/innovaphone-reporting-htdigest.user'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentioned above should be only the last try to get the data and could work or not.
To be always on the save site use a standby Linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

=== How to recover from a broken File System ===
Sometimes you may find messages in the ''kern.log'' log file (in ''var/log'') like

Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): initial error at 1500329378: ext4_journal_start_sb:328
Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): last error at 1500329378: ext4_journal_start_sb:328

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

* Open the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda4'' to <code>root=/dev/sda2</code>
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line
** on the command prompt, use <code>e2fsck -p -f /dev/sda4</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda2'' to <code>root=/dev/sda4</code>
** start Linux again
:: This will run Linux on the original partition.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the LAP and any applications and restore your backups.

<internal>
Internal: How to recover from a disk-is-full Condition: [http://wiki-intern.innovaphone.com/index.php?title=Reporting#Vergr.C3.B6.C3.9Fern_der_Partition_.28VM.29]
</internal>
[[Category:Concept|Linux Application Platform]]

Reference10:Concept Linux Application Platform

2017-08-28T09:16:00Z

Aschild: Explaining two types

==Introduction==

The innovaphone Linux Application Platform permits to install innovaphone or custom applications for certain purposes, like Reporting or a Fax Server. 
It also allows to backup/restore configuration files, uninstall applications or see and backup logs. 
 
The Linux distribution Debian 7.1 (Wheezy) is used and linux kernel is 3.4.10 (IPxx10) and 3.2.0.4 (VM) 
 
The architecture of the platform is armel. 
 

==Requirements==

There are three ways to use the innovaphone Linux Application Platform:

===On an IPxx10 Gateway===
* An IP810, IP0010, IP3010 or IP6010 Gateway
* Firmware Version 10
* A compact flash card with UDMA support (minimum 8 GB)
** We recommend SanDisk Extreme with UDMA and 90 MB/s or above

===On an IPx11 Gateway===
* An IP0011, IP311, IP411, IP811 or IP3011 Gateway
* Firmware Version 11r2
* An SSD mSATA

===As a Virtual Machine===
* VMWare Player/VMWare Workstation

* Minimal Requirements for the Virtual Machine:
1vCPU ( we run 800 MHZ CPU on our IPXX10 Gateways, so similar speed or higher it's enough, nevertheless depending on the operations/load you could need more CPU speed/vCPU)
512 MB RAM
8GB Disk

==Installation==

Download the latest Linux Application Platform from [https://download.innovaphone.com download.innovaphone.com ]. 
You can download and install two different packages: The IPxx10/IPx11 package to run on the gateways or a VMware image for VMware

===Default Credentials===
* Web/Webdav: '''admin'''/'''linux'''
* Root-Login (e.g. with Putty): '''root'''/'''iplinux'''

===Disk space calculation===
See [[Reference10:Concept_Reporting#Calculation_of_required_disk_space]].


It is strongly recommended that you try to precalculate the needed disk space and that you choose a suiting disk size.


===Disk space usage after first time installation===

====IPxx10/IPx11 Gateways====

* /dev/sda1: 32 MB (fat32 partition with two kernels, which are started by the IPxx10 or IPx11)
* /dev/sda2: 524 MB (ext2 initial installation partition)
* /dev/sda3: 120 MB (swap partition)
* /dev/sda4: 620 MB / xx GB depending of the size of the used CF card (ext4 partition, which is actually booted)

All in all about 1.3 GB are already in use after the initial installation.

====VMWare====

* /dev/sda1: 674 MB (ext2 initial installation partition)
* /dev/sda2: 120 MB (swap partition)
* /dev/sda3: 767 MB / xx GB depending of your pre installation configuration (ext3 partition, which is actually booted)

All in all about 1.6 GB are already in use after the initial installation.

===Linux Application Platform (IPxx10 or IPx11 Gateways)===

It is recommended to use CF-Cards with sizes of 8GB or more and the card '''must''' support UDMA! 
* Enable Linux under Linux General.
[[image:IPxx10_Linux_-_enable.png]]
* Be sure that "Autostart Linux" is disabled until the installation process is finished.
* You need to enable Proxy-ARP on ETH0 or ETH1 [[ Reference:Configuration/ETH/IP|here ]], so your gateway and the linux appliance will share the same physical interface. Simply go to '''IP4 > ETH0 (if used) > IP''' and check '''Proxy ARP'''
* Decompress the downloaded package. You should have an image file like <code>linux_ipxx10_armel.img</code> now. This works for both '''IPxx10''' and '''IPx11''' hardware!
* Upload the decompressed file over the gateways web interface under [[ Reference10:General/Compact-Flash/Image ]] (IPxx10) or [[ Reference12:General/SSD/Image ]] (IPx11). Unmount the CF card/SSD if necessary. Select "Part 1" before starting the upload!
[[image:IPxx10_Linux_-_upload_image.jpg]]
* Reset the box (which also activates the config change of step 1).
* Configure IP under [[ Reference10:Linux/IP ]]: select either "Disabled" to assign a static IP or ETH0/ETH1 to receive an IP-Address from DHCP-Server behind ETH0 or ETH1.
* Configure the kernel file, which you find under [[ Reference10:General/Compact-Flash/General#Browse_CF_Content ]] on [[ Reference10:Linux/General ]] '''Linux kernel file'''
** IPxx10 hardware: <code>Image-6010-3.4.10</code>
** IPx11 hardware: <code>Image-IPx11-4.4.0</code>
* Configure <code>root=/dev/sda2</code> under [[ Reference10:Linux/General ]] '''Kernel command line'''.
* If you want, configure the autostart flag.
* Submit your changes.
* Click the [[ Reference10:Linux/General ]] '''Start'''-Link. The page refreshes until Linux gets an IP and then tries to get a link to the Linux Web Server, which can take some time for the first time installation (~ 5 minutes to 2 hours).
[[Image:device_conf.jpg]]
* Open the Linux Web Server to see the installation progress (which might take several minutes too). The default credentials are '''admin'''/'''linux''' for both platforms.
[[Image:installation.jpg]]
* The output of the installation log is stored on the Linux AP under <code>/var/log/init_install.log</code>. In case you have no access to the web server but a console or SSH access, you can check the installation progress in this log file. E.g. login to the console with root/iplinux and run follwong command: <code>more /var/log/init_install.log</code>. In case you have an SSH connection to the Linux AP, you can download this file using [http://winscp.net WinSCP] tool.
* Enter the innovaphone device IP address (optional port allowed) and admin credentials when the installation has finished. Now wait until the page refrehses. The web server credentials are now the innovaphone device admin credentials, e.g. '''admin'''/'''ip6010'''.
** If the device couldn't be reconfigured, you will get an error message '''Command line at the PBX could not be changed...''' In this case, you have to open [[ Reference10:Linux/General ]] on your device, click stop and enter <code>root=/dev/sda4</code> under '''Kernel command line'''. Then start again. Your Linux webserver credentials will be '''admin'''/'''linux''' in this case.
* Linux install has finished.
* You will see now <code>root=/dev/sda4</code> under [[ Reference10:Linux/General ]] since Linux is running in on the fourth partition. You shouldn't change that unless you want to install Linux again.

===Linux Application Platform (VMWare)===

* Decompress the downloaded archive. You should have two files: '''IP-Debian.vmx''' and '''IP-Debian.vmdk'''.
* We can open using Vmware Player/Workstation, if you wish to run on Vsphere 4.x or later please convert it by the same method it's done with the IPVA (see [[Reference10:Concept_Innovaphone_Virtual_Appliance#VMware_vSphere | Using VMware vSphere]])
* Now you have two possibilities (example for VMWare Player, VMWare Workstation should be similar):
** If you want to assign more than 8 GB virtual flash:
*** Do '''not''' directly start/doubleclick the vmx file!
*** Start the VMware Player and Open the vmx file with '''Open a Virtual Machine'''.
*** Open '''Edit virtual machine settings'''.
*** Select the hard disk and '''Expand''' it under '''Utilities''' to the wished size.
*** Apply the change and klick '''Play virtual machine'''.
** If 8 GB are enough, simply double click the vmx file and Linux will start.
* The first time, a script will automatically configure a new partition, the web server etc., which will take some time. The waiting time depends on the CPU of the computer running the vmware player. In some cases the waiting time can be up to 30 minutes, in most cases the installation finishes in about 2-5 minutes.
* In the meantime, fetch your IP from the VMWare Player screen or login as root and get your IP address with the command '''ifconfig'''.
* Login to the web server to see the installation progress (it may take some minutes until the web server is up).
* Linux will restart automatically after the first time installation has finished.
* Linux install has finished.

===Hotfix Installation===
If you have already installed the latest version of the Linux Application Platform, simply download the Linux...HotfixIncremental for your platform (VM or IPxx10/IPx11) or if you have missed some hotfixes, download the Linux...HotfixCumulative archive, which contains all hotfixes since hotfix1.
 
 
Upload this hotfix archive [[Reference10:Concept_Linux_Application_Platform#Upload.2FUpdate|here]].

====Refreshing issue on installation====
You might get a PHP error when the browser is refreshing during the installation. Just refresh (F5) the page and you'll get the installation progress again.

=== Upgrade from a previous major Release ===
For instructions how to upgrade from a previous major release (such as V9 to V10), see ''Upgrading Linux Application Platform'' in [[Howto:Firmware_Upgrade_V9_V10|Firmware Upgrade V9 V10]].

===Static IP===
The Linux itself '''must''' be running in DHCP client mode to run properly. If you want to assign a static IP address, do it like this:

* On an IPxx10/IPxx11: assign a static IP under [[Reference10:Linux/IP]], this will do an internal DHCP response to the Linux that's running as DHCP client mode.
* On a VMWare: assign a static IP in your local DHCP server for your MAC address defined in the *.vmx file.

===IPxx10/IPxx11 Transit network for Linux===
When running Linux on an innovaphone device IPxx10/IPxx11 there is no dedicated network interface for the Linux machine. Instead we have a special transit network between the Linux and the device. The Linux will always operate as DHCP Client mode.

Any ARP request done by the Linux machine will always get the same ARP result that will be the internal "NIC" inside the device, so all packets are always sent to the same IPxx10/IPxx11 device that works as a router. When the packet sent by the Linux machine arrives the innovaphone device, it will follow the IP routing table of the device itself.

In case we have a single network (voice) we will have no problem since the default gateway is just one. However, if we wish to split into two networks (voice and data) and the Linux machine should have a different default gateway, this has no effect since IP routing is based on the innovaphone device IP routing table, because we can't have two default gateways at the same time.

==Administration==

===General===

====Configure IP====

The IP configuration on the Linux Application Platform is '''only''' available on a '''VM'''! A static IP for a Linux Application Platform for an IPxx10/IPxx11 can be configured on your gateway under Linux/IP.

* Mode: either DHCP Client or Static
* [IP Address]: the desired static IP address
* [Subnet Mask]
* [Gateway]
* [DNS Server]
* [Alternate DNS Server]

The optional parameters in [] can be only configured, if '''Static''' is selected as mode.

====Change the root credentials====

Here you can change the credentials of the Linux root user. 
Default password: '''iplinux'''

====Configure Authenticated URLs====

Configure credentials for authenticated URLs. These credentials will be used in automatic backups. 
You can add/remove Urls with the '''+''' and '''-''' at the right side of the list.

* URL: the URL, e.g. https://172.16.123.123/backup
* User: the user for this URL
* Password: the password for this URL

====Configure NTP server====

Configures a NTP server.

* NTP Server: the IP of the NTP Server

====Change Timezone====

Default is Europe/Berlin but you can change that to a valid timezone (an error is given if timezone not present). 

====Change postgresql admin password====

If innovaphone Reporting is installed, you can configure another password for the postgres admin user. 
Default password: '''postgres'''.

===Web Server===

We use lighttpd version 1.4.32. The linux web server user is '''www-data''' and group user also '''www-data'''. Root directory for the web-server is '''/var/www/innovaphone'''. This information is mainly relevant if you plan to develope custom applications and integrate them into linux application platform.

Default users and password for the different levels on the Linux application plattform (see figure below):
[[image:Linux_Application_hierarki.PNG]]

====Change web server properties and public access to the web/webdav====
* Force HTTPS: enables redirection for HTTP to HTTPS
* Public Web Paths: these paths are not password protected, e.g. '/ap'
* Public Webdav Paths: these webdav paths are not password protected, e.g. '/backup'
** These paths are by default readonly. You can set the 'Write' flag to make the path also writable. This flag will be anyway ignored if credentials are provided. 

''<IPadr>''<code>/webdav/</code> is the root directory for webdav files. If you want to access a directory/file without credentials you have to add this directory to the Public Webdav Paths.

Example: <code>/webdav/background/</code> Here you have the background pictures for your Phones. 
Public Webdav Paths: <code>/background</code> or <code>/background/a</code> 
Now you have a public access to the folder background. 

* Enter a single '<code>/</code>' for a public root directory. All sub directories and files will be also public then. 
* If you enter e.g. '<code>/update/</code>', the directory 'update' and all sub directories/files will be public. 
* If you enter e.g. '<code>/update</code>', only the directory 'update' and its files will be public.

Important: Linux file names are case sensitive (so <code>/Update</code> is not equal <code>/update</code>)!.

====Change the Linux web server credentials====

Here you can change the credentials for Web Server access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change the Linux webdav access credentials====

Here you can change the credentials for webdav access.

If running VMWare, default password is '''linux'''. If running IPXX10, password is the one entered at the end of first installation (admin password of the device where linux is running)

====Change application access credentials====

If you have installed an application, which has the lighttpd-auth property set in its configuration file, you can configure a separate user/password for the applications web site. 
If you want to disable the separate authentication, leave the '''user''' field empty and enter the currently configured password. The authentication will be the same as the root web server authentication afterwards. 
One can just login on the application web site with this access.

A configured access overrides a configured public web path to '/apps/application-name'!

====Configure mutual TLS====

If you need mutual TLS for innovaphone devices with a certificate signed by innovaphone, you can activate mutual TLS for a configurable '''port'''. 
Currently we're just supporting client certificates signed by innovaphone's ''innovaphone Device Certification Authority''. 
 
The physical mutual TLS path is '''/var/www/innovaphone/mtls'''. Here you can put your script files, e.g. mtls.php. 
You then call this script file by '''https://linux-ip:mtls-port/mtls.php''', as this path is the document root for the configured port.

'''How to upload the script:'''

Using a webdav client (like NetDrive) upload the script to the webdav folder.
Afterwards connect with Putty to the linux.

The uploaded file is under /var/www/innovaphone/webdav and we must move it to /var/www/innovaphone/mtls

===Certificates===

The current server certificate installed on the web server is shown here. A self signed certificate, innovaphone-linux, is installed by default. It is recommended to change it with your own certificate.

It is also possible to trust or reject other certificates.

'''Note''': Currently the LAP doesn't support the upload of a password protected certificate. As a workaround it is possible to convert the certificate with OpenSSL (on windows or Linux) to PEM format without password and upload this one.

With the following openssl command, the password protected certificate can be changed into an unprotected certificate.

<code>openssl pkcs12 -in</code> ''CertificateWithPasswort'' <code>-out</code> ''CertificateWithoutPasswort''.pem <code>-nodes</code>

The unprotected certificate should be deleted directly after upload for security reasons.

If you want to create a private, unsigned certificate you can do this with the following commands on the Linux AP CLI.
It is best to go in a folder which can be reached via http later as <code>/var/www/innovaphone/webdav/...</code>

Enter the following command:

<code>openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days xxxx (insert number)</code>

Add <code>-nodes</code> if you don't want to protect your private key with a passphrase.

You now will be asked for certificate information.

To merge the certificate and key you can enter the following command:

<code>cat cert.pem >> key.pem</code>

The file key.pem can now be uploaded via the web interface of the Linux AP.

===Backup===

The web server can be configured to poll a Command File URL (on a web server). 
The backup process is similar to [[Reference10:Services/Update]]. 

An alarm server can be also configured to receive alarms during an automatic backup: [[ #Alarm_Server | Alarm Server under Diagnostics ]].

At the bottom you will see a list of the current automatic backup serials from the Command File URL and the log of the last automatic backups.

[[Image:backup_restore.jpg]]

====Command File====

Example:
saveinnovaphonecfgs http://172.16.123.123/webdav/backup/cfgs-#i-#b10.tar.gz

The available default commands are:

=====saveinnovaphonecfgs=====

Saves all neccessary configuration files (no application specific files) as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphonelogs=====

Saves all available (also application related) log files as a tar gz archive (so you should use .tar.gz as ending).

=====saveinnovaphone-applicationnamelogs=====

Saves log files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportinglogs'''

=====saveinnovaphone-applicationnamecfgs=====

Saves all neccessary configuration files as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingcfgs'''

=====saveinnovaphone-applicationnamedb=====

Saves ddbb if existing as a tar gz archive (so you should use .tar.gz as ending) for applicationname (reporting, exchange or faxserver)
'''saveinnovaphone-reportingdb'''

=====times=====
Executes the following command(s) only, if the specified time matches and only once per hour (independent of poll timeout value). 
Example:

<pre>
# both commands always executed
saveinnovaphonelogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-logs-#i-#m-#b10.tar.gz
saveinnovaphonecfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-cfg-#i-#m-#b10.tar.gz
# commands only from monday till saturday at 10am and 11am executed.
times day:1,2,3,4,5 hour:10,11
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
# commands only Saturdays and Sundays at 00am executed.
times day:6,7 hour:00
saveinnovaphone-reportingcfgs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-cfgs-#i-#d-#b10.tar.gz
saveinnovaphone-reportinglogs http://xxx.xxx.xxx.xxx.xxx/webdav/backup/linux-innovaphone-reporting-logs-#i-#d-#b10.tar.gz
</pre>

* day goes from 1 (Monday) to 7 (Sunday). 
* hour goes from 00 to 23. 

You can specify multiple times commands to override the last one. 

=====Backup file name macros=====

You can use some macros for the backup filename:

* #i - will be replaced with the current IP address
* #m - will be replaced with the current MAC address
* #d - will be replaced with date/time in format Ymd-His (20110231-111010)
* #bxx - will be replaced with the current backup index, whilst xx is the maximum index

====Save configuration files/data====

Open this link to see all available files/data/logs to download them manually.

Password files for web server authentication won't be saved!

====Restore configuration files/data====

Open this link to restore all available files/data.

Password files for web server authentication won't be restored!

===Relay Hosts===

The Application Platform contains a mail client which speaks SMTP.
The SMTP daemon (postfix) looks up by default the DNS MX record of the recipient email address. 
Relay SMTP hosts can also be configured to deliver the mails. Each relay host is related to a '''sender''' mail address or a '''sender''' mail domain. TLS is used if the host supports it. 
Examples of the server entry:
; mydomain.com: MX record to the domain
; smtphost: host name with MX record lookup
; [gateway.example.com]: host name with DNS lookup
; [an.ip.add.ress]: IP address without DNS lookup
The form [hostname] turns off MX lookups. See also [http://www.postfix.org/postconf.5.html#relayhost the postfix documentation]. 
If anonymous SMTP is to be used, user and password must be left empty.
 

[[Image:relay_hosts.jpg]]

'''Note:''' Important to use "[]" like the picture.

Currently innovaphone Reporting and innovaphone Faxserver are using these relay hosts, if entered.

===Database===

The innovaphone database is created to store e.g. relay hosts.
PostgreSQL is also available for other applications and any of them could create its own database.

====Password====

The database user is '''innovaphone''' with default password '''innovaphone'''.
This password may be changed here.

====Remote Access====

There are tools (PgAdmin III) that allow to connect to application databases remotely.
It is first needed to configure the IP you are connecting from here. (Only Single-IP entry it's allowed, no submask or wildcard for multiple IPs)

For the PgAdmin III it is imporant to use innovaphone as Service-DB (Wartungs-DB). Default login credentials - User: innovaphone - Password: innovaphone

===Announcements===

You can upload a 16bit,8khz,mono wave file, which will be converted to G711U/G711A/G723/G729 . 
The converted files will be stored inside the webdav/announcements folder, e.g. http://172.16.111.111/webdav/announcements/test.g7xx 
 
If you check the '''Return files as ZIP file''' flag, you will get a ZIP file, which contains the converted files. These files are not stored locally then! 
For the new Codec G722, OPUS-NB and OPUS-WB you have to use the online converter available on my.innovaphone portal (login necessary first): https://my.innovaphone.com/support.php or on our website https://www.innovaphone.com/en/support/convert.html. No Conversion of new codecs is possible with Linux AP !

==Applications==

===List===

A list of all currently installed applications. 
If an application has an own web interface, you can reach it by using the application name link. 

====Uninstall====
Use the uninstall link in the list to uninstall an application.

===Upload/Update===

Here all new applications, application updates and application platform updates are installed. 
After uploading the file, the installation will start automatically and the installation process will be shown. The page refreshes until the installation has finished.

==Diagnostics==

===Logs===

Here you can view, download or clear the available log files from the application platform or from installed applications. 
You can also download all log files at once (this archiv also contains older versions from the log files).

===RPCAP===

Enable/disable RPCAP for use with Wireshark. 
A link will be displayed, which you can use within Wireshark.

===Alarm Server===

Configure an innovaphone device as alarm server:

* '''ip''': IP address of the innovaphone device
* ['''port''']
* ['''user''']: user for authentication to the alarm server
* ['''password''']
* ['''https''']: use https to send the alarm

Options in '''[]''' are optional.

Alarms from installed applications or the application platform itself will be sent to this configured server.

===Status===

View the disk usage.

===Reset===
====IPxx10====

Shutdown the application platform. You'll have to restart it over the IPxx10 gateway.

====VMWare====

Shutdown the application platform or reboot it.

===Status PHP script===
http://LinuxAP/status.php returns an XML file containing the output from the following linux commands: 
* df -H
* free -h
* uptime
* ps -wwweo pid,lstart,time,etime,pcpu,pmem,rsz,vsz,args
* ss -A inet -ap
* top -b -n 1

==Use as Log or Alarm Server==

You can use the application platform as a server for innovaphone logs. 
Configure Local-AP(-s)/Remote-AP(-s) on [[Reference10:Services/Logging]].
 
The following scripts are used to retrieve the logs/alarms:
* logs: /ap/log.fcgi
* alarms: /ap/alarm.fcgi

So you can make the path '''/ap''' public on the ''Linux Web Server'' or you configure an authenticated URL for these files/this path on your ''innovaphone gateway''. 

If you configure an authenticated URL, don't forget to configure port 80 or port 443 for secure transport (Remote-AP-S) like
https://111.111.111.111:443/ap or http://111.111.111.111:80/ap

The log and alarm files will be saved unter http://LAP/webdav/log or /alarm. The files are rotated after 1 MB size and four times, so you'll have max 5 files.

==Use as File/VM-Server==

You can use the application platform as file server, e.g. for udpate scripts, voicemail etc. 
You can access the server with a webdav client via '''http(s)://Linux-IP/webdav''' 
Public access to certain paths etc. can be configured under the [[Reference10:Concept_Linux_Application_Platform#Web_Server | web server configuration]].

Keep in mind that the Linux Filesystem(ext3) is case sensetive. The PBX will always search for lowercase letters. If you name your file ‘greetings.G711A’ it won’t be found. You have to name the file ‘greetings.g711a’.

==Enable further Tracing==
There are different trace options, which can be enabled by calling a certain php script: 
https://LINUX-IP/trace.php?level=127

The level is calculated by the addition of one or multiple of the following trace options:

{| border=1
|| '''Option''' || '''To add'''
|-
|| TRACE_STD || 1
|-
|| TRACE_DB || 2
|-
|| TRACE_TIME || 4
|-
|| TRACE_CALL_FLOW_TOTAL || 8
|-
|| TRACE_CALL_FLOW || 16
|-
|| TRACE_PARSE_CFG || 32
|-
|| TRACE_LDAP || 64
|-
|| TRACE_XML || 128
|-
|}

So currently all trace options are enabled with the level '''255'''.

Default trace level are "0"

==Appendix==
===Creating own applications===
See [[Reference10:Concept Linux Application]]

===Tools===

====WinSCP====

[https://winscp.net WinSCP] is a usefull webdav client, which can be used to access webdav of the innovaphone application platform.

====Putty====

[http://www.putty.org/ Putty] is SSH client to connect to the linux application platform.

===Manual Debian Upgrade===
If you have installed one of our upgrade hotfixes and you had installed packages, which weren't included in innovaphone applications, the upgrade of some packages might have failed. You will see a warning message on your application platform. Something like:

<code type="text">
The following packages couldn't be upgraded due to missing dependencies: php5-cgi php5-cli
Take a look at our wiki to see, what you have to do now!
</code>

Now you have to perfom some actions yourself:
* make sure, your Linux Application Platform has internet access
* login with a terminal client like Putty
* start 'apt-get update'
* start 'apt-get install php5-cgi php5-cli' (list the packages of the warning message)
* delete the file /var/www/innovaphone/log/missing_packages.log to clear the warning message:
** rm /var/www/innovaphone/log/missing_packages.log

Your installation should be now up to date again.

===Configuring a new Kernel===
If you have installed a hotfix with a new kernel, you will see a warning message on your application platform. Something like:

<code type="text">
You're not running the latest kernel Image-6010-3.4.10!
Take a look at our wiki to see, what you have to do now!
</code>

To change to the new kernel, you have to reconfigure something on your device, where the CF card is plugged in.
* First shutdown your Linux (see [[ Reference10:Concept_Linux_Application_Platform#IPxx10 ]])
* Stop Linux under [[ Reference10:Linux/General ]]
* Configure the latest kernel file (currently <code>Image-6010-3.4.10</code>) under [[ Reference10:Linux/General ]] '''Linux kernel file'''
* Start Linux under [[ Reference10:Linux/General ]]

===Alarms of the Application Platform===
If you have configured an [[ #Alarm_Server | Alarm Server]], you will receive certain alarms. 
Currently, the following alarms exist:

* Disk Usage >= 90%
* read-only mounted partition
* bad blocks on CF cards
* Alarms for the innovaphone Reporting Application, if installed
* Alarms for the innovaphone Exchange Calendar Connector Application, if installed
* Alarms for the innovaphone Faxserver Application, if installed

===Initially installed packages===

The following packages are already installed without any application:

* adduser
* apt
* apt-utils
* aptitude
* aptitude-common
* base-files
* base-passwd
* bash
* binutils
* bsdmainutils
* bsdutils
* bzip2
* ca-certificates
* comerr-dev
* coreutils
* cpio
* cpp
* cpp-4.7
* cpp-4.6
* cron
* curl
* dash
* db-util
* db5.1-util
* debconf
* debconf-i18n
* debian-archive-keyring
* debianutils
* diffutils
* dmidecode
* dmsetup
* dos2unix
* dovecot-common
* dovecot-core
* dovecot-pgsql
* dovecot-pop3d
* dovecot-sieve
* dpkg
* e2fslibs
* e2fsprogs
* file
* findutils
* gamin
* gcc
* gcc-4.7
* gcc-4.6
* gcc-4.6-base
* gcc-4.7-base
* gettext-base
* gnupg
* gpgv
* grep
* groff-base
* grub-common
* grub-legacy
* gzip
* hdparm
* hostname
* ifupdown
* info
* initramfs-tools
* initscripts
* insserv
* install-info
* iproute
* iptables
* iputils-ping
* isc-dhcp-client
* isc-dhcp-common
* klibc-utils
* kmod
* krb5-multidev
* libacl1
* libapt-inst1.5
* libapt-pkg4.12
* libasprintf0c2
* libattr1
* libblkid1
* libboost-iostreams1.49.0
* libbsd0
* libbz2-1.0
* libbz2-dev
* libc-bin
* libc-client2007e
* libc-dev-bin
* libc6
* libc6-dev
* libcap2
* libclass-isa-perl
* libcomerr2
* libcurl3
* libcurl4-openssl-dev
* libcwidget3
* libdb5.1
* libdevmapper1.02.1
* libedit2
* libept1.4.12
* libexpat1
* libfcgi-dev
* libfcgi0ldbl
* libffi5
* libfreetype6
* libfuse2
* libgamin-dev
* libgamin0
* libgcc1
* libgcrypt11
* libgcrypt11-dev
* libgdbm-dev
* libgdbm3
* libglib2.0-0
* libgmp10
* libgnutls-dev
* libgnutls-openssl27
* libgnutls26
* libgnutlsxx27
* libgomp1
* libgpg-error-dev
* libgpg-error0
* libgpgme11
* libgpm2
* libgssapi-krb5-2
* libgssrpc4
* libidn11
* libidn11-dev
* libitm1
* libk5crypto3
* libkadm5clnt-mit8
* libkadm5srv-mit8
* libkdb5-6
* libkeyutils1
* libklibc
* libkmod2
* libkrb5-3
* libkrb5-dev
* libkrb5support0
* libldap-2.4-2
* libldap2-dev
* liblocale-gettext-perl
* liblzma5
* libmagic1
* libmemcache-dev
* libmemcache0
* libmount1
* libmpc2
* libmpfr4
* libmysqlclient18
* libncurses5
* libncursesw5
* libnewt0.52
* libnfnetlink0
* libonig2
* libopts25
* libp11-kit-dev
* libp11-kit0
* libpam-modules
* libpam-modules-bin
* libpam-pgsql
* libpam-runtime
* libpam0g
* libpam0g-dev
* libparted0debian1
* libpcre3
* libpcre3-dev
* libpcrecpp0
* libpipeline1
* libpng12-0
* libpng12-dev
* libpopt0
* libpq-dev
* libpq5
* libprocps0
* libpth20
* libqdbm14
* libquadmath0
* libreadline6
* librtmp-dev
* librtmp0
* libsasl2-2
* libsasl2-modules
* libselinux1
* libsemanage-common
* libsemanage1
* libsepol1
* libsigc++-2.0-0c2a
* libslang2
* libsqlite3-0
* libsqlite3-dev
* libss2
* libssh2-1
* libssh2-1-dev
* libssl-dev
* libssl1.0.0
* libstdc++6
* libtasn1-3
* libtasn1-3-dev
* libtext-charwidth-perl
* libtext-iconv-perl
* libtext-wrapi18n-perl
* libtinfo5
* libtokyocabinet9
* libudev0
* libusb-0.1-4
* libustr-1.0-1
* libuuid-perl
* libuuid1
* libwrap0
* libxapian22
* libxml2
* libxml2-dev
* libxml2-utils
* linux-base
* linux-image-3.2.0-4-686-pae
* linux-libc-dev
* locales
* login
* logrotate
* lsb-base
* lsb-release
* make
* makedev
* man-db
* manpages
* manpages-dev
* mawk
* mime-support
* mlock
* module-init-tools
* mount
* multiarch-support
* mysql-common
* nano
* ncurses-base
* ncurses-bin
* net-tools
* netbase
* netcat-traditional
* ntp
* ntpdate
* openssh-client
* openssh-server
* openssl
* parted
* passwd
* patch
* perl-base
* php-pear
* php-xml-parser
* php-xml-serializer
* php5-cgi
* php5-cli
* php5-common
* php5-curl
* php5-imap
* php5-pgsql
* php5-xcache
* pkg-config
* postfix
* postfix-pcre
* postfix-pgsql
* postgresql-9.1
* postgresql-client-9.1
* postgresql-client-common
* postgresql-common
* procps
* psmisc
* python
* python-minimal
* python2.7
* python2.7-minimal
* rdate
* readline-common
* rsyslog
* sasl2-bin
* sed
* sensible-utils
* shared-mime-info
* ssh
* ssl-cert
* sudo
* sysv-rc
* sysvinit
* sysvinit-utils
* tar
* tasksel
* tasksel-data
* traceroute
* tzdata
* ucf
* udev
* util-linux
* uuid-dev
* vim
* vim-common
* vim-runtime
* vim-tiny
* wget
* whiptail
* xz-utils
* zlib1g
* zlib1g-dev
* lighttpd-mod-webdav
* lighttpd

==Known Issues==
=== Do not update Debian Packages ===
The Linux application platform comes with the tested set of required Debian packages. ''It is not recommended to do a manual update of those packages'' (or the kernel itself). We have seen situations where updated packages had been changed in a non-downward compatible fashion - resulting in the applications running on the Linux application platform not working properly an more!

===Separate authentication for innovaphone applications===
If you configured a separate authentication, it depends on the used browser, whether you have to re-authenticate on switching between the root web and the innovaphone application web access or not.

===Refreshing issue on hotfix installation===
[[ Reference10:Concept_Linux_Application_Platform#Refreshing_issue_on_installation | See here. ]]

===Kernel Update in VM Platform===
The installation of a new kernel fails and this process leaves the system unstable, not being able to install any more debian packages. Hotfix installations will probably fail.

===Outdated packages? Debian Upgrade?===
From time to time we will deliver upgraded debian packages with a new hotfix. As we have to insure compatibility with our applications, we won't perform an upgrade for each hotfix! 
 
Please do '''not''' perform an update/upgrade yourself, as this will break future hotfix/application releases. Sometimes we deliver debian packages in our hotfixes and dependencies might be broken if you update/upgrade yourself.

====I want to do it anyway!!!====
Ok, save your application/ap configuration and data files and install our latest '''FULL''' release without any hotfix. Restore the configuration/data files and perform your update/upgrade. Now you can be happy, if everything still works fine... 
Perform these steps for each new hotfix release, as you might not be able to apply a new hotfix.

==How To==
===Reset webserver/webdav passwords===
In case you have lost your webserver or webdav password, but you still have the root credentials, you can login with SSH and execute the following commands:

<code type="bash">
echo "admin:Linux Web Server:c33c4d3f554367d5d1c3c9bf36803024" > /home/lighttpd/lighttpd_htdigest.user
echo "admin:Linux Webdav:7182e328a0531dd2d44d225f36da6b87" > /home/lighttpd/webdav_htdigest.user
/etc/init.d/lighttpd restart
</code>

Afterwards you can access your webserver/webdav with '''admin'''/'''linux'''

The same can be done for application specific passwords, e.g. Reporting.
In this case, use the file '''/home/lighttpd/innovaphone-reporting-htdigest.user'''

==TroubleShooting==

===Installation process failed===

When the installation process stuck either because it doesn't get IP or services are not refresh/finished there is some additional information we could get from the Compact Flash that could help us understanding what is failing and if necessary open a support ticket and include this information in the ticket to innovaphone.

* Stop the linux and check General->Compact Flash "Browse files". All files in there might be helpfull (all but the kernel, of course).
* Start the linux and check if you can connect to the configured/expected IP address via Putty after ~1 minute.

Note: The file /var/log/init_install.log might help us to get a clue of the failure.

===Howto save and restore Linux AP data/database if the webgui is not available===

If the linux ap webgui is not reachable a common reason is that the harddisc is full.
If a full hd is the case, maybe your first thought is to increase the harddisc.
It could be a solution but there are some traps to increase the partition in linux which can be ended in complete data loss

The fastest way to get linux ap working with a new harddsik size is to install a new one.

'''How can you save the data without get access over the webgui?'''
If you can reach linux via putty it could be possible :)

Here are some possibilities how to do that over the shell:
'''(But keep in the back of you head that you are working as root and therefore typing errors can lead to undesirable behaviours!)'''

1. Delete at first all the logfiles. Sometimes a few MByte are enough to get all the stopped services running again and you could reach liunx over the webgui.
i.e. the reporting logfiles are under "''/var/www/innovaphone/apps/innovaphone-reporting/log''", the fax server logfiles are under
"''/var/www/innovaphone/apps/innovaphone-faxserver/log''"
-> '''Don't delete the 'log' directory itself!''' Delete only the content:

root@vmware-debian: cd /var/www/innovaphone/apps/innovaphone-reporting/log/
root@vmware-debian: rm *

Is the linux ap after a restart running and over http reachable, download all the config and databases and restore them on the new linux ap (2.2).

[[image:save.png]]

2. In case the reason for the unreachable webgui was not a full harddisk you can save the config/database (only reporting and exchange connector at the moment)
over the shell.

root@vmware-debian:/# cd /home/postgres/
''for reporting type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-reporting | gzip -fc6 > innovaphone-reporting-db.gz

root@vmware-debian:/# cd /home/postgres/
''for exchange connector type:''
root@vmware-debian:/# sudo -u postgres /usr/bin/pg_dump --encoding=utf8 --schema=public -Fc -U postgres innovaphone-exchange | gzip -fc6 > innovaphone-exchange-db.gz

2.1 Access linux with winscp '''(protocol: scp / user: root)''' and download the .gz (don't unzip)

[[image:reporting.png]]

(BTW: you can '''download''' with '''scp''' also the complete webdav files. But for the '''upload''' use as user 'admin' and as protocol "'''webdav'''".
Otherwise the owner is still root and this ends in authorization problems)

[[image:webdav.png]]

2.2. on the new linux ap upload this .gz

[[image:restore.png]]

3. The steps mentioned above should be only the last try to get the data and could work or not.
To be always on the save site use a standby Linux (for reporting), save configs (update server) and delete (automatic) old cdr's to avoid a full hd.

=== How to recover from a broken File System ===
Sometimes you may find messages in the ''kern.log'' log file (in ''var/log'') like

Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): initial error at 1500329378: ext4_journal_start_sb:328
Aug 15 10:45:31 ip6010-debian kernel: EXT4-fs (sda4): last error at 1500329378: ext4_journal_start_sb:328

This indicates a file system failure on the Linux Installation.

When the Linux file system is broken, you can try to repair it using some command line Linux tools.

* Open the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda4'' to <code>root=/dev/sda2</code>
** start Linux again
:: This will run Linux on another (hopefully sane) partition.

* use [https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html putty] to log in to the LAP's command line
** on the command prompt, use <code>e2fsck -p -f /dev/sda4</code>
:: this should fix any issue on the file system

* go back to the WebGUI of the gateway running your LAP and proceed to ''Linux/General''
** terminate Linux (''Status/Stop'')
** modify the ''Kernel command line'' from ''root=/dev/sda2'' to <code>root=/dev/sda4</code>
** start Linux again
:: This will run Linux on the original partition.

If this doesn't fix your issue, you need to replace the SSD with a new one, re-install the LAP and any applications and restore your backups.

<internal>
Internal: How to recover from a disk-is-full Condition: [http://wiki-intern.innovaphone.com/index.php?title=Reporting#Vergr.C3.B6.C3.9Fern_der_Partition_.28VM.29]
</internal>
[[Category:Concept|Linux Application Platform]]

Howto:Gigaset N510 PRO - Gigaset - Testreport

2017-08-22T09:03:54Z

Aschild: Added reverse proxy doc

Howto:Gigaset N510 PRO - Gigaset - Testreport

2017-08-22T09:02:32Z

Aschild: Firmware 42.240 solves SIP Digest auth problem

==Summary==

The Gigaset N510IP PRO DECT base-station supports all required innovaphone features and is therefore qualified as [[Howto:What_is_a_%22recommended_product%22%3F|recommended product]].

The usage of wideband codecs of the phone were tested successfully. The integration of the innovaphone voicemail in the Gigaset solution is possible. The message waiting indication will be displayed on the handsets. The handsets support 3-party conference calls.

The Gigaset N510IP PRO DECT base-station was tested successfully also in a [[Howto:Hosting#Overview | hosted setup]]. The test results are the same as if the N510IP is used in a normal (in the same LAN as the PBX) setup. It is not required to activate MediaRelay on the Frontend.

==Certification Status==

{{Template:Compat Status "tested"}}





Testing of this product has been finalized September 6th, 2013.

==Version==
Firmware Version:
* 42.078 (420780000000 / V42.00)

innovaphone Firmware:
* V10 SR3
* TSP 8150

== Test Setup ==
[[Image:Testreport_Terminals_SIP_or_H323_1.PNG]]

==Device Setup==

{| border="1"
!Tested feature
!Result
|----
|Register Device w/o specific configuration (requires DHCP)
|No
|----
|DHCP is default
|Yes
|----
|DHCP yields timeserver and time displays correctly
|No, set static to public NTP server
|----
|SNTP config has TZ string for timezone/dst autoconfig
|No, set static to public NTP server
|----
|DHCP yields correct default gateway
|Yes
|----
|Device supports magic registration (e.g. by serial)
|No
|----
|Fixed registrations works
|Yes
|----
|Device registers w/o Extension (just by name)
|Yes
|----
|Device registers by name with non-latin1 characters (e.g. UserÄÖÜ)
|Yes
|----
|Device registers by extension
|Yes
|----
|Device registers with password
|Yes
|----
|Device registers multiple identities
|Yes
|----
|2nd GK is supported
|According to [https://gigaset.atlassian.net/wiki/pages/viewpage.action?pageId=28540959 gigaset-wiki] only by DNS according to RFC3263
|----
|Device supports Redirection of Registration (Master redirects to Slave)
|No
|----
|Device supports STUN protocol
|Yes
|----
|Device sends NAT - keepalive messages
|Yes
|----
|Device refreshes the PBX registration
|Yes
|----
|Device supports SIP over TCP
|Not tested in LAN setup. Not usable for Hosting Setup, TCP connection is close immediately after SIP-TCP messages was sent. As a result - in a hosting setup the phone is not reachable for incoming calls.
|----
|Device supports SRTP
|Not tested, needs SIPS
|----
|Device supports SIPS (SIP over TLS)
|Not OK, registration fails
|----
|Device supports HTTPS
|Not for Admin access on the Web-page, probably as HTTP-client to retrieve firmware/configuration from remote servers
|----
|Device supports VAD (Voice activity detection)
|Not tested, according to manual supported
|----
|Supported menu languages
|many, check [http://gigaset.com/de/de/pages/index.html product specifications]
|----
|3-party conference
|Yes
|}

==Test Results==

=== Basic Call ===

{| border="1"
!Tested feature
!Result with MR
|----
|call using g711a
|Yes
|----
|call using g711u
|Yes
|----
|call using g729
|Yes
|----
|call using g722
|Yes
|----
|Overlapped sending
|No
|----
|Device sets up an early media channel for incoming calls
|N/A
|----
|Device sets up an early media channel for outgoing calls
|Yes
|----
|Device shows called id number
|Yes
|----
|Device shows called id name
|Yes
|----
|Device shows called id display info
|Yes
|----
|Fax using T.38
|N/A
|----
|CGPN can be suppressed
|Yes
|----
|Reverse Media Negotiation
|Yes
|----
|Device shows CDPN/CGPN on incoming call
|Yes
|----
|Device shows CDPN/CGPN on outgoing call
|Yes
|----
|Device shows connected number
|No
|----
|Device shows diverting number
|No
|----
|Device supports distinctive ringing
|Yes
|----
|Device supports asymetric codec negotiation
|Not tested
|----
|Device supports codec renegotiation during a conversation
|Yes
|----
|Device shows correct display message in case of busy CDPN
|Yes
|----
|Device shows correct display message in case of not existing CDPN
|No, it says "Not available"
|----
|Device shows correct display message in case that the call is declined
|Yes
|----
|3party conference possible
|Yes
|----
|Device supports display updates during call(needed for Directory Search object)
|No
|----
|Long Time Call (>30 min) works?
|Yes
|----
|Incoming SRTP call - SRTP not enabled on DUT
|Yes
|----
|Incoming SRTP call - SRTP enabled on DUT
|Not tested, requires sips
|----
|Voice Quality OK?
|Yes
|}

=== DTMF ===

{| border="1"
!Tested feature
!Result
|----
|DTMF tones sent correctly
|OK
|----
|DTMF tones received correctly
|OK, DTMFs are sent as RTP-Events (no DTMF dependent function on Gigaset device)
|}

=== Hold/Retrieve ===

{| border="1"
!Tested feature
!Result
|----
|Device handles incoming hold correctly
|Yes
|----
|Device can put a call on hold using correctly(inactive or sendonly)
|Yes
|}

=== Transfer with consultation ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Transfer without consultation (alerting only) ===

{| border="1"
!Tested feature
!Voice Ok?
!MoH Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|Yes
|----
||inno1 calls inno2. inno1 transfers to testphone.
|Yes
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|Yes
|Yes
|}

=== Blind Transfer ===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls inno2. inno1 transfers to testphone.
|Yes
|----
|inno1 calls testphone. inno1 transfers to inno2.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|----
|testphone calls inno1. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|}

=== Blind Transfer (alerting only)===

{| border="1"
!Tested feature
!Voice Ok?
|----
|inno1 calls inno2. inno2 transfers to testphone.
|Yes
|----
|inno1 calls testphone. testphone transfers to inno2.
|N/A, device does only transfer with consultation
|----
|testphone calls inno1. inno1 transfers to inno2.
|Yes
|}

=== Broadcast Group & Waiting Queue ===

{| border="1"
!Tested feature
!Result
|----
|testphone makes call to a Broadcast Group. inno1 picks up.
|Yes
|----
|inno1 makes call to a Broadcast Group. testphone picks up.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up before announcement is played.
|Yes
|----
|testphone makes call to a Waiting Queue. inno1 picks up after announcement is played.
|Yes
|----
|inno1 makes call to a Waiting Queue. testphone picks up.
|Yes
|}

=== DTMF Features ===

{| border="1"
!Tested feature
!Result
|----
|CFU Activate/Deactivate
|Ok
|----
|CFB Activate/Deactivate
|Ok
|----
|CFNR Activate/Deactivate
|Ok
|----
|Pickup Group
|Ok
|----
|Pickup Directed
|Ok
|----
|Park/Unpark
|Ok
|----
|Park To/Unpark From
|Ok
|----
|Call Completion Busy
|Nok, Gigaset rejects incoming call for starting CCBS/CCNR
|----
|Call Completion Cancel
|Not tested, since CCBS/CCNR does not work
|----
|Join Group/Leave Group
|Ok
|----
|Join All Groups/Leave All Groups
|Ok
|----
|Enable mobility/Disable mobility
|Not tested, feature is invoked by mobile phone
|----
|Enable mobility cw/Disable mobility cw
|Not tested, feature is invoked by mobile phone
|----
|Set presence
|Ok
|}

==Other Features==

===Directory===

{| border="1"
!Tested feature
!Result
|----
|Device built-in directory
|----
|Exists
|Yes
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

*It is possible to configure a connection to an online source like DE - Klicktel. Please take a look into the manual or configuration.
*It is possible to import and export the local Phonebook.
*You can add the call to the local phonebook from the call-list.

{| border="1"
!Tested feature
!Result
|----
|External LDAP Server supported
|Yes, tested with Estos Metadir. PBX not supported as external LDAP server and LDAPS not supported.
|----
|Can be dialled from
|Yes
|----
|Does CLI resolution
|Yes
|----
|display update if directory object is used?
|Yes
|}

===Keys===

{| border="1"
!Tested feature
!Result
|----
|Device has speed dial keys
|Yes, depending on handset
|----
|Device has programmable function keys
|Yes, depending on handset
|----
|Device has partner keys
|No
|}

===CTI Features (with SOAP / TAPI / myPBX) ===

{| border="1"
!Tested feature
!Result
|----
|User Call - outgoing call
|Ok
|----
|User Connect - Answer incoming call
|Ok
|----
|User Reject - Reject alerting call
|Ok
|----
|User Disconnect - Disconnect active call
|Ok
|----
|User Hold - Put connected call on hold
|Ok
|----
|User Hold Retrieve - Retrieve call on hold
|Ok
|----
|User Transfer - Transfer with Consult
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Transfer with Consult (Alerting only)
|Nok(myPBX), Ok(Tapi/Soap)
|----
|User Transfer - Blind Transfer
|Ok, Ok(Tapi/Soap)
|----
|3PTY - Make 3rd Party Call
|Nok(myPBX), Nok(Tapi/Soap)
|----
|Connected Number Update on Display
|No
|}

* tested with myPBX and TSP(8150)only

== Configuration ==

=== innovaphone configuration ===
Add a new PBX object of type "user": 
[[Image:Siemens Gigaset N510IP PRO - PBX_Userobject.png]]

=== 3rd party product configuration ===

====IP Configuration====

First you have to configure the general ''IP Configuration'' for the base-station.

* IP Address
* Subnet Mask
* Default Gateway
* DNS

[[Image:Siemens Gigaset N510IP PRO - Gigaset_IP_Configuration_ENG.png]]

====Telephony Connection====

In the next step you have to create a registration from the DECT/IP base-station to the PBX. Go to ''Telephony->Connections'' and ''edit'' the first entry.

Click on ''Select Provider'' and choose your country and ''innovaphonePBX''. This will ensure that all settings are configured correctly.

The device still needs the IP address of the PBX to register at and the name of the user for whom the registration shall be made. Click on ''Show advanced settings'' in order to enter as ''Domain'' name the IP address of your innovaphone PBX.

Please note that the registration credentials configured at the Gigaset phone use the ''number'' of the corresponding PBX object, not its name. Registration by using the name is also possible, but will result in CGPN display problems when making calls from the Gigaset phone to a mobility enabled user.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Telefonie_Connection_ENG.png]]

====Number Assignment====

If you have more than one DECT handset registered to your base-station, you can use the ''Telephony->Number Assignment'' menu to assign a DECT handset to a specific PBX registration.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Number_Assignment.png]]

To work with CTI clients like myPBX we need to configure the Call Manager with the handset that should handle this CTI calls and the mode (headset/handsfree).

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Call_Manager.png]]

====Voicemail====
To get the current voicemail status displayed on your DECT handset, you have to enter the corresponding innovaphone voicemail number in the ''Telephony->Network Mailbox'' menu.
[[Image:Siemens Gigaset N510IP PRO - Gigaset_VM_ENG.png]]

====Phone Directory - Adress Book====

You can import/export and save the local phonebook. Have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_Phone_Directory_ENG.png]]

====Enhanced VoIP Settings====

If the device is used in a hosted setup, make sure that the following settings are configured:
* Automatic Negotiation of DTMF transmission: '''Yes'''
* Find target addr. automatically: '''Yes'''

At last you can configure some enhanced VoIP Settings like the handling of the "R" button. For more information have a look at the configuration description in the Gigaset manual.

[[Image:Siemens Gigaset N510IP PRO - Gigaset_advanced_VoIP_Settings_ENG.png]]

=== Known problems ===

==== innovaphone PBX Version 12 ====

With the upcomming version 12 from innovaphone AG we have implemented the security feature [https://tools.ietf.org/html/rfc3261#section-22.4 SIP digest authentication] . If the client did not support this feature the PBX will reject the registration.
With the N510 Firmware 42.240, November 2016 and later this problem is fixed on Gigaset side.

There is a config option to avoid this if you use a older firmware. '''But it is not recommended to disable this feature. It's a security feature.'''

http://ip-of-pbx/!config change SIP /disable-digest-replay-check
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

==== MoH ====
Customer reported that even when choosing as Providerprofile ''innovaphonePBX'', MoH was not audible when a call was put on hold by the Gigaset device. The reason for this is that the Gigaset signals the hold using a "sendonly" instead of an "inactive" SDP-attribute.
To fix this error, you can configure the innovaphone PBX to ignore the wrong hold-signaling:

http://ip-of-pbx/!config add SIP /take-sendonly-as-inactive
http://ip-of-pbx/!config write
http://ip-of-pbx/!config activate

Please keep in mind that this option will affect all SIP/UDP communication. So if you have for example another 3rd party SIP-device, which wants to play its own MOH - it will not work anymore.

==== Usernames with whitespace ====
Customer reported that when registering a Gigaset-device at an object-name with whitespace (e.g. John Doe), because of a bug on the Gigaset SIP-stack ut will not be possible to put a remote device on hold. As a workaround, don't remove the whitespace from the object-name (e.g. JohnDoe).

[[Category:Compat|{{PAGENAME}}]]

Reference11r1:DHCP client

2015-09-21T09:23:13Z

Aschild: Typo in option 220

innovaphone devices include a DHCP client which allows the IP interface to be configured from a DHCP server.

In addition to that, telephone devices allow configuring a number of settings via special DHCP vendor options.

Here is how the DHCP client works.

==Applies To==

This information applies to

* All innovaphone devices,

V11r1 and later

==More Information==

===Problem Details===

The innovaphone devices do support auto configuration via standard DHCP options.

They additionally support some innovaphone vendor specific options to effect some VoIP specific configuration.

Some of them are generic; some of them are specific to phone devices.

===System Requirements===

To use vendor specific DHCP options, a DHCP server that supports such options is required.

Most popular DHCP server implementations such as the Microsoft Windows DHCP service and the Linux dhcpd do so.

===Configuration===

For the DHCP server to support vendor specific options, the options must be made known to the server.

Consult the accompanying documentation which comes with your DHCP server implementation how to do this.

==== Supported Options ====

{| border=1
|+
| Name || Data type || Array || Code || Meaning || How to code
|-
| H323 gatekeeper || IP address || Yes || 200 || Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible
|
This is an array of IP addresses. Put the primary gatekeepers IP into the first entry, the alternate gatekeepers IP into the second entry. Further entries are ignored.
|-
| H323 gatekeeper id || String || No || 201 || The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery
|
Type the gatekeeper id as configured in the gateway or PBX configuration into the string field.
|-
| POSIX TZ<ref name=blabber>This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.</ref> || String || No || 202 || Defines both the time zone and the daylight saving time information.
|
Enter the correct TZ string into the string field as you would configure it in the devices configuration applet. See chapter 9.1.3 of the VoIP Gateways Version 5 manual.

This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.
|-
| Default coder || String || No || 203 || Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD.
|
This string option must contain the value of the “/coder” option in the phone configuration file, e.g. '''G729A,40,esx'''. After a “/” the value of the “/lcoder” option can be added to this string (since V6.00 sr1-hotfix3). '''G729A,60/G711A,30''' for example defines G729A as the general coder and G711A as the coder to be used in networks considered local. Additional options are: e - Exclusive, s - Silence Compression, x0 - AES128/32, x1 - AES128/80, x2 - AES192/32, x3 - AES192/80, x4 - AES256/32, x5 - AES256/80, k0 - SDES-DTLS, k1 - DTLS-SDES, k2 - SDES, k3 - DTLS, k4 - no encryption, n - No DTMF Detection.
If the x and k options are not set the default (SDES-DTLS and AES128/32) is used.

In addition to the preference for the general coder, the preference for the local network coder can be specified here (since V6.00 SR1-hotfix3). G729A,60/G711A,30 for example defines G729A as the general coder and G711A as the local network coder.

Since V9-hotfix2 it's possible to define a list of potentially used coders.
Single entries as described above can be combined and are separated by a semicolon ';'.

This may lead to a string like:

<code>G729A,60,x;G723-53,60,x/G722,30;G711A,30</code>.

This kind of setting can be used as well for the general (remote) as for the local coder.
The list entries will be negotiated from left to right, the first coder which fits to the phone will be used.

In case of an empty list or no match, the default remote or local coder will be used, combined with the flags set in the last entry in list (if any).
Default remote coder is always G729, default local coder is the best one for the specific phone (G.722 for IP222/232/241; G.711A for older models), with no further preferences set (no SRTP, no DTMF).

|-
| Language || String || No || 204 || Defines the user interface language
|
This string must contain the value of the '''/lang''' option in the phone configuration file, e.g. '''eng'''
|-
| Location || String || No || 205 || Defines the various PBX access numbers (country code etc.) for the device.
|
This string must contain the '''/cc''' (Country Code), '''/ac''' (Area Code), '''/ntp''' (National Prefix), '''/itp''' (International Prefix), '''/col''' (Trunk Line Prefix) and '''/pbx''' (PBX Subscriber Number or comma separated MSN Numbers) parameters for dialing location configuration. Optional value is '''/len''' to set the maximum internal number length. Example: '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 73009 /len 3'''. Although, to save bytes, you may omit the slashes ('''/''').
|-
| VLAN ID || Word (16bit) || No || 206 || The 802.1q VLAN ID for traffic sent and received by the device
|
Enter the numerical ID into the 16bit edit field
|-
| VLAN Priority || Byte (8bit) || No || 207 || The 802.1p VLAN priority for traffic sent by the device
|
Enter the numerical priority into the 8bit edit field
|-
| TOS Bits || String || No || 208 || The values for the IP TOS/DSCP field in the IP header of UDP-RTP and TCP-signalling packets sent by the device (Bit 0..2 'precedence', bit 3..6 'type of service')
|
Enter the comma separated numerical priorities into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers). The default for RTP packets is 0xb8 (RFC 3246 - Expedited Forwarding), for signalling packets it is 0x68 (RFC 3246 - Assured Forwarding). 0xb8,0x68 for example defines the default values
|-
| Enbloc dialling || Byte (8bit) || No || 209 || The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper
|
Enter the number of seconds into the 8bit edit field. A value of '''0''' indicates that en-bloc dialling is turned off and digits are sent to the gatekeeper as they are dialled
|-
| Dialtone type || Byte (8bit) || No || 210 || The type of dialtone to generate locally
|
Enter the numeric dialtone type ('''0''' - EUROPE-PBX, '''1''' - EUROPE-PUBLIC, '''2''' - US, '''3''' - UK, '''10''' - ITALY-PBX, '''4''' - ITALY-PUBLIC, '''5''' - CZECH-PBX, '''6''' - CZECH-PUBLIC, '''7''' - SWEDEN, '''8''' - FRANCE, '''9''' - SWISS, '''11''' - BELGIUM, '''12''' - NETHERLANDS, '''13''' - NORWAY, '''14''' - DENMARK, '''15''' - GERMANY, '''16''' - SPAIN, '''17''' - FINLAND, '''18''' - AUSTRIA, '''19''' - IRELAND, '''20''' - AUSTRALIA, '''21''' - NEWZEALAND, '''22''' - MALAYSIA, '''23''' - TURKEY, '''24''' - RUSSIA, '''25''' - SOUTH AFRICA, '''26''' - BRAZIL
)
|-
| Faststart || Byte (8bit) || No || 211 || Disable/Enable the H245 faststart procedure
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| H245-Tunnelling || Byte (8bit) || No || 212 || Disable/Enable H245 tunneling
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| Clock type || Byte (8bit) || No || 213 || Define format of date and time display
|
Enter the numeric clock type ('''0''' – ''dd''.''mm''.''yy'' ''hh'':''mm'', 24 hour clock; '''1''' – ''mm''/''dd'' ''hh'':''mm'' ''xm'', 12 hour am/pm clock)
|-
| Static Routes || String || No || 214 || Static routes to be added to the routes already defined in the device configuration
|
The string (max 127 characters) must contain comma separated route definitions in the form '''address:mask:gateway''' where
''address'', ''mask'' and ''gateway'' are expected in dotted decimal notation, ''mask'' (but not the colon) can be left off in a host route
|-
| Update URL || String || No || 215 || URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module
|
Complete URL as in '''<nowiki>http://192.168.0.10/file.txt</nowiki>'''. No symbolic host names are supported
|-
| Update Poll Interval || Word (16bit) || No || 216 || Standard poll interval in minutes. This is identical to the '''/poll''' option parameter of the UP1 module
|
Interval in minutes
|-
| LDAP directory || String || No || 217 || Defines the various Parameters required to access an LDAP directory
| Following parameters can be provided '''-addr''' (LDAP Server Address), '''-port''' (LDAP Port), '''-base''' (Search Base), '''-attr''' (Name Attributes), '''-phone''' (Number Attruibutes), '''-sort1st''' (Sort Results by 1st LDAP name attribute), '''-hold''' (Hold Server Connection), '''-mode''' (Mode), '''-dn''' (Username) '''-pw''' (Password), '''-obj''' (LDAP Object Filter).
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
The string (max. 253 characters) must contain a list of networks in form of comma separated '''address:mask''' pairs, for example '''192.168.1.0:255.255.255.0,192.168.2.0:255.255.255.0'''.
|-
| STUN Server<ref name=blubber>Support for domain names may not be available in V11r1 already but will be added later.</ref> || String || No || 219 || Defines the IP addresses or domain names of STUN servers.
|
The string (max 127 characters) must contain comma separated STUN server addresses in the form '''address:port''' or '''domain:port''' where
''address'' is expected in dotted decimal notation and ''port'' as decimal number. ''port'' (and the preceeding colon) can be left off, in this case the default port is used.
|-
| VoIP Protocol || String || No || 220 || The VoIP Protocol to be used for the Primary Registration (User-1) of a VoIP telephone.
|
One of the following strings may be specified here: H.323, H.323/TCP, H.323/TLS, SIP/UDP, SIP/TCP, SIP/TLS.
|}

<references/>

==== Windows Server DHCP ====
In this section, the installation of innovaphone vendor options is demonstrated using a Microsoft Windows 2000 DHCP server.

First you need to create a new vendor class.

Use the ''Define Vendor Class…'' / ''Herstellerklasse definieren'' menu entry on the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp1_conv.JPG‎]]

Add a new vendor class as follows:

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp2_conv.JPG‎]]

{|
| Anzeigename / Display name || innovaphone
|-
| Beschreibung / Description || innovaphone VoIP Options
|-
| Kennung / ID || (ASCII) 1.3.6.1.4.1.6666
|}

Add the innovaphone options. Use the ''Configure predefined options'' / ''Vordefinierte Optionen einstellen'' entry in the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp3_conv.JPG‎]]

Select the innovaphone option class and add the innovaphone specific options according to the table above.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp4_conv.JPG‎]]

To configure innovaphone vendor specific options for a specific scope, use the ''Configure options'' / ''Optionen konfigurieren'' entry in the scopes context menu.

[[Image:DHow_to_use_the_innovaphone_DHCP_client_hcp5_conv.JPG‎]]

Select innovaphone in the Advanced / Erweitert tab sheet.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp7_conv.JPG‎ ]]

Tick the options you want to provide and edit the respective values.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp6_conv.JPG‎ ]]

To do the above automatically, just save the following code as innovaphone_dhcp.cmd and execute it at your DHCP Server.

[[Media:Innovaphone_dhcp_option.zip]]

<code powershell>
netsh Dhcp Server Add Class "innovaphone" "innovaphone VoIP Options" 312e332e362e312e342e312e36363636 1 b
netsh Dhcp Server Add Optiondef 200 "H323 gatekeeper" IPADDRESS 1 vendor="innovaphone" comment="Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible" 0.0.0.0
netsh Dhcp Server Add Optiondef 201 "H323 gatekeeper id" STRING 0 vendor="innovaphone" comment="The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery" ""
netsh Dhcp Server Add Optiondef 202 "POSIX TZ" STRING 0 vendor="innovaphone" comment="Defines both the time zone and the daylight saving time information." ""
netsh Dhcp Server Add Optiondef 203 "Default coder" STRING 0 vendor="innovaphone" comment="Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD" ""
netsh Dhcp Server Add Optiondef 204 "Language" STRING 0 vendor="innovaphone" comment="Defines the user interface language" ""
netsh Dhcp Server Add Optiondef 205 "Location" STRING 0 vendor="innovaphone" comment="Defines the various PBX access numbers (country code etc.) for the device" ""
netsh Dhcp Server Add Optiondef 206 "VLAN ID" WORD 0 vendor="innovaphone" comment="The 802.1q VLAN ID for traffic sent and received by the device" 0
netsh Dhcp Server Add Optiondef 207 "VLAN Priority" BYTE 0 vendor="innovaphone" comment="The 802.1p VLAN priority for traffic sent by the device" 0
netsh Dhcp Server Add Optiondef 208 "TOS Bits" STRING 0 vendor="innovaphone" comment="The value for the IP TOS field in the IP header of voice traffic sent by the device" ""
netsh Dhcp Server Add Optiondef 209 "Enbloc dialling" BYTE 0 vendor="innovaphone" comment="The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper" 0
netsh Dhcp Server Add Optiondef 210 "Dialtone type" BYTE 0 vendor="innovaphone" comment="The type of dialtone to generate locally" 0
netsh Dhcp Server Add Optiondef 211 "Faststart" BYTE 0 vendor="innovaphone" comment="Disable/Enable the H245 faststart procedure" 0
netsh Dhcp Server Add Optiondef 212 "H245-Tunnelling" BYTE 0 vendor="innovaphone" comment="Disable/Enable H245 tunneling" 0
netsh Dhcp Server Add Optiondef 213 "Clock type" BYTE 0 vendor="innovaphone" comment="Define format of date and time display" 0
netsh Dhcp Server Add Optiondef 214 "Static Routes" STRING 0 vendor="innovaphone" comment="Static routes to be added to the routes already defined in the device configuration" ""
netsh Dhcp Server Add Optiondef 215 "Update URL" STRING 0 vendor="innovaphone" comment="URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module" ""
netsh Dhcp Server Add Optiondef 216 "Update Poll Interval" WORD 0 vendor="innovaphone" comment="Standard poll interval in minutes. This is identical to the /poll option parameter of the UP1 module" 0
netsh Dhcp Server Add Optiondef 217 "LDAP directory" STRING 0 vendor="innovaphone" comment="Defines the various Parameters required to access an LDAP directory" ""
netsh Dhcp Server Add Optiondef 218 "Local Networks" STRING 0 vendor="innovaphone" comment="Defines the networks to be considered local in coder negotiation" ""
netsh Dhcp Server Add Optiondef 219 "STUN Server" STRING 0 vendor="innovaphone" comment="Defines the IP addresses or domain names of STUN servers" ""
netsh Dhcp Server Add Optiondef 220 "VOIP Protocol" STRING 0 vendor="innovaphone" comment="The VoIP Protocol to be used for the Primary Registration (User-1) of a VoIP telephone" ""
</code>

====ISC DHCP Server for Linux====
The ISC DHCP Server is a standard DHCP daemon on many Linux distributions. Here is a sample configuration that provides vendor specific options for innovaphone devices:

<code bash>
option space innovaphone;
option innovaphone.h323-gatekeeper code 200 = array of ip-address;
option innovaphone.h323-gatekeeper-id code 201 = text;
option innovaphone.posix-tz code 202 = text;
option innovaphone.default-coder code 203 = text;
option innovaphone.language code 204 = text;
option innovaphone.location code 205 = text;
option innovaphone.vlan-id code 206 = unsigned integer 16;
option innovaphone.vlan-prio code 207 = unsigned integer 8;
option innovaphone.tos-bits code 208 = text;
option innovaphone.enbloc-dialing code 209 = unsigned integer 8;
option innovaphone.dialtone-type code 210 = unsigned integer 8;
option innovaphone.faststart code 211 = unsigned integer 8;
option innovaphone.h245-tunneling code 212 = unsigned integer 8;
option innovaphone.clock-type code 213 = unsigned integer 8;
option innovaphone.static-routes code 214 = text;
option innovaphone.update-url code 215 = text;
option innovaphone.update-poll-interval code 216 = unsigned integer 16;
option innovaphone.ldap-directory code 217 = text;
option innovaphone.local-networks code 218 = text;
option innovaphone.stun-server code 219 = text;
option innovaphone.voip-protocol code 220 = text;

class "innovaphone" {
match if option vendor-class-identifier = "1.3.6.1.4.1.6666";
}

pool {
#
# Options for phones
#
allow members of "innovaphone";
range 172.21.49.1 172.21.49.127;
vendor-option-space innovaphone;
option innovaphone.h323-gatekeeper 172.21.48.5;
option innovaphone.posix-tz "CET-1CEST-2,M3.5.0/2,M10.5.0/3";
option innovaphone.default-coder "G729,60,e";
option innovaphone.language "deu";
option innovaphone.vlan-id 0x10;
option innovaphone.tos-bits "0x10";
option innovaphone.update-url "http://172.16.100.200/v6/cmds.txt";
option innovaphone.update-poll-interval 0x168;
option innovaphone.ldap-directory "-addr 172.21.48.1 -port 712 -base dc=meta \
-attr sn,givenName,company -phone telephoneNumber:D,homePhone:P,mobile:M,:@ -mail mail";
}
</code>

If you are using ISC-DHCP on IPxx10 linux application plateform you will need to add these line on your dhcpd.conf file.
<code bash>
host selfmac {
#
# Find the mac address of your IPxx10Linux AP with ifconfig command
# And replace the following mac with yours to prevent ISC dhcp offer at itself
# If you do not, you will loose your Application platform
#
hardware ethernet 86:be:09:65:d3:53 ;
deny booting ;
}
</code>

===Determining LDAP options===
To determine a proper configuration for DHCP option configuring a phone, you best proceed as described in [[{{NAMESPACE}}:Phone/State/DHCP-Options]].

Please note that myPBX will not evaluate the DHCP option 217 (LDAP) vendor option. It is thus recommended to deploy the directory settings as part of the users ''Phone'' config entry (''Directories''). Setting it with DHCP vendor options may thus be considered deprecated!

===Disabling the DHCP client===
In certain circumstances, it is convenient to partly disable the DHCP client. This way, the device still gets its IP address from the DHCP server, however, additional settings possibly supplied by the DHCP server are ignored. This is especially useful if in a given setup, some devices are to be configured differently but the majority is still configured by DHCP.

This can be achieved using the following config file options

{|
|'''config change UP1 /no-dhcp'''
|the update server uses the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "Update URL [215]" and "Update Poll Interval [216]" are ignored).
|-
|'''config change DHCPn /no-vlan'''
|the VLAN settings use the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "VLAN ID [206]" and "VLAN Priority [207]" are ignored)...
|-
|'''config change DHCPn /no-vendor'''
|all innovaphone vendor options are ignored.
|}

===Known Problems with lengthy options===
The minimum space available for options in a BOOTP/DHCP record is 312 byte. There are some extension mechanisms but only a few DHCP servers support it. The Windows 2000 DHCP server for example does not, but silently truncates options not fitting in this 312 byte space. Thus it’s nearly impossible to distribute the LDAP directory configuration with a Windows 2000 server but it’s no problem with the DHCP Server built into each innovaphone device.

===Known Problems with VLAN Configurations===
The handling of the 802.1q VLAN ID is a bit tricky. If not hard configured otherwise, the IP200 will request a DHCP lease using the Ethernet switch ports default VLAN ID (that is, it will not send any VLAN header). It will thus receive a DHCP offer dedicated to devices on that VLAN. If this offer includes a VLAN ID option, the IP200 will not accept the offered lease, set the VLAN ID to the value received in the otherwise disregarded offer and start the DHCP process all over again. Now, the DHCP request will be issued on a new VLAN ID. Therefore, the DHCP server will now send an offer dedicated for devices on that new VLAN. This will most probably be a different DHCP scope.

As a consequence, DHCP options of IP200’s on a non-default VLAN must be configured twice. The VLAN ID option itself must be configured in the default VLANs DHCP scope. All other options must be configured in the new VLANs DHCP scope.

Be sure to configure the VLAN in both scopes identically. If not, the DHCP client process will never terminate, since it will always detect a changed VLAN ID, set the VLAN ID and restart the DHCP process.

Here is how DHCP leases are handled in detail:

*First Boot
The client will broadcast a DHCP DISCOVER, expecting an OFFER from the server including all requested parameters. If the client intends to use the offered lease, it will issue a request for the offered lease. Once it receives an ACK for the lease requested, it will configure itself accordingly. All lease information is stored in the devices config file using the /laddr option (unless suppressed using /no-keep).

*Re-boot
If there is lease information (in the /laddr config file option), the client will broadcast requests for the same lease again. If there is no answer within 30 seconds, the device will configure itself using the parameters in /laddr. It will nevertheless continue to request this lease from the DHCP server again (every 30 seconds, a broadcast will be sent).

If the server acknowledges the old lease, the client will check for changes in the DHCP options and re-configure itself accordingly. Changed options will be saved in the config file.

If the server rejects the lease using a NAK, the client will forget about the lease and continue to operate like it does for the first boot.

*First boot with VLAN ID option received

If an offered lease includes the VLAN-ID option and the ID proposed differs from the VLAN ID the devices currently operates with (that is, from the id configured in the devices configuration), the device will change its VLAN ID to the one received in the VLAN-ID option. It will not request the lease though. Instead, it will continue to send DISCOVER requests on the new VLAN ID. If a lease is obtained there, all lease information is stored in the config file as usual.

You can disable the VLAN-ID processing using the '''/no-vlan''' option.

*Reboot with VLAN ID

If the device finds lease information in the config file at boot time and if there is a VLAN ID different from the devices current VLAN-ID, it will re-configure itself to the new VLAN ID and try to request the saved lease as usual. If the lease is rejected with a NAK by the server, the device will re-configure itself to the pre-configured VLAN ID and try to DISCOVER a new lease as usual.

====VLAN set with LLDP====

From version 10, VLAN is also set with LLDP if provided by the switch, see [[Reference10:Interfaces/ETH/VLAN]].

===Changing configuration options set by DHCP options===

If a device has been configured by DHCP, you cannot change those parameters. Any attempt to do so will issue a “Reset required” message.

Reference11r1:DHCP client

2015-09-21T09:22:43Z

Aschild: Added netsh code for options 219 and 220

innovaphone devices include a DHCP client which allows the IP interface to be configured from a DHCP server.

In addition to that, telephone devices allow configuring a number of settings via special DHCP vendor options.

Here is how the DHCP client works.

==Applies To==

This information applies to

* All innovaphone devices,

V11r1 and later

==More Information==

===Problem Details===

The innovaphone devices do support auto configuration via standard DHCP options.

They additionally support some innovaphone vendor specific options to effect some VoIP specific configuration.

Some of them are generic; some of them are specific to phone devices.

===System Requirements===

To use vendor specific DHCP options, a DHCP server that supports such options is required.

Most popular DHCP server implementations such as the Microsoft Windows DHCP service and the Linux dhcpd do so.

===Configuration===

For the DHCP server to support vendor specific options, the options must be made known to the server.

Consult the accompanying documentation which comes with your DHCP server implementation how to do this.

==== Supported Options ====

{| border=1
|+
| Name || Data type || Array || Code || Meaning || How to code
|-
| H323 gatekeeper || IP address || Yes || 200 || Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible
|
This is an array of IP addresses. Put the primary gatekeepers IP into the first entry, the alternate gatekeepers IP into the second entry. Further entries are ignored.
|-
| H323 gatekeeper id || String || No || 201 || The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery
|
Type the gatekeeper id as configured in the gateway or PBX configuration into the string field.
|-
| POSIX TZ<ref name=blabber>This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.</ref> || String || No || 202 || Defines both the time zone and the daylight saving time information.
|
Enter the correct TZ string into the string field as you would configure it in the devices configuration applet. See chapter 9.1.3 of the VoIP Gateways Version 5 manual.

This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.
|-
| Default coder || String || No || 203 || Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD.
|
This string option must contain the value of the “/coder” option in the phone configuration file, e.g. '''G729A,40,esx'''. After a “/” the value of the “/lcoder” option can be added to this string (since V6.00 sr1-hotfix3). '''G729A,60/G711A,30''' for example defines G729A as the general coder and G711A as the coder to be used in networks considered local. Additional options are: e - Exclusive, s - Silence Compression, x0 - AES128/32, x1 - AES128/80, x2 - AES192/32, x3 - AES192/80, x4 - AES256/32, x5 - AES256/80, k0 - SDES-DTLS, k1 - DTLS-SDES, k2 - SDES, k3 - DTLS, k4 - no encryption, n - No DTMF Detection.
If the x and k options are not set the default (SDES-DTLS and AES128/32) is used.

In addition to the preference for the general coder, the preference for the local network coder can be specified here (since V6.00 SR1-hotfix3). G729A,60/G711A,30 for example defines G729A as the general coder and G711A as the local network coder.

Since V9-hotfix2 it's possible to define a list of potentially used coders.
Single entries as described above can be combined and are separated by a semicolon ';'.

This may lead to a string like:

<code>G729A,60,x;G723-53,60,x/G722,30;G711A,30</code>.

This kind of setting can be used as well for the general (remote) as for the local coder.
The list entries will be negotiated from left to right, the first coder which fits to the phone will be used.

In case of an empty list or no match, the default remote or local coder will be used, combined with the flags set in the last entry in list (if any).
Default remote coder is always G729, default local coder is the best one for the specific phone (G.722 for IP222/232/241; G.711A for older models), with no further preferences set (no SRTP, no DTMF).

|-
| Language || String || No || 204 || Defines the user interface language
|
This string must contain the value of the '''/lang''' option in the phone configuration file, e.g. '''eng'''
|-
| Location || String || No || 205 || Defines the various PBX access numbers (country code etc.) for the device.
|
This string must contain the '''/cc''' (Country Code), '''/ac''' (Area Code), '''/ntp''' (National Prefix), '''/itp''' (International Prefix), '''/col''' (Trunk Line Prefix) and '''/pbx''' (PBX Subscriber Number or comma separated MSN Numbers) parameters for dialing location configuration. Optional value is '''/len''' to set the maximum internal number length. Example: '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 73009 /len 3'''. Although, to save bytes, you may omit the slashes ('''/''').
|-
| VLAN ID || Word (16bit) || No || 206 || The 802.1q VLAN ID for traffic sent and received by the device
|
Enter the numerical ID into the 16bit edit field
|-
| VLAN Priority || Byte (8bit) || No || 207 || The 802.1p VLAN priority for traffic sent by the device
|
Enter the numerical priority into the 8bit edit field
|-
| TOS Bits || String || No || 208 || The values for the IP TOS/DSCP field in the IP header of UDP-RTP and TCP-signalling packets sent by the device (Bit 0..2 'precedence', bit 3..6 'type of service')
|
Enter the comma separated numerical priorities into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers). The default for RTP packets is 0xb8 (RFC 3246 - Expedited Forwarding), for signalling packets it is 0x68 (RFC 3246 - Assured Forwarding). 0xb8,0x68 for example defines the default values
|-
| Enbloc dialling || Byte (8bit) || No || 209 || The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper
|
Enter the number of seconds into the 8bit edit field. A value of '''0''' indicates that en-bloc dialling is turned off and digits are sent to the gatekeeper as they are dialled
|-
| Dialtone type || Byte (8bit) || No || 210 || The type of dialtone to generate locally
|
Enter the numeric dialtone type ('''0''' - EUROPE-PBX, '''1''' - EUROPE-PUBLIC, '''2''' - US, '''3''' - UK, '''10''' - ITALY-PBX, '''4''' - ITALY-PUBLIC, '''5''' - CZECH-PBX, '''6''' - CZECH-PUBLIC, '''7''' - SWEDEN, '''8''' - FRANCE, '''9''' - SWISS, '''11''' - BELGIUM, '''12''' - NETHERLANDS, '''13''' - NORWAY, '''14''' - DENMARK, '''15''' - GERMANY, '''16''' - SPAIN, '''17''' - FINLAND, '''18''' - AUSTRIA, '''19''' - IRELAND, '''20''' - AUSTRALIA, '''21''' - NEWZEALAND, '''22''' - MALAYSIA, '''23''' - TURKEY, '''24''' - RUSSIA, '''25''' - SOUTH AFRICA, '''26''' - BRAZIL
)
|-
| Faststart || Byte (8bit) || No || 211 || Disable/Enable the H245 faststart procedure
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| H245-Tunnelling || Byte (8bit) || No || 212 || Disable/Enable H245 tunneling
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| Clock type || Byte (8bit) || No || 213 || Define format of date and time display
|
Enter the numeric clock type ('''0''' – ''dd''.''mm''.''yy'' ''hh'':''mm'', 24 hour clock; '''1''' – ''mm''/''dd'' ''hh'':''mm'' ''xm'', 12 hour am/pm clock)
|-
| Static Routes || String || No || 214 || Static routes to be added to the routes already defined in the device configuration
|
The string (max 127 characters) must contain comma separated route definitions in the form '''address:mask:gateway''' where
''address'', ''mask'' and ''gateway'' are expected in dotted decimal notation, ''mask'' (but not the colon) can be left off in a host route
|-
| Update URL || String || No || 215 || URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module
|
Complete URL as in '''<nowiki>http://192.168.0.10/file.txt</nowiki>'''. No symbolic host names are supported
|-
| Update Poll Interval || Word (16bit) || No || 216 || Standard poll interval in minutes. This is identical to the '''/poll''' option parameter of the UP1 module
|
Interval in minutes
|-
| LDAP directory || String || No || 217 || Defines the various Parameters required to access an LDAP directory
| Following parameters can be provided '''-addr''' (LDAP Server Address), '''-port''' (LDAP Port), '''-base''' (Search Base), '''-attr''' (Name Attributes), '''-phone''' (Number Attruibutes), '''-sort1st''' (Sort Results by 1st LDAP name attribute), '''-hold''' (Hold Server Connection), '''-mode''' (Mode), '''-dn''' (Username) '''-pw''' (Password), '''-obj''' (LDAP Object Filter).
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
The string (max. 253 characters) must contain a list of networks in form of comma separated '''address:mask''' pairs, for example '''192.168.1.0:255.255.255.0,192.168.2.0:255.255.255.0'''.
|-
| STUN Server<ref name=blubber>Support for domain names may not be available in V11r1 already but will be added later.</ref> || String || No || 219 || Defines the IP addresses or domain names of STUN servers.
|
The string (max 127 characters) must contain comma separated STUN server addresses in the form '''address:port''' or '''domain:port''' where
''address'' is expected in dotted decimal notation and ''port'' as decimal number. ''port'' (and the preceeding colon) can be left off, in this case the default port is used.
|-
| VoIP Protocol || String || No || 220 || The VoIP Protocl to be used for the Primary Registration (User-1) of a VoIP telephone.
|
One of the following strings may be specified here: H.323, H.323/TCP, H.323/TLS, SIP/UDP, SIP/TCP, SIP/TLS.
|}

<references/>

==== Windows Server DHCP ====
In this section, the installation of innovaphone vendor options is demonstrated using a Microsoft Windows 2000 DHCP server.

First you need to create a new vendor class.

Use the ''Define Vendor Class…'' / ''Herstellerklasse definieren'' menu entry on the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp1_conv.JPG‎]]

Add a new vendor class as follows:

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp2_conv.JPG‎]]

{|
| Anzeigename / Display name || innovaphone
|-
| Beschreibung / Description || innovaphone VoIP Options
|-
| Kennung / ID || (ASCII) 1.3.6.1.4.1.6666
|}

Add the innovaphone options. Use the ''Configure predefined options'' / ''Vordefinierte Optionen einstellen'' entry in the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp3_conv.JPG‎]]

Select the innovaphone option class and add the innovaphone specific options according to the table above.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp4_conv.JPG‎]]

To configure innovaphone vendor specific options for a specific scope, use the ''Configure options'' / ''Optionen konfigurieren'' entry in the scopes context menu.

[[Image:DHow_to_use_the_innovaphone_DHCP_client_hcp5_conv.JPG‎]]

Select innovaphone in the Advanced / Erweitert tab sheet.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp7_conv.JPG‎ ]]

Tick the options you want to provide and edit the respective values.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp6_conv.JPG‎ ]]

To do the above automatically, just save the following code as innovaphone_dhcp.cmd and execute it at your DHCP Server.

[[Media:Innovaphone_dhcp_option.zip]]

<code powershell>
netsh Dhcp Server Add Class "innovaphone" "innovaphone VoIP Options" 312e332e362e312e342e312e36363636 1 b
netsh Dhcp Server Add Optiondef 200 "H323 gatekeeper" IPADDRESS 1 vendor="innovaphone" comment="Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible" 0.0.0.0
netsh Dhcp Server Add Optiondef 201 "H323 gatekeeper id" STRING 0 vendor="innovaphone" comment="The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery" ""
netsh Dhcp Server Add Optiondef 202 "POSIX TZ" STRING 0 vendor="innovaphone" comment="Defines both the time zone and the daylight saving time information." ""
netsh Dhcp Server Add Optiondef 203 "Default coder" STRING 0 vendor="innovaphone" comment="Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD" ""
netsh Dhcp Server Add Optiondef 204 "Language" STRING 0 vendor="innovaphone" comment="Defines the user interface language" ""
netsh Dhcp Server Add Optiondef 205 "Location" STRING 0 vendor="innovaphone" comment="Defines the various PBX access numbers (country code etc.) for the device" ""
netsh Dhcp Server Add Optiondef 206 "VLAN ID" WORD 0 vendor="innovaphone" comment="The 802.1q VLAN ID for traffic sent and received by the device" 0
netsh Dhcp Server Add Optiondef 207 "VLAN Priority" BYTE 0 vendor="innovaphone" comment="The 802.1p VLAN priority for traffic sent by the device" 0
netsh Dhcp Server Add Optiondef 208 "TOS Bits" STRING 0 vendor="innovaphone" comment="The value for the IP TOS field in the IP header of voice traffic sent by the device" ""
netsh Dhcp Server Add Optiondef 209 "Enbloc dialling" BYTE 0 vendor="innovaphone" comment="The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper" 0
netsh Dhcp Server Add Optiondef 210 "Dialtone type" BYTE 0 vendor="innovaphone" comment="The type of dialtone to generate locally" 0
netsh Dhcp Server Add Optiondef 211 "Faststart" BYTE 0 vendor="innovaphone" comment="Disable/Enable the H245 faststart procedure" 0
netsh Dhcp Server Add Optiondef 212 "H245-Tunnelling" BYTE 0 vendor="innovaphone" comment="Disable/Enable H245 tunneling" 0
netsh Dhcp Server Add Optiondef 213 "Clock type" BYTE 0 vendor="innovaphone" comment="Define format of date and time display" 0
netsh Dhcp Server Add Optiondef 214 "Static Routes" STRING 0 vendor="innovaphone" comment="Static routes to be added to the routes already defined in the device configuration" ""
netsh Dhcp Server Add Optiondef 215 "Update URL" STRING 0 vendor="innovaphone" comment="URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module" ""
netsh Dhcp Server Add Optiondef 216 "Update Poll Interval" WORD 0 vendor="innovaphone" comment="Standard poll interval in minutes. This is identical to the /poll option parameter of the UP1 module" 0
netsh Dhcp Server Add Optiondef 217 "LDAP directory" STRING 0 vendor="innovaphone" comment="Defines the various Parameters required to access an LDAP directory" ""
netsh Dhcp Server Add Optiondef 218 "Local Networks" STRING 0 vendor="innovaphone" comment="Defines the networks to be considered local in coder negotiation" ""
netsh Dhcp Server Add Optiondef 219 "STUN Server" STRING 0 vendor="innovaphone" comment="Defines the IP addresses or domain names of STUN servers" ""
netsh Dhcp Server Add Optiondef 220 "VOIP Protocol" STRING 0 vendor="innovaphone" comment="The VoIP Protocol to be used for the Primary Registration (User-1) of a VoIP telephone" ""
</code>

====ISC DHCP Server for Linux====
The ISC DHCP Server is a standard DHCP daemon on many Linux distributions. Here is a sample configuration that provides vendor specific options for innovaphone devices:

<code bash>
option space innovaphone;
option innovaphone.h323-gatekeeper code 200 = array of ip-address;
option innovaphone.h323-gatekeeper-id code 201 = text;
option innovaphone.posix-tz code 202 = text;
option innovaphone.default-coder code 203 = text;
option innovaphone.language code 204 = text;
option innovaphone.location code 205 = text;
option innovaphone.vlan-id code 206 = unsigned integer 16;
option innovaphone.vlan-prio code 207 = unsigned integer 8;
option innovaphone.tos-bits code 208 = text;
option innovaphone.enbloc-dialing code 209 = unsigned integer 8;
option innovaphone.dialtone-type code 210 = unsigned integer 8;
option innovaphone.faststart code 211 = unsigned integer 8;
option innovaphone.h245-tunneling code 212 = unsigned integer 8;
option innovaphone.clock-type code 213 = unsigned integer 8;
option innovaphone.static-routes code 214 = text;
option innovaphone.update-url code 215 = text;
option innovaphone.update-poll-interval code 216 = unsigned integer 16;
option innovaphone.ldap-directory code 217 = text;
option innovaphone.local-networks code 218 = text;
option innovaphone.stun-server code 219 = text;
option innovaphone.voip-protocol code 220 = text;

class "innovaphone" {
match if option vendor-class-identifier = "1.3.6.1.4.1.6666";
}

pool {
#
# Options for phones
#
allow members of "innovaphone";
range 172.21.49.1 172.21.49.127;
vendor-option-space innovaphone;
option innovaphone.h323-gatekeeper 172.21.48.5;
option innovaphone.posix-tz "CET-1CEST-2,M3.5.0/2,M10.5.0/3";
option innovaphone.default-coder "G729,60,e";
option innovaphone.language "deu";
option innovaphone.vlan-id 0x10;
option innovaphone.tos-bits "0x10";
option innovaphone.update-url "http://172.16.100.200/v6/cmds.txt";
option innovaphone.update-poll-interval 0x168;
option innovaphone.ldap-directory "-addr 172.21.48.1 -port 712 -base dc=meta \
-attr sn,givenName,company -phone telephoneNumber:D,homePhone:P,mobile:M,:@ -mail mail";
}
</code>

If you are using ISC-DHCP on IPxx10 linux application plateform you will need to add these line on your dhcpd.conf file.
<code bash>
host selfmac {
#
# Find the mac address of your IPxx10Linux AP with ifconfig command
# And replace the following mac with yours to prevent ISC dhcp offer at itself
# If you do not, you will loose your Application platform
#
hardware ethernet 86:be:09:65:d3:53 ;
deny booting ;
}
</code>

===Determining LDAP options===
To determine a proper configuration for DHCP option configuring a phone, you best proceed as described in [[{{NAMESPACE}}:Phone/State/DHCP-Options]].

Please note that myPBX will not evaluate the DHCP option 217 (LDAP) vendor option. It is thus recommended to deploy the directory settings as part of the users ''Phone'' config entry (''Directories''). Setting it with DHCP vendor options may thus be considered deprecated!

===Disabling the DHCP client===
In certain circumstances, it is convenient to partly disable the DHCP client. This way, the device still gets its IP address from the DHCP server, however, additional settings possibly supplied by the DHCP server are ignored. This is especially useful if in a given setup, some devices are to be configured differently but the majority is still configured by DHCP.

This can be achieved using the following config file options

{|
|'''config change UP1 /no-dhcp'''
|the update server uses the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "Update URL [215]" and "Update Poll Interval [216]" are ignored).
|-
|'''config change DHCPn /no-vlan'''
|the VLAN settings use the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "VLAN ID [206]" and "VLAN Priority [207]" are ignored)...
|-
|'''config change DHCPn /no-vendor'''
|all innovaphone vendor options are ignored.
|}

===Known Problems with lengthy options===
The minimum space available for options in a BOOTP/DHCP record is 312 byte. There are some extension mechanisms but only a few DHCP servers support it. The Windows 2000 DHCP server for example does not, but silently truncates options not fitting in this 312 byte space. Thus it’s nearly impossible to distribute the LDAP directory configuration with a Windows 2000 server but it’s no problem with the DHCP Server built into each innovaphone device.

===Known Problems with VLAN Configurations===
The handling of the 802.1q VLAN ID is a bit tricky. If not hard configured otherwise, the IP200 will request a DHCP lease using the Ethernet switch ports default VLAN ID (that is, it will not send any VLAN header). It will thus receive a DHCP offer dedicated to devices on that VLAN. If this offer includes a VLAN ID option, the IP200 will not accept the offered lease, set the VLAN ID to the value received in the otherwise disregarded offer and start the DHCP process all over again. Now, the DHCP request will be issued on a new VLAN ID. Therefore, the DHCP server will now send an offer dedicated for devices on that new VLAN. This will most probably be a different DHCP scope.

As a consequence, DHCP options of IP200’s on a non-default VLAN must be configured twice. The VLAN ID option itself must be configured in the default VLANs DHCP scope. All other options must be configured in the new VLANs DHCP scope.

Be sure to configure the VLAN in both scopes identically. If not, the DHCP client process will never terminate, since it will always detect a changed VLAN ID, set the VLAN ID and restart the DHCP process.

Here is how DHCP leases are handled in detail:

*First Boot
The client will broadcast a DHCP DISCOVER, expecting an OFFER from the server including all requested parameters. If the client intends to use the offered lease, it will issue a request for the offered lease. Once it receives an ACK for the lease requested, it will configure itself accordingly. All lease information is stored in the devices config file using the /laddr option (unless suppressed using /no-keep).

*Re-boot
If there is lease information (in the /laddr config file option), the client will broadcast requests for the same lease again. If there is no answer within 30 seconds, the device will configure itself using the parameters in /laddr. It will nevertheless continue to request this lease from the DHCP server again (every 30 seconds, a broadcast will be sent).

If the server acknowledges the old lease, the client will check for changes in the DHCP options and re-configure itself accordingly. Changed options will be saved in the config file.

If the server rejects the lease using a NAK, the client will forget about the lease and continue to operate like it does for the first boot.

*First boot with VLAN ID option received

If an offered lease includes the VLAN-ID option and the ID proposed differs from the VLAN ID the devices currently operates with (that is, from the id configured in the devices configuration), the device will change its VLAN ID to the one received in the VLAN-ID option. It will not request the lease though. Instead, it will continue to send DISCOVER requests on the new VLAN ID. If a lease is obtained there, all lease information is stored in the config file as usual.

You can disable the VLAN-ID processing using the '''/no-vlan''' option.

*Reboot with VLAN ID

If the device finds lease information in the config file at boot time and if there is a VLAN ID different from the devices current VLAN-ID, it will re-configure itself to the new VLAN ID and try to request the saved lease as usual. If the lease is rejected with a NAK by the server, the device will re-configure itself to the pre-configured VLAN ID and try to DISCOVER a new lease as usual.

====VLAN set with LLDP====

From version 10, VLAN is also set with LLDP if provided by the switch, see [[Reference10:Interfaces/ETH/VLAN]].

===Changing configuration options set by DHCP options===

If a device has been configured by DHCP, you cannot change those parameters. Any attempt to do so will issue a “Reset required” message.

Reference11r1:DHCP client

2015-09-21T09:20:32Z

Aschild: Added options 219 and 220 for linux config

innovaphone devices include a DHCP client which allows the IP interface to be configured from a DHCP server.

In addition to that, telephone devices allow configuring a number of settings via special DHCP vendor options.

Here is how the DHCP client works.

==Applies To==

This information applies to

* All innovaphone devices,

V11r1 and later

==More Information==

===Problem Details===

The innovaphone devices do support auto configuration via standard DHCP options.

They additionally support some innovaphone vendor specific options to effect some VoIP specific configuration.

Some of them are generic; some of them are specific to phone devices.

===System Requirements===

To use vendor specific DHCP options, a DHCP server that supports such options is required.

Most popular DHCP server implementations such as the Microsoft Windows DHCP service and the Linux dhcpd do so.

===Configuration===

For the DHCP server to support vendor specific options, the options must be made known to the server.

Consult the accompanying documentation which comes with your DHCP server implementation how to do this.

==== Supported Options ====

{| border=1
|+
| Name || Data type || Array || Code || Meaning || How to code
|-
| H323 gatekeeper || IP address || Yes || 200 || Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible
|
This is an array of IP addresses. Put the primary gatekeepers IP into the first entry, the alternate gatekeepers IP into the second entry. Further entries are ignored.
|-
| H323 gatekeeper id || String || No || 201 || The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery
|
Type the gatekeeper id as configured in the gateway or PBX configuration into the string field.
|-
| POSIX TZ<ref name=blabber>This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.</ref> || String || No || 202 || Defines both the time zone and the daylight saving time information.
|
Enter the correct TZ string into the string field as you would configure it in the devices configuration applet. See chapter 9.1.3 of the VoIP Gateways Version 5 manual.

This option is in fact identical to the standard DHCP option number 88 (TZ). However, various DHCP servers do not support this option, so it is provided as a redundant vendor specific option. If your DHCP server supports option 88, the vendor specific option is not needed.
|-
| Default coder || String || No || 203 || Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD.
|
This string option must contain the value of the “/coder” option in the phone configuration file, e.g. '''G729A,40,esx'''. After a “/” the value of the “/lcoder” option can be added to this string (since V6.00 sr1-hotfix3). '''G729A,60/G711A,30''' for example defines G729A as the general coder and G711A as the coder to be used in networks considered local. Additional options are: e - Exclusive, s - Silence Compression, x0 - AES128/32, x1 - AES128/80, x2 - AES192/32, x3 - AES192/80, x4 - AES256/32, x5 - AES256/80, k0 - SDES-DTLS, k1 - DTLS-SDES, k2 - SDES, k3 - DTLS, k4 - no encryption, n - No DTMF Detection.
If the x and k options are not set the default (SDES-DTLS and AES128/32) is used.

In addition to the preference for the general coder, the preference for the local network coder can be specified here (since V6.00 SR1-hotfix3). G729A,60/G711A,30 for example defines G729A as the general coder and G711A as the local network coder.

Since V9-hotfix2 it's possible to define a list of potentially used coders.
Single entries as described above can be combined and are separated by a semicolon ';'.

This may lead to a string like:

<code>G729A,60,x;G723-53,60,x/G722,30;G711A,30</code>.

This kind of setting can be used as well for the general (remote) as for the local coder.
The list entries will be negotiated from left to right, the first coder which fits to the phone will be used.

In case of an empty list or no match, the default remote or local coder will be used, combined with the flags set in the last entry in list (if any).
Default remote coder is always G729, default local coder is the best one for the specific phone (G.722 for IP222/232/241; G.711A for older models), with no further preferences set (no SRTP, no DTMF).

|-
| Language || String || No || 204 || Defines the user interface language
|
This string must contain the value of the '''/lang''' option in the phone configuration file, e.g. '''eng'''
|-
| Location || String || No || 205 || Defines the various PBX access numbers (country code etc.) for the device.
|
This string must contain the '''/cc''' (Country Code), '''/ac''' (Area Code), '''/ntp''' (National Prefix), '''/itp''' (International Prefix), '''/col''' (Trunk Line Prefix) and '''/pbx''' (PBX Subscriber Number or comma separated MSN Numbers) parameters for dialing location configuration. Optional value is '''/len''' to set the maximum internal number length. Example: '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 73009 /len 3'''. Although, to save bytes, you may omit the slashes ('''/''').
|-
| VLAN ID || Word (16bit) || No || 206 || The 802.1q VLAN ID for traffic sent and received by the device
|
Enter the numerical ID into the 16bit edit field
|-
| VLAN Priority || Byte (8bit) || No || 207 || The 802.1p VLAN priority for traffic sent by the device
|
Enter the numerical priority into the 8bit edit field
|-
| TOS Bits || String || No || 208 || The values for the IP TOS/DSCP field in the IP header of UDP-RTP and TCP-signalling packets sent by the device (Bit 0..2 'precedence', bit 3..6 'type of service')
|
Enter the comma separated numerical priorities into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers). The default for RTP packets is 0xb8 (RFC 3246 - Expedited Forwarding), for signalling packets it is 0x68 (RFC 3246 - Assured Forwarding). 0xb8,0x68 for example defines the default values
|-
| Enbloc dialling || Byte (8bit) || No || 209 || The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper
|
Enter the number of seconds into the 8bit edit field. A value of '''0''' indicates that en-bloc dialling is turned off and digits are sent to the gatekeeper as they are dialled
|-
| Dialtone type || Byte (8bit) || No || 210 || The type of dialtone to generate locally
|
Enter the numeric dialtone type ('''0''' - EUROPE-PBX, '''1''' - EUROPE-PUBLIC, '''2''' - US, '''3''' - UK, '''10''' - ITALY-PBX, '''4''' - ITALY-PUBLIC, '''5''' - CZECH-PBX, '''6''' - CZECH-PUBLIC, '''7''' - SWEDEN, '''8''' - FRANCE, '''9''' - SWISS, '''11''' - BELGIUM, '''12''' - NETHERLANDS, '''13''' - NORWAY, '''14''' - DENMARK, '''15''' - GERMANY, '''16''' - SPAIN, '''17''' - FINLAND, '''18''' - AUSTRIA, '''19''' - IRELAND, '''20''' - AUSTRALIA, '''21''' - NEWZEALAND, '''22''' - MALAYSIA, '''23''' - TURKEY, '''24''' - RUSSIA, '''25''' - SOUTH AFRICA, '''26''' - BRAZIL
)
|-
| Faststart || Byte (8bit) || No || 211 || Disable/Enable the H245 faststart procedure
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| H245-Tunnelling || Byte (8bit) || No || 212 || Disable/Enable H245 tunneling
|
To disable enter '''0''', otherwise enter '''1''' into the 8bit edit field
|-
| Clock type || Byte (8bit) || No || 213 || Define format of date and time display
|
Enter the numeric clock type ('''0''' – ''dd''.''mm''.''yy'' ''hh'':''mm'', 24 hour clock; '''1''' – ''mm''/''dd'' ''hh'':''mm'' ''xm'', 12 hour am/pm clock)
|-
| Static Routes || String || No || 214 || Static routes to be added to the routes already defined in the device configuration
|
The string (max 127 characters) must contain comma separated route definitions in the form '''address:mask:gateway''' where
''address'', ''mask'' and ''gateway'' are expected in dotted decimal notation, ''mask'' (but not the colon) can be left off in a host route
|-
| Update URL || String || No || 215 || URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module
|
Complete URL as in '''<nowiki>http://192.168.0.10/file.txt</nowiki>'''. No symbolic host names are supported
|-
| Update Poll Interval || Word (16bit) || No || 216 || Standard poll interval in minutes. This is identical to the '''/poll''' option parameter of the UP1 module
|
Interval in minutes
|-
| LDAP directory || String || No || 217 || Defines the various Parameters required to access an LDAP directory
| Following parameters can be provided '''-addr''' (LDAP Server Address), '''-port''' (LDAP Port), '''-base''' (Search Base), '''-attr''' (Name Attributes), '''-phone''' (Number Attruibutes), '''-sort1st''' (Sort Results by 1st LDAP name attribute), '''-hold''' (Hold Server Connection), '''-mode''' (Mode), '''-dn''' (Username) '''-pw''' (Password), '''-obj''' (LDAP Object Filter).
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
The string (max. 253 characters) must contain a list of networks in form of comma separated '''address:mask''' pairs, for example '''192.168.1.0:255.255.255.0,192.168.2.0:255.255.255.0'''.
|-
| STUN Server<ref name=blubber>Support for domain names may not be available in V11r1 already but will be added later.</ref> || String || No || 219 || Defines the IP addresses or domain names of STUN servers.
|
The string (max 127 characters) must contain comma separated STUN server addresses in the form '''address:port''' or '''domain:port''' where
''address'' is expected in dotted decimal notation and ''port'' as decimal number. ''port'' (and the preceeding colon) can be left off, in this case the default port is used.
|-
| VoIP Protocol || String || No || 220 || The VoIP Protocl to be used for the Primary Registration (User-1) of a VoIP telephone.
|
One of the following strings may be specified here: H.323, H.323/TCP, H.323/TLS, SIP/UDP, SIP/TCP, SIP/TLS.
|}

<references/>

==== Windows Server DHCP ====
In this section, the installation of innovaphone vendor options is demonstrated using a Microsoft Windows 2000 DHCP server.

First you need to create a new vendor class.

Use the ''Define Vendor Class…'' / ''Herstellerklasse definieren'' menu entry on the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp1_conv.JPG‎]]

Add a new vendor class as follows:

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp2_conv.JPG‎]]

{|
| Anzeigename / Display name || innovaphone
|-
| Beschreibung / Description || innovaphone VoIP Options
|-
| Kennung / ID || (ASCII) 1.3.6.1.4.1.6666
|}

Add the innovaphone options. Use the ''Configure predefined options'' / ''Vordefinierte Optionen einstellen'' entry in the DHCP server’s context menu

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp3_conv.JPG‎]]

Select the innovaphone option class and add the innovaphone specific options according to the table above.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp4_conv.JPG‎]]

To configure innovaphone vendor specific options for a specific scope, use the ''Configure options'' / ''Optionen konfigurieren'' entry in the scopes context menu.

[[Image:DHow_to_use_the_innovaphone_DHCP_client_hcp5_conv.JPG‎]]

Select innovaphone in the Advanced / Erweitert tab sheet.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp7_conv.JPG‎ ]]

Tick the options you want to provide and edit the respective values.

[[Image:How_to_use_the_innovaphone_DHCP_client_Dhcp6_conv.JPG‎ ]]

To do the above automatically, just save the following code as innovaphone_dhcp.cmd and execute it at your DHCP Server.

[[Media:Innovaphone_dhcp_option.zip]]

<code powershell>
netsh Dhcp Server Add Class "innovaphone" "innovaphone VoIP Options" 312e332e362e312e342e312e36363636 1 b
netsh Dhcp Server Add Optiondef 200 "H323 gatekeeper" IPADDRESS 1 vendor="innovaphone" comment="Defines the IP address of both the primary and the alternate gatekeeper for the device. This is only required, if gatekeeper discovery is not feasible" 0.0.0.0
netsh Dhcp Server Add Optiondef 201 "H323 gatekeeper id" STRING 0 vendor="innovaphone" comment="The gatekeeper id of the gatekeeper the device likes to register with. Usually required only if several gatekeepers are running and a particular one must be chosen during gatekeeper discovery" ""
netsh Dhcp Server Add Optiondef 202 "POSIX TZ" STRING 0 vendor="innovaphone" comment="Defines both the time zone and the daylight saving time information." ""
netsh Dhcp Server Add Optiondef 203 "Default coder" STRING 0 vendor="innovaphone" comment="Defines the preferred coders for H.245 coder negotiation, as well as the packet size when sending RTP packets and the use of CNG and VAD" ""
netsh Dhcp Server Add Optiondef 204 "Language" STRING 0 vendor="innovaphone" comment="Defines the user interface language" ""
netsh Dhcp Server Add Optiondef 205 "Location" STRING 0 vendor="innovaphone" comment="Defines the various PBX access numbers (country code etc.) for the device" ""
netsh Dhcp Server Add Optiondef 206 "VLAN ID" WORD 0 vendor="innovaphone" comment="The 802.1q VLAN ID for traffic sent and received by the device" 0
netsh Dhcp Server Add Optiondef 207 "VLAN Priority" BYTE 0 vendor="innovaphone" comment="The 802.1p VLAN priority for traffic sent by the device" 0
netsh Dhcp Server Add Optiondef 208 "TOS Bits" STRING 0 vendor="innovaphone" comment="The value for the IP TOS field in the IP header of voice traffic sent by the device" ""
netsh Dhcp Server Add Optiondef 209 "Enbloc dialling" BYTE 0 vendor="innovaphone" comment="The number of seconds dialled digits are kept in the phone before they are sent en-bloc to the gatekeeper" 0
netsh Dhcp Server Add Optiondef 210 "Dialtone type" BYTE 0 vendor="innovaphone" comment="The type of dialtone to generate locally" 0
netsh Dhcp Server Add Optiondef 211 "Faststart" BYTE 0 vendor="innovaphone" comment="Disable/Enable the H245 faststart procedure" 0
netsh Dhcp Server Add Optiondef 212 "H245-Tunnelling" BYTE 0 vendor="innovaphone" comment="Disable/Enable H245 tunneling" 0
netsh Dhcp Server Add Optiondef 213 "Clock type" BYTE 0 vendor="innovaphone" comment="Define format of date and time display" 0
netsh Dhcp Server Add Optiondef 214 "Static Routes" STRING 0 vendor="innovaphone" comment="Static routes to be added to the routes already defined in the device configuration" ""
netsh Dhcp Server Add Optiondef 215 "Update URL" STRING 0 vendor="innovaphone" comment="URL to retrieve update commands from. This is identical to the /url option parameter of the UP1 module" ""
netsh Dhcp Server Add Optiondef 216 "Update Poll Interval" WORD 0 vendor="innovaphone" comment="Standard poll interval in minutes. This is identical to the /poll option parameter of the UP1 module" 0
netsh Dhcp Server Add Optiondef 217 "LDAP directory" STRING 0 vendor="innovaphone" comment="Defines the various Parameters required to access an LDAP directory" ""
netsh Dhcp Server Add Optiondef 218 "Local Networks" STRING 0 vendor="innovaphone" comment="Defines the networks to be considered local in coder negotiation" ""
</code>

====ISC DHCP Server for Linux====
The ISC DHCP Server is a standard DHCP daemon on many Linux distributions. Here is a sample configuration that provides vendor specific options for innovaphone devices:

<code bash>
option space innovaphone;
option innovaphone.h323-gatekeeper code 200 = array of ip-address;
option innovaphone.h323-gatekeeper-id code 201 = text;
option innovaphone.posix-tz code 202 = text;
option innovaphone.default-coder code 203 = text;
option innovaphone.language code 204 = text;
option innovaphone.location code 205 = text;
option innovaphone.vlan-id code 206 = unsigned integer 16;
option innovaphone.vlan-prio code 207 = unsigned integer 8;
option innovaphone.tos-bits code 208 = text;
option innovaphone.enbloc-dialing code 209 = unsigned integer 8;
option innovaphone.dialtone-type code 210 = unsigned integer 8;
option innovaphone.faststart code 211 = unsigned integer 8;
option innovaphone.h245-tunneling code 212 = unsigned integer 8;
option innovaphone.clock-type code 213 = unsigned integer 8;
option innovaphone.static-routes code 214 = text;
option innovaphone.update-url code 215 = text;
option innovaphone.update-poll-interval code 216 = unsigned integer 16;
option innovaphone.ldap-directory code 217 = text;
option innovaphone.local-networks code 218 = text;
option innovaphone.stun-server code 219 = text;
option innovaphone.voip-protocol code 220 = text;

class "innovaphone" {
match if option vendor-class-identifier = "1.3.6.1.4.1.6666";
}

pool {
#
# Options for phones
#
allow members of "innovaphone";
range 172.21.49.1 172.21.49.127;
vendor-option-space innovaphone;
option innovaphone.h323-gatekeeper 172.21.48.5;
option innovaphone.posix-tz "CET-1CEST-2,M3.5.0/2,M10.5.0/3";
option innovaphone.default-coder "G729,60,e";
option innovaphone.language "deu";
option innovaphone.vlan-id 0x10;
option innovaphone.tos-bits "0x10";
option innovaphone.update-url "http://172.16.100.200/v6/cmds.txt";
option innovaphone.update-poll-interval 0x168;
option innovaphone.ldap-directory "-addr 172.21.48.1 -port 712 -base dc=meta \
-attr sn,givenName,company -phone telephoneNumber:D,homePhone:P,mobile:M,:@ -mail mail";
}
</code>

If you are using ISC-DHCP on IPxx10 linux application plateform you will need to add these line on your dhcpd.conf file.
<code bash>
host selfmac {
#
# Find the mac address of your IPxx10Linux AP with ifconfig command
# And replace the following mac with yours to prevent ISC dhcp offer at itself
# If you do not, you will loose your Application platform
#
hardware ethernet 86:be:09:65:d3:53 ;
deny booting ;
}
</code>

===Determining LDAP options===
To determine a proper configuration for DHCP option configuring a phone, you best proceed as described in [[{{NAMESPACE}}:Phone/State/DHCP-Options]].

Please note that myPBX will not evaluate the DHCP option 217 (LDAP) vendor option. It is thus recommended to deploy the directory settings as part of the users ''Phone'' config entry (''Directories''). Setting it with DHCP vendor options may thus be considered deprecated!

===Disabling the DHCP client===
In certain circumstances, it is convenient to partly disable the DHCP client. This way, the device still gets its IP address from the DHCP server, however, additional settings possibly supplied by the DHCP server are ignored. This is especially useful if in a given setup, some devices are to be configured differently but the majority is still configured by DHCP.

This can be achieved using the following config file options

{|
|'''config change UP1 /no-dhcp'''
|the update server uses the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "Update URL [215]" and "Update Poll Interval [216]" are ignored).
|-
|'''config change DHCPn /no-vlan'''
|the VLAN settings use the config files configuration even though there is a configuration supplied from DHCP (innovaphone vendor options "VLAN ID [206]" and "VLAN Priority [207]" are ignored)...
|-
|'''config change DHCPn /no-vendor'''
|all innovaphone vendor options are ignored.
|}

===Known Problems with lengthy options===
The minimum space available for options in a BOOTP/DHCP record is 312 byte. There are some extension mechanisms but only a few DHCP servers support it. The Windows 2000 DHCP server for example does not, but silently truncates options not fitting in this 312 byte space. Thus it’s nearly impossible to distribute the LDAP directory configuration with a Windows 2000 server but it’s no problem with the DHCP Server built into each innovaphone device.

===Known Problems with VLAN Configurations===
The handling of the 802.1q VLAN ID is a bit tricky. If not hard configured otherwise, the IP200 will request a DHCP lease using the Ethernet switch ports default VLAN ID (that is, it will not send any VLAN header). It will thus receive a DHCP offer dedicated to devices on that VLAN. If this offer includes a VLAN ID option, the IP200 will not accept the offered lease, set the VLAN ID to the value received in the otherwise disregarded offer and start the DHCP process all over again. Now, the DHCP request will be issued on a new VLAN ID. Therefore, the DHCP server will now send an offer dedicated for devices on that new VLAN. This will most probably be a different DHCP scope.

As a consequence, DHCP options of IP200’s on a non-default VLAN must be configured twice. The VLAN ID option itself must be configured in the default VLANs DHCP scope. All other options must be configured in the new VLANs DHCP scope.

Be sure to configure the VLAN in both scopes identically. If not, the DHCP client process will never terminate, since it will always detect a changed VLAN ID, set the VLAN ID and restart the DHCP process.

Here is how DHCP leases are handled in detail:

*First Boot
The client will broadcast a DHCP DISCOVER, expecting an OFFER from the server including all requested parameters. If the client intends to use the offered lease, it will issue a request for the offered lease. Once it receives an ACK for the lease requested, it will configure itself accordingly. All lease information is stored in the devices config file using the /laddr option (unless suppressed using /no-keep).

*Re-boot
If there is lease information (in the /laddr config file option), the client will broadcast requests for the same lease again. If there is no answer within 30 seconds, the device will configure itself using the parameters in /laddr. It will nevertheless continue to request this lease from the DHCP server again (every 30 seconds, a broadcast will be sent).

If the server acknowledges the old lease, the client will check for changes in the DHCP options and re-configure itself accordingly. Changed options will be saved in the config file.

If the server rejects the lease using a NAK, the client will forget about the lease and continue to operate like it does for the first boot.

*First boot with VLAN ID option received

If an offered lease includes the VLAN-ID option and the ID proposed differs from the VLAN ID the devices currently operates with (that is, from the id configured in the devices configuration), the device will change its VLAN ID to the one received in the VLAN-ID option. It will not request the lease though. Instead, it will continue to send DISCOVER requests on the new VLAN ID. If a lease is obtained there, all lease information is stored in the config file as usual.

You can disable the VLAN-ID processing using the '''/no-vlan''' option.

*Reboot with VLAN ID

If the device finds lease information in the config file at boot time and if there is a VLAN ID different from the devices current VLAN-ID, it will re-configure itself to the new VLAN ID and try to request the saved lease as usual. If the lease is rejected with a NAK by the server, the device will re-configure itself to the pre-configured VLAN ID and try to DISCOVER a new lease as usual.

====VLAN set with LLDP====

From version 10, VLAN is also set with LLDP if provided by the switch, see [[Reference10:Interfaces/ETH/VLAN]].

===Changing configuration options set by DHCP options===

If a device has been configured by DHCP, you cannot change those parameters. Any attempt to do so will issue a “Reset required” message.