1echoscu(1)                        OFFIS DCMTK                       echoscu(1)
2
3
4

NAME

6       echoscu - DICOM verification (C-ECHO) SCU
7
8

SYNOPSIS

10       echoscu [options] peer port
11

DESCRIPTION

13       The  echoscu  application implements a Service Class User (SCU) for the
14       Verification SOP Class. It sends a DICOM C-ECHO message  to  a  Service
15       Class  Provider  (SCP) and waits for a response. The application can be
16       used to verify basic DICOM connectivity.
17

PARAMETERS

19       peer  hostname of DICOM peer
20
21       port  tcp/ip port number of peer
22

OPTIONS

24   general options
25         -h    --help
26                 print this help text and exit
27
28               --version
29                 print version information and exit
30
31               --arguments
32                 print expanded command line arguments
33
34         -q    --quiet
35                 quiet mode, print no warnings and errors
36
37         -v    --verbose
38                 verbose mode, print processing details
39
40         -d    --debug
41                 debug mode, print debug information
42
43         -ll   --log-level  [l]evel: string constant
44                 (fatal, error, warn, info, debug, trace)
45                 use level l for the logger
46
47         -lc   --log-config  [f]ilename: string
48                 use config file f for the logger
49
50   network options
51       application entity titles:
52
53         -aet  --aetitle  [a]etitle: string
54                 set my calling AE title (default: ECHOSCU)
55
56         -aec  --call  [a]etitle: string
57                 set called AE title of peer (default: ANY-SCP)
58
59       association negotiation debugging:
60
61         -pts  --propose-ts  [n]umber: integer (1..38)
62                 propose n transfer syntaxes
63
64         -ppc  --propose-pc  [n]umber: integer (1..128)
65                 propose n presentation contexts
66
67       other network options:
68
69         -to   --timeout  [s]econds: integer (default: unlimited)
70                 timeout for connection requests
71
72         -ts   --socket-timeout  [s]econds: integer (default: 60)
73                 timeout for network socket (0 for none)
74
75         -ta   --acse-timeout  [s]econds: integer (default: 30)
76                 timeout for ACSE messages
77
78         -td   --dimse-timeout  [s]econds: integer (default: unlimited)
79                 timeout for DIMSE messages
80
81         -pdu  --max-pdu  [n]umber of bytes: integer (4096..131072)
82                 set max receive pdu to n bytes (default: 16384)
83
84               --repeat  [n]umber: integer
85                 repeat n times
86
87               --abort
88                 abort association instead of releasing it
89
90   transport layer security (TLS) options
91       transport protocol stack:
92
93         -tls  --disable-tls
94                 use normal TCP/IP connection (default)
95
96         +tls  --enable-tls  [p]rivate key file, [c]ertificate file: string
97                 use authenticated secure TLS connection
98
99         +tla  --anonymous-tls
100                 use secure TLS connection without certificate
101
102       private key password (only with --enable-tls):
103
104         +ps   --std-passwd
105                 prompt user to type password on stdin (default)
106
107         +pw   --use-passwd  [p]assword: string
108                 use specified password
109
110         -pw   --null-passwd
111                 use empty string as password
112
113       key and certificate file format:
114
115         -pem  --pem-keys
116                 read keys and certificates as PEM file (default)
117
118         -der  --der-keys
119                 read keys and certificates as DER file
120
121       certification authority:
122
123         +cf   --add-cert-file  [f]ilename: string
124                 add certificate file to list of certificates
125
126         +cd   --add-cert-dir  [d]irectory: string
127                 add certificates in d to list of certificates
128
129       security profile:
130
131         +px   --profile-bcp195
132                 BCP 195 TLS Profile (default)
133
134         +py   --profile-bcp195-nd
135                 Non-downgrading BCP 195 TLS Profile
136
137         +pz   --profile-bcp195-ex
138                 Extended BCP 195 TLS Profile
139
140         +pb   --profile-basic
141                 Basic TLS Secure Transport Connection Profile (retired)
142
143         +pa   --profile-aes
144                 AES TLS Secure Transport Connection Profile (retired)
145
146         +pn   --profile-null
147                 Authenticated unencrypted communication
148                 (retired, was used in IHE ATNA)
149
150       ciphersuite:
151
152         +cc   --list-ciphers
153                 show list of supported TLS ciphersuites and exit
154
155         +cs   --cipher  [c]iphersuite name: string
156                 add ciphersuite to list of negotiated suites
157
158       pseudo random generator:
159
160         +rs   --seed  [f]ilename: string
161                 seed random generator with contents of f
162
163         +ws   --write-seed
164                 write back modified seed (only with --seed)
165
166         +wf   --write-seed-file  [f]ilename: string (only with --seed)
167                 write modified seed to file f
168
169       peer authentication:
170
171         -rc   --require-peer-cert
172                 verify peer certificate, fail if absent (default)
173
174         -ic   --ignore-peer-cert
175                 don't verify peer certificate
176

NOTES

178   DICOM Conformance
179       The echoscu application supports the following SOP Classes as an SCU:
180
181       VerificationSOPClass                1.2.840.10008.1.1
182
183       Unless the --propose-ts option is used, the  echoscu  application  will
184       only propose the transfer syntax
185
186       LittleEndianImplicitTransferSyntax  1.2.840.10008.1.2
187

LOGGING

189       The  level  of  logging  output  of  the various command line tools and
190       underlying libraries can be specified by the  user.  By  default,  only
191       errors  and  warnings  are  written to the standard error stream. Using
192       option --verbose also informational messages  like  processing  details
193       are  reported.  Option  --debug  can be used to get more details on the
194       internal activity, e.g. for debugging purposes.  Other  logging  levels
195       can  be  selected  using option --log-level. In --quiet mode only fatal
196       errors are reported. In such very severe error events, the  application
197       will  usually  terminate.  For  more  details  on the different logging
198       levels, see documentation of module 'oflog'.
199
200       In case the logging output should be written to file  (optionally  with
201       logfile  rotation),  to syslog (Unix) or the event log (Windows) option
202       --log-config can be used.  This  configuration  file  also  allows  for
203       directing  only  certain messages to a particular output stream and for
204       filtering certain messages based on the  module  or  application  where
205       they  are  generated.  An  example  configuration  file  is provided in
206       <etcdir>/logger.cfg.
207

COMMAND LINE

209       All command line tools  use  the  following  notation  for  parameters:
210       square  brackets  enclose  optional  values  (0-1), three trailing dots
211       indicate that multiple values are allowed (1-n), a combination of  both
212       means 0 to n values.
213
214       Command line options are distinguished from parameters by a leading '+'
215       or '-' sign, respectively. Usually, order and position of command  line
216       options  are  arbitrary  (i.e.  they  can appear anywhere). However, if
217       options are mutually exclusive the rightmost appearance is  used.  This
218       behavior  conforms  to  the  standard  evaluation  rules of common Unix
219       shells.
220
221       In addition, one or more command files can be specified  using  an  '@'
222       sign  as  a  prefix to the filename (e.g. @command.txt). Such a command
223       argument is replaced by the content  of  the  corresponding  text  file
224       (multiple  whitespaces  are  treated  as a single separator unless they
225       appear between two quotation marks) prior to  any  further  evaluation.
226       Please  note  that  a command file cannot contain another command file.
227       This simple but effective  approach  allows  one  to  summarize  common
228       combinations  of  options/parameters  and  avoids longish and confusing
229       command lines (an example is provided in file <datadir>/dumppat.txt).
230

EXIT CODES

232       The echoscu utility uses the following  exit  codes  when  terminating.
233       This  enables  the  user  to  check  for the reason why the application
234       terminated.
235
236   general
237       EXITCODE_NO_ERROR                         0
238       EXITCODE_COMMANDLINE_SYNTAX_ERROR         1
239
240   input file errors
241       EXITCODE_CANNOT_READ_INPUT_FILE          20 (*)
242
243   output file errors
244       EXITCODE_CANNOT_WRITE_OUTPUT_FILE        40 (*)
245
246   network errors
247       EXITCODE_CANNOT_INITIALIZE_NETWORK       60 (*)
248       EXITCODE_ASSOCIATION_ABORTED             70
249
250       (*) Actually, these codes are currently not used by echoscu  but  serve
251       as a placeholder for the corresponding group of exit codes.
252

ENVIRONMENT

254       The  echoscu  utility  will  attempt  to  load  DICOM data dictionaries
255       specified in the DCMDICTPATH environment variable. By default, i.e.  if
256       the   DCMDICTPATH   environment   variable   is   not   set,  the  file
257       <datadir>/dicom.dic will be loaded unless the dictionary is built  into
258       the application (default for Windows).
259
260       The   default   behavior   should  be  preferred  and  the  DCMDICTPATH
261       environment variable only used when alternative data  dictionaries  are
262       required.  The  DCMDICTPATH environment variable has the same format as
263       the Unix shell PATH variable in that a colon (':')  separates  entries.
264       On  Windows systems, a semicolon (';') is used as a separator. The data
265       dictionary code will  attempt  to  load  each  file  specified  in  the
266       DCMDICTPATH  environment variable. It is an error if no data dictionary
267       can be loaded.
268
270       Copyright (C) 1994-2021 e.V., Escherweg 2, 26121 Oldenburg, Germany.
271
272
273
274Version 3.6.6                   Thu Jan 14 2021                     echoscu(1)
Impressum