Skip to content

New HPOVUser

Chris Lynch edited this page Dec 10, 2020 · 43 revisions

HPE OneView 4.10 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-UserName] <String> [-Password] <String> [-FullName] <String> [-Roles] <Array>[ [-ScopePermissions] <Array>][ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>][ [-Enabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<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? named
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? named
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? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-MobilePhone <String>

Mobile phone number.

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

-OfficePhone <String>

Office phone number.

Aliases None
Required? false
Position? named
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? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Roles <Array>

Aliases [-r, -role] The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable.

Example: $roles = "Server administrator","Network administrator"

Aliases None
Required? true
Position? named
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-ScopePermissions <Array>

Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings.

Example: -ScopePermissions @{Role = "Network administrator"; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }

Aliases None
Required? False
Position? named
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? 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 (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 4.00 Library

New-HPOVUser

Create a new user account.

SYNTAX

New-HPOVUser [-UserName] <String> [-Password] <String> [-Roles] <Array> [-FullName] <String>[ [-ScopePermissions] <Array>][ [-EmailAddress] <String>][ [-OfficePhone] <String>][ [-MobilePhone] <String>][ [-Enabled] <SwitchParameter>] [-ApplianceConnection] <Object> [<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? named
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? named
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? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-MobilePhone <String>

Mobile phone number.

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

-OfficePhone <String>

Office phone number.

Aliases None
Required? false
Position? named
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? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Roles <Array>

Aliases [-r, -role] The role(s) to assign to the Directroy Group, in System.Collections.ArrayList format. Accepted values are noted within the ApplianceRoles property of the HPOneView.Appliance.Connection object stored in the $Global:ConnectedSessions variable.

Example: $roles = "Server administrator","Network administrator"

Aliases None
Required? true
Position? named
Default value @()
Accept pipeline input? false
Accept wildcard characters?    False

-ScopePermissions <Array>

Array collection of Hashtable<Role; Scope>. Will overwrite existing scope to role mappings.

Example: -ScopePermissions @{Role = 'Network administrator'; Scope = (Get-HPOVScope -Name CorpNetAdmins -ErrorAction Stop) }

Aliases None
Required? False
Position? named
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? 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 (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


Wiki Table of Contents

Clone this wiki locally