Set-TSTMGMTRole

Update the role's details within the Management Platform.

Written by David

Last published at: August 20th, 2020

Update the role's details within the Management Platform.


SYNTAX

Set-TSTMGMTRole

-Role <Role> [-RoleName <string>] [-RoleDescription <string>] [-AddTSTUsers <string[]>] [-AddTSTUserIds <guid[]>] [-RemoveTSTUsers<string[]>] [-RemoveTSTUserIds <guid[]>] [-AddDomainUsers <string[]>] [-RemoveDomainUsers <string[]>] [-RemoveAllUsers] [-Force] [-Interface <guid>][-Timeout <int>]


DESCRIPTION

Updates properties of an existing role in the Management Platform.


EXAMPLES

1. Add the user 'John' to the 'HelpDesk' role

        Get-TSTMGMTRole -RoleName '\Roles\Support\HelpDesk' | Set-TSTMGMTRole -AddTSTUsers '\Users\Support\John'

2. Update the 'HelpDesk' role description

        Get-TSTMGMTRole -RoleName '\Roles\Support\HelpDesk' | Set-TSTMGMTRole -RoleDescription 'Help Desk Staff'


PARAMETERS


-Role

Role object to update

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


-RoleName

New name for the role

Type: String
Required: No
Accept Pipeline Input: No


-RoleDescription

New description for the role

Type: String
Required: No
Accept Pipeline Input: No


-AddTSTUsers

Comma-delimited list of ThinScale Users to add to the role

Type: String[]
Required: No
Accept Pipeline Input: No


-AddTSTUserIds

Comma-delimited list of ThinScale UserId's to add to the role

Type: Guid[]
Required: No
Accept Pipeline Input: No


-RemoveTSTUsers

Comma-delimited list of ThinScale Users to remove from the role

Type: String[]
Required: No
Accept Pipeline Input: No


-RemoveTSTUserIds

Comma-delimited list of ThinScale UserId's to remove from the role

Type: Guid[]
Required: No
Accept Pipeline Input: No


-AddDomainUsers

Comma-delimited list of Domain Users to add to the role

Type: String[]
Required: No
Accept Pipeline Input: No


-RemoveDomainUsers

Comma-delimited list of Domain Users to remove from the role

Type: String[]
Required: No
Accept Pipeline Input: No


-RemoveAllUsers

Removes all users from the role

Type: SwitchParameter
Required: No
Accept Pipeline Input: No


-Force

If multiple Users 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.Role


OUTPUTS

ThinScale.Management.DataObjects.Role