PI Powershell

GetPIBackupSummary Class

Save PDF

TABLE OF CONTENTS

GetPIBackupSummary Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get a PI Backup Report Summary

The Get-PIBackupSummary cmdlet gets a backup report summary for a PI Data Archive.

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

NOTE: To get the summary of the most recent backup, see Example 2 for Get-PIBackupReport using "Get-Help Get-PIBackupReport -Examples"

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIBackupSummary", SupportsShouldProcess = true)]
public class GetPIBackupSummary : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIBackupSummary", SupportsShouldProcess := true)>
Public Class GetPIBackupSummary
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIBackupSummary

[CmdletAttribute(L"Get", L"PIBackupSummary", SupportsShouldProcess = true)]
public ref class GetPIBackupSummary : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIBackupSummary", SupportsShouldProcess = true)>]
type GetPIBackupSummary =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIBackupSummary type exposes the following members.

Constructors

	Name	Description
	GetPIBackupSummary

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to retrieve backup report summary (Overrides OSICmdletBaseWithConnectionConnection.)
	Index	Backup report summary index to get from the PI Data Archive

Examples

Get-PIBackupSummary -Index 97 -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example returns the backup report summary for the backup with index 97 from the "PISRV1" PI Data Archive.

PI Powershell