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 backup repository.

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

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Repository

    Specifies the backup repository you want to modify.

    Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

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

    String

    False

    Named

    False

    False

    Description

    Specifies a description of the backup repository.

    String

    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

    Accepts the CHost[] object. To get this object, run the Get-VBRServer cmdlet.

    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.

    Int32

    False

    Named

    False

    False

    EnableBackupImmutability

    Enables the immutability option for a backup repository.

    SwitchParameter

    False

    Named

    False

    False

    NFSRepositoryEncoding

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

    • utf
    • ansi

    VBRNASEncoding

    False

    Named

    False

    False

    Force

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

    SwitchParameter

    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.

    String

    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.

    Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

    False

    Named

    False

    False

    RotatedDrive

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

    SwitchParameter

    False

    Named

    False

    False

    EnableVPowerNFS

    Enables the repository to be accessible by the vPower NFS service.

    SwitchParameter

    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.

    Int32

    False

    Named

    False

    False

    MountPort

    Specifies the port number of the mount server.

    Default: 1058.

    Int32

    False

    Named

    False

    False

    RequireAccessCreds

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

    SwitchParameter

    False

    Named

    False

    False

    Credentials

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

    Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.

    False

    Named

    False

    False

    LimitConcurrentJobs

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

    SwitchParameter

    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.

    Int32

    False

    Named

    False

    False

    LimitDatarate

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

    SwitchParameter

    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).

    Int32

    False

    Named

    False

    False

    AlignDataBlocks

    Defines 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.

    SwitchParameter

    False

    Named

    False

    False

    DecompressDataBlocks

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

    SwitchParameter

    False

    Named

    False

    False

    UsePerVMFile

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

    SwitchParameter

    False

    Named

    False

    False

    DDBoostEncryptionType

    Specifies the native Dell EMC Data Domain encryption level:

    • High
    • Medium
    • None

    VBRDDBoostEncryptionType

    False

    Named

    False

    False

    AffinityMode

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

    • Auto — use this option if you want all backup proxies in the backup infrastructure to work with the backup repository
    • Manual — use this option if you want backup proxies from the AffinityProxy list to 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.

    VBRProxyAffinityMode

    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.

    Accepts the CViProxy[] object. To get this object, run the Get-VBRViProxy cmdlet.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    EnableXFSFastClone

    Enables the Fast Clone technology for the backup repository.

    SwitchParameter

    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.

    Output Object

    The cmdlet returns the CBackupRepository object that contains settings of backup repositories added to the backup infrastructure.

    Examples

    Defining Proxy Affinity Settings

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

    $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

    Perform the following steps:

    1. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
    2. Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy1 variable.
    3. Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy2 variable.
    4. Run the Set-VBRBackupRepository cmdlet. Set the $repository variable as the Repository parameter value. Specify the AffinityMode parameter value. Set the $proxy1 and $proxy2 variables as the AffinityProxy parameter value.

    Related Commands

    Get-VBRBackupRepository

    Get-VBRServer

    Get-VBRCredentials