New-SCLogicalSwitch

New-SCLogicalSwitch

Creates a logical switch.

Syntax

Parameter Set: Default
New-SCLogicalSwitch -Name <String> [-Description <String> ] [-EnableSriov <Boolean]> ] [-JobVariable <String> ] [-MinimumBandwidthMode <BandwidthMode]> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-SwitchUplinkMode <SwitchUplinkMode]> ] [-VirtualSwitchExtensions <VirtualSwitchExtension[]> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The New-SCLogicalSwitch cmdlet creates a logical switch object.

Parameters

-Description<String>

States a description for the specified object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-EnableSriov<Boolean]>

Indicates whether single-root I/O virtualization (SR-IOV) is enabled.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-MinimumBandwidthMode<BandwidthMode]>

Specifies the minimum bandwidth mode for the logical switch. Valid values are:

-- Default
-- Weight
-- Absolute
-- None

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VMM object.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

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

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SwitchUplinkMode<SwitchUplinkMode]>

Specifies a switch uplink mode object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VirtualSwitchExtensions<VirtualSwitchExtension[]>

Specifies an array of virtual switch extension objects.

To get a virtual switch extension object, use the Get-SCVirtualSwitchExtension cmdlet.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Create a logical switch

The first command gets the virtual switch extension object named VirtualSwitchExtension01 and then stores the object in the $VSwitchExt variable.

The second command creates a logical switch named LogicalSwitch01 using VirtualSwitchExtension01.

PS C:\> $VSwitchExt = Get-SCVirtualSwitchExtension -Name "VirtualSwitchExtension01"
PS C:\> New-SCLogicalSwitch -Name "LogicalSwitch01" -VirtualSwitchExtensions $VSwitchExt -MinimumBandwidthMode Default

Get-SCLogicalSwitch

Get-SCVirtualSwitchExtension

Remove-SCLogicalSwitch

Set-SCLogicalSwitch