Stop-VBORepositorySynchronizeSession

Short Description

Stops synchronization sessions of object storage cache.

Syntax

Stop-VBORepositorySynchronizeSession -Session <VBORepositorySynchronizeSession> [<CommonParameters>]

Detailed Description

This cmdlet stops sessions that are running to synchronize cache located in object storage.

Stop-VBORepositorySynchronizeSession Note

If you stop synchronization of cache located in object storage and then start it again, the synchronization process will start from the moment where it has been stopped.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Session	Specifies a synchronization session. The cmdlet will stop this session.	Accepts the VBORepositorySynchronizeSession object. To get this object, run the Get-VBORepositorySynchronizeSession cmdlet.	True	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Session

Specifies a synchronization session. The cmdlet will stop this session.

Accepts the VBORepositorySynchronizeSession object.

To get this object, run the Get-VBORepositorySynchronizeSession cmdlet.

True

Named

False

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 VBORepositorySynchronizeSession object that contains details on the synchronization status of object storage.

Examples

Stop-VBORepositorySynchronizeSession Example 1. Stopping All Synchronization Sessions

This command stops all sessions that are running to synchronize cache located in object storage.

Get-VBORepositorySynchronizeSession | foreach{Stop-VBORepositorySynchronizeSession -Session $_}

Stop-VBORepositorySynchronizeSession Example 2. Stopping Specific Synchronization Session

This example shows how to stop a session that is running to synchronize cache located on the Azure object storage.

$azurestorage = Get-VBORepository -Name "Azure"

$session = Get-VBORepositorySynchronizeSession -Repository $azurestorage

Stop-VBORepositorySynchronizeSession -Session $session

Perform the following steps:

Run the Get-VBORepository cmdlet. Specify the Name parameter value. Save the result to the $azurestorage variable.
Run the Get-VBORepositorySynchronizeSession cmdlet. Set the $azurestorage variable as the Repository parameter value. Save the result to the $session variable.

The cmdlet output will contain the following details on synchronization status of object storage: RepositoryId, RepositoryName and Status.

Run the Stop-VBORepositorySynchronizeSession cmdlet. Set the $session variable as the Session parameter value.

Related Commands