PI Powershell

RenamePIDigitalStateSet Class

Save PDF

TABLE OF CONTENTS

RenamePIDigitalStateSet Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Rename a PI Digital State Set on a PI Data Archive

The Rename-PIDigitalStateSet cmdlet renames a PI Digital State Set on 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.PowerShellRenamePIDigitalStateSet

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

Syntax

[CmdletAttribute("Rename", "PIDigitalStateSet", SupportsShouldProcess = true)]
public class RenamePIDigitalStateSet : OSICmdletBaseWithConnection

<CmdletAttribute("Rename", "PIDigitalStateSet", SupportsShouldProcess := true)>
Public Class RenamePIDigitalStateSet
	Inherits OSICmdletBaseWithConnection

Dim instance As RenamePIDigitalStateSet

[CmdletAttribute(L"Rename", L"PIDigitalStateSet", SupportsShouldProcess = true)]
public ref class RenamePIDigitalStateSet : public OSICmdletBaseWithConnection

[<CmdletAttribute("Rename", "PIDigitalStateSet", SupportsShouldProcess = true)>]
type RenamePIDigitalStateSet =  
    class
        inherit OSICmdletBaseWithConnection
    end

The RenamePIDigitalStateSet type exposes the following members.

Constructors

	Name	Description
	RenamePIDigitalStateSet

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to rename the PI Digital State Set (Overrides OSICmdletBaseWithConnectionConnection.)
	ExistingName	Name of the PI Digital State Set to rename
	NewName	New name to apply to the PI Digital State Set

Examples

Rename-PIDigitalStateSet -ExistingName "BoilerState" -NewName "BoilerXState" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example renames the PI Digital State Set "BoilerState" to "BoilerXState" on the "PISRV1" PI Data Archive.

PI Powershell