PI Powershell

RemovePIMapping Class

Save PDF

TABLE OF CONTENTS

RemovePIMapping Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove a PI Security Mapping

The Remove-PIMapping cmdlet deletes an existing PI Security Mapping

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellRemovePIMapping

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)

Syntax

[CmdletAttribute("Remove", "PIMapping", SupportsShouldProcess = true)]
public class RemovePIMapping : OSICmdletBaseWithConnection

<CmdletAttribute("Remove", "PIMapping", SupportsShouldProcess := true)>
Public Class RemovePIMapping
	Inherits OSICmdletBaseWithConnection

Dim instance As RemovePIMapping

[CmdletAttribute(L"Remove", L"PIMapping", SupportsShouldProcess = true)]
public ref class RemovePIMapping : public OSICmdletBaseWithConnection

[<CmdletAttribute("Remove", "PIMapping", SupportsShouldProcess = true)>]
type RemovePIMapping =  
    class
        inherit OSICmdletBaseWithConnection
    end

The RemovePIMapping type exposes the following members.

Constructors

	Name	Description
	RemovePIMapping

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to remove the PI Mapping (Overrides OSICmdletBaseWithConnectionConnection.)
	Name	Name of the PI Mapping to remove

Examples

Remove-PIMapping -Name "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Removes the PI Mapping "Windows_S-1-5-21-2084324470-1890137325-1469997231-53017" from the "PISRV1" PI Data Archive server.

PI Powershell