PI Powershell

GetPILicenseReport Class

Save PDF

TABLE OF CONTENTS

GetPILicenseReport Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get a PI License Report for a PI Data Archive

The Get-PILicenseReport cmdlet retrieves the license report for a 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.PowerShellGetPILicenseReport

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

Syntax

[CmdletAttribute("Get", "PILicenseReport", SupportsShouldProcess = true)]
public class GetPILicenseReport : OSICmdletBase

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

Dim instance As GetPILicenseReport

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

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

The GetPILicenseReport type exposes the following members.

Constructors

	Name	Description
	GetPILicenseReport

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to get the PI License Report

Examples

Get-PILicenseReport -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the PI License Report for the "PISRV1" PI Data Archive.

Examples

(Get-PILicenseReport -Connection $con).Usage.CurrentPercentMatch

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the current license "percent match" for a PI Data Archive. If the percent match falls below the "Required Percent Match", a new license file should be generated. Contact technical support for more information.

PI Powershell