Client Command (hcp-ls)
The hcp-ls command gets the file list on the remote servers (server or hcpd server).
Basic Format#
The basic format is as follows.
Usage: hcp-ls [OPTION]... [USER@]HOST[:PORT][:FILE] [:FILE]... or: hcp-ls [OPTION]... --host=HOST [--port=PORT] [--user=USER] [FILE]...Option List#
The options for the hcp-ls commands are below.
File List Acquisition
| Description | Short Name | Option Name |
|---|---|---|
| Set the flag to query command names | q | query-cmdname |
| Set the command option | o | cmd-options |
| 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 file list acquisition | user | |
| Specify a password first and file list acquisition | password |
Various Monitorings
| Description | Short Name | Option Name |
|---|---|---|
| Investigation mode starts (deprecated) | investigation |
Log Management
| Description | Short Name | Option Name |
|---|---|---|
| Specify an application log output destination | log-file | |
| 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 | |
| Setting by a relative path from the current directory | include-conf-from-cwd | |
| Server compatibility disabled | no-earlier-serv-compat |
Please refer to the hcpd command section on the following option.
--investigationPlease 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-compatFile List Acquisition#
q, query-cmdname#
=========================================================================Supported OS : Linux / Windows / MacFormat : -q | --query-cmdname=========================================================================Command names on the command list operated on servers are queried. Either of the following commands is shown.
- ls (Linux)
- dir (Windows)
--Example:[user@localhost ~]$ hcp-ls -q ...--o, cmd-options#
=========================================================================Supported OS : Linux / Windows / MacFormat : -o <options> | --cmd-options=<options>-------------------------------------------------------------------------optionsDefault : noneRange of Values : parameter option for the ls or dir command.=========================================================================The command options are set. When they include the blank or “-”, it should be quote.
--Example:[user@localhost ~]$ hcp-ls -o "-al" ...--host#
=========================================================================Supported OS : Linux / Windows / MacFormat : --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 listed target. With this parameter, the host name can be abbreviated.
--Example:[user@localhost ~]$ hcp-ls --host=192.168.100.100 ...--port#
=========================================================================Supported OS : Linux / Windows / MacFormat : --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 listed target.
--Example:[user@localhost ~]$ hcp-ls --port=1874 ...--Log Management#
hcp-out#
=========================================================================Supported OS : Linux / Windows / MacFormat : --hcp-out=<output-path>-------------------------------------------------------------------------output-pathDefault : noneRange of Values : path string of file system=========================================================================The file to output the execution record of file list acquirement is set. The execution result of the list is always output as standard output.
--Example:FILE 127.0.0.1:11111:/home/user/Desktop/hcp_dst5--
--Example:[user@localhost ~]$ hcp-ls --hcp-out=- ...--Software Information Uupdate#
V, version#
=========================================================================Supported OS : Linux / Windows / MacFormat : -V | --version=========================================================================The hcp-ls command version is shown.
--Example:[user@localhost ~]$ hcp-ls -Vhcp-ls client (hcp-ls) 1.4.10_7 / Linux (HpFP2 2.0.0.91_26 WSAPI 0.0.1.36 WS 4.2.0-2)--config-test#
=========================================================================Supported OS : Linux / Windows / MacFormat : --config-test=========================================================================Display the input parameters for the hcp-ls command and the configuration information.
--Example:[user@localhost ~]$ hcp-ls --config-test...
Number of Logical Processors : 2Number of Physical Processors : 2
Command parameters query-cmdname : disable cmd-options : - host : disable port : disable user : disable password : disable version : disable help : disable
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 SHA256 SHA160
Please type '--config-test --config-test ...' for more details.--h, help#
=========================================================================Supported OS : Linux / Windows / MacFormat : -h | --help=========================================================================The hcp-ls command help line is shown.
--Example:[user@localhost ~]$ hcp-ls -h--