Add-VBRDataCloudVaultRepository

Short Description

Adds a Veeam Data Cloud Vault to the backup infrastructure.

Important

You cannot add Veeam Data Cloud Vault Archive using this cmdlet.

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

Syntax

This cmdlet provides the following parameter sets:

DataCloudVaultV2

Add-VBRDataCloudVaultRepository [-Name <String>] [-Description <String>]

[-Vault <VBRVeeamDataCloudAssignedVault>] [-Folder <String>] [-GatewayServer <CHost[]>]

[-ConnectionType <VBRRepositoryConnectionType>] [-EnableSizeLimit] [-SizeLimit <Int32>]

[-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]

[-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-EnableConcurrentTasksLimit]

[-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange] [-EnableReadOnlyMode] [-Force] [<CommonParameters>]

DataCloudVaultV1

Add-VBRDataCloudVaultRepository [-Name <String>] [-Description <String>]

[-AzureBlobFolder <VBRAzureBlobFolder>] [-Connection <VBRAzureBlobConnection>] [-EnableSizeLimit]

[-SizeLimit <Int32>] [-ImmutabilityMode <VBRRepositoryImmutabilityMode>] [-ImmutabilityPeriod <Int32>]

[-MountServerOptions <VBRRepositoryMountServerOptions[]>] [-EnableConcurrentTasksLimit]

[-MaxConcurrentTasks <Int32>] [-ForceOwnershipChange] [-EnableReadOnlyMode] [-Force] [<CommonParameters>]

Detailed Description

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBRAzureBlobFolder`	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.	`VBRAzureBlobConnection`	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
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
EnableConcurrentTasksLimit	Enables limits for concurrent tasks that can be processed by the object storage repository. Use the `MaxConcurrentTasks` parameter to specify the number of tasks.	`SwitchParameter`	False	Named	False
EnableReadOnlyMode	Defines that the cmdlet will add the object storage repository in the read-only mode. If you enable this option, Veeam Backup & Replication will not write or modify data in the object storage repository. You can use the object storage repository for restore operations only. Default: `False`.	`SwitchParameter`	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
Folder	[Subscription scenario] Specifies the folder that will be used to store data.	`String`	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
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
GatewayServer	[Subscription scenario] Specifies an array of gateway servers that you want to use to transfer data from processed VM to object storage repositories.	`CHost[]`	False	Named	False
ImmutabilityMode	Specifies the immutability retention period: `BackupRetention`: Use this option if you want the immutability period to depend on the backup job retention. `RepositoryRetention`: Use this option if you want to ignore the job retention and specify the immutability period explicitly.	`VBRRepositoryImmutabilityMode`	False	Named	False
ImmutabilityPeriod	Defines the immutability period in days. Default: `30`. Maximum: `999`.	`Int32`	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
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.	`VBRRepositoryMountServerOptions[]`	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
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
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.	`VBRVeeamDataCloudAssignedVault`	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-VBRDataCloudVaultRepository Example 1. Adding Veeam Data Cloud Vault [Using Subscription]

This example shows how to add Veeam Data Cloud Vault to the backup infrastructure using a subscription.

$vault = Get-VBRVeeamDataCloudAssignedVault

$gateway = Get-VBRServer

Add-VBRDataCloudVaultRepository -Name "Vault2049" -Description "New Vault" -Vault $vault -Folder "Backups" -GatewayServer $gateway -ConnectionType Direct -ImmutabilityPeriod 14

Perform the following steps:

Run the Get-VBRVeeamDataCloudAssignedVault cmdlet. Save the result to the $vault variable.
Run the Get-VBRServer cmdlet. Save the result to the $gateway variable.
Run the Add-VBRDataCloudVaultRepository cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Specify the Description parameter value.
- Set the $vault variable as the Vault parameter value.
- Specify the Folder parameter value.
- Set the $gateway variable as the GatewayServer parameter value.
- Specify the ConnectionType parameter value.
- Specify the ImmutabilityPeriod parameter value.

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

This example shows how to add Veeam Data Cloud Vault to the backup infrastructure using a service key, and map object storage repository to an existing folder.

$account = Get-VBRAzureBlobAccount -Name "Azure Blob"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType CapacityTier

$container = Get-VBRAzureBlobContainer -Connection $connect

$folder = Get-VBRAzureBlobFolder -Container $container -Connection $connect

Add-VBRDataCloudVaultRepository -AzureBlobFolder $folder[3] -Connection $connect

Perform the following steps:

Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Connect-VBRAzureBlobService cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.

Note: You must specify the Global region to use a connection with Azure Blob storage and add a Veeam Data Cloud Vault.
Run the Get-VBRAzureBlobContainer cmdlet. Specify the Connection parameter value. Save the result to the $container variable.
Run the Get-VBRAzureBlobFolder cmdlet. Specify the Container and Connection parameter values. Save the result to the $folder variable.

The Get-VBRAzureBlobFolder cmdlet will return an array of folders. Mind the ordinal number of the necessary folders (in our example, it is the fourth restore point in the array).
Run the Add-VBRDataCloudVaultRepository cmdlet. Set the $folder variable as the AzureBlobFolder parameter value. Set the $connect variable as the Connection parameter value.

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

This example shows how to add Veeam Data Cloud Vault to the backup infrastructure and map object storage repository to a new folder. The cmdlet will map object storage repository to the Images folder.

$account = Get-VBRAzureBlobAccount -Name "Azure Blob"

$connect = Connect-VBRAzureBlobService -Account $account -RegionType Global -ServiceType CapacityTier

$container = Get-VBRAzureBlobContainer -Connection $connect

$folder = New-VBRAzureBlobFolder -Container $container -Connection $connect -Name "Images"

Add-VBRDataCloudVaultRepository -AzureBlobFolder $folder -Connection $connect

Perform the following steps:

Run the Get-VBRAzureBlobAccount cmdlet. Specify the Name parameter value. Save the result to the $account variable.
Run the Connect-VBRAzureBlobService cmdlet. Specify the Account, RegionType and ServiceType parameter values. Save the result to the $connect variable.
Run the Get-VBRAzureBlobContainer cmdlet. Specify the Connection parameter value. Save the result to the $container variable.
Run the New-VBRAzureBlobFolder cmdlet. Specify the Container, Connection and Name parameter values. Save the result to the $folder variable.
Run the Add-VBRDataCloudVaultRepository cmdlet. Set the $folder variable as the AzureBlobFolder parameter value. Set the $connect variable as the Connection parameter value.