New-TSTMGMTRole

Add a new role within the Management Platform.

Written by David

Last published at: August 20th, 2020

Add a new role within the Management Platform


SYNTAX

New-TSTMGMTRole

 -RoleName <string> -RoleDescription <string> [-ParentId <guid>] [-Force] [-TSTMembers <string[]>] [-TSTMemberIds <guid[]>][-DomainMemberSIDs <string[]>] [-Interface <guid>] [-Timeout <int>]

New-TSTMGMTRole

-RoleName <string> -RoleDescription <string> -ParentFolder <Folder> [-ParentId <guid>] [-TSTMembers <string[]>] [-TSTMemberIds<guid[]>] [-DomainMemberSIDs <string[]>] [-Interface <guid>] [-Timeout <int>]


DESCRIPTION

Add a new role within the Management Platform. You can specify a fully qualified role name or a relative one supplying a ParentFolder or a ParentId.


EXAMPLES

1. Add a role called 'HelpDesk' using RoleName

        New-TSTMGMTRole -RoleName '\Roles\HelpDesk' -RoleDescription 'All Help Desk Users'


2. Add a role called 'HelpDesk' and add the 'Administrator' user

        New-TSTMGMTRole -RoleName '\Roles\HelpDesk' -RoleDescription 'All Help Desk Users' -TSTMembers '\Users\Administrator'

PARAMETERS


-RoleName

Fully qualified or relative name of the role to create

Type: String
Required: Yes
Accept Pipeline Input: No


-ParentId

The GUID of the folder the role is to be created in (only required if RoleName is not fully qualified)

Type: Guid
Required: No
Accept Pipeline Input: No


-ParentFolder

Parent Folder object

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


-RoleDescription

Description of the role

Type: String
Required: Yes
Accept Pipeline Input: No


-TSTMembers

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

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


-TSTMemberIds

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

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


-DomainMemberSIDs

Comma-delimited list of domain user SID's to add to the role

Type: String[]
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


-Force

        If the path for the new role does not exist then it will be created

Type: SwitchParameter)
Required: No
Accept Pipeline Input: No



INPUTS

ThinScale.Management.DataObjects.Folder


OUTPUTS

ThinScale.Management.DataObjects.Role