Set-vRAUserPrincipal

NAME Set-vRAUserPrincipal



SYNOPSIS

Update a vRA local user principal





SYNTAX

Set-vRAUserPrincipal [-Id] <String> [[-Tenant] <String>] [[-FirstName] <String>] [[-LastName] <String>]

[[-EmailAddress] <String>] [[-Description] <String>] [[-Password] <SecureString>] [-DisableAccount]

[-EnableAccount] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Update a vRA Principal (user)





PARAMETERS

-Id <String>

The principal id of the user



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Tenant <String>

The tenant of the user



Required? false

Position? 2

Default value $Global:vRAConnection.Tenant

Accept pipeline input? false

Accept wildcard characters? false



-FirstName <String>

First Name



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-LastName <String>

Last Name



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-EmailAddress <String>

Email Address



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

Users text description



Required? false

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Password <SecureString>

Users password



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DisableAccount [<SwitchParameter>]

Disable the user principal



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-EnableAccount [<SwitchParameter>]

Enable or unlock the user principal



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String

System.SecureString

System.Diagnostics.Switch





OUTPUTS

System.Management.Automation.PSObject





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-vRAUserPrincipal -Id user@vsphere.local -FirstName FirstName-Updated -LastName LastName-Updated

-EmailAddress userupdated@vsphere.local -Description Description-Updated













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Set-vRAUserPrincipal -Id user@vsphere.local -EnableAccount













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Set-vRAUserPrincipal -Id user@vsphere.local -DisableAccount













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>$SecurePassword = ConvertTo-SecureString ???????P@ssword??????? -AsPlainText -Force



Set-vRAUserPrincipal -Id user@vsphere.local -Password SecurePassword











RELATED LINKS