PI Powershell

ConnectPIDataArchive.Password Property

Save PDF

ConnectPIDataArchive.Password Property

Save PDF

Last UpdatedDec 15, 2025
2 minute read

Password for PI Username used when connecting to the PI Data Archive. Used in conjunction with PIUsername.

Note: Explicit Login has been superseded by connecting via Windows Integrated Security (WIS) or PI Trusts. It is strongly recommended to connect via these authentication methods instead of explicit login. See -AuthenticationMethod parameter for details on connecting via WIS or PI Trusts.

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

Syntax

[ParameterAttribute(Position = 2, Mandatory = false, ParameterSetName = "MachineNameViaPIUser", 
	HelpMessage = "Password for PI user")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "ConnectionConfigurationViaPIUser", 
	HelpMessage = "Password for PI user")]
[ValidateNotNullOrEmptyAttribute]
public SecureString Password { get; set; }

<ParameterAttribute(Position := 2, Mandatory := false, ParameterSetName := "MachineNameViaPIUser", 
	HelpMessage := "Password for PI user")>
<ParameterAttribute(Position := 1, Mandatory := false, ParameterSetName := "ConnectionConfigurationViaPIUser", 
	HelpMessage := "Password for PI user")>
<ValidateNotNullOrEmptyAttribute>
Public Property Password As SecureString
	Get
	Set

Dim instance As ConnectPIDataArchive
Dim value As SecureString

value = instance.Password

instance.Password = value

public:
[ParameterAttribute(Position = 2, Mandatory = false, ParameterSetName = L"MachineNameViaPIUser", 
	HelpMessage = L"Password for PI user")]
[ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = L"ConnectionConfigurationViaPIUser", 
	HelpMessage = L"Password for PI user")]
[ValidateNotNullOrEmptyAttribute]
property SecureString^ Password {
	SecureString^ get ();
	void set (SecureString^ value);
}

[<ParameterAttribute(Position = 2, Mandatory = false, ParameterSetName = "MachineNameViaPIUser", 
	HelpMessage = "Password for PI user")>]
[<ParameterAttribute(Position = 1, Mandatory = false, ParameterSetName = "ConnectionConfigurationViaPIUser", 
	HelpMessage = "Password for PI user")>]
[<ValidateNotNullOrEmptyAttribute>]
member Password : SecureString with get, set

Property Value

Type: SecureString

PI Powershell