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

Verifies that a user can log on to Microsoft Communications Server “14” using a Communications Server Phone Edition device.

Syntax


Test-CsPhoneBootstrap [-TargetFqdn <String>] -PhoneOrExt <String> -PIN <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetCertProvWsURL <String>] [-UserSipAddress <String>]

Test-CsPhoneBootstrap [-TargetFqdn <String>] -PhoneOrExt <String> -PIN <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetCertProvWsURL <String>] [-UserSipAddress <String>]

Parameters

Parameter	Required	Type	Description
TargetFqdn	Optional	String	Fully qualified domain name of the registrar pool that hosts the user account to be tested. If not specified the registrar pool of the logged-on user will be used in the test.
TargetCertProvWsURL	Optional	String	URL of the certificate provisioning service. If this parameter is not included then the Test-CsPhoneBootstrap will use the certificate provisioning service configured for the registrar pool.
PhoneOrExt	Required	String	Telephone number or extension of the user account being tested. For example: -PhoneOrExt "+14255551219".
PIN	Required	String	PIN number of the user account being tested.
UserSipAddress	Optional	String	SIP address for the user account to be tested. For example: -UserSipAddres "sip:kenmyer@litwareinc.com". The UserSIPAddress parameter must reference the supplied phone number and PIN number. If the SIP address is not specified then Test-CsPhoneBootstrap will conduct its test using the SIP address of the logged-on user.
RegistrarPort	Optional	Integer	SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.
Verbose	Optional	String	Reports detailed activity to the screen as the cmdlet runs.
Force	Optional	Guid	Suppresses the display of any non-fatal error message that might arise when running the command.

Detailed Description

In order to connect to Microsoft Communications Server, Communications Server Phone Edition devices need to use DHCP to retrieve the address of a Communications Server registrar; these devices must also provide a valid phone number and associated PIN number 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 number assigned to him or her – is able to log on to the system from a Phone Edition device. (However, 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.

Return Types

Examples

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

	Copy Code
Test-CsPhoneBootstrap -PhoneOrExt "+14255551219" -Pin "0712"

The command shown in Example 1 verifies that the logged-on user can connect to Microsoft Communications Server using a Phone Edition device. In order to run the test, the user’s phone number (+14255551219) and the user’s PIN number (0712) must be supplied.

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

	Copy Code
Test-CsPhoneBootstrap -PhoneOrExt "+14255551219" -Pin "0712" -UserSipAddress "sip:kenmyer@litwareinc.com"

The preceding command verifies whether or not a specific user – kenmyer@litwareinc.com -- can connect to Microsoft Communications Server using a Phone Edition device. To do this, you must specify Ken Myer’s SIP address in addition to his phone number and PIN number.