PI Powershell

GetPIArchiveInfo Class

Save PDF

GetPIArchiveInfo Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Gets general PI Archive information and status

The Get-PIArchiveInfo cmdlet gets PI Archive information and status, including all registered archives and archive shift information.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIArchiveInfo

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

Syntax

[CmdletAttribute("Get", "PIArchiveInfo", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)]
public class GetPIArchiveInfo : OSICmdletBase

<CmdletAttribute("Get", "PIArchiveInfo", DefaultParameterSetName := "Name", 
	SupportsShouldProcess := true)>
Public Class GetPIArchiveInfo
	Inherits OSICmdletBase

Dim instance As GetPIArchiveInfo

[CmdletAttribute(L"Get", L"PIArchiveInfo", DefaultParameterSetName = L"Name", 
	SupportsShouldProcess = true)]
public ref class GetPIArchiveInfo : public OSICmdletBase

[<CmdletAttribute("Get", "PIArchiveInfo", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)>]
type GetPIArchiveInfo =  
    class
        inherit OSICmdletBase
    end

The GetPIArchiveInfo type exposes the following members.

Constructors

	Name	Description
	GetPIArchiveInfo

Properties

	Name	Description
	ArchiveSet	Specifies the archive set from which to retrieve information: 0 = Historical 1 = Future
	Connection	Connection to a PI Data Archive for which to get the PI Archive information

Examples

Get-PIArchiveInfo -ArchiveSet 0 -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Get the PI Archive information for the "PISRV1" PI Data Archive server. -ArchiveSet is set to 0, so the historical PI Archive information will be retrieved.

Examples

Get-PIArchiveInfo -Connection (Connect-PIDataArchive -PIDataArchiveMachineName PISRV1)

Get the PI Archive information for the "PISRV1" PI Data Archive server. Because -ArchiveSet parameter is not explicitly set, a value of 0 (Historical) will be used by default.

Examples

Get-PIArchiveInfo -ArchiveSet 1 -Connection (Connect-PIDataArchive -PIDataArchiveMachineName PISRV1)

Get the PI Archive information for the "PISRV1" PI Data Archive server. -ArchiveSet is set to 1, so the future PI Archive information will be retrieved.

PI Powershell