Set-VBRBackupRepository

In this article

    Short Description

    Modifies a backup repository.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRBackupRepository -Repository <CBackupRepository> [-ImmutabilityPeriod <Int32>] [-EnableBackupImmutability <SwitchParameter>] [-EnableXFSFastClone <SwitchParameter>] [-AffinityProxy <CViProxy[]>] [-AffinityMode <VBRProxyAffinityMode>] [-DDBoostEncryptionType <VBRDDBoostEncryptionType>] [-UsePerVMFile <SwitchParameter>] [-DecompressDataBlocks <SwitchParameter>] [-AlignDataBlocks <SwitchParameter>] [-DataRateLimit <Int32>] [-LimitDatarate <SwitchParameter>] [-MaxConcurrentJobs <Int32>] [-LimitConcurrentJobs <SwitchParameter>][-Credentials <CCredentials>] [-RequireAccessCreds <SwitchParameter>] [-DDServerName <String>] [-MountFolder <String>] [-MountPort <Int32>] [-VPowerNFSPort <Int32>] [-EnableVPowerNFS <SwitchParameter>] [-RotatedDrive <SwitchParameter>] [-Server <CHost>] [-MountServer <CHost>] [-Description <String>] [-Name <String>][-NFSRepositoryEncoding <VBRNASEncoding>] [-Force <SwitchParameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies a selected backup repository. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    To modify scale-out backup repository, run Set-VBRScaleOutBackupRepository.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Repository

    Specifies the backup repository you want to modify.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the name you want to assign to the backup repository.

    False

    Named

    False

    False

    Description

    Specifies the description of the backup repository.

    False

    Named

    False

    False

    Server

    Specifies the host where the backup repository is located. The cmdlet will set this host as a backup repository.

    Default: This server.

    Note: You can not set a new backup repository for the following types of hosts that have been added as backup repositories:

    • WinLocal
    • LinuxLocal

    False

    Named

    False

    False

    ImmutabilityPeriod

    For the immutability option.

    Defines a number of days within which Veeam Backup & Replication will not delete blocks of data from the backup repository.

    Default: 30 days.

    False

    Named

    False

    False

    EnableBackupImmutability

    Enables the immutability option for a backup repository.

    False

    Named

    False

    False

    NFSRepositoryEncoding

    Specifies encoding for NFS share. You can specify either of the following values:

    • utf
    • ansi

    False

    Named

    False

    False

    Force

    Defines that the cmdlet will a backup repository without showing warnings in the PowerShell console.

    False

    Named

    False

    False

    MountFolder

    Specifies the path to the mount folder. Veeam Backup & Replication will use this folder to mount VM disks  and to keep write cache data.

    False

    Named

    False

    False

    MountServer

    Specifies the mount server associated with the backup repository. You can assign the mount server role to the backup repository itself or to a server that resides close to the backup repository.

    False

    Named

    False

    False

    RotatedDrive

    Indicates that the repository you want to add is a rotated drive (removable media).

    False

    Named

    False

    False

    EnableVPowerNFS

    Indicates that the repository is accessible by the vPower NFS service.

    False

    Named

    False

    False

    VPowerNFSFolder

    This parameter is deprecated and replaced with the MountFolder parameter.

    Note: The vPower NFS folder is currently located under the following path: \Program Data\Veeam\Backup\IRCache\.

    False

    Named

    False

    False

    VPowerNFSPort

    Specifies the port number of the vPower NFS Service. Veeam Backup & Replication will set up a direct connection between the backup repository and ESXi to which the vPower NFS datastore is mounted.

    Default: 2049.

    False

    Named

    False

    False

    MountPort

    Specifies the port number of the mount server.

    Default: 1058.

    False

    Named

    False

    False

    RequireAccessCreds

    Indicates that the administrator credentials are needed to access the shared folder. Use the Credentials parameter to specify the credentials.

    False

    Named

    False

    False

    Credentials

    Specifies credentials you want to use for authenticating with the backup repository host.

    False

    Named

    False

    False

    LimitConcurrentJobs

    Indicates that the number of concurrent jobs using this repository must be limited. Use the MaxConcurrentJobs parameter to set the maximum value.

    False

    Named

    False

    False

    MaxConcurrentJobs

    Used for setting maximum value for the LimitConcurrentJobs parameter.

    Specifies the maximum allowed number of concurrent tasks for the backup repository.

    Permitted values: 1 to 99.

    False

    Named

    False

    False

    LimitDatarate

    Indicates that the total speed of writing data to the backup repository disk must be restricted. Use the DataRateLimit parameter to set the maximum value.

    False

    Named

    False

    False

    DataRateLimit

    Used for setting combined data ingestion rate for the LimitDatarate parameter.

    Specifies the combined data ingestion rate for the repository.

    Permitted value: 1 to 1024 (MByte/s).

    False

    Named

    False

    False

    AlignDataBlocks

    Indicates that the backup blocks size will be aligned by a 4Kb block boundary. Data alignment provides better deduplication on storage systems with fixed block size.

    False

    Named

    False

    False

    DecompressDataBlocks

    Indicates that the backup data blocks must be decompressed before storing to the repository.

    False

    Named

    False

    False

    UsePerVMFile

    Indicates that the backup repository must create per-VM backup files.

    False

    Named

    False

    False

    DDBoostEncryptionType

    Specifies the native Dell EMC Data Domain encryption level:

    • High
    • Medium
    • None

    False

    Named

    False

    False

    AffinityMode

    Specifies what proxy affinity rules are set up for the backup repository:

    • Auto — all backup proxies in the backup infrastructure can work with the backup repository
    • Manual — backup proxies from the AffinityProxy list can work with the backup repository

    To configure proxy affinity settings, you must install Veeam Backup & Replication Enterprise or higher license on the backup server.

    Default: Auto.

    False

    Named

    False

    False

    AffinityProxy

    Specifies the list of backup proxies that can work with the backup repository. Entries in the proxy affinity list are separated with a comma.

    To configure proxy affinity settings, you must install Veeam Backup & Replication Enterprise or higher license on the backup server.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    EnableXFSFastClone

    Defines that the Fast Clone technology will be enabled for the backup repository.

    False

    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.

    Example

    This example shows how to configure proxy affinity settings for a backup repository named "Backup Volume 01".

    1. Run Get-VBRBackupRepository to get the backup repository and save it to the $repository variable.
    2. Run Get-VBRViProxy twice to get backup proxies and save them to $proxy01 and $proxy02 variables.
    3. Run Set-VBRBackupRepository with the $repository, $proxy01 and proxy02 variables.

    $repository = Get-VBRBackupRepository -Name "Backup Volume 01"

    $proxy01 = Get-VBRViProxy -Name 172.17.53.5

    $proxy02 = Get-VBRViProxy -Name 172.17.53.33

    Set-VBRBackupRepository -Repository $repository -AffinityMode manual -AffinityProxy $proxy01, $proxy02

    Related Commands

    Get-VBRBackupRepository

    Get-VBRServer

    Get-VBRCredentials