Start-VBRNASBackupHealthCheck

In this article

    Short Description

    Performs a health check for file backup jobs.

    Applies to

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

    Syntax

    Start-VBRNASBackupHealthCheck -Job <CBackupJob[]> [-Repair] [-RunAsync]  [<CommonParameters>]

    Detailed Description

    This cmdlet performs a health check for file backup jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a file backup job. The cmdlet will perform a health check for this backup job.

    Accepts the CBackupJob[] object. To get this object, run the Get-VBRNASBackupJob cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    Repair

    Defines that the cmdlet will repair missing data and metadata.

    If you provide this parameter, the cmdlet will repair the missing metadata. Otherwise, the cmdlet will perform a health check of backup files and if corruption is detected, it will return a notification.

    SwitchParameter

    False

    Named

    False

     

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    SwitchParameter

    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.

    Output Object

    The cmdlet returns the VBRNASBackupHealthCheck object that contains results of a health check for file backup jobs.

    Examples

    Start-VBRNASBackupHealthCheckExample 1. Performing Health Check

    This example shows how to perform a health check for a file backup job.

    $job = Get-VBRNASBackupJob

    Start-VBRNASBackupHealthCheck -Job $job

    Perform the following steps:

    1. Run the Get-VBRNASBackupJob cmdlet. Save the result to the $job variable.
    2. Run the Start-VBRNASBackupHealthCheck cmdlet. Set the $job variable as the Job parameter value.

    Start-VBRNASBackupHealthCheckExample 2. Performing Health Check with Repair

    This example shows how to perform a health check for a file backup job. Veeam Backup & Replication will repair corrupted data if the health check detects them.

    $job = Get-VBRNASBackupJob

    Start-VBRNASBackupHealthCheck -Job $job -Repair

    Perform the following steps:

    1. Run the Get-VBRNASBackupJob cmdlet. Save the result to the $job variable.
    2. Run the Start-VBRNASBackupHealthCheck cmdlet. Set the $job variable as the Job parameter value. Specify the Repair parameter.

    Related Commands

    Get-VBRNASBackupJob