Skip to main content

Server Command (hcpd)

The hcpd daemon is the software which receives the instruction commands sent from the remote clients such as, the hcp (file transfer) command and the hrm (file delete) command and waits to execute them at the server side, which is available on Linux.

Basic Format#

The basic format is as follows.

Usage: hcpd [OPTION]...  or : hcpd -q [OPTION]...

Option List#

The options for the hcpd commands are below.

Various Monitorings

DescriptionShort NameOption Name
Foreground executionfforeground
Investigation mode starts (deprecated)investigation

Log Management

DescriptionShort NameOption Name
Specify a system log output destinationllog-file
Specify various statistics log output destinationsLstat-log-file

Software Information Update

DescriptionShort NameOption Name
Check the application versionVversion
Check the configuration and input parameterstconfig-test
Display the hcpd daemon helphhelp

System Operating Environment Settings

DescriptionShort NameOption Name
Setting a path of the configuration filecconfig-file
Setting a file path to save a process IDppid-file
Setting a file path to save a license keyklicense
The stop commandqquit

Various Monitorings#

f, foreground#

=========================================================================Supported OS : Linux.x86Format : -f | --foreground=========================================================================

Start the hcpd daemon in the foreground mode.

--Example:[root@localhost ~]# hcpd -f ...--

investigation#

=========================================================================Supported OS : Linux.x86Format : --investigation=========================================================================

The hcpd daemon starts in the investigation mode. In the case of unexpected behaviors and so on, detailed log is output for the investigation. This mode is not suitable for the long-time use and the case where the high performance is required on the transmission, because a lot of logs are output. Kindly send the log to the application developer for its investigation, because it is not for users but for the developers.

This option is deprecated. Instead, detailed log data can be obtained with SystemLogLevel or ApplicationLogLevel DEBUG.

Log Management#

l, log-file#

=========================================================================Supported OS : Linux.x86Format : -l <log-file-path> | --log-file=<log-file-path>-------------------------------------------------------------------------log-file-pathDefault : noneRange of Values : path string of file system=========================================================================

This option specifies a path of a file to which the hcpd daemon output logs.

--Example:[root@localhost ~]# hcpd -l /var/log/hcpd.log ...--

When this option is not specified, the log is output as the standard output.

L, stat-log-file#

=========================================================================Supported OS : Linux.x86Format : -L <log-file-path> | --stat-log-file=<log-file-path>-------------------------------------------------------------------------log-file-pathDefault : noneRange of Values : path string of file system=========================================================================

This option specifies the path of the statistic log file which the hcpd daemon outputs.

--Example:[root@localhost ~]# hcpd -L /var/tmp/.hcp.statistics2 ...--

Each statistics log is output in the specified path with suffix.

<spciified path>.system (system statistics)<spciified path>.application (application statistics)<spciified path>.transport.tcp.service_<service number>.<service port>.thread_<thread number>.transport.tcp (TCPtransport statistics)<spciified path>.transport.hpfp.service_<service number>.<t;service port>.thread_<thread number>(HpFPtransport statistics)<spciified path>.transport.ws.service_<service number>.<t;service port>.thread_<thread number>(WS/WSStransport statistics)

When it is output by a non-privileged user with StatLogPerUserInPrivilegeSeparation enabled, it is recorded in the following path.

<spciified path>.application.<UID>_<GID> (Linux)<spciified path>.application.<Username> (Windows)

When this option is not specified, it is output in the following path.

/var/tmp/.hcp.statistics

Software Information Update#

V, version#

=========================================================================Supported OS : Linux.x86Format : -V | --version=========================================================================

Display the hcpd daemon version.

--Example:[root@localhost ~]# hcpd -Vhcp server (hcpd) 1.4.10_7 / Linux (HpFP2 2.0.0.91_26 WSAPI 0.0.1.36 WS 4.2.0-2)--

t, config-test#

=========================================================================Supported OS : Linux.x86Format : -t | --config-test=========================================================================

Output the input parameters and the configuration data of the hcpd daemon.

--Example:[root@localhost ~]# hcpd -t...
Number of Logical Processors  : 2Number of Physical Processors : 2
Command parameters foreground  : disable version     : disable help        : disable quit        : disable pid-file    : disable [/var/run/hcpd.pid] default license     : disable [/etc/hcp/license.key] default config-test : enable config-file : disable [/etc/hcp/hcpd.conf] default log-file    : disable [/var/log/hcpd.log] default stat-log-file   : disable [/var/tmp/.hcp.statistics] default
Configuration parameters PubkeyAuthentication             : yes PAMAuthentication                : yes LocalPasswordAuthentication      : no PerformSystemAuthenticationRegardlessUsers : no UserDirectoryFallbackAvailable   : no RejectOnUserHomeDirectoryNotFound : no UsePrivilegeSeparation           : yes [supp_group=yes] PrivilegeSeparationMinimumUID    : 0 PrivilegeSeparationMinimumGID    : 0 PrivilegeSeparationUser          : nobody PrivilegeSeparationUmask         : 0022 - PrivilegeSeparationUmaskAnonymous : 0002 - ApplyUserPermission              : yes AllowUsers                       : - AllowGroups                      : - DenyUsers                        : - DenyGroups                       : - UseServerCertificateSecurity     : yes RequireServerCertificateSecurity : yes HeaderCompress                   : yes ContentCompress                  : yes OCSPRevocationEnabled            : yes AuthorizedKeysSearchDir           : - [/etc/hcp/authkeys] AuthorizedKeysFile                : - [~/.hcp/authorized_keys] AuthorizedKeysCommand            : -  LocalUserFile                    : - [/etc/hcp/users usage=overwrite] LocalPasswordFile                : - [/etc/hcp/passwd] ServerKeyFile                    : - [/etc/hcp/key/server.key] ServerCertificateFile            : - [/etc/hcp/cert/server.crt] ServerCertificateChainFile       : - [/etc/hcp/cert/chain.crt] CACertificateFile                : - [/etc/hcp/cacert.pem] CACertificatePath                : - [/etc/ssl] CARevocationFile                 : - [/etc/hcp/crl.pem] CARevocationPath                 : - [/etc/ssl] ProtocolVersion                  : 2 MaxConcurrentThread              : 0 MaxTotalConnection               : 150 MaxTcpConnection                 : 50 MaxUdpConnection                 : 50 MaxWsConnection                  : 50 MaxConnectionPerUser             : 50 MaxConnectionPerSec              : 50 MaxRequestFileEntryAtOnce        : 50 MaxReceiveFileSize               : unlimited MaxSendFileSize                  : unlimited MaxTotalBufferSize               : 4294967296 MaxBufferSizePerConnection       : 104857600 MaxTotalReceiveRate              : 10000000000 MaxTotalSendRate                 : 10000000000 MaxReceiveRatePerConnection      : 10000000000 MaxSendRatePerConnection         : 10000000000 InitHeaderBlockSize              : 51200 InitContentBlockSize             : 1048576 MaxHeaderBlockSize               : 51200 MaxContentBlockSize              : 1048576 TransportTimeout                 : 180 IdleTimeout                      : 0 FileLock                         : no FileLockTrials                   : 0 FileLockTrialInterval            : 3 AtomicLikeSaving                 : no .tmp NONE [threshold=0, reject_ow_req=yes] TCPListenAddress                 : 0.0.0.0:874[TCP tcp1, mcd=1] HPFPListenAddress                : 0.0.0.0:65520[HpFP udp1, sndbuf=104857600, rcvbuf=209715200, mss=-1, mcd=1] ListenServiceBonding             : - UDPServiceExtensionBufferSize    : 2147483648 TCPServiceSocketSendBuffer       : 0 AcceptableCryptMethod            : AES256/GCM AES256/CTR/VMAC AES256/CBC AES128/CBC [Intel:AES-NI=yes] AcceptableDigestMethod           : XXH3 SHA256 SHA160 RequireDataIntegrityChecking     : yes TransportCharEncoding            : UTF8 DocPoint                         : /home  DocPath = /home  PermitAccessRead = yes  PermitAccessWrite = yes  PermitAccessOverwrite = yes  PermitAccessDelete = yes  PermitAccessRandomRead = no  PermitAccessRandomWrite = no DocPointEnd HostEncoding                     : UTF8 SyslogOption                     : LOG_CONS | LOG_PID SyslogFacility                   : LOG_DAEMON SystemLog                        : INFO yes Rotation[size=no:0:0, pattern=no:] -[/var/log/hcpd.log] ApplicationStatLog               : yes Rotation[size=no:0:0, pattern=no:] TransportStatLog                 : no Rotation[size=no:0:0, pattern=no:] SystemStatLog                    : yes Rotation[size=no:0:0, pattern=no:] FileOperationLog                 : no -[/var/log/hcpd.file.operation.log] Rotation[size=no:0:0, pattern=no:] CallbackScript                   : no Script[~/.hcp/callback.sh, data=~/.hcp/callback] EnsureDestinationInFileTransfer  : yes StatLogPerUserInPrivilegeSeparation : no ApplicationStatLogSecurityEx     : yes MemoryTransferConcurrency        : 1 (wait_type cond, exp_nsec 1) MaxReadRatePerConnection         : unlimited MaxWriteRatePerConnection        : unlimited--

h, help#

=========================================================================Supported OS : Linux.x86Format : -h | --help=========================================================================

Display the hcpd daemon help.

--Example:[root@localhost ~]# hcpd -h--

System Operating Environment Settings#

c, config-file#

=========================================================================Supported OS : Linux.x86Format : -c <config-file-path> | --config-file=<config-file-path>-------------------------------------------------------------------------config-file-pathDefault : noneRange of Values : path string of file system=========================================================================

This option specifies the path of the configuration file that the hcpd daemon read. It is executed when normal users use the hcpd commands or when individual settings are necessary for each user.

--Example:[root@localhost ~]# hcpd -c /etc/hcp/hcpd2.conf ...--

If this option is not specified, the configuration from the following file will be read.

/etc/hcp/hcpd.conf

p, pid-file#

=========================================================================Supported OS : Linux.x86Format : -p <pid-file-path> | --pid-file=<pid-file-path>-------------------------------------------------------------------------pid-file-pathDefault : /var/run/hcpd.pidRange of Values : path string of file system=========================================================================

This option specifies the file path in order to output the process ID of the hcpd daemon process.

--Example:[root@localhost ~]# hcpd -p /var/run/hcpd2.pid ...--

Please note that if plural daemon processes are going to run or another daemon process has already run, the same file path is unavailable.

k, license#

=========================================================================Supported OS : Linux.x86Format : -k <license-key-path> | --license=<license-key-path>-------------------------------------------------------------------------license-key-pathDefault : /etc/hcp/license.keyRange of Values : path string of file system=========================================================================

The license key path is set.

--Example:[root@localhost ~]# hcpd -k /etc/hcp/license2.key ...--

The path of the license key is specified. When this option is not specified, the license key will be read from the following path.

/etc/hcp/license.key

When the license key is not available to read, the trial license is applied with the following conditions.

total max throughput 1GbpsMax throughput 1GbpsTCP Max session 3HpFP Max session 3WS/WSS Max session 3Max multiple connection degree per session 1

q, quit#

=========================================================================Supported OS : Linux.x86Format : -q | --quit=========================================================================

hcpd newly to run sends the signal to terminate the hcpd daemon working.

It gets the process ID from the specified file in the pid-file option or the default file and send the signal with the process ID to terminate the hcpd working.

--Example:[root@localhost ~]# hcpd -q ...--