Set-CsIPPhonePolicy

Use the Set-CsIPPhonePolicy cmdlet to modify the settings of the Skype for Business Online and Skype for Business Server 2019 global IP phone policy. IP phone policies define the Skype for Business features that are available to users.

Syntax

Set-CsIPPhonePolicy
   [-Tenant <Guid>]
   [-UserDialTimeoutMS <UInt64>]
   [-KeyboardLockMaxPinRetry <UInt64>]
   [-PrioritizedCodecsList <String>]
   [-EnablePowerSaveMode <Boolean>]
   [-PowerSaveDuringOfficeHoursTimeoutMS <UInt64>]
   [-PowerSavePostOfficeHoursTimeoutMS <UInt64>]
   [-EnableOneTouchVoicemail <Boolean>]
   [-DateTimeFormat <Int32>]
   [-EnableDeviceUpdate <Boolean>]
   [-EnableExchangeCalendaring <Boolean>]
   [-EnableBetterTogetherOverEthernet <Boolean>]
   [-BetterTogetherOverEthernetPairingMode <String>]
   [-LocalProvisioningServerUser <String>]
   [-LocalProvisioningServerPassword <String>]
   [-LocalProvisioningServerAddress <String>]
   [-LocalProvisioningServerType <String>]
   [[-Identity] <XdsIdentity>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CsIPPhonePolicy
   [-Tenant <Guid>]
   [-UserDialTimeoutMS <UInt64>]
   [-KeyboardLockMaxPinRetry <UInt64>]
   [-PrioritizedCodecsList <String>]
   [-EnablePowerSaveMode <Boolean>]
   [-PowerSaveDuringOfficeHoursTimeoutMS <UInt64>]
   [-PowerSavePostOfficeHoursTimeoutMS <UInt64>]
   [-EnableOneTouchVoicemail <Boolean>]
   [-DateTimeFormat <Int32>]
   [-EnableDeviceUpdate <Boolean>]
   [-EnableExchangeCalendaring <Boolean>]
   [-EnableBetterTogetherOverEthernet <Boolean>]
   [-BetterTogetherOverEthernetPairingMode <String>]
   [-LocalProvisioningServerUser <String>]
   [-LocalProvisioningServerPassword <String>]
   [-LocalProvisioningServerAddress <String>]
   [-LocalProvisioningServerType <String>]
   [-Instance <PSObject>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

IP phone policies are applied each time a user accesses the system via an IP phone device. The Set-CsIPPhonePolicy cmdlet enables you to modify the global IP phone policy that has been configured in your organization.

Examples

-------------------------- Example 1 --------------------------

Set-CsIPPhonePolicy -UserDialTimeoutMS 10000

This example modifies the global IP phone policy UserDialTimeoutMS parameter to 10 seconds (10000 ms).

-------------------------- Example 2 --------------------------

Set-CsIPPhonePolicy -EnablePowerSaveMode $False -EnableOneTouchVoicemail $False -EnableDeviceUpdate $False

This example sets the EnablePowerSaveMode, EnableOneTouchVoicemail and EnableDeviceUpdate parameters to $false.

Parameters

-BetterTogetherOverEthernetPairingMode

Valid values are: Auto - The phone will get paired with BTOE app Automatically and no need for the user to enter the pairing code. Manual - The user needs to enter the pairing code manually to pair with the BTOE app.

Type:String
Position:Named
Default value:Manual
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-DateTimeFormat

Specifies the time format to be used. The acceptable values are "24" for a 24 hour time format, or "12" for a 12 hour format. The default is "24".

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-EnableBetterTogetherOverEthernet

Specifies whether the Better Together Over Ethernet (BTOE) feature is enabled for users. If $true, and if the BTOE plugin is installed on the IP device, the user can tether the device to a PC and sign in to Skype for Business. The default is $true.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-EnableDeviceUpdate

Specifies whether the IP device will be updated by the Skype for Business service. If set to $true, IP devices will get firmware updates from the service, if $false the device will not be updated. The default is $true.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-EnableExchangeCalendaring

Specifies whether an IP device is enabled to connect to the Exchange Online calendaring service. If $true, users are able to connect to their Exchange calendars. If $false, users will not be able to connect to their calendars. The default is $true.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-EnableOneTouchVoicemail

Specifies whether the Visual Voicemail feature in Skype for Business Online is enabled. If set to $true, the feature is enabled, otherwise $false.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-EnablePowerSaveMode

If enabled, phone goes to power saving mode (display turns off) based on values of the PowerSaveDuringOfficeHoursTimeoutMS and PowerSavePostOfficeHoursTimeoutMS parameters.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-Force

The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-Identity

This parameter is reserved for internal Microsoft use.

Type:XdsIdentity
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-KeyboardLockMaxPinRetry

Specifies the maximum number of retries allowed for phone unlock. The default is 5.

Type:UInt64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-LocalProvisioningServerAddress

Specifies the address of the provisioning server for your organization.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-LocalProvisioningServerPassword

Specifies the password for the provisioning server.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-LocalProvisioningServerType

Specifies the server type for the phone. The default is FTP.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-LocalProvisioningServerUser

Specifies a username for the provisioning server.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-PowerSaveDuringOfficeHoursTimeoutMS

Specifies the time in milliseconds to wait during office hours before turning on Power Save mode. The default is 900,000.

Type:UInt64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-PowerSavePostOfficeHoursTimeoutMS

Specifies the time in milliseconds to wait after office hours before turning on Power Save mode. The default is 300,000.

Type:UInt64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-PrioritizedCodecsList

Specifies the order in which to prioritize codecs. The default is: "G722_8000;PCMU;PCMA;G729"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-Tenant

This parameter is reserved for internal Microsoft use.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-UserDialTimeoutMS

Specifies the time in milliseconds to wait in On-Hook mode before dialing out automatically. If a user enters a phone number and does not click Dial, the system will dial the number after the number of milliseconds specified. The default is 5000.

Type:UInt64
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019
-WhatIf

System.Management.Automation.SwitchParameter

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online, Skype for Business Server 2019

Inputs

System.Management.Automation.PSObject

Microsoft.Rtc.Management.ADConnect.Schema.ADUser

Outputs

System.Object

The Set-CsIPPhonePolicy cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object.