This is an archive version of the document. To get the most up-to-date information, see the current version.

New-VBRComputerIndexingOptions

Short Description

Creates indexing settings for Veeam Agent backup jobs.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

New-VBRComputerIndexingOptions -BackupObject <Object> -OSPlatform <VBRAgentType> {Windows | Linux | Mac} -IndexingMode <VBRIndexingMode> {Disable | IndexEverything | IndexIncludedOnly | IndexEverythingExceptExcluded}[-IndexingInclusion <string[]>] [-IndexingExclusion <string[]>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRComputerIndexingOptions object that contains file indexing settings for Veeam Agent backup jobs.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
BackupObject	Specifies the protection group, for which you want to add indexing settings.	True	Named	True (ByValue)
OSPlatform	Specifies the OS of the protected computers: Windows: for Windows computers. Linux: for Linux computers. Mac: for macOS computers. NOTE: Indexing for macOS computers is not supported in current version of Veeam PowerShell.	True	Named	False
IndexingMode	Specifies indexing scope settings: Disable: select this option to disable indexing mode. IndexEverything: select this option to index all files within the backup scope. IndexIncludedOnly: select this option to specify folders that you want to index. NOTE: Not available for the backup policy that Veeam Agent job applies to Linux machines with file-level backup scope. IndexEverythingExcept Excluded: select this option to index all directories on the protected computer except for those you want to exclude from indexing. NOTE: Not available for the backup policy that Veeam Agent job applies to Linux machines with file-level backup scope. NOTE: Veeam Backup & Replication will exclude the system directories from indexing.	True	Named	False
IndexingInclusion	For the IndexIncludedOnly mode. Specifies the list of the folders that you want to index.	False	Named	False
IndexingExclusion	For the IndexEverythingExceptExcluded mode. Specifies the list of the folders that you want to exclude from indexing.	False	Named	False

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

Return Type

Example

This example shows how to create indexing settings for a Veeam Agent job that backs up Linux computers. Veeam Backup & Replication will index everything except for:

System directories.
The /home/administrator/videos/ directory.

To create indexing settings for the Veeam Agent backup job, perform the following steps:

Run Get-VBRProtectionGroup to get the protection group. Save the result to the $group variable.
Run New-VBRComputerIndexingOptions with the $group variable. Use the IndexingMode parameter to specify the indexing scope and the IdexingExclusion parameter to specify the exclusions.

$group = Get-VBRProtectionGroup -Name "Linux Group"

New-VBRComputerIndexingOptions -BackupObject $group -OSPlatform Linux -IndexingMode IndexEverythingExceptExcluded -IndexingExclusion "/home/administrator/videos/"

Related Commands

Get-VBRProtectionGroup