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.

This guide walks you through installing the HPE OneView PowerShell Library, connecting to an appliance, and running a set of basic commands to verify everything is working.

​
Prerequisites

Before you begin, confirm your environment meets the following requirements:
RequirementMinimum version
PowerShell (Windows)5.1 or 7.x
PowerShell (Linux / macOS)7.x (PowerShell Core)
.NET Framework (Windows PS 5.1 only)4.7.2
HPE OneView appliance10.00
Windows PowerShell 4.0 and earlier are not supported. Windows 10 1709 (Fall Creators Update) or newer is required on Windows due to the .NET Framework 4.7.2 dependency.

​
Connect and run your first commands

1

Install the module

Install the library from the PowerShell Gallery. Run this command in an elevated PowerShell session (Run as Administrator on Windows).
Install-Module HPEOneView.1000
If you are prompted to trust the repository, enter Y to accept.
If you do not have administrator rights, install for the current user only:
Install-Module HPEOneView.1000 -Scope CurrentUser
2

Import the module

Load the module into your PowerShell session:
Import-Module HPEOneView.1000
Verify the module loaded correctly:
Get-Module HPEOneView.1000
You should see output showing the module name and version 10.0.4265.2221.
Only one version of the HPE OneView PowerShell library can be loaded at a time. If another HPEOneView.* module is already imported, the import will fail. Start a new PowerShell session if needed.
3

Connect to your appliance

Establish a session with your HPE OneView appliance using Connect-OVMgmt. Replace MyAppliance.FQDN.Name with your appliance’s hostname or IP address.
# Connect using a PSCredential object (recommended)
$credential = Get-Credential
Connect-OVMgmt -Hostname MyAppliance.FQDN.Name -Credential $credential
After a successful connection, the cmdlet returns a connection object and stores it in the $Global:ConnectedSessions variable.
# View active connections
$ConnectedSessions
You can connect to multiple appliances simultaneously. Each connection is tracked by hostname in $ConnectedSessions. Use the -ApplianceConnection parameter on subsequent cmdlets to target a specific appliance.
4

Retrieve server hardware

List all server hardware managed by the appliance:
Get-OVServer
To filter by name or retrieve a specific server:
# Get a server by name (supports wildcards)
Get-OVServer -Name "Encl1, bay 1"

# List all powered-off servers
Get-OVServer | Where-Object { $_.powerState -eq 'Off' }
5

Retrieve network resources

List Ethernet, Fibre Channel, and FCoE networks:
# Get all networks
Get-OVNetwork

# Get only Ethernet networks
Get-OVNetwork -Type Ethernet

# Get a specific network by name
Get-OVNetwork -Name "Production"
When Get-OVNetwork returns multiple network types (Ethernet, FC, FCoE), only the first type may render cleanly in table format due to a known FormatPX limitation. Pipe results to Format-List or filter by -Type to inspect all properties.
6

Retrieve server profiles

Server profiles define the configuration assigned to physical servers. Retrieve them with:
# List all server profiles
Get-OVServerProfile

# Get a specific profile
Get-OVServerProfile -Name "Web-Server-01"

# List profiles in an unassigned state
Get-OVServerProfile | Where-Object { $_.serverHardwareUri -eq $null }
7

Check appliance version

Confirm the library and appliance API version:
Get-OVVersion
This returns the library version (10.0.4265.2221) and the appliance X-API version (7600).
8

Disconnect from the appliance

Always close your session when you are finished:
# Disconnect from all active sessions
Disconnect-OVMgmt
To disconnect from a specific appliance when multiple connections are active:
Disconnect-OVMgmt -Hostname MyAppliance.FQDN.Name

​
Next steps

Installation guide

Detailed installation instructions for all platforms, including offline and WSL setups

Appliance connections

Learn how to manage multiple simultaneous appliance connections

Connecting to an appliance

Authentication options including credential objects and two-factor auth

Cmdlet reference

Browse the complete cmdlet reference for all supported operations

Build docs developers (and LLMs) love

Get started for freeTalk to us