PI Powershell

GetPILicenseEntry Class

Save PDF

TABLE OF CONTENTS

GetPILicenseEntry Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get a PI License Entry for an application on a PI Data Archive

The Get-PILicenseEntry cmdlet retrieves a license entry for an application 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.PowerShellGetPILicenseEntry

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

Syntax

[CmdletAttribute("Get", "PILicenseEntry", SupportsShouldProcess = true)]
public class GetPILicenseEntry : OSICmdletBase

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

Dim instance As GetPILicenseEntry

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

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

The GetPILicenseEntry type exposes the following members.

Constructors

	Name	Description
	GetPILicenseEntry

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to get the PI License Entry
	Name	License name of the application for which to retrieve the license Entry

Examples

Get-PILicenseEntry -Name PI-IN-OS-OPC.Default -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI License Entry for an OPC Interface connection on the "PISRV1" PI Data Archive.

Examples

Get-PILicenseEntry -Name * -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all the PI License Entries for all possible connections on the "PISRV1" PI Data Archive.

PI Powershell