PI Powershell

AddAFSecurityIdentity Class

Save PDF

TABLE OF CONTENTS

AddAFSecurityIdentity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Adds an AF Security Identity to an AF Server

The Add-AFSecurityIdentity cmdlet creates a new AF Security Identity on an AF Server.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellAddAFSecurityIdentity

Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 2.2.3.0 (2.2.3.952)

Syntax

[CmdletAttribute("Add", "AFSecurityIdentity", SupportsShouldProcess = true)]
public class AddAFSecurityIdentity : OSICmdletBase

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

Dim instance As AddAFSecurityIdentity

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

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

The AddAFSecurityIdentity type exposes the following members.

Constructors

	Name	Description
	AddAFSecurityIdentity

Properties

	Name	Description
	AFServer	AF Server on which to add the AF Security Identity
	CheckIn	Check in changes immediately
	Description	Description to add to the AF Security Identity
	Name	Name of the AF Security Identity to add

Examples

Add-AFSecurityIdentity -Name "Floor Operators" -Description "All plant floor operators" -CheckIn -AFServer (Get-AFServer -Name "PIAF1")

Adds an AF Security Identity "Floor Operators" to the AF Server "PIAF1". The change is checked in immediately.

Examples

$MyNewIdentity = Add-AFSecurityIdentity -Name "Floor Operators" -Description "All plant floor operators" -CheckIn -AFServer $afServer

Where:

$afServer = Get-AFServer -Name "PIAF1"

Adds an AF Security Identity "Floor Operators" to the AF Server "PIAF1" and stores the new object in $MyNewIdentity. The change is checked in immediately.

PI Powershell