Syntax


`Grant-CsDialPlan -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 dial plan is being assigned. User identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's 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 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 Identity value of the dial plan to be assigned to the user. (Note that this includes only the name portion of the Identity. Per-user dial plan 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.
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.
Confirm	Optional	SwitchParameter	Prompts you for confirmation before executing the command.

Detailed Description

This cmdlet assigns an existing user-specific dial plan to a user. Dial plans provide information required to enable Enterprise Voice users to make telephone calls. Users who do not have a valid dial plan will not be enabled to make calls by using Enterprise Voice. A dial plan determines such things as how normalization rules are applied and whether a prefix must be dialed for external calls.

You can check whether a user has been granted a per-user dial plan by calling a command in this format: Get-CsUser "<user name>" | Select-Object DialPlan. For example:

Get-CsUser "Ken Myer" | Select-Object DialPlan

Who can run this cmdlet: By default, members of the following groups are authorized to run the Grant-CsDialPlan cmdlet locally: RTCUniversalUserAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Grant-CsDialPlan"}

Input Types

String. Accepts a pipelined string value representing the Identity of a user account to which the dial plan is being granted.

Return Types

When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact.

Example

-------------------------- Example 1 --------------------------

	Copy Code
Grant-CsDialPlan -Identity "Ken Myer" -PolicyName RedmondDialPlan

In the example shown above, Grant-CsDialPlan is used to assign the dial plan RedmondDialPlan to the user with the Identity (in this case the display name) Ken Myer.

-------------------------- Example 2 --------------------------

	Copy Code
Get-CsUser -LDAPFilter "l=Redmond" \| Grant-CsDialPlan -PolicyName RedmondDialPlan

In Example 2, the RedmondDialPlan dial plan is assigned to all the users who have offices in the city of Redmond. To do this, the cmdlet Get-CsUser is invoked in order to retrieve a collection of all the users who have an office in the city of Redmond; this is done by using the LDAPFilter parameter and the LDAP query l=Redmond. (In the LDAP query language used by Active Directory Domain Services (AD DS), the l indicates a user's locality, or city.) This collection is then piped to Grant-CsDialPlan, which assigns the Redmond dial plan to each user in the collection.