Remove HPOVLogicalSwitch - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Remove-HPOVLogicalSwitch

Remove a new Logical Switch resource.

SYNTAX

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

Detailed Description

This Cmdlet will remove the configured Logical Switch from the requested appliance(s). When you delete a logical switch, HPE OneView no longer manages the physical switches associated with it. Required privileges: Infrastructure administrator or Network administrator

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?	true (ByPropertyName)
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

-Confirm <SwitchParameter>

Bypass the confirmation prompt, and process all of the objects.

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

-Force <SwitchParameter>

Force remove resource, even if there are communication problems.

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

-InputObject <Object>

The Logical Switch resource Name or Object to update.

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

-WhatIf <>

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

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.LogicalSwitch [System.Management.Automation.PSCustomObject]

Logical Switch resource.

Return Values

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

The async task resource object to monitor (if -Async was used) or results.

System.Collections.ArrayList <HPOneView.Appliance.TaskResource>

Collection of remove Logical Switch async task resources.

Examples

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

Get-HPOVLogicalSwitch | Remove-HPOVLogicalSwitch

Remove all logical switch resources found on the default appliance connection.

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

Get-HPOVLogicalSwitch -Name "My Logical Switch 1" | Remove-HPOVLogicalSwitch -confirm:$false

Remove the "My Logical Switch 1" resource.

HPE OneView 4.00 Library