Add-VBOAmazonS3Repository
Short Description
Adds Amazon S3 object storage repository (Amazon S3 Standard, Amazon S3 Standard-Infrequent Access and Amazon S3 One Zone-Infrequent Access storage classes) to the Veeam Backup for Microsoft 365 infrastructure.
Syntax
This cmdlet provides parameter sets that allow you to:
- Add Amazon S3 object storage repository with the default retention period.
Add-VBOAmazonS3Repository [-EnableStandardIAStorageClass] [-EnableOneZoneIAStorageClass] [-ImmutabilityPeriodDays <Int32>] [-IgnoreProxyPoolApplianceAccessValidation] -ObjectStorageSettings <VBOAmazonS3ObjectStorageRepository> [-ObjectStorageEncryptionKey <VBOEncryptionKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] -EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>] |
- Add Amazon S3 object storage repository. The retention period set to years and retention policy applied daily.
Add-VBOAmazonS3Repository [-EnableStandardIAStorageClass] [-EnableOneZoneIAStorageClass] [-ImmutabilityPeriodDays <Int32>] [-IgnoreProxyPoolApplianceAccessValidation] -ObjectStorageSettings <VBOAmazonS3ObjectStorageRepository> -RetentionPeriod <VBORetentionPeriod> -RetentionFrequencyType <VBORetentionFrequencyType> -DailyTime <TimeSpan> -DailyType <VBODailyType> [-ObjectStorageEncryptionKey <VBOEncryptionKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] [-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>] |
- Add Amazon S3 object storage repository with the custom retention period. Veeam Backup for Microsoft 365 applies the retention policy daily.
Add-VBOAmazonS3Repository [-EnableStandardIAStorageClass] [-EnableOneZoneIAStorageClass] [-ImmutabilityPeriodDays <Int32>] [-IgnoreProxyPoolApplianceAccessValidation] -ObjectStorageSettings <VBOAmazonS3ObjectStorageRepository> -CustomRetentionPeriodType <VBORetentionPeriodType> -CustomRetentionPeriod <Int32> -RetentionFrequencyType <VBORetentionFrequencyType> -DailyTime <TimeSpan> -DailyType <VBODailyType> [-ObjectStorageEncryptionKey <VBOEncryptionKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] [-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>][-Force] [<CommonParameters>] |
- Add Amazon S3 object storage repository. The retention period set to years and retention policy applied monthly.
Add-VBOAmazonS3Repository [-EnableStandardIAStorageClass] [-EnableOneZoneIAStorageClass] [-ImmutabilityPeriodDays <Int32>] [-IgnoreProxyPoolApplianceAccessValidation] -ObjectStorageSettings <VBOAmazonS3ObjectStorageRepository> -RetentionPeriod <VBORetentionPeriod> -RetentionFrequencyType <VBORetentionFrequencyType> -MonthlyTime <TimeSpan> -MonthlyDayNumber <VBOMonthlyDayNumber> -MonthlyDayOfWeek <DayOfWeek> [-ObjectStorageEncryptionKey <VBOEncryptionKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] [-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>][-Force] [<CommonParameters>] |
- Add Amazon S3 object storage repository with the custom retention period. Veeam Backup for Microsoft 365 applies the retention policy monthly.
Add-VBOAmazonS3Repository [-EnableStandardIAStorageClass] [-EnableOneZoneIAStorageClass][-ImmutabilityPeriodDays <Int32>] [-IgnoreProxyPoolApplianceAccessValidation] -ObjectStorageSettings <VBOAmazonS3ObjectStorageRepository> -CustomRetentionPeriodType <VBORetentionPeriodType> -CustomRetentionPeriod <Int32> -RetentionFrequencyType <VBORetentionFrequencyType> -MonthlyTime <TimeSpan> -MonthlyDayNumber <VBOMonthlyDayNumber> -MonthlyDayOfWeek <DayOfWeek> [-ObjectStorageEncryptionKey <VBOEncryptionKey>] [-SyncNow] [-SizeLimit <UInt64>] [-EnableImmutability] [-EnableImmutabilityGovernanceMode] [-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -Name <String> [-Description <String>] [-RetentionType <VBORetentionType>] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet adds a backup repository of the Amazon S3 object storage type, in particular — Amazon S3 Standard, Amazon S3 Standard-Infrequent Access and Amazon S3 One Zone-Infrequent Access storage classes, to the Veeam Backup for Microsoft 365 infrastructure. Veeam Backup for Microsoft 365 uses backup repositories as storage systems for backups and backup copies created for Microsoft 365 and on-premises Microsoft organizations. Every backup repository has the retention policy that defines how long you want to keep backups on a backup repository.
You can specify the following retention policy settings:
- Retention period to specify how long you want to keep data on a backup repository. You can set the period to years, months or days.
- Retention policy schedule to specify the day and time when Veeam Backup for Microsoft 365 must check the backup repository and remove the outdated backups. You can set the schedule to daily or monthly.
- Retention policy type to set it to Item-level or to snapshot-based types.
For more information on retention policy, see the Retention Policy section of the Veeam Backup for Microsoft 365 User Guide.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
EnableStandardIAStorageClass | Defines that the cmdlet will enable the Amazon S3 Standard-Infrequent Access storage class. Default: False | SwitchParameter | False | Named | False |
EnableOneZoneIAStorageClass | Defines that the cmdlet will enable the Amazon S3 One Zone-Infrequent Access storage class. Default: False | SwitchParameter | False | Named | False |
ImmutabilityPeriodDays | Specifies the number of days when your data will be blocked for deletion or modification. Note: If you set the null or 0 value, data will be blocked for deletion or modification for the same period as the retention period. | Int32 | False | Named | False |
IgnoreProxyPoolApplianceAccessValidation | Defines that the cmdlet will ignore check whether backup proxy servers that belong to the specified backup proxy pool can access the archiver appliance. Default: False | SwitchParameter | False | Named | False |
ObjectStorageSettings | Specifies the Amazon S3 object storage settings. | Accepts the VBOAmazonS3ObjectStorageRepository object. To get this object, run the New-VBOAmazonS3ObjectStorageSettings cmdlet. | True | Named | False |
ObjectStorageEncryptionKey | Specifies object storage encryption key. Veeam Backup for Microsoft 365 will encrypt data that is saved to this object storage. | Accepts the VBOEncryptionKey object. To get this object, run the Get-VBOEncryptionKey cmdlet. | False | Named | False |
SyncNow | Defines that the cmdlet will start to synchronize cache between object storage repository and the PersistentCache database on the PostgreSQL instance. Default: False | SwitchParameter | False | Named | False |
SizeLimit | Specifies a soft limit in GB for the object storage repository consumption that can be exceeded temporarily. If the specified limit is exceeded, Veeam Backup for Microsoft 365 will not run a new job. Permitted values: 1024–1073741824. Default: 1024 Note: In PowerShell you can specify a soft limit in GB only. | UInt64 | False | Named | False |
EnableImmutability | Defines that the cmdlet will add object storage repository to the Veeam Backup for Microsoft 365 infrastructure with the immutability feature enabled. Veeam Backup for Microsoft 365 allows you to prohibit deletion of data from the object storage repository by making that data temporarily immutable and to protect data against malware activity. For more information about the immutability feature, see the Immutability section of the Veeam Backup for Microsoft 365 User Guide. Default: False | SwitchParameter | False | Named | False |
EnableImmutabilityGovernanceMode | Defines that an administrator will be allowed to delete the protected backups in object storage repository added by the cmdlet. Default: False | SwitchParameter | False | Named | False |
Proxy | Specifies a backup proxy server. The cmdlet will map a new Amazon S3 object storage repository to this backup proxy server. | Accepts the VBOProxy object. To get this object, run the Get-VBOProxy cmdlet. | False | Named | False |
ProxyPool | Specifies a backup proxy pool. The cmdlet will map a new Amazon S3 object storage repository to this backup proxy pool. | Accepts the VBOProxyPool object. To get this object, run the Get-VBOProxyPool cmdlet. | False | Named | False |
Name | Specifies a name of Amazon S3 object storage repository. The cmdlet will add object storage repository with this name. | String | True | Named | False |
Description | Specifies a description of Amazon S3 object storage repository. The cmdlet will add object storage repository with this description. The default description contains information on the user who added object storage repository, date and time when object storage repository was added. | String | False | Named | False |
RetentionType | Specifies a type of retention policy. You can set either of the following types:
Default: SnapshotBased | VBORetentionType | False | Named | False |
Force | Defines that the cmdlet will add object storage repository to the Veeam Backup for Microsoft 365 infrastructure without notifying the user. Default: False | SwitchParameter | False | Named | False |
RetentionPeriod | Specifies the retention period in years. Veeam Backup for Microsoft 365 will remove items from object storage repository once this period is passed. You can set either of the following periods:
Default: Years3 Note: Apply the CustomRetentionPeriodType parameter to set the retention period in months or days. | VBORetentionPeriod | True | Named | False |
RetentionFrequencyType | Specifies retention policy schedule. Veeam Backup for Microsoft 365 will check object storage repository and will remove the outdated backups according to this schedule. You can set either of the following types of schedule:
Default: Daily | VBORetentionFrequencyType | True | Named | False |
DailyTime | For daily retention policy schedule. Specifies the time of the day when Veeam Backup for Microsoft 365 must apply the retention policy. Default: 00:00:00 | TimeSpan | True | Named | False |
DailyType | For daily retention policy schedule. Specifies the days when Veeam Backup for Microsoft 365 must apply the retention policy:
Default: Everyday | VBODailyType | True | Named | False |
MonthlyTime | For monthly retention policy schedule. Specifies the time of the day when Veeam Backup for Microsoft 365 must apply the retention policy. Default: 18:00:00 | TimeSpan | True | Named | False |
MonthlyDayNumber | For monthly retention policy schedule. Specifies the order number for the day of the week when Veeam Backup for Microsoft 365 must apply the retention policy.
Default: First | VBOMonthlyDayNumber | True | Named | False |
MonthlyDayOfWeek | For monthly retention policy schedule. Specifies the day of the week when Veeam Backup for Microsoft 365 must apply the retention policy.
Default: Monday | DayOfWeek | True | Named | False |
CustomRetentionPeriodType | Specifies a type of custom retention period. Veeam Backup for Microsoft 365 will remove items from object storage repository once this period is passed. You can set the custom retention period to either of the following types:
Set the CustomRetentionPeriod parameter to specify the number of days or the number of months. | VBORetentionPeriodType | True | Named | False |
CustomRetentionPeriod | For the CustomRetentionPeriodType option. Specifies the retention period to keep data on object storage repository. The retention period is defined according to the CustomRetentionPeriod settings:
Veeam Backup for Microsoft 365 will remove items from object storage repository once this period is passed. | Int32 | True | 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
The cmdlet returns the VBOAmazonS3Repository object that contains settings of Amazon S3 object storage repository.
Examples
Example 1. Adding Amazon S3 Object Storage with Default Retention Policy Period
This example shows how to add the Amazon S3 Standard Backup object storage repository. The retention type is set to snapshot-based.
Perform the following steps:
|
Example 2. Adding Amazon S3 Object Storage with Yearly Retention Period [Policy Applied Daily]
This example shows how to add the Amazon S3 Standard Backup object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 3. Adding Amazon S3 Object Storage with Yearly Retention Period [Policy Applied Monthly]
This example shows how to add the Amazon S3 Standard Backup object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 4. Adding Amazon S3 Object Storage with Custom Retention period [Policy Applied Daily]
This example shows how to add the Amazon S3 Standard Backup object storage repository. The retention settings will be the following:
Perform the following steps:
|
Example 5. Adding Amazon S3 Object Storage with Custom Retention period [Policy Applied Monthly]
This example shows how to add the Amazon S3 Standard Backup object storage repository. The retention settings will be the following:
Perform the following steps:
|
Related Commands