Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Powershell

GetPIDatabaseSecurity Class

  • Last UpdatedDec 15, 2025
  • 3 minute read
GetPIDatabaseSecurity Class

Get PI Database Security entries for the PI Data Archive

The Get-PIDatabaseSecurity cmdlet gets the database security settings for a PI Data Archive. If no name is specified, all 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.PowerShellGetPIDatabaseSecurity

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

Syntax

[CmdletAttribute("Get", "PIDatabaseSecurity", SupportsShouldProcess = true)]
public class GetPIDatabaseSecurity : OSICmdletBase
<CmdletAttribute("Get", "PIDatabaseSecurity", SupportsShouldProcess := true)>
Public Class GetPIDatabaseSecurity
	Inherits OSICmdletBase

Dim instance As GetPIDatabaseSecurity
[CmdletAttribute(L"Get", L"PIDatabaseSecurity", SupportsShouldProcess = true)]
public ref class GetPIDatabaseSecurity : public OSICmdletBase
[<CmdletAttribute("Get", "PIDatabaseSecurity", SupportsShouldProcess = true)>]
type GetPIDatabaseSecurity =  
    class
        inherit OSICmdletBase
    end

The GetPIDatabaseSecurity type exposes the following members.

Constructors

  NameDescription
Public method
GetPIDatabaseSecurity

Properties

  NameDescription
Public property
Connection

Connection to a PI Data Archive for which to get the PI Firewall entry

Public property
Name

Name of the PI Database Security entry to get

Examples

Get-PIDatabaseSecurity -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets all entries of PI database security from the "PISRV1" PI Data Archive server.

Examples

Get-PIDatabaseSecurity -Name PIPoint -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the database security for the PIPoint table from the "PISRV1" PI Data Archive server.

See Also

TitleResults for “How to create a CRG?”Also Available in