Client Command (hrm)
The hrm command deletes the files on the remote (server,hcpd server) computer.
Basic Format
The basic format is as follows.
Usage: hrm [OPTION]... [USER@]HOST:[PORT:]FILE [:FILE]...
or: hrm [OPTION]... --host=HOST [--port=PORT] [--user=USER] FILE...
Option List
The options for the hrm commands are below.
Deletion
| Description | Short Name | Option Name |
|---|---|---|
| Delete the file without showing the confirmation message. | f | force |
| Delete the file recursively | R | recursive |
| Delete the empty directory. | d | dir |
| Show the confirmation message at each deletion. | i | |
| Show the confirmation message just once at the first deletion. | I | |
| Set the remote host | host | |
| Set the remote port | port |
Selectable Communication Method Function
| Description | Short Name | Option Name |
|---|---|---|
| The HpFP protocol | hpfp | |
| The WebSocket protocol(SSL/TLS) | wss | |
| The port-separation UDP(HpFP) protocol(deprecated) | udp | |
| The WebSocket protocol (plaintext communications) | ws | |
| Directly connect to the Proxy server when the WebSocket protocol | ws-proxy-direct | |
| Set the Proxy server when the WebSocket protocol | ws-proxy |
Congestion Control
| Description | Short Name | Option Name |
|---|---|---|
| Congestion control modes in the HpFP protocol | hpfp-cong |
Data Flow Control, Message Data Size Control
| Description | Short Name | Option Name |
|---|---|---|
| MSS(Maximum Segment Size) in the HpFP protocol | hpfp-mss |
Data Flow Control, Data Buffer Setting
| Description | Short Name | Option Name |
|---|---|---|
| Set the sending buffer size for the HpFP protocol | hpfp-sndbuf | |
| Set the receiving buffer size for the HpFP protocol | hpfp-rcvbuf |
Authentication
| Description | Short Name | Option Name |
|---|---|---|
| Server certificate checking is disabled in WebSocket protocol communications | wss-no-check-certificate | |
| Specify a username first and deletion | user | |
| Specify a password first and deletion | password |
Various Monitorings
| Description | Short Name | Option Name |
|---|---|---|
| Investigation mode starts (deprecated) | investigation |
Performance Evaluation
| Description | Short Name | Option Name |
|---|---|---|
| Measure network I/O performance with HCP protocol | n | no-diskio |
Log Management
| Description | Short Name | Option Name |
|---|---|---|
| Specify an application diagnostic log output destination | hcp-diag | |
| Specify various statistics log output destinations | stat-log-file | |
| Specify an execution record output destination | hcp-out | |
| Start in the multiple-run mode | multi-run |
Software Information Update
| Description | Short Name | Option Name |
|---|---|---|
| Check the application version | V | version |
| Check the configuration and input parameters | config-test | |
| Display the command help | h | help |
System Operating Environment Settings
| Description | Short Name | Option Name |
|---|---|---|
| Setting form a path of the configuration file | config-file | |
| Make configuration from command line | config-option | |
| Show configuration option's names | show-config-options | |
| Setting by a relative path from the current directory | include-conf-from-cwd | |
| Server compatibility disabled | no-earlier-serv-compat |
Check System Information
| Description | Short Name | Option Name |
|---|---|---|
| Show system info | system-info | |
| Run host benchmark | run-host-benchmark | |
| Specify measurement categories on the benchmark | run-host-benchmark-categories |
Please refer to the hcpd command section on the following option.
--investigation
Please refer to the hcp command section on the following option.
--hpfp, --wss, --user, --password, --config-file, --config-option, --show-config-options, --system-info, --run-host-benchmark, --run-host-benchmark-categories, --hcp-diag, --stat-log-file, --udp, --ws, --wss-no-check-certificate, --ws-proxy-direct, --ws-proxy, --hpfp-cong, --hpfp-mss, --hpfp-sndbuf, --hpfp-rcvbuf, --multi-run, --include-conf-from-cwd, --no-earlier-serv-compat, --no-agent, --ident-select
Deletion
f, force
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -f | --force
=========================================================================
Files are deleted without confirmations, even if necessary due to the access authorization and so on.
--
Example:
[user@localhost ~]$ hrm -f ...
--
R, recursive
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -R | --recursive
=========================================================================
Files are deleted recursively.
--
Example:
[user@localhost ~]$ hrm -R ...
--
d, dir
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -d | --dir
=========================================================================
Even empty directories are deleted.
--
Example:
[user@localhost ~]$ hrm -d ...
--
i
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -i
=========================================================================
The confirmation message is shown at each deletion.
--
Example:
[user@localhost ~]$ hrm -i ...
--
I
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -I
=========================================================================
The confirmation message is not shown after showing it at the first deletion.
--
Example:
[user@localhost ~]$ hrm -I ...
--
host
=========================================================================
Supported OS : Linux / Windows / Mac
Format : --host=<remote-host>
-------------------------------------------------------------------------
remote-host
Default : none
Range of Values : IP address or host name
=========================================================================
The destination remote host is specified, which is applied to the path for the deletion target. With this parameter, the host name can be abbreviated.
--
Example:
[user@localhost ~]$ hrm --host=192.168.100.100 ...
--
port
=========================================================================
Supported OS : Linux / Windows / Mac
Format : --port=<remote-port>
-------------------------------------------------------------------------
remote-port
Default : none
Range of Values : port number
=========================================================================
The service port number for the destination remote host is specified, which is applied to the path for the deletion target.
--
Example:
[user@localhost ~]$ hrm --port=1874 ...
--
Log Management
hcp-out
=========================================================================
Supported OS : Linux / Windows / Mac
Format : --hcp-out=<output-path>
-------------------------------------------------------------------------
output-path
Default : none
Range of Values : path string of file system
=========================================================================
The file to output the execution record of file deletion is set.
--
Example:
TARGET 127.0.0.1:11111:/home/user/Desktop/hcp_dst5
OK 0000 DE 00000001 ./
OK 0000 FR 00000002 ./file1.txt
OK 0000 DX 00000001 ./
EXIT 0 REASON 0000
--
FR (File Remove) means file deletion processing. DE (Directory Enter) means the confirmation proceeding whether it starts deleting directories which is done by setting the i option, DX (Directory eXit) means whose confirmation processing.
--
Example:
[user@localhost ~]$ hrm --hcp-out=- ...
--
Software Information Update
V, version
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -V | --version
=========================================================================
Show the hrm command version.
--
Example:
[user@localhost ~]$ hrm -V
hrm client (hrm) 1.5.8_1 / Linux (HpFP2 2.0.0.91_26 WSAPI 0.0.1.36 WS 4.2.0-2)
--
config-test
=========================================================================
Supported OS : Linux / Windows / Mac
Format : --config-test
=========================================================================
Display the input parameters for the hrm command and the configurations.
--
Example:
[user@localhost ~]$ hrm --config-test
...
-- [Targets] ---------------------------------------------------------------
-- [Command Options] -------------------------------------------------------
force : disable
recursive : disable
dir : disable
-i (prompt every) : disable
-I (prompt once) : disable
no-diskio : disable
host : -
port : -
user : -
password : -
version : disable
help : disable
-- [Configuration Parameters] ----------------------------------------------
PubkeyAuthentication : yes
WinLogonUserAuthentication : yes
PAMAuthentication : yes
LocalPasswordAuthentication : yes
NumberOfPasswordPrompts : 3
CompressLevel : -1
StrictHostKeyChecking : ask
IdentityFile : - [~/.ssh/id_rsa ~/.ssh/id_ecdsa ~/.ssh/id_ed25519 ~/.hcp/id_rsa ~/.hcp/id_ecdsa ~/.hcp/id_ed25519]
MaxReceiveRate : 100000000000
MaxSendRate : 100000000000
MaxConnectionReceiveRate : 100000000000
MaxConnectionSendRate : 100000000000
TransportTimeout : 180 sec
AcceptableCryptMethod : AES256/GCM AES256/CTR/VMAC AES256/CBC AES128/CBC [Intel:AES-NI=yes]
AcceptableDigestMethod : XXH3 SHA256 SHA160
-- [Environment Variables] -------------------------------------------------
USER : user
LOGNAME : user
HCP_PASSWORD :
HCP_WS_PROXY :
----------------------------------------------------------------------------
Please type '--config-test --config-test ...' for more details.
--
h, help
=========================================================================
Supported OS : Linux / Windows / Mac
Format : -h | --help
=========================================================================
The help for the hrm commands are shown.
--
Example:
[user@localhost ~]$ hrm -h
--