Skip to content

Remove HPOVNetwork

Jump to bottom
Chris Lynch edited this page Dec 10, 2020 · 43 revisions

Library Version 4.20

Library Version 4.10

Library Version 4.00

HPE OneView 4.10 Library

Remove-HPOVNetwork

Delete network from appliance configuration.

SYNTAX

Remove-HPOVNetwork [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Delete a network and its corresponding default connection type.

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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Confirm <SwitchParameter>

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

-Force <SwitchParameter>

Forcefully remove the network object.

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

-InputObject <Object>

Aliases [-name, -Network]

The network object(s) or name(s) to be deleted.

Aliases uri, name, network, Resource
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-WhatIf <SwitchParameter>

Aliases wi
Required? false
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 Name or URI

System.Management.Automation.PSCustomObject

Network Resource Object

Return Values

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

Async Removal task

Examples

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

$task = Remove-HPOVNetwork -network "yellow"
Wait-HPOVTaskComplete $task

Remove the network specifed by name. Wait for remove to complete.

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

$Net = Get-HPOVNetwork -name "yellow"
Remove-HPOVNetwork -network $net -confirm:$false

Remove the network specifed by $net, and do not prompt for confirmation.

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

Get-HPOVNetwork | Remove-HPOVNetwork

Search for all networks and remove them from appliance.

Related Links

HPE OneView 4.00 Library

Remove-HPOVNetwork

Delete network from appliance configuration.

SYNTAX

Remove-HPOVNetwork [-InputObject] <Object> [-ApplianceConnection] <Object>[ [-Force] <SwitchParameter>][ [-WhatIf] <SwitchParameter>][ [-Confirm] <SwitchParameter>] [<CommonParameters>]

Detailed Description

Delete a network and its corresponding default connection type.

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? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-Confirm <SwitchParameter>

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

-Force <SwitchParameter>

Forcefully remove the network object.

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

-InputObject <Object>

Aliases [-name, -Network]

The network object(s) or name(s) to be deleted.

Aliases uri, name, network, Resource
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters?    False

-WhatIf <SwitchParameter>

Aliases wi
Required? false
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 Name or URI

System.Management.Automation.PSCustomObject

Network Resource Object

Return Values

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

Async Removal task

Examples

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

$task = Remove-HPOVNetwork -network "yellow"
Wait-HPOVTaskComplete $task

Remove the network specifed by name. Wait for remove to complete.

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

$Net = Get-HPOVNetwork -name "yellow"
Remove-HPOVNetwork -network $net -confirm:$false

Remove the network specifed by $net, and do not prompt for confirmation.

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

Get-HPOVNetwork | Remove-HPOVNetwork

Search for all networks and remove them from appliance.

Related Links

Wiki Table of Contents

Clone this wiki locally