Dovetailed Technologies

Appendix C. Co:Z Environment Variables

The following table describes the environment variables defined by the Co:Z Toolkit. These variables can be set to override default behavior.

Table C.1. Miscellaneous options

VariableDescription
COZ_SSH_CMDSpecifies an alternate executable for the SSH client used to connect to z/OS. By default, this is ssh. For example, to use the PuTTY command line client plink instead of ssh set COZ_SSH_CMD=/path/to/plink.
COZ_SSH_OPTSConvenience setting for supplying SSH options, including userid and host when making remote dataset pipes calls. For example, the command fromdsn -ssh user@host //mydsn can be simplified to fromdsn //mydsn if COZ_SSH_OPTS is set to user@host. This is very handy for repeated use of the remote dataset pipes commands.

When this varaible is set, the cozcontrol command can be simplified to cozcontrol start (omitting the -ssh user@host parameters). When a durable session is active, subsequent dataset pipes commands ignore the environment variable setting and use the durable session.

COZ_SSH_SUBSYSSpecifies an alternate SSH server subsystem name for Dataset Pipes. By default, this is dspipes.
COZ_CLIENT_CODEPAGEChanges the default client code page, which is used for codepage translation in text mode data transfers (i.e. if the -t is not supplied). By default, the default client code page is set the result of the POSIX system call nl_langinfo(CODESET).
COZ_DEFAULT_LOGSTREAMChanges the default stream that the Co:Z Log facility writes its messages to. By default, this is the stderr stream.
COZ_LOGSets log level for CozServer session level logging. The default is N, Notice.
COZ_LOG_CMDSets logging level for Dataset Pipes commands running on the server (fromdsn, cozclient, etc). The default is N, Notice. Command tracing can alternately be enabled with the -L option on most Dataset Pipes commands.
COZ_LOG_CMD_DUPWhen set to true (default is false), duplicates tracing enabled by COZ_LOG_CMD to the session log. This is recommended when requesting support from Co:Z support personnel because all logging for a problem is captured in a single file.
DSPIPES_LOGFILEPathname of file to where DSPIPES log/debug messages are written. The default is /tmp/dspipes.<userid>.<...>.log
DSPIPES_LOGDIRDirectory name (without trailing slash) where DSPIPES log files are created, rather than /tmp or $TMPDIR. This variable is ignored if DSPIPES_LOGFILE is set.
COZ_CONTROL_SESSIONUsed to identify the user@host associated with a cozcontrol durable connection. This setting is required when a user has multiple concurrent durable connections. The setting identifies the connection to use for remote Dataset Pipes commands as well as cozcontrol stop.
COZ_CONTROL_PATHUsed to override the default control path created with a tunneled cozcontrol durable connection. The default, when this variable is not set, is ~/.ssh/cm-%r@%h:%p.sock.

Copyright© 2009-2017 Dovetailed Technologies, LLC. All rights reserved.
Co:Z® is a registered trademark of Dovetailed Technologies, LLC.