Compare-VBREntraIDTenantItem

Short Description

Compares backed-up objects between two restore points or a restore point and the production state.

Applies to

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

Syntax

Compare-VBREntraIDTenantItem -Session <VBREntraIDTenantRestoreSession> -Item <VBREntraIDTenantItem> -OldRestorePoint <VBREntraIDTenantRestorePoint> [-NewRestorePoint <VBREntraIDTenantRestorePoint>] [-ShowUnchangedAttributes] [<CommonParameters>]

Detailed Description

This cmdlet compares backed-up objects between two restore points or a restore point and the production state.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Session

Specifies the restore session started to recover items backed-up by a tenant backup job.

Accepts the VBREntraIDTenantRestoreSession object. To create this object, run the Start-VBREntraIDTenantRestore cmdlet.

True

Named

False

Item

Specifies the backed-up object that you want to compare.

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

True

Named

False

OldRestorePoint

Specifies a restore point. The cmdlet will use this restore point as the starting point for the comparison.

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

True

Named

False

NewRestorePoint

Specifies a restore point. The cmdlet will use this restore point as the second point for the comparison.

Note: If you do not specify this parameter, the cmdlet will compare the restore point specified in OldRestorePoint with the production state of the backed-up object.

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

False

Named

False

ShowUnchangedAttributes

Defines that the cmdlet will show unchanged properties of the backed-up object.

Default: False.

SwichParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBREntraIDTenantItemComparisonResult object that contains compare state of backed-up objects.

Examples

This example shows how to compare user attributes.

$tenantRestoreSession = Get-VBREntraIDTenantRestoreSession -Id "901e32ac-4c9e-4f7a-9b36-a4fd0f7248fe"

$backup = Get-VBREntraIDTenantBackup -Name "Tenant backup"

$newRP = Get-VBREntraIDTenantRestorePoint -Backup $backup -Id "61448046-067f-4908-88ad-31e785477fc6"

$oldRP = Get-VBREntraIDTenantRestorePoint -Backup $backup -Id "a66808bc-780e-46f2-8538-63ace3c8f9be"

$item = Get-VBREntraIDTenantItem -Backup $backup -Type User -Name "Test Admin"

$compareInfo = Compare-VBREntraIDTenantItem -Session $tenantRestoreSession -Item $item -OldRestorePoint $oldRP -NewRestorePoint $newRP

Perform the following steps:

  1. Run the Get-VBREntraIDTenantRestoreSession cmdlet. Specify the Id parameter value. Save the result to the $tenantRestoreSession variable.
  2. Run the Get-VBREntraIDTenantBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
  3. Run the Get-VBREntraIDTenantRestorePoint cmdlet. Specify the following settings:
  • Set the $backup variable as the Backup parameter value.
  • Specify the Id parameter value.
  • Save the result to the $newRP variable.
  1. Run the Get-VBREntraIDTenantRestorePoint cmdlet. Specify the following settings:
  • Set the $backup variable as the Backup parameter value.
  • Specify the Id parameter value.
  • Save the result to the $oldRP variable.
  1. Run the Get-VBREntraIDTenantItem cmdlet. Specify the following settings:
  • Set the $backup variable as the Backup parameter value.
  • Specify the Type and Name parameter value.
  • Save the result to the $item variable.
  1. Run the Compare-VBREntraIDTenantItem cmdlet. Specify the following settings:
  • Set the $tenantRestoreSession variable as the Session parameter value.
  • Set the $item variable as the Item parameter value.
  • Set the $oldRP variable as the OldRestorePoint parameter value.
  • Set the $newRP variable as the NewRestorePoint parameter value.
  • Save the result to the $compareInfo variable.

Related Commands

Page updated 11/12/2024

Page content applies to build 12.3.0.310