PI Powershell

RegisterPIArchive Class

Save PDF

TABLE OF CONTENTS

RegisterPIArchive Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Registers a PI Archive file with a PI Data Archive server.

The Register-PIArchive cmdlet registers a PI Archive file with a PI Data Archive server.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Register", "PIArchive", SupportsShouldProcess = true)]
public class RegisterPIArchive : OSICmdletBaseWithConnection

<CmdletAttribute("Register", "PIArchive", SupportsShouldProcess := true)>
Public Class RegisterPIArchive
	Inherits OSICmdletBaseWithConnection

Dim instance As RegisterPIArchive

[CmdletAttribute(L"Register", L"PIArchive", SupportsShouldProcess = true)]
public ref class RegisterPIArchive : public OSICmdletBaseWithConnection

[<CmdletAttribute("Register", "PIArchive", SupportsShouldProcess = true)>]
type RegisterPIArchive =  
    class
        inherit OSICmdletBaseWithConnection
    end

The RegisterPIArchive type exposes the following members.

Constructors

	Name	Description
	RegisterPIArchive

Properties

	Name	Description
	Connection	Specifies which connection to a PI Data Archive to use. (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Specifies the full path and name of the archive file to register

Examples

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

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

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

Examples

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

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Registers the archive file found at "D:\Program Files\PI\arc\piarch008.arc" on 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