StartPIBackup Properties
- Last UpdatedDec 15, 2025
- 2 minute read
The StartPIBackup type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ArchiveIndex | Indices of historical archives to include in the PI Backup. Index = 0 is the primary archive. |
| BackupLocation | Backup location for the PI Backup |
| Connection | Connection to a PI Data Archive from which to retrieve archive statistics |
| CutoffDate | Do not include historical archives older than the CutoffDate |
| Exclude | Components to exclude from the PI Backup To get a list of possible components to exclude, see example 2 of Get-PIBackupIdentifyReport using "Get-Help Get-PIBackupIdentifyReport -Examples" |
| ExcludeFuture | Exclude future archives from the PI Backup |
| Include | Components to include in the PI Backup. If none are specified explicitly, all will be backed up. To get a list of possible components to include, see example 2 of Get-PIBackupIdentifyReport using "Get-Help Get-PIBackupIdentifyReport -Examples" |
| NumberOfArchives | Number of most recent historical archives to include in the PI Backup |
| Type | Type of PI Backup to perform |