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] [-UseInstantRetrieval] [-UseGatewayServer] [-GatewayServer <CHost[]>][-ConnectionType <VBRRepositoryConnectionType>] [-Force] [<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 Pipeline Input |
|---|---|---|---|---|---|
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 name of an Amazon S3 Glacier object storage. The cmdlet will add object storage with this name. | String | False | Named | False |
Description | Specifies a description of an Amazon S3 Glacier object storage. The cmdlet will add object storage with this description. | 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. | True | Named | True (ByPropertyName) |
EnableBackupImmutability | Enables the immutability option. Default: False. | SwitchParameter | False | Named | False |
UseDeepArchive | Defines that the cmdlet will create a repository where blocks are marked with the Glacier Deep Archive storage class. Note: If you do not provide the UseDeepArchive and UseInstantRetrieval parameters, the cmdlet will create a repository where blocks are marked as the Amazon S3 Glacier Flexible Retrieval storage class. Default: False. | SwitchParameter | False | Named | False |
UseInstantRetrieval | Defines that the cmdlet will create a repository where blocks are marked with the Amazon S3 Glacier Instant Retrieval storage class. Note: If you do not provide the UseDeepArchive and UseInstantRetrieval parameters, the cmdlet will create a repository where blocks are marked as the Amazon S3 Glacier Flexible Retrieval storage class. Default: False. | SwitchParameter | False | Named | False |
UseGatewayServer | Defines that the cmdlet will use a gateway server to transfer data from processed VM to object storage repositories Default: True. Note: If you do not specify the UseGatewayServer parameter, the cmdlet will use a proxy server to trasfer data. | SwitchParameter | False | Named | False |
GatewayServer | 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 | Specifies how Veeam Backup & Replication will access the object storage repository:
Default: Direct. | VBRRepositoryConnectionType | False | Named | False |
Force | Defines that the cmdlet will modify 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 the About CommonParameters section of Microsoft Docs.
Output Object
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 custom gateway servers to connect to Amazon S3 object storage.
$amazon = Get-VBRArchiveObjectStorageRepository -Name "Amazon S3" $gateserv = Get-VBRServer -Name "north.tech.local, north2.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. Set the $amazon variable as the Repository parameter value. Provide the UseGatewayServer parameter. Set the $gateserv variable as the GatewayServer parameter value.
Related Commands