PI Powershell

AddPIGroup Class

Save PDF

TABLE OF CONTENTS

AddPIGroup Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

AddPIGroup Class

Add a new PI Group to a PI Data Archive

The Add-PIGroup cmdlet adds a new PI Group on 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.PowerShellAddPIGroup

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

Syntax

[CmdletAttribute("Add", "PIGroup", SupportsShouldProcess = true)]
public class AddPIGroup : OSICmdletBase

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

Dim instance As AddPIGroup

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

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

The AddPIGroup type exposes the following members.

Constructors

	Name	Description
	AddPIGroup

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to add the PI Group
	Description	Description of the PI Group to add
	Name	Name of the PI Group to add

Examples

Add-PIGroup -Name "PIEngineersGroup" -Description "All Floor Engineers" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

This example adds a new PI Group "PIEngineersGroup" with a description to the "PISRV1" PI Data Archive.

PI Powershell