GetPIArchiveSetSettings Class
- Last UpdatedDec 15, 2025
- 3 minute read
Gets the archive set configuration from a PI Data Archive
The Get-PIArchiveSetSettings cmdlet gets detailed PI Archive set configuration information on a PI Data Archive.
Get-PIArchiveSetSettings can be used to get configuration settings for a specific archive set by name, or default set if name omitted.
The connection parameter specifies which connection to a PI Data Archive to use.
Inheritance Hierarchy
InternalCommand
Cmdlet
PSCmdlet
OSIsoft.PowerShellOSICmdletBase
OSIsoft.PowerShellOSICmdletBaseWithConnection
OSIsoft.PowerShellGetPIArchiveSetSettings
Namespace: OSIsoft.PowerShell
Assembly: OSIsoft.PowerShell (in OSIsoft.PowerShell.dll) Version: 3.1.1.0 (3.1.1.466)
Syntax
[CmdletAttribute("Get", "PIArchiveSetSettings", SupportsShouldProcess = true)] public class GetPIArchiveSetSettings : OSICmdletBaseWithConnection
<CmdletAttribute("Get", "PIArchiveSetSettings", SupportsShouldProcess := true)> Public Class GetPIArchiveSetSettings Inherits OSICmdletBaseWithConnection Dim instance As GetPIArchiveSetSettings
[CmdletAttribute(L"Get", L"PIArchiveSetSettings", SupportsShouldProcess = true)] public ref class GetPIArchiveSetSettings : public OSICmdletBaseWithConnection
[<CmdletAttribute("Get", "PIArchiveSetSettings", SupportsShouldProcess = true)>] type GetPIArchiveSetSettings = class inherit OSICmdletBaseWithConnection end
The GetPIArchiveSetSettings type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | GetPIArchiveSetSettings |
Properties
| Name | Description | |
|---|---|---|
 | Connection | Specifies the connection to a PI Data Archive to use |
| Name | Specifies the name of the archive file for which to get detailed information |
Examples
Get-PIArchiveSetSettings $con
Where:
$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"
Get the PI Archive set configuration settings for the default archive set.
Examples
Get-PIArchiveSetSettings -Name "0_Historical" -Connection (Connect-PIDataArchive -PIDataArchiveMachineName PISRV1)Get the PI Archive set configuration settings for the archive set (Historical) on the "PISRV1" PI Data Archive server.