Skip to content

New HPOVNetwork

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

HPE OneView 4.10 Library

New-HPOVNetwork

Creates one or more new Ethernet or Fibre-Channel networks on the appliance.

SYNTAX

New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32>[ [-NetworkSet] <Object[]>] [-Subnet] <Object> [-VLANType] <String> [-Purpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-VlanRange] <String> [-Type] <String> [-VLANType] <String> [-Purpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-LinkStabilityTime] <Int32> [-AutoLoginRedistribution] <Boolean> [-FabricType] <String> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Create a new network resource, including its default connection type. Network definitions can be supplied as direct CmdLet parameters or as input from a file containing the network definition in JSON format.

To create an Ethernet Network for Image Streamer, use the following paramters:

* Name
* VlanType = Untagged
* IPv4Subnet Object
* Purpose = Management

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

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

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

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

-AutoLoginRedistribution <Boolean>

Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available).

True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually.

This parameter is not applicable for Direct Attach Fabric Types.

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

-FabricType <String>

Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach

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

-ImportFile <String>

Full path and file name of a JSON formatted input file containing network definitions.

Aliases i, import
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-LinkStabilityTime <Int32>

The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).

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

-ManagedSan <Object>

Managed SAN Object or Name.

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

-MaximumBandwidth <Int32>

Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.

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

-Name <String>

Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. "VLAN" will become "VLAN-[vlanid]".)

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

-NetworkSet <Object[]>

Specify one or more network set objects the network should be added to during creation from Get-HPOVNetworkSet.

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

-PrivateNetwork <Boolean>

Default value is FALSE.

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

-Purpose <String>

A description of the network"s role within the logical interconnect. Accepted values in string format are:

* General
* Management
* VMMigration
* FaultTolerance
* iSCSI
Aliases None
Required? true
Position? named
Default value General
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <HPOneView.Appliance.ScopeCollection>

Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.

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

-SmartLink <Boolean>

Default value is TRUE.

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

-Subnet <Object>

An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.

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

-Type <String>

Required value that specifies the type of Network Resource to create. Allowed values are:

* Ethernet
* FC
* FibreChannel
* FCoE
Aliases None
Required? true
Position? named
Default value Ethernet
Accept pipeline input? false
Accept wildcard characters?    False

-TypicalBandwidth <Int32>

Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.

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

-VLANType <String>

The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not the Network Set it could be assigned to. Accepted values are

* Tagged
* Tunnel
* Access

Default value is Tagged.

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

-VlanId <Int32>

The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be changed once the network has been created.

When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.

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

-VlanRange <String>

VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both.

e.g. -VLANRange "10-90,94,96,200-210"

Aliases None
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

HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]

ManagedSan resource object to be assigned to a FC or FCoE Network

Return Values

System.Collections.ArrayList

A custom status object or array of objects containing the following PsCustomObject keys:

  • Name - name of the network object attempted to be created * Status - status of the creation attempt (Failed for http error return; Complete if a task object is returned)
  • Description - Task object or Error object * Exception - System.Management.Automation.ErrorRecord object of the error generated

Examples

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

New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500

Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, and specifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s. Network will be created on all connected appliances.

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

New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance MyAppliance

Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on "MyAppliance"

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

$Connection1 = Connect-HPOVMgmt MyAppliance1.domain.local Administrator MyPassword $Connection2 = Connect-HPOVMgmt MyAppliance2.domain.local Administrator MyPassword New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance $Connection1,$Connection2

Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on "MyAppliance1" and "MyAppliance2" using the connection objects.

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

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }

Create multiple Ethernet Networks.

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

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ } 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }

Create Ethernet Networks for an Active/Active configuration.

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

New-HPOVNetwork -name "VLAN A Side" -vlanRange "10,20,30,40,50,60" New-HPOVNetwork -name "VLAN B Side" -VlanRange "10,20,30,40,50,60"

Create Ethernet Networks for an Active/Active configuration using the -VlanRange parameter.

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

New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000

Creates a new FC network type, called "Fabric A" and preferred bandwidth is 2Gb/s and max is 4Gb/s.

 -------------------------- EXAMPLE 8 --------------------------

New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000 -fabricType FabricAttach -managedSAN Fabric_A

Creates a new FC network type, called "Fabric A", preferred bandwidth is 2Gb/s and max is 4Gb/s, and is associated with a Managed SAN Fabric.

 -------------------------- EXAMPLE 9 --------------------------

New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"

Creates the network(s) defined in the input file myNewNets.json

Related Links


HPE OneView 4.00 Library

New-HPOVNetwork

Creates one or more new Ethernet or Fibre-Channel networks on the appliance.

SYNTAX

New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-Subnet] <Object> [-VLANType] <String> [-Purpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-VlanRange] <String> [-Type] <String> [-VLANType] <String> [-Purpose] <String> [-SmartLink] <Boolean> [-PrivateNetwork] <Boolean> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-VlanId] <Int32> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-Name] <String> [-Type] <String> [-TypicalBandwidth] <Int32> [-MaximumBandwidth] <Int32> [-LinkStabilityTime] <Int32> [-AutoLoginRedistribution] <Boolean> [-FabricType] <String> [-ManagedSan] <Object>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
New-HPOVNetwork [-ImportFile] <String>[ [-Scope] <HPOneView.Appliance.ScopeCollection>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Create a new network resource, including its default connection type. Network definitions can be supplied as direct CmdLet parameters or as input from a file containing the network definition in JSON format.

To create an Ethernet Network for Image Streamer, use the following paramters:

* Name
* VlanType = Untagged
* IPv4Subnet Object
* Purpose = Management

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.

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

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

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

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

-AutoLoginRedistribution <Boolean>

Used for login balancing when logins are not distributed evenly over the Fibre Channel links (for example, when an uplink that was down becomes available).

True: Login redistribution is initiated automatically when the link stability time expires. False: Login redistribution must be initiated manually.

This parameter is not applicable for Direct Attach Fabric Types.

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

-FabricType <String>

Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach

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

-ImportFile <String>

Full path and file name of a JSON formatted input file containing network definitions.

Aliases i, import
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-LinkStabilityTime <Int32>

The time in seconds the appliance waits before reconnecting to a link that was previously offline (Login redistribution). This interval prevents connection loss due to reconnecting to a link that is unstable (going online and offline repeatedly).

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

-ManagedSan <Object>

Managed SAN Object or Name.

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

-MaximumBandwidth <Int32>

Maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.

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

-Name <String>

Required object to provide a display name for the network being created. If specifying the -VlanRange parameter, this will become the Nework Name Prefix (i.e. 'VLAN' will become 'VLAN-[vlanid]'.)

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

-PrivateNetwork <Boolean>

Default value is FALSE.

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

-Purpose <String>

A description of the network's role within the logical interconnect. Accepted values in string format are:

* General
* Management
* VMMigration
* FaultTolerance
* iSCSI
Aliases None
Required? true
Position? named
Default value General
Accept pipeline input? false
Accept wildcard characters?    False

-Scope <HPOneView.Appliance.ScopeCollection>

Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.

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

-SmartLink <Boolean>

Default value is TRUE.

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

-Subnet <Object>

An IPv4 Subnet Object that will be associated with a specific Ethernet Network and VLAN.

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

-Type <String>

Required value that specifies the type of Network Resource to create. Allowed values are:

* Ethernet
* FC
* FibreChannel
* FCoE
Aliases None
Required? true
Position? named
Default value Ethernet
Accept pipeline input? false
Accept wildcard characters?    False

-TypicalBandwidth <Int32>

Preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.

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

-VLANType <String>

The type of VLAN configuration for the Ethernet Network. This setting is only applicable for the Uplink Set configuration, and not the Network Set it could be assigned to. Accepted values are

* Tagged
* Tunnel
* Access

Default value is Tagged.

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

-VlanId <Int32>

The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique. The VLAN ID cannot be changed once the network has been created.

When creating an Ethernet Network on an HPE Synergy Composer, Vlan ID 1 is not a valid ID. The allowed range is 2-4095.

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

-VlanRange <String>

VLAN Range of networks to create. Can be consecutive, non-consecutive or a combination of both.

e.g. -VLANRange "10-90,94,96,200-210"

Aliases None
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

HPOneView.Storage.ManagedSan [System.Management.Automation.PSCustomObject]

ManagedSan resource object to be assigned to a FC or FCoE Network

Return Values

System.Collections.ArrayList

A custom status object or array of objects containing the following PsCustomObject keys:

  • Name - name of the network object attempted to be created * Status - status of the creation attempt (Failed for http error return; Complete if a task object is returned)
  • Description - Task object or Error object * Exception - System.Management.Automation.ErrorRecord object of the error generated

Examples

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

New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500

Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, and specifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s. Network will be created on all connected appliances.

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

New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance MyAppliance

Creates new Ethernet Network type, with "MyNetwork1" name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on 'MyAppliance'

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

$Connection1 = Connect-HPOVMgmt MyAppliance1.domain.local Administrator MyPassword $Connection2 = Connect-HPOVMgmt MyAppliance2.domain.local Administrator MyPassword New-HPOVNetwork -type Ethernet -name MyNetwork1 -vlanid 100 -typicalbandwidth 5000 -maximumbandwidth 7500 -Appliance $Connection1,$Connection2

Creates new Ethernet Network type, with 'MyNetwork1' name, VLAN ID 100, an dspecifies preferred bandwidth to 5Gb/s and max to 7.5Gb/s to be created on 'MyAppliance1' and 'MyAppliance2' using the connection objects.

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

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }

Create multiple Ethernet Networks.

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

10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ } 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }

Create Ethernet Networks for an Active/Active configuration.

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

New-HPOVNetwork -name "VLAN A Side" -vlanRange "10,20,30,40,50,60" New-HPOVNetwork -name "VLAN B Side" -VlanRange "10,20,30,40,50,60"

Create Ethernet Networks for an Active/Active configuration using the -VlanRange parameter.

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

New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000

Creates a new FC network type, called 'Fabric A' and preferred bandwidth is 2Gb/s and max is 4Gb/s.

 -------------------------- EXAMPLE 8 --------------------------

New-HPOVNetwork -type FC -name "Fabric A" -typicalBandwidth 2000 -maximumBandwidth 4000 -fabricType FabricAttach -managedSAN Fabric_A

Creates a new FC network type, called 'Fabric A', preferred bandwidth is 2Gb/s and max is 4Gb/s, and is associated with a Managed SAN Fabric.

 -------------------------- EXAMPLE 9 --------------------------

New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"

Creates the network(s) defined in the input file myNewNets.json

Related Links


Wiki Table of Contents

Clone this wiki locally