Synopsis
fprscli HostName {/p | /e} /s:SourceName /d:DestName [/rc:nn /ri:nnnn]
Description
The fprscli command compresses and expands files on a client.
You can use this command to compress a file at the transfer source and expand it at the transfer destination, which helps reduce the file transfer time as well as the load on the network.
Parameters
HostName
Specifies a host name of the client where the files are compressed/expanded. Specify a host name in HostName within 15 alphanumeric characters. If a space character is contained in HostName, enclose it in double quotation marks.
/p
Compresses files.
/e
Expands files.
/s:SourceName
Specify a path name of the compression source file/expansion source file using the local drive path. You can use a wildcard for the file name of the compression source file.
Since wildcard characters such as an asterisk (*) have special meaning to shell, you need to enclose SourceName with either single or double quotation marks as necessary.
SourceName must be no longer than 255 characters. If SourceName contains a space character, enclose it in double quotation marks.
/d:DestName
Specify a path name of destination file for compression/expansion using a local path. You can use a wildcard for the file name of the expansion destination file.
Since wildcard characters such as an asterisk (*) have special meaning to shell, you need to enclose DestName with either single or double quotation marks as necessary.
DestName must be no longer than 255 characters. If DestName contains a space character, enclose it in double quotation marks.
If the file name that already exists is specified, it will be overwritten. Note that the same file path name as the one (SourceName) specified with /s should not be specified.
/rc:nn
Specifies the retry count in case an error occurs in file compression/expansion.
Specify an integer value between 0 and 99 for nn. Setting any other value results in an error. If omitted, no retry is performed.
If a wildcard is used to specify the source files for compression or the destination files for expansion, retry is performed only for the failed files.
/ri:nnnn
Specifies the retry interval in case an error occurs.
Specify an integer value between 0 and 9999 (in seconds) for nnnn. Setting any other value results in an error. The default value is 0.
This parameter is valid if 1 or a greater value is specified to nn in the /rc parameter.
Return Values
Return value | Meaning |
---|---|
0 | Completed |
Value other than 0 | Abended |
Command Location
Solaris | /opt/FJSVsnjss/bin |
HP-UX | /opt/FHPsnjss/bin |
AIX | /opt/FAIXsnjss/bin |
Linux | /opt/FJSVsnjss/bin |
Example
In this example, the command is executed to compress the local file "c:\database\master\*.*" to "d:\database\database.prs" on the client "foo". If the compression fails, retry is performed up to three times at an interval of 60 seconds.
fprscli foo /p /s:c:\\database\\master\\*.* /d:d:\\database\\database.prs /rc:3 /ri:60
Execution Results/Output Format
After the command has been through processing, the information at command completion is output to the standard output.
The contents to be output are shown below:
[Process start time] MM-DD-YYYY HH:MM:SS [Client host name] HostName [File compression/Expansion] Name of compression/expansion source files Name of compression/expansion destination files (*) [Retry count] Number of retries performed (*) [Error] Error message (*) [Process end time] MM-DD-YYYY HH:MM:SS
If a wildcard is used, the information of each file is output by file basis.
In [Error], "None" is output if the command completed successfully. A message is output if the command is canceled or failed. For details on the messages, see the Systemwalker Operation Manager Message Guide.
If an error occurs before performing compression/expansion process, a message is output in the following format:
[Process start time] MM-DD-YYYY HH:MM:SS [Command error] Error message [Process end time] MM-DD-YYYY HH:MM:SS
For details on the messages, see the Systemwalker Operation Manager Message Guide.
Cautions
The Client Task Link service must be already working on the client side when you use this command.
A backslash (\) in a path name personal computer can be interpreted as an escape sequence depending on UNIX shells. To use a backslash in such shell string, enter two backlashes (\\).
If a file is compressed without the /w parameter on a UNIX server running this version or later versions of Systemwalker Operation Manager, it cannot be expanded on a client.
The compressed file created with this command becomes the format for Windows platform that is the same as the one created with the /w parameter on a UNIX- based server.
If you compressed files using the fprssvr (server file compression/expansion) command with the /w parameter and expand them using this command on Windows, they will be extracted as follow:
If write permission for the files are not assigned on the compression source, the files are marked with the Read Only attribute on Windows.
If write permission for the file is set for any of owner, group, or other on the compression source, the files are marked with the Read/Write attribute on Windows.
If you compress files in the format for Windows platform by using this command, and then expand them on UNIX, the feature of files after extraction is as follow:
File attribute before compression | Feature of file extracted on UNIX |
---|---|
Read-only |
|
Other than Read-only. |
|
When the files are readable by everyone, it indicates the permission for the files displayed as "-r--r--r--" by using the ls -l command.
When the files are readable/writable by everyone, it indicates the permission for the files displayed as "-rw-rw-rw-" by using the ls -l command.
You need the read permissions for the files you want to compress. However, the superuser can do it without the read permission.
If this command is canceled, it is carried out at the point when one file has been completely compressed or expanded. Therefore, the command takes a longer time to quit if it is cancelled while a large file is being compressed/expanded.
If you use a wildcard for the file name specified in this command with the /s parameter, note the following:
The number of files to be processed at a time on the same client should be 500 or less, including the files to be processed by other Client Task Link commands.
A temporary file is created in the following location on the client when executing this command.
A directory set in the environment variable temp
Note that the compression/expansion fails if there is not enough disk space in the temp. The amount of space necessary for the temporary file is determined by adding the files sizes (before compressing or after expanding) together.
The size per file should be 2GB or less.