SEARCHOWNER: Searching owner information

Purpose

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

Use the SEARCHOWNER subcommand to create a list of owners defined to DFSMSrmm. You can restrict how many owners DFSMSrmm displays by specifying the LIMIT or END operand. DFSMSrmm searches until it reaches your limit or end point, or until it lists all owners that match your search criteria. If you do not specify a search limit, DFSMSrmm lists a maximum of ten.

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

Table 1. Information returned by the RMM SEARCHOWNER subcommand
Table field name	Description
Owner	Owner's ID
Last Name	Owner's last name
First Names	Owner's first names
Telephone	Owner's internal telephone number
Volumes	Number of volumes owned

Format


>>-+-SEARCHOWNER-+--+---------------------------+--------------->
   '-SO----------'  |        .-10-----------.   |   
                    +-LIMIT(-+-search_limit-+-)-+   
                    |        '-*------------'   |   
                    '-END(end_owner)------------'   

>--+-------------------------------------------------------------------------+-->
   |                                                   .-LIST---.  .-START-. |   
   '-CLIST--(-+---------------+-,-+---------------+-)--+--------+--+-------+-'   
              '-prefix_string-'   '-suffix_string-'    '-NOLIST-'  '-ADD---'     

>--+------------------------------------------+----------------->
   '-CONTINUE--(--+----------------------+--)-'   
                  '-OWNER--(--ownerid--)-'        

>--OWNER(-+-full_or_generic_owner-+-)--------------------------><
          '-*---------------------'

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 owners you do not want in the list. Then you can run the CLIST at your convenience.

DFSMSrmm returns the owner serial number for each record if you do not specify (prefix_string and suffix_string). When the owner serial number contains special characters the value is returned within quotation marks.

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(OWNER(ownerid))

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 this value to identify the current search position:

OWNER(ownerid): ownerid is one to eight 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.

END(end_owner)

Specify END as an alternative to the LIMIT operand to enable you to specify both the starting and ending point of the owner search.

END is mutually exclusive with LIMIT.

LIMIT(search_limit| *)

Specifies the number of entries that DFSMSrmm lists. The maximum allowable decimal value is 9999. Specify an asterisk to request a list of all entries matching your search criteria.

LIMIT is mutually exclusive with END.

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.

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.

OWNER(full_or_generic_owner| *)

Specifies an owner ID. DFSMSrmm only lists volumes belonging to the owner ID you specify. Specify a specific owner ID to list volumes belonging to that owner. Specify an asterisk to list all volumes that match the other search criteria regardless of their owner. An owner ID is one-to-eight alphanumeric characters or to six alphanumeric characters, $, #, or @. The first character must not be a number. The default is your TSO user ID.

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.

Task: Create a list of all owners defined to DFSMSrmm.

Command:

  RMM SEARCHOWNER OWNER(*) LIMIT(*)

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

Figure 1. Sample SEARCHOWNER output listing

Owner    Last Name            First Names          Internal Volumes
 -------- -------------------- -------------------- -------- ----------
 WOODMW   Wood                 Mike                 664358   50

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.