PI Powershell

GetPIDigitalStateSet Class

Save PDF

TABLE OF CONTENTS

GetPIDigitalStateSet Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Get a PI Digital State Set

The Get-PIDigitalStateSet cmdlet gets a PI Digital State Set from a PI Data Archive.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellGetPIDigitalStateSet

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

Syntax

[CmdletAttribute("Get", "PIDigitalStateSet", DefaultParameterSetName = "ByName", 
	SupportsShouldProcess = true)]
public class GetPIDigitalStateSet : OSICmdletBaseWithConnection

<CmdletAttribute("Get", "PIDigitalStateSet", DefaultParameterSetName := "ByName", 
	SupportsShouldProcess := true)>
Public Class GetPIDigitalStateSet
	Inherits OSICmdletBaseWithConnection

Dim instance As GetPIDigitalStateSet

[CmdletAttribute(L"Get", L"PIDigitalStateSet", DefaultParameterSetName = L"ByName", 
	SupportsShouldProcess = true)]
public ref class GetPIDigitalStateSet : public OSICmdletBaseWithConnection

[<CmdletAttribute("Get", "PIDigitalStateSet", DefaultParameterSetName = "ByName", 
	SupportsShouldProcess = true)>]
type GetPIDigitalStateSet =  
    class
        inherit OSICmdletBaseWithConnection
    end

The GetPIDigitalStateSet type exposes the following members.

Constructors

	Name	Description
	GetPIDigitalStateSet

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to get the PI Digital State Set (Overrides OSICmdletBaseWithConnectionConnection.)
	Id	ID of the PI Digital State Set to get
	Name	Name of the PI Digital State Set to get

Examples

Get-PIDigitalStateSet -Name "SYSTEM" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the "SYSTEM" digital state set from the "PISRV1" PI Data Archive.

Examples

(Get-PIDigitalStateSet -Name "SYSTEM" -Connection $con).ID

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the ID for the "SYSTEM" digital state set from the "PISRV1" PI Data Archive. Note that the SYSTEM digital state set will always be ID = 0.

Examples

Get-PIDigitalStateSet -ID 47 -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Gets the digital state set of ID 47 from the "PISRV1" PI Data Archive.

PI Powershell