Syntax
Export-VDSwitch [-VDSwitch] <VDSwitch[]> [-WithoutPortGroups] [-Description <String>] [-Destination <String>] [-Force] [-Server <VIServer[]>] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet exports the configuration of a specified vSphere distributed switch to a .zip file.Parameters
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
VDSwitch | VDSwitch[] | Specifies the vSphere distributed switch whose configuration you want to export. | true | true (ByValue) | |
Description | String | Specifies a description for the exported vSphere distributed switch configuration. | false | false | |
Destination | String | Specifies an absolute or a relative file path to the location where you want to export the vSphere distributed switch configuration. | false | false | |
Force | SwitchParameter | Indicates 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. | false | 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. | false | false | |
WithoutPortGroups | SwitchParameter | Indicates that the configuration of the vSphere distributed switch is exported without its port group configuration. | false | false |
Return Type
One FileInfo object that contains information about the exported .zip fileNotes
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.