This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBOExcludedBackupitem
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 | 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:
| False | Named | False | False |
Users | Specifies that the cmdlet will return users excluded from a backup job. | False | Named | False | False |
Groups | Specifies that the cmdlet will return groups excluded from a backup job. | False | Named | False | False |
Sites | Specifies that the cmdlet will return sites excluded from a backup job. | False | Named | False | False |
PersonalSites | Specifies that the cmdlet will return personal sites excluded from a backup job. | False | Named | False | False |
TeamsGroups | Specifies that the cmdlet will return teams excluded from a backup job. | 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 get a list of objects excluded from the Monthly Backup job.
- Run the Get-VBOJob cmdlet. Set Monthly Backup as the Name parameter value. Save the result to the $job variable.
- Run the Get-VBOExcludedBackupItem cmdlet. Set the $job variable as the Job parameter value.
$job = Get-VBOJob -Name "Monthly Backup" Get-VBOExcludedBackupItem -Job $job |
Example 2
This example shows how to get a list of groups excluded from the Yearly Backup job.
- Run the Get-VBOJob cmdlet. Set Yearly Backup as the Name parameter value. Save the result to the $job variable.
- Run the Get-VBOExcludedBackupItem cmdlet. Set the $job variable as the Job parameter value. Set the Groups parameter.
$job = Get-VBOJob -Name "Yearly Backup" Get-VBOExcludedBackupItem -Job $job -Groups |
Related Commands