Get-VBRAmazonS3Folder
Returns Amazon S3 folders.
Platform: VMware, Hyper-V
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Get-VBRAmazonS3Folder -Connection <IVBRAmazonS3Connection> -Bucket <VBRAmazonS3Bucket> -Name <string> [<CommonParameters>] |
This cmdlet returns the VBRAmazonS3Folder object that contains an array of Amazon S3 folders. You can get the array of the folders for the following types of Amazon object storage:
- S3 compatible (including IBM Cloud Object Storage)
Note |
The Get-VBRAmazonS3Folder cmdlet returns the array of Amazon S3 folders that are created under the following paths: - [For Capacity Tier] - /Veeam/Archive/
- [For External Repository] - /Veeam/Backup/
|
Parameter | Description | Type | Required | Position | Accept
Pipeline
Input |
|---|
Connection | Specifies an active session with Amazon S3 object storage. The cmdlet will return an array of the folders added to this object storage. | Accepts the IVBRAmazonS3Connection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet. | True | Named | False |
Bucket | Specifies an Amazon S3 bucket. The cmdlet will return an array of the folders added to this bucket. | Accepts the VBRAmazonS3Bucket object. To get this object, run the Get-VBRAmazonS3Bucket cmdlet. | True | Named | True (ByValue) |
Name | Specifies a name of the Amazon S3 folder. Veeam Backup & Replication will return the folder with this name. | String | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
VBRAmazonS3Folder
This example shows how to get all folders added to Amazon object storage. $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier $bucket = Get-VBRAmazonS3Bucket -Connection $connection Get-VBRAmazonS3Folder -Connection $connection -Bucket $bucket |
Perform the following steps: - Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
- Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Save the result to the $bucket variable.
- Run the Get-VBRAmazonS3Folder cmdlet. Set the $connection variable as the Connection parameter value. Set the $bucket variable as the Bucket parameter value.
|
This example shows how to get a folder added to Amazon object storage. $account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c" $connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier $bucket = Get-VBRAmazonS3Bucket -Connection $connection Get-VBRAmazonS3Folder -Connection $connection -Bucket $bucket -Name "NewBucket" |
Perform the following steps: - Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
- Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
- Run the Get-VBRAmazonS3Bucket cmdlet. Set the $connection variable as the Connection parameter value. Save the result to the $bucket variable.
- Run the Get-VBRAmazonS3Folder cmdlet. Set the $connection variable as the Connection parameter value. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value.
|
Related Commands
Example 1. Getting All Folders Added to Amazon Object Storage