PI Powershell

GetPIBackupState Class

Save PDF

TABLE OF CONTENTS

GetPIBackupState 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 State of a PI Data Archive

The Get-PIBackupState cmdlet gets the PI Backup State 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.PowerShellGetPIBackupState

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

Syntax

[CmdletAttribute("Get", "PIBackupState", SupportsShouldProcess = true)]
public class GetPIBackupState : OSICmdletBaseWithConnection

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

Dim instance As GetPIBackupState

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

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

The GetPIBackupState type exposes the following members.

Constructors

	Name	Description
	GetPIBackupState

Properties

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

Examples

Get-PIBackupState -Connection (Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1")

This example returns the backup state from the "PISRV1" PI Data Archive.

Examples

Get-PIBackupState -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example returns the backup state from the "PISRV1" PI Data Archive.

Examples

(Get-PIBackupState -Connection $con).IsInProgress

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example can be used to quickly determine if a backup is currently in-progress on the "PISRV1" PI Data Archive.

PI Powershell