PI Powershell

RenamePIGroup Class

Save PDF

TABLE OF CONTENTS

RenamePIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

RenamePIGroup Class

Renames an existing PI Group on a PI Data Archive

The Rename-PIGroup cmdlet renames an existing PI Group from a PI Data Archive. To edit a PI Group description, use Set-PIGroup.

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

NOTE: PI Users and PI Groups have been replaced by PI Identities. PI Identities with PI Mappings (WIS) and PI Trusts should be used to configure PI Data Archive security. See KB00833 for more information.

Inheritance Hierarchy

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

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

Syntax

[CmdletAttribute("Rename", "PIGroup", SupportsShouldProcess = true)]
public class RenamePIGroup : OSICmdletBaseWithConnection

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

Dim instance As RenamePIGroup

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

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

The RenamePIGroup type exposes the following members.

Constructors

	Name	Description
	RenamePIGroup

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to rename the PI Group (Overrides OSICmdletBaseWithConnectionConnection.)
	ExistingName	Existing name of the PI Group to rename
	NewName	New name to set on the PI Group

Examples

Rename-PIGroup -ExistingName "PIEngineersGroup" -NewName "FloorEngineersGroup" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example renames an existing PI Group "PIEngineersGroup" to "FloorEngineersGroup" on the "PISRV1" PI Data Archive.

PI Powershell