Set-VBOBackupItem

In this article

    Short Description

    Modifies organization object settings.

    Syntax

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

    Detailed Description

    This cmdlet modifies organization object settings.

    Parameters

    Parameter

    Description

    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

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

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

    False

    Named

    False

    False

    Mailbox

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

    False

    Named

    False

    False

    ArchiveMailbox

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

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

    False

    Named

    False

    False

    Sites

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

    False

    Named

    False

    False

    Teams

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

    False

    Named

    False

    False

    GroupMailbox

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

    False

    Named

    False

    False

    GroupSite

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

    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

    Example 1

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

    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 a "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 value for the User parameter and Mailbox, OneDrive and Sites parameters. Save the result to the $backupitem variable.
    4. Run the Set-VBOBackupItem cmdlet with the $backupitem value for the BackupItem parameter, ArchiveMailbox, OneDrive and Sites parameters, and a $false value for the Mailbox parameter to create a backup item with all "userAlpha" processing options except for the mailbox.

    $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

    Related Commands