Set HPOVNetwork - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Set-HPOVNetwork

Modify an existing network.

SYNTAX

Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-Purpose] <String>][ [-Smartlink] <Boolean>][ [-PrivateNetwork] <Boolean>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-IPv4Subnet] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-LinkStabilityTime] <Int32>][ [-AutoLoginRedistribution] <Boolean>][ [-ManagedSan] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Modify a network and it"s attributes information. Use this cmdlet to change the Network Name, Purpose, Enable or Disable Smartlink, Enable or Disable Private Network, and adjust the allocated bandwidth.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. 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? true (ByPropertyName)
Accept wildcard characters?    False

-AutoLoginRedistribution <Boolean>

Aliases [-ald] 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). Parameter is only supported with FibreChannel network resources.

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

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

-IPv4Subnet <Object>

Associate with IPv4Subnet.

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

-InputObject <Object>

Aliases [-net, -Network] The Name or Resource object of the network to be modified.

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

-LinkStabilityTime <Int32>

Aliases [-lst] 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). Parameter is only supported with FibreChannel network resources.

Minimum Value: 1 Maximum Value: 1800

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

-ManagedSan <Object>

Managed SAN Name or URI.

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

-MaximumBandwidth <Int32>

The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection, expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is 20Gbps.

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

-Name <String>

The network resource"s new Name value.

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

-Prefix <String>

Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal name. Use the -Name parameter to adjust the entire name.

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

-PrivateNetwork <Boolean>

Enable or Disable Private Network within the Ethernet Network.

Aliases None
Required? false
Position? named
Default value
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
Accept pipeline input? false
Accept wildcard characters?    False

-Smartlink <Boolean>

Enable or Disable Smartlink within the Ethernet Network.

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

-Suffix <String>

Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal name. Use the -Name parameter to adjust the entire name.

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

-TypicalBandwidth <Int32>

Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.

Aliases None
Required? false
Position? named
Default value 0
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.Networking.EthernetNetwork [System.Management.Automation.PSCustomObject]

Ethernet Network resource object

HPOneView.Networking.FCNetwork [System.Management.Automation.PSCustomObject]

FC Network resource object

HPOneView.Networking.FCoENetwork [System.Management.Automation.PSCustomObject]

FCoE Network resource object

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

The Update Network Resource Task object

Examples

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

Get-HPOVNetwork "Net-11" | Set-HPOVNetwork -name NewNet-11 -Purpose Management -SmartLink $true -PrivateNetwork $false -TypicalBandwidth 500 -MaximumBandwidth 1500 | Wait-HPOVTaskComplete

Get the "Net-11" Ethernet Network, pipe it to Set-HPOVNetwork to update values.

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

$fabricAManagedSan = Get-HPOVManagedSan -Name "Fabric A" Get-HPOVNetwork "Prod Fabric A" | Set-HPOVNetwork -ManagedSan $fabricAManagedSan | Wait-HPOVTaskComplete

Update "Prod Fabric A" FC Network with "Fabric a" Managed SAN resource.

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

$NewSuffix = "-prod A" Get-HPOVNetwork -type Ethernet | Set-HPOVNetwork -Suffix $NewSuffix

Get all Ethernet networks, and add a Suffix to their names.

Related Links


Top

HPE OneView 4.00 Library

Set-HPOVNetwork

Modify an existing network.

SYNTAX

Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-Purpose] <String>][ [-Smartlink] <Boolean>][ [-PrivateNetwork] <Boolean>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-IPv4Subnet] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]
Set-HPOVNetwork [-InputObject] <Object>[ [-Name] <String>][ [-Prefix] <String>][ [-Suffix] <String>][ [-TypicalBandwidth] <Int32>][ [-MaximumBandwidth] <Int32>][ [-LinkStabilityTime] <Int32>][ [-AutoLoginRedistribution] <Boolean>][ [-ManagedSan] <Object>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

Detailed Description

Modify a network and it's attributes information. Use this cmdlet to change the Network Name, Purpose, Enable or Disable Smartlink, Enable or Disable Private Network, and adjust the allocated bandwidth.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one HPOneView.Appliance.Connection object or Name property value. 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? true (ByPropertyName)
Accept wildcard characters?    False

-AutoLoginRedistribution <Boolean>

Aliases [-ald] 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). Parameter is only supported with FibreChannel network resources.

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

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

-IPv4Subnet <Object>

Associate with IPv4Subnet.

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

-InputObject <Object>

Aliases [-net, -Network] The Name or Resource object of the network to be modified.

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

-LinkStabilityTime <Int32>

Aliases [-lst] 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). Parameter is only supported with FibreChannel network resources.

Minimum Value: 1 Maximum Value: 1800

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

-ManagedSan <Object>

Managed SAN Name or URI.

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

-MaximumBandwidth <Int32>

The maximum bandwidth of a network connection, that will be allowed and reflected witin the Server Profile Connection, expressed in Mbps. In Flex10 adapters, the maximum supported Ethernet bandwidth is 10 Gbps. With 10Gb FlexFabric adapters, the maximum FCoE bandwidth is 8Gbps. With FlexFabric 20Gb adapters, the maximum Ethernet bandwidth is 20Gbps.

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

-Name <String>

The network resource's new Name value.

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

-Prefix <String>

Use this parameter to add a new prefix to the name. Will not change the original name value, simply add the prefix to the orignal name. Use the -Name parameter to adjust the entire name.

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

-PrivateNetwork <Boolean>

Enable or Disable Private Network within the Ethernet Network.

Aliases None
Required? false
Position? named
Default value
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
Accept pipeline input? false
Accept wildcard characters?    False

-Smartlink <Boolean>

Enable or Disable Smartlink within the Ethernet Network.

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

-Suffix <String>

Use this parameter to add a new suffix to the name. Will not change the original name value, simply add the suffix to the orignal name. Use the -Name parameter to adjust the entire name.

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

-TypicalBandwidth <Int32>

Preferred amount of bandwidth to assign within the Server Profile Connection, specified in Mbps.

Aliases None
Required? false
Position? named
Default value 0
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.Networking.EthernetNetwork [System.Management.Automation.PSCustomObject]

Ethernet Network resource object

HPOneView.Networking.FCNetwork [System.Management.Automation.PSCustomObject]

FC Network resource object

HPOneView.Networking.FCoENetwork [System.Management.Automation.PSCustomObject]

FCoE Network resource object

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

The Update Network Resource Task object

Examples

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

Get-HPOVNetwork "Net-11" | Set-HPOVNetwork -name NewNet-11 -Purpose Management -SmartLink $true -PrivateNetwork $false -TypicalBandwidth 500 -MaximumBandwidth 1500 | Wait-HPOVTaskComplete

Get the 'Net-11' Ethernet Network, pipe it to Set-HPOVNetwork to update values.

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

$fabricAManagedSan = Get-HPOVManagedSan -Name "Fabric A" Get-HPOVNetwork "Prod Fabric A" | Set-HPOVNetwork -ManagedSan $fabricAManagedSan | Wait-HPOVTaskComplete

Update 'Prod Fabric A' FC Network with 'Fabric a' Managed SAN resource.

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

$NewSuffix = "-prod A" Get-HPOVNetwork -type Ethernet | Set-HPOVNetwork -Suffix $NewSuffix

Get all Ethernet networks, and add a Suffix to their names.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️