innovaphone wiki - User contributions [en]

Reference:Configuration/ETH/DHCP-Server

2008-04-08T19:39:03Z

Nstoever:

If the DHCP server was enabled (see chapter entitled "[[Reference:Configuration/ETH/DHCP|Configuration/ETH0-1/DHCP]]"), it can be configured here.

All settings marked with a "'''*'''" are innovaphone-specific settings that may only be found with innovaphone devices.

{|
|valign=top nowrap=true|'''Lease Time [min]:'''
| The validity period of the DHCP lease in minutes.
|-
|valign=top nowrap=true|'''Check Interval [min]:'''
| The interval (in minutes), at which a check is made whether the DHCP lease is still valid.
|}

== Address Ranges: ==
{|
|valign=top nowrap=true|'''First Address:'''
| The IP-Adresse that represents the start of the address range (for example, 192.168.1.100).
|-
|valign=top nowrap=true|'''Last Address:'''
| The IP-Adresse that represents the end of the address range (for example, 192.168.1.110).
|}

== Offer Parameters: ==
{|
|valign=top nowrap=true|'''Network Mask:'''
| The network mask in respect of the IP-Adress (for example, 192.168.1.100 corresponds to the network mask 255.255.255.0).
|-
|valign=top nowrap=true|'''Default Gateway:'''
| Standard router address (for example, 192.168.1.1).
|-
|valign=top nowrap=true|'''TOS Priority:'''
| ToS (Type of Service) value for voice packets (0x10).
|-
|valign=top nowrap=true|'''IP Routing:'''
| List of static IP-Routes in form of comma separated ''Address:Mask:Gateway'' triples (for example, 192.168.20.0:255.255.255.0:192.168.1.2,192.168.30.0:255.255.255.0:192.168.1.3).
|-
|valign=top nowrap=true|'''DNS Server 1:'''
| Primary DNS server address.
|-
|valign=top nowrap=true|'''DNS Server 2:'''
| Secondary DNS server address.
|-
|valign=top nowrap=true|'''Syslog Server:'''
| Syslog server address.
|-
|valign=top nowrap=true|'''Time Server:'''
| Time server address.
|-
|valign=top nowrap=true|'''Timezone String *:'''
| Time zone setting according to the IEEE POSIX standard (for example, CET-1CEST-2,M3.5.0/2,M10.5.0/3).
|-
|valign=top nowrap=true|'''TFTP Server:'''
| The TFTP server address.
|-
|valign=top nowrap=true|'''WINS Server:'''
| The WINS server address.
|-
|valign=top nowrap=true|'''Primary Gatekeeper *:'''
| The primary gatekeeper IP address.
|-
|valign=top nowrap=true|'''Secondary Gatekeeper *:'''
| The alternative Gatekeeper IP address.
|-
|valign=top nowrap=true|'''Coder *:'''
| Coder preference for VoIP telephones. 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.
|-
|valign=top nowrap=true|'''Gatekeeper Identifier *:'''
| The VoIP gatekeeper or the gatekeeper ID for VoIP telephones.
|-
|valign=top nowrap=true|'''Dial Tones *:'''
| The dial tone that is transmitted as the standard dial tone to the VoIP telephones (for example, German PBX = as German PBX, US = US dial tone, UK = British dial tone).
|-
|valign=top nowrap=true|'''Enblock Dialling Timeout [s] *:'''
| Switches on enbloc dialling for VoIP telephones.
|-
|valign=top nowrap=true|'''Faststart [0|1] *:'''
| Faststart 0/1 turns off/on the H.323 Faststart procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Tunneling [0|1] *:'''
| Tunneling 0/1 turns off/on the H.245 Tunneling procedure. If this option is not defined the default (on) applies.
|-
|valign=top nowrap=true|'''Local Networks *:'''
| List of local 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). For VoIP Calls that end up in a local network the device will try to use the coder preferred for the local network (as provided in the Coder option or defined locally).
|-
|valign=top nowrap=true|'''Language *:'''
| All VoIP telephones that receive their IP-Adresse via DHCP have the language defined here set up as the standard language.
|-
|valign=top nowrap=true|'''Dialling Location *:'''
| Defines the various PBX access numbers on VoIP telephones for directory access. This character string must contain /cc, /ac, /ntp, /itp, /col and /pbx options. It may look like this: "/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 7".
|-
|valign=top nowrap=true|'''AM/PM Clock [0|1]:'''
| Enables/disables the English time format for VoIP telephones. The German time format is displayed as standard: "dd.mm.yy hh:mm, 24-hour clock." If a 1 is entered in this field, the English time format "mm/dd hh:mm xm, 12-hour am/pm clock" is displayed.
|-
|valign=top nowrap=true|'''LDAP Directory:'''
| To allocate a functioning LDAP configuration to all VoIP devices integrated via DHCP, a configuration character string can be entered in the LDAP Directory field. You obtain this configuration character string by executing the following command in the browser of a configured device: "<IP-Adresse of the VoIP device>/!mod cmd PHONE DIR ldap-config". When this command has been executed, a configuration character string is output in the browser, which you copy and paste into the LDAP Directory field of the DHCP server. In this way, all further devices are given a correct LDAP configuration.
|-
|valign=top nowrap=true|'''Update Interval [min]:'''
| All devices integrated via DHCP are assigned the interval specified here in the Interval [min] field of the update server (see chapter entitled "[[Reference:Configuration/General/Update|Configuration/General/Update]]").
|-
|valign=top nowrap=true|'''Update Server URL:'''
| All devices integrated via DHCP are assigned the URL specified here (for example, <nowiki>http://192.168.1.2/update/script.htm</nowiki>) in the Command File URL field of the update server (see chapter entitled "[[Reference:Configuration/General/Update|Configuration/General/Update]]"). An automated update of the devices is thereby ensured.
|-
|valign=top nowrap=true|'''802.1q VLAN ID:'''
| The configuration at the switch must be observed for setting the VLAN ID. An empty 802.1q VLAN ID field (16 bit) assumes the value 0. The VLAN ID with the value 0 switches QoS (Quality of Service) off according to 802.1q ab. If the switch at the port to the innovaphone device happens to be configured to a different VLAN ID, the same value must be specified here to allow a prioritisation from the Ethernet. To be able to distinguish between the VLANs, the Ethernet packet is extended by 4 bytes, of which 12 bits are intended for the inclusion of the VLAN ID, making 4094 VLANs possible (VLAN ID 0 and 4095 are reserved or invalid).
|-
|valign=top nowrap=true|'''802.1p VLAN Priority'''
| In the 802.1p VLAN Priority field (3 bit), the associated VLAN priority level (a value between 0 and 7) can be specified, in order that voice data is given priority forwarding, for example.
|}

==DHCP Vendor-Optioncodes==

For a description howto implement the Innovaphone DHCP-Options in Microsoft or Linux DHCP Server Software refer to
[[Howto:How_to_use_the_innovaphone_DHCP_client]]

Howto:Maintain Quickdial Numbers In Estos MetaDirectory

2008-04-08T13:14:32Z

Nstoever:

==Applies To==
This information applies to

* PBX, V6 SR2
* Estos MetaDirectory 2.0.0.x

==More Information==
The PBX object ''LDAP Quickdial'' allows to map quickdial numbers into diallable numbers by means of LDAP. This article explains the directory- and PBX related configuration steps.
==Configuration==
The summarized goal of this article
* A CSV (Comma Separated Value) file ''quickdial.csv'' is to be maintained in Excel and to be imported into the Estos MetaDirectory.
* An LDAP Quickdial object with the extension ''1'' offers the mapping from 4-digit quickdial numbers to diallable numbers.
* An Estos MetaDirectory runs on 172.16.16.133, port 712.
===The CSV file===
Open a CSV-capable editor (e.g. Excel) and edit/create the file ''quickdial.csv'' with the following content:
<pre>
kw;telephone;name;givenname
1001;+4970311234570;Smith;Gerda
1002;+497031234571;Miller;Dan
1003;+497031234572;Doe;John
1004;+4970311234573;James;Rick
</pre>
===Estos MetaDirectory Configuration===
* Open the Estos MetaDirectory Administrator program and create a new Import Replicator under ''Configuration/Replicator''.
* Select ''Text CSV File''.
* Enter eventually required authentication information.
* Enter/Select the path to the file ''quickdial.csv''.
* As ''File Format'' selcect ''Windows Text(semicolon)''.
* Activate ''First line contains field names''.
* Now provide field mappings
** Map ''kw'' as the ''Primary Key'' (i.e. the quickdial number is the key and will be stored within the ''entryID'' attribute.
** The mappings for telephone, name and givenname are created automatically by this administration dialog.
* Skip ''Contact Actions''.
* Skip the ''Country Region'' dialog.
* Configure the time schedule.
* Provide a profile name (e.g. Quickdial) and hit ''Ok''.
* Trigger the replication at least 1x.
===PBX Configuration===
* Proceed to ''Administration/PBX/Objects''.
* Create a new ''LDAP Quickdial'' object.
* Enter ''ldap'' as ''Long Name'' and ''Name''.
* Enter ''1'' as ''Number''.
* Configure the ''Directory''.
** Enter ''172.16.16.133:712'' as ''Server''.
** Leave ''User'' and ''Password'' empty.
** Enter ''ou=quickdial,dc=meta'' as ''Search Base''.
** Enter ''entryID'' as ''Name Attributes''.
** Enter ''telephoneNumber'' as ''Number Attributes''.
* Configure the ''Dialing Location''
** E.g. a subscriber in Berlin, Germany could enter ''49'', ''30'', ''0'', ''00'', ''0'' for ''Country Code'' .. ''External Line''.
==Testing==
From an ip phone dial ''11001''. The call should then be forwarded to the number ''0070311234570''.
==A Bit Of Background==
A common LDAP browser (Softerra, MS ldp.exe, others) shows how the Estos MetaDirectory maintains such an object internally. Here is an exemplary excerpt of our object with all of its attributes and values:
<pre>
Dn: cn=1001,ou=Quickdial,dc=meta
cn: Smith;
createTimestamp: 20080129153527.0Z;
creatorsName: Quickdial;
databaseName: Quickdial;
displayName: Smith;
distinguishedName: cn=1001,ou=Quickdial,dc=meta;
entryID: 1001;
entryIDDB: DB99;
entryIDMeta: 1D60FD9CE2CD484396A7E6E9ACDE6059;
entryIDStore: C:\Dokumente und Einstellungen\mst\Desktop\metadirectory2.0.0.669de\kurzwahlen.csv;
givenName: Gerda;
modifiersName: Quickdial;
modifyTimestamp: 20080129153527.0Z;
name: Smith;
objectClass: contactperson;
telephoneNumber: +4970311234570;
uSNChanged: 1;
</pre>
The LDAP query will be submitted with the LDAP filter ''(entryID=1001)''. As can be easily seen the object's ''telephoneNumber'' attribute with the value ''+4970311234570'' will be returned. This number will be finally normalized into ''0070311234570''.

==Quickdial from Active Directory==

To use your existing Active Directory Data within your PBX through Meta Directory:
* Create a new Import Replicator Type Active Directory
* As Servername use either your DC's name or your Active Directory - DNS Domain Name
* In Database Management create a new LDAP Node (dc=Quickdial)
* As Numberformat choose dialable ( +49 ****558 123 => 123)
[[Image:Estos_quickdial_ad_node.PNG]]
* Create a LDAP Quickdial object with a
Number: 96 (should be not dialable from outside)
Search Base: dc=Quickdial
Name Attribute: telephoneNumber
Number Attribute: mobile

Now you can dial 96 + internal number and you reach your co-workers cellphone.

==Known Problems==



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

File:Estos quickdial ad node.PNG

2008-04-08T13:13:44Z

Nstoever:

Reference:DHCP client

2008-04-08T11:48:18Z

Nstoever: /* ISC DHCP Server for Linux */

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.

[ This article has been converted from the previous "howto" document in the V5 predoc folder and is intended to replace this ]

==Applies To==

This information applies to

* All innovaphone devices,

V5.01 Build 04-5679 and V6

==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,sec'''. 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.
|-
| 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''', '''/ac''', '''/ntp''', '''/itp''', '''/col''' and '''/pbx''' options in the phone configuration file, e.g. '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 7''' (althought, to save bytes, you may omit the '''/'''-es)
|-
| 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 value for the IP TOS field in the IP header of voice traffic sent by the device
|
Enter the numerical priority into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers)
|-
| 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 (e.g. '''0''' - german PBX, '''1''' – german PSTN, '''2''' – US)
|-
| 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''
''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
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
This string option 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'''.
|}

<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]]
<pre>

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" ""

</pre>

====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:

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;

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";
}

===Determining option values with V6===
In V6 (from SR1), there is [[Howto:Valid_values_for_innovaphone_DHCP_verndor_options | a simple method available ]] to paste the values from a phones web GUI.

===Determining LDAP options===

To determine a proper configuration for option 217 (LDAP), you best proceed as follows:

*Take a phone and configure it with static IP address
*Tweak the LDAP settings (''Registration 1 / Directories / Extern'') as desired
*take output string of following URL on your IP phone: <code><nowiki>http://''x.x.x.x''/!mod cmd PHONE DIR ldap-config</nowiki></code>
*and set option 217 on DHCP-Server to the string shown

With version 6 firmware, you can determine the values (as all other DHCP values) using the phones [[Reference:Administration/Phone/DHCP-Options|DHCP-Options page]].

===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.

===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.

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

Reference:DHCP client

2008-04-08T08:47:53Z

Nstoever: /* Windows Server DHCP */

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.

[ This article has been converted from the previous "howto" document in the V5 predoc folder and is intended to replace this ]

==Applies To==

This information applies to

* All innovaphone devices,

V5.01 Build 04-5679 and V6

==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,sec'''. 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.
|-
| 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''', '''/ac''', '''/ntp''', '''/itp''', '''/col''' and '''/pbx''' options in the phone configuration file, e.g. '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 7''' (althought, to save bytes, you may omit the '''/'''-es)
|-
| 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 value for the IP TOS field in the IP header of voice traffic sent by the device
|
Enter the numerical priority into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers)
|-
| 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 (e.g. '''0''' - german PBX, '''1''' – german PSTN, '''2''' – US)
|-
| 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''
''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
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
This string option 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'''.
|}

<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>

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:

option space innovaphone;
option innovaphone.h323-gatekeeper code 200 = array of ip-address;
option innovaphone.posix-tz code 202 = text;
option innovaphone.default-coder code 203 = text;
option innovaphone.language code 204 = text;
option innovaphone.tos-bits code 208 = 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;

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.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";
}

===Determining option values with V6===
In V6 (from SR1), there is [[Howto:Valid_values_for_innovaphone_DHCP_verndor_options | a simple method available ]] to paste the values from a phones web GUI.

===Determining LDAP options===

To determine a proper configuration for option 217 (LDAP), you best proceed as follows:

*Take a phone and configure it with static IP address
*Tweak the LDAP settings (''Registration 1 / Directories / Extern'') as desired
*take output string of following URL on your IP phone: <code><nowiki>http://''x.x.x.x''/!mod cmd PHONE DIR ldap-config</nowiki></code>
*and set option 217 on DHCP-Server to the string shown

With version 6 firmware, you can determine the values (as all other DHCP values) using the phones [[Reference:Administration/Phone/DHCP-Options|DHCP-Options page]].

===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.

===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.

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

File:Innovaphone dhcp option.zip

2008-04-08T08:46:26Z

Nstoever:

Howto:Different voice and data VLANs with innovaphone ip phones IEEE 802.1Q

2008-04-05T12:44:03Z

Nstoever: /* Configuration */

==Summary==
Having innovaphone IP phones, different Vlan´s (IEEE 802.1Q) and Pc´s connected behind the innovaphone IP phones.
==Applies To==
This information applies to

* IP110
* IP200
* IP230

==More Information==
The IP110, IP200, IP230, can handle Vlan Tags
===Problem Details===
Voice and Data Vlan on one switch port – when you are connected to a Switch with an IP Phone and on the IP Phone switch port is a PC connected.
===System Requirements===
Switch has to support tagged and untagged Frames on one Port.
===Installation
Configure the same Vlan Id on the Phone as on the Switch.
===Configuration===
You can configure a Vlan tag on these phones- the phone will send every frame with this configured tag. (Tagged frames)

Now you have Pc´s connected behind these phones (via the phone switch port) - this Pc should be in a different Vlan (for Qos and security reasons- different Ip Subnets, different Dhcp servers,...)

The switch must support tagged and untagged frames on one port!

So the tagged frames are the voice Vlan (you have to configure the same Vlan id on the switch as on the phone)

The switch put every frame from the IP phone in the configured Vlan.

So all phones and the innovaphone PBX should be in this Vlan (that’s nice because the innovaphone PBX can then be also dhcp server only for the phones.

The Pc data should send untagged frames

When untagged frames are send from the Pc - the switch put it in his default Vlan (or port based Vlan, or untagged Vlan)

You have now two different networks (Vlans) on one port.

If you configure your whole local network like this- you can connect your phone to every switch port and you are always in the right Vlan.

The DHCP Server on PC VLAN should be configured with Innovaphone DHCP-Option 206 VLAN ID matching the voice VLAN.

This way you can connect new Phones without configuring the VLAN and don't have problems with DHCP-leases left from phones

connected to the PC VLAN before switching them to the Voice VLAN manual. If your PC VLAN DHCP Server sends the innovaphone option 206

the Phone will not accept the DHCP Offer and switch to the received VLAN ID.

see [[Howto:How_to_use_the_innovaphone_DHCP_client]]

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

Howto:Different voice and data VLANs with innovaphone ip phones IEEE 802.1Q

2008-04-04T20:15:32Z

Nstoever:

==Summary==
Having innovaphone IP phones, different Vlan´s (IEEE 802.1Q) and Pc´s connected behind the innovaphone IP phones.
==Applies To==
This information applies to

* IP110
* IP200
* IP230

==More Information==
The IP110, IP200, IP230, can handle Vlan Tags
===Problem Details===
Voice and Data Vlan on one switch port – when you are connected to a Switch with an IP Phone and on the IP Phone switch port is a PC connected.
===System Requirements===
Switch has to support tagged and untagged Frames on one Port.
===Installation
Configure the same Vlan Id on the Phone as on the Switch.
===Configuration===
You can configure a Vlan tag on these phones- the phone will send every frame with this configured tag. (Tagged frames)

Now you have Pc´s connected behind these phones (via the phone switch port) - this Pc should be in a different Vlan (for Qos and security reasons- different Ip Subnets, different Dhcp servers,...)

The switch must support tagged and untagged frames on one port!

So the tagged frames are the voice Vlan (you have to configure the same Vlan id on the switch as on the phone)

The switch put every frame from the IP phone in the configured Vlan.

So all phones and the innovaphone PBX should be in this Vlan (that’s nice because the innovaphone PBX can then be also dhcp server only for the phones.

The Pc data should send untagged frames

When untagged frames are send from the Pc - the switch put it in his default Vlan (or port based Vlan, or untagged Vlan)

You have now two different networks (Vlans) on one port.

If you configure your whole local network like this- you can connect your phone to every switch port and you are always in the right Vlan.

The DHCP Server on PC VLAN should be configured with Innovaphone DHCP-Option 206 VLAN ID matching the voice VLAN.

This way you can connect new Phones without configuring the VLAN and don't have problems with DHCP-leases left from phones

connected to the PC VLAN before witching them to the Voice VLAN manual. If your PC VLAN DHCP Server sends the innovaphone option 206

the Phone will not accept the DHCP Offer and switch to the received VLAN ID.

see [[Howto:How_to_use_the_innovaphone_DHCP_client]]

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

Reference:DHCP client

2008-04-04T19:51:32Z

Nstoever: /* Windows Server DHCP */

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.

[ This article has been converted from the previous "howto" document in the V5 predoc folder and is intended to replace this ]

==Applies To==

This information applies to

* All innovaphone devices,

V5.01 Build 04-5679 and V6

==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,sec'''. 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.
|-
| 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''', '''/ac''', '''/ntp''', '''/itp''', '''/col''' and '''/pbx''' options in the phone configuration file, e.g. '''/cc 49 /ac 7031 /ntp 0 /itp 00 /col 0 /pbx 7''' (althought, to save bytes, you may omit the '''/'''-es)
|-
| 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 value for the IP TOS field in the IP header of voice traffic sent by the device
|
Enter the numerical priority into the string field. You may prefix with '''0x''' to specify hexadecimal numbers (or '''0''' to specify octal numbers)
|-
| 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 (e.g. '''0''' - german PBX, '''1''' – german PSTN, '''2''' – US)
|-
| 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''
''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
|-
| Local Networks || String || No || 218 || Defines the networks to be considered local in coder negotiation.
|
This string option 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'''.
|}

<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 automatic just save the following code as innovaphone_dhcp.cmd and execute it at your DHCP Server.

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" ""

====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:

option space innovaphone;
option innovaphone.h323-gatekeeper code 200 = array of ip-address;
option innovaphone.posix-tz code 202 = text;
option innovaphone.default-coder code 203 = text;
option innovaphone.language code 204 = text;
option innovaphone.tos-bits code 208 = 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;

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.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";
}

===Determining option values with V6===
In V6 (from SR1), there is [[Howto:Valid_values_for_innovaphone_DHCP_verndor_options | a simple method available ]] to paste the values from a phones web GUI.

===Determining LDAP options===

To determine a proper configuration for option 217 (LDAP), you best proceed as follows:

*Take a phone and configure it with static IP address
*Tweak the LDAP settings (''Registration 1 / Directories / Extern'') as desired
*take output string of following URL on your IP phone: <code><nowiki>http://''x.x.x.x''/!mod cmd PHONE DIR ldap-config</nowiki></code>
*and set option 217 on DHCP-Server to the string shown

With version 6 firmware, you can determine the values (as all other DHCP values) using the phones [[Reference:Administration/Phone/DHCP-Options|DHCP-Options page]].

===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.

===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.

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