Grant-CsCallViaWorkPolicy

  • Reference
Module:
SkypeForBusiness
Applies to:
Skype for Business Server 2015, Skype for Business Server 2019

Use the Grant-CsCallViaWorkPolicy cmdlet to assign call via work policies to a user or group of users. Call via work policies enable and manage the characteristics of outbound calls placed through the Skype for Business client.

Syntax

Grant-CsCallViaWorkPolicy
     [-Identity] <UserIdParameter>
     [-PolicyName] <String>
     [-Confirm]
     [-DomainController <Fqdn>]
     [-PassThru]
     [-WhatIf]
     [<CommonParameters>]

Description

This cmdlet assigns an existing per-user call via work policy to a user. Call via work policies are used to control access to the feature and manage the characteristics of outbound calls placed through the Skype for Business client.

Examples

-------------------------- Example 1 -------------------------- (Skype for Business Server 2015)

Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName StandardUserCvW

This example assigns the policy named "StandardUserCvW" to "Ken Myer".

Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-DomainController

Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. If this parameter is not specified, then the Grant-CsCallViaWorkPolicy cmdlet will contact the first available domain controller.

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-Identity

Specifies a unique identifier of the user account the policy should be assigned to. User identities can be specified by using one of four formats.

SIP address

User Principal Name (UPN)

Domain name and logon name, in the form domain\logon

Active Directory display name (Ken Myer), or distinguished name

In addition, you can use the asterisk (*) wildcard character when using the display name as the user Identity. For example, the Identity "* Smith" grants the policy all users who have a display name that ends in the string value " Smith".

Type:UserIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-PassThru

Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsCallViaWorkPolicy cmdlet does not pass objects through the pipeline.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-PolicyName

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

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-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
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None.

Outputs

None.