vSphere PowerCLI Reference

Export-VDSwitch

Synopsis

This cmdlet exports the configuration of a specified vSphere distributed switch to a .zip file.

Syntax

Export-VDSwitch [-VDSwitch] <VDSwitch[]> [-WithoutPortGroups] [-Description <String>] [-Destination <String>] [-Force] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Get-VDSwitch
New-VDSwitch
Remove-VDSwitch
Set-VDSwitch

Detailed Description

This cmdlet exports the configuration of a specified vSphere distributed switch to a .zip file.

Note: This cmdlet is supported only on vCenter Server 5.1 or later.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VDSwitchVDSwitch[]Specifies the vSphere distributed switch whose configuration you want to export.truetrue (ByValue)
DescriptionStringSpecifies a description for the exported vSphere distributed switch configuration.falsefalse
DestinationStringSpecifies an absolute or a relative file path to the location where you want to export the vSphere distributed switch configuration.falsefalse[file system provider location]\[port group name]-[timestamp].backup.zip
ForceSwitchParameterIndicates that if the specified destination file already exists, the existing file is overwritten. Any directories required to complete the specified file path are also created.falsefalse
ServerVIServer[]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.falsefalse
WithoutPortGroupsSwitchParameterIndicates that the configuration of the vSphere distributed switch is exported without its port group configuration.falsefalse

Return Type

One FileInfo object that contains information about the exported .zip file

Notes

Examples

-------------- Example 1 --------------

Get-VDSwitch -Name 'MyVDSwitch' | Export-VDSwitch -Description "My VDSwitch configuration" -Destination "c:\myVDSwitchConfig.zip"

Exports the configuration of the specified vSphere distributed switch and its port groups to the specified file.

-------------- Example 2 --------------

Get-VDSwitch -Name 'MyVDSwitch' | Export-VDSwitch -Description "My VDSwitch configuration" -Destination "c:\myVDSwitchConfig.zip" -WithoutPortGroups -Force

Exports the configuration of the specified vSphere distributed switch and its port groups to the specified file. If the myVDSwitchConfig.zip file already exists, it is overwritten.


Copyright © 1998 - 2013 VMware, Inc. All rights reserved.