Unmount-VBRObjectStorageRepository
Short Description
Unmounts object storage and archive repositories.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Unmount object storage repositories.
Unmount-VBRObjectStorageRepository -Repository <VBRObjectStorageRepository> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] |
- Unmount an archive repository.
Unmount-VBRObjectStorageRepository -ArchiveRepository <VBRArchiveObjectStorageRepository> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet unmounts object storage and archive repositories.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Repository | Specifies an object storage repository. The cmdlet will unmount this repository. | Accepts the VBRObjectStorageRepository object. To get this object, run the Get-VBRObjectStorageRepository cmdlet. | True | Named | True (ByValue) |
ArchiveRepository | Specifies an archive repository. The cmdlet will mount this archive repository. | Accepts the VBRArchiveObjectStorageRepository object. To get this object, run the Get-VBRArchiveObjectStorageRepository cmdlet. | True | Named | True (ByValue) |
Force | Defines that the cmdlet will unmount an object storage repository and will not show up any warnings or notifications. | SwitchParameter | False | Named | False |
WhatIf | Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. | SwitchParameter | False | Named | False |
Confirm | Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Examples
Unmounting Object Storage Repository
This example shows how to unmount the Amazon OS object storage repository. The cmdlet will skip all notifications and warnings.
$repository = Get-VBRObjectStorageRepository -Name "Amazon OS" Unmount-VBRObjectStorageRepository -Repository $repository -Force |
Perform the following steps:
- Run the Get-VBRObjectStorageRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
- Run the Unmount-VBRObjectStorageRepository cmdlet. Set the $repository variable as the Repository parameter value. Provide the Force parameter.
Related Commands