New-TSTMGMTUserAssignment

Add a new User Assignment within the Management Platform

Written by Ines

Last published at: December 14th, 2022

Add a new User Assignment within the Management Platform.

 

SYNTAX

 -UserAssignmentName <string> [-ParentId <guid>] [-Description <string>] [-Force] [-GroupMembers <string[]>] [-Interface <guid>] [-Timeout <int>]

-UserAssignmentName <string> [-ParentFolder <Folder>] [-ParentId <guid>] [-Description <string>] [-GroupMembers <string[]>] [-Interface <guid>] [-Timeout <int>]

 

 

 

DESCRIPTION

Adds a new User Assignment to the Management Platform. You can specify a fully qualified path to the new user assignment or a relative one supplying a ParentFolder or ParentId.

 

EXAMPLE

Add a UserAssignment called ‘Support’ with the Support Group from AD as members.

        

New-TSTMGMTUserAssignment -UserAssignmentName '\User Assignments\Support' -Description 'User Assignment for all members of the Support Group in AD' -GroupMembers 'CN=Support,OU=Groups,OU=mydomain,DC=mydomain,DC=local'

 

 

 

 

PARAMETERS

 

-UserAssignmentName

Fully qualified or relative name of the user assignment to create

Type: String
Required: Yes
Accept Pipeline Input: No

 

-ParentId

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

Type: Guid
Required: No
Accept Pipeline Input: No

 

-ParentFolder

A folder object in which the user assignment is to be created (only required if UserAssignmentName is a relative path)

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

 

-Description

Description for the user assignment

Type: String
Required: No
Accept Pipeline Input: No

 

-GroupMembers

Comma delimted list of user groups to add to the User Assignment

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 user 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.User