[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Assigns a new PIN authentication number to the specified user. PIN authentication provides a way for users to access Microsoft Communications Server 2010 using a telephone that does not have an alphanumeric keyboard and thus cannot be used to enter the user name and password.


Set-CsClientPin -Identity <UserIdParameter> [-Pin <String>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Indicates the Identity of the user account whose PIN number should be locked. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's Universal Principal Name; 3) the user's domain name and logon name, in the form domain\logon (e.g., 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 SamAccountNames are not necessarily unique in a forest.

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




Optional PIN number to be assigned to the user. If you do not include the -PIN parameter then Communications Server 2010 will randomly generate a PIN number and assign it to the user in question. Note that the PIN number must adhere to the minimum length, PIN history count, and common pattern settings found in the client PIN policy assigned to the user.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Communications Server 2010 enables users to connect to the system, or to join PSTN (Public Switched Telephone Network) conferences via telephone. Typically, logging on to the system or joining a conference requires the user to enter a user name or password; unfortunately, entering a user name and password can be a problem if you are using a phone that does not have an alphanumeric keypad. Because of that, Communications Server 2010 enables you to supply users with numeric-only PIN numbers; when prompted, users can then log on to the system or join a conference by entering the PIN number instead of a user name and password.

Users are not assigned a PIN number when they are enabled for Communications Server 2010; that means that, by default, users cannot access the system using PIN authentication. To provide users with this capability, administrators must assign each user a PIN number; this can be done using the Set-CsClientPin cmdlet. With Set-CsClientPin you can either assign a user a specific PIN number or you can allow Communications Server 2010 to generate a PIN number for you. To auto-generate a PIN number, simply leave off the -PIN parameter when calling Set-CsClientPin. If you do that, a new PIN number will be generated, and the user Identity and the new PIN number will be displayed onscreen when the command completes.

Note that PIN numbers you explicitly assign must meet the conditions specified in the PIN authentication policy governing the user in question; for example, the PIN number must have at least as many digits as specified by the MinPasswordLength property. Note, too that PINs can contain only numbers; letters or other non-numeric characters are not allowed. See the help topic Set-CsPinPolicy for more information.

Return Types

Set-CsClientPin does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object.


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

Copy Code
Set-CsClientPin -Identity "litwareinc\kenmyer"

In Example 1, the user litwareinc\kenmyer is assigned a new auto-generated PIN number; to assign an auto-generated PIN you simply leave off the -Pin parameter when calling Set-CsClientPin. After the command completes the new PIN number assigned to Ken Myer will be displayed onscreen; that information can then be relayed to the user.

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

Copy Code
Set-CsClientPin -Identity "litwareinc\kenmyer" -Pin 18723834

The command in Example 2 assigns the PIN 18723834 to the user litwareinc\kenmyer. You assign a specific PIN number by using the -Pin parameter followed by the number to be assigned.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Set-CsClientPin

Example 3 shows how you can auto-assign new PIN numbers to all the users in a given Active Directory OU. To do this, Get-CsUser is used, along with the –OU parameter, in order to return a collection of all the users who have accounts in the Finance OU. That collection is then piped to Set-CsClientPin, which generates a new PIN number for each user in the collection.

-------------------------- Example 4 ------------------------

Copy Code
Get-CsUser | Get-CsClientPin | Where-Object {$_.IsPinSet -eq $False} | Set-CsClientPin

The command shown in Example 4 assigns a new PIN number to all the users who do not currently have a PIN number assigned to them. To accomplish this task, Get-CsUser is used to return a collection of all the users who have been enabled for Communications Server 2010. That collection is then piped to the Get-CsClientPin and Where-Object cmdlets; these two cmdlets work together to select only those users where the IsPinSet property is equal to (-eq) False ($False). The resulting subset, which contains only users who do not have a PIN number, is then piped to Set-CsClientPin, which auto-generates a PIN number for each user in the collection.