Get-TSTMGMTFolders

Get the folders' details from the Management Platform.

Written by Giuseppe

Last published at: August 20th, 2020

Get the folders' details from the Management Platform


SYNTAX

Get-TSTMGMTFolders

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


DESCRIPTION


Retrieves all folders from the Management Platform, if you only want folders from within a specific folder you must supply a Folder, FolderName or FolderId

EXAMPLES

1. Retrieve all folders within the Management Platform

        Get-TSTMGMTFolders


2. Retrieve all folders from the '\Profiles' folder

        Get-TSTMGMTFolders -FolderName '\Profiles' 


PARAMETERS


-FolderName

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: 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


-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: String (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


INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

ThinScale.Management.DataObjects.Folder