PI Powershell

RenamePITrust Class

Save PDF

TABLE OF CONTENTS

RenamePITrust Class

Save PDF

Last UpdatedDec 15, 2025
3 minute read

PI System
Powershell Tools for the PI System 2024 R2
Developer

RenamePITrust Class

Rename a PI Security Trust

The Rename-PITrust cmdlet renames an existing PI Trust

The connection parameter specifies which connection to a PI Data Archive to use.

Inheritance Hierarchy

SystemObject
  InternalCommand
    Cmdlet
      PSCmdlet
        OSIsoft.PowerShellOSICmdletBase
          OSIsoft.PowerShellOSICmdletBaseWithConnection
            OSIsoft.PowerShellRenamePITrust

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

Syntax

[CmdletAttribute("Rename", "PITrust", SupportsShouldProcess = true)]
public class RenamePITrust : OSICmdletBaseWithConnection

<CmdletAttribute("Rename", "PITrust", SupportsShouldProcess := true)>
Public Class RenamePITrust
	Inherits OSICmdletBaseWithConnection

Dim instance As RenamePITrust

[CmdletAttribute(L"Rename", L"PITrust", SupportsShouldProcess = true)]
public ref class RenamePITrust : public OSICmdletBaseWithConnection

[<CmdletAttribute("Rename", "PITrust", SupportsShouldProcess = true)>]
type RenamePITrust =  
    class
        inherit OSICmdletBaseWithConnection
    end

The RenamePITrust type exposes the following members.

Constructors

	Name	Description
	RenamePITrust

Properties

	Name	Description
	Connection	Connection to a PI Data Archive for which to rename the PI Trust (Overrides OSICmdletBaseWithConnectionConnection.)
	ExistingName	Connection to a PI Data Archive for which to get the PI Trust
	NewName	New name for the PI Trust

Examples

Rename-PITrust -ExistingName "PIINT1Trust" -NewName "PIINT1_OPCInt_IP" -Connection $con

Where:

$con = Connect-PIDataArchive -PIDataArchiveMachineName "PISRV1"

Renames the "PIINT1Trust" as "PIINT1_OPCInt_IP" on the PI Data Archive server "PISRV1"

PI Powershell