Export-VDSwitch

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
VDSwitch
VDSwitch[] named
  • pipeline
  • Specifies the vSphere distributed switch whose configuration you want to export.
    optional
    Description
    String named Specifies a description for the exported vSphere distributed switch configuration.
    optional
    Destination
    String named Specifies an absolute or a relative file path to the location where you want to export the vSphere distributed switch configuration.
    optional
    Force
    SwitchParameter named 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.
    optional
    Server
    VIServer[] named Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    WithoutPortGroups
    SwitchParameter named Indicates that the configuration of the vSphere distributed switch is exported without its port group configuration.

    Output

    System.IO.FileInfo

    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.

    Related Commands

    Feedback

    Was this page helpful?