Export (0) Print
Expand All
Expand Minimize

Remove-CsTestDevice

 

Topic Last Modified: 2013-02-21

Removes the specified device update management test device. Test devices provide a way for administrators to test firmware updates before those updates are distributed to all the devices in an organization. This cmdlet was introduced in Lync Server 2010.

Remove-CsTestDevice -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Example 1 removes all the test devices from the Redmond site. This will remove the device collection as well as the individual test devices.

Remove-CsTestDevice -Identity site:Redmond

The command shown in Example 2 removes all the test devices configured for use in the organization; this is done by using the Get-CsTestDevice cmdlet to return all the test device collections, and then piping all of those items to the Remove-CsTestDevice cmdlet. Note that the global test device collection cannot be removed; however, this command will delete all the individual test devices configured at the global level.

Get-CsTestDevice | Remove-CsTestDevice

In Example 3, all the test devices configured at the site scope are removed. To carry out this task, the Get-CsTestDevice cmdlet and the Filter parameter are used to return all the test devices that have an Identity that begins with the string value "site:". This filtered collection is then piped to the Remove-CsTestDevice cmdlet, which deletes all the items in the collection.

Get-CsTestDevice -Filter "site:" | Remove-CsTestDevice

The command shown in Example 4 deletes all the LG-Nortel Phone test devices. To do this, the command first calls the Get-CsTestDevice cmdlet to return all the test devices configured for use in the organization. That information is then piped to the Where-Object cmdlet, which uses the -match operator to return any devices that have the string value "LG-Nortel" anywhere in the Name property. Any test device meeting that criterion is then deleted by using the Remove-CsTestDevice cmdlet.

Get-CsTestDevice | Where-Object {$_.Name -match "LG-Nortel Phone"} | Remove-CsTestDevice

By identifying specific Lync Phone Edition-compatible phones or other devices as test devices, administrators can verify and approve firmware updates before those updates are rolled out to all the relevant devices in the organization. When device update rules are imported to Lync Server, they are marked as "pending," which means that the updates corresponding to these rules will not automatically be downloaded and installed by the affected devices.

Instead, these pending rules will be downloaded and installed by any relevant test devices. That’s the idea behind test devices: new device update rules are automatically applied to test devices, giving administrators the opportunity to verify that the firmware updates work as expected. If they do, those administrators can then mark the rules as approved; approved rules are then downloaded and installed by all the relevant devices in the organization.

Test devices are hardware devices that run Lync Server. These devices are created by using the New-CsTestDevice cmdlet. Once created, the devices can later be removed by running the Remove-CsTestDevice cmdlet. Note that removing the device as a test device does not affect the actual device itself; for example, your Lync Phone Edition–compatible phone can still be used to access Lync Server. The only difference is that, because the device is no longer a test device, it will no longer download device update rules that are in the pending state. Instead, the device will wait until the rules have been approved before downloading and installing them.

The Remove-CsTestDevice cmdlet can be used to remove individual test devices configured at either the global or site scope. You can also use the cmdlet to remove all the test devices configured for a given scope.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsTestDevice cmdlet locally: RTCUniversalServerAdmins. 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 "Remove-CsTestDevice"}

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

Indicates the Identity of the test device to be removed. To remove a specific device, include both the scope (for example, site:Redmond) and the device name; for example: -Identity "site:Redmond/UCPhoneTest". To remove all the devices from a particular site use syntax similar to this: -Identity "site:Redmond".

Test devices can also be removed from the global scope. The global test device collection itself cannot be removed; however, the following command will delete all the devices stored in the global collection:

Remove-CsTestDevice –Identity global

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

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

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. The Remove-CsTestDevice cmdlet accepts pipelined input of the test device object.

The Remove-CsTestDevice cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft