Get-VBOExcludedBackupItem

In this article

    Short Description

    Returns a list of objects excluded from a backup job.

    Syntax

    Get-VBOExcludedBackupItem -Job <VBOJob> [-Name <string>] [-Users <switchparameter>] [-Groups <switchparameter>] [-Sites <switchparameter>] [-PersonalSites <switchparameter>] [-TeamsGroups <switchparameter>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns a list of objects excluded from a backup job.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a backup job. The cmdlet will return objects excluded from this job.

    Accepts the VBOJob object.

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

    True

    Named

    False

    False

    Name

    Specifies a name of an object. The cmdlet will return all objects with this name.

    Note: If you want to get a specific type of an object, you must also set either of the following parameters:

    • Organization
    • Users
    • Groups
    • Sites
    • PersonalSites
    • TeamsGroups

    String

    False

    Named

    False

    True

    Users

    Defines that the cmdlet will return users excluded from a backup job.

    SwitchParameter

    False

    Named

    False

    False

    Groups

    Defines that the cmdlet will return groups excluded from a backup job.

    SwitchParameter

    False

    Named

    False

    False

    Sites

    Defines that the cmdlet will return sites excluded from a backup job.

    SwitchParameter

    False

    Named

    False

    False

    PersonalSites

    Defines that the cmdlet will return personal sites excluded from a backup job.

    SwitchParameter

    False

    Named

    False

    False

    TeamsGroups

    Defines that the cmdlet will return teams excluded from a backup job.

    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

    Get-VBOExcludedBackupItemExample 1. Getting Excluded Objects

    This example shows how to get a list of objects excluded from the Monthly Backup job.

    $job = Get-VBOJob -Name "Monthly Backup"

    Get-VBOExcludedBackupItem -Job $job

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Set Monthly Backup as the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBOExcludedBackupItem cmdlet. Set the $job variable as the Job parameter value.

    Get-VBOExcludedBackupItemExample 2. Getting Excluded Groups

    This example shows how to get a list of groups excluded from the Yearly Backup job.

    $job = Get-VBOJob -Name "Yearly Backup"

    Get-VBOExcludedBackupItem -Job $job -Groups

    Perform the following steps:

    1. Run the Get-VBOJob cmdlet. Set Yearly Backup as the Name parameter value. Save the result to the $job variable.
    2. Run the Get-VBOExcludedBackupItem cmdlet. Set the $job variable as the Job parameter value. Provide the Groups parameter.

    Related Commands

    Get-VBOJob