Set-CsTeamsIPPhonePolicy

Reference

Module:: MicrosoftTeamsPowerShell

Applies to:: Microsoft Teams

Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing Teams phone policy settings.

Syntax

Set-CsTeamsIPPhonePolicy
   [[-Identity] <XdsIdentity>]
   [-AllowBetterTogether <String>]
   [-AllowHomeScreen <String>]
   [-AllowHotDesking <Boolean>]
   [-Confirm]
   [-Description <String>]
   [-Force]
   [-HotDeskingIdleTimeoutInMinutes <Int>]
   [-Instance <Object>]
   [-SearchOnCommonAreaPhoneMode <String>]
   [-SignInMode <String>]
   [-Tenant <Guid>]
   [-WhatIf]
   [<CommonParameters>]

Description

Set-CsTeamsIPPhonePolicy enables you to modify the properties of an existing TeamsIPPhonePolicy.

Examples

Example 1

PS C:\> Set-CsTeamsIPPhonePolicy -Identity CommonAreaPhone -SignInMode CommonAreaPhoneSignin

This example shows the SignInMode "CommonAreaPhoneSignIn" being set against the policy named "CommonAreaPhone".

Parameters

-AllowBetterTogether

Determines whether Better Together mode is enabled, phones can lock and unlock in an integrated fashion when connected to their Windows PC running a 64-bit Teams desktop client. Possible values this parameter can take:

Enabled
Disabled

Type:	String
Position:	Named
Default value:	Enabled
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowHomeScreen

Determines whether the Home Screen feature of the Teams IP Phones is enabled. Possible values this parameter can take:

Enabled
EnabledUserOverride
Disabled

Type:	String
Position:	Named
Default value:	EnabledUserOverride
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AllowHotDesking

Determines if the hot desking feature is enabled or not. Set this to TRUE to enable. Set this to FALSE to disable hot desking mode.

Type:	Boolean
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Free form text that can be used by administrators as desired.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Suppresses any confirmation prompts that would otherwise be displayed before making changes and suppresses the display of any non-fatal error message that might arise when running the command.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HotDeskingIdleTimeoutInMinutes

Determines the idle timeout value in minutes for the signed in user account. When the timeout is reached, the account is logged out.

Type:	Int
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Identity

The identity of the policy. To specify the global policy for the organization, use "global". To specify any other policy provide the name of that policy.

Type:	XdsIdentity
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SearchOnCommonAreaPhoneMode

Determines whether a user can look up contacts from the tenant's global address book when the phone is signed into the Common Area Phone Mode. Set this to ENABLED to enable the feature. Set this to DISABLED to disable the feature.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SignInMode

Determines the sign in mode for the device when signing in to Teams. Possible Values:

'UserSignIn: Enables the individual user's Teams experience on the phone'
'CommonAreaPhoneSignIn: Enables a Common Area Phone experience on the phone'
'MeetingSignIn: Enables the meeting/conference room experience on the phone'

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tenant

Internal Microsoft use only.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.Management.Automation.PSObject

Outputs

System.Object

Share via