PI Powershell

StopPIArchiveReprocess Class

Save PDF

TABLE OF CONTENTS

StopPIArchiveReprocess Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Stops/cancels a PI Archive from being reprocessed

The Stop-PIArchiveReprocess cmdlet stops/cancels a PI Archive from being reprocessed. If the archive reprocess task is currently running, it will be stopped. If the archive reprocess task is still pending, it will be removed from the queue.

This cmdlet is only supported on PI Data Archive 2016 or later.

To view the current PI Archive reprocess queue. Use "Get-PIArchiveReprocessQueue". See "Get-Help Get-PIArchiveReprocessQueue -Full" for more information.

The connection parameter specifies which connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellStopPIArchiveReprocess

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Stop", "PIArchiveReprocess", SupportsShouldProcess = true)]
public class StopPIArchiveReprocess : OSICmdletBaseWithConnection

<CmdletAttribute("Stop", "PIArchiveReprocess", SupportsShouldProcess := true)>
Public Class StopPIArchiveReprocess
	Inherits OSICmdletBaseWithConnection

Dim instance As StopPIArchiveReprocess

[CmdletAttribute(L"Stop", L"PIArchiveReprocess", SupportsShouldProcess = true)]
public ref class StopPIArchiveReprocess : public OSICmdletBaseWithConnection

[<CmdletAttribute("Stop", "PIArchiveReprocess", SupportsShouldProcess = true)>]
type StopPIArchiveReprocess =  
    class
        inherit OSICmdletBaseWithConnection
    end

The StopPIArchiveReprocess type exposes the following members.

Constructors

	Name	Description
	StopPIArchiveReprocess

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to cancel archive reprocessing (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the archive or archives to cancel reprocessing

Examples

Stop-PIArchiveReprocess -Name "F:\PIArchives\piarch001.arc" -Connection (Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1")

Stops/cancels the piarch001.arc archive reprocessing on the "PISRV1" PI Data Archive.

Examples

Stop-PIArchiveReprocess -Name "F:\PIArchives\piarch006.arc","F:\PIArchives\piarch007.arc" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Stops/cancels two archives for reprocessing: "piarch006.arc" and "piarch007.arc"

PI Powershell