This section describes the CA Spool commands, provides a syntax, and several usage examples.
Use the ABEND command to abnormally terminate the ESF system.
ESF initiates a termination sequence with a user abend 0001 and a dump. This command must only be used if a normal SHUTDOWN sequence cannot be completed.
The ABEND command has no operands.
This command has the following format:
ABEND
Use the AF command to release one or more held spool files to make them available for print processing.
This command has the following format:
AF{file_sequence_number | seq1-seq2}
Defines the sequence number of the requested release file.
Defines the sequence range of the files to be released.
Note: seq1 and seq2 are the specified file sequence range, where, seq1 must not be greater than seq2.
Example: 4-720
Example
This example releases the file with sequence number 354.
AF354
This example releases all the files in the range from 4 to 720.
AF4-720
Use the B command to initiate a backspace on a printer node.
This command has the following format:
B,nodename [,C | ,F | ,pagecount]
Defines the name of the printer to be backspaced.
The backspace value can be any one of the following:
Defines the backspace copy
Defines backspace the entire file
Defines page count in the range 1 through 999
Default: One page is assumed if no operand is specified for pagecount.
Example
This example backspaces the printer DEPTPRT1 by ten pages.
B,DEPTPRT1,10
Use this C command to cancel the current printing operation for a printer.
This command has the following format:
C,nodename
Defines the name of the printer to be canceled.
Note: If the printer operates in automatic-purge mode, the file is scheduled for purging. Otherwise, the file is marked as printed and retained for a specified number of hours.
Example
This example cancels the printer DEPTPRT1.
C,DEPTPRT1
Use this C command to cancel all files currently being sent or received through an NJE session.
This command has the following format:
C,njenode [.device]
Defines the name of the NJE node with which session all current activities must be canceled.
Defines the sessions with the device that are to be canceled.
After the cancel command is executed, the following events occur:
Example
This example cancels all active files on CMA2JES2.
C,CMA2JES2
This example cancels the file that is active on job receivers.
C,CMA2JES2.JR1
Use this C command to cancel the current receive process on a virtual printer.
This command has the following format:
C,vpiname [.session] [,V]
Defines the name of the virtual printer which must have its receiving activities canceled.
Defines the activities of the session that must be canceled.
Indicates that the Cancel command is directed to the virtual printer and not to the real printer.
Example
This example cancels files being received on VDPTPRT1.
C,VDPTPRT1
This example cancels files being received on VDPTPRT1.
C,VDPTPRT1,V
This example cancels files being received on VDPTPRT1 from sessions with TESTCICS.
C,VDPTPRT1.TESTCICS
Use this C command to cancel a TCP/IP LPD session.
This command has the following format:
C ,LPD,session
Specifies the name of the LPD session to be canceled. The entire session name need not be specified. A unique session name prefix is sufficient. All sessions matching the session name prefix are terminated.
Example
This example cancels current LPD session with remote TCP/IP host usany.our.com.
DA,LPD
ESF7061 ESF File 7481 ESFNUC (ANYPRINT /ANDNI02 ) from usany.our.com
- 0 Mbytes of 20 Mbytes ( 0%)
C,LPD,USANY
ESF7065 Session cancelled: usany.our.com
Use the CF command to change the status of a file from temporarily closed to permanently closed.
Note: The CF command can only be used on files with the temporarily closed status.
This command has the following format:
CFfile_sequence_number
Defines the file sequence number of the requested file.
Example
This example closes the file with sequence number 634.
CF634
Use the CHKPT command to force ESF to take a checkpoint.
This command has the following format:
CHKPT
Use the CSAR command to cancel all files currently being transferred through the CA View interface, and halt the CA View interface.
This command has the following format, with no operand:
CSAR
Use this D command to display the status of one or more display nodes.
This command has the following format:
D,{nodename | *ALL | *ACT | G=groupnumber},D
Examples
This example displays the status of all display nodes.
D,*ALL,D
This example displays the status of all active display nodes.
D,*ACT,D
This example displays the status of display node A55TU009.
D,A55TU009,D
Use this D command to display the status of one or more network nodes.
This command has the following format:
D,{nodename | *ALL | *ACT | G=groupnumber} [,N | ,P | ,V] [,PFX=] [,REL=] [,NUM=] [,ST=] [,C=] [,F=] [,G=] [,L=] [,Q=] [,U=] [,A2=] [,DT=] [,PQ=] [,PT=] [,TD=] [,TH=] [,TT=] [,CQ=] [,MQ=] [,CF=] [,CP=] [,CL=] [,CB=] [,MF=] [,MP=] [,ML=] [,MB=] [,TF=] [,TP=] [,TL=] [,TB=] [,S=] [,O=]
When displaying printer nodes, the "ST=status filter" field can be specified as any of the status names as shown on the display panel status field, such as DRAINED, ACTIVE, INACTIVE, or as NEVERUSED or NEVEROK.
For example, to display those printers that have not had any files queued or selected, a D,*ALL,P,ST=NEVERUSED command is issued.
To display those printers that have not had a file successfully printed, a D,*ALL,P,ST=NEVEROK command is issued.
Note: The printer use status of NEVERUSED and NEVEROK is maintained throughout the CA Spool cycle. For instance, the use status of printers is maintained across REINIT processing, but not across a cold or warm start of CA Spool. If you are using MAS or EMAS environment, the network control is switched to a different member and the use status of printers is lost.
When displaying virtual printer nodes, the "ST=status filter" must be specified as shown on the printer menu display only.
The C, F, L, Q, U, A2, DT, PQ, TD, TH, and TT filters apply only to printer nodes. Their length is limited to the length of the filtering attribute. The case of the filter matches the case of the attribute. For example, FCB's must always be in uppercase so the C filter is also an uppercase filter. Location can be mixed case so the L filter must match the case of the printer's location parameter.
The G, PT, CQ, MQ, CF, CP, CL, CB, MF, MP, ML, MB, TF, TP, TL and TB filters apply only to printer nodes. These filters are numeric.
Numeric filters, by default, show files whose attributes are greater than or equal to the value used as a filter. It is possible to show files whose numeric attribute value is less than the filter value by specifying a leading '<' in the filter, such as files whose priority values are '<9'. If a 'less than' filter is used in a numeric filter, the maximum number allowed is not always the highest possible value for the field. For example, the highest number that can be placed in the Port filter is 32767. The highest 'less than' filter for Port is <9999.
The G and PT filter lengths are limited to the length of the filtering attribute. The CQ, MQ, CF, CP, CL, CB, MF, MP, ML, MB, TF, TP, TL filter lengths are limited to the length of the filter in the menu display.
The valid values for S=Sort value parameter are equal to the filter parameters with one exception. For example, to sort on TCPHOST specify S=TH. The exception applies for sorting on destination. S=P sorts the printer name.
The O=Sort order parameter has two valid values: A for ascending and D for descending order.
Examples
This example displays the status of all printer nodes.
D,*ALL
This example displays the status of all active NJE nodes.
D,*ACT,N
This example displays the status of network node DEPTPRT1.
D,DEPTPRT1
This example displays the status of the first five printer nodes.
D,*ALL,NUM=5
This example displays the status of five printer nodes starting from the sixth printer node.
D,*ALL,REL=6,NUM=5
Use this D command to display the status of an NJE node session.
This command has the following format:
D,njenode,N
Defines the name of the NJE node for which the status must be displayed. The status of the NJE connection displays information about each file currently being sent or received by the NJE session.
Example
This example displays the status of the CMA2JES2 NJE node.
D,CMA2JES2,N
This D command displays the status of a virtual printer
This command has the following format:
D,vpiname,V
Displays the name of the virtual printer for which status must be displayed. The status of the connected physical printer displays with specific information about each existing session of the virtual printer.
Example
This example displays the VDPTPRT1 virtual printer status.
D,VDPTPRT1,V
Use this DA command to display the files active in the ESF system, including files opened for input or output processing, files being purged, files active on network printers, and so on.
This command has the following format, without any operands:
DA
Use this DA command to display all currently active TCP/IP LPD sessions.
This command has the following format:
DA,LPD
Example
DA,LPD
LPD7060 No active sessions
DA,LPD ESF7061 Request from usany.our.com - Receive LPD Daemon command
DA,LPD
ESF7061 ESF File 2049 LPDFILE (IBM4028X/ANDNI02 ) from 147.219.155.236
- 16 Kbytes of 78 Kbytes (20%)
Use the DC command to display the status of one or more communication channels.
This command has the following format:
DC [,cidname]
Specifies the name of a communication channel, and only the status of that channel is displayed.
Note: If no operand is specified, the statuses of all communication channels are displayed.
Example
This example displays the status of all communication channels.
DC
This example displays the status of the communication channel CICS.
DC,CICS
Use the DD command to display the DESTID settings for the selection criteria that you specify.
This command has the following format:
DD[Fnnnnnn] [,U=uuuuuuuu] [,D=dddddddd] [,Q=q] [,O=oooooooo]
Specify one or more operands. All operands are optional.
Important! If you specify the file sequence number operand, it must be the first operand. Also, see the explanation in first example after the parameter descriptions for information about optionally overriding the default behavior.
Specifies the sequence number of the file for DESTID display.
Specifies the userid for the DESTID display.
Specify a 1-8 character alphanumeric string. This operand specifies the highest priority selection criteria for the DESTID search.
Specifies the destination name for the DESTID display.
Specify a 1-8 character alphanumeric string. This operand specifies the second highest priority selection criteria for the DESTID search.
Specifies the output class for the DESTID display. The output class is a single character in the range A-Z or 0-9.
This operand specifies the third highest priority selection criteria for the DESTID search.
Specifies the filename for DESTID display.
The filename is a 1-8 character alphanumeric string.
This operand specifies the lowest priority selection criteria for the DESTID search.
Examples
The following example displays the closest matching DESTID setting when the only selection criteria is file sequence number 4.
By default, if the DD command specifies only a file sequence number, the number is looked up in the file queue and the selection criteria (user id, destination, class, and filename) are taken from the actual file you selected. In this example, they are taken from file 4, before the search for the specified DESTID occurs.
However, you can optionally override this default behavior by specifying the selection criteria as the next parameters. For example, you can specify DDF4,Q=B,D=RADEK to override the class and destination selection criteria of file 4 before the search for the specified DESTID occurs.
DDF4 ESF890 DESTID QDEST=AFPEMLPD, ESF890 FADDRES1=MSGTYPE=TEXT, ESF890 FADDRES2='SUBJECT=EMAIL TEST', ESF890 FADDRES3=TO=RADEK, ESF890 FADDRES4=FILENAME=&FNM.PDF ESF890 END-OF-DISPLAY
The following example displays the closest matching DESTID setting when the selection criteria are file sequence number 12 and destination and user ID file attributes. The file sequence number overrides the additional selection criteria.
DDF12,D=B54131DA,U=B54131UA ESF890 DESTID QUSERID=B54131UA, ESF890 QDEST=B54131DA, ESF890 FDEST=DEST2 ESF890 END-OF-DISPLAY
The following example displays the closest matching DESTID setting when the only selection criteria is destination B54131DB.
DD,D=B54131DB ESF890 DESTID QDEST=B54131D*, ESF890 FDEST=DEST7 ESF890 END-OF-DISPLAY
The following example displays the closest matching DESTID setting when the selection criteria are user ID B54131UB and destination B54131DC.
DD,U=B54131UB,D=B54131DC ESF890 DESTID QUSERID=B54131U*, ESF890 QDEST=B54131DC, ESF890 FDEST=DEST6 ESF890 END-OF-DISPLAY
The following example displays the closest matching DESTID setting when the selection criteria are user ID B54131UA, destination B54131DA, class A, and filename B54131FA.
DD,U=B54131UA,D=B54131DA,Q=A,O=B54131FA ESF890 DESTID QUSERID=B54131UA, ESF890 QDEST=B54131DA, ESF890 QCLASS=A, ESF890 QFNAME=B54131FA, ESF890 FDEST=DEST4 ESF890 END-OF-DISPLAY
Use the DF command to display the status of one or more files. Files can be selected using the optional operands. If a file sequence range is specified, seq1 must be not greater than seq2.
This command has the following format:
DF[file_sequence_number | seq1-seq2] [,O=] [,D=] [,Q=] [,F=] [,C=] [,FQE] [,NOESTAT] [,NUM=] [,REL=] [,TOTAL]
One or more operands can be used. If no operands are specified, the status of all the files in the ESF system is listed.
Defines the sequence number of the requested release file.
Defines the sequence range of the files to be released.
Specifies the filename to be used for file selection.
The filename is a 1 through 8 character alphanumeric string. If an asterisk (*) represents any character, the corresponding position of the filename is considered to match the selection being performed. This enables a generic search.
Specifies the FCB name to be used for file selection. The FCB name is an alphanumeric string with one to four characters.
Specifies the file destination name to be used for file selection. The destination name is an alphanumeric string with one to eight characters.
Specifies the form number to be used for file selection. The form number is an alphanumeric string with one to eight characters.
Replies must be unformatted file queue elements. These elements contain hexadecimal characters that cannot be displayed. This operand is used only from the MENU system.
Specifies that files with E (end-of-file) status are not displayed.
Specifies the number of replies wanted. The operand must be numeric, and in the range 1 through 999999.
Specifies the output class to be used for file selection. The output class is a single character in the range A-Z or 0-9.
Specifies the first file to be displayed relative to the first file that satisfies the rest of the operands. For example, if REL=6 is specified, the sixth file that satisfies the rest of the operands is the first to be displayed.
Specifies the total number of files satisfying all operands specified is indicated in the heading of the reply messages.
Examples
This example displays files with filename RTEST001 and file output class P.
DF,O=RTEST001,Q=P
This example displays file with file sequence number 512.
DF512
This example displays files in the range from 19 to 341.
DF19-341
This example displays all files with a filename starting with SYS.
DF,O=SYS*****
This example displays files in the range 15 through 330 with a file name length of 6 or less, positions 3-5 being DPS, in class A.
DF15-330,O=**DPS*.,Q=A
This example displays the first five files in the spool.
DF,NUM=5
This example displays five files starting with the sixth file in the spool.
DF,REL=6,NUM=5
Use this DS command to display the status of the ESF system.
This command has the following format:
DS
ESF displays the following:
Use this DS command to display the status of the LPD Interface.
This command has the following format:
DS,LPD
The LPD Interface displays the following:
Example
This example displays the status of the LPD interface.
DS,LPD ESF7070 CA LPD V12.0 SP00 ESF7071 Total sessions: 9 Active sessions: 0 Max sessions: 20 ESF7072 LPR requests: 9 LPQ requests: 0 LPRM requests: 0 ESF7073 ESF files: 9 SAR files: 0 JES files: 0 ESF7074 Text files: 0 AFP files: 0 PCL files: 9 ESF7075 Bin files: 0 PS files: 0 ESF7076 Total Kbytes: 1130 Total records: 0 Total pages: 89 ESF7079
Use this DS command to display the active Functional Subsystem address spaces.
This command has the following format:
DS,FSS
Example
This example displays the active Functional Subsystem address spaces.
DS,FSS
ESF869 ACTIVE FSS NAME=FSSTEST5, PROC=PSFTEST5, FSSID=00001 ESF869 FSS-DEF./CONN. 5/ 1 FSA-DEF./ACT. 9/ 3
Use this DS command to display the active Functional Subsystem address spaces and Functional Subsystem Applications.
This command has the following format:
DS,FSA
Example
This example displays the active Functional Subsystem address spaces and Functional Subsystem Applications.
DS,FSA ESF869 ACTIVE FSS NAME=FSSTEST5, PROC=PSFTEST5, FSSID=00001 ESF869 ACTIVE FSA NAME=PRT81 , PROC=PSFTEST5, FSAID=00005 ESF869 ACTIVE FSA NAME=PRT82 , PROC=PSFTEST5, FSAID=00007 ESF869 ACTIVE FSA NAME=PRT83 , PROC=PSFTEST5, FSAID=00008 ESF869 FSS-DEF./CONN. 5/ 1 FSA-DEF./ACT. 9/ 3
Use the DX command to display the status of the file transfer subtask and the two automatic file transfer interfaces.
This command has the following format:
DX
Use the E command to discontinue printing a file, then continue printing from the start of the file.
This command has the following format:
E,nodename
Defines the name of the printer to be restarted.
Example
This example restarts printer DEPTPRT1.
E,DEPTPRT1
Use the ESYS command to restart or reset the specified ESF system in a Multi-Access Spool (MAS) configuration.
This command has the following format:
ESYS {,system-id | ,RESET=system-id}
Restarts (on this system) the file processing which was being performed on the named system in the MAS configuration.
Resets the checkpoint data set lock if another member of the MAS configuration failed while it was holding the checkpoint lock.
Note: system-id must be the name of a system in the MAS configuration.
Examples
This example restarts system A158 on this system.
ESYS,A158
This example resets checkpoint data set lock held by system A158.
ESYS,RESET=A158
Use the F command to initiate a forwardspace on a printer node.
This command has the following format:
F,nodename [,C | ,F | ,pagecount]
Defines the name of the printer to be forwardspaced.
The forwardspace value can be one of the following:
Defines that the current copy is forwardspaced.
Defines that the entire file is forwardspaced
Defines the page count in the range of 1 to 9999.
Note: If no operand is specified, a default of one page is assumed.
If the forwardspace passes end-of-file, the file is backspaced ten pages from end-of-file, and printing continues from that point.
Example
This example forwardspaced the printer DEPTPRT1 by ten pages.
F,DEPTPRT1,10
Use the HF command to hold one or more spool files; held files are unavailable for print processing.
This command has the following format:
HF{file_sequence_number | seq1-seq2}
Defines the sequence number of the requested file to be held.
Defines the sequence range of the files to be held.
Note: seq1 and seq2 are the specified file sequence range, where, seq1 must not be greater than seq2.
Example
This example holds the file with sequence number 636.
HF636
This example holds all the files in the range from 17 to 123.
HF17-123
Use the HS command to disable the SUBSYS-parameter interface.
If the interface is currently busy, active files are allowed to complete processing. No new interface requests are allowed after this command is activated (no new files can be opened for read or write by any users).
This command has the following format:
HS
Use the HSAR command to halt the CA View interface.
If the interface is busy, the interface is not halted until it completes all the currently active file transformations.
This command has the following format:
HSAR
Use the HT command to halt the Transformer interface.
If the interface is busy, the interface is not halted until it completes all the currently active file transformations.
This command has the following format:
HT
Use the HX command to halt the XFER Interface.
Note: If the interface is busy, the interface is not halted until it completes transfer of the current file.
This command has the following format:
HX [,ESFTOJES | ,JESTOESF]
Use the I command to interrupt a printer and discontinue printing a file.
This command has the following format:
I,nodename
Specifies the name of the printer to be interrupted. Current activity on the specified printer is terminated and the file is returned to the output queue. The printer remains active (unless stopped or halted) and selects a new file for printing (if any are available in the queue). It is possible that the same file is selected for printing again unless the file has been held. When the interrupted file is later selected for print processing, it is backspaced one or more pages.
Example
This example interrupts the printer DEPTPRT1.
I,DEPTPRT1
Use the LOGOFF command to terminate the session between the operator terminal and ESF.
This command has the following format:
LOGOFF
The operator terminal is disconnected from ESF and returned to VTAM.
Use the LOGON command to gain access to ESF through VTAM.
Note: This command usage is installation-dependent.
This command has the following format:
LOGON APPLID(applid) [LOGMODE(logmode)] [DATA(logondata)]
Specifies the VTAM application name for ESF. This name is typically ESF. It is specified in the APPLID statement in the ESF parameter data set.
Defines the information in the user's logon mode table. See ESF Installation for coding directions for the MODEENT macro.
Specifies the data to be passed to ESF. This can be the userid/password.
Use this command to display the name and status of each system in a Multi-Access Spool (MAS) configuration.
This command has the following format:
LSYS
Use the M command to send a message to one or more network nodes.
This command has the following format:
M,{nodename | G=groupnumber | *ALL | *O},‘msg’
Specifies the name of an active display node or communication channel which is to receive the message.
Specifies a valid network number. If the keyword sequence G=groupnumber is specified, the message is sent to all active display nodes and communication channels in the specified network group.
Specifies that the message is sent to all active display nodes and communication channels. Only users with the EXCMD attribute or AUTH=2 can use this.
Specifies that the message is sent to the MVS system console and all other ESF system operators. This includes communication channels with system operator authorization.
Specifies the actual message to be sent. The actual message must follow the message destination specification, and it must be enclosed in single quotes if it contains blanks or quotes. If the message itself contains single quotes, they must be specified as two single quotes.
Examples
This example sends a message to network node RTEST001.
M,RTEST001,'PLEASE LOGOFF - IT'S LUNCH TIME'
This example sends a message to all active sessions.
M,*ALL,'PLEASE LOGOFF - ESF SHUTDOWN IN 5 MIN'
Use the MENU command to enter the CA Spool menu from a CA Spool console dialog.
The menu system primary selection panel is displayed on the terminal. If PF4 (RETURN) is entered in the Menu system, the terminal returns to the normal CA Spool console dialog.
This command has the following format:
MENU
Use the P command to terminate the ESF session with a printer node, or terminate a virtual printer.
This command can be used if you must release the printer for use by other applications. To stop the printer temporarily while retaining the connection with ESF, use the Z command.
This command has the following format:
P,nodename
Specifies the name of the printer node or the virtual printer.
The node is scheduled for termination, which means that when all active work has been completed, the node terminates its session with ESF. If the node is a virtual printer and it has a session with another system, a LUSTAT with sense 0831 (shutdown) is sent, and the system waits to receive the unbind command.
Example
This example stops the node DEPTPRT1.
P,DEPTPRT1
Use this P command to terminate the session with another NJE node.
This command has the following format:
P,njenode[.device]
Specifies the name of the NJE node with which the session must be terminated. The NJE session is scheduled for termination, which means, that when all active work has been completed, the VTAM session with the node is terminated.
Specifies the session with this specific device is terminated.
Example
This example stops the session with CMA2JES2.
P,CMA2JES2
This example stops Job transmitter 1 in session with CMA2JES2.
P,CMA2JES2.JT1
Use this P command to terminate the session between a virtual printer and an application.
This command has the following format:
C,vpiname[.session] [,V]
Defines the name of the virtual printer with which sessions must be terminated.
Indicates if a VPSOPT=6 parameter is specified. This allows the virtual printer name and the real printer name to be the same. It also indicates that the Stop command is directed to the virtual printer and not the real printer.
The virtual printer session will be scheduled for termination, which means that when all active work has been completed, the VTAM session with the node is terminated.
Defines the activities of the session that must be terminated. It also specifies the name of the controlling application, automatic startup of a session with this application will not take place again until an S command has been issued.
Example
This example terminates the session with VDPTPRT1.
P,VDPTPRT1
This example terminates session with VDPTPRT1.
P,VDPTPRT1,V
This example stops files being received on VDPTPRT1 from sessions with TESTCICS.
P,VDPTPRT1.TESTCICS
Use the PC command to stop a communication channel, and prevents user programs from opening the channel.
This command has the following format:
PC,cidname [,F]
Specifies the name of the communication channel to be stopped.
If a user program has opened the channel and the stop command is issued without the F (force) operand, a normal (slow) communication end (CEND) is scheduled for the user. If a user program has opened the channel and the stop command is issued with the F operand, an abnormal (fast) CEND is scheduled for the user.
Examples
This example stops communication channel CICS1.
PC,CICS1
This example stops communication channel POP1 with force.
PC,POP1,F
Use the PD command to immediately purge all files which have been E-marked.
This command has the following format:
PD
Use the PF command to purge files in the ESF system, and releases spool space, control blocks, and so on.
This command has the following format:
PF{file_sequence_number | seq1-seq2 | ALL [,O= | ,D=]}
Defines the sequence number of the requested file to be purged.
Defines the sequence range of the files to be purged.
Note: seq1 and seq2 are the specified file sequence range, where, seq1 must not be greater than seq2.
Defines all files in a specified file range to be purged. This keyword requires specification of the D= or O= parameters also.
If the O= parameter is specified only files in the specified file range matching the specified file name is purged.
If the D= parameter is specified only files in the specified file range matching the specified file destination name is purged.
Example
This example purges file with sequence number 354.
PF354
This example purges all files in the range from 4 to 720.
PF4-720
This example purges all files with destination OLDPRT01.
PFALL,D=OLDPRT01
This example purges all files with a filename starting with SYS.
PFALL,O=SYS*****
Use the PFSS command to stop a functional subsystem address space.
This command has the following format:
PFSS,{fssname | *ALL} [,F]
Defines the name of a Functional subsystem
Defines if all Functional subsystems must be stopped. The shutdown is deferred until active print files have been printed, unless the F option is specified.
Defines that the address space is terminated immediately, and an abend S027 RC 7B can be expected in the FSS address space.
Use the PNET command to initiate a slow halt of the network interface, virtual printer interface, LPD Interface, and NJE TCP/IP server.
No new logons and session requests are accepted, and the VTAM ACB is closed as soon as all of the active network sessions have been terminated.
This command has the following format:
PNET [,VPS | ,LPD |.NJES|,NETOWNER=ssss]
Halts the virtual printer interface.
Halts the LPD Interface.
Halts the NJE TCP/IP server.
Defines the EMAS system ssss as the EMAS Network Owner.
If no Operands are specified, the Network Interface, the VPS Interface, the LPD Interface, and the NJE TCP/IP server are all drained.
Use the R command to repeat printing of a file.
The repeat command causes a new copy of the file to be printed. If the original print command was for three copies of the file, then a total of four copies will be printed after a single repeat command.
The repeat command simply increments a counter in the printer's device control block, scheduling a reprint of the file. This means that the repeat command is discarded and ignored if the printing is interrupted.
This command has the following format:
R,nodename
Defines the name of the printer which is to repeat printing.
Example
This example repeats the printer DEPTPRT1.
R,DEPTPRT1
Use the REINIT,MODULES command to provide an alternative method to force modules ESFSSSM, ESFUSO, and ESFUSS to be reloaded into ECSA at the next CA Spool startup.
The normal method to force a new version of ESFSSSM, ESFUSO, and ESFUSS to be loaded into ECSA is to rename the respective module to a new name and then to specify the new name on the MODULES parm statement. Using this method means that the SMP environment might not reflect the current module names for those modules that were renamed.
Appropriate ESF888 messages are produced to indicate the status of module refresh commands. An ESF022 message is issued if new versions of modules ESFSSSM, ESFUSO, and ESFUSS are loaded into ECSA at CA Spool startup, as a result of a pending module refresh request from the prior CA Spool cycle.
The syntax is as follows:
REINIT,MODULES,{ON | OFF}
Note: If you specify neither an ON or OFF parameter, the command is considered invalid. There is no default value. If the command is invalid, no action occurs.
Examples:
This example refreshes the ECSA modules ESFSSSM, ESFUSO, and ESFUSS are scheduled for the next CA Spool startup.
REINIT,MODULES,ON
This example cancels the pending ECSA refresh.
REINIT,MODULES,OFF
Use the REINIT Command to read all the CA Spool parameter deck again and reconfigures the NODE, DEFNODE, USERID, NJE, MESSAGE, DESTID, SAFAT, SAFDEF, SAFUID, SAR, SPOOLDS, and SAFTYPE definitions.
Note: Changes to all other CA Spool initialization parameters not mentioned previously require a CA Spool restart. A COLD start is required if CHKPTDS, MAXFSEQ, NUMFQES, PGNLEN, SID or Snn parameters are changed. A FORMAT start is required if BUFIZE is changed.
If the LPD Interface is active, the LPD Interface reconfigures the LPDSERV default LPDDEST parameter values and all the LPDDEST and LPDFILE definitions. Changes to the LPDSERV parameters TCPPORT and TCPNS do not take effect until CA Spool is restarted.
If External Security and security changes are made that must take effect immediately, issue REINIT to maintain the in-core, and refresh the External Security definitions.
If using AFP Transfomers, issue REINIT to:
If using Java Transformers, issue REINIT to:
The syntax is as follows:
REINIT [,*(member) | ,dsname[(member)] | ,LPD | ,FSS [,fssname | ,*ALL]]
Note: If no value or * is specified, the original ESFPARM data set is used.
Reinitializes the specified member in the original data set.
Reinitializes the specified data set.
Reinitializes the LPD Interface.
Reinitializes the Java Transformers.
Reinitializes the specified Java Transformer Functional subsystem.
Reinitializes all Java Transformer Functional subsystems.
Changes to NODE parameters are not updated during REINIT processing. Users can modify these parameters in the menu system or through the T Reset Printer command.
Use the REINIT,PRT command to change the specified attributes of one or more printers without reinitializing all of the CA Spool parameters that the REINIT - Reinitialize ESF - command processes. You can change the attributes of a single printer, a group of printers, or all printers.
The syntax is:
REINIT [,PRT [,*ALL | ,printername | ,GROUP=nnn]]
Default: None
The ESF881 message indicates the status of the REINIT,PRT command. CA Spool checks the syntax of all DEFNODE and NODE statements that the command affects. CA Spool reports syntax errors and duplicate definitions even if the incorrect definitions are not the target of the REINIT,PRT command.
If you enter incorrect syntax or incorrect definitions, the command is considered invalid, and no action occurs.
Use the RF command to change the file name and the destination name for one or more spool files, or requeue a file for printing.
The syntax is as follows:
RF{file_sequence_number | seq1-seq2 | ALL} [,O=][,D=][,F=][,NO=][,ND=][,NT=]
Note: The RF command requires the file sequence number, the seq1-seq2, or the keyword ALL (route only).
Defines the sequence number of the requested file to be routed/requeued.
Defines the sequence range of the files to be routed/requeued.
Note: seq1 and seq2 are the specified file sequence range, where, seq1 must not be greater than seq2.
Defines all files to be routed.
Note: For the RF command to be interpreted as a requeue command, no operands except the sequence number (or sequence number range) can be specified.
The following operands apply to the RF command as a route command only.
Defines the old name of the file.
Defines the old destination name of the file.
Defines the old form name of the file.
Defines the new filename to be assigned to the file.
Defines the new destination name to be assigned to the file. If the new destination name is a valid JES destination (or INTRDR), the file is queued for transfer to that destination.
Initiates AFP-to-PDF transformation and store the resulting PDF output in the HFS specified by A2PDPARM FdOutput parameter.
Important! All operand values are alphanumeric strings with 1 to 8 characters.
A re-queue command (no old or new operands) to a file which has been printed once causes the removal of the flag which indicates that the file has been printed; this makes the file again eligible for output selection. If the keyword ALL is specified, both one or more old operands and one or more new operands are required. In other cases (RFnnn or RFnnn-mmm) only one or more new operands are required. This also implies that a re-queue command in the format RFALL is invalid. If a file which has been marked as printed is routed to the same or another destination, or is re-queued (no operands on command), the printed status is removed, and the file is eligible for selection at the new destination.
Examples
This example routes file 2176 from filename RTEST002 to filename RTEST003, and alter the destination name to DEPTPRT1.
RF2176,O=RTEST002,NO=RTEST003,ND=DEPTPRT1
-or-
RF2176,NO=RTEST003,ND=DEPTPRT1
This example routes all files from destination DEPTPRT1 to destination DEPTPRT2.
RFALL,D=DEPTPRT1,ND=DEPTPRT2
This example re-queues all files in the range from 14 to 62.
RF14-62
This example re-queues all files.
RF1-65535
Use this S command to start a halted or drained printer.
This command has the following format:
S{,nodename [,Q | ,NQ | ,F]} | {,*ALL,ST=EDRAINED}
Defines the name of the printer to be started. The Q or NQ operand only applies if the printer node is not in session with ESF at the time of the start command.
Example
This example starts printer DEPTPRT1.
S,DEPTPRT1
Use the S command to start a VTAM session with another NJE node.
This command has the following syntax:
S,njenode [.device]
Defines the name of the NJE node with which the session must be started. The NJE node must be defined in the CA Spool initialization parameter deck through an NJE parameter definition. If the NJE node is already in session with CA Spool, but halted (because of a halt command), then the transfer of files resumes.
Defines the device which must be started.
Example
The following are two examples of this command:
S,CMA2JES2 S,CMA2JES2.JR1
Use this S command to reactivate a virtual printer for which an S command has been issued.
This command has the following syntax:
S,vpiname [,V]
Defines the name of the virtual printer to be reactivated. If a controlling application has been specified, CA Spool initiates a session between the virtual printer and the controlling application.
allows the virtual printer name and the real printer name to be the same. The V operand indicates that the Start command is directed to the virtual printer and not the real printer.
Note: The V operand can be used if a VPSOPT=6 parameter is specified.
Examples
The following is an example of this command:
S,VDPTPRT1
This example starts virtual printer VDPTPRT1:
S,VDPTPRT1,V
Use the SC command to start a communication channel and allow user programs to open the channel.
This command has the following format:
S,cidname
Defines the name of the communication channel to be started.
Examples
This example starts communication channel POP2.
SC,POP2
Use the SHUTDOWN command to initiate a normal termination sequence of the ESF system; then, ESF no longer accepts any open-file requests.
When all currently open files have been closed and the VTAM interface is stopped, ESF terminates execution. The SNET, PNET, and TNET commands control the VTAM interface. If one or more ESF resource clean-ups have failed, it can be necessary to abnormally terminate ESF by using the ABEND command or the OS Cancel command.
This command has the following format:
SHUTDOWN [,F]
Forces ESF to terminate, disregarding open files.
Use the SNET command to start the network interface, virtual printer interface, LPD interface, and NJE TCP/IP server, if configured.
This command has the following syntax:
SNET [,VPS | ,LPD | ,NJES | ,NETOWNER=ssss]
Starts the virtual-printer interface.
Starts the LPD interface.
Starts the NJE TCP/IP server.
Defines the EMAS system ssss as the EMAS Network Owner.
Use the SS command to enable the SUBSYS parameter interface.
This command has the following syntax:
SS
Use the SSAR command to start the CA View interface.
This command has the following syntax:
SSAR [,sarname]
Defines the operand that can be used to overwrite the SAR database name used by the CA View interface.
Example
This example starts the CA View interface with a new SAR report database named SAR.SYSTEM2.
SSAR,SAR.SYSTEM2
Use the ST command to start the Transformer interface.
This command has the following syntax:
ST
Use the SX command to start the automatic file transfer (XFER) interfaces.
This command has the following syntax:
SX [,ESFTOJES | ,JESTOESF]
Defines the ESFTOJES file transfer interface that is started.
Defines the JESTOESF file transfer interface that is started.
Note: If no operand is specified, then both the ESFTOJES and the JESTOESF file transfer interfaces are started.
Use the T command to alter a printer's selection and processing characteristics.
This command has the following syntax:
T,nodename{ [,A=] [,C=] [,F=] [,P=] [,Q=] [,R=] [,S=] [,T=] [,N=] [,IP=] }
Defines the name of the printer node.
Printer options can only be changed when the printer is inactive, halted, or drained.
Defines whether the printer must operate in automatic-selection mode.
Specify A=Y if yes, A=N if no.
Automatic-selection mode means that the print processor scans the file queue for a printable file with setup characteristics matching the printer's current setup. If none is found, a file with a valid output class is selected, and appropriate setup messages issued.
If A=N is specified, the user must explicitly change the printer setup characteristics, using the F, C, and Q operands. The print processor does not automatically change the device setup.
Defines the 1 to 4 character FCB name to be assigned to the printer.
If this operand is used when the printer is in automatic selection mode, and if there is no file eligible for printing with the specified FCB name, the automatic file selection results in this specification being ignored.
Defines the 1 to 8 character form number to be assigned to the printer.
If this operand is used when the printer is in automatic-selection mode and if there is no file eligible for printing with the specified form number, the automatic file selection results in this specification being ignored.
Defines whether the printer must operate in automatic-purge mode.
Specify P=Y if yes, P=N if no. Automatic-purge mode causes the files which have been printed to be automatically scheduled for purge processing. If the printer does not operate in automatic-purge mode, the files are marked as printed.
Defines the output classes, from one to eight, which are to be serviced by the printer. Each class is specified as a single character in the range A-Z or 0-9, or ALL if ALL was specified on the DEFNODE/NODE statement.
If the printer operates in automatic-selection mode, the file queue is scanned using the printer classes from left to right, and the printer setup characteristics as arguments. If no files are selected, the file queue is re-scanned using only the printer's output classes left to right as selection criteria.
If the printer does not operate in automatic-selection mode, the file queue is scanned using the printer-setup characteristics and the printer classes left to right as selection criteria.
Defines whether the printer must operate in restricted-selection mode.
Specify R=Y if yes, R=N if no. If a printer operates in restricted-selection mode, only files with destination names that match the printer's node name or alias name are eligible for selection.
Defines the number of separator pages to be produced before each print file.
The value of S can be 0, 1, or 2.
Defines the name of the translation table to be used for data translation on this printer.
If the T operand is specified without a value, then no translation takes place on this printer.
Defines the name of the NJE destination, to which the files must be transferred. This can also be used to route files to another printer within the same CA Spool system by specifying the printer name.
Defines the symbolic name or IP address of the target TCP/IP host.
Example
This example changes the options for the printer DEPTPRT1.
T,DEPTPRT1,A=N,F=STD2,C=6,P=Y
Use the TF command to change a file's output class, output priority, FCB name, form number, copies, or system affinity.
This command has the following format:
TFfile_sequence_number{ [,C=] [,F=] [,N=] [,P=] [,Q=] [,S=*ANY | system-id] [,PAGE=start [/number]] [,RETAIN=] [,CH=ch1 | (ch1,…,ch4)] [,LC=] [,WR=] [,FD=] [,PD=] [,SAR=A | B | X | N] [,ND=] }
Defines new FCB name. It must must be 1 to 8 characters in length.
Defines new form number. It must be 1 to 8 characters in length.
Defines new number of copies. It must be a number in the range 1 to 255.
Defines new output priority. It must be a number in the range 0 to 15.
Defines new output class. It must be a single alphanumeric character, in the range A-Z or 0-9.
Defines new system-affinity identifier. The system-affinity identifier can be one of the following:
Defines partial print. The start page number must be in the range 0-65535. If the starting page is zero, the printing will start from the beginning of the file. The number of pages to print must be in the range 0-255. If number of pages is zero, the printing will continue from the starting page to end-of-file.
Defines the number of hours to retain the file. It must be in the range -1 to 8760. If the value is -1, the file will be purged immediately after it is printed.
Defines characters used. A maximum of four characters with a length of 4-bytes may be specified.
Defines the line count (for NOCC files). It must be a number in the range of 1 to 255.
Defines new remote destination in a receiving NJE system.
Defines new formdef. The formdef parameter must be 1 to 6 characters in length.
Defines new pagedef. The pagedef parameter must be 1 to 6 characters in length.
Defines SAR processing option and can have any of the following values:
Defines new destination. It must be 1 to 8 characters in length. If the new destination is a valid JES destination (or INTRDR), the file is queued for transfer to that destination.
Example
This example changes output class to N and output priority to 12 for file 276.
TF276,Q=N,P=12
Use the TNET command to reset the network interface, virtual printer interface, LPD interface, and NJE TCP/IP server.
All active sessions are interrupted immediately, and the VTAM ACB is closed to drain the VTAM interface.
This command has the following syntax:
TNET [,VPS | ,LPD | ,NJES | ,NETOWNER=ssss]
Halts the virtual printer interface.
Halts the LPD interface.
Halts the NJE TCP/IP server.
Defines the EMAS system ssss as the EMAS Network Owner.
Note: If no operands are specified, the network Interface, VPS Interface, LPD Interface, and NJE TCP/IP server are all interrupted immediately.
Use the TV command to control trace activity, and the controlling application, for virtual printers.
This command has the following syntax:
TV,nodename [.*ALL | .*STOP | .session] [,C=]
Defines the name of the virtual printer node.
Activates tracing for all sessions.
Terminates the active trace.
Activates a trace for the session specified. The session name is the online applications APPLID.
Specifies a controlling application. This means that CA Spool tries to establish a session between the virtual printer and the controlling application even if no work is currently pending.
The output from an activated trace goes to a CA Spool file automatically opened by the trace facility. Information about this file is available by issuing the D command for the virtual printer.
Examples
This example activates tracing for a session with the TESTCICS application.
TV,DEPVPRT1.TESTCICS
This example terminates the trace.
TV,DEPVPRT1.*STOP
This example sets the application TESTCICS as the controlling application.
TV,DEPVPRT1,C=TESTCICS
Use the WRITELOG command to close the current ESF system log file, and to allocate and open a new log file.
The WRITELOG command is valid only if the LOG option has been specified (or assumed by default) at initialization time. The WRITELOG command causes the current ESF system log file, which is a spin-off SYSOUT file, to be released for JES print processing. The system does not delete previous log files. Installations can remove old log files to preserve space.
Note: If you are using JES3 and if you specify both XFEROPT=17 and LOGHOLD=YES, then LOGDEST is used as a WRITER instead of a DEST value when the ESFLOG sysout is allocated.
This command has the following format:
WRITELOG
Use this Z command to halt the activity on an NJE session temporarily, but without terminating the VTAM session.
This command has the following syntax:
Z,njenode [.device]
Defines the name of the NJE node with which the file transfer activity must be halted.
Defines that the command takes effect only on the specific device.
Note: The S command can be used to resume file transfer on the NJE session.
Example
The following is an example of this command:
Z,CMA2JES2 Z,CMA2JES2.JR1
Use this Z command to halt a printer and prevents it from selecting new files.
This command has the following syntax:
Z,nodename
Defines the name of the printer node to be halted.
When the printer has completed printing the current file (if any), it enters the halted state and will no longer select files for output processing. The printer does not terminate its session with ESF but merely enters a logical "waiting for work" state. A printer which is halted can have its processing characteristics changed (see T command). The printer also enters halted state when it has a pending from setup. The printer can be started again using the S command.
Example
This example halts the printer DEPTPRT1.
Z,DEPTPRT1
Use this Z command to halt the activity on a virtual printer temporarily, but without terminating the VTAM session. Prevents the establishment of additional sessions.
After this command has been issued, all session requests from any application for this virtual printer will be queued by VTAM until an S command is issued for the virtual printer. At this time, all pending requests are resumed.
This command has the following syntax:
Z,vpiname [,V]
Defines the name of the virtual printer, which must be halted.
Defines that this operand can be used if a VPSOPT=6 parameter is specified. This allows the virtual printer name and the real printer name to be the same. The V operand indicates that the Halt command is directed to the virtual printer and not the real printer.
Example
The following is an example of this command:
Z,VDPTPRT1
Halt virtual printer VDPTPRT1:
Z,VDPTPRT1,V
|
Copyright © 2015 CA Technologies.
All rights reserved.
|
|