Library Version 1.10

Library Version 1.06


HP OneView 1.10 Library

NAME

Set-HPOVUser

SYNOPSIS

Modify an existing user account.

SYNTAX

Set-HPOVUser [-userName] <String> [[-password] <String>] [[-fullName] <String>] [[-roles] <Array>] [[-emailAddress] <String>] [[-officePhone] <String>] [[-mobilePhone] <String>] [-enabled] [-disabled] [<CommonParameters>]

DESCRIPTION

Modify or update an existing local user account on the management appliance

PARAMETERS

-userName <String>
The name of the new user account to be modified.
Aliases None
Required? true
Position? 1
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-password [<String>]

OPTIONAL. New password for the user account.

Passwords must be at least 8 characters.

Aliases None
Required? false
Position? 2
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-fullName [<String>]
OPTIONAL. Updated Full Name of the User Account.
Aliases None
Required? false
Position? 3
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-roles [<Array>]
An array list of roles to assign the user to. Allowed values are:
  • Infrastructure Administrator
  • Read Only
  • Backup Administrator
  • Network Administrator
  • Server Administrator
  • Storage administrator
Aliases None
Required? false
Position? 4
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false
-emailAddress [<String>]
OPTIONAL. Updated Email Address of the User Account.
Aliases None
Required? false
Position? 5
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-officePhone [<String>]
OPTIONAL. Updated office phone of the User Account.
Aliases None
Required? false
Position? 6
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-mobilePhone [<String>]
Optional mobile phone number
Aliases None
Required? false
Position? 7
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-enabled [<SwitchParameter>]
OPTIONAL. Enable the local user account.
Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    false
-disabled [<SwitchParameter>]
OPTIONAL. Disable the local user account.
Aliases None
Required? false
Position? named
Default value False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None. You cannot pipe objects to this cmdlet.

OUTPUTS

System.Management.Automation.PSCustomObject

If successful, returns a user resource.

RELATED LINKS

EXAMPLES

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

PS C:\> Set-HPOVUser -username Sally -roles @("server administrator","network administrator")

Update the user account 'Sally' with new roles.
-------------------------- EXAMPLE 2 -------------------------- 

PS C:\> Set-HPOVUser -username Sally -password NewP@ssw0rd

Update the user account 'Sally' with a new password.

HP OneView 1.06 Library

NAME

Set-HPOVUser

SYNOPSIS

Modify an existing user account.

SYNTAX

Set-HPOVUser [-userName] <String> [[-password] <String>] [[-fullName] <String>] [[-roles] <Array>] [[-emailAddress] <String>] [[-officePhone] <String>] [[-mobilePhone] <String>] [-enabled] [-disabled] [<CommonParameters>]

DESCRIPTION

Modify or update an existing local user account on the management appliance

PARAMETERS

-userName <String>
The name of the new user account to be modified.
Aliases None
Required? true
Position? 1
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-password [<String>]

OPTIONAL. New password for the user account.

Passwords must be at least 8 characters.

Aliases None
Required? false
Position? 2
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-fullName [<String>]
OPTIONAL. Updated Full Name of the User Account.
Aliases None
Required? false
Position? 3
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-roles [<Array>]
An array list of roles to assign the user to. Allowed values are:
  • Infrastructure Administrator
  • Read Only
  • Backup Administrator
  • Network Administrator
  • Server Administrator
Aliases None
Required? false
Position? 4
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false
-emailAddress [<String>]
OPTIONAL. Updated Email Address of the User Account.
Aliases None
Required? false
Position? 5
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-officePhone [<String>]
OPTIONAL. Updated office phone of the User Account.
Aliases None
Required? false
Position? 6
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-mobilePhone [<String>]
Optional mobile phone number
Aliases None
Required? false
Position? 7
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-enabled [<SwitchParameter>]
OPTIONAL. Enable the local user account.
Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    false
-disabled [<SwitchParameter>]
OPTIONAL. Disable the local user account.
Aliases None
Required? false
Position? named
Default value False
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None. You cannot pipe objects to this cmdlet.

OUTPUTS

System.Management.Automation.PSCustomObject

If successful, returns a user resource.

RELATED LINKS

EXAMPLES

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

PS C:\> Set-HPOVUser -username Sally -roles @("server administrator","network administrator")

Update the user account 'Sally' with new roles.
-------------------------- EXAMPLE 2 -------------------------- 

PS C:\> Set-HPOVUser -username Sally -password NewP@ssw0rd

Update the user account 'Sally' with a new password.

Last edited Aug 19, 2014 at 11:31 PM by chrislynchhp, version 3