Edit

Share via


Set-CsTeamsIPPhonePolicy

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

Syntax

Default (Default)

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

Parameter properties

Type:String
Default value:Enabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowHomeScreen

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

  • Enabled
  • EnabledUserOverride
  • Disabled

Parameter properties

Type:String
Default value:EnabledUserOverride
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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'

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tenant

Internal Microsoft use only.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Management.Automation.PSObject

Outputs

System.Object