PI Powershell

AddPICollectiveMember Class

Save PDF

TABLE OF CONTENTS

AddPICollectiveMember Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

Add a PI Data Archive to an existing PI Data Archive Collective

The Add-PICollectiveMember cmdlet adds a PI Data Archive as a secondary member to an existing PI Data Archive Collective. For PI Data Archive Collectives version 2017 and later, the member's public certificate must also be added. See KB01564 for more information.

The PICollective parameter specifies which PI Collective to add the specified PI Data Archive to a a secondary member.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellAddPICollectiveMember

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

Syntax

[CmdletAttribute("Add", "PICollectiveMember", SupportsShouldProcess = true)]
public class AddPICollectiveMember : OSICmdletBase

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

Dim instance As AddPICollectiveMember

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

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

The AddPICollectiveMember type exposes the following members.

Constructors

	Name	Description
	AddPICollectiveMember

Properties

	Name	Description
	Name	Name of PI Data Archive to add to the PI Data Archive Collective
	PICollective	PI Collective for which to add the PI Collective Member
	PublicCertificate	Public certificate signature of the PI Collective Member to add. This is only required to add a member to a PI Data Archive 2017 or later collective.

Examples

Add-PICollectiveMember -Name "PISRV3" -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Adds the PI Data Archive "PISRV3" to the PI Data Archive collective which the "PISRV1" PI Data Archive server is a part of. This example should be referenced for PI Data Archive versions 2016R2 or earlier.

Examples

Add-PICollectiveMember -Name "PISRV3" -PublicCertificate $cert -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

$cert = ( Get-ChildItem -Path 'Cert:\LocalMachine\OSIsoft LLC Certificates' )

Adds the PI Data Archive "PISRV3" to the PI Data Archive 2017 collective which the "PISRV1" PI Data Archive server is a part of. This example should be referenced for PI Data Archive versions 2017 or later.

Note that the self-signed certificate found at the path in the example should have been created upon installation of PI Data Archive 2017 or later. For more information regarding PI Data Archive 2017 certificates and troubleshooting, see KB01564 and KB00800

PI Powershell