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

PI Powershell

GetDiagnostics Class

  • Last UpdatedDec 15, 2025
  • 2 minute read
GetDiagnostics Class

Gets diagnostic information from the system.

This method returns information on things like the size of the AF SQL database files and the number of changed item records on the system. The information can be used to assess system health. Returns a dictionary of the diagnostic items which is keyed by diagnostic name. The DiagnosticNames class contains a list of the known names that can be used as keys for the returned dictionary. Additional items may be present in the dictionary.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetDiagnostics

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

Syntax

[CmdletAttribute("Get", "AFDiagnostics", SupportsShouldProcess = true)]
public class GetDiagnostics : OSICmdletBase
<CmdletAttribute("Get", "AFDiagnostics", SupportsShouldProcess := true)>
Public Class GetDiagnostics
	Inherits OSICmdletBase

Dim instance As GetDiagnostics
[CmdletAttribute(L"Get", L"AFDiagnostics", SupportsShouldProcess = true)]
public ref class GetDiagnostics : public OSICmdletBase
[<CmdletAttribute("Get", "AFDiagnostics", SupportsShouldProcess = true)>]
type GetDiagnostics =  
    class
        inherit OSICmdletBase
    end

The GetDiagnostics type exposes the following members.

Constructors

  NameDescription
Public method
GetDiagnostics

Properties

  NameDescription
Public property
AFServer

Instance of the AFServer

Examples

$afServer | Get-AFDiagnostics

Where:

$afServer = Get-AFServer -Name "AFServerMachineName"

Gets diagnostic information from the system.

See Also

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