PI Powershell

EnableAFSecurityIdentity Class

Save PDF

TABLE OF CONTENTS

EnableAFSecurityIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Enable an AF Security Identity on an AF Server

The Enable-AFSecurityIdentity cmdlet enables a currently disabled AF Security Identity on an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellEnableAFSecurityIdentity

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

Syntax

[CmdletAttribute("Enable", "AFSecurityIdentity", SupportsShouldProcess = true)]
public class EnableAFSecurityIdentity : OSICmdletBase

<CmdletAttribute("Enable", "AFSecurityIdentity", SupportsShouldProcess := true)>
Public Class EnableAFSecurityIdentity
	Inherits OSICmdletBase

Dim instance As EnableAFSecurityIdentity

[CmdletAttribute(L"Enable", L"AFSecurityIdentity", SupportsShouldProcess = true)]
public ref class EnableAFSecurityIdentity : public OSICmdletBase

[<CmdletAttribute("Enable", "AFSecurityIdentity", SupportsShouldProcess = true)>]
type EnableAFSecurityIdentity =  
    class
        inherit OSICmdletBase
    end

The EnableAFSecurityIdentity type exposes the following members.

Constructors

	Name	Description
	EnableAFSecurityIdentity

Properties

	Name	Description
	AFSecurityIdentity	AF Security Identity to enable
	CheckIn	Check in changes immediately
	PassThru	Returns objects that were changed. By default, this cmdlet does not generate any output

Examples

Enable-AFSecurityIdentity -CheckIn -AFSecurityIdentity $EngineersIdentity

Where:

$EngineersIdentity = Get-AFSecurityIdentity -Name Engineers -Refresh -AFServer (Get-AFServer -Name "PIAF1")

Enables the currently disabled AF Security Identity "Engineers" from the AF Server "PIAF1". The change is checked in immediately.

Examples

$MyAFIdentity = Enable-AFSecurityIdentity -CheckIn -PassThrough -AFSecurityIdentity $EngineersIdentity

Where:

$EngineersIdentity = Get-AFSecurityIdentity -Name Engineers -Refresh -AFServer (Get-AFServer -Name "PIAF1")

Enables the currently disabled AF Security Identity "Engineers" from the AF Server "PIAF1". The change is checked in immediately. The AF Security Identity that was enabled is sent down the pipeline, and in this example will be stored in variable $DisabledIdentity.

PI Powershell