Retrieves information about the PIN authentication settings for 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.
Syntax
Get-CsClientPinInfo -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
UserIdParameter |
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. 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". |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
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.
Administrators can retrieve the PIN settings for a user, or a group of users, by running the Get-CsClientPinInfo cmdlet. Note that there is no way for an administrator to retrieve the PIN number that has been assigned to a user. If someone forgets his or her PIN number then they will not be able to use PIN authentication to access the system, at least not until an administrator has assigned them a new PIN number. See the help topic Set-CsClientPin for more information.
Return Types
Get-CsClientPin returns one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsUser | Get-CsClientPinInfo |
|
The preceding command returns PIN information for all the users who have been enabled for Microsoft Communications Server. To do this, the command first calls Get-CsUser to return all the Communications Server-enabled users. That collection is piped to Get-CsClientPinInfo, which then displays PIN information for each user in the collection.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsClientPinInfo -Identity "litwareinc\kenmyer" |
|
In Example 2, Get-CsClientPinInfo is used to display PIN information for a single user: the user with the Identity litwareinc\kenmyer.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Get-CsClientPinInfo |
|
Example 3 returns PIN information for all the users with accounts in the Finance OU. To do this, Get-CsUser, and the -OU parameter, is first used to return a collection of all the users in the Finance OU. That collection is then piped to Get-CsClientPinInfo, which displays PIN information for each user in the collection.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsUser -LDAPFilter "Title=Manager" | Get-CsClientPinInfo |
|
The command shown in Example 4 displays PIN information for all the Managers in the organization. To retrieve a collection of all the Managers, the command uses Get-CsUser and the -LDAPFilter parameter; the filter "Title=Manager" limits the returned collection to users who have "Manager" as their job title. Get-CsClientPinInfo is then used to display PIN information for each of these users.