Synopsis
FPRSCLI.EXE HostName {/P | /E} /S:SourceName /D:DestName [/RC:nn /RI:nnnn]
Description
The FPRSCLI.EXE command compresses and expands files on a client.
This command allows you to compress files on the transfer source and expand them on 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. HostName must be no longer than 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
Specifies 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.
SourceName must be no longer than 255 characters. If SourceName contains a space character, enclose it in double quotation marks.
/D:DestName
Specifies 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.
Specify the path name in DestName within 255 characters. If a space character is contained in DestName, 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 compression source file or expansion destination file, 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
Systemwalker Operation Manager installation directory\MpWalker.JM\bin
Example
In this example, the command is executed to compress the local file "c:\database\master\database.db" 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.EXE 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 also output.
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.
If you compress files using the fprssvr command with the /w parameter on the UNIX-based Systemwalker Operation Manager server, and then expand them using this command on Windows, they will be extracted as follow:
If write permission for the files is not assigned on the compression source, the files are marked with the Read Only attribute on Windows.
If write permission for the files 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 using this command, and then expand them on the UNIX-based Systemwalker Operation Manager server, the feature of files after extraction is as follow:
File attribute on Windows 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 file 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 file 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.
If using a wildcard to specify a file name in a parameter, it is recommended to use a wildcard (asterisk only) for the entire file name. If using a wildcard for a part of the file name, confirm if the compressed/expanded file has the expected file name beforehand.
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.