PI Powershell

GetPIBackupIdentifyReport Class

Save PDF

TABLE OF CONTENTS

GetPIBackupIdentifyReport Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get the PI Backup Identify report

The Get-PIBackupIdentifyReport cmdlet gets the backup identify report for a PI Data Archive. This report includes files and components identified for backup.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIBackupIdentifyReport", SupportsShouldProcess = true)]
public class GetPIBackupIdentifyReport : OSICmdletBaseWithConnection

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

Dim instance As GetPIBackupIdentifyReport

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

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

The GetPIBackupIdentifyReport type exposes the following members.

Constructors

	Name	Description
	GetPIBackupIdentifyReport

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to retrieve backup identify report (Overrides OSICmdletBaseWithConnectionConnection.)

Examples

Get-PIBackupIdentifyReport -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the backup identify report from the "PISRV1" PI Data Archive.

Examples

(Get-PIBackupIdentifyReport -Connection $con).Components

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Data Archive components and descriptions identified for backup on the "PISRV1" PI Data Archive.

Examples

(Get-PIBackupIdentifyReport -Connection $con).Files.Name

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the files identified for backup on the "PISRV1" PI Data Archive.

PI Powershell