Get-TSTMGMTDevices

Get the details of all devices within a folder from the Management Platform.

Written by Giuseppe

Last published at: November 9th, 2022

Get the details of all devices within a folder from the Management Platform


SYNTAX

Get-TSTMGMTDevices

[-FolderName <string>] [-FolderId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]

Get-TSTMGMTDevices

        -Folder <Folder> [-FolderName <string>] [-FolderId <guid>] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Get the details of all devices within a folder from the Management Platform. You can use a fully qualified FolderName or a FolderId.


EXAMPLES

1. Get the details of all devices within a folder (full path required) called 'Testing Powershell'

        Get-TSTMGMTDevices -FolderName '\Devices\Testing Powershell'  


2. Get the details of all devices within a folder using the FolderId

         Get-TSTMGMTDevices -FolderId '48E089C2-EAF2-4A93-BE98-BE7BAA8425FA'


PARAMETERS


-FolderName

The fully qualified name of the folder to get Devices from

Type: String
Required: No
Accept Pipeline Input: No


-FolderId

        The GUID of the folder to get Devices from (not required if FolderName is supplied)

Type: String (GUID)
Required: No
Accept Pipeline Input: No


-Folder

         Folder object to get Devices from

Type: ThinScale.Management.DataObjects.Folder
Required: Yes
Accept Pipeline Input: Yes


-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 multiple objects are found with the same name, the first retrieved will be used otherwise the call will fail

Type: SwitchParameter
Required: No
Accept Pipeline Input: No



INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

 ThinScale.Management.DataObjects.Device