PI Powershell

GetAFSecurity Class

Save PDF

TABLE OF CONTENTS

GetAFSecurity Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

GetAFSecurity Class

Get AF Security entry for an AF object

The Get-AFSecurity cmdlet gets an AF Security entry for an AF object.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFSecurity

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

Syntax

[CmdletAttribute("Get", "AFSecurity", SupportsShouldProcess = true)]
public class GetAFSecurity : OSICmdletBase

<CmdletAttribute("Get", "AFSecurity", SupportsShouldProcess := true)>
Public Class GetAFSecurity
	Inherits OSICmdletBase

Dim instance As GetAFSecurity

[CmdletAttribute(L"Get", L"AFSecurity", SupportsShouldProcess = true)]
public ref class GetAFSecurity : public OSICmdletBase

[<CmdletAttribute("Get", "AFSecurity", SupportsShouldProcess = true)>]
type GetAFSecurity =  
    class
        inherit OSICmdletBase
    end

The GetAFSecurity type exposes the following members.

Constructors

	Name	Description
	GetAFSecurity

Properties

	Name	Description
	AFObject	The AF Object for which to return AF Security
	AFSecurityItem	The AF Security Item of the desired AF Security information to be returned

Examples

Get-AFSecurity -AFObject $afDB

Where:

$afDB = Get-AFDatabase "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

Gets the AF Security entry for the AF Database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFSecurity -AFObject $afElement

Where:

$afElement = Get-AFElement -Name "Production Line 1" -AFDatabase (Get-AFDatabase -Name "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1"))

Gets the AF Security entry for the AF Element "Production Line 1" on the AF Database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFSecurity -AFSecurityItem Element -AFObject $afDB

Where:

$afDB = Get-AFDatabase "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1")

Gets the AF Security entry for the Elements collection on the AF Database "AFDatabase1" on the AF Server "PIAF1".

PI Powershell