Configuration parameters

Changes to the parameters ending with '*' will cause a phone reboot.

Features

These parameters define the features on the Dolby Voice Hub.

Parameter Description Permitted Values Default Provisionable
Features.OperationMode* Device operational mode: Dolby Voice service with our without an IP PBX
  • DUALMODE
  • CONFONLYMODE
DUALMODE Yes
Features.RecentCallsEnabled Enable the recent calls feature true, false true Yes

Preferences

These parameters define the user preferences on the Dolby Voice Hub.

Parameter Description Permitted Values Default Provisionable
Preferences.DndEnabled Flag to determine whether to enable the Do Not Disturb feature true, false false Yes
Preferences.AutoAnswerEnabled Flag to determine whether to enable the Auto-Answer feature true, false false Yes
Preferences.ForwardAllNumber Phone number to which all calls are forwarded ASCII,LENGTH0:15 Yes
Preferences.ForwardBusyNumber Phone number to which a call is forwarded when the user is busy ASCII,LENGTH0:15 Yes
Preferences.ForwardNoAnswerNumber Phone number to which a call is forwarded when the user does not answer the call ASCII,LENGTH0:15 Yes
Preferences.SpeechVolume Speech volume level when the Dolby Voice Hub is on a call 1:20 14 Yes
Preferences.RingerVolume Ringer volume level 1:20 10 Yes
Preferences.SystemNotificationSounds Turn on or off the system notification sounds true, false true Yes
Preferences.ShowSystemWarning Show system warning on the phone true, false true Yes
Preferences.Localization.Timezone Time zone where the device is located
  • Pacific/Kwajalein
  • Pacific/Samoa
  • Pacific/Honolulu
  • America/Anchorage
  • America/Los_Angeles
  • America/Denver
  • America/Chicago
  • America/New_York
  • America/Caracas
  • America/St_Johns
  • America/Argentina/Buenos_Aires
  • Atlantic/South_Georgia
  • Atlantic/Azores
  • Atlantic/Cape_Verde
  • Europe/London
  • Europe/Paris
  • Africa/Johannesburg
  • Europe/Kiev
  • Europe/Moscow
  • Asia/Baghdad
  • Asia/Tehran
  • Asia/Muscat
  • Asia/Kabul
  • Asia/Karachi
  • Asia/Kolkata
  • Asia/Kathmandu
  • Asia/Dhaka
  • Asia/Novosibirsk
  • Asia/Bangkok
  • Asia/Singapore
  • Asia/Tokyo
  • Australia/Adelaide
  • Pacific/Guam
  • Australia/Sydney
  • Asia/Magadan
  • Pacific/Auckland
  • Pacific/Fiji
Europe/London Yes
Preferences.Localization.TimeFormat Time Format
  • h:mm ap
  • h:mm
h:mm ap Yes
Preferences.Localization.DateFormat Date Format
  • dd/MM/yy
  • d MMMM, yyyy
  • MMMM d, yyyy
  • MM/dd/yy
  • d MMM, yy
  • MMM d, yy
  • d MMMM yyyy
  • dd.MM.yy
  • d. MMMM yyyy
  • Spanish/Portuguese long
  • Chinese long
  • yyyy/MM/dd
  • yy. M. d.
  • Korean long
  • dd/MM/yyyy
MMMM d, yyyy No
Preferences.Localization.Language Language preference for the embedded UI
  • en
  • fr
  • it
  • de
  • es
  • pt
  • pt_BR
  • ru
  • cs
  • zh-Hant
  • zh-Hans
  • ja
  • ko
  • ar
  • he
en Yes
Preferences.PowerSaving.IdleTimeout Amount of time before an idle system turns off TV to save energy
  • Disabled
  • 5min
  • 15min
  • 30min
  • 60min
  • 120min
30min Yes

Network

These parameters specify the network connections for the Dolby Voice Hub.

Parameter Description Permitted Values Default Provisionable
Network.DHCP Flag to determine whether to enable automatic network configuration using DHCP. If true, the phone will request an IP address from the DHCP server. If set to false, the user must manually configure the IP address. true, false true No
Network.IpAddress* IP address of the Hub. Note: Enabled only when Network.DHCP is set to false. IPV4,LENGTH7:15 No
Network.Subnet* Subnet mask of the network interface. Note: Enabled only when Network.DHCP is set to false. SUBNET,LENGTH7:15 No
Network.DefaultGateway Default gateway for IP Routing. Note: Enabled only when Network.DHCP is set to false. IPV4,IPV6,LENGTH7:15 No
Network.HostName Host name of device ASCII,LENGTH13:13 No
Network.ManualDNS Override DHCP assigned DNS settings true, false false No
Network.DomainName Network domain name DOMAIN No
Network.DNS1 Primary DNS server IP address. Note: Enabled only when Network.DHCP is set to false. IPV4,IPV6,LENGTH7:15 No
Network.DNS2 Secondary DNS server IP address. Note: Enabled only when Network.DHCP is set to false. IPV4,IPV6,LENGTH7:15 No
Network.Ethernet.Speed Ethernet speed (Mbps) 10 No
Network.Ethernet.Duplex Ethernet duplex (half or full) half No
Network.Ethernet.RxPackets Total packets received NUMERIC 0 No
Network.Ethernet.TxPackets Total packets transmitted NUMERIC 0 No
Network.Eapol.Enabled* Enable IEEE 802.1X authentication true, false true No
Network.Eapol.Identity* IEEE 802.1X user identity ASCII,LENGTH0:64 No
Network.Eapol.Password* IEEE 802.1X password ASCII,LENGTH0:64 No
Network.Eapol.CertificateInfo No
Network.Eapol.CertificateAcceptedDigest No
Network.Dhcp.Server DHCP server IP address IPV4,LENGTH7:15 No
Network.Ntp.Server1 Primary NTP server IP address DOMAIN time.nist.gov Yes
Network.Ntp.Server2 Secondary NTP server IP address DOMAIN pool.ntp.org Yes
Network.Vlan.ManualVlanId* User-configured VLAN ID. When DHCP does not provide the VLAN ID, this value is used. 0:4094 0 No
Network.Vlan.ActiveVlanId VLAN ID in use. When provided over DHCP, this parameter is used. 0:4094 0 No
Network.Proxy.AutoDiscover Enable WPAD (Web Proxy Auto-Discovery Protocol) true, false false Yes
Network.Proxy.PacUrl PAC (Proxy Auto Configuration) file URL ASCII Yes
Network.Proxy.UserName Proxy server login name ASCII,LENGTH0:64 Yes
Network.Proxy.Password Proxy server login password ASCII,LENGTH0:64 Yes
Network.Proxy.EnableCache* Enable PAC Cache true, false true Yes
Network.Services.SSHEnabled Enable SSH server true, false true Yes
Network.Status.LinkState Link layer state
  • SUCCESS_UP
  • FAIL_DORMANT
  • FAIL_DOWN
  • FAIL_UNKNOWN
SUCCESS_UP No
Network.Status.EapolClientCert IEEE 802.1X client certificate Dolby Factory Installed Certificate No
Network.Status.Eapol IEEE 802.1X authentication status
  • NOT_APPLICABLE_DISABLED
  • NOT_APPLICABLE_UNCONFIGURED
  • NOT_APPLICABLE_UNCHALLENGED
  • FAIL_UNKNOWN
  • FAIL_CHALLENGED
  • FAIL_UNSUPPORTED_METHOD
  • SUCCESS_AUTHENTICATED
  • FAIL_CREDENTIAL
  • FAIL_CERT
NOT_APPLICABLE_UNCONFIGURED No
Network.Status.EapolMethod IEEE 802.1X authentication method in use
  • UNKNOWN
  • CHAP
  • GTC
  • MD5
  • MSCHAP
  • MSCHAPV2
  • PAP
  • EAP_FAST
  • EAP_GTC
  • EAP_MD5
  • EAP_MSCHAPV2
  • EAP_PEAP
  • EAP_TLS
  • EAP_TTLS
UNKNOWN No
Network.Status.EapolPhase2Method IEEE 802.1X authentication phase 2 method
  • UNKNOWN
  • CHAP
  • GTC
  • MD5
  • MSCHAP
  • MSCHAPV2
  • PAP
  • EAP_FAST
  • EAP_GTC
  • EAP_MD5
  • EAP_MSCHAPV2
  • EAP_PEAP
  • EAP_TLS
  • EAP_TTLS
UNKNOWN No
Network.Status.VoiceVlanStatus Voice VLAN status
  • NOT_APPLICABLE_UNCONFIGURED
  • SUCCESS_LLDP
  • SUCCESS_DHCP
  • SUCCESS_MANUAL
  • FAIL_UNSUPPORTED
  • FAIL_CONFLICT
NOT_APPLICABLE_UNCONFIGURED No
Network.Status.Dhcp DHCP Status
  • SUCCESS
  • FAIL
  • NOT_APPLICABLE
NOT_APPLICABLE No
Network.Status.NtpDiscovery NTP server Discovery Status
  • SUCCESS_DHCP
  • SUCCESS_MANUAL
  • NOT_APPLICABLE_DISABLED
NOT_APPLICABLE_DISABLED No
Network.Status.WpadStatus Web Proxy Auto-Discovery Status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS_DHCP
  • SUCCESS_DNS_A_RECORD
  • FAIL_DISCOVERY
NOT_APPLICABLE_DISABLED No
Network.Status.PacStatus Proxy Auto-Config Status
  • NOT_APPLICABLE_NOT_STARTED
  • NOT_APPLICABLE_DISABLED
  • SUCCESS_LOADED
  • FAIL_INVALID_URL
  • FAIL_DOWNLOAD
  • FAIL_OVERSIZE
  • FAIL_SYNTAX
NOT_APPLICABLE_NOT_STARTED No
Network.Status.AddressConflict IP address conflict No
Network.Status.GatewayStatus Default gateway status
  • NOT_APPLICABLE
  • FAIL_UNCONFIGURED
  • FAIL_UNREACHABLE
  • SUCCESS_REACHABLE
FAIL_UNREACHABLE No
Network.Status.DnsStatus DNS server status
  • NOT_APPLICABLE
  • NOT_APPLICABLE_USING_PRIMARY_VLAN_DNS
  • FAIL_UNCONFIGURED
  • FAIL_UNREACHABLE
  • FAIL_PRIMARY_UNREACHABLE
  • SUCCESS_REACHABLE
FAIL_UNREACHABLE No
Network.Status.HostnameResolvable Device hostname resolvable on DNS server
  • NOT_APPLICABLE
  • FAIL_DNS_UNCONFIGURED
  • FAIL_UNRESOLVABLE
  • SUCCESS_RESOLVABLE
FAIL_UNRESOLVABLE No
Network.Status.ConfigProgress Network configuration progress
  • NOT_STARTED
  • EAPOL
  • LLDP
  • DHCP_VLAN_OPTION
  • STATIC_IP
  • DHCP
  • COMPLETED
NOT_STARTED No
Network.Status.Pds PDS (Provisioning Discovery Service) connection status
  • NOT_APPLICABLE
  • SUCCESS_NORMAL
  • SUCCESS_OOBE_UPGRADE
  • SUCCESS_BLE
  • SUCCESS_DNS_SRV
  • FAIL_UNKNOWN
  • FAIL_EAPOL
  • FAIL_DHCP
  • FAIL_DNS_UNCONFIGURED
  • FAIL_DNS_UNREACHABLE
  • FAIL_PROXY_UNKNOWN
  • FAIL_PROXY_PAC
  • FAIL_PROXY_UNRESOLVABLE
  • FAIL_PROXY_UNREACHABLE
  • FAIL_PROXY_AUTHENTICATION
  • FAIL_PDS_UNRESOLVABLE
  • FAIL_PDS_UNREACHABLE
  • FAIL_PDS_SSL_UNKNOWN
  • FAIL_PDS_SSL_CA
  • FAIL_PDS_AUTHENTICATION
  • FAIL_PDS_RESPONSE_UNKNOWN
  • FAIL_PDS_DEVICE_NOT_FOUND
NOT_APPLICABLE No
Network.PeripheralPort.IpAddress* IP Address assigned to peripheral port IPV4,LENGTH7:15 192.168.67.1 No
Network.PeripheralPort.Status Peripheral port status
  • NOT_APPLICABLE_DISCONNECTED
  • SUCCESS_CONNECTED_UNKNOWN
  • SUCCESS_CONNECTED_DCP
  • FAIL_CONNECTED_UNSUPPORTED
  • FAIL_BLOCKED
NOT_APPLICABLE_DISCONNECTED No

Network2

These parameters specify the secondary VLAN for the Dolby Voice Hub.

Parameter Description Permitted Values Default Provisionable
Network2.Enabled* Flag to determine whether to enable secondary VLAN true, false false Yes
Network2.IpAddress IP address of secondary VLAN IPV4,LENGTH7:15 No
Network2.Subnet Subnet mask of secondary VLAN SUBNET,LENGTH7:15 No
Network2.DefaultGateway Default gateway of secondary VLAN IPV4,IPV6,LENGTH7:15 No
Network2.DomainName Network domain name of secondary VLAN DOMAIN No
Network2.DNS1 Primary DNS server IP address IPV4,IPV6,LENGTH7:15 No
Network2.DNS2 Secondary DNS server IP address IPV4,IPV6,LENGTH7:15 No
Network2.Dhcp.Server DHCP server IP address of secondary VLAN IPV4,LENGTH7:15 No
Network2.Vlan.ManualVlanId* User-configured VLAN ID of secondary VLAN 0:4094 0 Yes
Network2.Vlan.Name Secondary VLAN name No
Network2.Proxy.AutoDiscover Enable WPAD (Web Proxy Auto-Discovery Protocol) true, false false Yes
Network2.Proxy.PacUrl PAC Configuration URL ASCII Yes
Network2.Proxy.UserName Proxy server login name ASCII,LENGTH0:64 Yes
Network2.Proxy.Password Proxy server login password ASCII,LENGTH0:64 Yes
Network2.Status.SecondaryVlan Secondary VLAN status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS_MANUAL
  • FAIL_PRIMARY_SHADOW
NOT_APPLICABLE_DISABLED No
Network2.Status.Dhcp DHCP Status
  • SUCCESS
  • FAIL
  • NOT_APPLICABLE
NOT_APPLICABLE No
Network2.Status.WpadStatus Web Proxy Auto-Discovery Status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS_DHCP
  • SUCCESS_DNS_A_RECORD
  • FAIL_DISCOVERY
NOT_APPLICABLE_DISABLED No
Network2.Status.PacStatus Proxy Auto-Config Status
  • NOT_APPLICABLE_NOT_STARTED
  • NOT_APPLICABLE_DISABLED
  • SUCCESS_LOADED
  • FAIL_INVALID_URL
  • FAIL_DOWNLOAD
  • FAIL_OVERSIZE
  • FAIL_SYNTAX
NOT_APPLICABLE_NOT_STARTED No
Network2.Status.AddressConflict IP address conflict No
Network2.Status.GatewayStatus Default gateway status
  • NOT_APPLICABLE
  • FAIL_UNCONFIGURED
  • FAIL_UNREACHABLE
  • SUCCESS_REACHABLE
NOT_APPLICABLE No
Network2.Status.DnsStatus DNS server status
  • NOT_APPLICABLE
  • NOT_APPLICABLE_USING_PRIMARY_VLAN_DNS
  • FAIL_UNCONFIGURED
  • FAIL_UNREACHABLE
  • FAIL_PRIMARY_UNREACHABLE
  • SUCCESS_REACHABLE
NOT_APPLICABLE No
Network2.Status.SharedDns Share DNS servers with primary VLAN true, false true No

Provisioning

These parameters specify the connection to the provisioning server.

Parameter Description Permitted Values Default Provisionable
Provisioning.Configuration.Files List of configuration files ASCII dvcp-default.cfg No
Provisioning.Configuration.ImageFile Dolby Voice Hub software image file URL ASCII,LENGTH0:512 No
Provisioning.CfgChange.UserAcknowledgementEnabled Flag to determine if user acknowledgement is enabled when a configuration change triggers reboot or software update. true, false false Yes
Provisioning.Server.Static* Flag to determine whether to enable static configuration of the provisioning server address. If true, the provisioning server is configurable through Provisioning.Server.Address. If false, the provisioning server information is discovered using Bluetooth, DHCP or DNS SRV record. true, false false No
Provisioning.Server.PrivacyBlock Flag to disable all uploads that can violate customer privacy. true, false false No
Provisioning.Server.DiscoveryMethod Provisioning discovery method
  • NOT_APPLICABLE
  • BLUETOOTH
  • DNS_SRV
  • DNS_SRV_SECONDARY_VLAN
  • DHCP_OPTION
  • PDS
NOT_APPLICABLE No
Provisioning.Server.DiscoveryState Provision discovery status
  • SUCCESS
  • FAIL
  • NOT_APPLICABLE
NOT_APPLICABLE No
Provisioning.Server.Type Provisioning server type
  • FTP
  • HTTP
  • HTTPS
FTP No
Provisioning.Server.Address Provisioning server address. Note: Enabled only when Provisioning.Server.Static is set to true. URL,LENGTH0:256 No
Provisioning.Server.Username Provisioning server login name. For example, for Provisioning.Server.Type=ftp, this is the user name for logging into the FTP server. ASCII,LENGTH0:64 No
Provisioning.Server.Password Provisioning server login password. For example, for Provisioning.Server.Type=ftp, this is the password for logging into the FTP server. ASCII,LENGTH0:64 No
Provisioning.Server.UploadDir Directory on provisioning server for uploaded files URL,LENGTH0:512 Yes
Provisioning.Scheduled.Enable Flag to determine if scheduled provisioning is enabled true, false false Yes
Provisioning.Scheduled.StartTime Scheduled reprovisioning start time (hour) 0:23 0 Yes
Provisioning.Scheduled.Duration Scheduled reprovisioning interval duration (minutes). Reprovisioning will happen randomly within this time frame from the start time. 5:120 60 Yes
Provisioning.Update.Error Error number from last update attempt 0 No
Provisioning.InvalidCertificates.Info No
Provisioning.InvalidCertificates.AcceptedDigests No
Provisioning.Software.AppVersion Dolby Voice Hub software version LENGTH0:64 No

Sip

These parameters specify the connection to the call server (or SIP server).

Parameter Description Permitted Values Default Provisionable
Sip.Account.DisplayName SIP user display name SIPDISPLAYNAME,LENGTH0:64 Dolby Voice Yes
Sip.Account.UserName Extension Number/Address (also used as SIP user name) ALPHANUMERIC,LENGTH0:64 Yes
Sip.Account.DisplayNumber The number that will be displayed on the home screen. If not configured, then the extension number will be displayed instead. ASCII,LENGTH0:16 Yes
Sip.Account.TransportType Preferred transport to communicate with the IP PBX Server
  • AUTO
  • UDP
  • TCP
  • TLS
  • NAPTR
AUTO Yes
Sip.Account.SecureMedia Option to specify whether secure media (SRTP/SRTCP) is mandatory or optional. Applicable only when TLS transport is active.
  • MANDATORY
  • OPTIONAL
MANDATORY Yes
Sip.Account.SelfPort* Bind port used for SIP transport. TLS port default value is UDP/TCP port + 1 500:9998 5060 Yes
Sip.Pbx.Domain The SIP domain is the domain name of the IP PBX service that the device is registering with. It should be configured if the device connects to the IP PBX service through one or more SIP Proxies. Leave blank if the device directly connects to the SIP server without going through a SIP proxy. URL,LENGTH0:64 Yes
Sip.Pbx.OutboundProxy1 Primary call server or outbound proxy address DOMAIN Yes
Sip.Pbx.OutboundProxy1Port Primary call server/Outbound proxy port 0:65534 5060 Yes
Sip.Pbx.OutboundProxy2 Secondary call server or outbound proxy address DOMAIN Yes
Sip.Pbx.OutboundProxy2Port Secondary SIP server/Outbound Proxy port 0:65534 5060 Yes
Sip.Pbx.SipUriScheme SIP URI Scheme. When set to true, it's SIP; when it's set to false, it's SIPS (Secure SIP). true, false true Yes
Sip.Pbx.OnlyAcceptCallServerEvents Defines whether the device will only accept SIP events from the IP PBX server true, false true Yes
Sip.Pbx.RegistrationTimeout SIP server registration timeout (seconds) 4:60 32 Yes
Sip.Pbx.Codecs PBX codec list ASCII,LENGTH0:128 G722,G711U,G711A,G729AB Yes
Sip.Pbx.InBandDTMF In-band DTMF true, false false Yes
Sip.Credential.Name User credential name ASCII,LENGTH0:64 Yes
Sip.Credential.Password User credential password ASCII,LENGTH0:64 Yes
Sip.Credential.Realm Server realm ASCII,LENGTH1:32 * Yes
Sip.NAT.KeepAliveTimeout The keep-alive interval in seconds. Sets the interval at which phones will send a keep-alive packet to the gateway/NAT device to keep the communication port open so that NAT can continue to function. 0:3600 30 Yes
Sip.Vad.SignalAnnexB Flag to specify if G729 Annex B should be signaled. true, false true Yes

Dvms

These parameters specify the Dolby Voice conferencing service.

Parameter Description Permitted Values Default Provisionable
Dvms.Service.Name Sets the Dolby Voice conferencing service name that will appear on the home screen of the device. LENGTH1:32 Dolby Voice Yes
Dvms.HubApp.Url URL from which the Hub application is downloaded URL https://rtc2.trydcc.com/demo Yes
Dvms.HubApp.OobUrl URL from which the Hub OOBE application is downloaded URL Yes
Dvms.Audio.DVCodecType Defines the codec payload type in the SDP offer for Dolby codec ASCII,LENGTH0:32 60;DVC;8000 Yes
Dvms.Video.ParametersEnabled Enable the following custom encoder settings to tweak video performance. true, false true Yes
Dvms.Video.EncoderResetInterval Cap the video encoder reset at this interval to optimize for transmission bandwidth estimation. 1000 Yes
Dvms.Video.EncoderResetBpsThreshold Threshold of Tx bandwidth change above each encoder reset is requested. Change is calculated against last successfully applied Tx bandwidth value. 10 Yes
Dvms.Video.MinBitRate Minimum transmission bitrate for bandwidth management. 400000 Yes
Dvms.Video.LowH264QPThreshold Low QP (Quantization Parameter) threshold used by quality scaler to evaluate if resolution should be increased. 32 Yes
Dvms.Video.HighH264QPThreshold High QP (Quantization Parameter) threshold used by quality scaler to evaluate if resolution should be decreased. 40 Yes
Dvms.Video.GOPSize Configure the GOP size to adjust the frequency of I-frame. 3000 Yes
Dvms.Video.H264SimulcastDisabled Disable/Enable H264 simulcast support true, false false Yes
Dvms.DeveloperMode.Enabled Turn on developer mode for the Dolby Voice Hub Conferencing App true, false false Yes

Phone

These parameters specify the configuration of a Dolby Conference Phone that is paired with a Dolby Voice Hub .

Parameter Description Permitted Values Default Provisionable
Phone.IpAddress Conference phone IP address IPV4,LENGTH0:15 No
Phone.SerialNumber Phone serial number ALPHANUMERIC,LENGTH0:256 No
Phone.AppVersion Dolby Conference Phone software version LENGTH0:64 No
Phone.VppVersion Voice Processing Platform version LENGTH0:64 No
Phone.EnableBluetoothAdvertisement Allow/disallow Bluetooth Advertisement on Dolby Conference Phone true, false true Yes
Phone.PairingMode Phone pairing mode
  • NOT_PAIRED
  • ATTACHED_AUTO_PAIRED
  • DETACHED_MANUAL_PAIRED
NOT_PAIRED No
Phone.App.Url URL from which the phone application is downloaded URL http://rtc2.trydcc.com/dcpapps/demo/ Yes
Phone.App.OobUrl URL from which the phone OOBE application is downloaded URL Yes
Phone.Audio.RoomSize Optimize performance for a room of this size
  • DEFAULT
  • SMALL
DEFAULT Yes
Phone.Audio.SpatialCaptureOrigin To help with audio/video congruence, this parameter allows the application to specify the spatial capture origin so that the audio and video can be aligned
  • 0
  • 90
  • 180
  • 270
0 Yes
Phone.Audio.PreciseSpatialCaptureOrigin To help with audio/video congruence, this parameter allows the application to specify the spatial capture origin so that the audio and video can be aligned. Values range from -1 to 359 degrees. -1 Yes
Phone.LogLevel.Evs EVS (Event Service) is an internal communication dispatch service that allows software modules to talk to each other. In the log file, the module name is EVS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Sip SIP Communication module handles all telephony and conferencing service session negotiation signaling. In the log file, the module name is SIP.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Ccapi Conference Control API handles conferencing service signaling for BT MeetMe, such as roster list, active speaker, device registration, etc. In the log file, the module name is CCAPI.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Api APS API is an application programming interface that is used by the Embedded UI and Web UI. In the log file, the module name is API.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Cfg Configuration manager handles the storage, dispatch of the configuration parameters. In the log file, the module name is CFG.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Auth Authentication module handles user login from the Web UI as well as the SSH shell. In the log file, the module name is AUTH.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Web Web FastCGI module handles the device Web UI requests for device control and diagnostics. In the log file, the module name is WEB.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Ldp LDAP (Lightweight Directory Access Protocol) handles the LDAP server search request. In the log file, the module name is LDP.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Net Network service module handles network configuration such as VLAN, DHCP, etc. In the log file the module name is NET.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Pvs Provisioning service module handles device interactions with the Provisioning Server. The Provisioning Server is a centralized file server that helps to bulk-configure the devices and collect logs. In the log file, the module name is PVS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Shl Shell service handles the SSH shell. In the log file, the module name is SHL.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Upd Update service handles the software upgrade process on the device. In the log file, the module name is UPD.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Dev Device Manager handles the device hardware-related tasks. In the log file, the module name is DEV.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.CallLog Call Log handles the recent call service, records the calls placed, received and missed on the device. In the log file, the module name is CDR.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.UI Embedded User Interface (UI) module. In the log file, the module name is UI.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Security Security module handles the certificate management of the device. In the log file, the module name is SEC.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.Cdsp DSP (Digital Signal Processor) handles audio processing. In the log file, the module name is CDSP.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.BLE Bluetooth module. In the log file, the module name is BLE.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.LogLevel.DCC DCC (Dolby Conferencing Console) module is responsible for communications with the DCC server. In the log file, the module name is DCC.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Phone.Resources.ServicesMemoryUsed Services Memory Usage (KB) 0:9 0 No
Phone.Resources.ServicesVirtualMemoryUsed Services Virtual Memory Usage (KB) 0:9 0 No
Phone.Resources.GUIMemoryUsed GUI Memory Usage (KB) 0:9 0 No
Phone.Resources.GUIVirtualMemoryUsed GUI Virtual Memory Usage (KB) 0:9 0 No
Phone.Resources.OverallMemoryUsed Overall Memory Usage (KB) 0:9 0 No
Phone.Resources.DSPCPULoad DSP CPU Load (%) 0:9 0 No
Phone.Resources.DSPMemoryUsage DSP Memory Usage (KB) 0:9 0 No
Phone.Resources.ServicesCPULoad Services CPU Load (%) 0:9 0 No
Phone.Resources.OverallCPULoad Overall System CPU Load (%) 0:9 0 No
Phone.Resources.GUICPULoad GUI CPU Load (%) 0:9 0 No
Phone.Resources.UserDataPartitionAvail The availabble space (KB) in the user data partition 0:9 0 No
Phone.Resources.SystemUptime System Uptime 0:9 0 No
Phone.Resources.SystemBootTime System Boot Time (seconds) 0:9 0 No
Phone.Status.SystemWarning Overall system warning status
  • SUCCESS_OFF
  • FAIL_ON
SUCCESS_OFF No
Phone.Status.Network Primary VLAN Network Status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS
  • FAIL_LINK_DOWN
  • FAIL_EAPOL
  • FAIL_VLAN
  • FAIL_DHCP
  • FAIL_ADDRESS_CONFLICT
  • FAIL_WPAD
  • FAIL_PAC
  • FAIL_GATEWAY_UNREACHABLE
  • FAIL_DNS_UNREACHABLE
SUCCESS No
Phone.Status.SipRegistered SIP Registered Status
  • SUCCESS_REGISTERED
  • FAIL_REGISTERED
  • FAIL_ACCOUNT_NOTFOUND
  • FAIL_AUTHENTICATION
  • FAIL_SERVER_ERROR
  • FAIL_NETWORK_ERROR
  • NOT_APPLICABLE
NOT_APPLICABLE No
Phone.Status.SipRegResponse SIP Registration Response LENGTH0:128 No
Phone.Status.ActiveSipRegistrar Address of the active registrar LENGTH0:128 No
Phone.Status.NetworkTime Time sychronization with network server
  • FAIL_NOT_SYNCHRONIZED
  • SUCCESS_NTP
  • FAIL_NTP_POLL
  • SUCCESS_SIP
  • SUCCESS_PDS
  • SUCCESS_BLUETOOTH
FAIL_NOT_SYNCHRONIZED No
Phone.Status.Provisioning Provision Successful Status
  • SUCCESS
  • SUCCESS_SECONDARY_VLAN
  • FAIL
  • FAIL_SERVER_UNREACHABLE
  • FAIL_SSL_ERROR
  • FAIL_AUTH
  • FAIL_MASTER_CONFIG_NOT_FOUND
  • FAIL_CONFIG_NOT_FOUND
  • FAIL_CONFIG_INVALID_JSON
  • FAIL_INVALID_MASTER_CONFIG
  • FAIL_META_DOWNLOAD
  • FAIL_INVALID_META
  • FAIL_INVALID_CONFIG
  • FAIL_INVALID_CERTIFICATE_URL
  • NOT_APPLICABLE
  • NOT_APPLICABLE_IN_PROGRESS
NOT_APPLICABLE No
Phone.Status.SoftwareUpdate Software Update Successful Status
  • NOT_APPLICABLE
  • IN_PROGRESS
  • SUCCESS
  • FAIL
  • FAIL_UNABLE_DOWNLOAD
  • FAIL_INVALID_SIGNATURE
  • FAIL_INVALID_IMAGE
  • FAIL_CANCELLED
  • ACTIVATING
NOT_APPLICABLE No
Phone.Status.LogsUpload Logs Upload Successful Status
  • SUCCESS
  • FAIL
  • NOT_APPLICABLE
NOT_APPLICABLE No
Phone.Status.LoggingImpact Logging Impact On Performance Status
  • SUCCESS_PERFORMANCE_NOT_IMPACTED
  • FAIL_PERFORMANCE_IMPACTED
SUCCESS_PERFORMANCE_NOT_IMPACTED No
Phone.Status.Reboot Shows device reboot status
  • NOT_APPLICABLE
  • REQUIRED
  • PENDING_PVS_COMPLETION
  • PENDING
  • PENDING_DELAYED
  • CANCELLED
  • STARTED
  • STARTED_DELAYED
NOT_APPLICABLE No
Phone.Status.SatMicConnections Shows Satellite Microphone Connection State
  • NOT_CONNECTED
  • SAT_A
  • SAT_B
  • BOTH_CONNECTED
NOT_CONNECTED No
Phone.Status.BluetoothModuleInitialized Indicates if Bluetooth module initialized successfully
  • SUCCESS_INITIALIZED
  • FAIL_NOT_INITIALIZED
FAIL_NOT_INITIALIZED No
Phone.App.Status Application status
  • SUCCESS
  • NOT_APPLICABLE
  • NOT_APPLICABLE_LOADING
  • FAIL_OBJECT_CREATION
  • FAIL_FILE_NOT_FOUND
  • FAIL_NETWORK_ERROR
  • FAIL_CONNECTION_REFUSED
  • FAIL_CONNECTION_CLOSED
  • FAIL_HOST_NOT_FOUND
  • FAIL_CONNECTION_TIMEOUT
  • FAIL_PROXY_ERROR
  • FAIL_SSL_ERROR
  • FAIL_ACCESS_DENIED
  • FAIL_AUTH_REQUIRED
  • FAIL_COMPONENT_ERROR
  • FAIL_HAS_VISUAL_COMPONENTS
  • FAIL_CERTIFICATE_VALIDATION
  • FAIL_SIGNATURE_VALIDATION
  • FAIL_CHECKSUM_VALIDATION
  • FAIL_APP_NAME_VALIDATION
NOT_APPLICABLE No
Phone.App.Version Application version No
Phone.App.Name Application name No
Phone.AppRecording Enables the recording of mouse actions from the Applicatiion true, false false No

Directory

These parameters define the directories that are stored on the phone. This includes the LDAP definitions. The LDAP parameters specifies the location of the corporate directory's LDAP server, the LDAP attributes, and other settings.

Parameter Description Permitted Values Default Provisionable
Directory.Ldap.URIList Comma-separated list of LDAP server URIs (ldap://xxx[,ldap://yyy]) ASCII,LENGTH0:128 Yes
Directory.Ldap.LoginName Name used to login to the LDAP server(s) ASCII,LENGTH0:256 Yes
Directory.Ldap.Password Password used to login to the LDAP server(s) ASCII,LENGTH0:64 Yes
Directory.Ldap.SecureConnection Flag to determine whether to use a secure connection to the LDAP server true, false true Yes
Directory.Ldap.BaseDN Base domain name for the search. For example, "dc=dolby,dc=com" ASCII,LENGTH0:64 Yes
Directory.Ldap.SearchFilter LDAP search filter, where %1 is a placeholder for the search keyword ASCII,LENGTH0:256 (&(objectCategory=person)( (sn=%1)(givenName=%1))(!(msExchHideFromAddressLists=TRUE))) Yes
Directory.Ldap.SearchScope Search depth, where 0=base, 1=one level down, and 2=sub-tree 0:2 2 Yes
Directory.Ldap.SearchTimeout Search timeout (seconds) 0:60 15 Yes
Directory.Ldap.SearchLimit Maximum number of search results 0:1000 200 Yes
Directory.Ldap.AttrFirstName Name of the attribute corresponding to the first name in the LDAP schema ASCII,LENGTH0:32 givenName Yes
Directory.Ldap.AttrLastName Name of the attribute corresponding to the last name in the LDAP schema ASCII,LENGTH0:32 sn Yes
Directory.Ldap.AttrNumber Name of the attribute corresponding to the phone number in the LDAP schema ASCII,LENGTH0:32 telephoneNumber Yes
Directory.Ldap.AttrUUID Name of the attribute corresponding to the unique user ID in the LDAP schema ASCII,LENGTH0:32 uidNumber Yes
Directory.Ldap.AttrMail Name of the attribute corresponding to the e-mail address in the LDAP schema ASCII,LENGTH0:32 mail Yes

Logging

These parameters specify what information is logged and where it is logged. The level parameters specify the logging levels written to the log file. The remote syslog parameters specify the connection to syslog.

Parameter Description Permitted Values Default Provisionable
Logging.Upload.Enable Flag to determine if upload of logs is enabled true, false false Yes
Logging.Upload.Interval Interval between log files uploads in minutes 1:1440 5 Yes
Logging.RemoteSyslog.Enable Turn on or off syslog client on the Dolby Voice Hub. Configure syslog server IP address to complete the setup. true, false false Yes
Logging.RemoteSyslog.Address Syslog server IP address IPV4,IPV6,LENGTH0:15 Yes
Logging.Level.Evs EVS (Event Service) is an internal communication dispatch service that allows software modules to talk to each other. In the log file, the module name is EVS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Sip SIP Communication module handles all telephony and conferencing service session negotiation signaling. In the log file, the module name is SIP.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Api APS API is an application programming interface that is used by the Embedded UI and Web UI. In the log file, the module name is API.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Cfg Configuration manager handles the storage, dispatch of the configuration parameters. In the log file, the module name is CFG.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Auth Authentication module handles user login from the Web UI as well as the SSH shell. In the log file, the module name is AUTH.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Web Web FastCGI module handles the device Web UI requests for device control and diagnostics. In the log file, the module name is WEB.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Ldp LDAP (Lightweight Directory Access Protocol) handles the LDAP server search request. In the log file, the module name is LDP.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Net Network service module handles network configuration such as VLAN, DHCP, etc. In the log file the module name is NET.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Pvs Provisioning service module handles device interactions with the Provisioning Server. The Provisioning Server is a centralized file server that helps to bulk-configure the devices and collect logs. In the log file, the module name is PVS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Shl Shell service handles the SSH shell. In the log file, the module name is SHL.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Upd Update service handles the software upgrade process on the device. In the log file, the module name is UPD.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Dev Device Manager handles the device's hardware-related tasks. In the log file, the module name is DEV.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.CallLog Call Log handles the recent call service, records the calls placed, received and missed on the device. In the log file, the module name is CDR.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.UI Embedded User Interface (UI) module. In the log file, the module name is UI.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.Security Security module handles the certificate management of the device. In the log file, the module name is SEC.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.DCC DCC (Dolby Conferencing Console) module is responsible for communications with the DCC server. In the log file, the module name is DCC.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.PPS PPS (Peripheral Provisioning Service) module acts as a Provisioning server for the attached peripheral (Dolby Conference Phone). In the log file, the module name is PPS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.PNS PNS (Peripheral Network Service) module is responsible for providing network configuration for attached peripheral (Dolby Conference Phone). In the log file, the module name is PNS.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.SMARTCAM SCS (Smart Camera Service). In the log file, the module name is SMARTCAM.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.WALE Web App Manager module. In the log file, the module name is WALE.
  • NONE
  • EMERGENCY
  • ALERT
  • CRITICAL
  • ERROR
  • WARNING
  • NOTICE
  • INFO
  • DEBUG
  • DEBUG1
INFO Yes
Logging.Level.WAE Web App Engine module. In the log file, the module name is WAE.
  • NONE
  • ERROR
  • WARNING
  • INFO
  • VERBOSE1
  • VERBOSE2
  • VERBOSE3
  • VERBOSE4
  • VERBOSE5
  • VERBOSE6
  • VERBOSE7
  • VERBOSE8
  • VERBOSE9
WARNING Yes
Logging.Audio.Mode Audio module logging level.
  • DISABLED
  • STATISTICS
  • DIAGNOSTIC
DISABLED Yes
Logging.Audio.BufferSize Audio logging buffer size in KB. 4096:16384 16384 Yes
Logging.Audio.EchoRefInputEnabled Flag to determine if logging of echo reference input is enabled true, false false Yes
Logging.Audio.EchoRefOutputEnabled Flag to determine if logging of echo reference output is enabled true, false false Yes
Logging.Audio.JitterInputEnabled Flag to determine if logging of jitter buffer input is enabled true, false false Yes
Logging.Audio.JitterOutputEnabled Flag to determine if logging of jitter buffer output is enabled true, false false Yes
Logging.WebRTC.DebugTrace WebRTC debug trace. true, false false Yes
Logging.ReportFreeMemory Add memory usage report to each logging entry of the services application true, false false No

Device

Parameter Description Permitted Values Default Provisionable
Device.ReportCrashToDolby Enables the reporting of diagnostics information to Dolby error reporting service true, false false Yes
Device.MacAddress Device MAC address MAC No
Device.SerialNumber Device serial number ALPHANUMERIC,LENGTH8:8 NULL No
Device.SetupCompleted Shows device setup completion status true, false false No
Device.BoardRevision Hardware Revision ID ALPHANUMERIC,LENGTH5:5 NULL No
Device.USBCameraDetected Global status to indicate whether any UVC device is detected true, false false No
Device.UsbDevices List all connected USB devices, excluding hubs ASCII No
Device.WiFiSSIDs WiFi networks found during last scan. ASCII No
Device.Idle Shows device is in an idle state true, false false Yes
Device.Sleeping Shows device is in a sleeping state. Some features may be turned off. true, false false Yes
Device.BdAddress Bluetooth MAC address MAC No
Device.WAEVersion Web App Engine version No
Device.CACerts.Total Total number of CA certificates 0 No
Device.CACerts.NotValidYet Number of not valid yet CA certificates 0 No
Device.CACerts.Expired Number of expired CA certificates 0 No
Device.CACerts.ExpireSoon Number of expiring soon CA certificates 0 No
Device.CACerts.List CA certificates details ASCII No
Device.SystemResource.ServicesMemoryUsed Services Memory Usage (KB) 0:9 0 No
Device.SystemResource.ServicesVirtualMemoryUsed Services Virtual Memory Usage (KB) 0:9 0 No
Device.SystemResource.GUIMemoryUsed Web app manager memory usage 0:9 0 No
Device.SystemResource.GUIVirtualMemoryUsed Web App Manager Virtual Mem Usage 0:9 0 No
Device.SystemResource.SmartCAMMemoryUsed Smart CAM Mem Usage 0:9 0 No
Device.SystemResource.SmartCAMVirtualMemoryUsed Smart CAM Virtual Mem Usage 0:9 0 No
Device.SystemResource.OverallMemoryUsed Overall Memory Usage (KB) 0:9 0 No
Device.SystemResource.ServicesCPULoad Services CPU Load (%) 0:9 0 No
Device.SystemResource.OverallCPULoad Overall System CPU Load (%) 0:9 0 No
Device.SystemResource.GUICPULoad Web App Manager CPU Load 0:9 0 No
Device.SystemResource.SmartCAMCPULoad Smart CAM CPU Load 0:9 0 No
Device.SystemResource.UserDataPartitionAvail The available space (KB) in the user data partition 0:9 0 No
Device.SystemResource.SystemUptime System Uptime 0:9 0 No
Device.SystemResource.SystemBootTime System Boot Time (seconds) 0:9 0 No
Device.Thermal.Sensor1 Temperature Sensor 1 NULL No
Device.Thermal.Sensor2 Temperature Sensor 2 NULL No
Device.Thermal.Sensor3 Temperature Sensor 3 NULL No
Device.Thermal.FanSpeed Fan Speed (RPM) 0:9 0 No
Device.PowerUser.DevToolsEnabled Flag to indicate if the power user developer tools are enabled true, false false No
Device.Status.HDMIInputDetected Global status to indicate whether HDMI input is detected true, false false No
Device.Status.SystemWarning Overall system warning status
  • SUCCESS_OFF
  • FAIL_ON
SUCCESS_OFF No
Device.Status.Network Primary VLAN Network Status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS
  • FAIL_LINK_DOWN
  • FAIL_EAPOL
  • FAIL_VLAN
  • FAIL_DHCP
  • FAIL_ADDRESS_CONFLICT
  • FAIL_WPAD
  • FAIL_PAC
  • FAIL_GATEWAY_UNREACHABLE
  • FAIL_DNS_UNREACHABLE
SUCCESS No
Device.Status.Network2 Secondary VLAN Network Status
  • NOT_APPLICABLE_DISABLED
  • SUCCESS
  • FAIL_LINK_DOWN
  • FAIL_EAPOL
  • FAIL_VLAN
  • FAIL_DHCP
  • FAIL_ADDRESS_CONFLICT
  • FAIL_WPAD
  • FAIL_PAC
  • FAIL_GATEWAY_UNREACHABLE
  • FAIL_DNS_UNREACHABLE
NOT_APPLICABLE_DISABLED No
Device.Status.ConfigurationErrors Shows configuration errors ASCII No
Device.Status.SipRegistered SIP Registered Status
  • SUCCESS_REGISTERED
  • FAIL_REGISTERED
  • FAIL_ACCOUNT_NOTFOUND
  • FAIL_AUTHENTICATION
  • FAIL_SERVER_ERROR
  • FAIL_NETWORK_ERROR
  • NOT_APPLICABLE
NOT_APPLICABLE No
Device.Status.SipRegResponse SIP Registration Response LENGTH0:128 No
Device.Status.ActiveSipRegistrar Address of the active registrar LENGTH0:128 No
Device.Status.ActiveSipTransport Current active SIP transport LENGTH0:128 No
Device.Status.NetworkTime Time sychronization with network server
  • FAIL_NOT_SYNCHRONIZED
  • SUCCESS_NTP
  • FAIL_NTP_POLL
  • SUCCESS_SIP
  • SUCCESS_PDS
  • SUCCESS_BLUETOOTH
FAIL_NOT_SYNCHRONIZED No
Device.Status.LDAPConnected LDAP Connected Status
  • SUCCESS
  • FAIL_AUTH
  • FAIL_CONN
  • FAIL_UNKNOWN
  • FAIL_REFERRAL
  • FAIL_NETWORK_DOWN
  • NOT_APPLICABLE
NOT_APPLICABLE No
Device.Status.ProvisionSuccessful Provision Successful Status
  • SUCCESS
  • SUCCESS_SECONDARY_VLAN
  • FAIL
  • FAIL_SERVER_UNREACHABLE
  • FAIL_SSL_ERROR
  • FAIL_AUTH
  • FAIL_MASTER_CONFIG_NOT_FOUND
  • FAIL_CONFIG_NOT_FOUND
  • FAIL_CONFIG_INVALID_JSON
  • FAIL_INVALID_MASTER_CONFIG
  • FAIL_META_DOWNLOAD
  • FAIL_INVALID_META
  • FAIL_INVALID_CONFIG
  • FAIL_INVALID_CERTIFICATE_URL
  • NOT_APPLICABLE
  • NOT_APPLICABLE_IN_PROGRESS
NOT_APPLICABLE No
Device.Status.SoftwareUpdateSuccessful Software Update Successful Status
  • NOT_APPLICABLE
  • IN_PROGRESS
  • SUCCESS
  • FAIL
  • FAIL_UNABLE_DOWNLOAD
  • FAIL_INVALID_SIGNATURE
  • FAIL_INVALID_IMAGE
  • FAIL_CANCELLED
  • ACTIVATING
NOT_APPLICABLE No
Device.Status.PeripheralTunnel Peripheral tunnel status
  • NOT_APPLICABLE
  • SUCCESS_CONNECTED
  • FAIL_DISCONNECTED
NOT_APPLICABLE No
Device.Status.LogsUpload Logs Upload Successful Status
  • SUCCESS
  • FAIL
  • NOT_APPLICABLE
NOT_APPLICABLE No
Device.Status.LoggingImpact Logging Impact On Performance Status
  • SUCCESS_PERFORMANCE_NOT_IMPACTED
  • FAIL_PERFORMANCE_IMPACTED
SUCCESS_PERFORMANCE_NOT_IMPACTED No
Device.Status.Reboot Shows device reboot status
  • NOT_APPLICABLE
  • REQUIRED
  • PENDING_PVS_COMPLETION
  • PENDING
  • PENDING_DELAYED
  • CANCELLED
  • STARTED
  • STARTED_DELAYED
NOT_APPLICABLE No
Device.Status.CallInProgress Shows call progress status true, false false No
Device.Status.CACertificates Shows imported CA certificate status
  • NOT_APPLICABLE
  • SUCCESS
  • FAIL_EXPIRE_SOON
  • FAIL_EXPIRED
  • FAIL_NOT_VALID_YET
NOT_APPLICABLE No
Device.App.Status Application status
  • SUCCESS
  • NOT_APPLICABLE
  • NOT_APPLICABLE_LOADING
  • FAIL_FILE_NOT_FOUND
  • FAIL_NETWORK_ERROR
  • FAIL_CONNECTION_REFUSED
  • FAIL_CONNECTION_CLOSED
  • FAIL_HOST_NOT_FOUND
  • FAIL_CONNECTION_TIMEOUT
  • FAIL_PROXY_ERROR
  • FAIL_SSL_ERROR
  • FAIL_ACCESS_DENIED
  • FAIL_CERTIFICATE_VALIDATION
  • FAIL_INTERNAL
  • FAIL_UNKNOWN
NOT_APPLICABLE No
Device.App.Version Application version No
Device.App.Name Application name No

Displays

Display configuration and status parameters

Parameter Description Permitted Values Default Provisionable
Displays.MonitorCount Contains the number of monitors currently detected. 0 Yes
Displays.MonitorSwap Indicates if the two monitor positions are swapped. true, false false Yes
Displays.PreferredResolution Sets the horizontal resolution for the monitors. Auto=system chooses best option.
  • 1080
  • 2160
1080 Yes
Displays.MirrorEnabled Enables display mirroring (aka cloning) of the first monitor on to the second monitor. true, false false Yes
Displays.Monitor1.Height Contains the monitor's current height in pixels 0 No
Displays.Monitor1.Width Contains the monitor's current width in pixels 0 No
Displays.Monitor1.X Contains the monitor's current X position in pixels 0 No
Displays.Monitor1.Y Contains the monitor's current Y position in pixels 0 No
Displays.Monitor1.UpdateRate Contains the monitor's current update rate in Hz 0 No
Displays.Monitor1.Model Contains the monitor's model name n/a No
Displays.Monitor1.Manufacturer Contains the monitor's manufacturer name n/a No
Displays.Monitor2.Height Contains the monitor's current height in pixels 0 No
Displays.Monitor2.Width Contains the monitor's current width in pixels 0 No
Displays.Monitor2.X Contains the monitor's current X position in pixels 0 No
Displays.Monitor2.Y Contains the monitor's current Y position in pixels 0 No
Displays.Monitor2.UpdateRate Contains the monitor's current update rate in Hz 0 No
Displays.Monitor2.Model Contains the monitor's model name n/a No
Displays.Monitor2.Manufacturer Contains the monitor's manufacturer name n/a No

Authentication

This parameter defines the authentication parameters for the phone.

Parameter Description Permitted Values Default Provisionable
Authentication.Local.Admin Administrative password ASCII,LENGTH4:64 1739 Yes
Authentication.Local.SessionTimeout Default authenticated session timeout in seconds. A session is created when a user logs in from Web UI or command line interface. 0:1200 180 Yes
Authentication.Local.SessionPurgeTime The expired sessions record will be purged from the internal sessions list after this many seconds 0:1200 600 Yes
Authentication.Local.AccessPin Phone access PIN. Only applicable when secured access is enabled. NUMERIC,LENGTH4:4 No
Authentication.Local.AutoLockDuration Duration of auto-lock timeout. Only applicable when secured access is enabled for personal mode in the BT MeetMe scenario.
  • 5_MINUTES
  • 20_MINUTES
  • 1_HOUR
  • 2_HOURS
  • 4_HOURS
  • 8_HOURS
1_HOUR Yes

DVCamera

Dolby Voice Camera configuration and status parameters

Parameter Description Permitted Values Default Provisionable
DVCamera.SerialNumber Dolby Voice Camera serial number ALPHANUMERIC,LENGTH0:256 No
DVCamera.SoftwareVersion Dolby Voice Camera software version ALPHANUMERIC,LENGTH0:256 No
DVCamera.OperationMode Dolby Voice Camera operational mode
  • ROOM
  • PEOPLE
  • WHITEBOARD
ROOM Yes
DVCamera.HDREnabled Enables High Dynamic Range true, false false Yes
DVCamera.SceneFramingSensitivity Adjust the intelligent scene framing sensitivity for the people mode.
  • NORMAL
  • FAST
NORMAL Yes
DVCamera.OutputFormat Dolby Voice Camera output format
  • 720P
  • 1080P
1080P No
DVCamera.PTZ.PanLevel Pan level 0 No
DVCamera.PTZ.PanLevelMax Max Pan level 100 No
DVCamera.PTZ.PanLevelMin Min Pan level -100 No
DVCamera.PTZ.TiltLevel Tilt level 0 No
DVCamera.PTZ.TiltLevelMax Max Tilt level 100 No
DVCamera.PTZ.TiltLevelMin Min Tilt level -100 No
DVCamera.PTZ.ZoomLevel Zoom level 0:100 0 No
DVCamera.PTZ.ActivePreset Active preset selection for PTZ 1:3 0 No
DVCamera.PTZ.Preset1 Pan, tilt and zoom preset 1 No
DVCamera.PTZ.Preset2 Pan, tilt and zoom preset 2 No
DVCamera.PTZ.Preset3 Pan, tilt and zoom preset 3 No
DVCamera.ImageQuality.BrightnessLevel Camera brightness level 0:10 6 No
DVCamera.ImageQuality.Contrast Camera contrast level 0:10 5 No
DVCamera.ImageQuality.ColorIntensity Camera color intensity 0:10 5 No
DVCamera.Whiteboard.Corners Whiteboard corner positions {\"TopLeft\":{\"x\":\"0.20000000\",\"y\":\"0.20000000\"},\"TopRight\":{\"x\":\"0.80000000\",\"y\":\"0.20000000\"},\"BottomLeft\":{\"x\":\"0.20000000\",\"y\":\"0.80000000\"},\"BottomRight\":{\"x\":\"0.80000000\",\"y\":\"0.80000000\"}} No
DVCamera.Whiteboard.EnrollmentState Whiteboard enrollment state
  • NOT_APPLICABLE
  • SUCCESS
  • FAIL_INVALID
  • FAIL_TOO_SMALL
  • FAIL_UNSUPPORTED_SHAPE
  • FAIL_MISALIGNED
  • IN_PROGRESS_START
  • IN_PROGRESS_END
NOT_APPLICABLE No
DVCamera.Status.State Dolby Voice Camera state
  • DISCONNECTED
  • CONNECTING
  • READY
DISCONNECTED No
DVCamera.Status.Update Dolby Voice Camera software update status
  • SUCCESS
  • FAIL
  • IN_PROGRESS
  • NOT_APPLICABLE
NOT_APPLICABLE No
DVCamera.Status.Health Dolby Voice Camera health
  • OK
  • NOT_STREAMING
  • PERMANENT_ERROR
  • UNKNOWN
UNKNOWN No