Get-TSTMGMTUser

Get the user's details from the Management Platform.

Written by David

Last published at: August 20th, 2020

Get the user's details from the Management Platform


SYNTAX

Get-TSTMGMTUser

        [-UserName <string>] [-UserId <guid>] [-Force] [-Interface <guid>]


DESCRIPTION

Retrieves a user's details from the Management Platform


EXAMPLES

1. Retrieve the user 'John'

Get-TSTMGMTUser -UserName '\Users\Support\John'


PARAMETERS


-UserName

The fully qualified name of the user

Type: String
Required: No
Accept Pipeline Input: No


-UserId

The GUID of the user (only required if UserName is not 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

None


OUTPUTS

ThinScale.Management.DataObjects.User