New HPOVUser - HewlettPackard/POSH-HPEOneView GitHub Wiki

Create a new user account.

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

Create a new local user account on the management appliance

-ApplianceConnection <Object>

Aliases [-Appliance]

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

Default Value: ${Global:ConnectSessions}

-EmailAddress <String>

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

-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.

-FullName <String>

Full name for the user.

-MobilePhone <String>

Mobile phone number.

-OfficePhone <String>

Office phone number.

-Password <String>

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

-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"

-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) }

-UserName <String>

The name of the new user account to be created.

<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)

None. You cannot pipe objects to this cmdlet.

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

If successful, returns a user resource

 -------------------------- 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.

• Get-HPOVUser
• Remove-HPOVUser
• Set-HPOVUser
• Set-HPOVUserPassword
• Set-HPOVUserRole
• Show-HPOVUserSession

Create a new user account.

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

Create a new local user account on the management appliance

-ApplianceConnection <Object>

Aliases [-Appliance]

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

Default Value: ${Global:ConnectSessions}

-EmailAddress <String>

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

-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.

-FullName <String>

Full name for the user.

-MobilePhone <String>

Mobile phone number.

-OfficePhone <String>

Office phone number.

-Password <String>

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

-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"

-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) }

-UserName <String>

The name of the new user account to be created.

<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)

None. You cannot pipe objects to this cmdlet.

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

If successful, returns a user resource

 -------------------------- 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.

• Get-HPOVUser
• Remove-HPOVUser
• Set-HPOVUser
• Set-HPOVUserPassword
• Set-HPOVUserRole
• Show-HPOVUserSession