SetPIGroup Class
- Last UpdatedDec 15, 2025
- 3 minute read
Edits an existing PI Group on a PI Data Archive
The Set-PIGroup cmdlet will edit the description of an existing PI Group on a PI Data Archive. To rename a PI Group, use Rename-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
InternalCommand
Cmdlet
PSCmdlet
OSIsoft.PowerShellOSICmdletBase
OSIsoft.PowerShellOSICmdletBaseWithConnection
OSIsoft.PowerShellSetPIGroup
Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)
Syntax
[CmdletAttribute("Set", "PIGroup", SupportsShouldProcess = true)] public class SetPIGroup : OSICmdletBaseWithConnection
<CmdletAttribute("Set", "PIGroup", SupportsShouldProcess := true)> Public Class SetPIGroup Inherits OSICmdletBaseWithConnection Dim instance As SetPIGroup
[CmdletAttribute(L"Set", L"PIGroup", SupportsShouldProcess = true)] public ref class SetPIGroup : public OSICmdletBaseWithConnection
[<CmdletAttribute("Set", "PIGroup", SupportsShouldProcess = true)>] type SetPIGroup = class inherit OSICmdletBaseWithConnection end
The SetPIGroup type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SetPIGroup |
Properties
| Name | Description | |
|---|---|---|
 | Connection | Connection to a PI Data Archive for which to edit the PI Group |
| Description | Description to set on the PI Group |
| Name | Name of the PI Group to edit |
Examples
Set-PIGroup -Name "PIEngineersGroup" -Description "PI Group for all floor engineers" -Connection $con
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
This example edits the description on an existing PI Group "PIEngineersGroup" on the "PISRV1" PI Data Archive.