Using the piartool Utility

The following table lists the command line options for the piartool utility. You can only use piartool when PI is running.

Table 3–1. Options for Use with piartool

Option Name Action

-aag Archive Activity

Grid Enable/Disable the archive activity grid, and list the Archive access information. -ac Archive create Create an archive for specified period

-acd Dynamic archive

Option Name Action

-ads Archive disable

shift

Removed specified archive from shift participation.

-aes Archive enable

shift Add specified archive to shift participation. -al Archive list List all registered archives

-ar <path> Archive register Register a specified archive

-as Archive statistics Archive Subsystem activity monitor and statistics -au <path> Archive unregister Unregister a specified archive

-aw Archive walk List details of the records in an archive file -Backup ['path'] [-

component <comp>] [-numarch <number>] [More Options listed under Action]

Perform a System Backup

Start/End/Query a backup of the PI system. The path points to where the resulting backup files are placed. The optional component specifies which part of the PI system is backed up. The numarch option specifies how many archives (starting from the current archive and working backupwards) are backed up. By default all archives are backed up. Additional options include:

-query [-verbose] Inquire about the current backup status.

-abort Abort a running backup.

-identify [-numarch <number>] [-cutoff <date>] [- verbose] Identify files able to be backed up. In verbose mode the individual components are listed. The numarch and cutoff options override default until next backup.

-test <freeze,component|thaw> Test but don’t actually perform a PI system backup.

-block Block Wait for a specified subsystem to become responsive. Used in PI start scripts. -cad 'tagname' [-reset] Archive cache

diagnostics Archive cache diagnostics for a specified point. Display the events sitting in the read and write cache.

-cas ['tagmask'] Archive cache summary

Display a summary of the contents of the archive cache, including the number of events in the Read and Write caches for every point that matches the tagmask. -cs [For troubleshooting only] PINetmgr connection stress test

PI Network Manager connection stress test.

-de <path>

[-pt tagname] [recno]

Dump eventqueue Dump specified Event Queue file.

Optionally select a specific tag and/or specific record in the file.

3.3 - Tools for Managing Archives

Option Name Action

-disconnect - subsystem <name> [- id <id>] [For troubleshooting only] Force Subsystem Disconnect

Force the specified subsystem to disconnect from pinetmgr, or if pinetmgr is specified, instruct pinetmgr to disconnect the connection based on the connection ID passed.

The -graceful option causes a disconnection notice to be first sent by pinetmgr or the target

subsystem.

-fs Force shift Force an archive shift. -idci <in file>

-idco <outfile>

ID conversion file creation

Create ID conversion file from specified input file.

-lic [Options listed

under Action] Licensing Information Usage List options for viewing license info _{Def List all licenses} User List all licenses in use

Lic List all licenses and users

AllowedApps <-List <type,type...>|-Check <app,app,...>>

List the types of licenses or check whether a specific feature is licensed

-mpt <0|1> [For troubleshooting only]

Message protocol trace

Log all communication coming to and from the server.

To enable tracing run with -mpt 1. Call a second time with -mpt 0 to stop tracing.

The resulting output file appears in the “\pi\temp directory” with the .mpt extension.

The file can be read with the mptconsolveview utility, which OSISoft provides on request, e.g.: Mptconsolveview .\24-Aug-05_12-10-06.mpt -msg "message" [-pro "procname"] [-nrep m] [-nbuf l] [-nmps n] [For troubleshooting only] Message

Subsystem Test Sends a series of test messages to the PI message log. Can emulate sending messages from any process. Nrep sets how many messages are sent, nbuf sets how many messages are sent at a time, nmps attempts to throttle how many messages are sent per second.

-msgtest <startsize in bytes> <endsize in bytes> [For troubleshooting only] PINetmgr Communications Test

Send a series of test messages to the PInetmgr. Message size increases by one byte increments starting from startsize to endsize.

Option Name Action -netstress [-SendBlocks 1] [- RecvBlocks 1] [-loops 1] [For troubleshooting only] PINetmgr stress test.

Test PINetmgr subsystem by sending and receiving specified 4k blocks.

-ooo <-r><Sec> Out of order snap events

Show tags with Out of Order events. Optional Reset and Repeat.

-qs Queue statistics Monitor Event-Queue activity and statistics -re [-subsystem

<name> |-pid <#> ] [For troubleshooting only]

Raise Exception Raise exception in specified subsystem (force a crash). This call only works locally; remote is not supported.

-remote Remote system Run utility against a remote system. When this argument is included as the last argument in any valid command the utility prompts for remote system login information. If successful the utility runs against the remote system.

-rpctest <subsystem> <count> [For troubleshooting only] Inter-process Communication Test

Times the RPC round trip to the specified sub- system.

-ss Snapshot statistics Snapshot Subsystem activity monitor and statistics -standalone <n> Standalone mode Place PI Server in standalone mode. Possible

values for n are: 1 Enter standalone 0 Exit standalone 2 Query current state

-systembackup System Backup Start/End backup for a specified subsystem. Deprecated in favor of -backup.

-thread 'subsystem' [Options listed under Action]

Subsystem Thread Control

-info List a subsystem's threads -id <Thread ID>

<-disable|-enable|-suspend|-resume|-terminate|- hang|-add|-break|-priority <Direction>>

Perform an action on a particular thread -v Version Get version and build information