Share via

Remove-SCLogicalSwitch

  • Reference
Module:
VirtualMachineManager

Removes a logical switch.

Syntax

Remove-SCLogicalSwitch
      [-VMMServer <ServerConnection>]
      [-LogicalSwitch] <LogicalSwitch>
      [-RunAsynchronously]
      [-PROTipID <Guid>]
      [-JobVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCLogicalSwitch cmdlet deletes a logical switch.

Examples

Example 1: Remove a logical switch

PS C:\> $LogicalSwitch = Get-SCLogicalSwitch -Name "LogicalSwitch01" | Remove-SCLogicalSwitch

This command gets the logical switch object named LogicalSwitch01 and then uses the pipeline operator to pass the object to Remove-SCLogicalSwitch to delete the logical switch object.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JobVariable

Specifies a variable in which job progress is tracked and stored.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LogicalSwitch

Specifies a logical switch object.

Type:LogicalSwitch
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a Virtual Machine Manager (VMM) server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False