Skip to main content

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:]TARGET [:TARGET]...   or: hrm [OPTION]... --host=HOST [--port=PORT] [--user=USER] TARGET...

Option List#

The options for the hrm commands are below.

Deletion

DescriptionShort NameOption Name
Delete the file without showing the confirmation message.fforce
Delete the file recursivelyRrecursive
Delete the empty directory.ddir
Show the confirmation message at each deletion.i
Show the confirmation message just once at the first deletion.I
Set the remote hosthost
Set the remote portport

Selectable Communication Method Function

DescriptionShort NameOption Name
The HpFP protocolhpfp
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 protocolws-proxy-direct
Set the Proxy server when the WebSocket protocolws-proxy

Congestion Control

DescriptionShort NameOption Name
Congestion control modes in the HpFP protocolhpfp-cong

Data Flow Control, Message Data Size Control

DescriptionShort NameOption Name
MSS(Maximum Segment Size) in the HpFP protocolhpfp-mss

Data Flow Control, Data Buffer Setting

DescriptionShort NameOption Name
Set the sending buffer size for the HpFP protocolhpfp-sndbuf
Set the receiving buffer size for the HpFP protocolhpfp-rcvbuf

Authentication

DescriptionShort NameOption Name
Server certificate checking is disabled in WebSocket protocol communicationswss-no-check-certificate
Specify a username first and deletionuser
Specify a password first and deletionpassword

Various Monitorings

DescriptionShort NameOption Name
Investigation mode starts (deprecated)investigation

Performance Evaluation

DescriptionShort NameOption Name
Measure network I/O performance with HCP protocolnno-diskio

Log Management

DescriptionShort NameOption Name
Specify an application log output destinationlog-file
Specify various statistics log output destinationsstat-log-file
Specify an execution record output destinationhcp-out
Start in the multiple-run modemulti-run

Software Information Update

DescriptionShort NameOption Name
Check the application versionVversion
Check the configuration and input parametersconfig-test
Display the command helphhelp

System Operating Environment Settings

DescriptionShort NameOption Name
Setting form a path of the configuration fileconfig-file
Make configuration from command lineconfig-option
Setting by a relative path from the current directoryinclude-conf-from-cwd
Server compatibility disabledno-earlier-serv-compat

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, --log-file, --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

Deletion#

f, force#

=========================================================================Supported OS : Linux / WindowsFormat : -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 / WindowsFormat : -R | --recursive=========================================================================

Files are deleted recursively.

--Example:[user@localhost ~]$ hrm -R ...--

d, dir#

=========================================================================Supported OS : Linux / WindowsFormat : -d | --dir=========================================================================

Even empty directories are deleted.

--Example:[user@localhost ~]$ hrm -d ...--

i#

=========================================================================Supported OS : Linux / WindowsFormat : -i=========================================================================

The confirmation message is shown at each deletion.

--Example:[user@localhost ~]$ hrm -i ...--

I#

=========================================================================Supported OS : Linux / WindowsFormat : -I=========================================================================

The confirmation message is not shown after showing it at the first deletion.

--Example:[user@localhost ~]$ hrm -I ...--

host#

=========================================================================Supported OS : Linux / WindowsFormat : --host=<remote-host>-------------------------------------------------------------------------remote-hostDefault : noneRange 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 / WindowsFormat : --port=<remote-port>-------------------------------------------------------------------------remote-portDefault : noneRange 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 / WindowsFormat : --hcp-out=<output-path>-------------------------------------------------------------------------output-pathDefault : noneRange 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_dst5OK 0000 DE 00000001 ./OK 0000 FR 00000002 ./file1.txtOK 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 / WindowsFormat : -V | --version=========================================================================

Show the hrm command version.

--Example:[user@localhost ~]$ hrm -Vhrm client (hrm) 1.3.4_3 / Linux (HpFP2 2.0.0.91_21 WSAPI 0.0.1.30 WS 4.2.0-1)--

config-test#

=========================================================================Supported OS : Linux / WindowsFormat : --config-test=========================================================================

Display the input parameters for the hrm command and the configurations.

--Example:[user@localhost ~]$ hrm --config-test...
Number of Logical Processors  : 2Number of Physical Processors : 2
Command parameters force      : disable recursive      : disable dir      : disable prompt_every      : disable prompt_once      : disable no-diskio      : disable (0, 0) host     : disable port     : disable user           : disable password       : disable version        : disable help           : disable
Target:
Configuration parameters PubkeyAuthentication             : yes WinLogonUserAuthentication       : yes PAMAuthentication                : yes LocalPasswordAuthentication      : yes CompressLevel                    : -1 StrictHostKeyChecking            : ask PrivateKeyFile                   : - [~/.hcp/id_rsa] TransportTimeout                 : 180 AcceptableCryptMethod            : AES256/GCM AES256/CTR/VMAC AES256/CBC AES128/CBC [Intel:AES-NI=yes] AcceptableDigestMethod           : XXH3 MM128 SHA256 SHA160
Please type '--config-test --config-test ...' for more details.--

h, help#

=========================================================================Supported OS : Linux / WindowsFormat : -h | --help=========================================================================

The help for the hrm commands are shown.

--Example:[user@localhost ~]$ hrm -h--