PI Powershell

GetPITuningParameter Class

Save PDF

TABLE OF CONTENTS

GetPITuningParameter Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get PI Data Archive tuning parameters for a PI Data Archive

The Get-PITuningParameter cmdlet gets tuning parameters from a specified 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.PowerShellGetPITuningParameter

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

Syntax

[CmdletAttribute("Get", "PITuningParameter", SupportsShouldProcess = true)]
public class GetPITuningParameter : OSICmdletBaseWithConnection

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

Dim instance As GetPITuningParameter

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

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

The GetPITuningParameter type exposes the following members.

Constructors

	Name	Description
	GetPITuningParameter

Properties

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

Examples

Get-PITuningParameter Server_AuthenticationPolicy -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the Server_AuthenticationPolicy tuning parameter from the "PISRV1" PI Data Archive server.

Examples

Get-PITuningParameter -Name * -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all tuning parameters from the "PISRV1" PI Data Archive server.

Examples

Get-PITuningParameter -Name * -Connection $con | Select-Object -Property name,takeseffect,description

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Creates a list of all tuning parameters and their associated description, as well as when the parameter takes effect. This can be helpful for reference or for help when looking for settings or configuration information for a parameter.

PI Powershell