NAME

Get-DcsUser

SYNOPSIS

Returns one or all registered users in a server group.

SYNTAX

Get-DcsUser   [ -User <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsUser   [ -Current]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns one or all registered users in a server group. If no parameters are specified, all users in the default connection will be returned.

PARAMETERS

-User<Object>
UserData object, name, or ID that identifies a user. If specified, only data for that user will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Current<SwitchParameter>
Specify this parameter to get user data for the user that is currently logged-in.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

UserData : Object that identifies and describes a registered software user.

OUTPUTS

UserData : Object that identifies and describes a registered software user.

NOTES

Also see Add-DcsUser, Get-DcsUserRole.

EXAMPLES


-------------- Example 1 Returns data for all users --------------
Get-DcsUser
		

Returns data for all users in the server group.

Name:Administrator
Description:User with the Owners role
EmailAddress:
BlendedPrivileges:ViewInformation
   
IsAdministrator:True
RoleIds:{{DAD4B92D-BFC8-4628-A313-51D8B2F57083}}
Sequencenumber:3433
Id:7edfb6ed-8f24-4138-a23b-2843600d939d
Caption:Administrator
ExtendedCaption:Administrator
Internal:False
   
Name:Joe Schmoe
Description:
EmailAddress:
BlendedPrivileges:ViewInformation, ConfigureVVols
   
IsAdministrator:False
RoleIds:{{E1077253-9FD3-4460-A39A-7A13AF1E885E}}
Sequencenumber:3434
Id:2acfbe83-5af0-426e-8420-6e8ce0711d04
Caption:Joe Schmoe
ExtendedCaption:Joe Schmoe
Internal:False
   
Name:Larry C. Moe
Description:
EmailAddress:
BlendedPrivileges:ViewInformation
   
IsAdministrator:False
RoleIds:{{B1210FAD-5DAC-4a7b-B3D6-EEB8DFFE1F7A}}
Sequencenumber:3563
Id:4c3cf2d1-b2c7-462c-97da-9db62e0b3805
Caption:Larry C. Moe
ExtendedCaption:Larry C. Moe
Internal:False
   

-------------- Example 2 Returns user data for the user that is currently logged in. --------------
Get-DcsUser -Current
		

Returns user data for the user that is currently logged in by specifying the -Current parameter.

Name:Administrator
Description:User with the Owners role
EmailAddress:
BlendedPrivileges:ViewInformation
   
IsAdministrator:True
RoleIds:{{DAD4B92D-BFC8-4628-A313-51D8B2F57083}}
Sequencenumber:3560
Id:7edfb6ed-8f24-4138-a23b-2843600d939d
Caption:Administrator
ExtendedCaption:Administrator
Internal:False