PI Powershell

SetPICollectiveMember Class

Save PDF

SetPICollectiveMember Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

Edit the configuration of a PI Data Archive Collective Member

The Set-PICollectiveMember cmdlet can be used to edit the configuration of an existing PI Data Archive Collective member.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellSetPICollectiveMember

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

Syntax

[CmdletAttribute("Set", "PICollectiveMember", SupportsShouldProcess = true)]
public class SetPICollectiveMember : OSICmdletBase

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

Dim instance As SetPICollectiveMember

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

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

The SetPICollectiveMember type exposes the following members.

Constructors

	Name	Description
	SetPICollectiveMember

Properties

	Name	Description
	CommPeriod	Communication period to set on the PI Collective member if it is a secondary member
	Description	Description to set on the PI Collective Member
	Id	ID to set on the PI Collective Member
	Name	Name of the PI Data Archive Collective Member to edit
	Path	Network path to set on the PI Collective Member
	PICollective	PI Data Archive Collective to which the PI Collective Member to edit belongs
	PublicCert	Public certificate signature to set on the PI Collective Member to edit Note that this parameter is only used for PI Data Archive Collectives version 2017 and later.
	SyncPeriod	Synchronization period to set on the PI Collective Member if it is a secondary member

Examples

Set-PICollectiveMember -Name PISRV2 -Description "Secondary PI Collective Member" -CommPeriod "00:00:15" -SyncPeriod "00:00:10" 
                 -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Sets a new description, communication period, and synchronization period on the PI Data Archive Collective Member "PISRV2".

Examples

Set-PICollectiveMember -Name "PISRV2" -PublicCertificate $cert -PICollective (Get-PICollective -Connection $con)

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

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

Applies a new public certificate to the secondary member "PISRV2". This example should only 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