Move-VBOEntityData

Short Description

Moves organization data from one repository to another.

Syntax

This cmdlet provides the following parameter sets.

  • Move of organization user data:

Move-VBOEntityData -From <VBORepository> -To <VBORepository> -User <VBOUserData> [-Mailbox [<SwitchParameter>]] [-ArchiveMailbox [<SwitchParameter>]] [-OneDrive [<SwitchParameter>]] [-Sites [<SwitchParameter>]] [-RunAsync [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]]  [<CommonParameters>]

  • Move of organization group data:

Move-VBOEntityData -From <VBORepository> -To <VBORepository> -Group <VBOGroupData> [-Mailbox [<SwitchParameter>]] [-ArchiveMailbox [<SwitchParameter>]] [-OneDrive [<SwitchParameter>]] [-Sites [<SwitchParameter>]] [-GroupMailbox [<SwitchParameter>]] [-GroupSite [<SwitchParameter>]] [-RunAsync [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]]  [<CommonParameters>]

  • Move of organization site data:

Move-VBOEntityData -From <VBORepository> -To <VBORepository> -Site <VBOSiteData> [-RunAsync [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]]  [<CommonParameters>]

Detailed Description

This cmdlet moves the organization data between repositories and supports the following scenarios:

  • Data move from one local repository to another local repository.
  • Data move from a local repository to a backup repository extended with object storage. The data will be moved to object storage.

 

Move-VBOEntityData Important!

Data move from an object storage repository to a local repository is not supported.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

From

Specifies the source repository. The cmdlet will move data from this repository.

True

Named

False

False

To

Specifies the target repository for backed-up data. The cmdlet will move data to this repository. You can specify one of the following types of repositories:

  • Local backup repository
  • Backup repository extended with object storage

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

True

Named

False

False

User

Specifies the organization user entity.

True

Named

True (ByValue)

False

Mailbox

Indicates that this cmdlet will move the entity mailbox data.

False

Named

False

False

ArchiveMailbox

Indicates that this cmdlet will move the entity archive mailbox data.

False

Named

False

False

OneDrive

Indicates that this cmdlet will move the entity OneDrive data.

False

Named

False

False

Sites

Indicates that this cmdlet will move the entity sites data.

False

Named

False

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

False

Named

False

False

Group

Specifies the organization group entity.

True

Named

True (ByValue)

False

GroupMailbox

Indicates that this cmdlet will move the organization group mailbox data.

False

Named

False

False

GroupSite

Indicates that this cmdlet will move the organization group site data.

False

Named

False

False

Site

Specifies the organization site entity.

True

Named

True (ByValue)

False

<CommonParameters>

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

Example 1

This example shows how to move data of a user with a name "Chuck Brown" from one repository to another.

  1. Run Get-VBORepository with the Name parameter to get the source repository. Save the result to the $repository variable.
  2. Run Get-VBORepository with the Name parameter to get the destination repository. Save result to the $destination variable
  3. Run Get-VBOEntityData with the Name parameter and a $repository variable. Save result to the $user variable.
  4. Run Move-VBOEntityData with the $repository, $destination and $user variables and Mailbox, ArchiveMailbox, OneDrive and Sites parameters to move the corresponding data to the specified repository.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$destination = Get-VBORepository -Name "support_north"

$user = Get-VBOEntityData -Type User -Repository $repository -Name "Chuck Brown"

Move-VBOEntityData -From $repository -To $destination -User $user -Mailbox -ArchiveMailbox -OneDrive -Sites

Example 2

This example shows how to move data of an organization group with a name "support" from one repository to another.

  1. Run Get-VBORepository with the Name parameter to get the source repository. Save the result to the $repository variable.
  2. Run Get-VBORepository with the Name parameter to get the destination repository. Save result to the $destination variable
  3. Run Get-VBOEntityData with the Name parameter and a $repository variable. Save result to the $group variable.
  4. Run Move-VBOEntityData with the $repository, $destination and $group variables and Mailbox, ArchiveMailbox, OneDrive, Sites, GroupMailbox and GroupSite parameters to move the corresponding data to the specified repository.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$destination = Get-VBORepository -Name "support_north"

$group = Get-VBOEntityData -Type Group -Repository $repository -Name "support"

Move-VBOEntityData -From $repository -To $destination -Group $group -Mailbox -ArchiveMailbox -OneDrive -Sites -GroupMailbox -GroupSite

Example 3

This example shows how to move data of an organization site with a name "support" from one repository to another.

  1. Run Get-VBORepository with the Name parameter to get the source repository. Save the result to the $repository variable.
  2. Run Get-VBORepository with the Name parameter to get the destination repository. Save result to the $destination variable
  3. Run Get-VBOEntityData with the Name parameter and a $repository variable. Save result to the $site variable.
  4. Run Move-VBOEntityData with the $repository, $destination and $site variables to move the corresponding data to the specified repository.

$repository = Get-VBORepository -Name "ABC Daily Backup"

$destination = Get-VBORepository -Name "support_north"

$group = Get-VBOEntityData -Type Site -Repository $repository -Name "support"

Move-VBOEntityData -From $repository -To $destination -Site $site

Example 4

This example shows how to move the Chuck Brown user data from a local repository to an object storage repository.

  1. Run Get-VBORepository with the Name parameter to get the source repository. Save the result to the $repository variable.
  2. Run Get-VBORepository with the Name parameter to get the destination repository. Save result to the $destination variable.
  3. Run Get-VBOEntityData with the Type and Name parameters and the $source variable. Save result to the $user variable.
  4. Run Move-VBOEntityData with the $source, $target and $user variables to move the corresponding data to the specified repository.

$source = Get-VBORepository -Name "ABC Daily Backup"

$target = Get-VBORepository -Name "Extended Backup Repository Name"

$user = Get-VBOEntityData -Type User -Repository $source -Name "Chuck Brown"

Move-VBOEntityData -From $source -To $target -User $user -Mailbox -ArchiveMailbox -RunAsync

Related Commands

Get-VBORepository

Get-VBOEntityData

I want to report a typo

There is a misspelling right here:

 

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