New-HyperVVirtualSwitch

Hyper-V: Creates a new virtual switch on a Hyper-V host

Script

#Requires -Version 5.1
#Requires -Modules Hyper-V

[CmdletBinding()]
Param (
    [string]$ComputerName = "localhost",

    [PSCredential]$Credential,

    [Parameter(Mandatory = $true)]
    [string]$Name,

    [Parameter(Mandatory = $true)]
    [ValidateSet('External', 'Internal', 'Private')]
    [string]$SwitchType,

    [string]$NetAdapterName,

    [bool]$AllowManagementOS = $true,

    [switch]$EnableIov,

    [string]$Notes
)

Process {
    try {
        $params = @{
            'Name'         = $Name
            'ComputerName' = $ComputerName
            'Notes'        = $Notes
            'EnableIov'    = $EnableIov.IsPresent
            'Confirm'      = $false
            'ErrorAction'  = 'Stop'
        }
        if ($Credential) { $params.Add('Credential', $Credential) }

        if ($SwitchType -eq 'External') {
            if (-not $NetAdapterName) {
                throw "NetAdapterName is required when SwitchType is 'External'."
            }
            $params.Add('NetAdapterName', $NetAdapterName)
            $params.Add('AllowManagementOS', $AllowManagementOS)
        }
        else {
            $params.Add('SwitchType', $SwitchType)
        }

        $vSwitch = New-VMSwitch @params

        $result = [PSCustomObject]@{
            Name               = $vSwitch.Name
            ID                 = $vSwitch.Id
            SwitchType         = $vSwitch.SwitchType
            AllowManagementOS  = $vSwitch.AllowManagementOS
            Action             = "VirtualSwitchCreated"
            Status             = "Success"
            Timestamp          = Get-Date -Format "yyyy-MM-dd HH:mm:ss"
        }

        Write-Output $result
    }
    catch {
        throw
    }
}

Customize

ComputerName string

Specifies the name of the Hyper-V host. Defaults to the local machine.

Credential PSCredential

Specifies the credentials to use for the remote connection.

Name string

Specifies the name of the new virtual switch.

SwitchType string

Specifies the type of virtual switch to create (External, Internal, Private).

NetAdapterName string

Required for External switches. Specifies the name of the physical network adapter to bind to.

AllowManagementOS bool

Only for External switches. If set, allows the management OS to share the physical network adapter. Defaults to true.

EnableIov switch

Off

If set, enables Single Root I/O Virtualization (SR-IOV) on the virtual switch.

Notes string

Optional. Specifies notes for the virtual switch.