ctgstart command reference

Edit online

You can use the ctgstart command on UNIX and Linux® to start CICS® Transaction Gateway with options.

The format of the ctgstart command is:
ctgstart <options> [<-j>JVMArg1 <-j>JVMArg2...] [<-c>CicscliArg1 <-c>CicscliArg2...]
To list the startup options and their purposes, type ctgstart -?

If you are running the Gateway daemon as a background process, these startup options, except for -adminport, can be specified on the ctgd parameter CTGD_PARAMS. For more information, see ctgd command reference.

Startup options

Option name and syntax Description
-port=number Specifies the TCP/IP port number on which the Gateway daemon will listen.
-sslport=number Specifies the TCP/IP port number on which the Gateway daemon will listen for SSL requests.
-httpport=port_number Specifies the TCP/IP port on which the Gateway daemon listens for HTTP requests.
-httpsport=port_number Specifies the TCP/IP port on which the Gateway daemon listens for HTTPS requests.
-keyring=file Specifies the SSL key ring path and file name.
-keyringpw=password Specifies the SSL key ring password. An error message is generated if the keyringpw parameter is used on its own without the corresponding keyring parameter in thectgstart command.
-adminport=number Specifies the port used to communicate with the Gateway daemon when controlling the Gateway daemon through the ctgadmin command.
-statsport=number Specifies the TCP/IP port number on which the Gateway daemon will listen for statistics API requests.
-initconnect=number Specifies an initial number of connection manager threads. See Tuning the Gateway for performance information.
-maxconnect=number Specifies a maximum number of connection manager threads. If you set this value to -1, no limits are applied to the number of connection manager threads. See Tuning the Gateway for performance information.
-maxhttpconnect=number Specifies the maximum number of HTTP and HTTPS client threads
-initworker=number Specifies an initial number of worker threads. See Tuning the Gateway for performance information.
-maxworker=number Specifies a maximum number of worker threads. If you set this value to -1, no limits are applied to the number of connection manager threads. See Tuning the Gateway for performance information.
-trace Enables standard tracing (see Tracing). By default, the trace output shows only the first 128 bytes of any data blocks (for example the COMMAREA, or network flows). Other useful information, including the value of the CLASSPATH variable, and the code page, is shown at the start of the trace output.

Trace output is written to /var/cicscli/gateway.trc, unless you use the -tfile option. No trace is written if the Gateway daemon does not have permission to write to the specified file. Each time the Gateway daemon is started with trace enabled, the trace file is overwritten with the new trace.

See Note.
-quiet Disables the reading of input from the console and disables writing to stdout. When the -quiet option is used, the Gateway daemon log destination must be set to file. For more information, see Gateway daemon logging
-dnsnames Enables the display of symbolic TCP/IP host names in messages. See Display TCP/IP host names for more information.
-tfile=pathname If tracing is enabled, trace output is written to the file specified in pathname. This option overrides the default destination for trace output (see the -trace option).
-x Enables full debug tracing (see Tracing). By default, the trace output shows the whole of any data blocks (for example the COMMAREA, or network flows). It also displays more information about the internal Gateway daemon processing than the standard trace. See the -trace and -tfile options for information on the destination for trace output.

Debug tracing significantly decreases performance.
-tfilesize=number Specifies the maximum size, in kilobytes, of the trace output file.
-truncationsize=number The value number specifies the maximum size of any data blocks that are shown in the trace. You can use this option with either the -trace or -x options to override the default size. Any positive integer is valid. If you specify a value of 0, no data blocks are shown in the trace.
-dumpoffset=number The value number specifies the offset from which displays of any data blocks start. If the offset is greater than the total length of data to be displayed, an offset of 0 is used.
-stack Enables Java™ exception stack tracing (see Tracing). Java exceptions are traced, including those expected during typical operation. Expected exceptions include:
  • An IOException resulting from a Java client application ending or disconnecting from a network protocol.
  • An InterruptedException resulting from a CICS Transaction Gateway protocol handler timeout such as the idle timeout, or a ping timeout.
No other trace output is created. See the -trace and -tfile options for information on the destination for trace output.
-j Passes an argument to the JVM. For example, -j-D<name>=<value> sets a JVM system property. See the JVM command line interpreter help for guidance in using this option. You can pass multiple arguments to the JVM. Specify the -j option multiple times to pass multiple arguments to the JVM.
-classpath=classpath Specifies additional entries to append to JVM classpath that are used when launching the JVM. For example, the location of a jar file containing request exits.
-c Passes an argument to the Client daemon control program cicscli. For example ctgstart -c-s=myserver -c-d -c-m=all will call cicscli -s=myserver -d -m=all.

The server name must be supplied.

For details about which options can be passed to the Client daemon, see Client daemon administration section.
-requestExits=exits A comma separated list of one or more fully qualified class names of the request monitoring exits.
Note: The trace options specified on the ctgstart command must specify the full set of options required for trace. If you specify one trace option the default values for the other options will be used and all trace options in ctg.ini will be ignored.