1echoscu(1) OFFIS DCMTK echoscu(1)
2
6 echoscu - DICOM verification (C-ECHO) SCU
7
10 echoscu [options] peer port
11
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
19 peer hostname of DICOM peer
20 port tcp/ip port number of peer
22
24 general options
25 -h --help
26 print this help text and exit
27 --version
29 print version information and exit
30 --arguments
32 print expanded command line arguments
33 -q --quiet
35 quiet mode, print no warnings and errors
36 -v --verbose
38 verbose mode, print processing details
39 -d --debug
41 debug mode, print debug information
42 -ll --log-level [l]evel: string constant
44 (fatal, error, warn, info, debug, trace)
45 use level l for the logger
46 -lc --log-config [f]ilename: string
48 use config file f for the logger
49 network options
51 application entity titles:
52 -aet --aetitle [a]etitle: string
54 set my calling AE title (default: ECHOSCU)
55 -aec --call [a]etitle: string
57 set called AE title of peer (default: ANY-SCP)
58 association negotiation debugging:
60 -pts --propose-ts [n]umber: integer (1..38)
62 propose n transfer syntaxes
63 -ppc --propose-pc [n]umber: integer (1..128)
65 propose n presentation contexts
66 other network options:
68 -to --timeout [s]econds: integer (default: unlimited)
70 timeout for connection requests
71 -ts --socket-timeout [s]econds: integer (default: 60)
73 timeout for network socket (0 for none)
74 -ta --acse-timeout [s]econds: integer (default: 30)
76 timeout for ACSE messages
77 -td --dimse-timeout [s]econds: integer (default: unlimited)
79 timeout for DIMSE messages
80 -pdu --max-pdu [n]umber of bytes: integer (4096..131072)
82 set max receive pdu to n bytes (default: 16384)
83 --repeat [n]umber: integer
85 repeat n times
86 --abort
88 abort association instead of releasing it
89 transport layer security (TLS) options
91 transport protocol stack:
92 -tls --disable-tls
94 use normal TCP/IP connection (default)
95 +tls --enable-tls [p]rivate key file, [c]ertificate file: string
97 use authenticated secure TLS connection
98 +tla --anonymous-tls
100 use secure TLS connection without certificate
101 private key password (only with --enable-tls):
103 +ps --std-passwd
105 prompt user to type password on stdin (default)
106 +pw --use-passwd [p]assword: string
108 use specified password
109 -pw --null-passwd
111 use empty string as password
112 key and certificate file format:
114 -pem --pem-keys
116 read keys and certificates as PEM file (default)
117 -der --der-keys
119 read keys and certificates as DER file
120 certification authority:
122 +cf --add-cert-file [c]ertificate filename: string
124 add certificate file to list of certificates
125 +cd --add-cert-dir [c]ertificate directory: string
127 add certificates in d to list of certificates
128 security profile:
130 +px --profile-bcp195
132 BCP 195 TLS Profile (default)
133 +py --profile-bcp195-nd
135 Non-downgrading BCP 195 TLS Profile
136 +pb --profile-basic
138 Basic TLS Secure Transport Connection Profile (retired)
139 +pa --profile-aes
141 AES TLS Secure Transport Connection Profile (retired)
142 +pn --profile-null
144 Authenticated unencrypted communication
145 (retired, was used in IHE ATNA)
146 ciphersuite:
148 +cc --list-ciphers
150 show list of supported TLS ciphersuites and exit
151 +cs --cipher [c]iphersuite name: string
153 add ciphersuite to list of negotiated suites
154 pseudo random generator:
156 +rs --seed [f]ilename: string
158 seed random generator with contents of f
159 +ws --write-seed
161 write back modified seed (only with --seed)
162 +wf --write-seed-file [f]ilename: string (only with --seed)
164 write modified seed to file f
165 peer authentication:
167 -rc --require-peer-cert
169 verify peer certificate, fail if absent (default)
170 -ic --ignore-peer-cert
172 don't verify peer certificate
173
175 DICOM Conformance
176 The echoscu application supports the following SOP Classes as an SCU:
177 VerificationSOPClass 1.2.840.10008.1.1
179 Unless the --propose-ts option is used, the echoscu application will
181 only propose the transfer syntax
182 LittleEndianImplicitTransferSyntax 1.2.840.10008.1.2
184
186 The level of logging output of the various command line tools and
187 underlying libraries can be specified by the user. By default, only
188 errors and warnings are written to the standard error stream. Using
189 option --verbose also informational messages like processing details
190 are reported. Option --debug can be used to get more details on the
191 internal activity, e.g. for debugging purposes. Other logging levels
192 can be selected using option --log-level. In --quiet mode only fatal
193 errors are reported. In such very severe error events, the application
194 will usually terminate. For more details on the different logging
195 levels, see documentation of module 'oflog'.
196 In case the logging output should be written to file (optionally with
198 logfile rotation), to syslog (Unix) or the event log (Windows) option
199 --log-config can be used. This configuration file also allows for
200 directing only certain messages to a particular output stream and for
201 filtering certain messages based on the module or application where
202 they are generated. An example configuration file is provided in
203 <etcdir>/logger.cfg.
204
206 All command line tools use the following notation for parameters:
207 square brackets enclose optional values (0-1), three trailing dots
208 indicate that multiple values are allowed (1-n), a combination of both
209 means 0 to n values.
210 Command line options are distinguished from parameters by a leading '+'
212 or '-' sign, respectively. Usually, order and position of command line
213 options are arbitrary (i.e. they can appear anywhere). However, if
214 options are mutually exclusive the rightmost appearance is used. This
215 behavior conforms to the standard evaluation rules of common Unix
216 shells.
217 In addition, one or more command files can be specified using an '@'
219 sign as a prefix to the filename (e.g. @command.txt). Such a command
220 argument is replaced by the content of the corresponding text file
221 (multiple whitespaces are treated as a single separator unless they
222 appear between two quotation marks) prior to any further evaluation.
223 Please note that a command file cannot contain another command file.
224 This simple but effective approach allows one to summarize common
225 combinations of options/parameters and avoids longish and confusing
226 command lines (an example is provided in file <datadir>/dumppat.txt).
227
229 The echoscu utility uses the following exit codes when terminating.
230 This enables the user to check for the reason why the application
231 terminated.
232 general
234 EXITCODE_NO_ERROR 0
235 EXITCODE_COMMANDLINE_SYNTAX_ERROR 1
236 input file errors
238 EXITCODE_CANNOT_READ_INPUT_FILE 20 (*)
239 output file errors
241 EXITCODE_CANNOT_WRITE_OUTPUT_FILE 40 (*)
242 network errors
244 EXITCODE_CANNOT_INITIALIZE_NETWORK 60 (*)
245 EXITCODE_ASSOCIATION_ABORTED 70
246 (*) Actually, these codes are currently not used by echoscu but serve
248 as a placeholder for the corresponding group of exit codes.
249
251 The echoscu utility will attempt to load DICOM data dictionaries
252 specified in the DCMDICTPATH environment variable. By default, i.e. if
253 the DCMDICTPATH environment variable is not set, the file
254 <datadir>/dicom.dic will be loaded unless the dictionary is built into
255 the application (default for Windows).
256 The default behavior should be preferred and the DCMDICTPATH
258 environment variable only used when alternative data dictionaries are
259 required. The DCMDICTPATH environment variable has the same format as
260 the Unix shell PATH variable in that a colon (':') separates entries.
261 On Windows systems, a semicolon (';') is used as a separator. The data
262 dictionary code will attempt to load each file specified in the
263 DCMDICTPATH environment variable. It is an error if no data dictionary
264 can be loaded.
265
267 Copyright (C) 1994-2018 by OFFIS e.V., Escherweg 2, 26121 Oldenburg,
268 Germany.
269Version 3.6.4 Thu Nov 29 2018 echoscu(1)