CMS utility command modules: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(converted from 7.4 Command Ref manual)
 
m (remove category link)
Line 581: Line 581:
    
    
</div> <!-- end of toc limit div -->
</div> <!-- end of toc limit div -->
[[Category:CMS utility commands]]

Revision as of 15:38, 1 July 2014

Overview

The following CMS utility command modules relate to Model 204. Unlike the commands described so far in this book, however, you cannot issue CMS utility commands from within the Model 204 environment. For more information on CMS, refer to the Model 204 z/VM Installation Guide.

M204APND: Concatenating file definitions

Privileges

Any user

Function

Permits concatenation of file definitions for Model 204

Syntax

M204APND ddname parameter [, parameter]... [[option] [, option]...]

Where:

  • ddname specifies the file to which the file defined is concatenated.
  • parameter is a standard FILEDEF or M204FDEF parameter.
  • option is a standard FILEDEF or M204FDEF option.

Syntax notes

A FILEDEF command with the CLEAR parameter for a ddname that represents a concatenation of files clears all file definitions in the concatenation.

Usage notes

This module defines a file to be added to another file of a specified name. Concatenated files are processed in the order that the associated FILEDEF, M204FDEF, and M204APND commands are issued.

M204CMS: Providing the interface between Model 204 and CMS

Privileges

Any user

Function

Provides the interface between Model 204 and CMS

Syntax

M204CMS [module] [keyword=value [, keyword=value] ...

Where:

  • module specifies the name of the Model 204 program module to be executed. The default is M204ONLN.
  • keyword and its associated value specify parameters passed to the Model 204 module in the format of an z/OS PARM field.

Syntax notes

The keyword and value are separated by an equal sign and inserted in the PARM field. Successive keyword-value pairs are separated by commas. An exception occurs when value is specified as a percent sign (%). In this case, only the keyword is inserted in the PARM field, with commas separating neighboring operands.

Usage notes

The M204CMS command is the interface between Model 204 and CMS. It is used during execution of a variety of Model 204 facilities to provide system services in the CMS environment. The M204CMS module is usually employed in EXEC procedures that provide higher-level interfaces to Model 204 (for example, FASTLOAD, ONLINE).

M204CRYP: Decoding features distributed in object/source form

Privileges

Restricted

Function

Decodes key components of Model 204 features distributed in object and/or source code form

Syntax

M204CRYP [DECODE | ENCODE} featurename key [options]

Where:

  • ENCODE causes the CCA XENCDEC program to encrypt vital elements of a specified feature. This disables the feature and prevents subsequent use, unless a DECODE request is made. ENCODE is used internally at Rocket Software.
  • DECODE causes the CCA XENCDEC program to decrypt vital elements of a specified feature. This enables the feature.
  • featurename is a valid feature name, as defined in the CMS table M204CRYP FEATTBLE.
  • key is an eight-byte numeric character representation of a Rocket-supplied code, which is the trigger for encrypting or decrypting a specified feature.
  • options are:
    • NOREPLACE checks that files with the same file ID as the output file to be generated by M204CRYP do not already exist. If one or more output files do exist, an error message is displayed and the M204CRYP command terminates. This option is the default to prevent existing files from inadvertently being destroyed.
    • REPLACE causes the output file to be generated by M204CRYP to replace an existing file with the same file identifier.

Syntax notes

The M204CRYP command has restricted use and must be issued directly from the MAINT204 machine (Model 204's maintenance virtual machine).

M204CRYP report

The M204CRYP command generates a report that is identified by a CMS file name equal to a feature name and a file type of D_REPT. The report contains:

FILE IN-CMSFile ID of the input file.
FILE OUT-CMSFile ID of the output file.
CONTROL PARMFunction used (DECODE) and the key value.
NUMBER OF RECORDS PROCESSEDTotal number of records processed.
Return codes and messages.

M204CRYP return codes and messages

The return codes issued by M204CRYP are described in the following table:

Code Message Description
0 Successful completion All materials were decrypted successfully.
1 Error in an input argument The error may be a misspelling, an invalid option, or invalid decryption key. Check the command you issued, correct the error, and re-execute it.
2 Error in M204CRYP This internally detected error return code is not used.
3 Execution of a host, CMS or CP, command failed The return code and the text of the command are described in an error message. This usually means that the decryption utility failed for some reason. If this is the case, the D_REPT file shows the reason for the decryption failure. Check the report, correct the error, and rerun the M204CRYP command.

The following table lists the return codes and messages that appear in the report produced by the decryption utility. The appropriate diagnostic action is also suggested.

Code Message Diagnostic action
0 None None — decryption was successful.
8 No Control or Parm provided PARM= on the EXEC card was invalid or missing. This reflects an internal error in the service routine used by M204CRYP. Contact Technical Support for assistance.
12 Invalid command specified DECODE was not specified on the PARM= on the EXEC card. This reflects an internal error in the service routines used by M204CRYP. Contact Technical Support for assistance.
16 Invalid decryption key specified Decryption key specified was not exactly eight bytes in length. Verify that the key you have specified correctly matches the key you were supplied by Rocket.
20 Wrong decryption key specified Decryption key specified does not match the key used to encrypt modules for the feature that you are installing. Verify that the key you have specified correctly matches the key you were supplied by Rocket.
24 Internal decryption xxxx error detected, where xxxx can be:
  • Clear text length
  • Clear checksum
  • Cipher checksum
 Decryption key specified does not match the key used to encrypt modules for the feature that you are installing, or the material you are trying to decrypt has been modified or tampered with. Verify that the key you have specified correctly matches the key you were supplied by Rocket.

M204FDEF: Creating file definitions

Privileges

Any user

Function

Permits creation of file definitions for files on unaccessed variable-format disks

Syntax

M204FDEF ddname address DSN dsnname [parameter [, parameter] ...]

Where:

  • ddname is the name associated with the file to be defined.
  • address is the virtual address of the minidisk where the file to be processed resides. The address can be up to four digits long.
  • DSN is the identifier tag for the dataset.
  • dsname is the name of the dataset. The dataset name follows the DSN tag. A blank space must separate the tag and the name. The same conventions and restrictions associated with the DSN operand of the FILEDEF command apply. You specify the dataset name as a series of items separated by blanks. For example:

    DOSRV.M204.CLIENTS

    is represented as:

    DOSRV M204 CLIENTS

  • parameter is a standard FILEDEF option, the same as is used for dataset definition with z/OS. The DSORG, RECFM, BLKSIZE, and LRECL options are particularly useful with Model 204.

Usage notes

The CMS FILEDEF command requires that any variable-format disk used by Model 204 be accessed through the CMS ACCESS command. This limits the total disks available to a particular Model 204 service virtual machine. The M204FDEF module overcomes the limitation.

By performing a modified FILEDEF function, M204FDEF permits the definition of non-CMS disks without accessing the volume on which the variable format files reside. The non-CMS disks act as substitute volumes. The Model 204 user can, therefore, establish an unlimited number of file definitions on any number of disks.

M204LDEF: Specifying tape label information

Privileges

Any user

Function

Permits specification of magnetic tape label information for tape volumes defined using the M204APND module

Syntax

M204LEDF ddname parameter [, parameter] ... [option [, option] ...]

Where:

  • ddname is the name associated with the file to be defined.
  • parameter is a standard LABELDEF parameter.
  • option is a standard LABELDEF option.

Syntax notes

A LABELDEF command that specifies the CLEAR parameter for a ddname that represents a label definition for a concatenated file clears only the first label definition in the concatenation.

Usage notes

Using the M204APND command, you can define a file as a concatenation of magnetic tape volumes. You must issue a LABELDEF command for each volume in the concatenation. For more information about the LABELDEF command, refer to your IBM documentation. Because a label definition is associated with a file definition through the ddname parameter, an alternative is required to define labels for the second and subsequent volumes of a multi-reel file. M204LDEF provides this function.

M204LDEF commands are associated with the file definitions created by the M204APND command in the sequence that the file definitions are established.

For information on the FILEDEF options, refer to Defining the runtime environment (CCAIN).

For information about using M204LDEF and M204APND to back up and restore multitape Model 204 files, see Backing up and restoring multitape files under z/VM.

M204SQSH: Condensing map sizes

Privileges

Any user

Function

Condenses the in-storage load map for a program loaded through a LOAD or LOADMOD command. The M204SQSH program reduces the map size by eliminating all load map entries that are not section definitions.

Syntax

M204SQSH

Syntax notes

The M204SQSH module is used by the M204GEN and M204XGEN commands to construct various Model 204 programs.

M204UTIL: Maintaining variable-format volumes

Privileges

Any user

Function

Initializes variable-format volumes and allocates, renames, and erases datasets on such volumes

Syntax

M204UTIL function operands ([option [, option] ...

Where:

  • function specifies the operation that M204UTIL performs. Function is one of the following operations:
    • ALLOCATE
    • ERASE
    • INITIAL
    • LABEL
    • LIST
    • RENAME
  • operands are dependent on the kind of function specified. An operand can be a dataset name, a virtual address, or whatever represents the object of the function. Minidisk addresses must be specified as three or four digits.
  • option is an attribute of an operand and depends on the kind of function specified.

Usage notes

M204UTIL ALLOCATE: Allocating space for a variable-format minidisk

Privileges

Any user

Function

Allocates file space on the variable-format minidisk

Syntax

M204UTIL ALLOCATE datasetname {mode | address} ( {PRIMARY nnnnnn CYL | TRK | BLK} [DSORG PS | DA] [RECFM format] [BLKSIZE nnnnn] [LRECL nnnnn]

Where:

  • ALLOCATE has the alias CREATE. M204UTIL CREATE is functionally equivalent to M204UTIL ALLOCATE.
  • datasetname specifies the components, separated by blanks, of the file name for which space is allocated.
  • mode specifies the disk mode of the minidisk where the file is to be allocated.
  • address specifies the hexadecimal virtual address of the minidisk where the file allocation is to be performed.
  • PRIMARY nnnnnn specifies the primary allocation quantity in cylinders (CYL) or tracks (TRK) for a count key data device, or in blocks (BLKS) for a fixed-block architecture device. This option must be specified.
  • DSORG PS|DA specifies the dataset organization. If this option is omitted, no dataset organization is defined.
  • RECFM format specifies the dataset record format. If this option is omitted, no record format is defined.
  • BLKSIZE nnnnn specifies the dataset block size. If this option is omitted, a value of 0 is used.
  • LRECL nnnnn specifies the dataset logical record length. If this option is omitted, a value of 0 is used.

M204UTIL ERASE: Erasing a dataset on a variable-format disk

Privileges

Any user

Function

Erases a dataset on a variable-format disk

Syntax

M204UTIL ERASE datasetname {mode | address}

Where:

  • ERASE has the aliases SCRATCH and REMOVE. M204UTIL SCRATCH and M204UTIL REMOVE are functionally equivalent to M204UTIL ERASE.
  • datasetname specifies the qualifiers, separated by blanks, that make up the name of the dataset to be erased.
  • mode indicates the disk mode of the minidisk from which the file is to be erased.
  • address specifies the hexadecimal virtual address designating the minidisk.

M204UTIL INITIAL: Initializing a variable-format volume

Privileges

Any user

Function

Initializes a volume in variable format

Syntax

M204UTIL INITIAL address label ([LOCATION nnnnnn | EXTENT nnnnnn]

Where:

  • INITIAL has the alias FORMAT. M204UTIL FORMAT is functionally equivalent to M204UTIL INITIAL.
  • address is the hexadecimal virtual address of the minidisk to be initialized.
  • label is the volume label.
  • LOCATION nnnnnn specifies the starting location of the Volume Table of Contents (VTOC) as a track or block number. If a value is not specified, the default option for a count key data device is LOCATION 1. For a fixed-block architecture device, the default option is LOCATION 2.
  • EXTENT nnnnnn specifies the size of the VTOC in tracks or blocks. If a value is not specified, the default option for a count key data device is EXTENT 2. For a fixed-block architecture device, the default option is a value that causes the VTOC to occupy the remaining portion of the first cyclical group in the device.

Model 204 does not support VTOCs that cross cylinder boundaries on count-key-data devices. Indexed VTOCs are neither created nor manipulated by Model 204.

Usage notes

Do not use the M204UTIL INITIAL function on volumes that are owned by virtual machines other than the MODEL204 virtual machine, for example, other operating systems, or minidisks that contain data that you want to keep.

The initialization process deletes the VTOC, which has the pointers to the z/OS datasets on the disk, and Model 204 can no longer find the datasets.

Enter YES and not Y in response to the confirmation prompt.

M204UTIL LABEL: Changing a variable-format minidisk label

Privileges

Any user

Function

Changes the label of a variable-format minidisk

Syntax

M204UTIL LABEL address label

Where:

  • address specifies the hexadecimal virtual address of the minidisk to be labeled.
  • label specifies the volume label to be assigned to the minidisk.

M204UTIL LIST: Listing datasets on a variable-format minidisk

Privileges

Any user

Function

Lists the datasets on a variable-format minidisk

Syntax

M204UTIL LIST datasetname {mode | address}

Where:

  • datasetname specifies the qualifiers, separated by blanks, that comprise the name of the dataset that is to be listed.

    If the last qualifier specified is an asterisk (*), all dataset names that begin with the prefix defined by the preceding qualifiers are listed. If the last qualifier specified ends with an asterisk (*), the response includes all datasets whose names begin with the preceding qualifiers and are followed by a qualifier that matches the last one up to the asterisk.

    If the only qualifier specified is an asterisk (*), all datasets on the volume are listed.

  • mode specifies the disk mode of the minidisk that contains the files to be listed.
  • address specifies the hexadecimal virtual address designating the minidisk.

M204UTIL RENAME: Changing a dataset name on a variable-format minidisk

Privileges

Any user

Function

Changes the name of a dataset on a variable-format minidisk

Syntax

M204UTIL RENAME oldname {mode | address} (newname

Where:

RENAME has the alias CHANGE. M204UTIL CHANGE is functionally equivalent to M204UTIL RENAME.

  • oldname specifies the qualifiers, separated by blanks, that make up the name of the dataset to be renamed.
  • mode indicates the disk mode of the minidisk on which the file to be renamed resides.
  • address specifies the hexadecimal virtual address designating the minidisk.
  • newname specifies the qualifiers, separated by blanks, that make up the new name to be assigned to the dataset.

M204XFER: Invoking the M204CMS module in the DCSS

Privileges

Any user

Function

Transfers control to the version of the M204CMS module that executes in a discontiguous saved segment (DCSS)

Syntax

XFER program interface [(selection [, selection] ...]

Where:

  • program specifies the name of the Model 204 program segment, for example, M204ONLN or M204IFM1, that is to be invoked. If this operand is omitted, the default value of M204ONLN is used. Entering an asterisk (*) for this option indicates that no program segment is to be invoked.
  • interface specifies the name of the Model 204 CMS interface segment, for example, M204CMS, or the user interface segment, for example, M204USR. If it is omitted, the default is M204CMS.
  • selection is an option that is passed to the M204CMS module intact.

Usage notes

  • For this module to function, the specified interface segment (M204CMS by default) must be defined. If this segment is not created, the M204XFER module must not be generated. If the M204XFER module exists and the interface segment does not, M204XFER abandons any attempt to invoke Model 204.
  • M204XFER can optionally load a second DCSS containing the Model 204 program that is to be invoked by M204CMS.

    M204XFER first attempts to load the specified program segment. Regardless of whether this operation succeeds, it then attempts to load the interface segment. If this attempt fails, M204XFER terminates with an error message. Otherwise, the interface is invoked in the DCSS with the same parameter list that was used to invoke M204XFER.

    If the specified program segment could not be loaded by M204XFER, a MODULE that has the same name as the segment is loaded by M204FCMS.

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=CMS_utility_command_modules&oldid=69895"