Stop-VBORepositorySynchronizeSession

Short Description

Stops sessions that are running to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.

Syntax

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

Detailed Description

This cmdlet stops sessions that are running to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.

Note

If you stop the synchronization session and then start it again, the synchronization process will start from the moment where it has been stopped.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies a synchronization session. The cmdlet will stop this session. Accepts the `VBORepositorySynchronizeSession` object. To get this object, run the `Get-VBORepositorySynchronizeSession` cmdlet.	`VBORepositorySynchronizeSession`	True	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 VBORepositorySynchronizeSession object that contains details on the synchronization status of an object storage repository.

Examples

Stop-VBORepositorySynchronizeSession Example 1: Stopping All Synchronization Sessions

This command stops all sessions that are running to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.

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 between the Azure object storage repository and the PersistentCache database on the PostgreSQL instance.

$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 an object storage repository: RepositoryId, RepositoryName and Status.
Run the Stop-VBORepositorySynchronizeSession cmdlet. Set the $session variable as the Session parameter value.