< Back
New-VDSwitch
Post
NAME New-VDSwitch
SYNOPSIS
This cmdlet creates vSphere distributed switches.
SYNTAX
New-VDSwitch -BackupPath <String> [-KeepIdentifiers] -Location <VIContainer> [-Name <String>] [-RunAsync] [-Server
<VIServer[]>] [-WithoutPortGroups] [-Confirm] [-WhatIf] [<CommonParameters>]
New-VDSwitch [-ContactDetails <String>] [-ContactName <String>] [-LinkDiscoveryProtocol <LinkDiscoveryProtocol>]
[-LinkDiscoveryProtocolOperation <LinkDiscoveryOperation>] -Location <VIContainer> [-MaxPorts <Int32>] [-Mtu
<Int32>] -Name <String> [-Notes <String>] [-NumUplinkPorts <Int32>] [-RunAsync] [-Server <VIServer[]>] [-Version
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-VDSwitch -Location <VIContainer> -Name <String> -ReferenceVDSwitch <VDSwitch> [-RunAsync] [-Server
<VIServer[]>] [-WithoutPortGroups] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates vSphere distributed switches. You can create a new vSphere distributed switch with custom
properties, specify a reference vSphere distributed switch to clone its configuration, or provide a backup profile
to import the switch configuration.
Note: Creating vSphere distributed switches from a reference switch or a backup profile requires vCenter Server
5.1 or later.
PARAMETERS
-BackupPath <String>
Specifies the full file path to the .zip file containing the backup configuration that you want to import.
Only .zip files created with the Export-VDSwitch cmdlet are supported.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContactDetails <String>
Specifies the contact details of the vSphere distributed switch administrator.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContactName <String>
Specifies the name of the vSphere distributed switch administrator.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeepIdentifiers [<SwitchParameter>]
Indicates that the original vSphere distributed switch and port group identifiers will be preserved. You
cannot specify this parameter, when the Name parameter is specified.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LinkDiscoveryProtocol <LinkDiscoveryProtocol>
Specifies the discovery protocol type of the vSphere distributed switch that you want to create. This
parameter accepts CDP and LLDP values. If you do not set a value for this parameter, the default server
setting is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LinkDiscoveryProtocolOperation <LinkDiscoveryOperation>
Specifies the link discovery protocol operation for the vSphere distributed switch that you want to create.
This parameter accepts Advertise, Listen, Both, and Disabled values. If you do not set a value for this
parameter, the default server setting is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <VIContainer>
Specifies the location where you want to create the vSphere distributed switch. This parameter accepts
Datacenter and Folder objects.
Note: You cannot create distributed port groups with identical names in the same location. If you want to
import or clone a vSphere distributed switch with its distributed port groups, you need to specify a location
that does not contain identically named distributed port groups.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-MaxPorts <Int32>
Specifies the maximum number of ports allowed on the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mtu <Int32>
Specifies the maximum MTU size for the vSphere distributed switch that you want to create. Valid values are
positive integers only.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new vSphere distributed switch that you want to create. You cannot specify this
parameter, when the KeepIdentifiers parameter is specified.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Notes <String>
Specifies a description for the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NumUplinkPorts <Int32>
Specifies the number of uplink ports on the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReferenceVDSwitch <VDSwitch>
Specifies a reference vSphere distributed switch. The properties of the new vSphere distributed switch will be
cloned from the reference vSphere distributed switch.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Version <String>
Specifies the version of the vSphere distributed switch that you want to create. This parameter accepts 4.0,
4.1.0, 5.0.0, 5.1.0, 5.5.0, 6.0.0, and 6.5.0 values. You cannot specify a version that is incompatible with
the version of the vCenter Server system you are connected to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WithoutPortGroups [<SwitchParameter>]
Indicates that the new vSphere distributed switch will be created without importing the port groups from the
specified backup file or reference vSphere distributed switch.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created VDSwitch object
NOTES
-------------------------- Example 1 --------------------------
$myDatacenter = Get-Datacenter -Name "MyDatacenter"
New-VDSwitch -Name "MyVDSwitch" -Location $myDatacenter -LinkDiscoveryProtocol "LLDP"
-LinkDiscoveryProtocolOperation "Listen" -MaxPorts 256 -Version "5.0.0"
Creates a new vSphere distributed switch with the specified name, version, maximum number of ports, and link
discovery protocol settings in the specified datacenter.
-------------------------- Example 2 --------------------------
$myFolder = Get-Folder -Name "MyFolder"
Get-VDSwitch -Name "MyReferenceSwitch" | New-VDSwitch -Name "MyVDSwitch" -Location $myFolder -WithoutPortGroups
Creates a new vSphere distributed switch by cloning the configuration of the existing vSphere distributed switch
named "MyReferenceSwitch". The new vSphere distributed switch is created without cloning the existing port groups
and is stored in the specified folder.
-------------------------- Example 3 --------------------------
$myFolder = Get-Folder -Name "MyFolder"
New-VDSwitch -Name "MyVDSwitch" -Location $myFolder -WithoutPortGroups -BackupPath
"c:\\MyDistributedSwitchProfile.zip"
Creates a new vSphere distributed switch by importing the specified backup profile.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... witch.html
Get-VDSwitch
Remove-VDSwitch
Set-VDSwitch
Export-VDSwitch
SYNOPSIS
This cmdlet creates vSphere distributed switches.
SYNTAX
New-VDSwitch -BackupPath <String> [-KeepIdentifiers] -Location <VIContainer> [-Name <String>] [-RunAsync] [-Server
<VIServer[]>] [-WithoutPortGroups] [-Confirm] [-WhatIf] [<CommonParameters>]
New-VDSwitch [-ContactDetails <String>] [-ContactName <String>] [-LinkDiscoveryProtocol <LinkDiscoveryProtocol>]
[-LinkDiscoveryProtocolOperation <LinkDiscoveryOperation>] -Location <VIContainer> [-MaxPorts <Int32>] [-Mtu
<Int32>] -Name <String> [-Notes <String>] [-NumUplinkPorts <Int32>] [-RunAsync] [-Server <VIServer[]>] [-Version
<String>] [-Confirm] [-WhatIf] [<CommonParameters>]
New-VDSwitch -Location <VIContainer> -Name <String> -ReferenceVDSwitch <VDSwitch> [-RunAsync] [-Server
<VIServer[]>] [-WithoutPortGroups] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet creates vSphere distributed switches. You can create a new vSphere distributed switch with custom
properties, specify a reference vSphere distributed switch to clone its configuration, or provide a backup profile
to import the switch configuration.
Note: Creating vSphere distributed switches from a reference switch or a backup profile requires vCenter Server
5.1 or later.
PARAMETERS
-BackupPath <String>
Specifies the full file path to the .zip file containing the backup configuration that you want to import.
Only .zip files created with the Export-VDSwitch cmdlet are supported.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContactDetails <String>
Specifies the contact details of the vSphere distributed switch administrator.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ContactName <String>
Specifies the name of the vSphere distributed switch administrator.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-KeepIdentifiers [<SwitchParameter>]
Indicates that the original vSphere distributed switch and port group identifiers will be preserved. You
cannot specify this parameter, when the Name parameter is specified.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-LinkDiscoveryProtocol <LinkDiscoveryProtocol>
Specifies the discovery protocol type of the vSphere distributed switch that you want to create. This
parameter accepts CDP and LLDP values. If you do not set a value for this parameter, the default server
setting is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LinkDiscoveryProtocolOperation <LinkDiscoveryOperation>
Specifies the link discovery protocol operation for the vSphere distributed switch that you want to create.
This parameter accepts Advertise, Listen, Both, and Disabled values. If you do not set a value for this
parameter, the default server setting is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <VIContainer>
Specifies the location where you want to create the vSphere distributed switch. This parameter accepts
Datacenter and Folder objects.
Note: You cannot create distributed port groups with identical names in the same location. If you want to
import or clone a vSphere distributed switch with its distributed port groups, you need to specify a location
that does not contain identically named distributed port groups.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-MaxPorts <Int32>
Specifies the maximum number of ports allowed on the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Mtu <Int32>
Specifies the maximum MTU size for the vSphere distributed switch that you want to create. Valid values are
positive integers only.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies a name for the new vSphere distributed switch that you want to create. You cannot specify this
parameter, when the KeepIdentifiers parameter is specified.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Notes <String>
Specifies a description for the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-NumUplinkPorts <Int32>
Specifies the number of uplink ports on the vSphere distributed switch that you want to create.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReferenceVDSwitch <VDSwitch>
Specifies a reference vSphere distributed switch. The properties of the new vSphere distributed switch will be
cloned from the reference vSphere distributed switch.
Note: This parameter is supported only on vSphere 5.1 and later.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer[]>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of Connect-VIServer.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Version <String>
Specifies the version of the vSphere distributed switch that you want to create. This parameter accepts 4.0,
4.1.0, 5.0.0, 5.1.0, 5.5.0, 6.0.0, and 6.5.0 values. You cannot specify a version that is incompatible with
the version of the vCenter Server system you are connected to.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WithoutPortGroups [<SwitchParameter>]
Indicates that the new vSphere distributed switch will be created without importing the port groups from the
specified backup file or reference vSphere distributed switch.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created VDSwitch object
NOTES
-------------------------- Example 1 --------------------------
$myDatacenter = Get-Datacenter -Name "MyDatacenter"
New-VDSwitch -Name "MyVDSwitch" -Location $myDatacenter -LinkDiscoveryProtocol "LLDP"
-LinkDiscoveryProtocolOperation "Listen" -MaxPorts 256 -Version "5.0.0"
Creates a new vSphere distributed switch with the specified name, version, maximum number of ports, and link
discovery protocol settings in the specified datacenter.
-------------------------- Example 2 --------------------------
$myFolder = Get-Folder -Name "MyFolder"
Get-VDSwitch -Name "MyReferenceSwitch" | New-VDSwitch -Name "MyVDSwitch" -Location $myFolder -WithoutPortGroups
Creates a new vSphere distributed switch by cloning the configuration of the existing vSphere distributed switch
named "MyReferenceSwitch". The new vSphere distributed switch is created without cloning the existing port groups
and is stored in the specified folder.
-------------------------- Example 3 --------------------------
$myFolder = Get-Folder -Name "MyFolder"
New-VDSwitch -Name "MyVDSwitch" -Location $myFolder -WithoutPortGroups -BackupPath
"c:\\MyDistributedSwitchProfile.zip"
Creates a new vSphere distributed switch by importing the specified backup profile.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... witch.html
Get-VDSwitch
Remove-VDSwitch
Set-VDSwitch
Export-VDSwitch