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.

The HPE OneView PowerShell Library is published to the PowerShell Gallery and supports Windows PowerShell 5.1, PowerShell 7.x on Windows, and PowerShell Core 7.x on Linux and macOS.

​
Prerequisites

RequirementDetails
PowerShell versionWindows PowerShell 5.1, or PowerShell 7.x
.NET Framework (Windows PS 5.1)4.7.2 or newer (requires Windows 10 1709+)
.NET (PowerShell 7.x)Bundled with PowerShell 7 — no separate install needed
PowerShellGetIncluded with PowerShell 5.1+; update with Install-Module PowerShellGet if needed
Windows PowerShell 4.0 and earlier are not supported. Windows 10 1709 (Fall Creators Update, build 16299) or newer is required when using Windows PowerShell 5.1, because the library’s C# class assembly targets .NET Standard 2.1 and requires .NET Framework 4.7.2.
1

Open an elevated PowerShell session

Right-click Windows PowerShell or PowerShell 7 and select Run as Administrator.If you cannot use an elevated session, install for the current user instead (see the tip at the end of this step).
2

Install the module

Install-Module HPEOneView.1000
If prompted to trust the PSGallery repository, enter Y.
To install without administrator rights, scope the install to the current user:
Install-Module HPEOneView.1000 -Scope CurrentUser
3

Verify the installation

Get-Module HPEOneView.1000 -ListAvailable
The output should list the module with version 10.0.4265.2221.
4

Import the module

Import-Module HPEOneView.1000
Confirm it is loaded and check the library version:
Get-OVVersion
If you are running Windows PowerShell 5.1 and receive an error about a missing .NET Framework dependency when importing the module, download and install the .NET Framework 4.7.2 offline installer and then retry.

​
Offline / manual installation

If the target system does not have internet access, use Save-Module on a connected machine to download the module files, then copy and install them manually.
1

Save the module on a connected machine

On a machine with internet access and PowerShell, save the module to a local directory:
Save-Module -Name HPEOneView.1000 -Path C:\Temp\Modules
This downloads all module files including the required HPEOneView_Classes.dll assembly into C:\Temp\Modules\HPEOneView.1000\10.0.4265.2221\.
2

Transfer the files to the target system

Copy the saved module directory to the target machine via USB, file share, or any available transfer method.
3

Place the module in a PowerShell module path

Move the module folder to one of the directories listed in $env:PSModulePath.System-wide (all users):
# Windows example
C:\Program Files\PowerShell\Modules\HPEOneView.1000\10.0.4265.2221\
Current user only:
# Windows example
$HOME\Documents\PowerShell\Modules\HPEOneView.1000\10.0.4265.2221\
4

Import and verify

Import-Module HPEOneView.1000
Get-Module HPEOneView.1000

​
Verifying the installation

Use these commands to confirm the module is installed and available: 
# List installed module versions
Get-Module HPEOneView.1000 -ListAvailable

# Import the module
Import-Module HPEOneView.1000

# Show library and API version information
Get-OVVersion
Get-OVVersion returns the library version (10.0.4265.2221) and the supported HPE OneView X-API version (7600).

​
Module version compatibility

Each library version targets a specific HPE OneView appliance API version. Choose the library version that matches your HPE OneView appliance.
Library moduleHPE OneView versionPowerShell Gallery
HPEOneView.100010.00HPEOneView.1000
HPEOneView.9109.10HPEOneView.910
HPEOneView.9009.00HPEOneView.900
HPEOneView.6606.60HPEOneView.660
The library module version number corresponds directly to the HPE OneView appliance version. Use HPEOneView.1000 with HPE OneView 10.00 appliances.

​
Known limitations

The HPE OneView PowerShell library does not support loading multiple versions in the same PowerShell session. If you attempt to import a second version while one is already loaded, the import will fail with an error:
Another HPE OneView module is already loaded. The HPE OneView PowerShell library
does not support loading multiple versions of libraries within the same console.
Start a new PowerShell session to switch between library versions.
On Windows, the library uses FormatPX to fix formatting inconsistencies in Format-List and Format-Table. FormatPX is not supported on PowerShell Core.As a result, when Get-OVNetwork returns results with multiple network resource types (Ethernet, Fibre Channel, FCoE), only the first type will render correctly in table format. The remaining types will display their full raw object properties.Workaround: Filter by network type to get consistent output:
Get-OVNetwork -Type Ethernet
Get-OVNetwork -Type FibreChannel
Get-OVNetwork -Type FibreChannelOverEthernet
Get-OVCommandTrace generates a trace log, but due to a limitation in the .NET Standard API, verbose and debug messages emitted by the HPE OneView C# class library are not automatically captured in the trace file.If you enable verbose or debug output via [HPEOneView.Config]::EnableVerbose = $true or [HPEOneView.Config]::EnableDebug = $true, use Select All and copy/paste the console output into the generated log file when reporting issues.

​
Next steps

Quickstart

Connect to your appliance and run your first commands

Appliance connections

Learn how multiple simultaneous connections work

Build docs developers (and LLMs) love

Get started for freeTalk to us