Set-VBRComputerIndexingOptions

Short Description

Modifies indexing settings for Veeam Agent backup jobs.

Applies to

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

Syntax

Set-VBRComputerIndexingOptions -Options <VBRComputerIndexingOptions> [-IndexingMode <VBRIndexingMode> {Disable | IndexEverything | IndexIncludedOnly | IndexEverythingExceptExcluded}] [-IndexingInclusion <string[]>][-IndexingExclusion <string[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies indexing settings for Veeam Agent backup job. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Options

Specifies the protection group indexing options that you want to modify.

Accepts the VBRComputerIndexingOptions type.

True

Named

True (ByValue)

 

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.

False

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

 

<CommonParameters>

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 modify indexing settings for a Veeam Agent job that backs up Windows computers. Veeam Backup & Replication will change the indexing scope and will index everything except for system folders.

  1. Run Get-VBRProtectionGroup to get a protection group. Save the result to the $group variable.
  2. Run New-VBRComputerIndexingOptions with the $group variable. Save the result to the $index variable.
  3. Run Set-VBRComputerIndexingOptions with the $index variable. Use the IndexingMode parameter with the IndexEverything value to index everything.

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

$index = New-VBRComputerIndexingOptions -BackupObject $group -OSPlatform Windows -IndexingMode IndexIncludedOnly -IndexingInclusion "C:/Desktop/MyFolder"

Set-VBRComputerIndexingOptions -Options $index -IndexingMode IndexEverything

Related Commands

Get-VBRProtectionGroup

New-VBRComputerIndexingOptions