Device Parameters

The following table lists each of the <device/> parameters that you can configure.

Note: The default values for the <device/> parameters are set at the factory when the phones are shipped. For a list of the default values, see the latest Product Shipping Configuration Change Notice at Polycom Engineering Advisories and Technical Notifications.
Table 1. Device Parameters

Template

Parameter

Permitted Values

Change Causes

Restart or Reboot

device.cfg site.cfg

device.auth.localAdminPassword

Set the phone's local administrative password. The minimum length is defined by sec.pwd.length.admin .

string (32 character max)

No

device.cfg reg-advanced

device.auth.localUserPassword

Set the phone user's local password. The minimum length is defined by sec.pwd.length.user .

string (32 character max)

No

device.cfg

device.auxPort.enable

Enable or disable the phone auxiliary port.

0

1 (default)

Yes

device.cfg

device.baseProfile

NULL (default)

Generic —Sets the base profile to Generic for OpenSIP environments.

Lync —Sets this Base Profile for Skype for Business deployments.

No

device.cfg site.cfg

device.dhcp.bootSrvOpt

When the boot server is set to Custom or Custom+Option66, specify the numeric DHCP option that the phone looks for.

Null

128 to 254

Yes

device.cfg site.cfg

device.dhcp.bootSrvOptType

Set the type of DHCP option the phone looks for to find its provisioning server if device.dhcp.bootSrvUseOpt is set to Custom .

IP address—The IP address provided must specify the format of the provisioning server.

String—The string provided must match one of the formats specified by device.prov.serverName .

Yes

device.cfg site.cfg

device.dhcp.bootSrvUseOpt

Default—The phone looks for option number 66 (string type) in the response received from the DHCP server. The DHCP server should send address information in option 66 that matches one of the formats described for device.prov.serverName .

Custom —The phone looks for the option number specified by device.dhcp.bootSrvOpt , and the type specified by device.dhcp.bootSrvOptType in the response received from the DHCP server.

Static —The phone uses the boot server configured through the provisioning server device.prov.* parameters.

Custom and Default—The phone uses the custom option first or use Option 66 if the custom option is not present.

Yes

device.cfg site.cfg

device.dhcp.dhcpVlanDiscOpt

Set the DHCP private option to use when device.dhcp.dhcpVlanDiscUseOpt is set to Custom .

128 to 254

Yes

device.cfg site.cfg

device.dhcp.dhcpVlanDiscUseOpt

Set how VLAN Discovery occurs.

Disabled—no VLAN discovery through DHCP.

Fixed—use predefined DHCP vendor-specific option values of 128, 144, 157 and 191 ( device.dhcp.dhcpVlanDiscOpt is ignored). Custom—use the number specified by device.dhcp.dhcpVlanDiscOpt .

Yes

device.cfg site.cfg

device.dhcp.enabled

Enable or disable DHCP.

0

1

Yes

device.cfg site.cfg

device.dhcp.option60Type

Set the DHCP option 60 type.

Binary—vendor-identifying information is in the format defined in RFC 3925.

ASCII—vendor-identifying information is in ASCII format.

Yes

device.cfg site.cfg

device.dns.altSrvAddress

Set the secondary server to which the phone directs domain name system (DNS) queries.

Server Address

Yes

device.cfg site.cfg

device.dns.domain

Set the phone's DNS domain.

String

Yes

device.cfg site.cfg

device.dns.serverAddress

Set the primary server to which the phone directs DNS queries.

Server Address

Yes

device.cfg site.cfg

device.hostname

Specify a hostname for the phone when using DHCP by adding a hostname string to the phone's configuration.

If device.host.hostname.set = 1, and device.host.hostname = Null , the DHCP client uses Option 12 to send a predefined hostname to the DHCP registration server using Polycom_<MACaddress> .

String —The maximum length of the hostname string is <=255 bytes, and the valid character set is defined in RFC 1035.

Yes

device.cfg site.cfg

device.net.cdpEnabled

Determine if the phone attempts to determine its VLAN ID and negotiate power through CDP.

0

1

Yes

device.cfg site.cfg wireless.cfg

device.net.dot1x.anonid

EAP-TTLS and EAP-FAST only. Set the anonymous identity (user name) for 802.1X authentication.

String

Yes

device.cfg site.cfg wireless.cfg

device.net.dot1x.enabled

Enable or disable 802.1X authentication.

0

1

Yes

device.cfg site.cfg wireless.cfg

device.net.dot1x.identity

Set the identity (user name) for 802.1X authentication.

String

Yes

device.cfg site.cfg wireless.cfg

device.net.dot1x.method

Specify the 802.1X authentication method, where EAP-NONE means no authentication.

EAP-None

EAP-TLS

EAP-PEAPv0-MSCHAPv2

EAP-PEAPv0-GTC

EAP-TTLS-MSCHAPv2

EAP-TTLS-GTC

EAP-FAST

EAP-MD5

No

device.cfg site.cfg wireless.cfg

device.net.dot1x.password

Set the password for 802.1X authentication. This parameter is required for all methods except EAP-TLS.

String

Yes

device.cfg site.cfg

device.net.etherModeLAN

Set the LAN port mode that sets the network speed over Ethernet.

Polycom recommends that you do not change this setting.

Auto

10HD

10FD

100HD

100FD

1000FD

HD means half-duplex and FD means full duplex.

Yes

device.cfg site.cfg

device.net.etherModePC

Set the PC port mode that sets the network speed over Ethernet.

Auto (default)

Disabled—disables the PC port.

10HD

10FD

100HD

100FD

1000FD

HD means half-duplex and FD means full duplex.

Yes

device.cfg site.cfg

device.net.etherStormFilter

1—DoS storm prevention is enabled and received Ethernet packets are filtered to prevent TCP/IP stack overflow caused by bad data or too much data.

0— DoS storm prevention is disabled.

Yes

device.cfg site.cfg

device.net.etherStormFilterPpsValue

Set the corresponding packets per second (pps) for storm filter and to control the incoming network traffic.

17 to 40

38 (default)

No

device.cfg site.cfg

device.net.etherStormFilterPpsValue.set

0 (default) - You cannot configure the device.net.etherStormFilterPpsValue parameter.

1 - You can configure the device.net.etherStormFilterPpsValue parameter.

No

device.cfg site.cfg

device.net.etherVlanFilter

VLAN filtering for VVX phones is done by the Linux operating system and it cannot be disabled.

0

1

Yes

device.cfg

device.net.ipAddress

Set the phone's IP address.

This parameter is disabled when device.dhcp.enabled is set to 1.

String

Yes

device.cfg site.cfg

device.net.IPgateway

Set the phone's default router.

IP address

Yes

device.cfg site.cfg

device.net.lldpEnabled

0—The phone doesn't attempt to determine its VLAN ID.

1—The phone attempts to determine its VLAN ID and negotiate power through LLDP.

Yes

device.cfg site.cfg

device.net.lldpFastStartCount

Specify the number of consecutive LLDP packets the phone sends at the time of LLDP discovery, which are sent every one second.

5 (default)

3 to 10

No

device.cfg site.cfg

device.net.subnetMask

Set the phone's subnet mask.

This parameter is disabled when device.dhcp.enabled is set to 1.

subnet mask

Yes

device.cfg site.cfg

device.net.vlanId

Set the phone's 802.1Q VLAN identifier.

Null—No VLAN tagging.

0 to 4094

Yes

device.cfg site.cfg

device.prov.maxRedunServers

Set the maximum number of IP addresses to use from the DNS.

1 - 8

Yes

device.cfg site.cfg

device.prov.password

Set the password for the phone to log in to the provisioning server, which may not be required.

If you modify this parameter, the phone re-provisions. The phone may also reboot if the configuration on the provisioning server has changed.

string

Yes

device.cfg site.cfg

device.prov.redunAttemptLimit

Set the maximum number of attempts to attempt a file transfer before the transfer fails. When multiple IP addresses are provided by DNS, 1 attempt is considered to be a request sent to each server.

1 to 10

Yes

device.cfg site.cfg

device.prov.redunInterAttemptDelay

Set the number of seconds to wait after a file transfer fails before retrying the transfer. When multiple IP addresses are returned by DNS, this delay only occurs after each IP has been tried.

0 to 300

Yes

device.cfg site.cfg

device.prov.serverName

Enter the IP address, domain name, or URL of the provisioning server followed by an optional directory and optional configuration filename. This parameter is used if ( device.dhcp.enabled is 0 ), if the DHCP server does not send a boot server option, or if the boot server option is static ( device.dhcp.bootSrvUseOpt is static ).

IP address

Domain name string

URL

If you modify this parameter, the phone re-provisions. The phone also reboots if the configuration on the provisioning server has changed.

No

device.cfg site.cfg

device.prov.serverType

Set the protocol the phone uses to connect to the provisioning server. Active FTP is not supported for BootROM version 3.0 or later, and only implicit FTPS is supported.

FTP (default)

TFTP

HTTP

HTTPS

FTPS

Yes

device.cfg site.cfg

device.prov.tagSerialNo

0—The phone's serial number (MAC address) is not included in the User-Agent header of HTTPS/HTTPS transfers and communications to the microbrowser and web browser.

1— the phone's serial number is included.

No

device.cfg site.cfg

device.prov.upgradeServer

Specify the URL or path for a software version to download to the device.

On the Web Configuration Utility, the path to the software version you specify displays in the drop-down list on the Software Upgrade page.

NULL (default)

string

0 -255 characters

No

device.cfg site.cfg

device.prov.user

The user name required for the phone to log in to the provisioning server (if required).

If you modify this parameter, the phone re-provisions, and it may reboot if the configuration on the provisioning server has changed.

string

No

device.cfg site.cfg

device.prov.ztpEnabled

Enable or disable Zero Touch Provisioning (ZTP).

0

1

For information, see Zero-Touch Provisioning: https://support.polycom.com/content/support/North_America/USA/en/support/voice/Zero_Touch_Provisioning/zero_touch_provisioning_solution.html.

No

device.cfg site.cfg

device.sec.configEncryption.key1

Set the configuration encryption key used to encrypt configuration files.

string

For more information, see the sectionConfiguration File Encryption.

Yes

device.cfg site.cfg

device.sec.coreDumpEncryption.enabled

Determine whether to encrypt the core dump or bypass the encryption of the core dump.

0—encryption of the core dump is bypassed.

1 (default)—the core dump is encrypted

No

device.cfg site.cfg

device.sec.TLS.customCaCert1( TLS Platform Profile 1 )

device.sec.TLS.customCaCert2( TLS Platform Profile 2 )

Set the custom certificate to use for TLS Platform Profile 1 and TLS Platform Profile 2 and TLS Application Profile 1 and TLS Application Profile 2. The parameter device.sec.TLS.profile.caCertList must be configured to use a custom certificate. Custom CA certificate cannot exceed 4096 bytes total size.

string

PEM format

No

debug.cfg

device.sec.TLS.customDeviceCert1.privateKey device.sec.TLS.customDeviceCert2.privateKey

Enter the corresponding signed private key in PEM format (X.509).

Size constraint: 4096 bytes for the private key.

No

debug.cfg

device.sec.TLS.customDeviceCert1.publicCert device.sec.TLS.customDeviceCert2.publicCert

Enter the signed custom device certificate in PEM format (X.509).

Size constraint: 8192 bytes for the device certificate.

No

device.cfg site.cfg

device.sec.TLS.customDeviceCert1.set device.sec.TLS.customDeviceCert2.set

Use to set the values for parameters device.sec.TLS.customDeviceCertX.publicCert and device.sec.TLS.customDeviceCertX.privateKey .

Size constraints are: 4096 bytes for the private key, 8192 bytes for the device certificate.

0 (default)

1

No

device.cfg

device.sec.TLS.profile.caCertList1 ( TLS Platform Profile 1 )

device.sec.TLS.profile.caCertList2 ( TLS Platform Profile 2 )

Choose the CA certificate(s) to use for TLS Platform Profile 1 and TLS Platform Profile 2 authentication:

Builtin—The built-in default certificate

BuiltinAndPlatform—The built-in and Custom #1 certificates

BuiltinAndPlatform2—The built-in and Custom #2 certificates

All—Any certificate (built in, Custom #1 or Custom #2)

Platform1—Only the Custom #1 certificate

Platform2—Only the Custom #2 certificate

Platform1AndPlatform2—Either the Custom #1 or Custom #2 certificate

No

device.cfg site.cfg

device.sec.TLS.profile.cipherSuite1 ( TLS Platform Profile 1 )

device.sec.TLS.profile.cipherSuite2 ( TLS Platform Profile 2 )

Enter the cipher suites to use for TLS Platform Profile 1 and TLS Platform Profile 2

string

No

device.cfg site.cfg

device.sec.TLS.profile.cipherSuiteDefault1 ( TLS Platform Profile 1 )

device.sec.TLS.profile.cipherSuiteDefault2 ( TLS Platform Profile 2 )

Determine the cipher suite to use for TLS Platform Profile 1 and TLS Platform profile 2.

0—The custom cipher suite is used.

1—The default cipher suite is used.

No

device.cfg site.cfg

device.sec.TLS.profile.deviceCert1 ( TLS Platform Profile 1 )

device.sec.TLS.profile.deviceCert2 ( TLS Platform Profile 2 )

Choose the device certificate(s) for TLS Platform Profile 1 and TLS Platform Profile 2 to use for authentication.

Builtin

Platform1

Platform2

No

device.cfg site.cfg

device.sec.TLS.profileSelection.dot1x

Choose the TLS Platform Profile to use for 802.1X.

PlatformProfile1

PlatformProfile2

No

device.cfg site.cfg

device.sec.TLS.profileSelection.provisioning

Set the TLS Platform Profile to use for provisioning.

PlatformProfile1

PlatformProfile2

Yes

device.cfg site.cfg

device.sec.TLS.profileSelection.syslog

Set the TLS Platform Profile to use for syslog.

PlatformProfile1

PlatformProfile2

Yes

device.cfg site.cfg

device.sec.TLS.prov.strictCertCommonNameValidation

0

1 (default)—Provisioning server always verifies the server certificate for the commonName/SubjectAltName match with the server hostname that the phone is trying to connect.

No

device.cfg site.cfg

device.sec.TLS.syslog.strictCertCommonNameValidation

0

1—Syslog always verifies the server certificate for the commonName/SubjectAltName match with the server hostname that the phone is trying to connect.

No

device.cfg site.cfg

device.sntp.gmtOffset

Set the GMT offset—in seconds—to use for daylight savings time, corresponding to -12 to +13 hours.

-43200 to 46800

No

device.cfg site.cfg

device.sntp.gmtOffsetcityID

Sets the correct time zone location description that displays on the phone menu and in the Web Configuration Utility.

NULL (default)

0 to 126

For descriptions of all values, refer to Time Zone Location Description.

No

device.cfg site.cfg

device.sntp.serverName

Enter the SNTP server from which the phone obtains the current time.

IP address

Domain name string

No

device.cfg site.cfg

device.syslog.facility

Determine a description of what generated the log message.

0 to 23

For more information, see RFC 3164.

No

device.cfg site.cfg

device.syslog.prependMac

0

1—The phone's MAC address is prepended to the log message sent to the syslog server.

Yes

device.cfg site.cfg

device.syslog.renderLevel

Specify the logging level for the lowest severity of events to log in the syslog. When you choose a log level, the log includes all events of an equal or greater severity level, but it excludes events of a lower severity level.

0 or 1—SeverityDebug(7).

2 or 3—SeverityInformational(6).

4—SeverityError(3).

5—SeverityCritical(2).

6—SeverityEmergency(0).

Yes

device.cfg site.cfg

device.syslog.serverName

Set the syslog server IP address or domain name string.

IP address

Domain name string

No

device.cfg site.cfg

device.syslog.transport

Set the transport protocol that the phone uses to write to the syslog server.

None—Transmission is turned off but the server address is preserved.

UDP

TCP

TLS

No