piconfig command-line options

Option

Argument

Defaults

Description

?

Lists all commands.

?atr

Lists all attributes for current table.

?tbl

Lists all tables known to piconfig.

Case

Data|Names|All

All (case-insensitive)

Sets case-sensitivity-ignore mode. This affects only timeout and firewall tables.

Cd

Directory

Change directory for input/output files.

Clear

Clears Modify and Select specifications.

Comchar

NewComChar

@

Changes the command character to the specified non-alphanumeric character.

Comment

NewCommentChar

*

Changes the comment character to the specified non-alphanumeric character.

Delimiter

NewDelimiter

,

Changes the delimiter to the specified non-alphanumeric character.

Echo

Data|Commands|All|Verbose|None

Data

Specifies if input commands and data are echoed to the output file.

End-repeat

Marks end of repeated field.

Endrecord

Terminates input of one data record. Required in keyword format. May be used in other formats to terminate input before all data fields were entered.

Endsection

Marks the end of processing section.

Error

Filename

Redirects error messages to file.

Exit

Exits the piconfig utility. (Quit and Bye work the same way.)

Help

Lists all commands.

Input

Filename

Redirects input from file.

Istructure

Structure

Specifies format of input data.

Istype

F|D|K

D

Selects input data format structure type.

Line

BufferSize

1024

Inputs line buffer size.

Login

PI 3 node, PI username, password, port ID

Connects to a remote PI 3 home node using the given PI user name, password, and TCP/IP port ID. This does not work if explicit logins are disabled on the target Data Archive server. piconfig displays an error message stating that the authentication method is disabled by current server policy.

Maxerr

ErrorTolerance

10

Sets the error tolerance. piconfig exits when the number of errors reaches the specified number. However, piconfig exits only when in non-interactive mode. A Maxerr value of -1 causes piconfig to exit upon the first error and display the line number of the input file.

Mode

Create|Edit, Delete|List, Compare|Convert

List

Specifies mode of operation. Create mode can be modified to edit if the record already exists by specifying Create,t. Edit mode can be modified to create if the record doesn’t exist (Edit,t). To check only, specify: Edit,c or Create,c.

Modify

Modification

Defines field modifications.

Ostructure

Structure

Specifies format of output data. Only useful when in list mode. A warning is issued if this command is used in mode edit, create, or delete.

Ostype

F|D|K

D

Selects output data format structure type: Fixed, Delimited, or Keyword.

Output

filename

Redirects output to file. If a file is not specified, the output is directed back to standard output.

Prompt

Yes|No

Yes

Sets prompt mode: yes for interactive sessions or no for batch sessions.

Ptclassname

Classname

Base

Specifies the point class: base or classic. PIPOINT table only.

Quote

' | “

Tells piconfig to enclose output fields with quote character 'c' if they contain the delimiter character.

Recsep

Yes|No

Yes

Tells piconfig to separate multi-line output records with a comment line.

Select

Selection

Key=*

Defines record selection criteria.

Sigd

SignificantDigits

-7

In a number display, sets decimal digits (that is, the number of digits below the decimal point) by setting it to a number greater than or equal to 0, or significant digits by setting to a negative number.

Status

Reports piconfig current configuration: table, mode, structure type, and so on.

Structure

Structure

Specifies either input or output according to mode. Output in list and convert modes. Input in all other modes.

STYP

Delimited|Keyword|Fixed

Delimited

Sets structure type.

SYST

System

Executes OS console command. For example, Syst dir.

Table

Table

Sets the PI table to PIPOINT, PIDS, and so on.

Timformat

Dig,TZ

5,F

Time format. Number of decimals on subsecond time stamps and whether or not to include time-zone indication.

Wait

Seconds

0

Pause for the specified number of seconds. Useful in piconfig scripts (non-interactive).