Start-VBORepositoryOwnerChangeSession
Short Description
Creates and starts a session to change an owner for backup repositories from one to another.
Syntax
This cmdlet provides parameter sets that allow you to:
- Create and start a change owner session to move a backup repository or object storage repository to another backup proxy server.
Start-VBORepositoryOwnerChangeSession -Repository <VBORepository> [-Proxy <VBOProxy>] [-WaitForSessionsTimeoutMinutes <Int32>] [-ForceStopSessions] [-ForceStopSessionsTimeoutMinutes <Int32>] [-Force] [<CommonParameters>] |
- Create and start a change owner session to move object storage repository to another backup proxy pool.
Start-VBORepositoryOwnerChangeSession -Repository <VBORepository> [-Pool <VBOProxyPool>] [-WaitForSessionsTimeoutMinutes <Int32>] [-ForceStopSessions] [-ForceStopSessionsTimeoutMinutes <Int32>] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet creates and starts a session when Veeam Backup for Microsoft 365 changes an owner for a backup repository from one to another.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Repository | Specifies a backup repository or object storage repository. The cmdlet will create and start a change owner session for this backup repository or object storage repository. | Accepts the VBORepository object. To get this object, run the Get-VBORepository cmdlet. | True | Named | False |
Proxy | Specifies a backup proxy server. The cmdlet will move a backup repository or object storage repository to this backup proxy server. | Accepts the VBOProxy object. To get this object, run the Get-VBOProxy cmdlet. | False | Named | False |
WaitForSessionsTimeoutMinutes | Specifies a timeout in minutes. The cmdlet will use this timeout to wait for the related sessions to finish before starting the current session. Related sessions are the sessions that Veeam Backup for Microsoft 365 creates to perform different activities: data backup and backup copy, data management, data restore, data retrieval, and data migration. Default: 60 | Int32 | False | Named | False |
ForceStopSessions | Defines action that Veeam Backup for Microsoft 365 will perform if the related sessions exceed the WaitForSessionsTimeoutMinutes value to finish. The following values are available:
Default: False | SwitchParameter | False | Named | False |
ForceStopSessionsTimeoutMinutes | For the ForceStopSessions parameter set to true. Specifies a timeout in minutes. The cmdlet will use this timeout to wait for the related sessions to stop after Veeam Backup for Microsoft 365 forced them to stop. Default: 10 | Int32 | False | Named | False |
Force | Defines that the cmdlet will start a session without showing warnings in the PowerShell console. If you do not provide the parameter, the cmdlet will prompt you to confirm the operation. Default: False | SwitchParameter | False | Named | False |
Pool | Specifies a backup proxy pool. The cmdlet will move object storage repository to this backup proxy pool. | Accepts the VBOProxyPool object. To get this object, run the Get-VBOProxyPool cmdlet. | 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
The cmdlet returns the VBORepositoryOwnerChangeSession object that contains details on a session when Veeam Backup for Microsoft 365 changes an owner for a backup repository from one to another.
Example
Starting Change Owner Session
This example shows how to start a change owner session to move the Azure Backup object storage repository to the Pool1 backup proxy pool.
$repository = Get-VBORepository -Name "Azure Backup" $pool = Get-VBOProxyPool -Name "Pool1" Start-VBORepositoryOwnerChangeSession -Repository $repository -Pool $pool -ForceStopSessions |
Perform the following steps:
- Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
- Run the Get-VBOProxyPool cmdlet. Specify the Name parameter value. Save the result to the $pool variable.
- Run the Start-VBORepositoryOwnerChangeSession cmdlet. Set the $repository variable as the Repository parameter value. Set the $pool variable as the Pool parameter value. Provide the ForceStopSessions parameter.
Related Commands