GetPIUser Class
- Last UpdatedDec 15, 2025
- 3 minute read
Gets an existing PI User on a PI Data Archive
The Get-PIUser cmdlet gets an existing PI User on a PI Data Archive
The connection parameter specifies which connection to a PI Data Archive to use.
NOTE: PI Users and PI Groups have been replaced by PI Identities. PI Identities with PI Mappings (WIS) and PI Trusts should be used to configure PI Data Archive security. See KB00833 for more information.
Inheritance Hierarchy
InternalCommand
Cmdlet
PSCmdlet
OSIsoft.PowerShellOSICmdletBase
OSIsoft.PowerShellGetPIUser
Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)
Syntax
[CmdletAttribute("Get", "PIUser", SupportsShouldProcess = true)] public class GetPIUser : OSICmdletBase
<CmdletAttribute("Get", "PIUser", SupportsShouldProcess := true)> Public Class GetPIUser Inherits OSICmdletBase Dim instance As GetPIUser
[CmdletAttribute(L"Get", L"PIUser", SupportsShouldProcess = true)] public ref class GetPIUser : public OSICmdletBase
[<CmdletAttribute("Get", "PIUser", SupportsShouldProcess = true)>] type GetPIUser = class inherit OSICmdletBase end
The GetPIUser type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | GetPIUser |
Properties
| Name | Description | |
|---|---|---|
 | Connection | Connection to a PI Data Archive from which to get the PI User |
| Name | Name of the PI User to get |
Examples
Get-PIUser -Name "John Doe" -Connection $conWhere:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
This example gets an existing PI User "John Doe" from the "PISRV1" PI Data Archive.
Examples
Get-PIUser -Name * -Connection $con | Select-Object -Property Name,Groups
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
This example gets a list of all PI Users and what PI Groups they belong to from the "PISRV1" PI Data Archive.