pidiag command-line options

Option

Description

-ad [path]

Lists archive files known to Data Archive.

-adg version   path

Downgrades archive files to the specified version.

-ahd [path]

Lists information about unregistered archive files.

-ar [path]

Creates a new archive manager data file.

-ara

Recovers the archive manager data file.

-archk path  [complete]

Generates a report on an archive file.

-backup -identify backupdir

Shows a list of the backup up files in the backupdir directory.

-backup backupdir [-minspace SizeInMb] [-checkonly]

Starts an offline backup, storing files in the specified path.

Specifying -minspace checks the hard drive to see if there is the SizeInMb available before starting the backup. If there is not enough space available, the backup fails.

-backup -restore backupdir

Restores the backup from the backupdir to the Data archive installation.

-connectionhistory -u|-n|-i|-p|-r [-s start time] [-e end time] [-f path]

Data Archive stores the history of connections from clients, interfaces, and other applications on your local computer. For information about the options to use with the -connectionhistory option, see Connection history information.

-cpc [-fix]

Checks performance counters, reports any problems found, and optionally fixes certain problems.

-crash

Simulates a process crash.

-dapi [host]

Creates and displays the API server ID of the local machine or a specified host.

-did

Dumps the server ID file; used for troubleshooting PI collectives. This command works only when the server is not running. When the server is running, use Collective Manager or piconfig with the pisysdump.dif file.

-e code

Displays the message associated with an error code.

-fb path  [-header|-dv]

Displays the file base header and index. To suppress the index display, use the -header option. To show only the file version, use the -dv option.

-fbc path  [-header]

Compacts a file-base data file. To suppress the index display, use the -header option.

-fbf inpath outpath [alignment] [-compress] [-header]

Recovers the file-base data file by copying recoverable records to an output file. To remove empty records, use the -compress option. To suppress the index display, use the -header option.

-fc -query

Queries the size of the file-system cache.

-fc -reset

Resets the size of the file-system cache.

-getpipcpath

Displays the 32-bit and 64-bit PIPC home directories.

-getpipcpath -filepath filename [-32bit|-64bit]

Displays the full path of the specified file. To query only in the 32-bit PIPC home, use the -32bit option. To query only in the 64-bit PIPC home, use the -64bit option.

-gmmf mmf

Gets the performance-counter memory-map file.

-gpc

Gets the performance-counter path.

-host

Displays host information as used for trust login.

-host -compare filename1 [,filename2]

Compares a machine or cluster signature file to the local machine or to another signature file.

-host -file filename

Produces a machine signature file for licensing.

-host -lictomsf licfile msffile

Extracts the machine signature from a license file and stores in a machine signature file.

-lcks

Links the 64-bit and 32-bit performance-counter registry keys.

-machine

Displays machine and compile information.

-mdfv path

Displays the message-definition file version.

-qd [HeaderOnly | RecNo=n | PointId=ID | count=n] [QueueType=auto|evq|mdbrepl|harepl] path

Displays the header or specified events from the event-queue file. With the QueueType specifier, choose the queue type or use auto to detect the queue type. The RecNo and PointID qualifiers can be used for evq types only. Use the count qualifier with any queue type.

-qs path

Displays statistics of an offline event-queue file.

-t time_stamp [U]

Converts a time stamp to string. If the time is numeric and ambiguous (such as the day of a month) and the first digit is not zero, relative time conversion is performed. To specify that a numeric time is UTC seconds (so that any local time-zone offset is not applied), use the U option.

-tls --register thumbprint*

Sets the thumbprint of the certificate that Data Archive presents to clients when they attempt TLS communication. This command also confirms that the certificate is located in the Local Computer's "Personal" certificate store, has the required properties, and sets read permissions on the certificate's private key for PI Network Manager.

-tls --verify*

Confirms that the certificate registered for PI Data Archive's TLS use is valid and that the permissions are set properly.

-tz [time [time_zone]] [-check | -dump [-brief] | -full]

Shows time-zone information.

-udf path

Resets the piadmin password to blank.

Note: We do not recommend assigning piadmin to any users.

-ulcks

Unlinks the 64-bit and 32-bit performance-counter registry keys.

-upc subsystem

Uninstalls performance counters for the specified subsystem.

-updateFolderSecurity [-verbose]

Grants the virtual service accounts running PI Archive Subsystem, PI Snapshot Subsystem, and PI Update Manager required permissions to the folders that store archive and queue files.

-uuid [N]

Creates and displays the specified number of UIDs. If no number is specified, one UID is created.

-v

Displays version information.

-w msec

Waits for the specified time, in milliseconds.

-xa path [-st start] [-et end] [-uid ID] [-xh URL] [-dbMask mask]

Exports audit records from an Audit Database file to XML. The path parameter specifies the audit file from which you want to export records. Output is sent to standard output (the command line). Available options are:

• -st start

  Starts at the specified time.

• -et end

  Ends at the specified time.

• -uid ID

  Specifies the ID of the audit record that you want to export. If you do not specify the -uid parameter, all audit records are output.

• -xh URL

  Exports records to the specified schema URL.

• -dbmask mask

  Exports the specified databases. If this option is excluded, all databases are exported. To view a list of the allowed databases and their decimals, enter:

  pidiag -?