Display Distribution Log (DSPDSTLOG)

Where allowed to run: All environments (*ALL)
Threadsafe: No

The Display Distribution Log (DSPDSTLOG) command provides a convenient interface to the Systems Network Architecture distribution services (SNADS) log. The SNADS log (the QSNADS journal) contains entries that track SNADS operations that have been performed on the system. These operations include sending, receiving, and routing distributions and configuration changes.

This command provides a wide range of selection criteria which allows easy access to the desired information. The selection criteria includes time period, function type (such as router and sender/receiver), entry type (such as normal, error, and configuration), and job name. Any number of selection parameters can be entered, and the resulting output is cumulative, based on all parameters entered.

Both displayed and printed output can be produced in conjunction with the input parameter specified. If the user requests output that can be shown, a summary of all entries matching the selection criteria are shown. The summary display includes basic information, such as function type, entry type, date-time of logging, job name, and originating user ID. From the summary display, any of the entries can be chosen to view the details of that log entry. The detail display gives more specific information on that particular log entry. If the user requests printed output, a detail printout for each log entry in the selection is produced.

By specifying the appropriate selection criteria, the user can determine the following types of information:

Configuration changes that were made, when and by whom they were made for all tables or for specific tables
Configuration changes correlated with error entries or distributions routed and/or sent
List error entries for all functions or for specific functions (such as routing errors)
All distributions received, routed, or sent during a selected time interval
Activity for a specific sender or receiver job

Restrictions:

This command is shipped with public *EXCLUDE authority.
This command cannot be used to show information on the 12 by 80 size work station (*DS2) or on the console (*DS1).

Top

Parameters

Keyword	Description	Choices	Notes
PERIOD	Time period for log output	Element list	Optional
	Element 1:	Element list
	Element 1: Beginning time	Time, *AVAIL
	Element 2: Beginning date	Date, CURRENT, BEGIN
	Element 2:	Element list
	Element 1: Ending time	Time, *AVAIL
	Element 2: Ending date	Date, CURRENT, END
FNCTYP	Function type	Single values: ALL Other values (up to 8 repetitions): RCV, RTR, SND, CFG, OPR, ORG, ARV, *SYS	Optional
ENTTYP	Entry type	Single values: ALLDST, ALL Other values (up to 5 repetitions): NRM, ERR, RTG, DSQ, *SYS	Optional
ORGUSRID	Origin user identifier	Element list	Optional
	Element 1: User ID	Character value, ALL, BLANK
	Element 2: Address	Character value, ALL, BLANK
ORGSYSNAME	Origin system name	Element list	Optional
	Element 1: System name	Character value, *ALL
	Element 2: System group	Character value, ALL, BLANK
JOB	Job name	Single values: *ALL Other values: Qualified job name	Optional
	Qualifier 1: Job name	Name
	Qualifier 2: User	Name
	Qualifier 3: Number	000000-999999
RCVRNG	Range of journal receivers	Single values: *CURRENT Other values: Element list	Optional
	Element 1: Starting journal receiver	Qualified object name
	Qualifier 1: Starting journal receiver	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
	Element 2: Ending journal receiver	Single values: *CURRENT Other values: Qualified object name
	Qualifier 1: Ending journal receiver	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
OUTPUT	Output	, PRINT	Optional

Top

Time period for log output (PERIOD)

Specifies the time period for which log entries are shown. The following values can be coded in this parameter, which contains two lists of two values each.

Beginning Time: One of the following is used to specify the beginning time.

*AVAIL

The log entries from the starting date to the ending date are shown.

start-time

Specify the starting time for the specified starting date for which you want the log entries shown. The time can be specified with or without a time separator:

Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds.
With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.

Beginning Date: One of the following is used to specify the beginning date.

*CURRENT: The log entries that are available for the current day and between the specified starting and ending times (if specified) are shown.
*BEGIN: The entries from the beginning of the log are shown. If *BEGIN is specified then beginning-time is ignored.
beginning-date: Specify the start date for which the log entries are shown. (The system date format must be used.)

Ending Time: One of the following is used to specify the ending time.

*AVAIL: The log entries from the beginning date to the ending date are shown.
ending-time: Specify the ending time for the specified ending date to which you want the log entries shown. See the start-time description in this parameter description for details on how the time must be specified.

Ending Date: One of the following is used to specify the ending date.

*CURRENT: The log entries that are available for the current day and between the specified starting and ending times (if specified) are shown.
*END: The entries to the end of the log are shown. If *END is specified then ending-time is ignored.
ending-date: Specify the ending date to which you want the log entries shown. (The system date format must be used.)

Top

Function type (FNCTYP)

Specifies the SNADS function that was being performed when entries were made to the QSNADS journal. If the default value *ALL is not specified, a maximum of eight functions can be specified.

You can enter multiple values for this parameter.

The possible values are:

*ALL: All SNADS functions that made log entries are specified.
*RCV: The SNADS receiver function is specified.
*RTR: The SNADS router function is specified.
*SND: The SNADS sender function is specified.
*ORG: The SNADS originator function is specified.
*ARV: The SNADS arrival function is specified.
*CFG: The SNADS configuration function is specified. If *CFG is specified on this parameter, the User ID prompt (ORGUSRID parameter), and the System group prompt (ORGSYSNAME parameter) cannot be specified.
*OPR: The SNADS operation function is specified.
*SYS: The SNADS system function is specified.

Top

Entry type (ENTTYP)

Specifies the type of log entries that are shown. If the values *ALL or *ALLDST are not specified, a maximum of five entry types may be specified.

You can enter multiple values for this parameter.

The possible values are:

*ALLDST: All log entry types are shown except *SYS.
*ALL: All log entry types are shown.
*NRM: Normal (or non-error) log entries are shown.
*ERR: Error log entries are shown.
*RTG: Routing table log entries or secondary system name log entries are shown.
*DSQ: Distribution queue log entries are shown.
*SYS: The QSNADS journal entries are shown.

Top

Origin user identifier (ORGUSRID)

Specifies the originating user ID and address of logged distributions. This parameter allows you to display or print only those entries logged because of distributions originated by a user with the specified ID or address. The user ID and address are translated to the character set and code page '697 500' using the job's coded character set identifier (CCSID).

The possible user ID values are:

*ALL: All log entries are shown regardless of the originating user ID.
*BLANK: Only log entries with an originating user ID of all blanks (as in the case of SNADS status distributions) are shown.
user-ID: Specify the originating user ID for which log entries are to be shown.

The possible address values are:

*ALL: All log entries are shown regardless of the originating address.
*BLANK: Only log entries with an originating address of all blanks (as in the case of SNADS status distributions) are shown.
address: Specify the originating address for which log entries are to be shown.

Top

Origin system name (ORGSYSNAME)

Specifies the name and group name of the originating system of logged distributions. This parameter allows you to display or print only those entries logged because of distributions that originated from the specified system or group.

IBM i, System/38, and System/36 systems do not specify a system group. The originating system group name of distributions from these systems will always be blanks.

The name and group are translated to the character set and code page '697 500' using the job's coded character set identifier (CCSID).

The possible system name values are:

*ALL: All log entries are shown regardless of the originating system.
system-name: Specify the name of the originating system for which log entries are to be shown.

The possible group name values are:

*ALL: All log entries are shown regardless of the originating system group name.
*BLANK: Only log entries with an originating address of all blanks are shown.
system-group-name: Specify the originating system group name for which log entries are to be shown.

Top

Job name (JOB)

Specifies the name of the SNADS job that made the log entry. This parameter allows you to display or print only those entries logged by the specified job.

The possible values are:

*ALL: Entries are shown regardless of the job that logged them.
job name (user name (job number)): Specifies the particular SNADS job name that made the entries.

Top

Range of journal receivers (RCVRNG)

Specifies the journal receivers that contain the SNADS logs. This allows you to display entries from SNADS logs that are kept in journal receivers which are no longer active.

The possible values are:

*CURRENT

The current SNADS log is shown.

starting-receiver-name

Specify a starting receiver name (library name/starting receiver name). The SNADS logs that are kept in the journal receivers from the starting receiver name through the ending receiver name are shown.

The possible library values are:

*LIBL: The library list is used to locate the journal receiver.
*CURLIB: The current library for the job is used to locate the journal receiver. If no library is specified as the current library, QGPL is used.
library-name: Specify the name of the library where the journal receiver is located.

ending-receiver-name

Specify a ending receiver name (library name/ending receiver name). The SNADS logs that are kept in the journal receivers from the starting receiver name through the ending receiver name are shown.

The possible library values are:

*LIBL: The library list is used to locate the journal receiver.
*CURLIB: The current library for the job is used to locate the journal receiver. If no library is specified as the current library, QGPL is used.
library-name: Specify the name of the library where the journal receiver is located.

Top

Output (OUTPUT)

Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.

The possible values are:

*: The output is displayed (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).

*PRINT: The output is printed with the job's spooled output.

Top

Examples

Example 1: Printing a Distribution Log

DSPDSTLOG   OUTPUT(*PRINT)

This command directs the distribution log information to the job's output spooling queue to be printed. If OUTPUT(*) is specified, and the command was entered from a work station, the information about the distribution log is shown at the work station.

Example 2: Getting a SNADS Distribution Log

DSPDSTLOG   ENTTYPE(*SYS)

This command directs the SNADS distribution log entries to be shown on the work station display for an interactive job, or printed with the job's spooled output for a batch job.

Top

Error messages

*ESCAPE Messages

CPF9845: Error occurred while opening file &1.
CPF9846: Error while processing file &1 in library &2.
CPF9847: Error occurred while closing file &1 in library &2.
CPF9850: Override of printer file &1 not allowed.
CPF9851: Overflow value for file &1 in &2 too small.

Top