#!/bin/sh
# Set site-wide environment variables for dspipes server.
# Place this sample as an executable script in file: /etc/ssh/dspipes.rc

# The following are the default locations for user level configuration files.
#DSPIPES_USER_RC=$HOME/.ssh/dspipes.rc 
#DSPIPES_USER_CONFIG=$HOME/.ssh/dspipes_config 

# The following defines a directory name (without trailing slash) where
# log files will be created, rather than /tmp or $TMPDIR. Setting this 
# variable and regular cleanup of this directory are recommended.
#export DSPIPES_LOGDIR= 

In some cases, users may not have access to individual $HOME directories or it may be desirable to have all user configuration files centralized. In this case, the environment variable DSPIPES_USER_RC can be specified to provide an alternate file name for the user .rc file in a common, readable location. For example, to specify a common directory for all user configuration files, set the following: DSPIPES_USER_RC=/usr/share/coz/$LOWER_LOGNAME.dspipes.rc To disable the usage of user specific dspipes.rc files for all users, DSPIPES_USER_RC can be set to a dummy file name (e.g: /dummy). Note that the z/OS Unix System Services $LOGNAME environment variable holding the current username is in uppercase. As this is not always consistent with other POSIX style usage, the dspipes.sh script exports an enviroment variable named $LOWER_LOGNAME that downcases the value in $LOGNAME.

Additionally, individual user server config files can be similarly located. To learn more about config files, refer to section: Section 2.4, “z/OS Remote Services Session Config Files”. By default, user server config files are located at $HOME/.ssh/dspipes_config.

Note: The /etc/ssh/dspipes.rc, if present, must be marked executable, as must the individual user files.

#!/bin/sh
# Place this sample as an executable script in file: $HOME/.ssh/dspipes.rc

# Product support personnel may request that you uncomment one or more of 
# the following variables to enable tracing. These options should be set
# in user specific dspipes.rc files rather than globally in the site-wide 
# dspipes.rc 

# Setting COZ_LOG enables tracing for CozServer session level tracing. 
# The default is N, Notice.
#export COZ_LOG=T 

# Setting COZ_LOG_CMD enables tracing for dspipes 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.  
#export COZ_LOG_CMD=F 

# Setting COZ_LOG_CMD_DUP 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.  
#export COZ_LOG_CMD_DUP=true 

	When logging is enabled by setting this variable, log files are created for every Dataset Pipes server session. Each session is an SSH session. See the section called “Logging Configuration for Dataset Pipes” for additional information.
	When command logging is enabled by setting this variable, Co:Z logging messages are redirected back to the client for all Dataset Pipes commands executed by the client. The optional -L switch can be specified on Dataset Pipes commands to enable logging for a single command.
	When set to true, command logging is redirected back to the client and duplicated to the session log.

By default, log files are written to the /tmp directory (or the directory specified by the TMPDIR environment variable, if it is set). To change this directory default for all users, modify /etc/ssh/dspipes.rc as needed. Exporting DSPIPES_LOGDIR changes the directory log files are written to. The session log file name is generated with the following pattern: dspipes.<userid>.<...>.log.

The directory containing the log files must be cleaned up and monitored for space; however, it is important to keep these files for some period of time in order to allow support personnel to review the session log file for diagnostic information when investigating a problem.

In order to assist with log file maintenance, the environment variable DSPIPES_LOG_KEEP_DAYS can be exported from either the site or individual user's dspipes.rc. When this variable is specified, the argument must be an integer greater than zero. Log files older than the argument will be removed when the user next establishes a Co:Z Dataset Pipes server session. The log files to be deleted must belong to the the connecting user and reside in the immediate directory specified by DSPIPES_LOGDIR (or $TMPDIR if DSPIPES_LOGDIR is not specified). Note that if DSPIPES_LOGFILE is specified, DSPIPESP_LOG_KEEP_DAYS (if set) will be ignored.

The logging level is controlled by exporting the following environment variables: COZ_LOG, COZ_LOG_CMD, and COZ_LOG_CMD_DUP. In order to diagnose a problem for an individual user, create a dspipes.rc file in their individual .ssh directory, setting these variables as directed by product support personnel.