E.1 Creating a format file
Keywords are used to specify the information that is to be output to a format file.
During output, information is embedded into the format file at the locations of the corresponding keywords. Any characters other than the keywords (including linefeed and control characters) are output as is to the text file.
- Notes about creating a format file
-
A format file must be created within a size limit of 2,048 bytes. If a created file exceeds 2,048 bytes, any excess information will be ignored.
- Organization of this subsection
(1) Keywords that can be specified
This subsection lists the keywords that can be specified in each type of format file. Note that the login user information is output as text from the Operations-Manager Console.
Keyword |
Description |
---|---|
$ICNT |
Data count |
$USER |
User name |
$CDIR |
Current directory |
Keyword |
Description |
---|---|
$ICNT |
Data count |
$USER |
User name |
$AKEY |
Trigger for auto-start |
$AFDK |
Key type |
$ANML |
Name of the program to start when transmission ends normally |
$AERR |
Name of the program to start when transmission ends abnormally |
Keyword |
Description |
---|---|
$ICNT |
Data count |
$USER |
User name |
$PSWD |
Password# |
$CARD |
Transmission card |
$LCAL |
Local file name |
$RMTE |
Remote file name |
$TRAN |
Sending or receiving |
$MODE |
Transmission mode |
$COMP |
Compression mode |
$FSIZ |
Size check |
$OUTK |
Output type |
$HOST |
Remote host name |
$PORT |
Port number |
$ANML |
Name of the program to start when transmission ends normally |
$AERR |
Name of the program to start when transmission ends abnormally |
$CMND |
FTP command |
$CMNT |
Comment |
$MULT |
Single-file or multiple-file transmission |
$FTPS |
Use FTPS |
$SCVC |
Check the expiration date of the server certificate |
$CACF |
Path to the CA certificate |
$CRLF |
Path to the CRL |
- #
-
To output passwords, you must have superuser permissions.
Keyword |
Description |
---|---|
$ICNT |
Data count |
$USER |
User name |
$CARD |
Transmission card |
$LCAL |
Local file name |
$RMTE |
Remote file name |
$MODE |
Transmission mode |
$TRAN |
Sending or receiving |
$COMP |
Compression mode |
$OUTK |
Output type |
$HOST |
Remote host name |
$PORT |
Port number |
$CMNT |
Comment |
$TRNO |
Transmission number |
$SVCE |
Client or server |
$STAT |
End status |
$STIM |
Start time |
$ETIM |
End time |
$TIME |
Transmission period |
$TSIZ |
Size transmitted |
$CONO |
Connection number |
$ETYP |
Error type |
$EPOS |
Location of the error |
$EMOD |
Error module name |
$ESYS |
Name of the system call |
$EMSG |
Error message |
$EPRT |
Protocol message |
$EMSC |
SSL communication error message |