Skip to content

New HPOVUser

Jump to bottom
Chris Lynch edited this page Aug 18, 2017 · 43 revisions

Library Version 3.10

Library Version 3.00

Library Version 2.00

Library Version 1.20

HPE OneView 3.10 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>] [-ApplianceConnection] <Object>[ [-Enabled] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Create a new local user account on the management appliance

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectSessions}

Aliases Appliance
Required? true
Position? 7
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-EmailAddress <String>

Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.

Aliases None
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Enabled <SwitchParameter>

Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-HPOVUser Cmdlet.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-FullName <String>

Full name for the user.

Aliases None
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-MobilePhone <String>

Mobile phone number.

Aliases None
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-OfficePhone <String>

Office phone number.

Aliases None
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Password <String>

The initial password to be assigned to the new user. Passwords must be at least 8 characters.

Aliases None
Required? true
Position? 1
Default value
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
* Software Administrator (For HPE Synergy and ImageStreamer only)
Aliases None
Required? true
Position? 3
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-UserName <String>

The name of the new user account to be created.

Aliases None
Required? true
Position? 0
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]

If successful, returns a user resource

Examples

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

New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles "server administrator","network administrator"

Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected appliances.

Related Links

HPE OneView 3.00 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>] [-ApplianceConnection] <Object>[ [-Enabled] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Create a new local user account on the management appliance

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectSessions}

Aliases Appliance
Required? true
Position? 7
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-EmailAddress <String>

Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.

Aliases None
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Enabled <SwitchParameter>

Deprecated parameter. By default, all new user accounts will be enabled. In order to disable a user account, use the Set-HPOVUser Cmdlet.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-FullName <String>

Full name for the user.

Aliases None
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-MobilePhone <String>

Mobile phone number.

Aliases None
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-OfficePhone <String>

Office phone number.

Aliases None
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Password <String>

The initial password to be assigned to the new user. Passwords must be at least 8 characters.

Aliases None
Required? true
Position? 1
Default value
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
* Software Administrator (For HPE Synergy and ImageStreamer only)
Aliases None
Required? true
Position? 3
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-UserName <String>

The name of the new user account to be created.

Aliases None
Required? true
Position? 0
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

HPOneView.Appliance.User [System.Management.Automation.PSCustomObject]

If successful, returns a user resource

Examples

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

PS C:\> New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles "server administrator","network administrator"

Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected appliances.

Related Links

HPE OneView 2.00 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array> [-EmailAddress] <String> [-officePhone] <String> [-mobilePhone] <String> [-ApplianceConnection] <Object>[ [-enabled] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Create a new local user account on the management appliance

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? true
Position? 7
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-EmailAddress <String>

Provide the users email address. This does not set the Email Notification value when configuring SMTP Notifications.

Aliases None
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-FullName <String>

Full name for the user.

Aliases None
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Password <String>

The initial password to be assigned to the new user. Passwords must be at least 8 characters.

Aliases None
Required? true
Position? 1
Default value
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? true
Position? 3
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-UserName <String>

The name of the new user account to be created.

Aliases None
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-enabled <SwitchParameter>

Indicates if the user account is enabled, allowing the user to log into the appliance. Default to true.

Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    False

-mobilePhone <String>

Mobile phone number.

Aliases None
Required? true
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-officePhone <String>

Office phone number.

Aliases None
Required? true
Position? 5
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 (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this Cmdlet.

Return Values

System.Management.Automation.PSCustomObject

If successful, returns a user resource.

Examples

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

PS C:\> New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles @("server administrator","network administrator")

Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles, on all connected appliances.

Related Links

HPE OneView 1.20 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-userName] <userName> [-password] <password>[ [-fullName] <fullName>] [-roles] <roles>[ [-emailAddress] <emailAddress>][ [-officePhone] <officePhone>][ [-mobilePhone] <mobilePhone>][ [-enabled] <enabled>] [<CommonParameters>]

Detailed Description

Create a new local user account on the management appliance

Parameters

-userName <userName>

The name of the new user account to be created.

Aliases None.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-password <password>

The initial password to be assigned to the new user. Passwords must be at least 8 characters.

Aliases None.
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-fullName <fullName>

Full name for the user

Aliases None.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-roles <roles>

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? true
Position? 4
Default value @()
Accept pipeline input? false
Accept wildcard characters?    false

-emailAddress <emailAddress>

Optional email address

Aliases None.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-officePhone <officePhone>

Optional office phone number

Aliases None.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-mobilePhone <mobilePhone>

Optional mobile phone number

Aliases None.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters?    false

-enabled <enabled>

Indicates if the user account is enabled, allowing the user to log into the appliance. Default to true.

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)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

System.Management.Automation.PSCustomObject

If successful, returns a user resource.

Examples

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

PS C:\> New-HPOVUser -username Sally -fullName "Sally Smith" -password SallysPassword -roles @("server administrator","network administrator")

Create the Sally user account, and assigning to the Server Administrator and Network Administrator roles.

Related Links

Wiki Table of Contents

Clone this wiki locally