Skip to content

Get HPOVNetwork

Chris Lynch edited this page Dec 10, 2020 · 47 revisions

HPE OneView 4.10 Library

Get-HPOVNetwork

Retrieve Network resource(s).

SYNTAX

Get-HPOVNetwork [-Name] <String> [-Type] <String>[ [-Purpose] <String>][ [-Scope] <Object>] [-Label] <String> [-ApplianceConnection] <Object> [-exportFile] <String> [<CommonParameters>]

Detailed Description

Obtain a collection of network resources which have the specified type and/or name. The default connection information is included in the returned network resources.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

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

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

-Label <String>

Specify the label name the network resource is associated with. Cannot be combined with Name.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Name <String>

The name of the network resource to be returned. All network resources will be returned if omitted. Supports "*" wildcard character.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-Purpose <String>

Specify the Ethernet Purpose value to filter on.

Supported Values:

* General
* Management
* VMMigration
* FaultTolerance
* ISCSI

Note: When using this parameter, only Ethernet networks will be returned.
Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <Object>

Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:

* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
Default value AllResourcesInScope
Accept pipeline input? false
Accept wildcard characters?    False

-Type <String>

The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for Fibre Channel networks. All network resources will be returned if omitted.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-exportFile <String>

Aliases [-x, -export] The full path and file name to export the JSON formatted definition of the networks to a file. The directory for the file is validated prior to execution and the function returns an error is the directory does not exist.

Aliases x, export
Required? true
Position? named
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

System.String

Network Resource Name(s)

Return Values

HPOneView.Networking.EthernetNetwork

Single Ethernet Network resource

HPOneView.Networking.FibreChannelNetwork

Single Fibre Channel Network resource

HPOneView.Networking.FCoENetwork

Single FCoE Network resource

System.Collections.ArrayList

Multiple Network Object resources

Examples

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

$net41 = Get-HPOVNetwork -name "Net-41"

Return the network resource with the name "Net-41"

 -------------------------- EXAMPLE 2 --------------------------

$ethNets = Get-HPOVNetwork -type Ethernet

Return all the Ethernet network resources

 -------------------------- EXAMPLE 3 --------------------------

$ethNets = Get-HPOVNetwork -Name VLAN_19*

Return all Ethernet Networks that match "VLAN_19*".

 -------------------------- EXAMPLE 4 --------------------------

$ethNets = "Net1","Net2","Net3" | Get-HPOVNetwork -Type Ethernet

Return Net1, Net2, and Net3 Ethernet Networks from the specified appliance connection.

 -------------------------- EXAMPLE 5 --------------------------

Get-HPOVNetwork -exportFile "c:\myApplianceConfig\myNets.json"

Exports all networks to the file myNets.json in JSON format.

 -------------------------- EXAMPLE 6 --------------------------

Get-HPOVNetwork -x "c:\myApplianceConfig\myNets.json" -type Ethernet

Exports only the ethernet networks to the file myNets.json.

 -------------------------- EXAMPLE 7 --------------------------

Get-HPOVNetwork Type: Ethernet Name Type VLAN ID Purpose Smartlink Private Network Status Preferred Bandwidth Max Bandwidth ---- ---- ------- ------- --------- --------------- ------ ------------------- ------------- VLAN 1-A Tagged 1 Management True False OK 2500 10000 VLAN 1-B Tagged 1 Management True False OK 2500 10000 VLAN 10-A Tagged 10 VMMigration True False OK 2500 10000 VLAN 10-B Tagged 10 VMMigration True False OK 2500 10000 VLAN 101-A Tagged 101 General True False OK 2500 10000 VLAN 101-B Tagged 101 General True False OK 2500 10000 VLAN 102-A Tagged 102 General True False OK 2500 10000 VLAN 102-B Tagged 102 General True False OK 2500 10000 VLAN 103-A Tagged 103 General True False OK 2500 10000 VLAN 103-B Tagged 103 General True False OK 2500 10000 VLAN 104-A Tagged 104 General True False OK 2500 10000 VLAN 104-B Tagged 104 General True False OK 2500 10000 VLAN 105-A Tagged 105 General True False OK 2500 10000 VLAN 105-B Tagged 105 General True False OK 2500 10000 VLAN 20-A Tagged 20 General True False OK 2500 10000 VLAN 20-B Tagged 20 General True False OK 2500 10000 VLAN 201-A Tagged 201 General True False OK 2500 10000 VLAN 201-B Tagged 201 General True False OK 2500 10000 VLAN 30-A Tagged 30 General True False OK 2500 10000 VLAN 30-B Tagged 30 General True False OK 2500 10000 VLAN 301-A Tagged 301 General True False OK 2500 10000 VLAN 301-B Tagged 301 General True False OK 2500 10000 VLAN 40-A Tagged 40 General True False OK 2500 10000 VLAN 40-B Tagged 40 General True False OK 2500 10000 VLAN 401-A Tagged 401 General True False OK 2500 10000 VLAN 401-B Tagged 401 General True False OK 2500 10000 VLAN 50-A Tagged 50 General True False OK 2500 10000 VLAN 50-B Tagged 50 General True False OK 2500 10000 VLAN 501-A Tagged 501 General True False OK 2500 10000 VLAN 501-B Tagged 501 General True False OK 2500 10000 Type: Fibre Channel Name Status Type Typical Bandwidth Max Bandwidth Auto Login Redistribution Link Stability Interval ---- ------ ---- ----------------- ------------- ------------------------- ----------------------- 3PAR SAN DA A OK DirectAttach 4000 8000 False 0 3PAR SAN DA B OK DirectAttach 4000 8000 False 0 3PAR SAN Fabric A OK FabricAttach 4000 8000 True 30 3PAR SAN Fabric B OK FabricAttach 4000 8000 True 30 Type: FCoE Name Status vlanId Typical Bandwidth Max Bandwidth Associated SAN ---- ------ ------ ----------------- ------------- -------------- fcoe1 OK 134 2500 20000 FCOE3 OK 11 2500 10000 FCOE2 OK 10 2500 10000 FCOE12 OK 12 2500 10000

Get all available networks.

Related Links


HPE OneView 4.00 Library

Get-HPOVNetwork

Retrieve Network resource(s).

SYNTAX

Get-HPOVNetwork [-Name] <String> [-Type] <String>[ [-Purpose] <String>][ [-Scope] <Object>] [-Label] <String> [-ApplianceConnection] <Object> [-exportFile] <String> [<CommonParameters>]

Detailed Description

Obtain a collection of network resources which have the specified type and/or name. The default connection information is included in the returned network resources.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

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

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

-Label <String>

Specify the label name the network resource is associated with. Cannot be combined with Name.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Name <String>

The name of the network resource to be returned. All network resources will be returned if omitted. Supports '*' wildcard character.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-Purpose <String>

Specify the Ethernet Purpose value to filter on.

Supported Values:

* General
* Management
* VMMigration
* FaultTolerance
* ISCSI

Note: When using this parameter, only Ethernet networks will be returned.
Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <Object>

Filter resources based on provided Scope membership. By default, all resources for the accounts Active Permissions will be displayed. Allowed values:

* AllResources
* AllResourcesInScope
* HPOneView.Appliance.ScopeCollection
* HPOneView.Appliance.ConnectionPermission
Aliases None
Required? False
Position? named
Default value AllResourcesInScope
Accept pipeline input? false
Accept wildcard characters?    False

-Type <String>

The type of the network resource to be returned. Valid types are "Ethernet" for Ethernet networks, "FC" or "FibreChannel" for Fibre Channel networks. All network resources will be returned if omitted.

Aliases None
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-exportFile <String>

Aliases [-x, -export] The full path and file name to export the JSON formatted definition of the networks to a file. The directory for the file is validated prior to execution and the function returns an error is the directory does not exist.

Aliases x, export
Required? true
Position? named
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

System.String

Network Resource Name(s)

Return Values

HPOneView.Networking.EthernetNetwork

Single Ethernet Network resource

HPOneView.Networking.FibreChannelNetwork

Single Fibre Channel Network resource

HPOneView.Networking.FCoENetwork

Single FCoE Network resource

System.Collections.ArrayList

Multiple Network Object resources

Examples

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

$net41 = Get-HPOVNetwork -name "Net-41"

Return the network resource with the name "Net-41"

 -------------------------- EXAMPLE 2 --------------------------

$ethNets = Get-HPOVNetwork -type Ethernet

Return all the Ethernet network resources

 -------------------------- EXAMPLE 3 --------------------------

$ethNets = Get-HPOVNetwork -Name VLAN_19*

Return all Ethernet Networks that match 'VLAN_19*'.

 -------------------------- EXAMPLE 4 --------------------------

$ethNets = 'Net1','Net2','Net3' | Get-HPOVNetwork -Type Ethernet

Return Net1, Net2, and Net3 Ethernet Networks from the specified appliance connection.

 -------------------------- EXAMPLE 5 --------------------------

Get-HPOVNetwork -exportFile "c:\myApplianceConfig\myNets.json"

Exports all networks to the file myNets.json in JSON format.

 -------------------------- EXAMPLE 6 --------------------------

Get-HPOVNetwork -x "c:\myApplianceConfig\myNets.json" -type Ethernet

Exports only the ethernet networks to the file myNets.json.

 -------------------------- EXAMPLE 7 --------------------------

Get-HPOVNetwork Type: Ethernet Name Type VLAN ID Purpose Smartlink Private Network Status Preferred Bandwidth Max Bandwidth ---- ---- ------- ------- --------- --------------- ------ ------------------- ------------- VLAN 1-A Tagged 1 Management True False OK 2500 10000 VLAN 1-B Tagged 1 Management True False OK 2500 10000 VLAN 10-A Tagged 10 VMMigration True False OK 2500 10000 VLAN 10-B Tagged 10 VMMigration True False OK 2500 10000 VLAN 101-A Tagged 101 General True False OK 2500 10000 VLAN 101-B Tagged 101 General True False OK 2500 10000 VLAN 102-A Tagged 102 General True False OK 2500 10000 VLAN 102-B Tagged 102 General True False OK 2500 10000 VLAN 103-A Tagged 103 General True False OK 2500 10000 VLAN 103-B Tagged 103 General True False OK 2500 10000 VLAN 104-A Tagged 104 General True False OK 2500 10000 VLAN 104-B Tagged 104 General True False OK 2500 10000 VLAN 105-A Tagged 105 General True False OK 2500 10000 VLAN 105-B Tagged 105 General True False OK 2500 10000 VLAN 20-A Tagged 20 General True False OK 2500 10000 VLAN 20-B Tagged 20 General True False OK 2500 10000 VLAN 201-A Tagged 201 General True False OK 2500 10000 VLAN 201-B Tagged 201 General True False OK 2500 10000 VLAN 30-A Tagged 30 General True False OK 2500 10000 VLAN 30-B Tagged 30 General True False OK 2500 10000 VLAN 301-A Tagged 301 General True False OK 2500 10000 VLAN 301-B Tagged 301 General True False OK 2500 10000 VLAN 40-A Tagged 40 General True False OK 2500 10000 VLAN 40-B Tagged 40 General True False OK 2500 10000 VLAN 401-A Tagged 401 General True False OK 2500 10000 VLAN 401-B Tagged 401 General True False OK 2500 10000 VLAN 50-A Tagged 50 General True False OK 2500 10000 VLAN 50-B Tagged 50 General True False OK 2500 10000 VLAN 501-A Tagged 501 General True False OK 2500 10000 VLAN 501-B Tagged 501 General True False OK 2500 10000 Type: Fibre Channel Name Status Type Typical Bandwidth Max Bandwidth Auto Login Redistribution Link Stability Interval ---- ------ ---- ----------------- ------------- ------------------------- ----------------------- 3PAR SAN DA A OK DirectAttach 4000 8000 False 0 3PAR SAN DA B OK DirectAttach 4000 8000 False 0 3PAR SAN Fabric A OK FabricAttach 4000 8000 True 30 3PAR SAN Fabric B OK FabricAttach 4000 8000 True 30 Type: FCoE Name Status vlanId Typical Bandwidth Max Bandwidth Associated SAN ---- ------ ------ ----------------- ------------- -------------- fcoe1 OK 134 2500 20000 FCOE3 OK 11 2500 10000 FCOE2 OK 10 2500 10000 FCOE12 OK 12 2500 10000

Get all available networks.

Related Links


Wiki Table of Contents

Clone this wiki locally