PI Powershell

SetPITuningParameter Class

Save PDF

TABLE OF CONTENTS

SetPITuningParameter Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Set a PI Data Archive tuning parameter value for a PI Data Archive

The Set-PITuningParameter cmdlet sets a tuning parameter value on a specified PI Data Archive. Note that this cmdlet does not force the new value to take effect. Use Get-PITuningParameter to check when the PI Tuning Parameter will take effect.

To reset the value of the PI Tuning Parameter back to its default value, use Reset-PITuningParameter.

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Set", "PITuningParameter", SupportsShouldProcess = true)]
public class SetPITuningParameter : OSICmdletBaseWithConnection

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

Dim instance As SetPITuningParameter

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

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

The SetPITuningParameter type exposes the following members.

Constructors

	Name	Description
	SetPITuningParameter

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to set the tuning parameter (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI Data Archive tuning parameter to set
	Value	Value of the PI Data Archive tuning parameter to set

Examples

Set-PITuningParameter -Name Archive_AutoArchiveFileSize -Value 1024 -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Sets the Archive_AutoArchiveFileSize tuning parameter to 1024MB (1 GB) on the "PISRV1" PI Data Archive server.

PI Powershell