PI Powershell

RemoveAFSecurityMapping Class

Save PDF

TABLE OF CONTENTS

RemoveAFSecurityMapping Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove an AF Security Mapping from an AF Server

The Remove-AFSecurityMapping cmdlet removes an existing AF Security Mapping from an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemoveAFSecurityMapping

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

Syntax

[CmdletAttribute("Remove", "AFSecurityMapping", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)]
public class RemoveAFSecurityMapping : OSICmdletBase

<CmdletAttribute("Remove", "AFSecurityMapping", DefaultParameterSetName := "Name", 
	SupportsShouldProcess := true)>
Public Class RemoveAFSecurityMapping
	Inherits OSICmdletBase

Dim instance As RemoveAFSecurityMapping

[CmdletAttribute(L"Remove", L"AFSecurityMapping", DefaultParameterSetName = L"Name", 
	SupportsShouldProcess = true)]
public ref class RemoveAFSecurityMapping : public OSICmdletBase

[<CmdletAttribute("Remove", "AFSecurityMapping", DefaultParameterSetName = "Name", 
	SupportsShouldProcess = true)>]
type RemoveAFSecurityMapping =  
    class
        inherit OSICmdletBase
    end

The RemoveAFSecurityMapping type exposes the following members.

Constructors

	Name	Description
	RemoveAFSecurityMapping

Properties

	Name	Description
	AFSecurityMapping	AF Security Mapping to remove
	AFServer	AF Server from which to remove the AF Security Mapping
	CheckIn	Check in changes immediately
	ID	GUID of the AF Security Mapping to remove
	Name	Name of the AF Security Mapping to remove

Examples

Remove-AFSecurityMapping -Name "domain\testuser" -CheckIn -AFServer (Get-AFServer -Name PIAF1)

Removes an existing AF Security Mapping called "domain\testuser" from the AF Server "PIAF1". The change is checked in immediately.

Examples

Remove-AFSecurityMapping -AFSecurityMapping $TestUser -CheckIn -AFServer (Get-AFServer -Name PIAF1)

Where:

$TestUser = Get-AFSecurityMapping -Name "domain\testuser" -Refresh -AFServer (Get-AFServer -Name "PIAF1")

Removes an existing AF Security Mapping called "domain\testuser" from the AF Server "PIAF1". The change is checked in immediately.

PI Powershell