Convert-VBRNASBackupStorageFormat

In this article

    Short Description

    Converts format of baskets used for storing backups created with file share backup and file share backup copy jobs.

    Applies to

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

    Syntax

    Convert-VBRNASBackupStorageFormat -Job <CBackupJob[]> [-RunAsync] [-BasketType {Automatic | SingleFileBasket | Classic}]  [<CommonParameters>]

    Detailed Description

    The cmdlet converts format of baskets used for storing backups created with file share backup and file share backup copy jobs.

    File share backups can be stored either in baskets containing up to 16 standard blob files each up to 64 MB in size, or in single file baskets containing one file up to 1 GB in size. To provide better performance, it is recommended to convert backups that are stored on HPE StoreOnce storage appliances and Dell EMC Data Domain storage systems into the single file basket format.

    Note

    • If the backups created by the backup job are stored not only in the backup repository, but also in the archive repository, all of them will be converted when running this cmdlet.
    • Archive backups stored on S3 repositories cannot be converted into the single file basket format. If you try to convert such backups, the cmdlet will return a warning about that.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Job

    Specifies an array of file share backup jobs or file share backup copy jobs. The cmdlet will convert backups created by these jobs into the specified format.

    Accepts the CBackupJob object. To get this object, run the Get-VBRNASBackupJob or Get-VBRNASBackupCopyJob cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    RunAsync

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

    SwitchParameter

    False

    Named

    False

    BasketType

    Specifies a basket type into which file share backups will be converted. You can specify either of the following values:

    • Automatic: use this option to automatically convert backups into the recommended format based on the type of the storage specified in file share backup jobs or file share backup copy jobs.
    • SingleFileBasket: use this option to convert backups into single file baskets containing one file up to 1 GB in size.
    • Classic: use this option to convert backups into classic containing up to 16 standard blob files each up to 64 MB in size.

    If you do not specify this parameter, the cmdlet will use the Automatic setting for conversion by default.

    Accepts the VBRBasketType type.

    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 result of the conversion.

    Examples

    Convert-VBRNASBackupStorageFormatExample 1. Converting File Share Backup into Single File Basket Format

    This example shows how to convert backups created by a file share backup job into the single file basket format.

    $job = Get-VBRNASBackupjob -Name 'Daily NAS backup to StoreOnce'
    Convert-VBRNASBackupStorageFormat -Job $job -BasketType SingleFileBasket

    Perform the following steps:

    1. Run the Get-VBRNASBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
    2. Run the Convert-VBRNASBackupStorageFormat cmdlet. Specify the following settings:
    • Set the $job variable as the Job parameter value.
    • Specify the SingleFileBasket value for the BasketType parameter value.

    Convert-VBRNASBackupStorageFormatExample 2. Converting File Share Backup Copy into Classic Basket Format

    This example shows how to convert backups created by a file share backup job into the classic basket format.

    $copy_job = Get-VBRNASBackupCopyJob -Name 'Daily NAS backup to StoreOnce'
    Convert-VBRNASBackupStorageFormat -Job $copy_job -BasketType Classic

    Perform the following steps:

    1. Run the Get-VBRNASBackupCopyJob cmdlet. Specify the Name parameter value. Save the result to the $copy_job variable.
    2. Run the Convert-VBRNASBackupStorageFormat cmdlet. Specify the following settings:
    • Set the $copy_job variable as the Job parameter value.
    • Specify the Classic value for the BasketType parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.