Set-CsTestDevice
Topic Last Modified: 2012-03-25
Modifies one or more of the device update management test devices that have been configured for use in your organization. Test devices provide a way for administrators to test firmware updates before those updates are distributed to all the devices in an organization.
Syntax
Set-CsTestDevice [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Identifier <String>] [-IdentifierType <MACAddress | SerialNumber>] [-WhatIf [<SwitchParameter>]]
Set-CsTestDevice [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Identifier <String>] [-IdentifierType <MACAddress | SerialNumber>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]
Detailed Description
By identifying specific phones running Microsoft Lync 2010 Phone Edition 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 Microsoft Lync Server 2010, 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 created by using the New-CsTestDevice cmdlet. After a test device has been created, you can then use the Set-CsTestDevice cmdlet to change the Identifier and the IdentifierType of that device, or any other test device.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-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 "Set-CsTestDevice"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Xds Identity |
Indicates the Identity of the test device to be modified. For example: -Identity site:Redmond/UCPhoneTestDevice. Note that you cannot use wildcards when specifying an Identity. |
Instance |
Optional |
Test device object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
Identifier |
Required |
String |
Based on the IdentifierType, indicates the Media Access Control (MAC) address or serial number of the new test device. Serial numbers can be specified using numbers, letters, hyphens and underscores; for example: -Identifier "AB37_679e" MAC addresses must be specified as six or more two-character pairs; depending on the MAC address, these pairs can be a single string value or they can be separated using hyphens or colons. (Note that MAC addresses can include both letters and/or numbers.) Each of the following are valid MAC addresses: 010203040506 01-02-03-04-05-06 01:02:03:04:05:06 A MAC address such as 01-02-03-04-05 will not be accepted because it does not have at least six two-character pairs. |
IdentifierType |
Required |
String |
Indicates whether the test device will be uniquely identified by its MAC address or by its serial number. To identify a device by its MAC address, set the IdentifierType to MACAddress. To identify a device by its serial number, set the IdentifierType to SerialNumber. MACAddress and SerialNumber are the only allowed values. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur 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. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. Set-CsTestDevice accepts pipelined input of the test device object.
Return Types
Set-CsTestDevice does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object.
Example
-------------------------- Example 1 ------------------------
Set-CsTestDevice -Identity site:Redmond/UCPhone -Identifier "09768-ABDR-83295"
The preceding command modifies the Identifier property for the test device named UCPhone assigned to the Redmond site.
-------------------------- Example 2 ------------------------
Set-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber -Identifier "09768-ABDR-83295"
The command shown in Example 2 also modifies the test device named UCPhone assigned to the Redmond site. In this case, however, the command not only specifies a new Identifier but also assigns a new IdentifierType: SerialNumber.