Get-TSTMGMTUsers
Get all the users from the Management Platform.
Written by
Last published at: December 9th, 2022Get all the users from the Management Platform
SYNTAX
Get-TSTMGMTUsers
-Folder <Folder> [-FolderName <string>] [-FolderId <guid>] [-Interface <guid>] [-Timeout <int>]
Get-TSTMGMTUsers
[-FolderName <string>] [-FolderId <guid>] [-Force] [-Interface <guid>] [-Timeout <int>]
DESCRIPTION
Get all the users from the Management Platform, if you only want users from a specific folder you must supply a Folder, FolderName or FolderId
EXAMPLES
1. Retrieve all users from the 'Support' folder
Get-TSTMGMTUsers
2. Retrieve all users from the 'Support' folder
Get-TSTMgmtUsers -FolderName '\Users\Support'
PARAMETERS
-Folder
Folder object to get Users from
| Type: | ThinScale.Management.DataObjects.Folder |
| Required: | Yes |
| Accept Pipeline Input: | Yes |
-FolderName
A fully qualified name of the folder to get Users from
| Type: | String |
| Required: | No |
| Accept Pipeline Input: | No |
-FolderId
The GUID of the folder to get Users from (not required if FolderName is 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
ThinScale.Management.DataObjects.Folder
OUTPUTS
ThinScale.Management.DataObjects.User