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

Enable-VBRJobGuestFSIndexing

In this article

    Short Description

    Enables job guest file system indexing option.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    Enable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Related Commands

    Get-VBRJob

    Detailed Description

    This cmdlet enables guest file system indexing in the selected job.

    Guest file system indexing is cataloging the guest VM files during the backup. Indexing helps you recognize files stored on guest VM. If you backup your VMs without guest file system indexing option, you will not be able to perform guest OS files restore.

    You can enable the guest file system indexing settings in case you have these settings set beforehand. Use this cmdlet to enable the indexing option that was disabled with Disable-VBRJobGuestFSIndexing.

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Job

    Specifies the job you want to edit.

    You can assign multiple jobs to this object.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example 1

    This command enables the guest file system indexing option in jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down.

    PS C:\PS> Get-VBRJob -Name Name "Backup Job 01", "Backup Job 02" | Enable-VBRJobGuestFSIndexing

    Example 2

    This command enables the guest file system indexing option in the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand.

    PS C:\PS> Enable-VBRJobGuestFSIndexing -Job $job