PI Powershell

GetPIAFLinkBatchDatabaseUnmappedIdentities Class

Save PDF

GetPIAFLinkBatchDatabaseUnmappedIdentities Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Get a list of unmapped PI Identities for the Batch Database from the AF Link Subsystem.

The Get-PIAFLinkBatchDatabaseUnmappedIdentities cmdlet get the unmapped PI Identities from the Batch Database that are required to have a mapping before a migration from Batch Database to Event Frames can be performed.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIAFLinkBatchDatabaseUnmappedIdentities

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

Syntax

[CmdletAttribute("Get", "PIAFLinkBatchDatabaseUnmappedIdentities", SupportsShouldProcess = true)]
public class GetPIAFLinkBatchDatabaseUnmappedIdentities : OSICmdletBase

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

Dim instance As GetPIAFLinkBatchDatabaseUnmappedIdentities

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

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

The GetPIAFLinkBatchDatabaseUnmappedIdentities type exposes the following members.

Constructors

	Name	Description
	GetPIAFLinkBatchDatabaseUnmappedIdentities

Properties

	Name	Description
	Connection	Connection to a PI Data Archive to use

Examples

Get-PIAFLinkBatchDatabaseUnmappedIdentities -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example retrieves a list of Identities that exist in the Batch Database but do not currecntly have a PI Mapping created. A PI Mapping must be created for each of these PI Identities before the Batch to Event Frames Migration can be performed.

PI Powershell