PI Powershell

GetPIAFLinkModuleDatabaseSecurityErrors Class

Save PDF

GetPIAFLinkModuleDatabaseSecurityErrors Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get a list of PI AF Link security errors on a PI Data Archive

The Get-PIAFLinkModuleDatabaseSecurityErrors cmdlet analyzes the PI Module Database for security errors that may prevent the PI Module Database from synchronizing to an AF Database. These errors should be resolved before attempting to sync Module Database and AF Datbase.

The connection parameter specifies the connection to a PI Data Archive to use.

This cmdlet returns a collection of PI Modules which each contain a collection of errors encountered.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIAFLinkModuleDatabaseSecurityErrors

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

Syntax

[CmdletAttribute("Get", "PIAFLinkModuleDatabaseSecurityErrors", SupportsShouldProcess = true)]
public class GetPIAFLinkModuleDatabaseSecurityErrors : OSICmdletBase

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

Dim instance As GetPIAFLinkModuleDatabaseSecurityErrors

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

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

The GetPIAFLinkModuleDatabaseSecurityErrors type exposes the following members.

Constructors

	Name	Description
	GetPIAFLinkModuleDatabaseSecurityErrors

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use
	Timeout	The length of time to wait for a result from the query. If no Timeout is specified, the OperationTimeout for the connection is used.

Examples

Get-PIAFLinkModuleDatabaseSecurityErrors -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example retrieves any potential security conflicts found by PI AF Link on the PISRV1 PI Data Archive. No timeout is specified, so the OperationTimeout parameter of the connection will be used as a timeout.

Examples

(Get-PIAFLinkModuleDatabaseSecurityErrors -Connection $con).Count

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example returns a count of the number of PI Modules with found security errors. No timeout is specified, so the OperationTimeout parameter of the connection will be used as a timeout.

Examples

(Get-PIAFLinkModuleDatabaseSecurityErrors -Timeout "00:00:30" -Connection $con).Errors

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example dumps all security errors found by PI AF Link. A timeout timespan of 30 seconds is specified.

PI Powershell