PI Powershell

SetPIArchiveSetSettings Class

Save PDF

TABLE OF CONTENTS

SetPIArchiveSetSettings Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Sets the archive set configuration from a PI Data Archive

The Set-PIArchiveSetSettings cmdlet sets the PI Archive configuration settings for a specific archive set on a PI Data Archive.

Set-PIArchiveSetSettings can be used to set specific configuration settings for an archive set by name, or through a PIArchiveSetSettings object.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Set", "PIArchiveSetSettings", SupportsShouldProcess = true)]
public class SetPIArchiveSetSettings : OSICmdletBaseWithConnection

<CmdletAttribute("Set", "PIArchiveSetSettings", SupportsShouldProcess := true)>
Public Class SetPIArchiveSetSettings
	Inherits OSICmdletBaseWithConnection

Dim instance As SetPIArchiveSetSettings

[CmdletAttribute(L"Set", L"PIArchiveSetSettings", SupportsShouldProcess = true)]
public ref class SetPIArchiveSetSettings : public OSICmdletBaseWithConnection

[<CmdletAttribute("Set", "PIArchiveSetSettings", SupportsShouldProcess = true)>]
type SetPIArchiveSetSettings =  
    class
        inherit OSICmdletBaseWithConnection
    end

The SetPIArchiveSetSettings type exposes the following members.

Constructors

	Name	Description
	SetPIArchiveSetSettings

Properties

	Name	Description
	ArchiveSizeMB	Specifies the name of the archive file for which to get detailed information
	Connection	Specifies the connection to a PI Data Archive to use (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Specifies the name of the archive file for which to get detailed information
	SetSettings	Specifies the name of the archive file for which to get detailed information
	ShiftFrequency	Specifies the name of the archive file for which to get detailed information

Examples

Set-PIArchiveFileInfo -SetSettings $settings -Connection $con

Where:

$settings = Get-PIArchiveFileInfo

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Set the PI Archive Set settings to the values set

Examples

Set-PIArchiveFileInfo -Name "HistoricalSet" -ArchiveSizeMB 1024 -ShiftFrequency -Connection (Connect-PIDataArchive -PIDataArchiveMachineName PISRV1)

Set the PI Archive Set settings for the primary archive file (ID=0) on the "PISRV1" PI Data Archive server. Because -ArchiveSet parameter is not explicitly set, a value of 0 (Historical) will be used by default.

PI Powershell