Set-VBOBackupItem

In this article

    Short Description

    Modifies organization object settings.

    Syntax

    Set-VBOBackupItem -BackupItem <VBOBackupItem[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [-GroupMailbox] [-GroupSite] [-Teams] [-TeamsChats] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies organization object settings. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    BackupItem

    Specifies an organization object. The cmdlet will modify settings of this object.

    Accepts the VBOBackupItem[] object.

    To get this object, run the Get-VBOBackupItem cmdlet.

    True

    Named

    False

    False

    OneDrive

    Defines that the cmdlet will enable the OneDrive option for an object.

    Note: You cannot specify this parameter for the user of the PublicMailbox type.

    SwitchParameter

    False

    Named

    False

    False

    Mailbox

    Defines that the cmdlet will enable the mailbox option for an object.

    SwitchParameter

    False

    Named

    False

    False

    ArchiveMailbox

    Defines that the cmdlet will enable the archive mailbox option for an object.

    Note: You cannot specify this parameter for the user of the PublicMailbox type.

    SwitchParameter

    False

    Named

    False

    False

    Sites

    Defines that the cmdlet will enable the sites option for an object.

    SwitchParameter

    False

    Named

    False

    False

    Teams

    Defines that the cmdlet will enable the teams option for an object.

    SwitchParameter

    False

    Named

    False

    False

    TeamsChats

    Defines that the cmdlet will enable the team chats option for an object.

    Note: This parameter is available starting from Veeam Backup for Microsoft 365 version 6a (build 6.1.0.222).

    SwitchParameter

    False

    Named

    False

    False

    GroupMailbox

    Defines that the cmdlet will enable the group mailbox option for an object.

    SwitchParameter

    False

    Named

    False

    False

    GroupSite

    Defines that the cmdlet will enable the group site option for an object.

    SwitchParameter

    False

    Named

    False

    False

    <CommonParameters>

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

    Examples

    Set-VBOBackupItemExample 1. Modifying Processing Options of User Backup Item

    This example shows how to add all processing options except for the mailbox for a backup item with a user named userAlpha.

    $org = Get-VBOOrganization -Name "ABC"

    $user = Get-VBOOrganizationUser -Organization $org -Name "userAlpha"

    $backupitem = New-VBOBackupItem -User $user -Mailbox -ArchiveMailbox -OneDrive -Sites

    Set-VBOBackupItem -BackupItem $backupitem -Mailbox:$false -ArchiveMailbox -OneDrive -Sites

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name ABC. Save the result to the $org variable.
    2. Run the Get-VBOOrganizationUser cmdlet with the $org variable and the userAlpha value for the Name parameter to get a user with the name userAlpha. Save the result to the $user variable.
    3. Run the New-VBOBackupItem cmdlet with the $user variable as the User parameter value and Mailbox, ArchiveMailbox, OneDrive and Sites parameters. Save the result to the $backupitem variable.
    4. Run the Set-VBOBackupItem cmdlet with the $backupitem variable as the BackupItem parameter value, ArchiveMailbox, OneDrive and Sites parameters, and the :$false value for the Mailbox parameter to create a backup item with all userAlpha processing options except for the mailbox.

    Related Commands