Command line variables

AFACKNOWLEDGEBACKUP

AFACKNOWLEDGEBACKUP=

• 0: (Default) Set to 0 to take a backup of the PI AF SQL Server database.

• 1: Set to 1 to prevent a backup of the PI AF SQL Server database.

Specifies whether to back up the existing PI AF SQL Server database before the database is upgraded. Applies to upgrades only.

AFBACKUPFILE

AFBACKUPFILE=fullpathname

Specifies the full path (directory + filename) for your PI AF SQL Server database backup on your SQL Server machine.

If this parameter is not specified, the backup file is written to a file name with the format PIAFSqlBackup_yyyy_MM_dd_hh_mm_ss.bak under the backup directory corresponding the SQL Server instance. For example: C:\Program Files (x86)\Microsoft SQL Server\MSSQL10_50.SQLEXPRESS\MSSQL\Backup\PIAFSqlBackup_2017_08_02_18_28_53.bak.

AFCLIENT_SHUTDOWN_OPTIONS

AFCLIENT_SHUTDOWN_OPTIONS=

• 1: Enables an automatic shutdown and killing the service(s) if unresponsive.

• 2: Disables automatic shutdown.

• 0: Enables an automatic shutdown but disable the ability to kill unresponsive service(s).

The default behavior is to shut down and restart processes that have the Osisoft.AFSDK.dll file in use to prevent user from having to restart the host machine at end of the setup. Specify AFCLIENT_SHUTDOWN_OPTIONS=2 to prevent processes from being automatically shut down.

AFSERVER

AFSERVER=NetworkPath

For example, the network path can simply be the computer name of the AF Server or it can be a fully qualified domain name (FQDN). For example: computername.companyname.com.

Specifies the default PI AF server name (the computer where the PI AF Application Service resides) for the client.

If a value is not defined by the user and the PI AF Application Service is not resident on the target installation computer, the default PI AF server name is not set during the installation. If not set, the default PI AF server name can be set manually after the installation has completed.

The AFSERVER variable has no effect on an upgrade.

AFSERVICEACCOUNT

AFSERVICEACCOUNT=account

(Default) AFSERVICEACCOUNT=NT SERVICE\AFService

Specifies the account name for the PI AF Application Service.

AFSERVICEPASSWORD

AFSERVICEPASSWORD=password

Specifies the account password for the PI AF Application Service.

FDREMOTEAPPS

On an PI AF SQL Server database computer, this field specifies the account that will be added to the AFServers group so that a remote PI AF Application Service has the appropriate permissions to connect to the PI AF SQL Server database. This variable is applicable only if you are installing the AF SQL scripts on a separate computer from the PI AF Application Service.

• If the PI AF Application Service is running under a domain account, enter the domain and account name under which the PI AF Application Service is running. For example: FDREMOTEAPPS=DOMAIN\accountname

• If the PI AF Application Service is running under Network Service or the virtual account " NT SERVICE\AFService", enter the domain and name of the computer where PI AF Application Service is running. For example: FDREMOTEAPPS= DOMAIN\MachineName

• If the PI AF Application Services is running under a local account, or you are unsure of the account under which the PI AF Application Service is running, leave the field blank and update the AFServers group with the appropriate membership after the installation is complete.

FDSQLDBNAME

FDSQLDBNAME=name Name

(Default) FDSQLDBNAME=PIFD

Specifies the name of the PI AF SQL Server database.

FDSQLDBSERVER

FDSQLDBSERVER=

• A named instance: Server Name\Named Instance or \Named Instance

• An SQL Express named instance: Server Name\SQLEXPRESS or Server Name\SQLEXPRESS

Specifies the SQL Server hosting PI AF SQL Server database.

FDSQLDBVALIDATE

FDSQLDBVALIDATE=

• 0: Disables validation of PI AF SQL Server database.

• 1: (Default) Enables validation of the PI AF SQL Server database.

Specifies whether or not the SQL Server connection and PI AF SQL Server database version are validated. If the FD_SQLScriptExecution feature is selected, database validation cannot be suppressed.

NOPISDKBUFFERING

NOPISDKBUFFERING=

• 0: Enables buffering.

• 1: Disables buffering.

Enables or disables PI SDK buffering. This parameter takes effect only if the PI Software Development Kit (PISDK) is installed. If the NOPISDKBUFFERING flag is not specified, the default is to not change the existing buffering configuration for the PISDK.

PIANALYSIS_AUTOSTARTSERVICE

PIANALYSIS_AUTOSTARTSERVICE=

• 0: Do not start service after installation is complete.

• 1: (Default) Start service after installation is complete.

Specifies whether to start the Analysis service immediately after an installation. This variable does not affect the service startup type, which is always set to automatic. This means that the service will still get started after the first reboot. For upgrades, this variable takes effect only if you stop the service before the upgrade.

PIANALYSIS_SERVICEACCOUNT

PIANALYSIS_SERVICEACCOUNT=account

(Default) PIANALYSIS_SERVICEACCOUNT=NT Service\PIAnalysisManager

Specifies the service account for PI Analysis Service. For new installations, one must specify a domain account if the AF Server is remote from PI Analysis Service. For upgrades, this variable is typically not needed.

PIANALYSIS_SERVICEPASSWORD

PIANALYSIS_SERVICEPASSWORD=password

Specifies the service account password for PI Analysis Service.

PIHOME

PIHOME=directory

By default, the value is \program files(x86)\pipc

Specifies the folder defined by the PIHOME environment variable and is the directory in which most 32-bit client applications are installed.

PIHOME64

PIHOME64=directory

By default, the value is \program files\pipc

Specifies the folder defined by the PIHOME64 environment variable and is the directory in which most 64-bit applications are installed.

PINOTIFICATIONS_AUTOSTARTSERVICE

PINOTIFICATIONS_AUTOSTARTSERVICE=

• 0: Do not start service after installation is complete.

• 1: (Default) Start service after installation is complete.

Specifies whether to start the Notifications service immediately after an installation. This variable does not affect the service startup type, which is always set to automatic. This means that the service will still get started after the first reboot. For upgrades, this variable takes effect only if you stop the service before the upgrade.

PINOTIFICATIONS_BACKUPSMTPSERVER

PINOTIFICATIONS_BACKUPSMTPSERVER=NetworkPath

Where NetworkPath is the computer name of the backup SMTP server or the fully qualified domain name (FQDN). For example: Computername.CompanyName.com.

Specifies the computer hosting your backup SMTP server for PI Notifications Service.

PINOTIFICATIONS_BACKUPSMTPSERVERPORT

PINOTIFICATIONS_BACKUPSMTPSERVERPORT=port

(Default) PINOTIFICATIONS_BACKUPSMTPSERVERPORT=25

Specifies the port number for the backup SMTP server.

PINOTIFICATIONS_BACKUPSMTPSERVERUSESSL

PINOTIFICATIONS_BACKUPSMTPSERVERUSESSL=[TRUE|FALSE]

(Default) PINOTIFICATIONS_BACKUPSMTPSERVERUSESSL=FALSE

Species whether or not to use SSL (Secure Sockets Layer) for communicating between PI Notifications Service and the backup SMTP server.

PINOTIFICATIONS_CORESIGHTSERVER

PINOTIFICATIONS_CORESIGHTSERVER=URL

Specifies the computer hosting your PI Vision server to integrate with PI Notifications Service.

PINOTIFICATIONS_FROMEMAIL

PINOTIFICATIONS_FROMEMAIL=emailaddress

Specifies the email address to associate with notifications emails for PI Notifications Service.

PINOTIFICATIONS_SERVICEACCOUNT

PINOTIFICATIONS_SERVICEACCOUNT=account

(Default) PINOTIFICATIONS_SERVICEACCOUNT=NT SERVICE\PINotificationsService

Specifies the service account for PI Notifications Service. For new installations, you must specify a domain account if the AF Server is remote from PI Notifications Service. For upgrades, this variable is typically not needed.

PINOTIFICATIONS_SERVICEPASSWORD

PINOTIFICATIONS_SERVICEPASSWORD=password

Specifies the service account password for PI Notifications Service.

PINOTIFICATIONS_SMTPSERVER

PINOTIFICATIONS_SMTPSERVER=NetworkPath

Where NetworkPath can simply be the computer name of the SMPT server or it can be a fully qualified domain name (FQDN). For example: ComputerName.Companyname.com.

Specifies the computer hosting your primary SMTP server for PI Notifications Service.

PINOTIFICATIONS_SMTPSERVERPORT

PINOTIFICATIONS_SMTPSERVERPORT=port

(Default) PINOTIFICATIONS_SMTPSERVERPORT=25

Specifies the port number for the primary SMTP server.

PINOTIFICATIONS_SMTPSERVERUSESSL

PINOTIFICATIONS_SMTPSERVERUSESSL=FALSE

(Default) PINOTIFICATIONS_SMTPSERVERUSESSL=FALSE

Species whether or not to use SSL (Secure Sockets Layer) for communicating between PI Notifications Service and the primary SMTP server.

PISERVER

PISERVER=ComputerName or PISERVER=FQDN

Where FQDN is the fully qualified domain name. For example, ComputerName.Companyname.com

Specifies the computer hosting your PI Data Archive. When you are not installing the PI Data Archive as part of the installation, use this variable to define the default PI Data Archive server.

PISQLDAS_REMOTEAPPS

PISQLDAS_REMOTEAPPS=account|YourAFServer

On an PI AF SQL Server database computer, this field specifies the account that will be added to the AFQueryEngines group so that a remote PI SQL Data Access Server (RTQP Engine) service has the appropriate permissions to connect to the PI AF SQL Server database. This variable is applicable only if you are installing the AF SQL scripts on a separate computer from the PI SQL Data Access Server (RTQP Engine) service.

• If the PI SQL Data Access Server (RTQP Engine) service is running under a domain account, enter the domain and account name under which the PI SQL Data Access Server (RTQP Engine) service is running. For example: PISQLDAS_REMOTEAPPS=DOMAIN\accountname

PI_AUTOARCHIVEROOT

PI_AUTOARCHIVEROOT=

The default archives will automatically be created with a root name corresponding to the computer name where the PI Data Archive is installed. Specify PI_AUTOARCHIVEROOT=name to change the root name for PI Data Archives that are created.

This parameter applies only to new installations of PI Data Archive.

PI_AUTOCREATEARCHIVES

PI_AUTOCREATEARCHIVES=

• 0

• 1: (Default)

Specifies whether to enable or disable automatic creation of historical archive files for your PI Data Archive.

If you disable automatic archive creation with PI_AUTOCREATEARCHIVES=0, then you can use PI_NUMARCHIVES=number to specify the number of archives to create for a new installation.

This parameter applies only to new installations of PI Data Archive.

PI_ARCHIVEDATDIR

PI_ARCHIVEDATDIR=directory

Specifies the directory path to store historical archives for your PI Data Archive installation.

PI_ARCHIVESIZE

PI_ARCHIVESIZE=value

Specifies the size (in MB) for historical archive files for your PI Data Archive. The default historical archive size is roughly 1/3 of physical memory, up to a max of 10,240 MB.

PI_BACKUPDIR

PI_BACKUPDIR=directory

Specifies the directory path to backup your PI Data Archive.

PI_DEFAULTPTS

PI_DEFAULTPTS=value

Specifies the maximum point count from the license file for your PI Data Archive.

PI_EVENTQUEUEDIR

PI_EVENTQUEUEDIR=directory

Specifies the directory path to store the event queue files for your PI Data Archive.

PI_EXPLICITLOGINS

PI_EXPLICITLOGINS=

For new installations, explicit logins to PI Data Archive are disabled by default. Specify PI_EXPLICITLOGINS=1 to enable explicit logins.

Note: we do not recommend using explicit logins for authentication for your PI Data Archive unless your deployment cannot support Windows Integrated Security or PI Trusts.

PI_EXPLICITLOGINSNOPASSWORD

PI_EXPLICITLOGINSNOPASSWORD=

For new installations, legacy explicit logins to PI Data Archive are disabled by default for PI Users with blank passwords. Specify PI_EXPLICITLOGINS=1 and PI_EXPLICITLOGINSNOPASSWORD=1 to enable explicit logins with blank passwords.

Note: we do not recommend using blank passwords.

Note: we do not recommend using explicit logins for authentication for your PI Data Archive unless your deployment cannot support Windows Integrated Security or PI Trusts.

PI_EXPLICITLOGINSPIADMIN

PI_EXPLICITLOGINSPIADMIN=

For new installations, legacy explicit logins to PI Data Archive are disabled by default for the piadmin PI User account. Specify PI_EXPLICITLOGINSPIADMIN=1 to enable explicit logins with the piadmin account.

Note: we do not recommend using piadmin with explicit login. We do not recommend using explicit logins for authentication for your PI Data Archive unless your deployment cannot support Windows Integrated Security or PI Trusts.

PI_FUTUREARCHIVEDATDIR

PI_FUTUREARCHIVEDATDIR=directory

Specifies the directory path to store the future archive files for your PI Data Archive.

The PI_FUTUREARCHIVEDATDIR variable applies only new installations and to upgrades from versions earlier than PI Data Archive 2015.

PI_INSTALLDIR

PI_INSTALLDIR=directory

Specifies the directory path to install your PI Data Archive.

PI_LICDIR

PI_LICDIR=directory

Specifies the directory path for the license file to use for your PI Data Archive. By default, PI_LICDIR is the directory that corresponds to where PI Server_2018 SP3_.exe is run. For a new silent installation, you can put pilicense.dat in the same directory as the install kit so that PI_LICDIR does not need to be specified.

PI_NOBACKUP

PI_NOBACKUP=

To suppress the minimum backup that occurs while upgrading PI Data Archive, specify PI_NOBACKUP=1.

PI_NUMARCHIVES

PI_NUMARCHIVES=value

Specifies the number of fixed archives to create for a new installation. The default is 3.

You must specify PI_AUTOCREATEARCHIVES=0 in order for PI_NUMARCHIVES variable to take effect.

PI_PIADMINPASSWORD

PI_PIADMINPASSWORD=

Specifies that password for the piadmin account. A piadmin password only needs to be specified if explicit logins for the piadmin account is enabled with the PI_EXPLICITLOGINSPIADMIN variable.

Note: we do not recommend using explicit logins for authentication for your PI Data Archive unless your deployment cannot support Windows Integrated Security or PI Trusts.

SENDTELEMETRY

SENDTELEMETRY=

• 0: Do not start service after installation is complete.

• 1: (Default) Start service after installation is complete.

Specifies whether to participate in the Customer Experience Improvement Program.