PI Powershell

GetPITrust Class

Save PDF

TABLE OF CONTENTS

GetPITrust Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

GetPITrust Class

Get a PI Security Trust

The Get-PITrust cmdlet gets a PI Trust

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PITrust", SupportsShouldProcess = true)]
public class GetPITrust : OSICmdletBaseWithConnection

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

Dim instance As GetPITrust

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

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

The GetPITrust type exposes the following members.

Constructors

	Name	Description
	GetPITrust

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to get the PI Trust (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI Trust to get

Examples

Get-PITrust -Name "PIINT1_OPC_IPAddress" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Trust "PIINT1_OPC_IPAddress" from the "PISRV1" PI Data Archive server.

Examples

Get-PITrust -Name "PIINT1*" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all PI Trusts that start with PIINT1 from the "PISRV1" PI Data Archive server. Wildcards are supported by the -Name parameter in this cmdlet.

Examples

Get-PITrust -Name "*" -Connection $con | Group-Object -Property ApplicationName

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets a list of all PI Trusts on the "PISRV1" Data Archive server and groups the results by the ApplicationName the trust is configured for.

PI Powershell