PI Powershell

GetPIBackupReport Class

Save PDF

TABLE OF CONTENTS

GetPIBackupReport 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

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

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIBackupReport", DefaultParameterSetName = "BackupReportIndex", 
	SupportsShouldProcess = true)]
public class GetPIBackupReport : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIBackupReport", DefaultParameterSetName := "BackupReportIndex", 
	SupportsShouldProcess := true)>
Public Class GetPIBackupReport
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIBackupReport

[CmdletAttribute(L"Get", L"PIBackupReport", DefaultParameterSetName = L"BackupReportIndex", 
	SupportsShouldProcess = true)]
public ref class GetPIBackupReport : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIBackupReport", DefaultParameterSetName = "BackupReportIndex", 
	SupportsShouldProcess = true)>]
type GetPIBackupReport =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIBackupReport type exposes the following members.

Constructors

	Name	Description
	GetPIBackupReport

Properties

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

Examples

Get-PIBackupReport -LastReport -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example returns the backup report object for the most recent backup from the "PISRV1" PI Data Archive.

Examples

(Get-PIBackupReport -LastReport -Connection $con).Summary

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example returns the backup report summary for the most recent backup from the "PISRV1" PI Data Archive.

Examples

Get-PIBackupReport -Index 97 -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

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

PI Powershell