PI Powershell

UnregisterPIArchive Class

Save PDF

TABLE OF CONTENTS

UnregisterPIArchive Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Unregisters a registered PI Archive file with a PI Data Archive server.

The Unregister-PIArchive cmdlet unregisters a registered PI Archive file from a PI Data Archive server.

An unregistered archive is not deleted, but the PI Data Archive will no longer see the data contained until it is registered again.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellUnregisterPIArchive

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Unregister", "PIArchive", SupportsShouldProcess = true)]
public class UnregisterPIArchive : OSICmdletBase

<CmdletAttribute("Unregister", "PIArchive", SupportsShouldProcess := true)>
Public Class UnregisterPIArchive
	Inherits OSICmdletBase

Dim instance As UnregisterPIArchive

[CmdletAttribute(L"Unregister", L"PIArchive", SupportsShouldProcess = true)]
public ref class UnregisterPIArchive : public OSICmdletBase

[<CmdletAttribute("Unregister", "PIArchive", SupportsShouldProcess = true)>]
type UnregisterPIArchive =  
    class
        inherit OSICmdletBase
    end

The UnregisterPIArchive type exposes the following members.

Constructors

	Name	Description
	UnregisterPIArchive

Properties

	Name	Description
	Connection	Specifies which connection to a PI Data Archive to use.
	Name	Specifies the full path and name of the archive file to unregister

Examples

Unregister-PIArchive -Name E:\PIArchives\piarch008.arc -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Unregisters the archive file found at E:\PIArchives\piarch008.arc from the "PISRV1" PI Data Archive server.

Examples

Unregister-PIArchive -Name "D:\Program Files\PI\arc\piarch008.arc" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Unregisters the archive file found at "D:\Program Files\PI\arc\piarch008.arc" from the "PISRV1" PI Data Archive server. Note that the path to the archive contains a space so the entire path must be enclosed in double quotes.

PI Powershell