This is an archive version of the document. To get the most up-to-date information, see the current version.

Export-VEADItem

Short Description

Exports backed-up Active Directory objects and containers.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Export Active Directory objects.

Export-VEADItem -Item <VEADItem[]> -Path <string> [-Force]  [<CommonParameters>]

  • Export Active Directory containers.

Export-VEADItem -Container <VEADContainer> -Path <string> [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet exports backed-up Active Directory objects and containers.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Item

For export of Active Directory objects.

Specifies an array of Active Directory objects. The cmdlet will export these objects.

Accepts the VEADItem[] object. To get this object, run the Get-VEADItem cmdlet.

True

Named

True (ByValue)

Container

For export of Active Directory containers.

Specifies an Active Directory container. The cmdlet will export that container.

Accepts the VEADContainer object. To get this object, run the Get-VEADContainer cmdlet.

True

Named

True (ByValue)

Path

Specifies the target path. The cmdlet will export Active Directory objects and containers to the location specified in this path.

String

True

Named

False

Force

Defines that the cmdlet will overwrite the existing Active Directory objects and containers with objects and containers from backup.

If you do not provide this parameter, the cmdlet will keep the existing version of Active Directory objects and containers.

Note: The cmdlet will show no prompt before executing the command.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.

Output Object

The cmdlet returns the VEADItem object that contains settings of exported backed-up Active Directory objects and containers.

Examples

Export-VEADItemExample 1. Exporting Active Directory Objects

Export-VEADItemExample 2. Exporting Active Directory Containers

Related Commands