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

Retrieves one or more network resources (Ethernet, Fibre Channel, or FCoE) from the connected HPE OneView appliance.

​
Syntax

Get-OVNetwork
    [-Name <String>]
    [-Type <String>]
    [-Purpose <String>]
    [-Label <String>]
    [-Scope <Object>]
    [-ApplianceConnection <Object>]
    [-ExportFile <String>]
    [<CommonParameters>]

​
Description

Get-OVNetwork queries the HPE OneView appliance for network resources. When no parameters are specified, the cmdlet returns all Ethernet, Fibre Channel, and FCoE networks visible within the current scope. You can narrow results by name, type, purpose, or label. Wildcard characters are supported in the -Name parameter.

​
Parameters

​
Name
String
The name of the network resource to retrieve. Supports wildcard characters (*, ?). When omitted, all networks are returned.
​
Type
String
Filter results to a specific network type. Accepted values:
  • Ethernet
  • FC / FibreChannel
  • FCOE
  • ROCE
When omitted, all network types are returned.
​
Purpose
String
Filter Ethernet networks by their configured purpose. Accepted values:
  • General
  • Management
  • VMMigration
  • FaultTolerance
  • ISCSI
​
Label
String
Filter results by a resource label assigned to the network.
​
Scope
Object
Filter results to resources that belong to the specified scope. Defaults to AllResourcesInScope.
​
ApplianceConnection
Object
The appliance connection object or name. Defaults to the default connected session (${Global:ConnectedSessions}).
​
ExportFile
String
Path to a JSON file where the retrieved network objects will be exported.

​
Examples

​
Return all networks

Get-OVNetwork

​
Return all Ethernet networks

Get-OVNetwork -Type Ethernet

​
Return a specific network by name

Get-OVNetwork -Name "Production Fabric A" -Type FibreChannel

​
Use a wildcard to list networks with a common prefix

Get-OVNetwork -Name "Prod Vlan *" -Type Ethernet

​
Filter Ethernet networks by purpose

Get-OVNetwork -Type Ethernet -Purpose Management

​
Retrieve networks and pass them to another cmdlet

$Networks = "red", "blue", "green" | Get-OVNetwork -Type Ethernet

​
Output

HPEOneView.Networking.EthernetNetwork, HPEOneView.Networking.FibreChannelNetwork, or HPEOneView.Networking.FCoENetwork objects depending on network type.