PI Powershell

GetPIFirewall Class

Save PDF

GetPIFirewall Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

GetPIFirewall Class

Get an entry in the PI Firewall Table

The Get-PIFirewall cmdlet gets existing entries in the PI Firewall table. If no name is specified, all PI Firewall entries are returned.

The connection parameter specifies which connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellGetPIFirewall

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

Syntax

[CmdletAttribute("Get", "PIFirewall", SupportsShouldProcess = true)]
public class GetPIFirewall : OSICmdletBase

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

Dim instance As GetPIFirewall

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

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

The GetPIFirewall type exposes the following members.

Constructors

	Name	Description
	GetPIFirewall

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to get the PI Firewall entry
	Hostmask	Hostmask of the PI Firewall entry to get

Examples

Get-PIFirewall -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all entries in the PI Firewall table from the "PISRV1" PI Data Archive server.

Examples

Get-PIFirewall -Hostmask "192.168.0.56" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the entry in the PI Firewall table for the hostmask 192.168.0.56 from the "PISRV1" PI Data Archive server.

Examples

Get-PIFirewall -Connection $con | Where-Object -Property Access -eq "Disallow"

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all disallowed entries in the PI Firwall table from the "PISRV1" PI Data Archive server.

PI Powershell