New-VBRNASBackupArchivalOptions

In this article

    Short Description

    Defines long-term retention policy for file versions of backed up files from file shares.

    Applies to

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

    Syntax

    New-VBRNASBackupArchivalOptions [-ActiveFileVersionRetention <int>] [-DeletedFileVersionRetention <int>] [-ArchivalType <VBRNASBackupArchivalType> {All | InclusionMask | ExclusionMask}] [-InclusionMask <string[]>] [-ExclusionMask <string[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet defines long-term retention policy for file versions of backed up files from file shares.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    ActiveFileVersionRetention

    Specifies the number of active file versions. Veeam Backup & Replication will keep the specified number of active file versions on the long-term repository. Once the number of file versions exceeds, Veeam Backup & Replication will remove the oldest file version from the repository.

    Note: If you do not specify this parameter, the number of active file versions is set to unlimited. Veeam Backup & Replication will delete active file versions from the backup repository after the retention period that is specified for the long-term

    Default: 10

    Int32

    False

    Named

    False

     

    DeletedFileVersionRetention

    Specifies the number of deleted file versions. Veeam Backup & Replication will keep the specified number of deleted file versions on the long-term repository. Once the number of file versions exceeds, Veeam Backup & Replication will remove the oldest version from the repository.

    Note: If you do not specify this parameter, the number of deleted file versions is set to unlimited. Veeam Backup & Replication will remove deleted files versions from the backup repository after the retention period that is specified for the long-term repository is passed.

    Default: 3

    Int32

    False

    Named

    False

     

    ArchivalType

    Specifies the filter settings for file versions that must be kept on the long-term repository. You can specify either of the following filter settings:

    • All: use this option if you want to keep all types of file versions on the long-term repository.
    • InclusionMask: use this option if you want to keep only file versions with specific extensions on the long-term repository.
      Use the InclusionMask parameter to specify these extensions.
    • ExclusionMask: use this option if you do not want to keep file versions with specific extensions on the long-term repository.
      Use the ExclusionMask parameter to specify these extensions.

    VBRNASBackupArchivalType

    False

    Named

    False

     

    InclusionMask

    For the ArchivalType parameter with the InclusionMask value.

    Specifies a file mask for files and folders that you want to add to the file backup job. The cmdlet will back up only these files and folders.

    String[]

    False

    Named

    False

     

    ExclusionMask

    For the ArchivalType parameter with the ExclusionMask value.

    Specifies a file mask for files and folders that you do not want to add to the file backup job.

    String[]

    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 VBRNASBackupArchivalOptions object that contains settings of files and folders that will be added to the file backup job.

    Examples

    New-VBRNASBackupArchivalOptionsExample 1. Defining Retention Policy for Active File Versions of File Share Backed Up Files

    This command shows how to define retention policy for active file versions of backed up files from file shares. The long-term repository will keep active file versions for 14 days.

    New-VBRNASBackupArchivalOptions -ActiveFileVersionRetention 14

    New-VBRNASBackupArchivalOptionsExample 2. Defining Retention Policy for Deleted File Versions of File Share Backed Up Files

    This command shows how to define retention policy for deleted file versions of backed up files from file shares. The long-term repository will keep deleted file versions for 7 days.

    New-VBRNASBackupArchivalOptions -DeletedFileVersionRetention 7

    New-VBRNASBackupArchivalOptionsExample 3. Defining Retention Policy for Active File Versions of File Share Backed Up Files by Using Filter Settings

    This command shows how to define retention policy for active file versions of backed up files from file shares. The retention policy will have the following settings:

    • The long-term repository will keep active file versions for 9 days.
    • The long-term repository will keep only .PDF and .DOCX file extensions.

     

    New-VBRNASBackupArchivalOptions -ActiveFileVersionRetention 9 -ArchivalType InclusionMask -InclusionMask "*.pdf","*.docx"

    New-VBRNASBackupArchivalOptionsExample 4. Defining Retention Policy for Deleted File Versions of File Share Backed Up Files by Using Filter Settings

    This command shows how to define retention policy for deleted file versions of backed up files from file shares. The retention policy will have the following settings:

    • The long-term repository will keep deleted file versions for 3 days.
    • The long-term repository will not keep .EXE file extensions.

     

     

    New-VBRNASBackupArchivalOptions -DeletedFileVersionRetention 3 -ArchivalType ExclusionMask -ExclusionMask "*.exe"