Get-VBRNASInstantRecovery

In this article

    Short Description

    Returns active instant restore sessions started to recover backups created by file share backup jobs.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get all instant restore sessions started to recover backups created by file share backup jobs.

    Get-VBRNASInstantRecovery [-All]  [<CommonParameters>]

    • Get instant restore sessions started to recover backups created by file share backup jobs. In this case, the cmdlet will return sessions with specified IDs.

    Get-VBRNASInstantRecovery -Id <guid[]>  [<CommonParameters>]

    • Get instant restore sessions started to recover backups created by file share backup jobs. In this case, the cmdlet will return sessions with specified parameters.

    Get-VBRNASInstantRecovery -NASBackupName <string> -NASServerName <string>  [<CommonParameters>]

    Detailed Description

    This cmdlet returns active instant restore sessions started to recover backups created by file share backup jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    All

    Defines that the cmdlet will return all active instant restore sessions started to recover backups created by file share backup jobs.

    SwitchParameter

    False

    Named

    False

    Id

    Specifies the array of instant restore session IDs. The cmdlet will return the instant restore sessions with these IDs.

    Guid[]

    True

    Named

    True (ByPropertyName)

    NASBackupName

    Specifies a name of the file share backup for which the instant restore session was started. The cmdlet will return the instant restore session started to recover backups created by the file share backup job with this name.

    String

    True

    Named

    True (ByPropertyName)

    NASServerName

    Specifies a name of the host with the repository and mount service where the SMB share is published. The cmdlet will return the instant restore session using this host.

    String

    True

    Named

    True (ByPropertyName)

    <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 VBRNASInstantRecovery[] object that defines the file share backup recovery session settings.

    Examples

    Get-VBRNASInstantRecoveryExample 1. Getting All Instant Restore Sessions for NAS Backups

    This command returns all instant restore sessions for NAS backups.

    Get-VBRNASInstantRecovery

    Get-VBRNASInstantRecoveryExample 2. Getting Instant Restore Sessions for NAS Backups by Session IDs

    This command returns instant restore sessions for NAS backups by restore session IDs.

    Get-VBRNASInstantRecovery -Id ("49664A5F-9C55-4A1F-8E6A-1CD5705A684B", "42696B53-6FEC-4148-9354-AA9E4B52DED9")

    Get-VBRNASInstantRecoveryExample 3. Getting Instant Restore Sessions for NAS Backups by Parameters

    This command returns instant restore sessions for NAS backups with certain parameters.

    Get-VBRNASInstantRecovery -NASBackupName "Daily SMB1 Backup" -NASServerName "ontap-2"