Get-TSTMGMTRoles
Get all the roles'details from the Management Platform.
Get all the roles'details from the Management Platform
SYNTAX
DESCRIPTION
Retrieves all roles from the Management Platform, if you only want roles from a specific folder you must supply a Folder, FolderName or FolderId
EXAMPLES
1. Retrieve all roles
2. Retrieve all roles from the 'Support' folder
PARAMETERS
-Folder
Folder object to get Roles from
Type: | ThinScale.Management.DataObjects.Folder |
Required: | Yes |
Accept Pipeline Input: | Yes |
-FolderName
A fully qualified name of the folder to get Roles from
Type: | String |
Required: | No |
Accept Pipeline Input: | No |
-FolderId
The GUID of the folder to get Roles 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.Role