PI Powershell

StopPIBackup Class

Save PDF

Save PDF

StopPIBackup Class

Stop execution of a PI Backup on a PI Data Archive

The Stop-PIBackup cmdlet stops a PI Backup on a PI Data Archive.

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

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellStopPIBackup

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

[CmdletAttribute("Stop", "PIBackup", SupportsShouldProcess = true)]
public class StopPIBackup : OSICmdletBase

<CmdletAttribute("Stop", "PIBackup", SupportsShouldProcess := true)>
Public Class StopPIBackup
	Inherits OSICmdletBase

Dim instance As StopPIBackup

[CmdletAttribute(L"Stop", L"PIBackup", SupportsShouldProcess = true)]
public ref class StopPIBackup : public OSICmdletBase

[<CmdletAttribute("Stop", "PIBackup", SupportsShouldProcess = true)>]
type StopPIBackup =  
    class
        inherit OSICmdletBase
    end

The StopPIBackup type exposes the following members.

	Name	Description
	StopPIBackup

	Name	Description
	Connection	Connection to a PI Data Archive from which to stop a PI Backup

Stop-PIBackup -Connection (Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1")

This example stops a running PI Backup on the "PISRV1" PI Data Archive.

Stop-PIBackup -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example stops a running PI Backup on the "PISRV1" PI Data Archive.