This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRAmazonS3GlacierRepository
Short Description
Modifies settings for Amazon S3 Glacier archive storage added as a backup repository.
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRAmazonS3GlacierRepository -Repository <VBRAmazonS3GlacierRepository> [-Name <string>] [-Description <string>] [-AmazonProxySpec <VBRAmazonEC2ProxyAppliance>] [-EnableBackupImmutability] [-UseDeepArchive] [-UseGatewayServer] [-GatewayServer <CHost>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings for Amazon S3 Glacier archive storage repository added as a backup repository.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Repository | Specifies an Amazons S3 Glacier archive storage that you want to modify. | Accepts the VBRAmazonS3GlacierRepository object. To create this object, run the Add-VBRAmazonS3GlacierRepository cmdlet. | True | Named | True (ByValue) |
Name | Specifies a new name for the Amazons S3 Glacier archive storage. | String | False | Named | False |
Description | Specifies a description of the Amazons S3 Glacier archive storage. | String | False | Named | False |
AmazonProxySpec | Specifies a proxy appliance for transferring the data from Amazon S3 to Amazon S3 Glacier object storage. | Accepts the VBRAmazonEC2ProxyAppliance object. To create this object, run the New-VBRAmazonEC2ProxyAppliance cmdlet. | False | Named | False |
EnableBackupImmutability | Enables the immutability option. Default: False | SwitchParameter | False | Named | False |
UseDeepArchive | Defines that the cmdlet will apply the Glacier Deep Archive for backups feature. If you provide this parameter, the cmdlet will assign the Glacier Deep Archive storage class to the backups. Default: False | SwitchParameter | False | Named | False |
UseGatewayServer | Defines that the cmdlet will use a gateway server to access Amazon S3 Glacier archive storage added as a backup repository. Default: True | SwitchParameter | False | Named | False |
GatewayServer | Specifies a gateway server that you want to use to access Amazon S3 Glacier archive storage. | CHost | 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 VBRAmazonS3GlacierRepository object that defines the Amazon Glacier archive storage repository settings.
Examples
Modifying Gateway Server of Amazon S3 Glacier Repository
This example shows how to modify settings for an Amazon S3 Glacier archive storage added to the backup infrastructure. The cmdlet will use a custom gateway server to connect to Amazon S3 object storage.
$amazon = Get-VBRArchiveObjectStorageRepository -Name "Amazon S3" $gateserv = Get-VBRServer -Name north.tech.local Set-VBRAmazonS3GlacierRepository -Repository $amazon -UseGatewayServer -GatewayServer $gateserv |
Perform the following steps:
- Run the Get-VBRArchiveObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $amazon variable.
- Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $gateserv variable.
- Run the Set-VBRAmazonS3GlacierRepository cmdlet. Specify the following settings:
- Set the $amazon variable as the Repository parameter value.
- Provide the UseGatewayServer parameter.
- Set the $gateserv variable as the GatewayServer parameter value.
Related Commands
