Set-VBRS3GlacierCompatibleRepository

Short Description

Modifies settings of S3 compatible object storage with data archiving.

Applies to

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

Syntax

Set-VBRS3GlacierCompatibleRepository -Repository <VBRS3GlacierCompatibleRepository> [-Name <string>] [-Description <string>] [-ArchiverAppliance <CHost>] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of S3 compatible object storage with data archiving that is added to the backup infrastructure.

Important

Do NOT change the immutability settings for your S3 compatible object storage with data archiving repository, otherwise it may result in data loss in the following scenarios:

  • If you provide the EnableBackupImmutability parameter to enable immutability for already configured object storage if it was not enabled beforehand.
  • If you provide the EnableBackupImmutability:$False parameter to disable immutability for already configured object storage if it was enabled beforehand.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Repository

Specifies an S3 compatible object storage with data archiving that you want to modify.

Accepts the VBRS3GlacierCompatibleRepository object. To create this object, run the Get-VBRArchiveObjectStorageRepository cmdlet.

True

Named

True (ByValue)

Name

Specifies a name of S3 compatible object storage with data archiving. The cmdlet will add S3 compatible object storage with this name.

String

False

Named

False

Description

Specifies a description of S3 compatible object storage with data archiving. The cmdlet will add S3 compatible object storage with this description.

String

False

Named

False

ArchiverAppliance

Specifies the archiver appliance. The cmdlet will use it to transfer data from S3 compatible object storage to S3 compatible object storage with data archiving.

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

False

Named

False

Force

Defines that the cmdlet will add S3 compatible object storage with data archiving 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

VBRS3GlacierCompatibleRepository

Examples

Modifying Settings for S3 Compatible Object Storage with Data Archiving

This example shows how to specify the archiver appliance for the Atlanta03 S3 compatible object storage with data archiving.

$appliance = Get-VBRServer -Name "WinSrv2049"

$repo = Get-VBRArchiveObjectStorageRepository -Name "Atlanta03"

$s3Glacier = Set-VBRS3GlacierCompatibleRepository -Repository $repo -ArchiverAppliance $appliance

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $appliance variable.
  2. Run the Get-VBRArchiveObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $repo variable.
  3. Run the Set-VBRS3GlacierCompatibleRepository cmdlet. Set the $repo variable as the Repository parameter value. Set the $appliance variable as the ArchiverAppliance parameter value.

Related Commands