echoscu(1)

πŸ’– echoscu(1) β€” OFFIS DCMTK πŸ’–

okay bestie, sit down, hydrate, because we're about to talk about echoscu from the OFFIS DCMTK manual set, and honestly? she's iconic. she's the "hey are you there??" of the DICOM world. let's go πŸ¦‹


✨ NAME ✨

echoscu β€” DICOM verification (C-ECHO) SCU, aka the friend that texts "u up?" to your PACS 🫢


🌸 SYNOPSIS 🌸

echoscu [options] peer port

πŸ’… DESCRIPTION πŸ’…

so the echoscu application is a Service Class User (SCU) for the Verification SOP Class β€” like, the whole job is verification, that's her lane, she stays in it πŸ‘‘

basically she sends a DICOM C-ECHO message to a Service Class Provider (SCP) and then waits for a response. patient queen energy, she will wait. and the app can be used to verify basic DICOM connectivity β€” which is literally the "can we even talk to each other" vibe check of the whole network πŸ”₯


πŸŽ€ PARAMETERS πŸŽ€

  • peer β€” hostname of DICOM peer πŸ’«
  • port β€” tcp/ip port number of peer πŸ’«

✨ OPTIONS ✨

🌈 general options

  • -h, --help β€” print this help text and exit. classic. we love a quick out ✨
  • --version β€” print version information and exit. who are you, where did you come from πŸ‘€
  • --arguments β€” print expanded command line arguments. for the nosy ones (me, I'm nosy) πŸ™ˆ
  • -q, --quiet β€” quiet mode, print no warnings and errors. she's giving stealth mode πŸ’€
  • -v, --verbose β€” verbose mode, print processing details. now she's yapping (affectionate) πŸ’¬
  • -d, --debug β€” debug mode, print debug information. full brain dump, no filter 🧠
  • -ll, --log-level [l]evel: string constant β€” use level l for the logger. the valid levels are fatal, error, warn, info, debug, trace πŸ“‹
  • -lc, --log-config [f]ilename: string β€” use config file f for the logger πŸ“

🌈 network options

IP protocol version:

  • -i4, --ipv4 β€” use IPv4 only (default) πŸ’œ
  • -i6, --ipv6 β€” use IPv6 only πŸ’œ
  • -i0, --ip-auto β€” use DNS lookup to determine IP protocol. let the DNS girlies decide πŸ’œ

application entity titles:

  • -aet, --aetitle [a]etitle: string β€” set my calling AE title (default: ECHOSCU) πŸ’–
  • -aec, --call [a]etitle: string β€” set called AE title of peer (default: ANY-SCP) πŸ’–

association negotiation debugging:

  • -pts, --propose-ts [n]umber: integer (1..53) β€” propose n transfer syntaxes πŸŽ€
  • -ppc, --propose-pc [n]umber: integer (1..128) β€” propose n presentation contexts πŸŽ€
lowkey note: those ranges are 1..53 and 1..128, don't get creative with them bestie πŸ™…

other network options:

  • -to, --timeout [s]econds: integer (default: unlimited) β€” timeout for connection requests ⏳
  • -ts, --socket-timeout [s]econds: integer (default: 60) β€” timeout for network socket (0 for none) 🧦
  • -ta, --acse-timeout [s]econds: integer (default: 30) β€” timeout for ACSE messages ⏱️
  • -td, --dimse-timeout [s]econds: integer (default: unlimited) β€” timeout for DIMSE messages ⏱️
  • -pdu, --max-pdu [n]umber of bytes: integer (4096..131072) β€” set max receive pdu to n bytes (default: 16384) πŸ“¦
  • --repeat [n]umber: integer β€” repeat n times. again! again! πŸ”
  • --abort β€” abort association instead of releasing it. dramatic exit, no closure, we love it πŸ’€

πŸ” transport layer security (TLS) options

transport protocol stack:

  • -tls, --disable-tls β€” use normal TCP/IP connection (default) 🐒
  • +tls, --enable-tls [p]rivate key file, [c]ertificate file: string β€” use authenticated secure TLS connection πŸ”’
  • +tla, --anonymous-tls β€” use secure TLS connection without certificate. mysterious. no ID, still encrypted πŸ•ΆοΈ

private key password (only with --enable-tls):

  • +ps, --std-passwd β€” prompt user to type password on stdin (default) ⌨️
  • +pw, --use-passwd [p]assword: string β€” use specified password πŸ™Š
  • -pw, --null-passwd β€” use empty string as password πŸ«₯

key and certificate file format:

  • -pem, --pem-keys β€” read keys and certificates as PEM file (default) πŸ“œ
  • -der, --der-keys β€” read keys and certificates as DER file πŸ“œ

certification authority:

  • +cf, --add-cert-file [f]ilename: string β€” add certificate file to list of certificates βž•
  • +cd, --add-cert-dir [d]irectory: string β€” add certificates in d to list of certificates βž•
  • +crl, --add-crl-file [f]ilename: string β€” add certificate revocation list file (implies --enable-crl-vfy) 🚫
  • +crv, --enable-crl-vfy β€” enable leaf CRL verification πŸƒ
  • +cra, --enable-crl-all β€” enable full chain CRL verification ⛓️

security profile:

  • +ph, --list-profiles β€” list supported TLS profiles and exit πŸ“‹
  • +pg, --profile-8996 β€” BCP 195 RFC 8996 TLS Profile (default) 🌟
  • +pm, --profile-8996-mod β€” Modified BCP 195 RFC 8996 TLS Profile 🌟
# only available if underlying TLS library supports # all TLS features required for this profile β€” so it might just not be a thing on your box, don't @ me πŸ₯²
  • +py, --profile-bcp195-nd β€” Non-downgrading BCP 195 TLS Profile (retired) πŸ‘΅
  • +px, --profile-bcp195 β€” BCP 195 TLS Profile (retired) πŸ‘΅
  • +pz, --profile-bcp195-ex β€” Extended BCP 195 TLS Profile (retired) πŸ‘΅
  • +pb, --profile-basic β€” Basic TLS Secure Transport Connection Profile (retired) πŸ‘΅
# only available if underlying TLS library supports 3DES β€” yes, 3DES, yes it's giving 2011, that's why it says retired 🫠
  • +pa, --profile-aes β€” AES TLS Secure Transport Connection Profile (retired) πŸ‘΅
  • +pn, --profile-null β€” Authenticated unencrypted communication (retired, was used in IHE ATNA) πŸ‘΅
ok bestie, clock the tea: a whole bunch of these profiles are literally marked retired. they're still documented, but do not come for me if you pick one and it's giving museum exhibit πŸ›οΈ

ciphersuite:

  • +cc, --list-ciphers β€” list supported TLS ciphersuites and exit πŸ“‹
  • +cs, --cipher [c]iphersuite name: string β€” add ciphersuite to list of negotiated suites πŸ”

server name indication:

  • --no-sni β€” do not use SNI (default) πŸ™ˆ
  • --request-sni [s]erver name: string β€” request server name s πŸ“›

pseudo random generator:

  • +rs, --seed [f]ilename: string β€” seed random generator with contents of f 🌱
  • +ws, --write-seed β€” write back modified seed (only with --seed) ✍️
  • +wf, --write-seed-file [f]ilename: string (only with --seed) β€” write modified seed to file f ✍️

peer authentication:

  • -rc, --require-peer-cert β€” verify peer certificate, fail if absent (default) πŸͺͺ
  • -ic, --ignore-peer-cert β€” don't verify peer certificate. trust falls, but make it network security πŸ™ƒ

offline certificate verification:

  • +vc, --verify-cert [f]ilename: string β€” verify certificate against CA settings πŸ”
# Load a client certificate and check whether it would be accepted # when received during a TLS handshake. Print result and exit.
  • +rc, --is-root-cert [f]ilename: string β€” check if certificate is self-signed root CA πŸ”
# Load a client certificate and check whether it is a valid, # self-signed root CA certificate. Print result and exit.

🌟 NOTES 🌟

πŸ’– DICOM Conformance πŸ’–

so the echoscu application supports the following SOP Classes as an SCU β€” just the one, she's focused:

VerificationSOPClass                                1.2.840.10008.1.1

and by default? the echoscu application will only propose this transfer syntax:

LittleEndianImplicitTransferSyntax                  1.2.840.10008.1.2

BUT. and this is the fun part. if the --propose-ts option is used, the following transfer syntaxes will also be proposed, depending on the numeric value n that is passed to this option. get comfy, this list is long and lowkey the main character of this section πŸ‘‘

LittleEndianExplicitTransferSyntax                  1.2.840.10008.1.2.1
BigEndianExplicitTransferSyntax                     1.2.840.10008.1.2.2
JPEGProcess1TransferSyntax                          1.2.840.10008.1.2.4.50
JPEGProcess2_4TransferSyntax                        1.2.840.10008.1.2.4.51
JPEGProcess3_5TransferSyntax                        1.2.840.10008.1.2.4.52
JPEGProcess6_8TransferSyntax                        1.2.840.10008.1.2.4.53
JPEGProcess7_9TransferSyntax                        1.2.840.10008.1.2.4.54
JPEGProcess10_12TransferSyntax                      1.2.840.10008.1.2.4.55
JPEGProcess11_13TransferSyntax                      1.2.840.10008.1.2.4.56
JPEGProcess14TransferSyntax                         1.2.840.10008.1.2.4.57
JPEGProcess15TransferSyntax                         1.2.840.10008.1.2.4.58
JPEGProcess16_18TransferSyntax                      1.2.840.10008.1.2.4.59
JPEGProcess17_19TransferSyntax                      1.2.840.10008.1.2.4.60
JPEGProcess20_22TransferSyntax                      1.2.840.10008.1.2.4.61
JPEGProcess21_23TransferSyntax                      1.2.840.10008.1.2.4.62
JPEGProcess24_26TransferSyntax                      1.2.840.10008.1.2.4.63
JPEGProcess25_27TransferSyntax                      1.2.840.10008.1.2.4.64
JPEGProcess28TransferSyntax                         1.2.840.10008.1.2.4.65
JPEGProcess29TransferSyntax                         1.2.840.10008.1.2.4.66
JPEGProcess14SV1TransferSyntax                      1.2.840.10008.1.2.4.70
RLELosslessTransferSyntax                           1.2.840.10008.1.2.5
DeflatedExplicitVRLittleEndianTransferSyntax        1.2.840.10008.1.2.1.99
JPEGLSLosslessTransferSyntax                        1.2.840.10008.1.2.4.80
JPEGLSLossyTransferSyntax                           1.2.840.10008.1.2.4.81
JPEG2000LosslessOnlyTransferSyntax                  1.2.840.10008.1.2.4.90
JPEG2000TransferSyntax                              1.2.840.10008.1.2.4.91
JPEG2000Part2MulticomponentImageComp.LosslessOnlyT. 1.2.840.10008.1.2.4.92
JPEG2000Part2MulticomponentImageComp.TransferSyntax 1.2.804.10008.1.2.4.93
MPEG2MainProfileAtMainLevelTransferSyntax           1.2.840.10008.1.2.4.100
MPEG2MainProfileAtHighLevelTransferSyntax           1.2.840.10008.1.2.4.101
MPEG4HighProfileLevel4_1TransferSyntax              1.2.840.10008.1.2.4.102
MPEG4BDcompatibleHighProfileLevel4_1TransferSyntax  1.2.840.10008.1.2.4.103
MPEG4HighProfileLevel4_2_For2DVideoTransferSyntax   1.2.840.10008.1.2.4.104
MPEG4HighProfileLevel4_2_For3DVideoTransferSyntax   1.2.840.10008.1.2.4.105
MPEG4StereoHighProfileLevel4_2TransferSyntax        1.2.840.10008.1.2.4.106
HEVCMainProfileLevel5_1TransferSyntax               1.2.840.10008.1.2.4.107
HEVCMain10ProfileLevel5_1TransferSyntax             1.2.840.10008.1.2.4.108
FragmentableMPEG2MainProfileMainLevelTransferSyntax 1.2.840.10008.1.2.4.100.1
FragmentableMPEG2MainProfileHighLevelTransferSyntax 1.2.840.10008.1.2.4.101.1
FragmentableMPEG4HighProfileLevel4_1TransferSyntax  1.2.840.10008.1.2.4.102.1
FragmentableMPEG4BDcompatibleHighProfileLevel4_1Tr. 1.2.840.10008.1.2.4.103.1
FragmentableMPEG4HighProfileLevel4_2_For2DVideoTr.S 1.2.840.10008.1.2.4.104.1
FragmentableMPEG4HighProfileLevel4_2_For3DVideoTr.S 1.2.840.10008.1.2.4.105.1
FragmentableMPEG4StereoHighProfileLevel4_2TransferS 1.2.840.10008.1.2.4.106.1
HighThroughputJPEG2000ImageCompressionLossless.Tr.S 1.2.840.10008.1.2.4.201
HighThroughputJPEG2000RPCLImageCompressionLoss.Tr.S 1.2.840.10008.1.2.4.202
HighThroughputJPEG2000ImageCompressionTransferSynt. 1.2.840.10008.1.2.4.203
🫢 tiny heads-up because I love you: those names are copied exactly as they appear, truncations and all β€” JPEG2000Part2MulticomponentImageComp.LosslessOnlyT. really does end in a dot, and yes, 1.2.804.10008.1.2.4.93 really is written like that. do not "fix" them, they're not typos on my end, they're just how the manual prints them. iykyk πŸ’…

✨ LOGGING ✨

Okay bestie, so the level of logging output from the various command line tools and underlying libraries can be set by you. By default, only errors and warnings are written to the standard error stream. Using option --verbose also reports informational messages like processing details. Option --debug can be used to get more details on the internal activity, e.g. for debugging purposes. Other logging levels can be selected using option --log-level. In --quiet mode only fatal errors are reported. In such very severe error events, the application will usually terminate. For more details on the different logging levels, see documentation of module "oflog".

If the logging output should be written to file (optionally with logfile rotation), to syslog (Unix) or the event log (Windows), option --log-config can be used. This configuration file also allows for directing only certain messages to a particular output stream and for filtering certain messages based on the module or application where they are generated. An example configuration file is provided in <etcdir>/logger.cfg.


πŸ› οΈ COMMAND LINE πŸ› οΈ

All command line tools use the following notation for parameters: square brackets enclose optional values (0-1), three trailing dots indicate that multiple values are allowed (1-n), and a combination of both means 0 to n values.

Command line options are distinguished from parameters by a leading + or - sign, respectively. Usually, order and position of command line options are arbitrary (i.e. they can appear anywhere). However, if options are mutually exclusive, the rightmost appearance is used. This behavior conforms to the standard evaluation rules of common Unix shells.

In addition, one or more command files can be specified using an @ sign as a prefix to the filename (e.g. @command.txt). Such a command argument is replaced by the content of the corresponding text file (multiple whitespaces are treated as a single separator unless they appear between two quotation marks) prior to any further evaluation. Please note that a command file cannot contain another command file. This simple but effective approach allows one to summarize common combinations of options/parameters and avoids longish and confusing command lines (an example is provided in file <datadir>/dumppat.txt).


πŸ’… EXIT CODES πŸ’…

The echoscu utility uses the following exit codes when terminating. This enables the user to check for the reason why the application terminated.

🌈 general 🌈

  • EXITCODE_NO_ERROR β€” 0
  • EXITCODE_COMMANDLINE_SYNTAX_ERROR β€” 1

πŸ“ input file errors πŸ“

  • EXITCODE_CANNOT_READ_INPUT_FILE β€” 20 (*)
  • EXITCODE_INVALID_INPUT_FILE β€” 22

πŸŽ€ output file errors πŸŽ€

  • EXITCODE_CANNOT_WRITE_OUTPUT_FILE β€” 40 (*)

πŸ¦‹ network errors πŸ¦‹

  • EXITCODE_CANNOT_INITIALIZE_NETWORK β€” 60 (*)
  • EXITCODE_ASSOCIATION_ABORTED β€” 70
(*) Actually, these codes are currently not used by echoscu but serve as a placeholder for the corresponding group of exit codes.

🌱 ENVIRONMENT 🌱

The echoscu utility will attempt to load DICOM data dictionaries specified in the DCMDICTPATH environment variable. By default, i.e. if the DCMDICTPATH environment variable is not set, the file <datadir>/dicom.dic will be loaded unless the dictionary is built into the application (default for Windows).

The default behavior should be preferred and the DCMDICTPATH environment variable only used when alternative data dictionaries are required. The DCMDICTPATH environment variable has the same format as the Unix shell PATH variable in that a colon (:) separates entries. On Windows systems, a semicolon (;) is used as a separator. The data dictionary code will attempt to load each file specified in the DCMDICTPATH environment variable. It is an error if no data dictionary can be loaded.


Copyright (C) 1994-2026 by OFFIS e.V., Escherweg 2, 26121 Oldenburg, Germany.


That’s the whole page, bestie! This echoscu(1) manual is Version 3.7.1, dated Sat Oct 17 2026 09:34:01 β€” footer tea, served fresh πŸ’…βœ¨

πŸ“¦ where this page comes from