Restore-VEADItem

Short Description

Restores backed-up Active Directory objects and containers.

Applies to

Veeam Backup & Replication

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Restore backed-up Active Directory objects.

Restore-VEADItem -Item <VEADItem[]> -Server <String> -Credential <PSCredential> [-UseSSL] [-RestoreChangedObjects] [-RestoreDeletedObjects] [-ChangePasswordAtLogon] [-MergeAttributes] [-NewPassword <SecureString>] [-GcServer <String>] [-TargetContainer <VEADADContainer>] [-AccountState <VEADAccountState>] [-PasswordRestoreAction <VEADPasswordRestoreAction>] [<CommonParameters>]

  • Restore a backed-up Active Directory container.

Restore-VEADItem -Container <VEADContainer> -Server <String> -Credential <PSCredential> [-UseSSL] [-RestoreChangedObjects] [-RestoreDeletedObjects] [-ChangePasswordAtLogon] [-MergeAttributes] [-NewPassword <SecureString>] [-GcServer <String>] [-TargetContainer <VEADADContainer>] [-AccountState <VEADAccountState>] [-PasswordRestoreAction <VEADPasswordRestoreAction>] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Item

For restore of Active Directory objects.

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

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

True

Named

True (ByValue)

Container

For restore of Active Directory containers.

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

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

True

Named

True (ByValue)

Server

Specifies DNS name or IP address of the target server. The cmdlet will restore Active Directory objects and containers to this server.

String

True

Named

False

Credential

Specifies credential records that Veeam Explorer for Microsoft Active Directory will use to connect to the LDAP server.

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

True

Named

False

RestoreChangedObjects

Defines whether changed Active Directory objects will be restored.

If you provide this parameter, Veeam Explorer for Microsoft Active Directory will restore backed-up Active Directory objects. If the object is deleted, the cmdlet will skip this object.

Note: To run the cmdlet, you must provide either this or the RestoreDeletedObjects parameter.

SwitchParameter

False

Named

False

RestoreDeletedObjects

Defines whether deleted Active Directory objects will be restored.

If you provide this parameter, Veeam Explorer for Microsoft Active Directory will restore deleted Active Directory objects. If the object is not deleted, the cmdlet will skip this object.

Note: To run the cmdlet, you must provide either this or the RestoreChangedObjects parameter.

SwitchParameter

False

Named

False

UseSSL

Defines whether Veeam Explorer for Microsoft Active Directory will establish a secure SSL connection to the target server.

If you provide this parameter, Veeam Explorer for Microsoft Active Directory will connect over SSL to the target server. Otherwise, Veeam Explorer for Microsoft Active Directory will connect to the target server using a non-secure connection.

SwitchParameter

False

Named

False

GcServer

Specifies a Global Catalog server FQDN or IP address. Veeam Explorer for Microsoft Active Directory will use this server to look for the linked attributes of the objects in the AD domain tree.

If you do not provide this parameter, Veeam Explorer for Microsoft Active Directory will try to detect the Global Catalog server automatically.

String

False

Named

False

MergeAttributes

Defines whether multi-valued attributes of Active Directory objects will be merged.

If you provide this parameter, Veeam Explorer for Microsoft Active Directory will merge existing multi-valued attributes of Active Directory objects with multi-valued attributes from a backup file. Otherwise, the production multi-valued attributes will be replaced with multi-valued attributes from a backup file.

SwitchParameter

False

Named

False

PasswordRestoreAction

Specifies options for restoring user passwords. You can specify one of the following options:

  • OriginalPassword - To restore Active Directory objects with original user passwords.
  • NoPassword - To restore Active Directory objects without restoring user passwords.
  • NewPassword - To restore Active Directory objects with new passwords for users.

Note: For the NewPassword option, you must specify a new password with the NewPassword parameter.

VEADPasswordRestoreAction

False

Named

False

ChangePasswordAtLogon

For the PasswordRestoreAction parameter.

Defines whether users must restore the password after the restore completes. If you provide this parameter, users must change the password at next logon.

SwitchParameter

False

Named

False

NewPassword

For the PasswordRestoreAction parameter.

Specifies new passwords for users. Veeam Explorer for Microsoft Active Directory will restore Active Directory objects with this password.

Securestring

False

Named

False

TargetContainer

For restore to a different container.

Specifies the target container. Veeam Explorer for Microsoft Active Directory will restore objects and containers to this container.

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

False

Named

False

AccountState

Specifies a state of an Active Directory account. You can specify one of the following states:

  • SameAsInBackup - to keep an Active Directory account state the same as in a backup.
  • Enabled - to restore an Active Directory account with the enabled state.
  • Disabled - to restore an Active Directory account with the disabled state.

VEADAccountState

False

Named

False

<CommonParameters>

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

Output Object

None.

Examples

Restoring Objects

Restore-VEADItemExample 1. Restoring Active Directory Object to Server

Restore-VEADItemExample 2. Restoring Active Directory Object to Different Container

Restore-VEADItemExample 3. Restoring Active Directory Object with Custom Restore Options

Restoring containers

Restore-VEADItemExample 4. Restoring Active Directory Container to Different Server

Restore-VEADItemExample 5. Restoring Active Directory Container to Different Container

Restore-VEADItemExample 6. Restoring Active Directory Container with Custom Restore Options

Related Commands

Page updated 3/25/2025

Page content applies to build 12.3.1.1139