Set-VBRAzureDataBoxRepository

Short Description

Modifies settings of Azure Data Box storage as an object storage repository to Veeam Backup & Replication.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRAzureDataBoxRepository -Repository <VBRAzureDataBoxRepository> [-Name <string>] [-Description <string>][-UseGatewayServer] [-GatewayServer <CHost>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies Azure Data Box storage that is added as an object storage  repository to the  Veeam Backup & Replication infrastructure/

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Repository

Specifies Azure Data Box storage that you want to modify.

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

True

Named

True

Name

Specifies a name for Azure Data Box storage.

String

False

Named

False

Description

Specifies a description of Azure Data Box storage.

String

False

Named

False

UseGatewayServer

Indicates that cmdlet will use a gateway server to access an Azure Data Box storage.

SwitchParameter

False

Named

False

GatewayServer

Specifies a gateway server that you want to use to access an Azure Data Box storage.

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

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

This cmdlet returns the VBRAzureDataBoxRepository object that contains settings of Azure Data Box storage added as an object storage repository to the Veeam Backup & Replication infrastructure.

Examples

Modifying Gateway Server

This example shows how to modify Azure Data Box storage added as an object storage repository to the Veeam Backup & Replication infrastructure.

$repository = Get-VBRObjectStorageRepository -Name "Azure Data Box"

$gateway = Get-VBRServer -Name "WinSrv567"

Set-VBRAzureDataBoxRepository -Repository $repository -UseGatewayServer -GatewayServer $gateway

Perform the following steps:

  1. Run the Get-VBRObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  2. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
  3. Run the Set-VBRAzureDataBoxRepository cmdlet. Specify the following settings:
  • Set the $repository variable as the Repository parameter value.
  • Provide the UseGatewayServer parameter.
  • Set the $gateway variable as the GatewayServer parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.