Set HPOVUserRole - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Set-HPOVUserRole

(Deprecated) Assign or change roles for an existing user.

SYNTAX

Set-HPOVUserRole [-Name] <Object> [-Roles] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This CMDLET is now deprecated. Please use the Set-HPOVUser CMDLET to modify user accounts and associated roles/permissions

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

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

-Name <Object>

Aliases [-user, -username] The name of the user account to have a role assigned.

Aliases user, userName
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
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 roleName
Required? true
Position? 1
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

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

HPE OneView applinace user account

Return Values

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

Updated user account with new role(s)

Examples

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

Set-HPOVUserRole -user Sally -roleName "Server Administrator"

Set the Server Administrator role for Sally"s user account.

Related Links


Top

HPE OneView 4.00 Library

Set-HPOVUserRole

(Deprecated) Assign or change roles for an existing user.

SYNTAX

Set-HPOVUserRole [-Name] <Object> [-Roles] <Array> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

This CMDLET is now deprecated. Please use the Set-HPOVUser CMDLET to modify user accounts and associated roles/permissions

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

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

-Name <Object>

Aliases [-user, -username] The name of the user account to have a role assigned.

Aliases user, userName
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
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 roleName
Required? true
Position? 1
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

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

HPE OneView applinace user account

Return Values

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

Updated user account with new role(s)

Examples

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

Set-HPOVUserRole -user Sally -roleName "Server Administrator"

Set the Server Administrator role for Sally's user account.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️