VMTWAITR Commands
VMTWAITR accepts and processes commands that arrive as the message text with the CP SMSG command. A VMTWAITR command consists of a command name followed by one or more positional operands. One or more blanks must separate each entry in the command line unless otherwise indicated.
micsrm140cd
VMTWAITR accepts and processes commands that arrive as the message text with the CP SMSG command. A VMTWAITR command consists of a command name followed by one or more positional operands. One or more blanks must separate each entry in the command line unless otherwise indicated.
Notational Conventions
In the command formats shown below, uppercase letters represent the shortest version of the command that you can enter. Lowercase letters and words that appear in the command format box represent variables for which specific information should be substituted. Uppercase letters and words and the symbols other than those described below should be entered as specified in the format box.
The following symbols are used to define the command format and should never be typed when the actual command is entered:
< >
Denotes options that may be specified or omitted.
|
Denotes choices, one of which MUST be selected.
+ +
| |
+ +
Denotes choices, one of which MAY be selected.
...
Denotes that the preceding item or group of items may be coded more than once in succession.
TRANSFER - Initiate the Data Transmission
Use the TRANSFER command to start transmitting data.
TRANSFER Format
+ + TRAnsfer datatype | <fn ft> < ( option > | | | | <fn ft <fm>> ( NOLINK | + + option: FROM userid cuu <PASSWORD readpass>
Operands
datatype
Indicates the type of data to be transmitted. Valid values are:
ACCOUNT
initiates the VM Account data transfer function
CAVMACT
initiates the
VM:Account
data transfer functionMONXA
initiates the VM/ESA and z/VM Monitor data transfer function
NETDATA
initiates the VM Network data transfer function
POWER
initiates the VSE/POWER Account data transfer function
ERDS
initiates the Error Recording data transfer function
fn ft
fn ft is the file identifier of input data to be transferred. The VM Data Transfer Program locates this file from the minidisk that has been defined on the corresponding data parameter menu. If you use the optional FROM statement, the minidisk address and the owner userid you specify are used to search the file.
The INPUT DISK FILE MODE parameter on the Common Transfer Parameters menu determines the file mode with which the VM Data Transfer Program accesses the data disk.
fn ft <fm> ( NOLINK
specifies the file identifier of input data to be transferred. Access to this file does not require the VM Data Transfer Program to locate the data disk prior to its transmission. When fm is omitted, the file mode A is assumed. If fm is specified as an asterisk (*), all accessed disks are searched for the file.
FROM userid cuu <PASSWORD readpass>
Indicates where the VM Data Transfer Program locates the input data file. The userid is the user identifier whose system entry contains the data disk, and cuu is the virtual address of the data disk as defined in the specified userid's entry in the system directory.
The PASSWORD readpass is the read access password of the data disk. The readpass is a one to eight character string that must be the read access password of the specified data disk as defined in the system directory for the userid that you specified above. This operand must be omitted if no password is defined.
Corequisites
If you use the TRAnsfer command, you must code the following in VMTFDEF:
datatype.INPUT section: ec = INPUTDEF(dtype,signal,suffix) exit ec datatype.TERMINATE section: ec = Cleanup(dtype,info) exit ec
where datatype is one of the data types listed above. See Section 10.2.1 for instructions on modifying VMTFDEF.
Usage Notes
- The TRANSFER command triggers VMTXMIT to transmit data. VMTXMIT examines the type of transfer function, then calls the corresponding input exit at VMTFDEF for input data allocation. It passes the operands of the TRANSFER command to VMTFDEF, whose INPUTDEF routine builds the data definition for the INPUT DDname. At the end of the transfer process, VMTFDEF is called again for resource deallocation, which is performed by the CLEANUP routine.
- Use the TRANSFER command to transmit data immediately after it is cut.To delay data transfer, use the INPUTDD command to define the data source after it has been created. Then, at a prescheduled time, issue the TRANSFER command without input file entry, thereby starting the transmission for the data source defined by the INPUTDD command.
- The file mode used to access a data disk is determined by the INPUT DISK FILE MODE parameter on the Common Transfer Parameters menu. The INPUT DISK FILE MODE is used to access the data disk if it is a letter within A and Z. If the INPUT DISK FILE MODE is coded with an asterisk (*), the VM Data Transfer Program will find an unused file mode letter to access the disk.
- You cannot use the TRANSFER command to define an OS data set or a VSE file that has more than two qualifiers in its name. Instead, use the INPUTDD command's DSN qual1... form to build the data definition for the input. Then use the TRANSFER command without a file identifier to start the transmission.
INPUTDD - Define The Input File
Use the INPUTDD command to add an input file definition to the data definition pool prior to the transmission, or to reset the data definition pool to empty.
Use the data definition pool to accumulate the input file definitions for the INPUT DDname. Then use the TRANSFER command without a file identifier to start the transmission. When the TRANSFER command is received without a file identifier, the data definition pool is used to build the INPUT DDname.
Each data definition pool is operated independently and is automatically reset to empty after it has been processed successfully.
INPUTDD Format
+ INPutdd datatype | fn ft <fm> < (options > | + + | fn ft <fm> | DSN qual1 <qual2...> | | | DSN qual1<.qual2...> | | + + | < (options > | | RESET + options: <RECFM r> <LRECL nnnnn> <BLOCK|BLKSIZE nnnnn> <CONCAT>
Operands
datatype
indicates the data type to be defined. Valid values are:
ACCOUNT
defines the input for the VM Account data transfer function
CAVMACT
defines the input for the
VM:Account
data transfer functionMONXA
defines the input for the VM Monitor data transfer function
NETDATA
defines the input for the VM Network data transfer function
POWER
defines the input for the VSE/POWER Account data transfer function
ERDS
defines the input for the Error Recording data transfer function
fn ft <fm>
is the file identifier of the input data file. When the fm is omitted, the file mode resolved by the TRANSFER command is used to locate the input file. If fm is specified as an asterisk (*), then all accessed disks are searched for the file.
If fm is the file mode of an OS disk, fn and ft are assumed to be the only two qualifiers of an OS data set name and each is one to eight characters long, separated by a period. Otherwise, you must use the DSN qual1... form.
DSN quall <qual2...>DSN quall<.qual2...>
associates the specified CMS file name and file type with the OS data set name or VSE file identifier that follows the DSN operand. The DSN operand corresponds to the DSN parameter on the OS DD statement. Once it is defined, you can refer to the OS dataset name or VSE file identifier using the CMS file name and file type.
RECFM r
is the record format of the file, where r can be one of the following:
F
Fixed length
FB
Fixed blocked
V
Variable length
VB
Variable blocked
U
Undefined
LRECL nnnnn
is the logical record length (nnnnn) of the file, in bytes.
BLOCK|BLKSIZE nnnnn
is the logical block size (nnnnn) of the file, in bytes.
CONCAT
allows you to assign the INPUT DDname to two or more data files. This option applies only to VM network data and Error Recording data.
RESET
removes any existing input definitions from the data definition pool for the specified transfer function.
Corequisites
If you use the INPUTDD and TRAnsfer commands, you must code the following in VMTFDEF:
datatype.INPUT section: ec = INPUTDEF(dtype,signal,suffix) exit ec datatype.TERMINATE section: ec = Cleanup(dtype,info) exit ec
where datatype is one of the data types listed above.
See the Modifying Distributed Code section for instructions on modifying VMTFDEF.
Usage Notes
- The INPUT DDname is not established with the input file definition until a TRANSFER command is received for the same type of transfer function.
- Typically, you do not need to specify RECFM, LRECL, or BLKSIZE for an input file. If the input file is a VSE sequential file, you do need to specify characteristics.
- You may need to use the combination of the INPUTDD and TRANSFER commands in the following circumstances:
- When transferring data from multiple data sources (such as network data).Example:A site has both NPM and NetSpy data. Both sources cut their files at 17:00 every day.The NPM machine issues the following INPUTDD command:CP SMSG MICSVMT ACCESS 2E1 K CP SMSG MICSVMT INPUTDD NETDATA NPM SMFLOG K (CONCATThe NetSpy machine issues:CP SMSG MICSVMT ACCESS 4BF G CP SMSG MICSVMT INPUTDD NETDATA NETSPY SMFLOG G (CONCATAt 17:05, a TRANSFER command is given to the VM Data Transfer Program from the scheduler machine:CP SMSG MICSVMT TRANSFER NETDATA (NOLINKwhich transfers both NPM SMFLOG K and NETSPY SMFLOG G at once.
- When transferring data using a time delay.Example:A data file is cut at 8:30 a.m. but is not transmitted until 12:00 noon. At 8:30 a.m., an INPUTDD command is issued to the VM Data Transfer Program from the MONWRITE userid:CP SMSG MICSVMT INPUTDD MONXA D051590 T083002At 12:00 noon, a TRANSFER command is given to the VM Data Transfer Program from the scheduler machine, which triggers the transmission.CP SMSG MICSVMT TRANSFER MONXA
- When transferring an input file that is an OS data set or VSE file whose name has more than two qualifiers.
- When transferring VM network data using the CONCAT operand.
- The CONCAT option is not valid for VM Account,VM:Account, VM Monitor, and VSE/POWER data.
RESET - Reset the Reader File
Use the RESET command to reset the status of reader files so that they can be reexamined.
RESET Format
RESET READER | RDR
Usage Notes
VMTRDR places each file in a "seen" state as it examines the files, which reduces processing overhead on subsequent CMS reader searches for files that are eligible for processing. The RESET READER command resets the "file seen" indicator of reader files and makes them eligible for processing again.
STOP - Stop VMTWAITR
Use the STOP command to terminate VMTWAITR after all outstanding files and CP SMSG commands have been processed.
VMTWAITR stops and exits with return code 1.
STOP Format
STOP
IMMDSTOP - Stop VMTWAITR Immediately
Use the IMMDSTOP command to stop VMTWAITR immediately.
VMTWAITR stops immediately and exits with return code 1. Any SMSG commands that have been received but not yet processed are discarded.
IMMDSTOP Format
IMMDSTOP
LINK - Link to a Minidisk
Use the LINK command to make a minidisk that is associated with another userid available to the VM Data Transfer Program.
LINK Format
LINK <To> userid vaddr1 <As> vaddr2 <mode> <<PASS=> pwd>
Operands
<To> userid vaddr1
is the virtual address (cuu) of the minidisk to be accessed in the directory entry for userid.
<As> vaddr2
is the virtual address (cuu) that is to be assigned to the minidisk for the VM Data Transfer Program.
mode
is the access mode. Valid values are R, RR, W, WR, M, MR, and MW. Refer to CP LINK command in IBM CP General User Command Reference for details.
<PASS=> pwd
is a one to eight character string that must match the access mode password for minidisk vaddr1 in the directory for the userid specified.
Usage Notes
Refer to the LINK command in IBM CP Command and Utility Reference.
ACCESS - Access a Minidisk
Use the ACCESS command to access a minidisk with a file mode letter.
ACCESS Format
ACCess vaddr fm </ext <fn <ft <fm>>>>
Operands
vaddr
makes available the minidisk at the specified virtual address.
fm
assigns a one-character file mode letter to all files on the minidisk accessed.
ext
indicates the file mode of the parent minidisk. Files on the minidisk being accessed are logically associated with files on the parent minidisk.
fn ft fm
defines a subset of the files on the specified minidisk. Only the specified files can be read.
Usage Notes
Refer to the ACCESS command in IBM CMS Command Reference.
RELEASE - Free an Accessed Minidisk
Use the RELEASE command to free a minidisk previously accessed.
RELEASE Format
+ + RELease | fm | < (DET <)> > | vdev | + +
Operands
fm
is the file mode letter for which the disk is currently accessed.
vdev
is the virtual device address of the disk that is to be released.
DET
specifies that the disk is to be detached from the VM Data Transfer Program's virtual machine.
Usage Notes
Refer to the RELEASE command at the IBM CMS command reference.
DETACH - Remove A Minidisk
Use the DETACH command to remove a minidisk from the VM Data Transfer Program.
DETACH Format
DETach vaddr
Operands
vaddr
is the virtual device address to be detached from the VM Data Transfer Program's virtual machine.
Usage Notes
Refer to the DETACH command at the IBM CP command reference.
LOGOFF - Logoff The VM Data Transfer Program
Use the LOGOFF command to terminate the virtual machine that runs the VM Data Transfer Program.
LOGOFF Format
LOGOFF <IMMD>
Operands
IMMD
terminates the session immediately and discards any outstanding SMSG commands. If IMMD is not specified, the VM Data Transfer Program will not logoff until all eligible reader files and existing SMSG commands are processed.