Get-TSTMGMTDevice

Get the details of a device from the Management Platform.

Written by Giuseppe

Last published at: November 9th, 2022

Get the details of a device from the Management Platform


SYNTAX

Get-TSTMGMTDevice

        [-DeviceName <string>] [-DeviceId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Get the details of the device from the Management Platform. You can specify a fully qualified or relative name of the device to create


EXAMPLES

1. Get the details of a device called 'W10_ULTRON'

        Get-TSTMGMTDevice -DeviceName '\Devices\Testing PowerShell\W10_ULTRON'  


         2. Get the details of a device using a device Id

        Get-TSTMGMTDevice -DeviceId 'ABEEF049-BC24-4FD6-9EB3-186F863C30A2'


PARAMETERS


-DeviceName

Fully qualified or relative name of the device

Type: String
Required: No
Accept Pipeline Input: No


-DeviceId

        The GUID of the device (only required if DeviceName is not supplied)

Type: Guid
Required: No
Accept Pipeline Input: No


-Interface

The interface ID returned by a previously successful call to Connect-TSTMGMTServer. This parameter is only required if you are connected to 2 or more Management Platform instances at the same time. If this parameter is not specified the connection to the last successful call to Connect-TSTMgmtServer will be used.

Type: Guid
Required: No
Accept Pipeline Input: No


-Timeout

The time allowed in milliseconds for the call to complete before it is deemed to have timed out and is aborted

Type: Int32
Required: No
Accept Pipeline Input: No


-Force

         If the path for the new folder does not exist then it will be created

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


INPUTS

None


OUTPUTS

ThinScale.Management.DataObjects.Device