PI Powershell

RemovePIGroup Class

Save PDF

TABLE OF CONTENTS

RemovePIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

RemovePIGroup Class

Removes an existing PI Group on a PI Data Archive

The Remove-PIGroup cmdlet removes an existing PI Group from a PI Data Archive

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.PowerShellRemovePIGroup

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

Syntax

[CmdletAttribute("Remove", "PIGroup", SupportsShouldProcess = true)]
public class RemovePIGroup : OSICmdletBase

<CmdletAttribute("Remove", "PIGroup", SupportsShouldProcess := true)>
Public Class RemovePIGroup
	Inherits OSICmdletBase

Dim instance As RemovePIGroup

[CmdletAttribute(L"Remove", L"PIGroup", SupportsShouldProcess = true)]
public ref class RemovePIGroup : public OSICmdletBase

[<CmdletAttribute("Remove", "PIGroup", SupportsShouldProcess = true)>]
type RemovePIGroup =  
    class
        inherit OSICmdletBase
    end

The RemovePIGroup type exposes the following members.

Constructors

	Name	Description
	RemovePIGroup

Properties

	Name	Description
	Connection	Connection to a PI Data Archive from which to remove the PI Group
	Name	Name of the PI Group to remove

Examples

Remove-PIGroup -Name "PIEngineersGroup" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example removes an existing PI Group "PIEngineersGroup" from the "PISRV1" PI Data Archive.

PI Powershell