PI Powershell

GetAFSecurityIdentity Class

Save PDF

TABLE OF CONTENTS

GetAFSecurityIdentity 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 Identity from an AF Server

The Get-AFSecurityIdentity cmdlet gets an AF Security Identity on an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFSecurityIdentity

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

Syntax

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

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

Dim instance As GetAFSecurityIdentity

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

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

The GetAFSecurityIdentity type exposes the following members.

Constructors

	Name	Description
	GetAFSecurityIdentity

Properties

	Name	Description
	AFServer	AF Server from which to retrieve the AF Security Identity
	ID	The GUID of the AF Security Identity to get
	Index	The index of the AF Security Identity to get
	Name	The name of the AF Security Identity to get
	Refresh	Refresh parent before getting the AF Security Identity

Examples

Get-AFSecurityIdentity -Name Administrators -Refresh -AFServer (Get-AFServer -Name PIAF1)

Gets the AF Security Identity "Administrators" from the AF Server "PIAF1"

Examples

Get-AFSecurityIdentity -Name * -Refresh -AFServer (Get-AFServer -Name PIAF1) | Where-Object -Property IsEnabled -EQ $False

Gets all "disabled" AF Security Identities from the AF Server "PIAF1". The AF Server object is refreshed before the AF Security Identites are retrieved.

Examples

Get-AFSecurityIdentity -Name * -Refresh -AFServer (Get-AFServer -Name PIAF1) | Where-Object -Property IsEnabled -EQ $False | Select-Object -Property Name,ModifyDate

Gets all "disabled" AF Security Identities from the AF Server "PIAF1" and outputs their Name and ModifyDate properties. The AF Server object is refreshed before the AF Security Identities are retrieved.

PI Powershell