PI Powershell

GetPIMapping Class

Save PDF

TABLE OF CONTENTS

GetPIMapping Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

GetPIMapping Class

Get a PI Security Mapping

The Get-PIMapping cmdlet gets a PI Security Mapping

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

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Get", "PIMapping", SupportsShouldProcess = true)]
public class GetPIMapping : OSICmdletBaseWithConnection

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

Dim instance As GetPIMapping

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

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

The GetPIMapping type exposes the following members.

Constructors

	Name	Description
	GetPIMapping

Properties

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

Examples

Get-PIMapping -Name "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI Mapping "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" from the "PISRV1" PI Data Archive server.

Note that name of the mapping is typically Windows_[WindowsSID] where [WindowsSID] is the Windows SID of the Windows User or Group the mapping is for.

Examples

Get-PIMapping -Name "*" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all PI Mappings from the "PISRV1" PI Data Archive server.

Examples

Get-PIMapping -Name "*" -Connection $con | Where-Object -Property Identity -eq "piadmin"

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets a list of only PI Mappings which are mapped to the "piadmin" identity on the "PISRV1" Data Archive server. This might be helpful when trying to better lock down access to the PI Data Archive.

PI Powershell