Grant-CsIPPhonePolicy

 

Topic Last Modified: 2016-01-21

Use the Grant-CsIPPhonePolicy cmdlet to assign an Internet Protocol (IP) phone policy to a user or a group of users. IP phone policies determine the features of Skype for Business Online that are available to users. For example, you might enable the Better Together Over Ethernet feature for some users while disabling it for others.

Grant-CsIPPhonePolicy -PolicyName <String> [-Identity <UserIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-PassThru <SwitchParameter>] [-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]

This example assigns the IP phone policy "SkypePolicy" to the user with the identity "Ken Myer".

Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName SkypePolicy

This example assigns all the users in the "Sales" department to the "SalesPolicy" IP phone policy. The command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who are members of the "Sales" department. This collection of users is piped to the Grant-CsIPPhonePolicy cmdlet, which assigns "SalesPolicy" to each user in the collection.

Get-CsUser -LDAPFilter "Department=Sales" | Grant-CsIPPhonePolicy -PolicyName SalesPolicy

Skype for Business Online uses IP phone policies to determine the features and capabilities that are available to users. IP phone policies are applied each time a user accesses the system, regardless of where the user logs on from.

 

Parameter Required Type Description

PolicyName

Required

System.String

Specifies the name of the policy to be assigned. The PolicyName is the policy Identity minus the policy scope ("tag:"). For example, a policy that has the identity "tag:Redmond" has a PolicyName equal to "Redmond". If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. For example: Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing, and requires confirmation to proceed.

DomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

This parameter is reserved for internal Microsoft use.

Identity

Optional

Microsoft.Rtc.Management.AD.UserIdParameter

Specifies the identity of the target user. Acceptable values include:

  • User Principal Name (UPN)

    Example: jphillips@contoso.com

  • SIPAddress

    Example: sip:jphillips@contoso.com

  • GUID

    Example: 98403f08-577c-46dd-851a-f0460a13b03d

PassThru

Optional

System.Management.Automation.SwitchParameter

Including this switch enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the pipeline.

Tenant

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

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 Grant-CsIPPhonePolicy cmdlet accepts pipelined input of Microsoft.Rtc.Management.ADConnect.Schema.ADUser objects.

By default, the Grant-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.

 
Show: