PI Powershell

DisableAFSecurityIdentity Class

Save PDF

TABLE OF CONTENTS

DisableAFSecurityIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Disable an AF Security Identity on an AF Server

The Disable-AFSecurityIdentity cmdlet disables an AF Security Identity on an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellDisableAFSecurityIdentity

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

Syntax

[CmdletAttribute("Disable", "AFSecurityIdentity", SupportsShouldProcess = true)]
public class DisableAFSecurityIdentity : OSICmdletBase

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

Dim instance As DisableAFSecurityIdentity

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

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

The DisableAFSecurityIdentity type exposes the following members.

Constructors

	Name	Description
	DisableAFSecurityIdentity

Properties

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

Examples

Disable-AFSecurityIdentity -CheckIn -AFSecurityIdentity $EngineersIdentity

Where:

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

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

Examples

$DisabledIdentity = Disable-AFSecurityIdentity -CheckIn -PassThrough -AFSecurityIdentity $EngineersIdentity

Where:

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

Disables the AF Security Identity "Engineers" from the AF Server "PIAF1". The change is checked in immediately. The AF Security Identity that was changed is returned, and in this example will be stored in variable $DisabledIdentity.

PI Powershell