PowerCLI Reference

Export-VDPortGroup

Synopsis

This cmdlet exports the configuration of a specified distributed port group to a specified .zip file.

Syntax

Export-VDPortGroup [-VDPortGroup] <VDPortgroup[]> [-Description <String>] [-Destination <String>] [-Force] [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version
Get-VDPortgroup
New-VDPortgroup
Remove-VDPortGroup
Set-VDPortgroup

Detailed Description

This cmdlet exports the configuration of a specified distributed port group to a specified .zip file. You can export only vSphere distributed port groups.


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

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VDPortGroupVDPortgroup[]Specifies the distributed port group whose configuration you want to export.trueTrue (ByValue)
DescriptionStringSpecifies a description for the exported distributed port group configuration.falseFalse
DestinationStringSpecifies an absolute or a relative file path to the location where you want to export the configuration of the distributed port group.falseFalse
ForceSwitchParameterIndicates that if the specified destination file already exists, the existing file will be overwritten. Any directories required to complete the specified file path will also be 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

Return Type

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

Notes

Examples

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

Get-VDPortGroup -Name 'MyVDPortGroup' | Export-VDPortGroup -Destination 'C:\MyVDSwitchesBackup\MyVDPortGroup_21122012.zip'

Exports the configuration of the specified port group to the specified file.

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

$myPortGroup = Get-VDPortGroup -Name 'MyVDPortGroup'
Export-VDPortGroup -VDPortGroup $myPortGroup -Destination 'C:\MyVDSwitchesBackup\MyVDPortGroupBackup.zip' -Force

Exports the configuration of the specified port group to the specified file. If the MyVDSwitchesBackup directory does not exist, it is created. If the MyVDPortGroupBackup.zip file already exists in the specified location, it is overwritten.


Copyright © VMware, Inc. All rights reserved.