PI Powershell

SetPICollective Class

Save PDF

TABLE OF CONTENTS

SetPICollective Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Edit name, description, or ID of a PI Data Archive Collective

The Set-PICollective cmdlet can be used to set a new name, description or ID on an existing PI Data Archive Collective.

The PICollective parameter specifies which PI Data Archive Collective to edit.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellSetPICollective

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

Syntax

[CmdletAttribute("Set", "PICollective", SupportsShouldProcess = true)]
public class SetPICollective : OSICmdletBase

<CmdletAttribute("Set", "PICollective", SupportsShouldProcess := true)>
Public Class SetPICollective
	Inherits OSICmdletBase

Dim instance As SetPICollective

[CmdletAttribute(L"Set", L"PICollective", SupportsShouldProcess = true)]
public ref class SetPICollective : public OSICmdletBase

[<CmdletAttribute("Set", "PICollective", SupportsShouldProcess = true)>]
type SetPICollective =  
    class
        inherit OSICmdletBase
    end

The SetPICollective type exposes the following members.

Constructors

	Name	Description
	SetPICollective

Properties

	Name	Description
	Description	Description to set on the PI Data Archive Collective
	Id	Collective ID to set on the PI Data Archive Collective
	NewName	New name to set on the PI Data Archive Collective
	PICollective	PI Data Archive Collective to edit

Examples

Set-PICollective -NewName "Renamed-Collective" -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Renames the PI Data Archive Collective which "PISRV1" is a member to "Renamed-Collective".

Examples

Set-PICollective -NewName "Renamed-Collective" -Description "New corporate PI Collective" -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Renames the PI Data Archive Collective which "PISRV1" is a member to "Renamed-Collective" and edits the description to "New corporate PI Collective".

PI Powershell