Stop-VBORepositoryMaintenanceSession

Short Description

Stops maintenance sessions.

Syntax

This cmdlet provides the following parameter sets:

BySession (Default)

Stop-VBORepositoryMaintenanceSession -Session <VBORepositoryMaintenanceSession> [<CommonParameters>]
BySessionId

Stop-VBORepositoryMaintenanceSession -Id <Guid> [<CommonParameters>]

Detailed Description

This cmdlet stops a maintenance session. After the maintenance session stops, Veeam Backup for Microsoft 365 resumes operations on the backup repositories for which this session was started.

If you stop a maintenance session that has not entered the Running state yet, Veeam Backup for Microsoft 365 cancels this session. The related sessions that Veeam Backup for Microsoft 365 was waiting for are not stopped.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an ID of the maintenance session. The cmdlet will stop the maintenance session with this ID.	`Guid`	True	Named	False
Session	Specifies a maintenance session. The cmdlet will stop this session. Accepts the `VBORepositoryMaintenanceSession` object. To get this object, run the `Get-VBORepositoryMaintenanceSession` cmdlet.	`VBORepositoryMaintenanceSession`	True	Named	True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Examples

Stop-VBORepositoryMaintenanceSession Example 1: Stopping Maintenance Session Started for Specific Backup Repository

This example shows how to stop a maintenance session started for the Repository 09 backup repository.

$repository = Get-VBORepository -Name "Repository 09"

$session = Get-VBORepositoryMaintenanceSession -Repository $repository -State Running

Stop-VBORepositoryMaintenanceSession -Session $session

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Get-VBORepositoryMaintenanceSession cmdlet. Set the $repository variable as the Repository parameter value. Specify the State parameter value. Save the result to the $session variable.
Run the Stop-VBORepositoryMaintenanceSession cmdlet. Set the $session variable as the Session parameter value.

Stop-VBORepositoryMaintenanceSession Example 2: Stopping Maintenance Session by ID

This command stops a maintenance session with the ID 4a1f8c3e-7d92-4b60-9f15-0c2e6b84d371.

Stop-VBORepositoryMaintenanceSession -Id 4a1f8c3e-7d92-4b60-9f15-0c2e6b84d371