Enable-VBRJobGuestFSIndexing

Short Description

Enables job guest file system indexing option.

Platform: VMware, Hyper-V

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

Syntax

Enable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]> [<CommonParameters>]

Detailed Description

This cmdlet enables guest file system indexing in the selected job. You can enable the guest file system indexing settings in case you have these settings set beforehand.

You can run this cmdlet with backup and replica jobs including Cloud jobs.

Run the Disable-VBRJobGuestFSIndexingDisables job guest file system indexing option. cmdlet to disable the guest file system indexing option.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the array of jobs. The cmdlet will enable guest file system indexing for these jobs.

Accepts the CBackupJob[] object. To create this object, run the Get-VBRJobReturns existing jobs. cmdlet.

CBackupJob[]

True

0

True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Enable-VBRJobGuestFSIndexingExample 1. Enabling Guest File System Indexing Option [Using Pipeline]

This example shows how to enable the guest file system indexing option in the Backup Job 01 and Backup Job 02 jobs.

Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Enable-VBRJobGuestFSIndexing

Perform the following steps:

  1. Run the Get-VBRJobReturns existing jobs. cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Enable-VBRJobGuestFSIndexing cmdlet.

Enable-VBRJobGuestFSIndexingExample 2. Enabling Guest File System Indexing Option [Using Variable]

This example shows how to enable the guest file system indexing option in the job represented by the $job variable.

$job = Get-VBRJob -Name "Backup Job 01"

Enable-VBRJobGuestFSIndexing -Job $job

Perform the following steps:

  1. Run the Get-VBRJobReturns existing jobs. cmdlet. Specify the Name parameter values. Save the result to the $job variable.
  2. Run the Enable-VBRJobGuestFSIndexing cmdlet. Set the $job variable as the Job parameter value.

Get-VBRJobReturns existing jobs.

Page updated 2026-08-19

Page content applies to build 13.1.1.18