Add-VBRDataCloudVaultRepository

Short Description

Adds a Veeam Data Cloud Vault to the backup infrastructure.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add a Veeam Data Cloud Vault using a subscription.

Important

Before you run this parameter set, you must assign a vault to your backup server. For more information, see the Getting Started with Veeam Data Cloud Vault section in the Veeam Data Cloud Vault User Guide.

Add-VBRDataCloudVaultRepository [-Name <String>] [-Description <String>] [-Vault <VBRVeeamDataCloudAssignedVault>] [-Folder <String>] [-GatewayServer <CHost[]>] [-ConnectionType <VBRRepositoryConnectionType>] [-EnableSizeLimit] [-SizeLimit <Int32>] [-ImmutabilityPeriod <Int32>] [-MountServerOptions <VBRRepositoryMountServerOptions>] [-EnableConcurrentTasksLimit] [-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange] [-Force] [<CommonParameters>]

  • Add a Veeam Data Cloud Vault using the service key.

Add-VBRDataCloudVaultRepository [-Name <String>] [-Description <String>] [-AzureBlobFolder <VBRAzureBlobFolder>] [-Connection <VBRAzureBlobConnection>] [-EnableSizeLimit] [-SizeLimit <Int32>] [-ImmutabilityPeriod <Int32>] [-MountServerOptions <VBRRepositoryMountServerOptions>] [-EnableConcurrentTasksLimit] [-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet adds a Veeam Data Cloud Vault to the backup infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Vault

[Subscription scenario]

Specifies a Veeam storage vault assigned to the backup server. The cmdlet will add this vault to the backup infrastructure.

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

False

Named

False

Folder

[Subscription scenario]

Specifies the folder that will be used to store data.

String

False

Named

False

GatewayServer

[Subscription scenario]

Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.

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

False

Named

False

ConnectionType

[Subscription scenario]

Specifies how Veeam Backup & Replication will access the object storage repository:

  • Direct: Use this option if you want Veeam Backup & Replication to use a proxy server to transfer data from the processed VM to object storage repositories.
  • Gateway: Use this option if you want Veeam Backup & Replication to use a gateway server to transfer data from processed VM to object storage repositories.
    Note: Provide the GatewayServer parameter to specify the server.

Default: Direct.

VBRRepositoryConnectionType

False

Named

False

AzureBlobFolder

[Service key scenario]

Specifies an Azure Blob folder. The cmdlet will map Veeam Data Cloud Vault to this folder.

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

False

Named

True (ByValue)

Connection

[Service key scenario]

Specifies an active session with Azure Blob storage. The cmdlet will use this connection to add a Veeam Data Cloud Vault.

Accepts the VBRAzureBlobConnection object. To get this object, run the Connect-VBRAzureBlobService cmdlet and set the CapacityTier property as the ServiceType parameter value.

False

Named

False

Name

Specifies a name of an object storage repository. The cmdlet will add a Veeam Data Cloud Vault to the backup infrastructure with this name.

String

False

Named

False

Description

Specifies a description of an object storage repository. The cmdlet will add a Veeam Data Cloud Vault to the backup infrastructure with this description.

String

False

Named

False

EnableSizeLimit

Defines that the cmdlet will enable size limits for a Veeam Data Cloud Vault that you want to add as a backup repository.

Use the SizeLimit parameter to specify the size limits.

SwitchParameter

False

Named

False

SizeLimit

For the EnableSizeLimit parameter.

Specifies size limits in GB for data blocks that you want to store in a Veeam Data Cloud Vault.

Permitted value: 1024 - 1073741824.

Default: 10240.

Int32

False

Named

False

ImmutabilityPeriod

Defines the immutability period in days.

Default: 30.

Maximum: 999.

Int32

False

Named

False

MountServerOptions

Specifies settings of a mount server for object storage repositories.

Note: This parameter is required for object storage repositories that you want to add as performance extents to a scale-out backup repository.

Accepts the VBRRepositoryMountServerOptions object. To create this object, run the New-VBRRepositoryMountServerOptions cmdlet.

False

Named

False

EnableConcurrentTasksLimit

Enables limits for concurrent tasks that can be processed by the object storage repository.

Use the MaxConcurrentTasks paramter to specify the number of tasks.

SwitchParameter

False

Named

False

MaxConcurrentTasks

Specifies a maximum number of concurrent tasks that can be processed at once by the object storage repository.

Int32

False

Named

False

ForceOwnershipChange

Defines that the cmdlet will force ownership change of the object storage folder.

If you do not provide this parameter and the object storage folder is owned by another host, you will not be able to add object storage to the backup infrastructure.

SwitchParameter

False

Named

False

Force

Defines that the cmdlet will add an object storage repository without showing warnings in the PowerShell console.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRDataCloudVaultRepository

Examples

Add-VBRDataCloudVaultRepositoryExample 1. Adding Veeam Data Cloud Vault [Using Subscription]

Add-VBRDataCloudVaultRepositoryExample 2. Adding Veeam Data Cloud Vault using Service Key [Mapping to Existing Folder]

Add-VBRDataCloudVaultRepositoryExample 3. Adding Veeam Data Cloud Vault [Mapping to New Folder]

Related Commands

Page updated 3/6/2025

Page content applies to build 12.3.1.1139