< Back

Export-VDSwitch

Sun Jan 19, 2020 7:22 pm

NAME Export-VDSwitch



SYNOPSIS

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





SYNTAX

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

<VIServer[]>] [-WithoutPortGroups] [<CommonParameters>]





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

-Description <String>

Specifies a description for the exported vSphere distributed switch configuration.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Destination <String>

Specifies an absolute or a relative file path to the location where you want to export the vSphere distributed

switch configuration.



Required? false

Position? named

Default value [file system provider location]\\[port group name]-[timestamp].backup.zip

Accept pipeline input? False

Accept wildcard characters? 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.



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? false



-VDSwitch <VDSwitch[]>

Specifies the vSphere distributed switch whose configuration you want to export.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-WithoutPortGroups [<SwitchParameter>]

Indicates that the configuration of the vSphere distributed switch is exported without its port group

configuration.



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

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







NOTES









-------------------------- 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 LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... witch.html

Get-VDSwitch

New-VDSwitch

Remove-VDSwitch

Set-VDSwitch