PI Powershell

GetAFSecurityMapping Class

Save PDF

TABLE OF CONTENTS

GetAFSecurityMapping Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Gets an AF Security Mapping from an AF Server

The Get-AFSecurityMapping cmdlet gets an AF Security Mapping from an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFSecurityMapping

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

Syntax

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

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

Dim instance As GetAFSecurityMapping

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

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

The GetAFSecurityMapping type exposes the following members.

Constructors

	Name	Description
	GetAFSecurityMapping

Properties

	Name	Description
	AFServer	AF Server from which to retrieve the AF Security Mapping
	ID	GUID of the AF Security Mapping to get
	Index	Index of the AF Security Mapping to get
	Name	Name of the AF Security Mapping to get
	Refresh	Refresh the parent container before retrieving AF Security Mapping

Examples

Get-AFSecurityMapping -Name domain\testuser -Refresh -AFServer (Get-AFServer -Name PIAF1)

Gets the AF Security Mapping "domain\testuser" from the AF Server "PIAF1"

Examples

Get-AFSecurityMapping -Name * -Refresh -AFServer (Get-AFServer -Name PIAF1) | Select-Object -Property Name,SecurityIdentity

Gets all AF Security Mappings from the AF Server "PIAF1" and outputs only their Name and associated AF Security Identity. The AF Server object is refreshed before the AF Security Mappings are retrieved.

PI Powershell