MAINTENANCE
Configuration file structure
The following table shows the default structure of the .xml file:
String
<xml>
<KT800>
<time>
<timezone>
<time_format>
<ntp>
<server>
<enable>
<date_format>
<custom_dst>
<enable>
Description
To specify the number of the phone configuration version and encoding.
To specify the model of the conference phone.
To specify the time and region parameters.
To specify the type of the time zone set for the phone. If you set the string value to the name of a time zone, for example, to
Europe/Amsterdam , it automatically enables the Geo Timezone (auto DST) parameter on the phone web UI.
To specify the time format for the phone.
To specify whether NTP is applied.
To specify the server which the phone uses to set the time.
To specify whether NTP is enabled. The default setting is true.
To specify the date format for the phone.
To specify the Daylight Saving Time parameters.
To specify whether the Daylight Saving Time is enabled. The default setting is false.
Table continued…
109
MAINTENANCE
String
<offset_hours>
<dst_start>
<month>
<day>
<day_mode>
<hour>
<dst_stop>
<month>
<day>
<day_mode>
<hour>
<media>
<security>
<srtp>
<srtcp>
Description
To specify the time in hours between the standard time and daylight saving time. The values are 1 and 2. The default setting is 1.
To specify when to apply the offset for daylight saving time.
To specify the month when to apply the offset.
To specify the day when to apply the offset.
To specify the day mode when to apply the offset.
To specify the hour when to apply the offset
To specify when to stop the offset for daylight saving time.
To specify the month when to stop the offset.
To specify the day when to stop the offset.
To specify the day mode when to stop the offset.
To specify the hour when to stop the offset.
To specify the media settings.
To specify the means of encryption configured for the phone.
To specify the SRTP parameters that the phone uses.
To specify whether SRTCP is enabled.
Table continued…
110
MAINTENANCE
String
<capneg>
<codec>
<iLBC>
<prio>
<mode>
<OPUS>
<prio>
<PCMU>
<prio>
<PCMA>
<prio>
<G722>
<prio>
<G729>
<prio>
<rtp_pt_98_ilbc>
<voice_quality_monitor>
Description
To specify whether Capability Negotiation is enabled.
To specify the codec settings.
To specify the internet Low Bitrate Codec
(iLBC) codec settings.
To specify the codec priority (0–6).
To specify the frame length in ms.
To specify the OPUS codec settings.
To specify the codec priority (0–6).
To specify the PCMU codec settings.
To specify the codec priority (0–6).
To specify the PCMA codec settings.
To specify the codec priority (0–6).
To specify the G722 codec settings.
To specify the codec priority (0–6).
To specify the G729 codec settings.
To specify the codec priority (0–6).
To specify that the server gets iLBC packets as payload type 98. By default it is set to
104. You can also set the value to 98 to ensure interoperability with specific systems.
To specify the Voice Quality Monitor settings.
Table continued…
111
MAINTENANCE
String
<enable_rtcp_xr>
<rtcp_xr_collector_uri>
<sip>
<primary_account>
<name>
<user>
<registrar>
<proxy>
<keep_alive>
<cred>
<realm>
<username>
<password>
Description
To specify whether the sending of RTCP XR is enabled.
To specify the Uniform Resource Identifier
(URI) of the RTCP XR collector.
To specify SIP settings.
To specify the primary account settings.
To specify the name of the account.
To specify the user-defined name of the account.
To specify the request URI for registration.
To specify the optional URI of the proxy to visit for all outgoing requests from the account.
To specify whether the keep-alive transmission for the account is enabled.
To specify the array of credentials. In case of registration, at least one credential must be available to successfully authenticate the service provider. If you want proxies to challenge the requests in the route set, you must specify more credentials.
To specify the realm.
To specify an authentication name.
To specify the password used for the account.
Table continued…
112
MAINTENANCE
String
<reg_timeout>
<secondary_account>
<name>
<user>
<registrar>
<proxy>
<keep_alive>
<cred>
<realm>
<username>
<password>
Description
To specify the optional interval for registration in seconds. If zero, the phone uses the default interval. The default setting is 300.
To specify the secondary account settings.
To specify the name of the account.
To specify the user-defined name of the account.
To specify the request URI for registration.
To specify the optional URI of the proxy to visit for all outgoing requests from the account.
To specify whether the keep-alive transmission for the account is enabled.
To specify the array of credentials. In case of registration, at least one credential must be available to successfully authenticate the service provider. If you want proxies to challenge the requests in the route set, you must specify more credentials.
To specify the realm.
To specify an authentication name.
To specify the password used for the account.
Table continued…
113
MAINTENANCE
String
<reg_timeout>
<fallback_account>
<name>
<user>
<registrar>
<proxy>
<keep_alive>
<cred>
<realm>
<username>
<password>
Description
To specify the optional interval for registration in seconds. If zero, the phone uses the default interval. The default setting is 300.
To specify the fallback account settings.
To specify the name of the account.
To specify the user-defined name of the account.
To specify the request URI for registration.
To specify the optional URI of the proxy to visit for all outgoing requests from the account.
To specify whether the keep-alive transmission for the account is enabled.
To specify the array of credentials. In case of registration, at least one credential must be available to successfully authenticate the service provider. If you want proxies to challenge the requests in the route set, you must specify more credentials.
To specify the realm.
To specify an authentication name.
To specify the password used for the account.
Table continued…
114
MAINTENANCE
String
<reg_timeout>
<source_port>
<transport_protocol>
<tls>
<tls_method>
<tls_neg_timeout>
<tls_password>
<verify_client>
<verify_server>
<require_client_cert>
<advanced>
<disable_rport>
Description
To specify the optional interval for registration in seconds. If zero, the phone uses the default interval. The default setting is 300.
To specify the source port to listen to.
To specify the transport protocol which the phone must use.
To specify that TLS is selected as the transport protocol. This is followed by the corresponding transport protocol settings.
To specify the TLS protocol method.
To specify the TLS negotiation time-out in seconds for both outgoing and incoming connections. If zero, the phone uses no timeout.
To specify the password for the private key.
To specify whether the phone must verify the client.
To specify whether the phone must verify the server.
To specify whether the phone requires the client certificate.
To specify the configured advanced SIP settings.
To specify whether the remote port forwarding is enabled. The default setting is disabled.
Table continued…
115
MAINTENANCE
String
<session_timers>
Description
To specify the chosen time-related mechanism to disconnect the sessions.
<session_expiration_minimum> To specify the minimum session expiration value in seconds. The default value is 90 seconds.
<session_expiration> To specify the session expiration value in seconds. The default setting is 1800 seconds.
<outbound_proxy>
<enable_sip_traces>
To specify the IP address of the outbound proxy.
To specify whether the provision of key information for troubleshooting is enabled.
The default setting is disabled.
<allow_contact_rewrite>
<allow_via_rewrite>
<enable_sip_replaces>
To specify whether the storing of the IP address from the response of the register request is enabled.
To specify whether rewriting of the VIA header in the SIP stack is enabled.
To specify whether the SIP Replaces header must be used.
<contact_use_src_port_even_wit h_dns>
To specify whether the SIP stack should continue to retrieve the local ephemeral port even if the stack is configured with DNS.
<enable_lock_codec>
<use_static_source_port>
To specify whether the lock codec feature is enabled.
To specify whether the use of static source port feature is enabled.
Table continued…
116
MAINTENANCE
<enable>
<stun>
<enable>
<server>
<turn>
<enable>
<server>
String
<dtmf>
<method>
<rfc4733_payload_type>
<nat_traversal>
<ice>
<user>
<password>
<phone>
Description
To specify DTMF signaling settings.
To specify the DTMF signaling method.
To specify the type of audio traffic.
To specify the configured NAT traversal settings.
To specify whether ICE is configured for the phone.
To specify whether ICE is enabled.
To specify whether STUN is configured for the phone.
To specify whether STUN is enabled.
To specify the IP address or the public name of the STUN server.
To specify whether TURN is configured for the phone.
To specify whether TURN is enabled.
To specify the IP address or the public name of the TURN server.
To specify the user authentication name on the TURN server.
To specify whether the user authentication password on the TURN server is set.
To specify the configured basic settings of the phone.
Table continued…
117
MAINTENANCE
String
<name>
<language>
<allow_legacy_encryption>
<password>
<ringlevel>
<key_tone>
<is_daisy_chain_slave>
<fips_mode>
<phone_status_api>
<sleep_mode_timeout>
<enable_startup_sound>
<bluetooth>
<enable>
<network>
<dhcp>
<hostname>
Description
To specify the name of the phone.
To specify the language selected.
To specify whether Legacy encryption mode is enabled. The default setting is true.
To specify the password used.
To specify the volume level configured.
To specify whether the key tone is enabled.
To specify the mode of the phone in case of a daisy chain arrangement.
To specify whether FIPS mode is enabled.
The default setting is false.
To specify whether the phone status API feature is enabled.
To specify the time-out value in minutes.
To specify whether the start-up sound is enabled. The default setting is true.
To specify the Bluetooth parameters.
To specify whether Bluetooth is enabled. The default setting is true.
To specify the network parameters.
To specify whether the phone uses DHCP to obtain network settings.
To specify the hostname of the phone.
Table continued…
118
MAINTENANCE
String
<domain>
<dns1>
<dns2>
<static_ip>
<ip>
<netmask>
<gateway>
<vlan>
<vlanid>
<ieee_8021x>
<enable>
<username>
<eap_md5>
<enable>
Description
To specify the domain name of the phone.
To specify Domain Name Server (DNS) 1 of the phone.
To specify DNS 2 of the phone. You can use maximum two DNS.
To specify the static IP settings.
To specify the IP address of the phone if
DHCP is disabled.
To specify the network mask for your phone.
To specify the gateway for the phone.
To specify whether VLAN is enabled. The default setting is disabled.
To specify the ID number that the phone uses for all IP telephony communication through VLAN.
To specify IEEE 802.1x parameters.
To specify whether IEEE 802.1x is enabled.
It is disabled by default.
To specify the phone username if IEEE
802.1x is enabled.
To specify whether the phone uses MD5
EAP method.
To specify whether MD5 EAP method is enabled.
Table continued…
119
MAINTENANCE
String
<password>
<eap_tls>
<enable>
<password>
<lldp>
<enable>
<country>
<country_subdivision>
<county>
<city>
<city_division>
<block>
<street>
<direction>
Description
To specify the password for MD5 EAP method.
To specify whether the phone uses TLS EAP method.
To specify whether TLS EAP method is enabled.
To specify the password for the TLS EAP method.
To specify the LLDP settings.
To specify whether the LLDP settings are enabled. These settings are disabled by default.
To specify the country of the phone location.
To specify the region of the country of the phone location.
To specify the county, parish, district, or other applicable administrative division.
To specify the city of the phone location.
To specify the city district or area of the phone location.
To specify the block within the city district.
To specify the street of the building where the phone is located.
To specify the direction of moving towards the location of the phone.
Table continued…
120
MAINTENANCE
String
<trailing_street_suffix>
<street_suffix>
<number>
<number_suffix>
<landmark>
<additional>
<name>
<zip>
<building>
<unit>
<floor>
<room>
<place_type>
<script>
Description
To specify the trailing street suffix.
To specify the street suffix.
To specify the number of the building where the phone is located.
To specify the building number suffix.
To specify the reference point for the location of the phone.
To specify any additional information related to the phone location.
To specify the name of the company that owns the phone.
To specify the ZIP-code of the phone location.
To specify the name or number of the building of the phone location.
To specify the unit within the building where the phone is located.
To specify the floor of the building for the location of the phone.
To specify the room in the building where the phone is located.
To specify the type of setting, for example, office.
To specify the script.
Table continued…
121
MAINTENANCE
String
<elin>
<qos>
<dscp_sip>
<dscp_media>
<device_management>
<enable>
<update_interval>
<update_max_wait>
<server>
<check_server_certificate>
<lowest_tls_version>
<dhcp_option>
<logging>
Description
To specify Emergency Location Identification
Number (ELIN).
To specify the quality of service (QoS) parameters.
To specify a value in the range from 0 to 63 to prioritize the SIP messages.
To specify a value in the range from 0 to 63 to prioritize the media packets.
To specify the Device Management settings.
To specify whether Device Management is enabled.
To specify the update interval in the range from 1 minute to 21,000 minutes. The default setting is 60 minutes.
To specify the maximum time in seconds the phone waits for the update.
To specify the Device Management server address if it is not provided by the DHCP option.
To specify whether the Check certificate is enabled.
To specify the lowest TLS version for the phone.
To select the DHCP option used for the
Device Management server address.
To specify the syslog settings.
Table continued…
122
MAINTENANCE
String
<remote_syslog_enable>
<remote_syslog_host>
<ldap>
<enable>
<name_filter>
<server_url>
<search_base>
<user_name>
<password>
<max_hits>
<country_code>
<area_code>
<external_prefix>
Description
To specify whether the remote syslog feature is enabled.
To specify the IP address or the host of the remote syslog server.
To configure the LDAP options.
To enable the LDAP feature. By default it is disabled.
To define how the phone applies the entered search characters.
To specify the URL of the LDAP server host.
It includes the protocol (LDAP/LDAPS) and the port number.
To specify the distinguished name of the search base.
To specify the username for the LDAP server.
To specify the password for the LDAP server.
To specify the maximum number of hits to return for each LDAP search.
To specify the country code of the phone location.
To specify the area code of the phone location.
To specify a special prefix for dialing external numbers.
Table continued…
123
MAINTENANCE
String
<min_length_for_ext_prefix>
<number_prefix_for_no_ext_prefi x>
To specify the initial number for the phone numbers in case of using which the phone adds no external prefix.
<exact_length_for_no_ext_prefix
>
To specify the exact length for the phone numbers if the phone adds no external prefix.
<number_attributes>
<number_attribute>
<id>
To specify if there are configured number attributes.
To define the attributes that the phone displays if it receives them from the server.
To define the identifier of the number attribute in the form in which the LDAP directory stores it.
<value>
Description
To restrict the external prefix that the phone adds only if the phone number is longer than the minimum length.
<display_name>
<sort_results>
To define the label that the user sees on the phone screen for a specific number attribute.
To specify how the phone displays the name it searched for.
To specify if the phone sorts the search hits based on the Display name.
<use_dm_certificates_for_ldaps> To specify if the phone uses any device management certificates for LDAPS.
<httpd> To configure the web server options.
Table continued…
124
