PI Powershell

RemovePICollective Class

Save PDF

TABLE OF CONTENTS

RemovePICollective Class

Save PDF

Last UpdatedDec 15, 2025
2 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Remove all members from a PI Data Archive Collective

The Remove-PICollective cmdlet removes all PI Data Archive members from an existing PI Data Archive Collective, including the primary member.

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

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellRemovePICollective

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

Syntax

[CmdletAttribute("Remove", "PICollective", SupportsShouldProcess = true)]
public class RemovePICollective : OSICmdletBase

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

Dim instance As RemovePICollective

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

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

The RemovePICollective type exposes the following members.

Constructors

	Name	Description
	RemovePICollective

Properties

	Name	Description
	PICollective	PI Data Archive Collective from which to remove all members, including the primary

Examples

Remove-PICollective -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Removes all members from the PI Data Archive Collective which "PISRV1" is a member

PI Powershell