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

This example shows how to export backed-up Active Directory objects.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$parentcontainer = Get-VEADContainer -Domain $domain

$object = Get-VEADItem -Container $parentcontainer[3]

Export-VEADItem -Item $object -Path "C:\AD objects"

Perform the following steps:

  1. Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  2. Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $parentcontainer variable.
  3. Run the Get-VEADItem cmdlet. Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container. Save the result to the $object variable.
  4. Run the Export-VEADItem cmdlet. Set the $object variable as the Item parameter value. Specify the Path parameter value.

Export-VEADItemExample 2. Exporting Active Directory Containers

The following request returns license usage data for the VAO server with the ID 76da0d75-75b0-4675-8296-0142ad0d52a7.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$container = Get-VEADContainer -Domain $domain

Export-VEADItem -Container $container[3] -Path "C:\AD objects"

Perform the following steps:

  1. Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  2. Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value.  Save the result to the $container variable.
  3. Run the Export-VEADItem cmdlet. Set the $container[3] variable as the Container parameter value. Specify the Path parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.