Test-CsPhoneBootstrap

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Verifies that a user can log on to Skype for Business Server using a Phone Edition-compatible device. This cmdlet was introduced in Lync Server 2010.

Syntax

Test-CsPhoneBootstrap
    [[-TargetFqdn] <String>]
    -PhoneOrExt <String>
    -PIN <String>
    [-RegistrarPort <Int32>]
    [-TargetUri <String>]
    [-UserSipAddress <String>]
    [-Force]
    [-Verbose]
    [-OutVerboseVariable <String>]
    [-OutLoggerVariable <String>]
    -PhoneOrExtension <String>
    [<CommonParameters>]

Description

In order to connect to Skype for Business Server, Phone Edition-compatible devices need to use Dynamic Host Configuration Protocol (DHCP) to retrieve the address of a Skype for Business 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 Phone Edition-compatible device. (No device is actually needed in order to run the test.)

In order for the Test-CsPhoneBootstrap cmdlet 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 Get-CsRegistrarConfiguration cmdlet and check the value of the EnableDHCPServer property. If this property is set to False, you will need to use the Set-CsRegistrarConfiguration cmdlet 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 Skype for Business Server -specific options.

Examples

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

Test-CsPhoneBootstrap -PhoneOrExtension "+14255551219" -Pin "0712"

The command shown in Example 1 verifies that the user with the specified phone number and PIN can connect to Skype for Business Server using a 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 -PhoneOrExtension "+14255551219" -Pin "0712" -UserSipAddress "sip:kenmyer@litwareinc.com"

Example 2 verifies whether or not the user with the specified phone number and PIN can connect to Skype for Business Server using a 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.

Parameters

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-OutLoggerVariable

When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file.

To store output in a logger variable named $TestOutput use the following syntax:

-OutLoggerVariable TestOutput

Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this:

$TestOutput.ToHTML() \> C:\Logs\TestOutput.html

To save the information stored in the logger variable to an XML file, use a command similar to this:

$TestOutput.ToXML() \> C:\Logs\TestOutput.xml

Type:String
Aliases:olv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-OutVerboseVariable

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.

Type:String
Aliases:ovv
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-PhoneOrExt

Telephone number or extension of the user account being tested. For example: -PhoneOrExt "+14255551219".

Type:String
Aliases:ph
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013

-PhoneOrExtension

Telephone number or extension of the user account being tested. For example: -PhoneOrExt "+14255551219".

Type:String
Aliases:ph
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-PIN

PIN of the user account being tested.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-RegistrarPort

SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061.

Type:Int32
Aliases:rp
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-TargetFqdn

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.

Type:String
Aliases:t
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-TargetUri

URL of the certificate provisioning service. If this parameter is not included, then the DHCP discovery will be used to locate the target URI.

Type:String
Aliases:twsu
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-UserSipAddress

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.

Type:String
Aliases:ua
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Verbose

Reports detailed activity to the screen as the cmdlet runs.

Type:SwitchParameter
Aliases:vb
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010

Inputs

None. The Test-CsPhoneBootstrap cmdlet does not accept pipelined input.

Outputs

The Test-CsPhoneBootstrap cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.