Set-CsUCPhoneConfiguration
Enables you to modify management options for UC phones. This includes such things as the required security mode and whether or not the phone should automatically be locked after a specified period of inactivity. This cmdlet was introduced in Lync Server 2010.
Syntax
Set-CsUCPhoneConfiguration
[-Tenant <Guid>]
[-CalendarPollInterval <TimeSpan>]
[-EnforcePhoneLock <Boolean>]
[-PhoneLockTimeout <TimeSpan>]
[-MinPhonePinLength <Byte>]
[-SIPSecurityMode <SIPSecurityMode>]
[-VoiceDiffServTag <Byte>]
[-Voice8021p <Byte>]
[-LoggingLevel <LoggingLevel>]
[[-Identity] <XdsIdentity>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CsUCPhoneConfiguration
[-Tenant <Guid>]
[-CalendarPollInterval <TimeSpan>]
[-EnforcePhoneLock <Boolean>]
[-PhoneLockTimeout <TimeSpan>]
[-MinPhonePinLength <Byte>]
[-SIPSecurityMode <SIPSecurityMode>]
[-VoiceDiffServTag <Byte>]
[-Voice8021p <Byte>]
[-LoggingLevel <LoggingLevel>]
[-Instance <PSObject>]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
UC phones represent the merging of the telephone and Skype for Business Server. UC phones use special hardware (that is, a Skype for Business-compatible telephone) that can function as a Voice over Internet Protocol (VoIP) telephone. In addition, this hardware can also act as a Skype for Business-like endpoint: you can set your current status; check the status of your Skype for Business contacts; search for new contacts and carry out many of the other activities you are used to doing with Skype for Business.
The CsUCPhoneConfiguration cmdlets enable you to use configuration settings to manage phones running Skype for Business. For example, you can control such things as the minimum length of the personal identification number (PIN) used to log on to the phone and whether or not the phone will automatically lock itself after a specified period of inactivity.
Unified communications (UC) phone configuration settings can be applied at either the global scope or at the site scope.
When you first install Skype for Business Server, a single set of UC phone configuration settings is created and applied at the global scope.
However, at any time after that you can use the New-CsUCPhoneConfiguration cmdlet to create a collection of settings that are applied at the site scope.
This lets you tailor UC phone management to the unique needs of each individual site.
In addition to creating new collections of UC phone settings, you can use the Set-CsUCPhoneConfiguration cmdlet to modify the property values of an existing collection.
For example, by default logging is disabled for UC phones.
To enable logging at the global level, you can use the Set-CsUCPhoneConfiguration cmdlet to change the value of the global collection's LoggingLevel property to True.
The following parameters are not applicable to Skype for Business Online: CalendarPollInterval, Force, Identity, Instance, PipelineVariable, SIPSecurityMode, Tenant, Voice8021p, and VoiceDiffServTag
Examples
-------------------------- Example 1 --------------------------
Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium"The command shown in Example 1 sets the SIP security mode of the global UC phone settings to Medium.
-------------------------- Example 2 --------------------------
Set-CsUCPhoneConfiguration -Identity site:Redmond -PhoneLockTimeout "00:30:00"Example 2 modifies the UC phone settings configured for the Redmond site. In this case, the PhoneLockTimeout property is set to 30 minutes; this is done by including the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds).
-------------------------- Example 3 --------------------------
Get-CsUCPhoneConfiguration -Filter "site:*" | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:30:00"Example 3 is a variation of the command shown in Example 2.
This time, however, the PhoneLockTimeout property is modified for all the UC phone settings configured at the site scope.
To do this, the command starts off by calling the Get-CsUCPhoneConfiguration cmdlet; the Filter parameter and the filter value "site:*" limit the returned data to phone settings configured at the site scope.
This filtered collection is then piped to the Set-CsUCPhoneConfiguration cmdlet, which uses the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds) to set the phone lock timeout value for each item in the collection to 30 minutes.
-------------------------- Example 4 --------------------------
Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Set-CsUCPhoneConfiguration -EnforcePhoneLock $True -PhoneLockTimeout "00:30:00"Example 4 configures the EnforcePhoneLock and the PhoneLockTimeout properties for all the UC phone settings where the SIP security mode is set to either Low or Medium.
To perform this task, the command first uses the Get-CsUCPhoneConfiguration cmdlet to return all the UC phone configuration settings in the organization; this information is then piped to the Where-Object cmdlet, which picks out only those settings where the SIPSecurityMode property is not equal to High.
(Because SIP security can only be set to Low, Medium, or High, this clause will select all the settings where SIPSecurityMode is set to either Low or Medium.) The filtered collection is then piped to the Set-CsUCPhoneConfiguration cmdlet, which uses the EnforcePhoneLock and the PhoneLockTimeout parameters to modify the phone locking and phone lock timeout properties.
-------------------------- Example 5 --------------------------
Get-CsUCPhoneConfiguration | Where-Object {$_.PhoneLockTimeout -lt "00:10:00"} | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:10:00"In Example 5, the phone lock timeout value is set to 10 minutes for all the UC phone settings where the PhoneLockTimeout property is currently less than 10 minutes.
(In effect, this makes 10 minutes the minimum phone lock timeout for the entire organization.) To do this, the command first uses the Get-CsUCPhoneConfiguration cmdlet to return a collection of all the UC phone settings currently in use in the organization.
This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the PhoneLockTimeout property is less than 10 minutes (00 hours: 10 minutes: 00 seconds).
In turn, the filtered collection is piped to the Set-CsUCPhoneConfiguration cmdlet, which sets the PhoneLockTimeout value for each item in the collection to 10 minutes.
Parameters
-CalendarPollInterval
Indicates how often the UC device retrieves information from your Outlook calendar.
The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: -CalendarPollInterval "01:00:00".
The default value is 3 minutes (00:03:00).
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-EnforcePhoneLock
Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. The default value is True.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
Represents the unique identifier assigned to the collection of UC phone configuration settings. To refer to the global settings, use this syntax:
-Identity global
To refer to a collection configured at the site scope use syntax similar to this:
-Identity site:Redmond
Note that you cannot use wildcard characters when specifying an Identity.
If this parameter is omitted, then the Set-CsUCPhoneConfiguration cmdlet will modify the global settings.
| Type: | XdsIdentity |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Instance
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
| Type: | PSObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-LoggingLevel
Enables logging on the UC device. Valid values are Off; Low; Medium and High. The default value is Off.
| Type: | LoggingLevel |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-MinPhonePinLength
Specifies the minimum number of digits required for personal identification numbers (PINs).
Minimum value: 4
Maximum value: 15
Default: 6
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-PhoneLockTimeout
Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking.
This value must be less than 01:00:00 (1 hour). The default value is 00:10:00 (10 minutes).
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-SIPSecurityMode
Specifies the level of security that the server applies to SIP sessions initiated by a UC phone.
Valid values are:
Low (allow any type of authorization or transport).
Medium (NTLM or Kerberos is required for user authentication).
High (NTLM or Kerberos is required for user authentication and TLS is required for SIP connections).
The default value is High.
| Type: | SIPSecurityMode |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-Tenant
{{Fill Tenant Description}}
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Online |
-Voice8021p
Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment.
This setting is effective only for networks in which switches and bridges are 802.1p-capable. The minimum value for this property is 0 and the maximum value is 7. The default value is 0.
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-VoiceDiffServTag
Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server.
This value must be between 0 and 63, inclusive. The default value is 40.
| Type: | Byte |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object.
The Set-CsUCPhoneConfiguration cmdlet accepts pipelined instances of the UC phone settings object.
Outputs
The Set-CsUCPhoneConfiguration cmdlet does not return a value or object.
Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object.