Test-CsPhoneBootstrap
Topic Last Modified: 2012-03-26
Verifies that a user can log on to Microsoft Lync Server 2010 using a Microsoft Lync 2010 Phone Edition-compatible device.
Syntax
Test-CsPhoneBootstrap [-TargetFqdn <String>] -PhoneOrExt <String> -PIN <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetUri <String>] [-UserSipAddress <String>]
Detailed Description
In order to connect to Lync Server 2010, Lync 2010 Phone Edition-compatible devices need to use Dynamic Host Configuration Protocol (DHCP) to retrieve the address of a Lync Server Registrar; these devices must also provide a valid phone number and associated personal identification number (PIN) in order to be authenticated by the system. (This process is known as "bootstrapping".) The Test-CsPhoneBootstrap cmdlet enables administrators to verify that a given user -- using the phone number and PIN assigned to him or her -- is able to log on to the system from a Lync 2010 Phone Edition-compatible device. (No device is actually needed in order to run the test.)
In order for Test-CsPhoneBootstrap to make its check, the Registrar pool that hosts the user account being tested must be discoverable using DHCP. To determine whether a Registrar is discoverable in this manner, use the cmdlet Get-CsRegistrarConfiguration and check the value of the EnableDHCPServer property. If this property is set to False, you will need to use Set-CsRegistrarConfiguration to set the property value to True and make the Registrar discoverable using DHCP. This can also be done by using Enterprise DHCP Server and configuring the Lync Server-specific options.
Who can run this cmdlet: 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 "Test-CsPhoneBootstrap"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
PhoneOrExt |
Required |
String |
Telephone number or extension of the user account being tested. For example: -PhoneOrExt "+14255551219". |
PIN |
Required |
String |
PIN of the user account being tested. |
RegistrarPort |
Optional |
Integer |
SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. |
TargetFqdn |
Optional |
String |
Fully qualified domain name (FQDN) of the Registrar pool that hosts the user account to be tested. If not specified, then DHCP discovery will be used to locate the Registrar pool. |
TargetUri |
Optional |
String |
URL of the certificate provisioning service. If this parameter is not included, then the DHCP discovery will be used to locate the target URI. |
UserSipAddress |
Optional |
String |
SIP address for the user account used in the text; for example: -UserSipAddress "sip:kenmyer@litwareinc.com". The UserSIPAddress parameter must reference the supplied phone number and PIN; the test will fail if the included phone number and PIN do not belong to the user specified by the UserSipAddress parameter. Note that the SIP address must include the "sip:" prefix. |
OutVerboseVariable |
Optional |
String |
When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: -OutVerboseVariable TestOutput Do not prepend a $ character when specifying the variable name. |
Force |
Optional |
Guid |
Suppresses the display of any non-fatal error message that might occur when running the command. |
Verbose |
Optional |
String |
Reports detailed activity to the screen as the cmdlet runs. |
Input Types
None. Test-CsPhoneBootstrap does not accept pipelined input.
Return Types
Test-CsPhoneBootstrap returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 ------------------------
Test-CsPhoneBootstrap -PhoneOrExt "+14255551219" -Pin "0712"
The command shown in Example 1 verifies that the user with the specified phone number and PIN can connect to Lync Server using a Lync 2010 Phone Edition-compatible device. In order to run the test, the user’s phone number (+14255551219) and the user’s PIN (0712) must be supplied.
-------------------------- Example 2 ------------------------
Test-CsPhoneBootstrap -PhoneOrExt "+14255551219" -Pin "0712" -UserSipAddress "sip:kenmyer@litwareinc.com"
The preceding command verifies whether or not the user with the specified phone number and PIN can connect to Lync Server using a Lync 2010 Phone Edition-compatible device. In this example, the UserSipAddress parameter is included as an additional check: the test will fail if the user with the SIP address is not the same as the user with the specified phone number and PIN.