PI Powershell

GetPILicenseUser Class

Save PDF

TABLE OF CONTENTS

GetPILicenseUser Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get a PI License User on a PI Data Archive

The Get-PILicenseUser cmdlet retrieves a license user on the 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.PowerShellGetPILicenseUser

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Get", "PILicenseUser", SupportsShouldProcess = true)]
public class GetPILicenseUser : OSICmdletBase

<CmdletAttribute("Get", "PILicenseUser", SupportsShouldProcess := true)>
Public Class GetPILicenseUser
	Inherits OSICmdletBase

Dim instance As GetPILicenseUser

[CmdletAttribute(L"Get", L"PILicenseUser", SupportsShouldProcess = true)]
public ref class GetPILicenseUser : public OSICmdletBase

[<CmdletAttribute("Get", "PILicenseUser", SupportsShouldProcess = true)>]
type GetPILicenseUser =  
    class
        inherit OSICmdletBase
    end

The GetPILicenseUser type exposes the following members.

Constructors

	Name	Description
	GetPILicenseUser

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to get the PI License User
	Name	Name of the PI License User (PI Subsystem) to retrieve

Examples

Get-PILicenseUser -Name "pibasess_14e1bf4d-df7e-464a-a617-78edf6bd11f0" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI License User information for PI Base Subsystem on the "PISRV1" PI Data Archive. License users are PI Data Archive Subsystems (EX: piarchss, pisnapss, pibasess, etc) and the names are <subsystemname>_<PIServerGUID>. If you do not specify a name, all license users are returned.

Examples

Get-PILicenseUser -Name * -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all the PI License Users on the "PISRV1" PI Data Archive.

PI Powershell