< Back

Export-VDPortGroup

Sun Jan 19, 2020 7:22 pm

NAME 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>]





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

-Description <String>

Specifies a description for the exported distributed port group 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 configuration of

the distributed port group.



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 will be overwritten. Any

directories required to complete the specified file path will also be 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



-VDPortGroup <VDPortgroup[]>

Specifies the distributed port group whose configuration you want to export.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

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



RELATED LINKS

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

Get-VDPortgroup

New-VDPortgroup

Remove-VDPortGroup

Set-VDPortgroup