Stop-VBRCloudTapeRestore

In this article

    Short Description

    This cmdlet stops the restore session of the tenant data from tape.

    Applies to

    Product Edition: Enterprise

    Requires Cloud Connect license

    Syntax

    Stop-VBRCloudTapeRestore -Session <VBRBackupSession>  [<CommonParameters>]

    Detailed Description

    This cmdlet stops the restore session of the tenant data from tape.

    Run Start-VBRCloudTapeRestore to start the restore session.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Session

    Specifies the tape restore session that you want to stop.

    Accepts the VBRBackupSession type.

    True

    Named

    False

    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 start a restore session of the tenant backups and then to stop the running session of backups restore from the tape.

    1. Run Get-VBRCloudTapeBackupTenantRepository to get the necessary tenant backup repository. Save the result to the $repository variable.
    2. Run Start-VBRCloudTapeRestore with the $repository variable. Use the PointInTime parameter to specify the restore period.
    3. Run Get-VBRCloudTapeRestoreSession to get the tape restore session that you want to stop. Save the result to the $session variable.
    4. Run Set-VBRNDMPServer with the $session variable.

    $repository = Get-VBRCloudTapeBackupTenantRepository

    Start-VBRCloudTapeRestore -BackupObject $repository -PointInTime "11/26/18" -RunAsync

    CreationTime : 11/26/2018 5:47:38 PM

    EndTime      : 1/1/1900 12:00:00 AM

    JobId        : 3d6c6bc4-fca3-4815-854a-3e5095a2f452

    Result       : None

    State        : Starting

    Id           : aae753f4-bcbf-427b-9cb8-bc9ee92acb6b

    $session = Get-VBRCloudTapeRestoreSession -Id aae753f4-bcbf-427b-9cb8-bc9ee92acb6b

    Stop-VBRCloudTapeRestore -Session $session

    Related Commands

    Get-VBRCloudTapeBackupTenantRepository

    Start-VBRCloudTapeRestore

    Get-VBRCloudTapeRestoreSession