Get-TSTMGMTFolder
Get the details of a folder from the Management Platform.
Written by
Last published at: December 9th, 2022Get the details of a folder from the Management Platform.
SYNTAX
Get-TSTMGMTFolder
[[-FolderName] <string>] [[-FolderId] <guid>] [[-Force]] [-Interface <guid>]
DESCRIPTION
Get the details of a folder from the Management Platform. You can specify a fully qualified FolderName or a FolderId
EXAMPLES
1. Get a folder called 'Production ThinKiosk' from the devices node using a fully qualified name
2. Get a folder using the FolderId
PARAMETERS
-FolderName
The fully qualified name of the folder
| Type: | String |
| Required: | Yes |
| Accept Pipeline Input: | No |
-FolderId
The GUID of the folder (only required if FolderName is not supplied)
| Type: | Guid |
| 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 |
-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 |
INPUTS
None
OUTPUTS
ThinScale.Management.DataObjects.Folder