Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Powershell

GetPIMessage Properties

  • Last UpdatedDec 15, 2025
  • 3 minute read
GetPIMessage Properties

The GetPIMessage type exposes the following members.

Properties

  NameDescription
Public property
Category

Category mask to search for

Public property
Connection

Connection to a PI Data Archive from which to get the message(s)

(Overrides OSICmdletBaseWithConnectionConnection.)
Public property
Count

Maximum number of messages to retrieve

Public property
EndTime

End time for which to retrieve messages

Public property
Id

Message ID to search for. Multiple Message IDs can be searched by specifying a comma separated list

Public property
Message

Message string mask to search for

Public property
OriginatingHost

Originating hostname of the message to search for

Public property
OriginatingOSUser

Originating OS User of the message to search for

Public property
OriginatingPIUser

Originating PI User of the message to search for

Public property
Priority

Message priority to search for

Public property
ProcessHost

Hostname of the machine running the process that issued the message to search for

Public property
ProcessId

ProcessID of ProgramName to search for

Public property
ProcessOSUser

OS User under which the process issuing the message runs to search for

Public property
ProcessPIUser

PI User Identity of the process issues the message to search for

Public property
Program

Program mask to search for

Public property
SeverityType

Message severity level to retrieve. Severity levels are:

"Debug" -> "Informational" -> "Warning" -> "Error" -> "Critical"

Public property
Source1

Source1 mask to search for

Public property
Source2

Source2 mask to search for

Public property
Source3

Source3 mask to search for

Public property
SourceAny

Source mask for any source field to search for (includes Source1, Source2, and Source3)

Public property
StartTime

Start time for which to retrieve messages

See Also

TitleResults for “How to create a CRG?”Also Available in