Set-CsIPPhonePolicy

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

Syntax

Set-CsIPPhonePolicy
   [[-Identity] <XdsIdentity>]
   [-BetterTogetherOverEthernetPairingMode <String>]
   [-Confirm]
   [-DateTimeFormat <Int>]
   [-EnableBetterTogetherOverEthernet <Boolean>]
   [-EnableDeviceUpdate <Boolean>]
   [-EnableExchangeCalendaring <Boolean>]
   [-EnableOneTouchVoicemail <Boolean>]
   [-EnablePowerSaveMode <Boolean>]
   [-Force]
   [-Instance <PSObject>]
   [-KeyboardLockMaxPinRetry <UInt64>]
   [-LocalProvisioningServerAddress <String>]
   [-LocalProvisioningServerPassword <String>]
   [-LocalProvisioningServerType <String>]
   [-LocalProvisioningServerUser <String>]
   [-PowerSaveDuringOfficeHoursTimeoutMS <UInt64>]
   [-PowerSavePostOfficeHoursTimeoutMS <UInt64>]
   [-PrioritizedCodecsList <String>]
   [-Tenant <Guid>]
   [-UserDialTimeoutMS <UInt64>]
   [-WhatIf]
   [-AsJob]
   [<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 EnablePowerSaveModeproperty, EnableOneTouchVoicemailvalues, and EnableDeviceUpdate parameters to $false.

Optional Parameters

-AsJob

Indicates that this cmdlet runs as a background job.

When you specify the AsJob parameter, the command immediately returns an object that represents the background job. You can continue to work in the session while the job finishes. The job is created on the local computer and the results from the Skype for Business Online session are automatically returned to the local computer. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs and about_Remote_Jobs.

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

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:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Online
-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
-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
-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 Online. 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
-EnableDeviceUpdate

Specifies whether the IP device will be updated by the Skype for Business Online 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
-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 enabled 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
-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
-EnablePowerSaveMode

If enabled, phone goes to power savings 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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-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
-WhatIf

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

Inputs

System.Management.Automation.PSObject

Microsoft.Rtc.Management.ADConnect.Schema.ADUser

Outputs

System.Object

By default, the Set-CsIPPhonePolicy cmdlet returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object.