Get-VBORepositoryMaintenanceSession

Short Description

Returns maintenance sessions started for backup repositories.

Syntax

This cmdlet provides the following parameter sets:

GetByFilter (Default)

Get-VBORepositoryMaintenanceSession [-Repository <VBORepository>] [-State <VBOControllerSessionState>] [<CommonParameters>]
GetById

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

Detailed Description

This cmdlet returns maintenance sessions that are started for backup repositories.

During maintenance session, Veeam Backup for Microsoft 365 suspends operations on the backup repositories, and you can perform service operations on the storage where these repositories reside.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an ID of the maintenance session. The cmdlet will return details of this session.	`Guid`	True	Named	False
Repository	Specifies a backup repository. The cmdlet will return maintenance sessions that are started for the specified backup repository. Accepts the `VBORepository` object. To get this object, run the `Get-VBORepository` cmdlet.	`VBORepository`	False	Named	True (ByValue)
State	Specifies a session state. The cmdlet will return maintenance sessions that are in the specified state: `Initialized` `Preparing` `Running` `Finishing` `Finished` `Canceling` `Canceled` `Failing` `Failed`	`VBOControllerSessionState`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBORepositoryMaintenanceSession object that contains details on a maintenance session when Veeam Backup for Microsoft 365 suspends operations on a backup repository.

Examples

Get-VBORepositoryMaintenanceSession Example 1: Getting Maintenance Sessions Started for Specific Backup Repository

This example shows how to get maintenance sessions started for the Repository 09 backup repository and that are in the Finished state.

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

Get-VBORepositoryMaintenanceSession -Repository $repository -State Finished

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.

Get-VBORepositoryMaintenanceSession Example 2: Getting Maintenance Session by ID

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

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

Get-VBORepository