SEARCHPRODUCT: Creating a list of software products

Purpose

Before you begin: To use the RMM SEARCHPRODUCT subcommand, you need READ access to the STGADMIN.EDG.MASTER resource profile.

Use the SEARCHPRODUCT subcommand to create a list of software products defined to DFSMSrmm.

You can restrict how many software products DFSMSrmm displays by specifying the LIMIT operand. DFSMSrmm searches until it reaches your limit or until it lists all software products that match your search criteria. If you do not specify a search limit, DFSMSrmm lists a maximum of ten products.

Table 1 shows the information DFSMSrmm returns for each software product in the list, in the order it is displayed:

Table 1. Information returned by SEARCHPRODUCT
Table field name	Description
Number	Software product number
Level	Software product level
Product Name	Software product name
Feature Code	Software product feature code
Vols	Number of volumes associated with the software product
Volume	Volume serial number of the first volume where the software product resides

Format


>>-+-SEARCHPRODUCT-+-------------------------------------------->
   '-SP------------'   

>--+-------------------------------------------------+---------->
   |                           .-LIST---.  .-START-. |   
   '-CLIST--| CLIST strings |--+--------+--+-------+-'   
                               '-NOLIST-'  '-ADD---'     

>--+-------------------------------------------------------------------------------+-->
   '-CONTINUE--(--+-----------------------------------------------------------+--)-'   
                  '-NUMBER--(--product_number--)--LEVEL--(--version_number--)-'        

>--+---------------------------+-------------------------------->
   |        .-10-----------.   |   
   '-LIMIT(-+-search_limit-+-)-'   

>--+------------------------------------+----------------------->
   '-NAME(full_or_generic_product_name)-'   

>--+----------------------------------------+------------------><
   '-NUMBER(full_or_generic_product_number)-'   

CLIST strings

|--(prefix_string,suffix_string)--------------------------------|

Parameters

ADD

Specify this operand to request that new records written to the CLIST data set are added after any existing records in the data set. When the CLIST data set is empty or DFSMSrmm creates the CLIST data set during command execution, specifying ADD is the same as specifying START.

ADD is mutually exclusive with START.

You can easily build a set of commands from CLIST processing using multiple SEARCH subcommands of the same or different resource types. For variable length records, the minimum record length can cause the LRECL to be increased. For fixed length records, if the minimum length cannot be accommodated, the subcommand fails.

CLIST(prefix_string,suffix_string)

Specifies a CLIST to create a data set of executable commands. You can edit the data set to remove any products you do not want in the list. Then you can run the CLIST at your convenience.

DFSMSrmm returns the software product and version for each record if you do not specify (prefix_string and suffix_string).

You can add RMM TSO subcommands and operands to the records in the CLIST data set by specifying (prefix_string and suffix_string). These text strings cannot exceed 255 characters. Separate the prefix_string and suffix_string using a blank or a comma between the text strings. Insert blanks in the prefix and suffix values to prevent DFSMSrmm from concatenating the strings with the data that DFSMSrmm returns. To enter a null prefix_string, add a pair of separator characters such as '' to the text string (for example, CLIST('','suffix_string')).

See Creating CLISTs of executable subcommands for information about the data set used for the CLIST output.

CONTINUE(NUMBER(product_number)LEVEL(version_number))

Specify the CONTINUE operand without any value to notify DFSMSrmm SEARCH subcommand processing that you want to break down the search results based on the LIMIT value and request that DFSMSrmm return the search continue information for use with the next command. For TSO, the continue information is returned either as a REXX variable or as a line mode message. When the subcommand is issued from the DFSMSrmm API, the continuation information may be either a line mode message or an SFI or XML attribute.

CONTINUE is an optional operand.

Use the LIMIT operand to control the maximum number of entries to be returned each time you start or continue the search.

To continue a previous search subcommand, the CONTINUE operand value includes all of these values to identify the current search position:

NUMBER(product_number): product_number is one to eight characters enclosed in single quotation marks if it contains any special characters, or blank.
LEVEL(version_number): version_number is one to nine characters enclosed in single quotation marks if it contains any special characters or blank.

The information required to continue a search subcommand is returned by each search subcommand that specifies the CONTINUE operand and passed back to DFSMSrmm unchanged in order to continue the previous search. You should specify the exact same subcommand unchanged. To do this, just change the CONTINUE operand value on each additional command required.

LIMIT(search_limit|*)

Specifies to limit how many entries DFSMSrmm lists. The maximum allowable decimal value is 9999. Specify an asterisk to list all entries matching your search criteria. The default value is 10.

LIST

Specifies that DFSMSrmm produce a list when the CLIST operand is used. LIST is mutually exclusive with the NOLIST operand. LIST is the default.

NAME(*|full_or_generic_software_product_name)

Specifies a software product name. A full product name is one to thirty characters. A generic product name is 1 to 29 characters followed by an asterisk. Enclose the software product name in single quotation marks if it contains any special characters or blanks. Specify an asterisk to list software products regardless of name or number. An asterisk is the default for NAME.

NOLIST

Specifies that DFSMSrmm should neither produce a list nor set REXX variables for resources when the CLIST operand is used. DFSMSrmm produces only the CLIST output file. NOLIST is mutually exclusive with the LIST operand. LIST is the default.

NUMBER(*|full_or_generic_software_product_number)

Specifies a software product number. A full software product number is one to eight characters. A generic software product number is one to seven characters followed by an asterisk. Enclose the value for NUMBER in single quotation marks if it contains any special characters or blanks. Specify an asterisk to list software products regardless of name or number. An asterisk is the default value for NUMBER.

START

Specify this operand to request that records written to the CLIST data set start from the beginning of the data set.

START is mutually exclusive with ADD.

START is the default value.

Examples

Task: Create a list of all software products that have product numbers starting with PROD.

Command:

  RMM SEARCHPRODUCT NUMBER(PROD*) LIMIT(*)

Output: DFSMSrmm displays a list such as the one shown in Figure 1.

Figure 1. Sample SEARCHPRODUCT output

 Number   Level     Product Name                   Feature Code Vols    Volume
 -------- --------- ------------------------------ ------------ ----    ------
 PROD01   V01R01M00 Product One                    1234         5       VOL100
 PROD02   V01R01M00 Product Two                    3245         1       VOL800
 PROD03   V01R01M00 Product Three                  1059         1       VOL801
 PROD04   V01R01M00 Product Four                   9846         1       VOL802
 PROD05   V01R01M00 Product Five                   5647         1       VOL803
 EDG3012I 5          ENTRIES LISTED

Return codes

See DFSMSrmm return codes and reason codes for DFSMSrmm reason codes.

0: Subcommand completed normally.
4: Warning. Subcommand completed but some operands could have been ignored or modified. DFSMSrmm sets a reason code.
8: User not authorized.
12: Subcommand ended with an error. DFSMSrmm sets a reason code.
16: Error. The DFSMSrmm subsystem is not active.
20: Error. The data is incomplete or incorrect and the TSO user has set NOPROMPT.
24: The TSO subcommand is not APF authorized.
28: The user pressed the attention key.