Library Version 1.10

Library Version 1.06


HP OneView 1.10 Library

NAME

New-HPOVNetwork

SYNOPSIS

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

SYNTAX

New-HPOVNetwork [-Name] <String> [-type] <String> [-vlanId] <Int32> [[-VLANType] <String>] [-purpose <String>] [-smartLink <Boolean>] [-privateNetwork <Boolean>] [-typicalBandwidth <Int32>] [-maximumBandwidth <Int32>] [<CommonParameters>]

New-HPOVNetwork [-Name] <String> [-type] <String> [-fcUplinkBandwidth <String>] [-typicalBandwidth <Int32>] [-maximumBandwidth <Int32>] [-linkStabilityTime <Int32>] [-autoLoginRedistribution <Boolean>] [-fabricType <String>] [-managedSan <Object>] [<CommonParameters>] New-HPOVNetwork -importFile <String> [<CommonParameters>]

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.

PARAMETERS

-Name <String>
Required object to provide a display name for the network being created.
Aliases None
Required? true
Position? 1
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-type <String>
Aliases None
Required? true
Position? 2
Default value <none>
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.
Aliases None
Required? true
Position? 3
Default value 0
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? false
Position? 4
Default value Tagged
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
Aliases None
Required? false
Position? named
Default value General
Accept pipeline input? false
Accept wildcard characters?    false
-smartLink [<Boolean>]
Optional. Default value is TRUE.
Aliases None
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters?    false
-privateNetwork [<Boolean>]
Optional. Default value is FALSE.
Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    false
-fcUplinkBandwidth [<String>]
[DEPRICATED FEATURE, NOW PART OF NEW-HPOVUPLINKSET]
Aliases None
Required? false
Position? named
Default value <none>
Accept pipeline input? false
Accept wildcard characters?    false
-typicalBandwidth [<Int32>]
Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None
Required? false
Position? named
Default value 2500
Accept pipeline input? false
Accept wildcard characters?    false
-maximumBandwidth [<Int32>]
Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None
Required? false
Position? named
Default value 10000
Accept pipeline input? false
Accept wildcard characters?    false
-linkStabilityTime [<Int32>]
Used or FC Networks. Specified in seconds. Default value is 30.
Aliases None
Required? false
Position? named
Default value 30
Accept pipeline input? false
Accept wildcard characters?    false
-autoLoginRedistribution [<Boolean>]
Optional value, specified in seconds. Default value is 30.
Aliases None
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?    false
-fabricType [<String>]
Optional. Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach
Aliases None
Required? false
Position? named
Default value FabricAttach
Accept pipeline input? false
Accept wildcard characters?    false
-managedSan [<Object>]
Optional. Managed SAN Name or URI.
Aliases None
Required? false
Position? named
Default value <none>
Accept pipeline input? true (ByValue)
Accept wildcard characters?    false
-importFile <String>
Optional. Full path and file name of a JSON formatted input file containing network definitions.
Aliases None
Required? true
Position? named
Default value <none>
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).

INPUTS

System.ObjectSystem.Management.Automation.PSCustomObject

ManagedSan resource object to be assigned to a Fibre Channel Network.

OUTPUTS

System.Array

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

[System.String]name - name of the network object attempted to be created.

[System.String]status - status of the creation attempt (Failed for http error return; Complete if a task object is returned)

[System.String]escription - Task object or Error object.

}

RELATED LINKS

EXAMPLES

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

PS C:\> 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.
-------------------------- EXAMPLE 2 -------------------------- 

PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }
    
Create multiple Ethernet Networks.
-------------------------- EXAMPLE 3 -------------------------- 

PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ }
PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }
  
Create Ethernet Networks for an Active/Active configuration.
-------------------------- EXAMPLE 4 -------------------------- 

PS C:\> 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 5 -------------------------- 

PS C:\> 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 6 -------------------------- 

PS C:\> New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"
 
Creates the network(s) defined in the input file myNewNets.json

HP OneView 1.06 Library

NAME

New-HPOVNetwork

SYNOPSIS

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

SYNTAX

New-HPOVNetwork -Name <String> -type <String> [-purpose <String>] [-fcUplinkBandwidth <String>] [-typicalBandwidth <Int32>] [-maximumBandwidth <Int32>] [-linkStabilityTime <Int32>] [-autoLoginRedistribution <Boolean>] [-fabricType <String>] [<CommonParameters>]
New-HPOVNetwork -Name <String> -type <String> -vlanId <Int32> [-purpose <String>] [-smartLink <Boolean>] [-privateNetwork <Boolean>] [-typicalBandwidth <Int32>] [-maximumBandwidth <Int32>] [<CommonParameters>]
New-HPOVNetwork -importFile <Object> [<CommonParameters>]

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.

PARAMETERS

-Name <String>
Required object to provide a display name for the network being created.
Aliases None.           
Required? true
Position? 1
Default value <none>        
Accept pipeline input? false
Accept wildcard characters?     false

-type <String>
Type of the network to be created:
  • "Ethernet" to create an Ethernet Network
  • "FC" to create a Fibre Channel Network
Aliases None.           
Required? true
Position? 2
Default value <none>        
Accept pipeline input? false
Accept wildcard characters?     false

-vlanId <Int32>
Required object for Ethernet Networks only.
Aliases None.           
Required? true
Position? 3
Default value 0
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
Aliases None.           
Required? false
Position? named
Default value General
Accept pipeline input? false
Accept wildcard characters?     false

-smartLink <Boolean>
Optional. Default value is FALSE.
Aliases None.           
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters?     false

-privateNetwork <Boolean>
Optional. Default value is FALSE.
Aliases None.           
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?     false

-fcUplinkBandwidth <String>
Optional. Default is Auto. Parameter is case sensitive. Accepted values in string format are:
  • Auto
  • Two_Gbps
  • Four_Gbps
  • Eight_Gbps
Aliases None.           
Required? false
Position? named
Default value Auto
accept pipeline input? False
Accept wildcard characters?     false

-typicalBandwidth <Int32>
Optional preferred amount of bandwidth to assign, specified in Mbps. Default value is 2500.
Aliases None.           
Required? false
Position? named
Default value 2500
Accept pipeline input? false
Accept wildcard characters?     false

-maximumBandwidth <Int32>
Optional maximum amount of bandwidth to assign, specified in Mbps. Default value is 10000.
Aliases None.           
Required? false
Position? named
Default value 10000
Accept pipeline input? false
Accept wildcard characters?     false

-linkStabilityTime <Int32>
Used or FC Networks. Specified in seconds. Default value is 30.
Aliases None.           
Required? false
Position? named
Default value 30
Accept pipeline input? false
Accept wildcard characters?     false

-autoLoginRedistribution <Boolean>
Optional value, specified in seconds. Default value is 30.
Aliases None.           
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters?     false

-fabricType <String>
Optional. Valid values are DirectAttach and FabricAttach. Defaults to FabricAttach
Aliases None.           
Required? false
Position? named
Default value FabricAttach
Accept pipeline input? false
Accept wildcard characters?     false

-importFile <Object>
Optional. Full path and file name of a JSON formatted input file containing network definitions.
Aliases None.           
Required? false
Position? named
Default value <none>
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).

INPUTS

None.

OUTPUTS

System.Array

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.

RELATED LINKS

EXAMPLES


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

PS C:\> 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.
-------------------------- EXAMPLE 2 --------------------------

PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_" -vlanid $_ }
Create multiple Ethernet Networks.
-------------------------- EXAMPLE 3 --------------------------

PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-A" -vlanid $_ }
PS C:\> 10,20,30,40,50,60 | % { New-HPOVNetwork -type Ethernet -name "VLAN $_-B" -vlanid $_ }
Create Ethernet Networks for an Active/Active configuration. *** Only available with HP OneView 1.05 release. ***
-------------------------- EXAMPLE 4 --------------------------

PS C:\> New-HPOVNetwork -type FC -name "Fabric A" -FcUplinkBandwidth Auto -typicalBandwidth 2000 -maximumBandwidth 4000
Creates a new FC network type, called "Fabric A", which the uplink port speed is Auto, and preferred bandwidth is 2Gb/s and max is 4Gb/s.

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

PS C:\> New-HPOVNetwork -importFile "c:\OneViewInput\myNewNets.json"
Creates the network(s) defined in the input file myNewNets.json

Last edited Aug 19, 2014 at 12:16 AM by chrislynchhp, version 12