PI Powershell

GetAFAttribute Class

Save PDF

TABLE OF CONTENTS

GetAFAttribute Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get an AF Attribute

The Get-AFAttribute cmdlet gets an existing AF Attribute.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetAFAttribute

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

Syntax

[CmdletAttribute("Get", "AFAttribute", DefaultParameterSetName = "ElementName", 
	SupportsShouldProcess = true)]
public class GetAFAttribute : OSICmdletBase

<CmdletAttribute("Get", "AFAttribute", DefaultParameterSetName := "ElementName", 
	SupportsShouldProcess := true)>
Public Class GetAFAttribute
	Inherits OSICmdletBase

Dim instance As GetAFAttribute

[CmdletAttribute(L"Get", L"AFAttribute", DefaultParameterSetName = L"ElementName", 
	SupportsShouldProcess = true)]
public ref class GetAFAttribute : public OSICmdletBase

[<CmdletAttribute("Get", "AFAttribute", DefaultParameterSetName = "ElementName", 
	SupportsShouldProcess = true)>]
type GetAFAttribute =  
    class
        inherit OSICmdletBase
    end

The GetAFAttribute type exposes the following members.

Constructors

	Name	Description
	GetAFAttribute

Properties

	Name	Description
	AFAttribute	Parent AF Attribute of the AF Attribute to get
	AFElement	AF Element containing the AF Attribute to get
	ID	ID of AF Attribute to get
	Index	Index of AF Attribute to get
	Name	Name of the AF Attribute to get
	Refresh	Refresh the container before accessing

Examples

Get-AFAttribute -Name "Interior Temperature" -AFElement $afElement

Where:

$afElement = Get-AFElement -Name "Anneal Oven 1" -AFDatabase (Get-AFDatabase -Name "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1"))

$afAttribute = Get-AFAttribute -Name "Inner Temperature" -AFElement $afElement

Gets the AF Attribute "Inner Temperature" on the top level element "Anneal Oven 1" on the database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFAttribute -Name "Celsius" -AFAttribute $afAttribute

Where:

$afElement = Get-AFElement -Name "Anneal Oven 1" -AFDatabase (Get-AFDatabase -Name "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1"))

$afAttribute = Get-AFAttribute -Name "Inner Temperature" -AFElement $afElement

Gets the child AF Attribute "Celsius" of the AF Attribute "Inner Temperature" on the top level element "Anneal Oven 1" on the database "AFDatabase1" on the AF Server "PIAF1".

Examples

Get-AFAttribute -Name * -AFElement $afElement

Where:

$afElement = Get-AFElement -Name "Anneal Oven 1" -AFDatabase (Get-AFDatabase -Name "AFDatabase1" -AFServer (Get-AFServer -Name "PIAF1"))

Gets all AF Attributes on the top level element "Anneal Oven 1" on the database "AFDatabase1" on the AF Server "PIAF1".

PI Powershell