NewPICollective Class
- Last UpdatedDec 15, 2025
- 4 minute read
Create a new PI Data Archive Collective information from a PI Data Archive
The New-PICollective cmdlet creates a PI DA Collective with the PI Data Archive specified by the -Connection parameter as the primary and the machines specified by -Secondaries as the secondary members. If secondary members are specified, note that this cmdlet does not initialize the secondary members automatically. Once the collective is formed, a backup of the primary needs to be taken and restored to the secondary members to initialize them manually.
The connection parameter specifies which connection to a PI Data Archive to use as the primary member.
Inheritance Hierarchy
InternalCommand
Cmdlet
PSCmdlet
OSIsoft.PowerShellOSICmdletBase
OSIsoft.PowerShellOSICmdletBaseWithConnection
OSIsoft.PowerShellNewPICollective
Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)
Syntax
[CmdletAttribute("New", "PICollective", SupportsShouldProcess = true)] public class NewPICollective : OSICmdletBaseWithConnection
<CmdletAttribute("New", "PICollective", SupportsShouldProcess := true)> Public Class NewPICollective Inherits OSICmdletBaseWithConnection Dim instance As NewPICollective
[CmdletAttribute(L"New", L"PICollective", SupportsShouldProcess = true)] public ref class NewPICollective : public OSICmdletBaseWithConnection
[<CmdletAttribute("New", "PICollective", SupportsShouldProcess = true)>] type NewPICollective = class inherit OSICmdletBaseWithConnection end
The NewPICollective type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | NewPICollective |
Properties
| Name | Description | |
|---|---|---|
 | Connection | Connection to a PI Data Archive from which to use as the primary member of the new PI Data Archive Collective. |
| Description | Description to use for the new PI Data Archive Collective |
| Id | Collective unique ID. This does not need to be the same ID as the primary member. |
| Name | Name to use for the new PI Data Archive Collective. Note that this does not need to be the same name as the primary member. |
| Secondaries | PI Data Archive machine names to be added as secondary collective members. Note that this cmdlet does not automatically initialize each secondary member. This still must be done manually by taking a backup of the primary PI Data Archive once the collective is formed, and restoring the backup on each secondary member. |
Examples
New-PICollective -Name PI-Collective -Description "Corporate PI Collective" -Secondaries "PISRV2" -Connection $con
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
The example creates a new PI Data Archive Collective with the "PISRV1" PI Data Archive server as the primary member, and "PISRV2" as the only secondary member.
Note that this cmdlet does not automatically initialize each secondary member. This still must be done manually by taking a backup of the primary PI Data Archive once the collective is formed, and restoring the backup on each secondary member.
Examples
New-PICollective -Name PI-Collective -Description "Corporate PI Collective" -Secondaries "PISRV2","PISRV3" -Connection $con
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
The example creates a new PI Data Archive Collective with the "PISRV1" PI Data Archive server as the primary member, with "PISRV2" and "PISRV3" as the secondary members.
Note that this cmdlet does not automatically initialize each secondary member. This still must be done manually by taking a backup of the primary PI Data Archive once the collective is formed, and restoring the backup on each secondary member.