Set-VBRAmazonS3Repository
Short Description
Modifies settings for Amazons S3 object storage added as a backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRAmazonS3Repository -Repository <VBRAmazonS3Repository> [-Name <String>] [-Description <String>][-EnableIAStorageClass [<SwitchParameter>]] [-EnableOZIAStorageClass [<SwitchParameter>]] [-UseGatewayServer[<SwitchParameter>]] [-GatewayServer <CHost>] [-EnableSizeLimit [<SwitchParameter>]] [-SizeLimit <Int32>][-EnableBackupImmutability [<SwitchParameter>]] [-ImmutabilityPeriod <Int32>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings for Amazons S3 object storage repositories added added as a backup repository.
Parameters
Parameter | Description | Required | Position | Accept |
Repository | Specifies an Amazon S3 object storage that you want to modify. Accepts the VBRAmazonS3Repository type. | True | Named | True (ByValue) |
Name | Specifies a new name for the AmazonS3 object storage. | False | Named | False |
Description | Specifies a description of the AmazonS3 object storage. | False | Named | False |
EnableIAStorageClass | Indicates that the cmdlet will enable the infrequent access storage class for data blocks that are stored in an Amazon S3 object storage added as a backup repository. | False | Named | False |
EnableOZIAStorageClass | Defines that the cmdlet will enable the One Zone-IA storage class for data blocks that are stored in an Amazon S3 object storage. | False | Named | False |
UseGatewayServer | Indicates that the cmdlet will use a gateway server to access Amazon S3 object storage added as a backup repository. | False | Named | False |
GatewayServer | Specifies a gateway server that you want to use to access Amazon S3 object storage. | False | Named | False |
EnableSizeLimit | Indicates that the cmdlet will enable size limits for data blocks that you want to store in an Amazon S3 object storage. Use the SizeLimit parameter to specify the size limits. | False | Named | False |
SizeLimit | For the EnableSizeLimit parameter. Specifies size limits in GB for data blocks that you want to store in an Amazon S3 object storage. Permitted value:1024 - 1073741824 Default: 10240 | False | Named | False |
EnableBackupImmutability | Defines that the cmdlet will enable the immutability option. | False | Named | False |
ImmutabilityPeriod | For the EnableBackupImmutability parameter. Defines the immutability period in days. Default: 30 | 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.
Return Type
Example
This example shows how to modify settings for an Amazon S3 object storage added as a backup repository. The cmdlet will use a custom gateway server to connect to Amazon S3 object storage.
- Run Get-VBRObjectStorageRepository to get an Amazon S3 object storage added as a backup repository. Save the result to the $amazon variable.
- Run Get-VBRServer with the Name parameter to get the server that you want to use as a gateway. Save the result to the $gateserv variable.
- Run Set-VBRAmazonS3Repository with the $amazon and $gateserv variables. Use the UseGatewayServer parameter to enable the custom gateway server option.
$amazon = Get-VBRObjectStorageRepository -Name "Amazon S3" $gateserv = Get-VBRServer -Name north.tech.local Set-VBRAmazonS3Repository -Repository $amazon -UseGatewayServer -GatewayServer $gateserv |
Related Commands