New-VBOBackupItem

In this article

    Short Description

    Creates organization objects.

    Syntax

    This cmdlet provides the following parameter sets:

    • Creates objects that represent users.

    New-VBOBackupItem -User <VBOOrganizationUser[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites]  [<CommonParameters>]

    • Creates objects that represent organizations.

    New-VBOBackupItem -Organization <VBOOrganization[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [-Teams]  [<CommonParameters>]

    • Creates objects that represents sites.

    New-VBOBackupItem -Site <VBOOrganizationSite>  [<CommonParameters>]

    • Creates objects that represent groups.

    New-VBOBackupItem -Group <VBOOrganizationGroup[]> [-Mailbox] [-ArchiveMailbox] [-OneDrive] [-Sites] [-GroupMailbox] [-GroupSite]  [<CommonParameters>]

    • Creates objects that represent personal sites.

    New-VBOBackupItem -PersonalSites  [<CommonParameters>]

    • Creates objects that represent teams.

    New-VBOBackupItem -Team <VBOOrganizationTeam[]>  [<CommonParameters>]

    Detailed Description

    Creates organization objects. You can add or exclude these objects from a backup job.

    For more information on object types, see the Organization Object Types section of the Veeam Backup for Microsoft Office 365 User Guide.

    Run the Add-VBOBackupItem cmdlet to create a list of objects included in a backup job. The job will back up these objects.

    Run the Add-VBOExcludedBackupItem cmdlet to create a list of objects excluded from a backup job. The job will exclude these objects from backup.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Organization

    Specifies an array of organizations added to Veeam Backup for Microsoft Office 365. The cmdlet will create an organization object that contains an organization.

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

    True

    Named

    False

    False

    User

    Specifies an array of users added to Veeam Backup for Microsoft Office 365. The cmdlet will create an organization object that contains a user.

    Accepts the VBOOrganizationUser object.

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

    True

    Named

    False

    False

    Group

    Specifies an array of groups added to Veeam Backup for Microsoft Office 365. The cmdlet will create an organization object that contains a group.

    Accepts the VBOOrganizationGroup object.

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

    True

    Named

    False

    False

    Site

    Specifies an array of sites added to Veeam Backup for Microsoft Office 365. The cmdlet will create an organization object that contains a site.

    Accepts the VBOOrganizationSite object.

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

    True

    Named

    False

    False

    Team

    Specifies an array of teams added to Veeam Backup for Microsoft Office 365. The cmdlet will create an organization object that contains a team.

    Accepts the VBOOrganizationTeam object.

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

    True

    Named

    False

    False

    PersonalSites

    Indicates that the cmdlet will create an organization object with the personal sites option enabled.

    Can be used only in a standalone parameter set.

    True

    Named

    False

    False

    OneDrive

    Indicates that the cmdlet will create an organization object that will have the OneDrive option enabled.

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

    False

    Named

    False

    False

    Mailbox

    Indicates that the cmdlet will create an organization object that will have the mailbox option enabled.

    False

    Named

    False

    False

    ArchiveMailbox

    Indicates that the cmdlet will create an organization object that will have the archived mailbox option enabled.

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

    False

    Named

    False

    False

    Sites

    Indicates that the cmdlet will create an organization object that will have the sites option enabled.

    False

    Named

    False

    False

    Teams

    Indicates that the cmdlet will create an organization object that will have the teams option enabled.

    False

    Named

    False

    False

    GroupMailbox

    Indicates that the cmdlet will create an organization object that will have the group mailbox enabled.

    False

    Named

    False

    False

    GroupSite

    Indicates that the cmdlet will create an organization object that will have the group site option enabled.

    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 create an organization object that contains a user. An object will be created with the following settings:

    • The object will contain the William Sonders user.
    • The object will have all options enabled except for the mailbox.

    You must perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Set ABC as the Name parameter value. Save the result to the $org variable.
    2. Run the Get-VBOOrganizationUser cmdlet. Set the $org variable as the Organization parameter value. Set William Sonders as the Name parameter value. Save the result to the $user variable.
    3. Run the New-VBOBackupItem cmdlet. Specify the following settings:
    • Set the $user value for the User parameter.
    • Set the ArchiveMailbox and OneDrive parameters.
    • Set the $false value for the Mailbox parameter.

    $org = Get-VBOOrganization -Name "ABC"

    $user = Get-VBOOrganizationUser -Organization $org -Name "William Sonders"

    New-VBOBackupItem -User $user -Mailbox:$false -ArchiveMailbox -OneDrive

    Example 2

    This example shows how to create a backup item with an organization "ABC" mailbox, archive mailbox and all of the sites but without the OneDrive processing option:

    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 New-VBOBackupItem cmdlet with the $org value for the Organization parameter, Mailbox, Archive Mailbox and Sites parameters, and a $false value for the OneDrive parameter to create a backup item with all "ABC" organization processing options except for the OneDrive components.

    $org = Get-VBOOrganization -Name "ABC"

    New-VBOBackupItem -Organization $org -Mailbox -ArchiveMailbox -OneDrive$:false -Sites

    Example 3

    This example shows how to create a backup item with an "ABC" organization site with a given URL:

    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. Save a certain SharePoint organization site URL address to the $siteUrl variable.
    3. Run the Get-VBOOrganizationSite cmdlet with the $org variable and the $siteURL value for the URL parameter to get an "ABC" organization site. Save the result to the $site variable.
    4. Run the New-VBOBackupItem cmdlet with the $site variable to create a backup item with "ABC" organization site with a given URL.

    $org = Get-VBOOrganization -Name "ABC"

    $siteUrl = "https://exampleorganization.sharepoint.com/sites/exampleparentsite"

    $site = Get-VBOOrganizationSite -Organization $org -URL $siteUrl

    New-VBOBackupItem -Site $site

    Example 4

    This example shows how to create a backup item with all processing options for the "UsersAlpha" organization user group:

    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-VBOOrganizationGroup cmdlet with the $org variable and a "UsersAlpha" value for the Name parameter to get an organization user group with the name "UsersAlpha". Save the result to the $group variable.
    3. Run the New-VBOBackupItem cmdlet with the $group value for the Group parameter and Mailbox, ArchiveMailbox, OneDrive, Sites, GroupMailbox and GroupSite parameters, to create a backup item with all processing options for the "UsersAlpha" organization user group.

    $org = Get-VBOOrganization -Name "ABC"

    $group = Get-VBOOrganizationGroup -Organization $org -Name "UsersAlpha"

    New-VBOBackupItem -Group $group -Mailbox -ArchiveMailbox -OneDrive -Sites -GroupMailbox -GroupSite

    Example 5

    This command creates a backup item with a personal sites processing option:

    New-VBOBackupItem -PersonalSites

    Related Commands