Assigns a voice policy to one or more users or groups.
Syntax
Grant-CsVoicePolicy -Identity <UserIdParameter> [-PolicyName <String>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-PassThru <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
UserIdParameter |
The Identity (unique identifier) of the user to whom the policy is being assigned. User identities can be specified by using one of four formats: 1) The user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). Note that the SAMAccountName cannot be used as an identity; that's because these names are not necessarily unique in a forest. Note that you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" would return all the users with the last name Smith. Full Data Type: Microsoft.Rtc.Management.AD.UserIdParameter |
|
PolicyName |
Optional |
String |
The name (Identity) of the voice policy to be assigned to the user. (Note that this includes only the name portion of the Identity. Per-user policy identities include a prefix of tag: that should not be included with the PolicyName.) |
|
DomainController |
Optional |
Fqdn |
Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
|
PassThru |
Optional |
SwitchParameter |
Returns the results of the command. By default, this cmdlet does not generate any output. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Detailed Description
This cmdlet assigns an existing per-user voice policy to a user. Voice policies are used to manage such Enterprise Voice-related features as simultaneous ringing (the ability to have a second phone ring each time someone calls your office phone) and call forwarding. Use this cmdlet to assign the settings that enable and disable these features for a specific user.
You can check whether a user has been granted a per-user voice policy by calling a command in this format: Get-CsUser "<user name>" | Select-Object VoicePolicy. For example:
 Copy Code |
|
|---|---|
Get-CsUser "Ken Myer" | Select-Object VoicePolicy |
|
Return Types
This cmdlet does not return a value.
Examples
-------------------------- Example 1 --------------------------
| Copy Code |
|
|---|---|
Grant-CsVoicePolicy -Identity "Ken Myer" -PolicyName VoicePolicyRedmond |
|
This example assigns the voice policy with the Identity VoicePolicyRedmond to the user with the display name Ken Myer.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" | Grant-CsVoicePolicy -PolicyName VoicePolicyRedmond |
|
This example assigns the voice policy with the Identity VoicePolicyRedmond to all users in the OU OU=Finance,OU-NorthAmerica,DC=litwareinc,DC=com. The first part of the command calls the Get-CsUser cmdlet to retrieve all users enabled for Communications Server from the specified OU. This collection of users is then piped to the Grant-CsVoicePolicy cmdlet, which assigns the policy VoicePolicyRedmond to each of these users.