Set-CsIPPhonePolicy

 

Topic Last Modified: 2016-01-21

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.

Set-CsIPPhonePolicy [-Identity <XdsIdentity>] <COMMON PARAMETERS>

Set-CsIPPhonePolicy [-Instance <PSObject>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DateTimeFormat <Int32>] [-EnableBetterTogetherOverEthernet <$true | $false>] [-EnableDeviceUpdate <$true | $false>] [-EnableExchangeCalendaring <$true | $false>] [-EnableOneTouchVoicemail <$true | $false>] [-EnablePowerSaveMode <$true | $false>] [-Force <SwitchParameter>] [-KeyboardLockMaxPinRetry <UInt64>] [-LocalProvisioningServerAddress <String>] [-LocalProvisioningServerPassword <String>] [-LocalProvisioningServerType <String>] [-LocalProvisioningServerUser <String>] [-PowerSaveDuringOfficeHoursTimeoutMS <UInt64>] [-PowerSavePostOfficeHoursTimeoutMS <UInt64>] [-PrioritizedCodecsList <String>] [-Tenant <Guid>] [-UserDialTimeoutMS <UInt64>] [-WhatIf [<SwitchParameter>]]

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

Set-CsIPPhonePolicy -UserDialTimeoutMS 10000

This example sets the EnablePowerSaveModeproperty, EnableOneTouchVoicemailvalues, and EnableDeviceUpdate parameters to $false.

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

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.

 

Parameter Required Type Description

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

DateTimeFormat

Optional

System.Int32

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".

EnableBetterTogetherOverEthernet

Optional

System.Boolean

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.

EnableDeviceUpdate

Optional

System.Boolean

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.

EnableExchangeCalendaring

Optional

System.Boolean

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.

EnableOneTouchVoicemail

Optional

System.Boolean

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

EnablePowerSaveMode

Optional

System.Boolean

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

Force

Optional

System.Management.Automation.SwitchParameter

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.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

This parameter is reserved for internal Microsoft use.

Instance

Optional

System.Management.Automation.PSObject

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.

KeyboardLockMaxPinRetry

Optional

System.UInt64

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

LocalProvisioningServerAddress

Optional

System.String

Specifies the address of the provisioning server for your organization.

LocalProvisioningServerPassword

Optional

System.String

Specifies the password for the provisioning server.

LocalProvisioningServerType

Optional

System.String

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

LocalProvisioningServerUser

Optional

System.String

Specifies a username for the provisioning server.

PowerSaveDuringOfficeHoursTimeoutMS

Optional

System.UInt64

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

PowerSavePostOfficeHoursTimeoutMS

Optional

System.UInt64

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

PrioritizedCodecsList

Optional

System.String

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

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

UserDialTimeoutMS

Optional

System.UInt64

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.

WhatIf

Optional

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.

The Set-CsIPPhonePolicy cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IPPhone.IPPhonePolicy object.

The Set-CsIPPhonePolicy cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IPPhone.IPPhonePolicy object.

 
Show: