Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/HewlettPackard/POSH-HPEOneView/llms.txt

Use this file to discover all available pages before exploring further.

Synopsis

Returns the built-in role names recognized by an HPE OneView appliance.

Syntax

Get-OVRole
    [<CommonParameters>]

Description

Get-OVRole is deprecated. In the current library version, role information is returned as part of user account objects from Get-OVUser. The cmdlet emits a deprecation warning and takes no action. To view the roles assigned to a user, retrieve the user account with Get-OVUser and inspect the permissions property of the returned object.
This cmdlet is deprecated and will be removed in a future release. Use Get-OVUser to inspect role assignments.

Parameters

This cmdlet accepts no parameters.

Built-in roles

The following roles are built into every HPE OneView appliance:
Role nameScope of access
Infrastructure administratorFull administrative access to all resources and settings.
Server administratorManage server hardware, including power operations and firmware.
Network administratorManage networks, network sets, uplink sets, and logical switches.
Storage administratorManage storage systems, storage pools, and volumes.
Read onlyView all resources with no ability to make changes.
Backup administratorCreate and restore appliance backups.
Scope operatorPerform operations within assigned scopes.
Scope administratorManage scope definitions and membership.
Role names are case-insensitive when passed to -Roles in New-OVUser or Set-OVUser.

Examples

View roles assigned to a user

$user = Get-OVUser -Name 'jsmith'
$user.permissions
Retrieves the jsmith account and displays its role and scope assignments.

List all users and their roles

Get-OVUser | Select-Object userName, permissions
Returns every local user account with its permissions array.

Output

This cmdlet produces no output. See Get-OVUser for user and role data.