CL Commands
CL Commands
iSeries
CL Commands Volume 17
ERserver
iSeries
CL Commands Volume 17
Copyright International Business Machines Corporation 1998, 2002. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . RMVLANADPI (Remove LAN Adapter Information) Command Description . . . . . RMVLIBLE (Remove Library List Entry) Command Description . . . . . . . . . RMVLICKEY (Remove License Key Information) Command Description . . . . . . DEL (Remove Link) Command Description . . . . . . . . . . . . . . . . ERASE (Remove Link) Command Description . . . . . . . . . . . . . . . RMVLNK (Remove Link) Command Description. . . . . . . . . . . . . . . RMVLOGEBRM (Remove Log Entries from BRM) Command Description . . . . . RMVLOGEJS (Remove Log Entries from Job Scheduler) Command Description. . . RMVMEDIBRM (Remove Media Information from BRM) Command Description . . . RMVMEDBRM (Remove Media Volumes from BRM) Command Description . . . . RMVM (Remove Member) Command Description. . . . . . . . . . . . . . RMVMSG (Remove Message) Command Description . . . . . . . . . . . . RMVMSGD (Remove Message Description) Command Description . . . . . . . RMVMFS (Remove Mounted File System) Command Description. . . . . . . . UNMOUNT (Remove Mounted File System) Command . . . . . . . . . . . RMVNTWAUTE (Remove NetWare Authentication Entry) Command Description . . RMVNETJOBE (Remove Network Job Entry) Command Description. . . . . . . RMVNWSSTGL (Remove Network Server Storage Link) Command Description . . RMVNETTBLE (Remove Network Table Entry) Command Description . . . . . . RMVNCK (Remove Nickname) Command Description . . . . . . . . . . . . RMVNODLE (Remove Node List Entry) Command Description . . . . . . . . . RMVOPTCTG (Remove Optical Cartridge) Command Description . . . . . . . RMVOPTSVR (Remove Optical Server) Command Description. . . . . . . . . RMVPEXDFN (Remove Performance Explorer Definition) Command Description . . RMVPEXFTR (Remove Performance Explorer Filter) Command Description . . . . RMVPFCST (Remove Physical File Constraint) Command Description . . . . . . RMVPFTRG (Remove Physical File Trigger) Command Description . . . . . . . RMVTCPPTP (Remove Point-to-Point TCP/IP Profile) Command Description . . . RMVPJE (Remove Prestart Job Entry) Command Description . . . . . . . . . RMVPRFTKN (Remove Profile Tokens) Command Description . . . . . . . . . RMVPGM (Remove Program) Command Description . . . . . . . . . . . . RMVPTF (Remove Program Temporary Fix) Command Description . . . . . . . RMVPCLTBLE (Remove Protocol Table Entry) Command Description . . . . . . RMVRDBDIRE (Remove Relational Database Directory Entry) Command Description RMVRMTDFN (Remove Remote Definition) Command Description . . . . . . . RMVRMTJRN (Remove Remote Journal) Command Description . . . . . . . . RMVRMTPTF (Remove Remote Program Temporary Fix) Command Description . . RMVRPYLE (Remove Reply List Entry) Command Description . . . . . . . . . RMVREXBUF (Remove REXX Buffer) Command Description . . . . . . . . . RMVRTGE (Remove Routing Entry) Command Description . . . . . . . . . . RMVSCHIDXE (Remove Search Index Entry) Command Description . . . . . . RMVSVRAUTE (Remove Server Authentication Entry) Command Description . . . RMVSRVTBLE (Remove Service Table Entry) Command Description . . . . . . RMVSOCE (Remove Sphere of Control Entry) Command Description . . . . . . RMVTAPCTG (Remove Tape Cartridge) Command Description . . . . . . . . RMVTCPHTE (Remove TCP/IP Host Table Entry) Command Description . . . . . RMVTCPIFC (Remove TCP/IP Interface) Command Description . . . . . . . . RMVTCPPORT (Remove TCP/IP Port Restriction) Command Description . . . . . RMVTCPRSI (Remove TCP/IP Remote System Information) Command Description . RMVTCPRTE (Remove TCP/IP Route) Command Description . . . . . . . . . RMVTCPTBL (Remove TCP/IP Table) Command Description . . . . . . . . . RMVTRC (Remove Trace) Command Description . . . . . . . . . . . . .
Copyright IBM Corp. 1998, 2002
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . .
. 1 . 1 . 2 . 2 . 5 . 5 . 5 . 7 . 8 . 9 . 9 . 10 . 11 . 16 . 17 . 18 . 18 . 19 . 21 . 22 . 23 . 24 . 26 . 29 . 30 . 31 . 32 . 34 . 36 . 37 . 39 . 39 . 40 . 43 . 44 . 45 . 45 . 47 . 51 . 53 . 53 . 54 . 55 . 56 . 57 . 57 . 59 . 60 . 61 . 63 . 65 . 68 . 68
iii
RMVTRCFTR (Remove Trace Filter) Command Description . . . . . . . . . . . . . . RMVUSFCNNE (Remove Ultimedia System Facilities Connection Entry) Command Description RMVUSFDEVE (Remove Ultimedia System Facilities Device Entry) Command Description . . RMVUSFSVRE (Remove Ultimedia System Facilities Server Entry) Command Description . . RMVWSE (Remove Work Station Entry) Command Description . . . . . . . . . . . . REN (Rename) Command . . . . . . . . . . . . . . . . . . . . . . . . . . RNM (Rename) Command Description . . . . . . . . . . . . . . . . . . . . . RNMCNNLE (Rename Connection List Entry) Command Description . . . . . . . . . . RNMDIRE (Rename Directory Entry) Command Description . . . . . . . . . . . . . . RNMDKT (Rename Diskette) Command Description. . . . . . . . . . . . . . . . . RNMDSTL (Rename Distribution List) Command Description . . . . . . . . . . . . . RNMDLO (Rename Document Library Object) Command Description . . . . . . . . . . RNMJOBJS (Rename Job using Job Scheduler) Command Description . . . . . . . . . RNMLANADPI (Rename Local Area Network Adapter Information) Command Description . . . RNMM (Rename Member) Command Description . . . . . . . . . . . . . . . . . RNMNCK (Rename Nickname) Command Description . . . . . . . . . . . . . . . . RNMOBJ (Rename Object) Command Description . . . . . . . . . . . . . . . . . RNMTCPHTE (Rename TCP/IP Host Table Entry) Command Description . . . . . . . . . RGZDLO (Reorganize Document Library Object) Command Description . . . . . . . . . RGZPFM (Reorganize Physical File Member) Command Description . . . . . . . . . . RPLDOC (Replace Document) Command Description . . . . . . . . . . . . . . . RQSORDAST (Request Order Assistance) Command Description . . . . . . . . . . . RRTJOB (Reroute Job) Command Description . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . .
iv
Command Descriptions
RMVLANADPI (Remove LAN Adapter Information) Command Description
RMVLANADPI Command syntax diagram Purpose The Remove Local Area Network Adapter Information (RMVLANADPI) command removes an adapter name entry from the adapter file. Required Parameter ADPTNAME Specifies the name of the entry being removed from the adapter file. *ADPTADR: The adapter address is used to identify the adapter entry being removed. adapter-name: Specify the name of the adapter entry to remove. The name can be a maximum of 10 characters in length. Optional Parameter ADPTADR Specifies the 12-character hexadecimal adapter address. Example for RMVLANADPI
RMVLANADPI ADPTNAME(PAYROLL)
This command removes the adapter PAYROLL from the adapter file. Error messages for RMVLANADPI *ESCAPE Messages CPF8B43 Request to remove adapter &29 from network adapter file failed. Adapter not found. CPF8B44 Adapter address required. CPF8B62 Adapter &29 on line &23 not removed. Adapter not found in network adapter file. CPF8B68 Line description &23 not found. CPF8B74 Request to display active adapters failed. CPF8B75 No adapter entries in network adapter file. CPF8B76 No functional addresses for adapter.
This command removes the library TESTLIB from the user portion of the library list. Error messages for RMVLIBLE *ESCAPE Messages CPF2103 Library &1 already exists in library list. CPF2104 Library &1 not removed from the library list. CPF2106 Library list not changed. CPF2110 Library &1 not found. CPF2113 Cannot allocate library &1. CPF2118 Library &1 not added. CPF2176 Library &1 damaged. CPF2182 Not authorized to library &1. CPF9807 One or more libraries in library list deleted.
Removing license information from the repository does not affect installed licenses. Any license that is currently being used to access the product on this system remains valid and usable. Restrictions: This command is shipped with public *EXCLUDE authority. Optional Parameters LICKEYINP Specifies how the software license key information to be removed is supplied by the user. *LICKEYFILE: The software license key information is taken from the file specified on the LICKEYFILE parameter. *PROMPT: The software license key information is entered through prompting. PRDID Specifies the seven-character identifier of the product for which software license key information is removed. *ALL: The software license key information for all product identifiers is removed. generic*-product-identifier: Specify the generic identifier of the products to be removed. A generic product identifier is specified in the same manner as a generic name. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. product-identifier: Specify the seven-character identifier of the product. LICTRM Specifies the license term for which software license key information is removed. *ALL: The software license key information for all product identifiers is removed. license-term: Specify the license term in Vx, VxRy, or VxRyMz format, where x and y can be a number from 0 through 9, and z can be a number from 0 through 9 or a letter from A through Z. FEATURE Specifies the feature of the product specified on the PRDID parameter for which the software license key information is removed. *ALL: The software license key information for all features of the product is removed. feature: Specify the number of the feature for which software license key information is removed. SERIAL Specify the serial number of the system for which software license key information is removed. *LOCAL: The software license key information for the local system is removed. *REMOTE: The software license key information to be removed is for remote systems only and depends on the value specified on the LICKEYINP parameter. v If LICKEYINP(*PROMPT) is specified, the software license key information for all remote systems is removed. v If LICKEYINP(*LICKEYFILE) is specified, the software license key information for the remote systems named in the file specified on the LICKEYFILE parameter is removed. *ALL: The software license key information to be removed is for all systems and depends on the value specified on the LICKEYINP parameter. v If LICKEYINP(*PROMPT) is specified, the software license key information for all systems is removed.
Command Descriptions
v If LICKEYINP(*LICKEYFILE) is specified, the software license key information for all the remote systems named in the file specified on the LICKEYFILE parameter is removed. system-serial-number: Specify the serial number of the system for which software license key information is removed. LICKEYFILE Specifies the qualified name of the file in which the software license key information to be removed is located. This input file must be in the format of QSYS/QALZAKEY, and can be created by using the LICKEYFILE parameter on the Display License Key Information (DSPLICKEY) command. The name of the license key file can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. license-key-file: Specify the name of the file that contains the software license key information. LICKEYMBR Specifies the name of the member in which the software license key information to be removed is located. This member is in the file specified on the LICKEYFILE parameter. *FIRST: The oldest member in the file is used. *LAST: The newest member in the file is used. license-key-member: Specify the name of the member that contains the software license key information. Examples for RMVLICKEY Example 1: Removing License Key Information from Prompt Input
RMVLICKEY LICKEYINP(*PROMPT) PRDID(1MYPROD) LICTRM(V3) FEATURE(5001) SERIAL(1234567)
This command removes from the license repository the software license key information for the product 1MYPROD, the license term V3, and the feature 5001 for the system with serial number 1234567. Example 2: Removing License Key Information from File Input
RMVLICKEY LICKEYINP(*LICKEYFILE) SERIAL(*REMOTE) LICKEYFILE(*LIBL/MYKEYFILE) LICKEYMBR(*LAST)
This command removes from the license repository the software license key information for all the remote systems found in the newest created member of the file MYKEYFILE. Error messages for RMVLICKEY *ESCAPE Messages CPF9E55 License Repository object damaged.
CPF9E57 &1 license key information records removed, &2 not removed. CPF9E58 License key information not found. CPF9E69 License key information not found in license key file.
Command Descriptions
OBJLNK Specifies the path name of the object to unlink. Multiple links can be removed with a name pattern. The object path name can be either a simple name or a name that is qualified with the name of the directory in which the object is located. A pattern can be specified in the last part of the path name. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes. For more information on specifying path names, refer to path names. Example for RMVLNK
RMVLNK OBJLNK(PAY)
This command removes a link named PAY. Additional Considerations or independent ASP If you use this command to remove links for an object that is in QDLS, QSYS.LIB, additional restrictions may apply. To identify these restrictions, see the description of the QSYS.LIB, other OS/400 command that can be used to delete the type of object you are removing. v For QDLS restrictions, see the DLTDLO (Delete Document Library Object) command. and independent ASP QSYS.LIB restrictions, see the delete command for the v For QSYS.LIB object you are removing. In general, the name of this command is formed using the OS/400 object type value, from which you remove the character * and add the verb DLT to the beginning. For example: To delete an alert table, which has the object type value of *ALRTBL, see the description for the DLTALRTBL (Delete Alert Table) command for any additional restrictions. You can use the table in the Commonly used parameters - OBJTYPE parameter to identify the object type values. Exceptions: 1. The names of the delete commands for the following objects are not formed in the general manner described above, so they are supplied here for your reference: Object Type (Value) Command Compiler unit (*MODULE) DLTMOD File
1
(*FILE) DLTF
See Exception 2.
or independent ASP QSYS.LIB file system, libraries and database files 2. In the QSYS.LIB cannot be deleted using the Remove Link (RMVLNK or alias DEL or ERASE) command. However, these objects can be deleted using the Remove Directory (RMVDIR or alias RMDIR or RD) command instead. or independent ASP QSYS.LIB object types cannot be deleted using 3. The following QSYS.LIB another OS/400 command: *EXITRG, *IGCSRT, *JOBSCD, *PRDAVL, *QRYDFN, *RCT.
Error messages for RMVLNK *ESCAPE Messages CPFA085 Home directory not found for user &1. CPFA093 Name matching pattern not found. CPFA09C Not authorized to object. CPFA0A1 An input or output error occurred. CPFA0A7 Path name too long. CPFA0A9 Object not found. CPFA0AB Object name not a directory. CPFA0B2 No objects satisfy request. CPFA0BD &1 links removed. &2 links failed.
In the example, all log entries from January 1, 1999 to April 1, 1999 will be removed from the log. Error messages for RMVLOGEBRM None
Command Descriptions
In the example, all log entries are removed for the period March 12, 1999 to April 12, 1999. SLTDATE is expressed in mm/dd/yy format in this example. Error messages for RMVLOGEJS None
This command allows you to remove BRMS media contents information. In the example, media contents information remains on the BRMS media contents file until the media is reused and accompanying object detail is removed after 45 days. Error messages for RMVMEDIBRM None
Note: Media can only be removed if it was previously added using the ADDMEDBRM command. All information about the volume, including content and statistics is deleted when the volume is removed. Also the total number of volumes in the BRMS media inventory is decremented. Example for RMVMEDBRM Example 1: Removing a Volume from BRMS
RMVMEDBRM VOL(C00005)
In the example volume C00005 is removed from the BRMS media inventory. Error messages for RMVMEDBRM None
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. database-file-name: Specify the name of the database file that contains the member being removed. MBR Specifies the name of the physical or logical file member being removed. A specific or generic member name, or *ALL, can be requested. *ALL: All members found in the specified file are removed.
10
member-name: Specify the specific name of the member removed. generic*-member-name: Specify the generic name of the member. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. Examples for RMVM Example 1: Removing a File Member
RMVM FILE(JOBHIST1) MBR(JOBHIST1A)
This command removes file member JOBHIST1A from file JOBHIST1. Library list *LIBL is used to find the file and member. If JOBHIST1 contains other members, they remain unchanged. Example 2: Removing Members with Names that Start with SRC
RMVM FILE(QGPL/JOBHISTL) MBR(SRC*)
This command removes all file members with names that start with SRC from file JOBHISTL in library QGPL. Error messages for RMVM *ESCAPE Messages CPF32CF Distributed file error, reason code &3. CPF32C3 Distributed file error, level ID mismatch CPF320A Member &3 cannot be removed. CPF320B Operation was not valid for database file &1. CPF3203 Cannot allocate object for file &1 in &2. CPF3220 Cannot do operation on file &1 in &2. CPF3273 File or member not created, deleted or changed. CPF7301 &5 members not removed from file &2 in &3. CPF7310 Member &1 not removed from file &2 in &3.
Command Descriptions
11
The Remove Message (RMVMSG) command is used by a program to remove the specified message, or a group of messages, from the specified message queue. If the specified message queue is not allocated to the job in which this command is issued, or to any other job, it is allocated by this command for the duration of the command. Restrictions: 1. This command is valid only in a compiled CL program. 2. To remove a message from the message queue, the user must have *CHANGE authority for the queue and *USE authority for the library in which the queue is stored. Optional Parameters PGMQ Specifies the call message queue from which the message is removed. Messages can be removed from the external queue (*EXT) or from a message queue associated with a call stack entry.
Note: If CLEAR(*BYKEY) is specified, the PGMQ parameter is ignored.
Element 1: Relationship Element 1 of this parameter specifies whether the message queue is associated with the program or procedure identified by Element 2, or if it is associated with the caller of the program or procedure. *PRV: The message is removed from the message queue of the program or procedure that called the program or procedure identified by Element 2.
Note: If the message queue previous to the one identified by Element 2 is for an ILE program entry procedure (PEP), the message will be removed from the message queue immediately previous to the PEP message queue. (Effectively this would be two message queues previous to the one identified by Element 2).
*SAME: The message is removed from the message queue of the program or procedure identified by Element 2. Element 2: Program or Qualified Procedure Element 2 of this parameter has three items. Item 1 specifies the program or procedure of the job message queue. Items 2 and 3 specify the module name and the bound program name, which can be used to qualify the procedure name. Item 1: Program or Procedure Name *: Identifies the program or procedure running the RMVMSG command. program-or-procedure-name: Specify the name of the program or procedure used. If Item 1 identifies a program, the name specified can be a maximum of 10 characters. If Item 1 identifies a procedure, the name specified can be a maximum of 256 characters.
12
The procedure name alone may not identify the correct procedure. Several different procedures with the same name can run in a job. To further identify a procedure, the name specified can be qualified by a module name, or by both a module name and a bound program name. Item 2: Module Name The module name qualifier identifies the module into which the procedure was compiled. *NONE: No module name is specified. module-name: Specify the module name to be used as a qualifier for the specified procedure name (modules are associated only with procedures). The module name can be a maximum of 10 characters. If a module name is not specified but a bound program name is, *NONE must be specified in the module name position. Item 3: Bound Program Name The bound program name qualifier identifies the program to which the procedure was bound. *NONE: No bound program name is specified. bound-program-name: Specify the bound program name to be used as a qualifier for the specified procedure name (and module name if specified). The bound program name can be a maximum of 10 characters. Other Single Values *ALLINACT: All messages for all inactive call stack entries are removed from the users job message queue. If this value is specified for the PGMQ parameter, the value *ALL must be specified on the CLEAR parameter. *EXT: The message is removed from the external message queue of the job. MSGQ Specifies the qualified name of the message queue from which one or more messages are removed. If MSGQ is specified, the PGMQ parameter cannot be specified. *PGMQ: The call message queue specified in the PGMQ parameter is the only queue from which the messages are removed. If CLEAR(*KEEPUNANS) is specified, MSGQ(*PGMQ) cannot be specified. The name of the message queue can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. message-queue-name: Specify the name of the message queue from which one or more messages are removed.
Command Descriptions
13
MSGKEY Specifies the name of the CL variable that contains the message reference key of the message being removed. MSGKEY cannot be specified if *ALL, *KEEPUNANS, *OLD, or *NEW is specified for the CLEAR parameter. CLEAR Specifies whether one message, all messages (except unanswered inquiry messages), or only old or new messages in the specified message queue are removed from the queue. *BYKEY: The message identified by the CL variable named in the MSGKEY parameter is removed from the message queue. *ALL: All messages are removed from the specified message queue. *KEEPUNANS: Messages other than unanswered inquiry messages are removed from the specified message queue. If CLEAR(*KEEPUNANS) is specified, MSGQ(*PGMQ) cannot be specified (a message-queue name must be specified for MSGQ). *OLD: Old messages in the specified message queue are removed from the queue. *NEW: New messages in the specified message queue are removed from the queue. RMVEXCP Specifies the action to be taken when an unhandled exception message is found. An unhandled exception message is an escape, notify, or status message that has been sent to an ILE procedure. When this command is run, the ILE procedure has not yet taken action to tell the system that the exception is handled. One action that the ILE procedure can take is to call a CL program that will remove the exception message. More information on actions that an ILE procedure can take to handle an exception is in ILE Concepts book.
This parameter is valid only when working with a message queue that is associated with a call stack entry for an ILE procedure. This parameter is ignored when working with a message queue associated with a call stack entry for a program. *YES: The unhandled exception message on the specified message queue is removed. As a result, the exception is handled. *NO: The unhandled exception message on the specified message queue is not removed. The message remains on the queue as an unhandled exception message. Examples for RMVMSG Example 1: Removing a Message
RMVMSG MSGQ(SMITH) MSGKEY(&KEY)
This command removes the message with the reference key specified in the CL variable &KEY from the message queue named SMITH. Example 2: Keeping Unanswered Messages
RMVMSG MSGQ(SMITH) CLEAR(*KEEPUNANS)
This command removes all messages except the unanswered inquiry messages from the message queue named SMITH. Example 3: Removing Messages Using a Partial Procedure Name
RMVMSG PGMQ(*SAME PROCESS_ORDER>>>) CLEAR(*ALL)
This command removes all messages from the most recent procedure whose name begins with PROCESS_ORDER.
14
Error messages for RMVMSG *ESCAPE Messages CPF24A6 Value for messages to remove not valid. CPF24AD Messages to remove must be *ALL if program message queue is *ALLINACT. CPF2401 Not authorized to library &1. CPF2403 Message queue &1 in &2 not found. CPF2407 Message file &1 in &2 not found. CPF2408 Not authorized to message queue &1. CPF241A Clear option &1 in system program is not valid. CPF2410 Message key not found in message queue &1. CPF2411 Not authorized to message file &1 in &2. CPF2419 Message identifier &1 not found in message file &2 in &3. CPF2450 Work station message queue &1 not allocated to job. CPF2451 Message queue &1 is allocated to another job. CPF247A Call stack entry not found. CPF2477 Message queue &1 currently in use. CPF2479 Call stack entry not found. CPF2483 Message file currently in use. CPF2499 Message identifier &1 not allowed. CPF8127 &8 damage on message queue &4 in &9. VLIC log-&7. CPF8176 Message queue for device description &4 damaged. CPF9830 Cannot assign library &1. CPF9838 User profile storage limit exceeded.
Command Descriptions
15
Restriction: The user must have use and delete authorities to the message file. Required Parameters MSGID Specifies the message identifier of the message being removed from the message file. MSGF Specifies the qualified name of the message file containing the message being removed. Any message file overrides in effect for the job are ignored by this command; the file specified here is the one from which the message is removed. The name of the message file can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. message-file-name: Specify the name of the message file to use.
This command removes the message description with the identifier UIN0115 from the message file named INV. The library list is used to find the INV file. Note that if more than one INV message file exists in the libraries being searched, the message description will only be removed from the first INV message file found in the library list. Error messages for RMVMSGD *ESCAPE Messages CPF2401 Not authorized to library &1. CPF2407 Message file &1 in &2 not found.
16
CPF2411 Not authorized to message file &1 in &2. CPF2419 Message identifier &1 not found in message file &2 in &3. CPF2483 Message file currently in use. CPF2499 Message identifier &1 not allowed. CPF9830 Cannot assign library &1.
Command Descriptions
17
directory-path-name: The specified directory that was previously mounted over will be uncovered. If TYPE(*ALL) was specified, all file systems mounted over the specified directory will be unmounted. If a specific file system type was specified for the TYPE parameter, the file system mounted most recently over the specified directory will be unmounted only if it matches the specified TYPE value. *ALL: All directories that were previously mounted over will be uncovered. If you specify *ALL, you must specify *ALL for the TYPE parameter. MFS Specifies the path name of the file system to be unmounted. This parameter can only be used to unmount a Block Special File (*BLKSF), when *UDFS is specified for the TYPE parameter.
This command unmounts a Network File System that is accessible on directory /tools. Example 2: Unmounting an User Defined File System
RMVMFS TYPE(*UDFS) MFS(/DEV/QASP02/CUST1UDFS)
This command unmounts the user defined file system /dev/qasp02/custudfs. Error messages for RMVMFS None
18
NDSTREE For *NDS entries, specifies the NetWare Directory Services tree name of the authentication entry to be removed. NDS-tree-name: Specify the name of the NDS tree entry to be deleted. generic*-NDS-tree-name: Specify the generic name of the NDS tree entry to be deleted. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. SERVER For *NETWARE3 entries, specifies the server name of the authentication entry to be removed. server-name: Specify the name of the server entry to be deleted. generic*-server-name: Specify the generic name of the server entry to be deleted. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. USRPRF Specifies the name of the user profile from which the authentication entry is to be removed. *CURRENT: Remove the entry from the current user profile. user-profile-name: Remove the entry from the specified user profile. The user profile must be the current user profile, or the user must have *USE and *OBJMGT authority to the user profile, and *SECADM special authority. Example for RMVNTWAUTE
RMVNTWAUTE SVRTYPE(*NDS) NDSTREE(IBMTREE)
This command removes the authentication entry for the NetWare Directory Services tree IBMTREE from the current user profile. Error messages for RMVNTWAUTE *ESCAPE Messages FPE0219 Authentication entry not removed for &3.
19
If this command is used to remove an entry for a specific user, an entry may still exist that is in effect for that user. For example, if the user removes the entry for user ID, JOE PGMRS, and if there is an entry with a user ID, *ANY PGMRS or *ANY *ANY, that entry is used to handle any jobs submitted by JOE PGMRS. Additional information on the job entry table is in the SNA Distribution Services Restrictions: 1. This command is shipped with public *EXCLUDE authority. 2. The internal value for a node identifier may differ from the characters shown by the RMVNETJOBE command depending on the type of work station (language) being used. If the byte-string value specified for the FROMUSRID command parameter does not match the rules for an internal node identifier value, or if it does not match the internal value for any defined node (ignoring case differences), an error may be reported. Required Parameter FROMUSRID Specifies the two-part user ID that identifies the network job entry being removed. Specify the two-part user ID. Both parts of the user ID are required.
Note: Depending on the work station being used, the internal value for a new user identifier may differ from the characters shown by the Display Network Job Entry (DSPNETJOBE) command. If the byte-string value specified for the FROMUSRID parameter does not match the rules for an internal user identifier value, or if it does not match the internal value for any enrolled user, an error may be reported.
book.
This command removes the network job entry that is used to determine the action that is taken for any input streams received from user ID, JOE SMITH. The network job authority for user ID, JOE SMITH, is taken from either the network job entry *ANY SMITH, if that entry exists, or from the network job entry *ANY *ANY, if that entry exists. If neither of these entries exist, all jobs received from user ID, JOE SMITH, are rejected. Error messages for RMVNETJOBE *ESCAPE Messages CPF8050 Network job table could not be accessed. CPF8051 *ANY not correct for second part of user ID. CPF8054 Network job entry &1 &2 not removed. CPF9040 Wrong characters used in User ID or address, or List identifier &1 &2.
20
Note:
Removing a client storage space that is linked to a network server description of TYPE(*WINDOWSNT) needs to take the following under consideration: If any applications are installed on these drives, the drive may change causing the application to fail.
Note:
When removing the link to the quorum resource disk from a Windows server, all links from the server to clustered disks must be removed first. The links to clustered disks include any network server storage spaces with link type of *SHR and drive numbers 1-15.
Required Parameters NWSSTG Specifies the name of the network server storage space to be removed from the network servers link list. NWSD Specifies the name of the network server description that contains the link to be removed. Optional Parameters RENUMBER *YES: After removing the link of the storage space from the network server specified (NWSD parameter), the sequence numbers will be renumbered sequentially so that no gaps occur in the sequence. This option is recommended because the storage space numbers will match the logical unit numbers assigned to the disk drives on the Windows NT server. *NO: After removing the link of the storage space from the network server specified (NWSD parameter), the sequence numbers will NOT be renumbered sequentially. Gaps may be present in the sequence. This option is not recommended because the storage space numbers will not match the logical unit numbers assigned to the disk drives on the Windows NT server. Examples for RMVNWSSTGL Example 1: Removing a client storage space link
RMVNWSSTGL NWSSTG(PAINTS) NWSD(REMODEL)
This command removes the client storage space PAINTS link from the network server REMODEL. Example 2: Removing and renumbering a client storage space link
Command Descriptions
21
This command removes the client storage space MAIL link from the network server NTSERVER and renumbers the sequence number of the remaining linked storage spaces to eliminate any gaps in the sequence. Note: For more detail on the affect of renumbering client storage spaces that are linked to a network server description that was created with TYPE(*WINDOWSNT), see Windows server on iSeries topic in the Information Center. Error messages for RMVNWSSTGL *ESCAPE Messages CPF26B9 Remove network server storage link command failed.
where nnn is a number ranging from 0 through 255. Example for RMVNETTBLE
RMVNETTBLE NETWORK(NETONE) INTNETADR(9.5.0.0)
This command removes the NETONE network entry with address 9.5.0.0 from the network table. Error messages for RMVNETTBLE *ESCAPE Messages TCP1901 Internet address &1 not valid. TCP2649 Interface entry not found. TCP2903 Network entry not found in table.
22
book.
This command removes the public nickname SEC44A. If the user has proper authority to the nickname, the nickname is removed. Error messages for RMVNCK *ESCAPE Messages CPF8AA1 Library QUSRSYS not completely installed. CPF8360 Not enough storage for commitment control operation. CPF9A89 Nickname function not successful. CPF905C Error occurred trying to find a translation table. CPF9838 User profile storage limit exceeded.
Command Descriptions
23
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. node-list-name: Specify the name of the node list to which the entry is added.
Optional Parameters RMTLOCNAME Specifies the name and address type of the system to remove from the node list object. The name can be an SNA network ID and control point name, an internet protocol host name, or an internet address. An SNA node name is specified using the format nnnnnnnn.cccccccc, where nnnnnnnn is the network ID and cccccccc is the control point name. If only the control point name is specified, the local network ID (LCLNETID) network attribute is used as the value of the network identifier (ID) of the system being removed from the node list. Element 1: Name or Address remote-location-name: Specify the remote location name to remove from the node list. Element 2: Address Type *SNA: The node name has a Systems Network Architecture (SNA) address type. *IP: The node name has an Internet Protocol (IP) address type. CPNAME Specifies the SNA node name that is being removed from the node list object. This system is specified as two elements: the network ID and the control point name. Notes: 1. The RMTLOCNAME parameter is recommended for use in specifying the network ID and the control point name. 2. When the RMTLOCNAME parameter is used to specify the name of a system to remove from the node list, *RMTLOC must be specified for this parameter.
24
*RMTLOC: The network ID and control point name are specified using the RMTLOCNAME parameter. Element 1: Network ID *NETATR: The local network ID (LCLNETID) network attribute is used as the value of the network identifier (ID) of the system being removed from the node list. network-ID: Specify the network ID of the system to remove from the node list. Element 2: Control Point Name control-point-name: Specify the control point name of the system to remove from the node list.
Note: This field is left blank when *RMTLOC is specified as the network ID.
Examples for RMVNODLE Example 1: Removing a System in the Local Network from a Node List
RMVNODLE NODL(MYLIB/NODL02) RMTLOCNAME(AS400A01 *SNA)
This command removes the entry for system AS400A01, which is in the local network, from the node list NODL02 in library MYLIB. The entry has an SNA address type. Example 2: Removing a Host Name from a Node List
RMVNODLE NODL(MYLIB/NODL02) RMTLOCNAME(MYSYS.NET1.LOCAL *IP)
This command removes the entry for host name MYSYS.NET1.LOCAL from the node list NODL02 in library MYLIB. The entry has an address type of IP. Example 3: Removing an Internet Address from a Node List
RMVNODLE NODL(MYLIB/NODL02) RMTLOCNAME(9.13.156.8 *IP)
This command removes the entry for internet address 9.13.156.8 from the node list NODL02 in library MYLIB. The entry has an address type of IP. Error messages for RMVNODLE *ESCAPE Messages CPF7AD4 Network ID &1 not in correct format. CPF7B18 Control point &1 not in correct format. CPF813E Node list &4 in &9 damaged. CPF96B4 Node list entry does not exist. CPF96B5 Remote location name not in correct format.
Command Descriptions
25
CPF9801 Object &2 in library &3 not found. CPF9802 Not authorized to object &2 in &3. CPF9803 Cannot allocate object &2 in library &3. CPF9807 One or more libraries in library list deleted. CPF9808 Cannot allocate one or more libraries on library list. CPF9810 Library &1 not found. CPF9820 Not authorized to use library &1. CPF9830 Cannot assign library &1.
volume-identifier: Specify the volume identifier of the optical cartridge being removed. Optional Parameters
26
VOLOPT Specifies whether to keep the optical volume description in the optical index database files. *REMOVE: The volume description is removed from the optical index database files. *KEEP: The volume description is kept in the optical index database files. This allows the volume descriptions of removed volumes to be displayed when using the Work with Optical Volumes (WRKOPTVOL) command.
Note: This value is only valid for volumes in media library devices. It will be ignored for volumes in other optical devices.
RMVCTGLOC Specifies the external location of the optical cartridge after it is removed.
Note: This parameter is valid only when VOLOPT(*KEEP) is specified.
*NONE: No external location is specified. removed-cartridge-location: Specify the location of the optical cartridge after it is removed. A maximum of 50 characters can be specified. MLB
Note:
Specifies the name of the optical media library to use for the operation.
This parameter is valid only when VOL(*IOSTATION) or VOL(*LEASTUSED) is specified. This parameter is ignored when a specific volume name is specified on the VOL parameter.
DEV
Specifies the name of the optical device which is to have the volume which it contains removed from the optical index database and tray opened if supported by the device.
Note:
This parameter is valid only when VOL(*MOUNTED) is specified. This parameter is ignored when a specific volume name is specified on the VOL parameter.
This command removes the volume found in the stand-alone optical device OPT01. Error messages for RMVOPTCTG *ESCAPE Messages OPT1320 Optical volume &1 in use.
Command Descriptions
27
OPT1325 Optical volume format not recognized. OPT1330 Optical volume not found or not useable. OPT1331 Optical volume &1 not found. OPT1346 Operation not allowed to volume located in a remote optical device. OPT1430 Optical volume &1 information removed. OPT1460 Optical volume &1 is not in an optical device. OPT1530 &1 does not represent a valid optical device. OPT1555 Optical device &1 in use. OPT1652 Device &1 is not an optical media library. OPT1790 Operation not allowed or conflicts with another request. OPT1805 Error accessing optical volume index file. OPT1810 Error accessing optical directory index file. OPT1815 Internal program error occurred. OPT1820 Internal error occurred on optical device &1. OPT1821 Internal error occurred on optical device &1. OPT1825 Optical indexes are incorrect for optical device &1. OPT1860 Request to optical device &1 failed. OPT1861 No device description configured for resource &1. OPT1862 No active device description for resource &1. OPT1863 Optical libraries need to be reclaimed. OPT1872 Optical request timed out. OPT2301 Internal system object in use.
28
OPT7740 User not authorized to object &2 in library &3 type &4.
This command removes optical LAN server LAN01 from the optical configuration. All volume descriptions are removed from the optical index database files. Error messages for RMVOPTSVR *ESCAPE Messages OPT0125 Command &1 completed with errors, more information in job log. OPT6730 No server can be specified when special value *ALL is used.
Command Descriptions
29
Required Parameter DFN Specifies the name of the performance explorer definition being removed. A specific or generic definition name, or *ALL, can be specified. *ALL: All performance explorer definitions are removed. definition-name: Specify the name of the performance explorer definition to be removed. generic*-definition-name: Specify the generic name of the performance explorer definition to be removed. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. Examples for RMVPEXDFN Example 1: Removing a Single Definition
RMVPEXDFN DFN(SAMPLE)
This command removes the member named SAMPLE from file QAPEXDFN in library QUSRSYS that contains the performance explorer definition named SAMPLE. Example 2: Removing All Definitions that Start with SAM
RMVPEXDFN DFN(SAM*)
This command removes all definitions with names that start with SAM by removing all members that start with SAM from file QAPEXDFN in library QUSRSYS. No error messages.
30
This command removes the member named SAMPLE from file QAPEXFTR in library QUSRSYS that contains the performance explorer filter named SAMPLE. Example 2: Removing All Filters that Start with SAM
RMVPEXFTR FTR(SAM*)
This command removes all filters with names that start with SAM by removing all members that start with SAM from file QAPEXFTR in library QUSRSYS. Error messages for RMVPEXFTR *ESCAPE Messages
Command Descriptions
31
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. physical-file: Specify the name of the physical file. CST Specifies the name of the constraint relationship being removed. *ALL: All of the constraint relationships for the file specified on the FILE parameter are removed. *CHKPND: The constraint relationships that have records that are possibly in violation of the constraints (check pending) are removed. A check pending state occurs when the system has not yet determined that the values of a dependent file are all valid in relation to its primary key. Only referential constraints can be in check pending. constraint-name: Specify the name of the constraint. The case is preserved when lowercase characters are specified. Optional Parameters TYPE Specifies the type of constraint relationship named on the CST parameter that is being removed from the physical file. *ALL: All types of primary key and unique constraints are removed. The following are examples of the CST parameter dependencies: v CST(*ALL) TYPE(*ALL) - All constraints are removed
32
v CST(*CHKPND) TYPE(*ALL) - All referential constraints in check pending are removed v CST(ABC) TYPE(*ALL) - The constraint ABC is removed
Note: This value is ignored for referential constraints when the RMVCST parameter is specified.
*REFCST: The referential constraints are removed. The following are examples of the CST parameter dependencies: v CST(*ALL) TYPE(*REFCST) - All referential constraints are removed v CST(*CHKPND) TYPE(*REFCST) - All referential constraints in check pending are removed v CST(ABC) TYPE(*REFCST) - The referential constraint ABC is removed *UNQCST: The unique constraints are removed.
Note: If the unique constraint is a primary key, the unique constraint is removed, but the primary key definition and the files access path are not removed.
The following are examples of the CST parameter dependencies: v CST(*ALL) TYPE(*UNQCST) - All unique constraints (except the primary key constraint) are removed v CST(*CHKPND) TYPE(*UNQCST) - Not valid; unique constraints cannot be in check pending v CST(ABC) TYPE(*UNQCST) - The unique constraint ABC is removed (unless it is a primary key constraint) *PRIKEY: The primary key constraint is removed. The following are examples of the CST parameter dependencies: v CST(*ALL) TYPE(*PRIKEY) - The primary key constraint is removed v CST(*CHKPND) TYPE(*PRIKEY) - Not valid; primary key constraints cannot be in check pending v CST(ABC) TYPE(*PRIKEY) - The primary key constraint ABC is removed *CHKCST: The check constraints are removed. The following are examples of the CST parameter dependencies: v CST(*ALL) TYPE(*CHKCST) - All check constraints are removed v CST(*CHKPND) TYPE(*CHKCST) - All check constraints in check pending are removed v CST(XYZ) TYPE(*CHKCST) - The check constraint XYZ is removed RMVCST Specifies how much of the constraint relationship on the dependent file is removed when a primary key or unique constraint that is also a parent key is removed from the parent file of a referential constraint.
Note: This parameter is ignored if the value on the TYPE parameter is *REFCST.
*RESTRICT: The constraint is not removed if the constraint is either defined or established between the parent file and the dependent file. Neither the foreign key access path nor the foreign key of the dependent file is removed.
Command Descriptions
33
*REMOVE: The constraint and the constraint definition between the parent file and the dependent file are removed. The corresponding foreign key is removed. The foreign key access path of the dependent file is removed only if one exists and is not shared. *KEEP: The constraint between the parent file and the dependent file is removed, but the constraint definition is not removed. The corresponding foreign key and the foreign key access path of the dependent file are not removed. Examples for RMVPFCST In these examples, the unique constraint UNIQUE_Department_NUMBER and the referential constraint EMPLOYEE_Department were added to the files by issuing the following Add Physical File Constraint (ADDPFCST) commands:
ADDPFCST FILE(MYLIB/DEPARTMENTS) TYPE(*UNQCST) KEY(DEPTNUM) CST(UNIQUE_Department_NUMBER) ADDPFCST FILE(MYLIB/PERSONNEL) TYPE(*REFCST) KEY(DEPTNO) CST(EMPLOYEE_Department)
This command removes the unique constraint UNIQUE_Department_NUMBER from the file DEPARTMENTS located in the library MYLIB. Example 2: Removing a Referential Constraint
RMVPFCST FILE(MYLIB/PERSONNEL) CST(EMPLOYEE_Department) TYPE(*REFCST) RMVCST(*RESTRICT)
This command removes the referential constraint EMPLOYEE_Department from the dependent file PERSONNEL located in the library MYLIB. Because the parent file had not yet been established (the PRNFILE had not been specified on the ADDPFCST command) the removal is not restricted. Error messages for RMVPFCST *ESCAPE Messages CPF32B1 Constraint(s) not removed from file &1.
34
An exclusive-no-read lock is held on the physical file when removing the trigger from that file. All logical files which are built over the physical file are also held with the exclusive no-read lock. Restrictions: 1. You must have object alter or object management authority to the physical file, and execute authority to the library that the physical file is in. 2. If the physical file or a dependent logical file or Structured Query Language (SQL) view is opened in this or another job, the trigger cannot be removed. 3. While this command is running, neither the physical file nor any dependent logical files can be opened. 4. In multithreaded jobs, this command is not threadsafe for distributed files and fails for distributed files that use relational databases of type *SNA. Required Parameter FILE Specifies the qualified name of the physical file from which this trigger is removed. The file name must exist on the system. The name of the physical file can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. physical-file-name: Specify the name of the file from which the trigger is removed.
Optional Parameters TRGTIME Specifies the trigger to be removed, based on the time when the trigger program is called. *ALL: All triggers for programs called either before or after a trigger event are removed. *BEFORE: The triggers for programs called before a trigger event are removed. *AFTER: The triggers for programs called after a trigger event are removed. TRGEVENT Specifies the trigger event for which the associated triggers are removed. *ALL: All triggers for insert, delete, update and read operations are removed. *INSERT: The triggers for insert operations are removed. *DELETE: The triggers for delete operations are removed. *UPDATE: The triggers for update operations are removed. *READ: The triggers for read operations are removed. TRG Specifies the name of the trigger to be removed. *ALL: All triggers are removed from the file, including SQL triggers. trigger-name: Specify the name of the trigger to be removed. You can specify a maximum of 128 characters without delimiters or 258 characters with quotation mark () delimiters.
Command Descriptions
35
TRGLIB Specifies the name of the library that the trigger is to be removed from. *FILE: The library for the file specified on the FILE parameter is used. *CURLIB: The current library is used. If no library is specified as the current library for the job, the QGPL library is used. library-name: Specify the name of the library to be used. Examples for RMVPFTRG Example 1: Removing All Triggers for Insert Events
RMVPFTRG FILE(EMP) TRGEVENT(*INSERT)
This command removes all triggers for programs called by insert operations from the physical file named EMP. Example 2: Removing All Triggers for Programs Called Before a Trigger Event
RMVPFTRG FILE(EMP) TRGTIME(*BEFORE)
This command removes all triggers for programs called before trigger events from the physical file named EMP. Example 3: Removing a Trigger for a Program Called After an Insert Event
RMVPFTRG FILE(EMP) TRGTIME(*AFTER) TRGEVENT(*INSERT)
This command removes the trigger for the program called after an insert operation from the physical file named EMP. Error messages for RMVPFTRG *ESCAPE Messages CPF32C6 Trigger operation not successful.
36
configuration-profile-name: Specify the name of a valid, inactive point-to-point configuration profile to delete. DLTCMNCFG Specifies whether you want to delete all communications configuration objects associated with this point-to-point profile. This would include the line, controller and device descriptions defined for use with this profile. Optionally, for some profile types this could also include any network interface descriptions and connection lists associated with the line description being deleted. *NO: Do not delete any of the communications configuration currently associated with this point-to-point profile. *YES: Delete the communications configuration associated with this point-to-point profile. If the communications configuration object to be deleted is found to have other point-to-point profiles or line descriptions using it or is not in a VARIED OFF state, it will not be deleted. If a communications object is not deleted a message will be sent. Examples for RMVTCPPTP Example 1: Delete a Point-to-Point Profile
RMVTCPPTP CFGPRF(SLIPPROF)
This command will remove the point-to-point profile named SLIPPROF. Any communications configuration objects associated with this profile will not be deleted. Example 2: Delete Profile and Related Communications Configuration Objects
RMVTCPPTP CFGPRF(ANSPROF) DLTCMNCFG(*YES)
This command will remove the point-to-point profile named ANSPROF and all communications configuration objects associated with the profile. Additionally, if any of the configuration objects are found to be shared with other point-to-point profiles, such as a line description, then the object will NOT be deleted. If an object is not deleted, a diagnostic message will be sent indicating which object was not deleted and why. Error messages for RMVTCPPTP *ESCAPE Messages TCP83E0 Point-to-point profile &1 not removed.
Command Descriptions
37
1. This command is restricted to a user with *USE and object management authorities for the subsystem description. 2. If the prestart job is active, the End Prestart Jobs (ENDPJ) command must be run before this command can be run. Required Parameters SBSD Specifies the qualified name of the subsystem description that contains the prestart job entry being removed. The name of the subsystem description can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. subsystem-description-name: Specify the name of the subsystem description.
Optional Parameters PGM Specifies the qualified name of the program for the prestart job entry being removed. Two entries with the same program name can exist in a single subsystem description but they must have different library names. The name of the program can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. program-name: Specify the name of the program.
This command removes the prestart job entry for the PGM1 program (in the QGPL library) from the PJE subsystem description contained in the QGPL library. Error messages for RMVPJE *ESCAPE Messages
38
CPF1619 Subsystem description &1 in library &2 damaged. CPF1691 Active subsystem description may or may not have changed. CPF1697 Subsystem description &1 not changed.
39
*ALL: All programs currently in the debug mode are removed. program-name: Specify the names of up to 20 programs being removed from the current debugging session. Example for RMVPGM
RMVPGM PGM(PGMX PGMY PGMZ)
This command removes the three programs PGMX, PGMY, and PGMZ from the current debugging session. All breakpoints and data traces are removed from the programs. Error messages for RMVPGM *ESCAPE Messages CPF1999 Errors occurred on command.
40
RMV
Specifies whether the PTFs are removed temporarily or permanently. Permanently removed PTF objects are moved to QRPLOBJ or deleted. Temporarily removed PTFs are held in the product PTF library for application at a later time. *TEMP: The PTFs are removed and held in the product PTF library so that they can be applied again later, if desired. *PERM: The PTFs are permanently removed and placed in QRPLOBJ.
DELAYED Specifies whether immediate PTFs are removed at the time the command is run, or whether immediate or delayed PTFs are removed during the next unattended IPL. *NO: Immediate PTFs that are identified are removed at the time the command is processed. Delayed PTFs are ignored during the RMVPTF request and are not removed. For delayed PTFs, if the PTF has a status of Not Applied and you have specified RMV(*PERM), the PTF is permanently removed at the time the command is run. For immediate PTFs that are being temporarily removed, any preconditions that are not satisfied will result in the PTF not being removed. A message is sent for each PTF that is not removed. *YES: Both delayed and immediate PTFs that are identified are removed during the next unattended IPL. The Remove on unattended IPL prompt (IPLRMV parameter) determines whether PTFs are removed during the next unattended IPL, or whether any previous request to remove the PTFs during the next unattended IPL is canceled. IPLRMV Specifies the action that is done for delayed or immediate PTFs at the next unattended IPL. This parameter is valid only if DELAYED(*YES) is also specified. *YES: The identified PTFs are removed at the next unattended IPL. The RMV parameter determines whether the remove is temporary or permanent. *NO: Any previous request to remove the identified PTFs at the next unattended IPL is canceled. RLS Specifies the release level of the PTFs being removed. *ONLY: This value is valid when only one release of the products base option is installed on the system. PTFs for all installed options of the product are removed regardless of the release-level of the option. release-level: Specify the release level in VxRyMz format, where Vx is the version number, Ry is the release number, and Mz is the modification level. The variables x and y can be a number from 0 through 9, and the variable z can be a number from 0 through 9 or a letter from A through Z. If the release-level specified is the release-level of the base option of the product, PTFs for all installed options of the product are removed regardless of the release-level of the option. If the release-level specified is not the release-level of the base option of the product, only PTFs for the options installed at that release-level are removed. RMVDEP Specifies whether mutually dependent PTFs and dependent PTFs in the same product and option as the PTFs specified in the SELECT parameter are processed with the PTFs specified in the SELECT parameter list. *NO: The mutually dependent and dependent PTFs are not processed with the SELECT parameter list. No PTFs are removed if any PTF specified in the list has dependent PTFs not also in the list or already applied. Messages identify the missing dependent PTFs and the specified PTFs on which they depend. *YES: The PTFs are removed with the SELECT parameter list. Examples for RMVPTF
Command Descriptions
41
This command temporarily removes all temporarily applied PTFs from the Operating System/400 product (5722SS1) at the next IPL. The PTFs can be applied again, if necessary, using the APYPTF command. Example 2: Permanently Removing PTFs
RMVPTF LICPGM(5722SS1) RMV(*PERM) SELECT(SI10002 SI10005)
This command permanently removes two PTFs (numbers SI10002 and SI10005) from the Operating System/400 product (5722SS1). The two PTFs are moved to QRPLOBJ and must be loaded again using the LODPTF command before they can be applied. Example 3: Removing PTFs and their mutual dependents
RMVPTF LICPGM(5722SS1) SELECT(SI00003 SI00008 SI00012) DELAYED(*YES) RMVDEP(*YES)
This command temporarily removes PTFs SI00003, SI00008, SI00012, and their dependent and mutually dependent PTFs within the same product and option from the Operating System/400 product in library QSYS at the next IPL. Error messages for RMVPTF *ESCAPE Messages CPF24B4 Severe error while addressing parameter list. CPF35A0 Cannot allocate library &1. CPF35A1 Wrong copy of Licensed Internal Code in use. CPF35A4 Licensed Internal Code fix &2 cannot be removed. CPF35A9 Error occurred while processing Licensed Internal Code fix. CPF35C0 IPL action cannot be removed for PTF &1-&2 &3. CPF35D0 Licensed Internal Code fix &1-&2 &3 not set to be removed permanently. CPF35D2 PTF &1-&2 not removed. CPF35EB Multiple releases of product &1 installed. CPF35E4 Information for PTF &1-&2 &3 not complete. CPF35FB PTF &1-&2 not removed. CPF3558 Cannot allocate &1 in &3 type *&2.
42
CPF3564 PTF &1-&2 damaged. CPF358A Release not valid. CPF3596 PTF numbers in select/omit list not permitted. CPF3598 PTF function already in process. CPF3602 PTF &2 not removed because it is permanently applied. CPF3604 PTF not removed because an error occurred. CPF3606 Product &1 &2 not installed. CPF361E Error occurred while removing PTFs for product &1. CPF3612 Library &1 not found. CPF3641 No immediate PTFs removed. CPF3658 No program temporary fixes identified. CPF3693 Service function ended because error occurred. CPF3931 Required programs not found. PTF incomplete. CPF3945 Records of PTF activity for licensed program are deleted. CPF3956 Error occurred during PTF processing.
43
This command removes the TCP protocol entry from the protocol table. Error messages for RMVPCLTBLE *ESCAPE Messages TCP2902 Protocol entry not found in table.
This command removes the entry YOURRDB from the relational database directory. The entry is no longer accessible. Error messages for RMVRDBDIRE *ESCAPE Messages CPF3EC2 Remove relational database directory entry failed.
44
This command removes the definition from remote system RCHAS1. This system now uses the values for the *ANY remote definition or the defaults. Example 2: Removing all Remote Definitions
RMVRMTDFN SYSTEM(*ALL)
This command removes all remote system definitions. All systems now use the default values. Error messages for RMVRMTDFN *ESCAPE Messages CPF6DCA SYSTEM parameter cannot be local system. CPF6DCC Remote definition for system &1 &2 not found. CPF9899 Error occurred during processing of command.
45
The Remove Remote Journal (RMVRMTJRN) command disassociates a remote journal on the specified target system from the specified journal on the source system. The journal on the source system may be either a local journal or another remote journal. The remote journal, and any associated journal receivers, are not deleted from the target system by the command processing. No processing is performed on the target system for the command. The remote journal that remains on the target system may later be added back to the remote journal definition for the journal on the source system by using the Add Remote Journal (ADDRMTJRN) command or the Add Remote Journal (QjoAddRemoteJournal) API. It is the responsibility of the user to delete the remote journal and any associated journal receivers from the target system, if so desired. Once a remote journal association has been removed from a journal, all of the journal receivers that are currently in the journals receiver directory on the source system will no longer be protected from deletion even if the journal entries have not yet been replicated to the remote journal. Restrictions: The following restrictions apply: v The command must be called from the source system for a local or remote journal. v The remote journal on the specified target system cannot have a journal state of *ACTIVE. v The specified relational database directory entry (RDB) must meet the following rules: The communications protocol must be one of the remote journal function supported protocols. The remote location name in the RDB cannot refer to the *LOCAL database. The RDB cannot use an application requester driver program (*ARDPGM) to locate the target system. Required Parameters RDB The name of the relational database directory entry that contains the remote location name of the target system. relational-database-entry: Specify a maximum of 18 characters for the name of the relational database directory entry. SRCJRN The name of the journal on the source system from which the remote journal is being removed, and the library where it resides. The journal on the source system may be either a local journal or a remote journal. The name of the source journal can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. source-journal-name: Specify the source journal from which the target journal is being removed.
46
Optional Parameters TGTJRN The name of the remote journal on the target system. *SRCJRN: The target journal name is exactly the same as the source journal name. library-name/target-journal-name: Specify the target journal that is being removed from the source journal. Example for RMVRMTJRN Example 1: Removing a remote journal whose name is the same as the source journal.
RMVRMTJRN SRCJRN(RMTLIB/JOURNAL) RDB(CHICAGO) TGTJRN(*SRCJRN)
This command removes remote journal JOURNAL in library RMTLIB identified by relational database directory entry, CHICAGO, from the source journal JOURNAL in library RMTLIB. Error messages for RMVRMTJRN *ESCAPE Messages CPF6981 Remote journal &1 in &2 not removed. CPF6982 Relational database directory entry &1 not valid. CPF6992 Remote journal &1 in &2 not removed. CPF9801 Object &2 in library &3 not found. CPF9802 Not authorized to object &2 in &3. CPF9803 Cannot allocate object &2 in library &3. CPF9810 Library &1 not found. CPF9820 Not authorized to use library &1. CPF9830 Cannot assign library &1.
Command Descriptions
47
The Remove Remote Program Temporary Fix (RMVRMTPTF) command allows a service provider to remotely remove PTFs from a service requesters system. When using the RMVRMTPTF command, you can request an IPL of the service requesters system. The remove PTF and IPL can be scheduled to occur at a later date and time.
Note: A change request is automatically submitted that can be viewed to determine the status of this command. You can use the Work with Submitted Change Request (WRKSBMCRQ) command to monitor the status.
Restrictions: 1. The remove and IPL functions of this command are only supported when the service requester has the Managed System Services licensed program installed. 2. If a NODL value is specified, the node list can only contain entries that have value of *SNA for the address type. 3. PTFs are always removed temporarily except Vertical Licensed Internal Code (VLIC) PTFs which are removed permanently. 4. Dependent PTFs must already be removed on the service requester. PTFs are removed in the order that they are listed on the command. Required Parameters PTFID Specifies the PTF that is to be removed. A maximum of 300 PTF identifiers can be specified. Element 1: PTF Identifier ptf-identifier: A 7-character PTF identifier. *ALL: Removes all PTFs for the specified product. Element 2: Product Identifier *ONLY: Specifies that the PTF identifier is associated with only one product. product-id: Specify the product of the PTF. The product must be specified when PTF identifiers are not unique across products or the PTF identifier is *ALL. Element 3: Release Level of Product release(VxRxMx): Specify the release level of the product. The format is VxRxMx. DESTSRVRQS Specifies the service requester where this PTF function is to be performed. A single service requester or a list of service requesters can be specified. Element 1: Network Identifier *SELECT: Shows a list of service requesters. From the list, you can select one or more service requesters. *SELECT is not valid when the command is used in a batch environment. *ALL: Specifies that this PTF function should occur on all of the service requesters that are defined for this service provider. *NONE: The service requesters are identified in a node list object. *NETATR: The remote network identifier of the service requester is the same as the network identifier of this system. remote-network-identifier: Specify the remote network identifier of the service requester. Element 2: Control Point This element is not valid when the network identifier is *ALL, *SELECT, or *NODE.
48
remote-control-point: Specify the remote control point name of the service requester. Optional Parameters DLYRMV Specifies how PTFs are removed. Remove immediate PTFs at the time the activity runs on the specified system or later during the next IPL. *NO: Removes an immediate PTF at the time the activity runs. If the PTF is marked delayed, it is not applied until the next unattended IPL. *YES: Removes both immediate or delayed PTFs during the next unattended IPL. NODL Specifies the node list object name that contains a list of service requesters where this PTF function is to be performed. *NONE: The service requesters are identified in the DESTSRVRQS parameter. The possible library values are the following:
*LIBL: Searches all of the libraries in the user and system portions of the jobs library list for the node list object.
*CURLIB: Searches for the node list object in the library for the current job.
library-name: Specify the name of the library to be searched. node-list-name: Specify the node list name that contains the list of service requesters where this PTF function is to be performed. RMTRMVTIME Specifies the date and time when this PTF function can occur on the service requester. The current date and time values and next date are determined, when this PTF function is processed on this system, based on this systems date and time. Element 1: Time Zone *LCLSYS Specifies the remote start time in the time zone of this system. *MGDSYS: Specifies the remote start time in the time zone of the service requesters system. Element 2: Start After Time *CURRENT: Starts this PTF function on the service requester system at any time on or after this PTF function request is processed on this system. start-after-time: Specify the time when this PTF function can be started on the service requester. The time can be entered as 4 or 6 digits, such as hhmm or hhmmss where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss). Element 3: Start After Date *CURRENT: Starts this PTF function on the service requester system on any date on or after the date this PTF function is processed on this system. *NEXT: Starts this PTF function on the service requester system on any date after the date this PTF function is processed on this system. start-after-date: Specify the date when this PTF function can start on the service requester system. The date must be specified in the job date format.
Command Descriptions
49
Note:
The special values *CURRENT and *NEXT cannot be specified for the date and time when the time zone value *MGDSYS is specified.
IPL
Specifies if an IPL of the service requesters system should occur. *NO: An IPL of the service requester system should not occur. *YES: An IPL of the service requester system should occur after all the PTFs listed on the command are successfully removed.
RMTIPLTIME Specifies the date and time when the IPL can occur on the service requester. The current date and time values and next date are determined, when this IPL request is processed on this system, based on this systems date and time. Element 1: Time Zone *LCLSYS Specifies the remote start time in the time zone of this system. *MGDSYS: Specifies the remote start time in the time zone of the service requesters system. Element 2: Start After Time *CURRENT: Starts the IPL on the service requester system at any time on or after the IPL request is processed on this system. start-after-time: Specify the time when the IPL can be started on the service requester. The time can be entered as 4 or 6 digits, such as hhmm or hhmmss where hh = hours, mm = minutes, and ss = seconds. Seconds are optional. The time can be specified with or without a separator. With a time separator, specify a string of 5 or 8 digits (hh:mm or hh:mm:ss). Element 3: Start After Date *CURRENT: Starts the IPL on the service requester system on any date on or after the date this IPL request is processed on this system. *NEXT: Starts the IPL on the service requester system on any date after the date this IPL request is processed on this system. start-after-date: Specify the date when the IPL can start on the service requester system. The date must be specified in the job date format.
Note: The special values *CURRENT and *NEXT cannot be specified for the date and time if the time zone value *MGDSYS is specified.
PWRDWNOPT Specifies how to manage the end of active jobs during IPL process at the service requester system. This parameter is valid only if IPL(*YES) is specified. *CNTRLD: All jobs end when the specified time in the Power down delay (PWRDWNDLY) parameter expires. Any current jobs that are running will perform an end of batch processing. *IMMED: Jobs end immediately. PWRDWNDLY This parameter is valid only if IPL(*YES) and if PWRDWNOPT(*CNTRLD) are specified. Specifies the amount of time in seconds that the system allows a controlled end to be performed. If the end of job routines are not finished in the specified power down delay, any remaining jobs are ended immediately. 3600: The amount of time in which to complete a controlled end of processing is limited to 3600 seconds.
50
delay-time: Specify the maximum amount of delay time, in seconds, in which a controlled end can be performed. Valid values range from 1 through 65535 (65,535 seconds). Examples for RMVRMTPTF Example 1: Removing a PTF
RMVRMTPTF PTFID((123456 *ONLY V5R2M0)) DESTSRVRQS(*SELECT)
Remove a PTF from one or more selected service requesters. Example 2: Removing a PTF on a Certain Date
RMVRMTPTF PTFID((*ALL DESTSRVRQS((*NETATR RMTAPYTIME((*MGDSYS RMTIPLTIME((*MGDSYS PRODUCT V5R2M0)) CHICAGO1) (*NETATR CHICAGO2)) (10:00:00 10/31/02)) IPL(*YES) (01:00:00 11/01/02))
This example removes the PTFs on the service requesters starting at 10:00 a.m. on October 31, 2002. If all the PTFs were removed successfully, the service requesters system IPL starts at 1:00 a.m. on November 1, 2002. Example 3: Doing an IPL after removing a PTF
RMVRMTPTF PTFID((987654 *ONLY V5R2M0)) DESTSRVRQS(*SELECT))) IPL(*YES) RMTIPLTIME(*LCLSYS (*CURRENT 12/24/2002)) PWRDWNOPT(*IMMED)
To remove a PTF from one or more selected service requesters, the IPL should occur for all selected service requesters. This example removes the PTF on the service requesters. If the PTF is removed sucessfully, the IPL on the remote system starts at the current time on December 24, 2002. The times specified are in the time zone of the local system. Example 4: Removing a PTF with two corequisite PTFs and one prerequisite PTF
RMVRMTPTF PTFID((SF00001 *ONLY V5R2M0)) DESTSRVRQS(*SELECT) RMTRMVTIME(*LCLSYS (*CURRENT *CURRENT)) IPL(*NO)
Remove PTF number SF00001. This PTF has 2 corequisite PTFs and one prerequisite PTF. PTFs SF00002 and SF00003 are corequisite PTFs for PTF SF00001. PTF SF00004 is a prerequisite for PTF SF00001. The system will remove PTFs SF0001, SF00002, and SF00003. However, the prerequisite PTF will not be removed. The system will determine all corequisite PTFs if they were not specified. No IPL will be performed, and this action applies the PTFs on the service requesters. The times specified are in the time zone of the local system. Error messages for RMVRMTPTF *ESCAPE Messages CPF358A PTF &1-&2 cannot be applied or removed.
51
The Remove Reply List Entry (RMVRPYLE) command removes an entry from the system reply list. The reply list is used as a source for automatic responses to predefined inquiry messages. The reply list is only used when an inquiry message is sent by a job that has the inquiry message reply attribute of the system reply list specified (INQMSGRPY(*SYSRPLY) is specified). INQMSGRPY(*SYSRPLY) can be changed with the CHGJOB command. New entries may be added to the reply list with the Add Reply List Entry (ADDRPYLE) command; entries can be changed with the Change Reply List Entry (CHGRPYLE) command. The entire list of entries can be shown with the Work with System Reply List Entries (WRKRPYLE) display. From the display that is presented the user can add, change, and remove individual entries. Restriction: This command is shipped with public *EXCLUDE authority and the QPGMR user profile has private authority to use the command. Required Parameters SEQNBR Specifies the sequence number of the reply list entry being removed from the system reply list. *ALL: Specifies that all reply list entries are removed from the system reply list. Whenever *ALL has been specified, and the reply list object had previously been marked as damaged, the reply list is deleted and recreated. No reply list entries will be present after re-creation. They must be reentered or a reinstall operation must be done.
Note: Specifying the sequence number 0 has the same behavior as specifying the special value *ALL.
sequence-number: Specify the sequence number of the file. Valid values range from 1 through 9999. Examples for RMVRPYLE Example 1: Removing All Entries
RMVRPYLE SEQNBR(*ALL)
This command removes all entries from the system reply list. Example 2: Removing One Entry
RMVRPYLE SEQNBR(0001)
This command removes from the system reply list the entry that has sequence number 0001. Error messages for RMVRPYLE *ESCAPE Messages CPF2435 System reply list not found. CPF2556 Sequence number &1 not defined in system reply list. CPF2557 System reply list damaged. CPF2558 System reply list currently in use.
52
This command removes buffer number 2 and all buffers with numbers higher than 2 from the REXX external data queue. Error messages for RMVREXBUF *ESCAPE Messages CPF7CF7 REXX external data queue is damaged.
*LIBL: All libraries in the jobs library list are searched until the first match is found.
Command Descriptions
53
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. subsystem-description-name: Specify the name of the subsystem description. SEQNBR Specifies the sequence number of the routing entry being removed. The sequence numbers on the routing entries indicate the order in which the routing entries will be processed when comparing values. When a job enters the system, the compare value for the job is compared to the compare value for the routing entries in a subsystem. When the first match is found, the routing information for that entry is used for the new job; therefore, the sequence numbers indicate the compare order. Example for RMVRTGE
RMVRTGE SBSD(OR/PERT) SEQNBR(9912)
This command removes the routing entry 9912 from subsystem description PERT in library OR. Error messages for RMVRTGE *ESCAPE Messages CPF1619 Subsystem description &1 in library &2 damaged. CPF1691 Active subsystem description may or may not have changed. CPF1697 Subsystem description &1 not changed.
*LIBL: All libraries in the jobs library list are searched until the first match is found.
54
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. search-index-name: Specify the name of the search index. PNLGRP Specifies the name of the panel group for which entries are being removed. Example for RMVSCHIDX
RMVSCHIDX SCHIDX(ACCOUNTING) PNLGRP(PAYROLL)
This command removes panel group PAYROLL from search index ACCOUNTING.
*CURRENT: Specifies that the server authentication entry will be removed for the current user.
user-profile-name: Specify the name of the user for which to remove the server authentication entry. SERVER Specifies the name of the application server.
*ALL: Specifies that all server authentication entries for this user profile will be removed.
server-name: Specify the name for the particular application server whose entry is to be removed. Specify no more than 200 characters.
Command Descriptions
55
This command removes the server authentication entry for MPLS_RDB from the current user profile. Error messages for RMVSVRAUTE *ESCAPE Messages CPF2204 User profile &1 not found. CPF2213 Not able to allocate user profile &1. CPF225E Server authentication entry does not exist. CPF226C Not authorized to perform function.
This command removes an FTP service entry from the network service table. The service being removed is assigned to port 21 and runs the TCP protocol. Error messages for RMVSRVTBLE *ESCAPE Messages TCP2901 Service entry not found in table.
56
This command removes two systems (RCHSTR1 and RCHSTR2) from the alert sphere of control.
57
begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. cartridge-identifier: Specify a maximum of 40 cartridge identifiers to remove. CGY
Note:
Specifies the category from which the tape cartridges are to be removed.
If this parameter is specified, the CTG parameter cannot be specified.
Element 1: Category Name *NOSHARE: The cartridge identifiers assigned to the *NOSHARE category are removed. The cartridge identifiers in this category cannot be shared with other systems. *IPL: The cartridge identifiers assigned to the *IPL category are removed. The cartridge identifiers in this category can be used for an alternate IPL. *NL: The cartridge identifiers assigned to *NL category are removed. The cartridge identifiers in this category are used as a non-labeled tape. *CNV: All cartridge identifiers assigned to the *CNV category are removed. A cartridge in this category would be automatically removed by OS/400 if the cartridge was loaded and an unload was requested by a user. category-name: Specify the name of a user-defined category. The cartridge identifiers assigned to the specified user-defined category are removed. Element 2: Category System This element identifies the system to which the category belongs. The system name is obtained from the pending system name field of a Display Network Attributes (DSPNETA) command. If there is no pending system name, the current system attribute is used. Attention: If the system name is changed, the categories associated with all tape cartridges in library devices owned by the system are no longer valid. *CURRENT: The category belongs to the system currently running the command. system-name: Specify the name of the system to which the category belongs. Single Values: *SHARE400: The cartridge identifiers assigned to the *SHARE400 category are removed. The cartridge identifiers in this category can be shared with other systems attached to the same device. *INSERT: The cartridge identifiers assigned to the *INSERT category are removed. The cartridge identifiers in this category are for cartridges that have been placed in the library device, but whose identifier has not been added to the system. Optional Parameter
58
STATION Specifies the station to receive the cartridges being ejected. *DEV: If the tape library has a convenience input/output (I/O) station, the cartridges are placed in it. If the tape library does not have a convenience I/O station, the cartridges are placed in either the high capacity output station or a storage slot within the library. *CNV: The tape cartridge is ejected into the convenience I/O station. The convenience I/O station allows entry and removal of the tape cartridges from the library without opening the library door. *HIGHCAP:The tape cartridges either are ejected into the high capacity output station or are returned to a storage slot in the library device. Both of these outcomes require that the library door be opened to physically remove the tape cartridges from the library. Examples for RMVTAPCTG Example 1: Removing a Single Cartridge to the *EJECT Category
RMVTAPCTG DEV(LIB01) STATION(*HIGHCAP) CTG(VOL4)
This command removes the cartridge identifier VOL4 from its current category and places it in the *EJECT category. The cartridge is placed in a storage slot or the high capacity output station. Example 2: Removing All Cartridges from the *IPL Category
RMVTAPCTG DEV(LIB01) STATION(*CNV) CGY(*IPL)
This command removes all cartridge identifiers in the *IPL category and places them in the *EJECT category. The cartridges are placed in the convenience I/O station. Error messages for RMVTAPCTG *ESCAPE Messages CPF67AF &6 cartridges not removed CPF6745 Device &1 not a media library device.
Command Descriptions
59
v Merge TCP/IP Host Table (MRGTCPHT) command merges host names, internet addresses, and text comment entries from a physical file member into the local host table. A replace option is also provided that allows the entire local host table to be replaced by the host table entries in a user specified physical file member. v Rename TCP/IP Host Table Entry (RNMTCPHTE) command renames the internet address of a host table entry to another internet address Restriction: You must have *IOSYSCFG special authority to use this command. Required Parameter INTNETADR Specifies the internet address that is to be removed from the local host table. The internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes. Example for RMVTCPHTE
RMVTCPHTE INTNETADR(132.28.71.5)
This command removes the host table entry with an internet address of 132.28.71.5. This includes the internet address, all associated host names, and the text description field associated with the entry. Error messages for RMVTCPHTE *ESCAPE Messages TCP1901 Internet address &1 not valid. TCP1902 Internet address &1 not valid. TCP1907 Internet address entry &1 does not exist. TCP1908 Internet address &1 not valid. TCP1929 Host table not available. TCP9999 Internal system error in program &1.
60
An interface that is required for an existing route or remote system information (RSI) entry cannot be removed. This command can be used to remove interfaces that have been specified with the Add TCP/IP Interface (ADDTCPIFC) command. Restriction: You must have *IOSYSCFG special authority to use this command. Required Parameter INTNETADR Specifies the internet address of an interface that had previously been added to the TCP/IP configuration with the Add TCP/IP Interface (ADDTCPIFC) command. The internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes. internet-address: Specify the internet address associated with the interface to be removed. Example for RMVTCPIFC
RMVTCPIFC INTNETADR(9.5.11.125)
This command removes the interface associated with the internet address 9.5.11.125. Error messages for RMVTCPIFC *ESCAPE Messages TCP1D03 &1 member record length not correct. TCP1D04 Error occurred processing member &1 of &2/&3. TCP1901 Internet address &1 not valid. TCP8050 *IOSYSCFG authority required to use &1. TCP9999 Internal system error in program &1.
Command Descriptions
61
There are two independent sets of ports. One set is for TCP processing and the other is for UDP processing. They are completely independent sets of ports and have no relationship to one another. Restriction: You must have *IOSYSCFG special authority to use this command. Required Parameters PORT Specifies the port number or range of port numbers that are having the user profile removed from the list of user profiles that are allowed to use that port or range of ports. Valid values range from 1 through 65535. However, ports 1 through 1023 are reserved for use by system-supplied TCP/IP applications. If the user specifies ports 1 through 1023, it can affect the operation of those applications. Element 1: Lower Port Value lower-value: Specify the port value or the lower port value (in a range) from which you want the user profile removed. *ALL: The port range values that are removed are 1-65535. Element 2: Upper Port Value *ONLY: The port value specified in the lower port value is the only port value that has the user profile removed. upper-value: Specify the upper port value (in a range) from which you want the user profile removed. PROTOCOL Specifies the transport protocol associated with the port or range of ports having the user profile removed from the list of user profiles that have exclusive use of a port or range of ports. *UDP: The port is a User Datagram Protocol (UDP) transport protocol port. *TCP: The port is a Transmission Control Protocol (TCP) transport protocol port. USRPRF Specifies the name of the user profile whose profile is to be removed from the list of user profiles that have exclusive use of the port or range of ports. user-profile-name: Specify the user profile that is to be removed. Example for RMVTCPPORT Example 1: Removing Restriction on a Single User Profile
RMVTCPPORT PORT(1590) USRPRF(USER1) PROTOCOL(*UDP)
This command removes the restriction for the user profile named USER1 for UDP port 1590. This user profile is removed from the list of user profiles that are allowed to use port number 1590. Example 2: Removing Restriction on a Range of Ports
RMVTCPPORT PORT(1590 2000) USRPRF(USER2) PROTOCOL(*TCP)
This command removes the restriction for the user profile named USER2 for TCP ports 1590 through port 2000. This user profile is removed from the list of user profiles that are allowed to use ports 1590 though 2000. Example 3: Removing All Ports
62
PROTOCOL(*TCP)
This command removes the restriction for the user profile named USER3 for TCP port 1 through port 65535. The command will complete successfully even if the user did not have a port within this range restricted. This user profile is removed from the list of user profiles that are allowed to use any of the TCP ports. Error messages for RMVTCPPORT *ESCAPE Messages TCP1D03 &1 member record length not correct. TCP1D04 Error occurred processing member &1 of &2/&3. TCP26E2 User profile &1 damaged. TCP26E4 Port restriction action successful, but TCP/IP errors occurred. TCP26E7 You cannot have *ALL and *ONLY. TCP26FA Port restriction &1 - &2 not removed. TCP26FB The user profile &1 does not exist TCP26FC Upper port value must be *ONLY. TCP26FD Port &1 not found. TCP26F1 Range of ports not valid. TCP26F2 Removal of port restriction &1 - &2 not valid. TCP8050 *IOSYSCFG authority required to use &1. TCP9503 File &3 in library &2 not available. TCP9526 User profile &1 not found. TCP9999 Internal system error in program &1.
63
The Remove TCP/IP Remote System Information (RMVTCPRSI) command removes a remote system information entry that associates an internet address with an X.25 network address in the TCP/IP configuration. If you attempt to remove a remote system information entry that is associated with an internet address that is active on an X.25 networks SVC or PVC, the remove operation fails. Restriction: You must have *IOSYSCFG special authority to use this command. Required Parameter INTNETADR Specifies the internet address of the remote system. The internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes. Example for RMVTCPRSI
RMVTCPRSI INTNETADR(128.1.1.10)
This command removes the internet address named 128.1.1.10 from the TCP/IP configuration remote system information data, along with its corresponding X.25 network address and other data. Error messages for RMVTCPRSI *ESCAPE Messages TCP1D03 &1 member record length not correct. TCP1D04 Error occurred processing member &1 of &2/&3. TCP1901 Internet address &1 not valid. TCP1902 Internet address &1 not valid. TCP1908 Internet address &1 not valid. TCP26D4 Remote system information not removed. TCP26D5 Error occurred processing file. TCP8050 *IOSYSCFG authority required to use &1. TCP9999 Internal system error in program &1.
64
Restrictions: 1. You must have *IOSYSCFG special authority to use this command. 2. Attempts to remove a route that is required to reach an existing RSI entry will fail. Required Parameters RTEDEST Specifies the route destination being removed. You must specify all 4 bytes that make up an internet address though some of the bytes may be equal to 0. For example, a route to all the hosts on the 9.5.11 subnetwork is identified by entering 9.5.11.0 for the route destination. Used in combination with a subnetmask, type of service value, and next hop, the route destination uniquely identifies a route to a network or system. *DFTROUTE: Specifies that a default route entry is being removed. A default route entry is used by the system to route data that is being sent to a remote destination that does not have a specific route defined. The system allows a maximum of 8 default route entries. The default route entries are used based on the availability of the next hop gateway and the type of service (TOS). If the application requests a specific TOS, the TOS of the default route used must match the TOS requested. If no default route is found that matches the requested TOS, the first available default route with a TOS of *NORMAL is used. *DFTMCAST: Specifies that a default multicast route entry is being removed. A default multicast route entry is used by the system to select a local interface when sending data to a multicast group. The default multicast entry is used when the application does not specifically name the local interface over which multicast packets should be sent. When RTEDEST(*DFTMCAST) is specified, SUBNETMASK(*NONE) must be specified and the NEXTHOP parameter must be the internet address of an interface that had previously been added with the Add TCP/IP Interface (ADDTCPIFC) command. route-destination: Specify the route destination being removed. The route destination can be specified in the form nnn.0.0.0, for Class A, nnn.nnn.0.0 for Class B, and nnn.nnn.nnn.0 for Class C, or nnn.nnn.nnn.nnn for any combination thereof, where nnn is a decimal number ranging from 0 through 255.
Command Descriptions
65
Any combination thereof means that you may specify a route, such as 9.5.0.0 to the hosts on the 9.5 subnet, even though all 9.5.x.x addresses are class A network addresses. Exceptions: v The first byte (octet) must be greater than 0 and less than 255. v The last byte (octet) may not equal 255. v The last byte (octet) may not equal 0 if *HOST is specified for the SUBNETMASK value. v Routes to a broadcast address are not allowed. SUBNETMASK Specifies a bit mask that identifies to TCP/IP which bits of the value specified for the route destination (RTEDEST) compose the network and subnet portions of the internet address. By defining the network portion and subnetwork portion of the RTEDEST address, the subnet mask also defines which bits of the RTEDEST address make up the host portion. The mask is a 32-bit combination that is logically ANDed with the internet address to determine a particular subnetwork. The bits of the mask set to the value one (1) determine the network and subnetwork portions of the address. The bits set to the value zero (0) determine the host portion of the address. *NONE: There is no subnet mask. If RTEDEST(*DFTROUTE) or RTEDEST(*DFTMCAST) is specified, then SUBNETMASK(*NONE) must be specified. *NONE is valid only for the *DFTROUTE and *DFTMCAST route destination values. *HOST: The internet address value specified in the route destination field is a host address. The subnetmask value is calculated to be 255.255.255.255. subnet-mask: Specify the mask of the subnet field. The internet address is in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. The subnetmask network classs network ID part of the destination routes internet address must equal 255. For example, a destination routes internet address value of 129.35.11.0 is a Class B subnet. The network ID part of its address is 129.35. The upper 2 bytes must designate 255 in the subnetmask. The subnetmask must appear in the format 255.255.x.x, where x is determined by the user. The portion of the subnetmask that is associated with the network portion of a particular class of address must equal 255. Optional Parameters TOS Specifies the type of service to be used. The type of service defines how the internet hosts and routers should make trade-offs between throughput, delay, reliability, and cost. *NORMAL: Normal service is used for delivery of data. *MINDELAY: Minimize delay means that prompt delivery is important for data on this connection. *MAXTHRPUT: Maximize throughput means that a high data rate is important for data on this connection. *MAXRLB: Maximize reliability means that a higher level of effort to ensure delivery is important for data on this connection. *MINCOST: Minimize monetary cost means that lower cost is important for data on this connection. The type of service, together with the subnetmask, next hop, and route destination, uniquely identifies a route to be removed. If this parameter is not specified, a value of *NORMAL is used. NEXTHOP Specifies the internet address of the next system (gateway) on the route. internet-address: Specify the internet address. The internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID)
66
portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes. BINDIFC The local IP interface to bind this route to. The binding is preferred and absolute. If the IP interface defined for BINDIFC is active then the route specified will be bound to that interface. *NONE: TCP/IP will not attempt to bind this route to a particular IP interface but will bind it to the first active IP interface on the network as defined by the NEXTHOP and SUBNETMASK parameters. binding-interface: Specify an IP interface to bind this route to. The binding is preferred and absolute. Examples for RMVTCPRTE Example 1: Removing a Route
RMVTCPRTE RTEDEST(132.65.0.0) SUBNETMASK(255.65.0.0) TOS(*MINDELAY) NEXTHOP(9.5.15.1)
This command removes the route identified as 132.65.0.0 with a subnetmask of 255.65.0.0, a type of service of *MINDELAY, and a next hop of 9.5.15.1. Example 2: Removing a Default Route
RMVTCPRTE RTEDEST(*DFTROUTE) SUBNETMASK(*NONE) NEXTHOP(186.34.76.92)
This command removes a host route identified as a default route (*DFTROUTE). The subnetmask is specified as *NONE and the type of service defaults to *NORMAL. The subnetmask, type of service, and next-hop value differentiate this *DFTROUTE from the other possible eight *DFTROUTE entries. Error messages for RMVTCPRTE *ESCAPE Messages TCP1D03 &1 member record length not correct. TCP1D04 Error occurred processing member &1 of &2/&3. TCP1901 Internet address &1 not valid. TCP261C Process completed successfully. TCP264A &2 &1 not removed. TCP8050 *IOSYSCFG authority required to use &1. TCP9999 Internal system error in program &1.
Command Descriptions
67
Restriction: You must have *IOSYSCFG special authority to use this command. Required Parameters TBL
Note:
*ALL: The IP Filter rule table, the IP Network Address Translation table and the IP Security Tables will be removed from use. All security features will no longer be operative. *IPFTR: See *ALL parameter value description. *IPNAT: See *ALL parameter value description. Example for RMVTCPTBL
RMVTCPTBL
This command removes all rule files from use. Error messages for RMVTCPTBL *ESCAPE Messages TCP8050 *IOSYSCFG authority required to use &1.
68
remove a trace, exactly the same range (as specified on the ADDTRC command) must be specified. Up to five sets of trace ranges can be specified in one command. Restrictions: 1. This command is valid only in debug mode. To start debug mode, refer to the STRDBG (Start Debug) command. 2. This command cannot be used if the user is servicing another job, and that job is on a job queue, or is being held, suspended, or ended. 3. This command cannot be used to remove a trace from a bound program. Optional Parameters STMT Specifies the HLL statement identifiers or machine instruction numbers of the trace statements that are no longer being traced. Unless *ALL is specified, to remove a trace from a program, the same statement identifiers must be specified here that were specified on the ADDTRC command. The method used to specify the trace statements on the ADDTRC command (that is, HLL statement identifiers versus machine instruction numbers) must also be used here to remove them. *ALL: All HLL statements and/or machine instructions in the specified programs are no longer traced regardless of how the trace was defined by the ADDTRC command. Element 1: Statement Identifier of First Trace Statement start-statement-identifier: Specify the HLL statement identifier (or the machine instruction number) of the first trace statement being removed from future tracing. Up to five trace ranges can be specified in the program for each use of this command. Element 2: Statement Identifier of Last Trace Statement stop-statement-identifier: Specify, optionally, the HLL statement identifier (or the machine instruction number) of the last statement being removed from future tracing. If the last statement was specified on the ADDTRC command, the last statement must also be specified here. Up to five trace ranges can be specified in the program for each use of this command. PGM Specifies the program (or all programs) containing the trace statements being removed from future tracing operations. *DFTPGM: The program currently specified as the default program contains the statements being removed from tracing. *ALL: All programs that currently have trace ranges in them have all of their trace ranges removed; no tracing can be done in any of the programs in debug mode unless more traces are added by the ADDTRC command. PGM(*ALL) is valid only if the STMT parameter is not specified. program-name: Specify the name of the program that has the specified trace statements (or all trace statements) being removed. Example for RMVTRC
RMVTRC
This command removes all the trace statements used for tracing in the program currently specified as the default program. Error messages for RMVTRC *ESCAPE Messages CPF1999 Errors occurred on command.
Command Descriptions
69
This command removes the trace filter named SAMPLE. Example 2: Removing All Filters that Start with SAM
RMVTRCFTR FTR(SAM*)
This command removes all trace filters with names that start with SAM. Error messages for RMVTRCFTR *ESCAPE Messages CPFAF21 Filter not found. CPFAF24 Filter not removed.
70
This command removes the entry for the multimedia device VIDEO2, whose connection uses the output device connector 1.
71
Required Parameter MMDEV Specifies the multimedia device for which the entry is to be removed. The multimedia device is specified by the multimedia device name, the remote location name, and the remote network identifier (ID). Element 1: Device Name device-name: Specify the name of the multimedia device. Element 2: Remote Location Name *NONE: The multimedia device does not have a remote location name. remote-location-name: Specify the remote location name of the programmable work station (PWS) that is the multimedia device. Element 3: Remote Network ID *NONE: The multimedia device does not have a remote network ID. remote-network-identifier: Specify the network identifier of the remote system of the PWS that is the multimedia device. Example for RMVUSFDEVE
RMVUSFDEVE MMDEV(EASYON)
This command removes the entry for the multimedia device EASYON.
This command removes the entry for the multimedia server device LOCALSWITCH from the multimedia server device table. The associated device description, line description, and controller description objects are also removed.
72
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. subsystem-description-name: Specify the name of the subsystem description containing the work station entry that is being removed. WRKSTN Specifies the device description name of the work station for which the job entry is being removed. work-station-name: Specify the name of the work station whose work station entry is removed. generic*-work-station-name: Specify the generic name of the work station. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name. For more information on the use of generic names, refer to generic names. The WRKSTN parameter and the WRKSTNTYPE parameter are mutually exclusive. When a generic name is specified, only the generic name entry is removed. For more information on the use of generic functions, see generic functions. WRKSTNTYPE Specifies the work station device type for which the job entry is being removed. The following type codes are valid: Type Code Device 3179 3179 Display station
Command Descriptions
73
3180 3196 3197 3277 3278 3279 3476 3477 3486 3487 5251 5291 5292 5555
3180 Display Station 3196 Display Station 3197 Display Station 3277 Display Station 3278 Display Station 3279 Display Station 3476 Display Station 3477 Display Station 3486 Display Station 3487 Display Station 5251 Display Station 5291 Display Station 5292 Color Display Station 5555 Display Station (on systems supporting DBCS (double-byte character set))
*ALL: The work station entry for all valid work station types is removed. *NONASCII: The work station entry for all valid work stations that use 5250 data stream is removed. *ASCII: The work station entries for all work stations that use ASCII data streams are added. *CONS: This value overrides a device type entry that specifies the same device type as the device being used as the console. work-station-type: Specify the work station device type whose work station entry is being removed. The WRKSTN parameter and the WRKSTNTYPE parameter are mutually exclusive.
This command removes the work station entry for work station B53 from the subsystem description named CHARLES in library LIB2. Error messages for RMVWSE *ESCAPE Messages CPF1619 Subsystem description &1 in library &2 damaged. CPF1691 Active subsystem description may or may not have changed. CPF1697 Subsystem description &1 not changed.
74
NEWOBJ Specifies the new name with which you can refer to the object. This name cannot contain any directory qualifiers and is in the same directory containing the existing object. Example for RNM
RNM OBJ(DECEMBER-1994-MONTHLY-PAYROLL-FILE) NEWOBJ(JANUARY-1995-MONTHLY-PAYROLL-FILE)
Command Descriptions
75
Error messages for RNM *ESCAPE Messages CPFA085 Home directory not found for user &1. CPFA08E More than one name matches pattern. CPFA093 Name matching pattern not found. CPFA09C Not authorized to object. CPFA09D Error occurred in program &1. CPFA0A1 An input or output error occurred. CPFA0A3 Path name resolution causes looping. CPFA0A6 Number of links exceeds maximum allowed for the file system. CPFA0A7 Path name too long. CPFA0A9 Object not found. CPFA0AA Error occurred while attempting to obtain space. CPFA0AB Object name not a directory. CPFA0B1 Requested operation not allowed. Access problem. CPFA0B2 No objects satisfy request. CPFA0B4 NEWOBJ parameter cannot start with a slash. CPFA0B5 The NEWOBJ parameter cannot contain path. CPFA0C4 Object name not a file.
76
Required Parameters CNNL Specifies the name of the connection list. ENTRY Specifies the name of the entry to be renamed. NEWENTRY Specifies the new name for the entry. Each entry in the connection list must have a unique name. Example for RNMCNNLE
RNMCNNLE CNNL(CHICAGO) ENTRY(CORPORATE) NEWENTRY(SERVICE)
This command renames entry CORPORATE in the connection list named CHICAGO. The new name will be SERVICE, but all other information for the entry remains the same. Error messages for RNMCNNLE *ESCAPE Messages CPF266C Connection list &1 not found. CPF2683 Entry &2 in connection list &1 not renamed.
77
If any one of these are in use during the rename request, the request fails and an error message is sent. Required Parameters OLDUSRID Specifies the user ID and address of the directory entry being renamed. Both elements must be specified. If lowercase characters are specified, the system stores them as uppercase characters. More information about specifying the user ID and address is in the SNA Distribution Services book. Element 1: User ID user-ID: Specify the current user ID for the directory entry. A maximum of 8 characters can be specified. If this value is specified, an address must be specified on Element 2. Element 2: Address address: Specify the current address for the directory entry. A maximum of 8 characters can be specified. If this value is specified, a user ID must be specified on Element 1. NEWUSRID Specifies the user ID and address to which the old user ID and address is being renamed. Both elements must be specified but only one element needs to be different from the user ID and address specified on the OLDUSRID parameter. The new user ID and address specified cannot be an existing user ID and address or exist as a forward-from value in the directory. If the entry being renamed is in error from a previous rename request, you can continue with the rename operation or back out the changes and reset the files to the original values. To back out the changes, specify *BACKOUT on this parameter. To continue with the rename operation, do not change the value of this parameter (if the value is changed this is an error). If lowercase characters are specified, the system stores them as uppercase characters. *BACKOUT: Back out of the rename directory entry operation. This value is only allowed on a directory entry that is in error as the result of a previous rename. This value sets the user ID and address in all IBM-supplied files changed by a previous rename request to the values specified on the OLDUSRID parameter. Element 1: User ID user-ID: Specify the new user ID for the directory entry. A maximum of 8 characters can be specified. If this value is specified, an address must be specified on Element 2. Element 2: Address address: Specify the new address for the directory entry. A maximum of 8 characters can be specified. If this value is specified, a user ID must be specified on Element 1.
Note: Changing the address element does not change the system name of the directory entry. If you want distributions for the user forwarded to a system other than what is specified by the directory entry, you must change the system name for the directory entry using the Change Directory Entry (CHGDIRE) command.
Optional Parameters
78
FWDFRM Specifies whether distributions are automatically forwarded from the old user ID and address or a specified user ID and address. This value is valid only for local users. *NONE: Distributions are not forwarded. *OLDUSRID: All distributions are forwarded from the old user ID and address. Element 1: User ID user-ID: Specify the user ID from which distributions are to be forwarded. A maximum of 8 characters can be specified. If this value is specified, an address must be specified on Element 2. Element 2: Address address: Specify the address from which distributions are to be forwarded. A maximum of 8 characters can be specified. If this value is specified, a user ID must be specified on Element 1. NETUSRID Specifies whether the current network user ID and address are renamed to the new user ID and address. The network user ID is used in shadowing to uniquely identify a user in the network. The default is the user ID and address. If you are using directory shadowing with the user ID and address as the unique value in the network, you can also change this value to the new user ID and address specified on the NEWUSRID parameter. *SAME: The value does not change. *NEWUSRID: The network user ID and address are changed to the new user ID and address. Examples for RNMDIRE Example 1: Renaming a User ID
RNMDIRE OLDUSRID(HURST PAYROLL) NEWUSERID(HURST NEWYORK) FWDFRM(*OLDUSRID)
This command renames the current user ID HURST PAYROLL to the new user ID HURST NEWYORK. Distributions sent to the old user ID and address are forwarded. Example 2: Renaming a User ID and Network User ID
RNMDIRE OLDUSRID(HURST PAYROLL) NEWUSERID(HURST NEWYORK) FWDFRM(*OLDUSRID) NETUSRID(*NEWUSRID)
This command renames the current user ID HURST PAYROLL and the current network user ID to the new user ID HURST NEWYORK. Distributions sent to the old user ID and address are forwarded. Error messages for RNMDIRE *ESCAPE Messages CPF897F Rename failed for user ID and address &1 &2. CPI90F1 Rename completed with errors. See previously listed messages.
79
The Rename Diskette (RNMDKT) command changes the name of a diskette or changes the name (or identifier) of its owner. This command can be used to change the contents of the volume identifier field, or the owner identifier field, or both fields of a single diskette.
Note: When processing a diskette with labels that are not IBM standard labels, unpredictable results may occur. To initialize the diskette, enter the Initialize Diskette (INZDKT) command with CHECK(*NO) specified.
Required Parameters DEV Specifies the name of the diskette device containing the diskette being renamed.
Optional Parameters VOL Specifies one or more volume identifiers used by the file. More information on this parameter is in commonly used parameters. *MOUNTED: The volume currently placed in the device is used. volume-identifier: Specify the volume identifier that is being compared with the diskette label volume identifier field on the diskette that is being renamed. Specify up to 6 characters; any combination of letters and numbers can be used. If the volume identifiers do not match, a message is sent to the system operator. The operator can either insert the correct diskette and try again, or stop the command. NEWVOL Specifies, if the diskette is being renamed, the new volume identifier of the diskette. *SAME: The value does not change. volume-identifier: Specify up to 6 characters for the volume identifier of the diskettes being renamed; any combination of letters and numbers can be used. NEWOWNID Specifies the owner identification being written in the volume label. The owner identification contains up to 14 characters (uppercase letters and/or numbers in any combination) and is left-justified and padded with blanks on the right if fewer than 14 characters are supplied. *SAME: The value does not change. owner-identifier: Specify no more than 14 uppercase letters and numbers that identify the owner of the diskette. No lowercase letters, embedded blanks, or special characters can be included, even if they are enclosed in apostrophes. If less than 14 characters are used, the field is left-justified and padded on the right with blanks. Example for RNMDKT
RNMDKT DEV(DKT1) VOL(MASTER) NEWVOL(BACKUP)
This command changes the name of the diskette in device DKT1, if its name is MASTER, to BACKUP. The owner identification is unchanged (NEWOWNID assumed to be *SAME). Error messages for RNMDKT *ESCAPE Messages CPF6153 NEWOWNID parameter value not correct. CPF6154 NEWVOL parameter value not correct.
80
CPF6156 Cancel reply received for message &6. CPF6160 Rename diskette ended; previous errors occurred. CPF6716 Device &1 not a diskette device. CPF6718 Cannot allocate device &1. CPF9814 Device &1 not found. CPF9825 Not authorized to device &1.
When renaming the distribution list, the new list ID must be unique to all local user IDs and other list IDs in the directory. If a new list ID is not unique, the list is not renamed and an error message is returned. Restriction: You must have security administrator (*SECADM) authority to rename a distribution list that you do not own. No special authority is needed for you to rename a distribution list that you own. Required Parameters LSTID Specifies the two-part list identifier of the distribution list to be renamed. Element 1: List Identifier list-ID: Specify the list identifier (ID) of the distribution list. Element 2: List Qualifier list-ID-qualifier: Specify the list ID qualifier of the distribution list.
Note: The distribution list identifier has two parts, the ID and the qualifier, separated by at least one space. If lowercase characters are specified, the system changes them to uppercase. The naming rules for the two-part list ID are identical to the rules for the user ID and address. A complete description of these rules is in the SNA Distribution Services book.
Command Descriptions
81
NEWLSTID Specifies the new two-part list identifier of the distribution list. Element 1: List Identifier list-ID: Specify the list identifier (ID) of the distribution list. Element 2: List Qualifier list-ID-qualifier: Specify the list ID qualifier of the distribution list.
Note: The distribution list identifier has two parts, the ID and the qualifier, separated by at least one space. If lowercase characters are specified, the system changes them to uppercase. The naming rules for the two-part list ID are identical to the rules for the user ID and address. A complete description of these rules is in the SNA Distribution Services book.
This command renames a distribution list that contains the members of Department ABC. The list ID is being changed to correspond to a new department name, XYZ. If the new list ID is unique, the distribution list is changed. Error messages for RNMDSTL *ESCAPE Messages CPF9A8B Distribution list &1 &2 not renamed. CPF9024 System cannot get correct record to finish operation. CPF9845 Error occurred while opening file &1. CPF9846 Error while processing file &1 in library &2. CPF9847 Error occurred while closing file &1 in library &2.
82
error message indicating that internal objects are locked. This means that another user is using the document library functions which cannot run at the same time as the RNMDLO command; therefore, retry this command later. Required Parameters DLO Specifies the name of the document or folder that is being renamed.
NEWDLO Specifies the new name of the document or folder. Optional Parameters FLR Specifies the name of the folder that contains the document. *NONE: The folder being renamed is not located in a folder. *NONE cannot be specified if the object being renamed is a document. folder-name: Specify the name of the folder that contains the document or folder that is being renamed. Example for RNMDLO
RNMDLO DLO(A) NEWDLO(B) FLR(FLR1)
This command changes the name of document or folder A located in folder FLR1, to B. Error messages for RNMDLO *ESCAPE Messages CPF8A14 &2 of type &4 not renamed to &3 in folder &1.
83
job-name: Specify the name of the job that you want to rename. Element 2: Group *NONE: The job that you are renaming is not a member of a group. group-name: Specify the name of the group for the job that you are renaming. Element 3: Group sequence *NONE: The job that you are renaming does not have a sequence number. group-sequence-number: Specify the sequence number of the job within the group. NEWJOB Specifies the name of the job schedule entry that you are creating as a result of renaming the job specified in the NEWJOB parameter. You must specify a job and optionally can specify a group to which the job belongs as well as a sequence number for the job within the group. The first job of a group must be sequence number 1. Sequence numbers can range from 1 to 99. Element 1: New job new-job-name: Specify the new name of the job that you are renaming. Element 2: Group *NONE: The job that you are renaming is not a member of a group. group-name: Specify the name of the group for the job that you are renaming. Element 3: Group sequence *NONE: The job that you are renaming is not a member of a group. group-sequence-number: Specify the sequence number of the job within the group. Example for RMNJOBJS Example 1: Renaming a Job
RNMJOBJS JOB(JOB02) NEWJOB(JOB04)
In the example, JOB02 is renamed to JOB04. Error messages for RMNJOBJS None
84
NEWNAME Specifies the new name associated with the adapter information. Example for RNMLANADPI
RNMLANADPI ADPTNAME(ACCTG3A) NEWNAME(BILLING2)
This command changes the name from ACCTG3A to BILLING2. Error messages for RNMLANADPI *ESCAPE Messages CPF8B48 Adapter name - &29 or address - &30 already in the network adapter file. CPF8B68 Line description &23 not found. CPF8B74 Request to display active adapters failed. CPF8B75 No adapter entries in network adapter file. CPF8B76 No functional addresses for adapter. CPF8B83 Rename request for adapter &29 failed. Adapter name not found.
*LIBL: All libraries in the jobs library list are searched until the first match is found.
Command Descriptions
85
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. database-file-name: Specify the name of the physical or logical database that contains the member being renamed. MBR Specifies the name of the physical or logical file member that is renamed. Specify the name of the member.
NEWMBR Specifies the new name of the member being renamed. The member remains in the same file. Specify the name of the new member. The new name must be unique in the file. Example for RNMM
RNMM FILE(ELEMENT) MBR(LEAD) NEWMBR(GOLD)
This command renames member LEAD in file ELEMENT as GOLD. The library list (*LIBL) is used to find the file. Error messages for RNMM *ESCAPE Messages CPF3178 Member &3 not renamed to &4.
Restrictions: 1. You must have security administrator (*SECADM) authority to rename a public nickname that you do not own. No special authority is needed for you to rename a public nickname that you own. 2. Only the owner can rename a private nickname. No special authority is needed. Required Parameters NCK Specifies the existing nickname to be renamed and the access of that nickname. Element 1: Nickname nickname: Specify the nickname you are renaming. Element 2: Nickname Access
86
*PRIVATE: The private nickname that you own is being renamed. *PUBLIC: The public nickname is being renamed. Public nicknames can be renamed only by a user with security administrator (*SECADM) authority or by the owner. NEWNCK Specifies the new nickname. Example for RNMNCK
RNMNCK NCK(SEC44A *PUBLIC) NEWNCK(SEC44C)
This command renames the public nickname SEC44A to SEC44C. If the new nickname is unique, the nickname is renamed. Error messages for RNMNCK *ESCAPE Messages CPF8AA1 Library QUSRSYS not completely installed. CPF8360 Not enough storage for commitment control operation. CPF9A80 Public nickname &1 in use. CPF9A80 Public nickname &1 in use. CPF9024 System cannot get correct record to finish operation. CPF905C Error occurred trying to find a translation table. CPF9838 User profile storage limit exceeded.
Command Descriptions
87
v Configuration objects including controller descriptions, line descriptions, device descriptions, and network interface descriptions must all be varied off in order to rename them. v The following objects cannot be renamed: The jobs temporary library (QTEMP) The system libraries (QQALIB, QRCL, QRCLxxxxx, QRECOVERY, QRCYxxxxx, QSYS, QSYSxxxxx, QSYSCGI, QSYS2, QSYS2xxxxx, SYSIBM, or SYSIBxxxxx (where xxxxx is the number of a primary auxiliary storage pool (ASP))) The system operator message queue (QSYSOPR) All work station user message queues The system log (QHST) The configuration objects (QCTL and QCONSOLE)
The configuration lists (QAPPNRMT, QAPPNLCL, QASYNCLOC, QRTLPASTHR) The Electronic Customer Support configuration objects (QESLIN, QESPAP, QESCTL. QTILINE, QTICTL, QTIDA, QTIDA2, QIADSP, QIAPRT, QQAHOST) v A library (*LIB) cannot be renamed if it contains any objects of the following types: *CRG *DTADCT *JRN *JRNRCV *SQLPKG *SQLUDT v When renaming objects of type *CSI, *GSS, *FNTRSC, *FORMDF, *OVL, *PAGDFN, and *PAGSEG, the new name for the object cannot exceed 8 characters in length. v This command is conditionally threadsafe. The following restrictions apply: 1. In multithreaded jobs, this command is not threadsafe for distributed files and fails for distributed files that use relational databases of type *SNA. This command is also not threadsafe and fails for Distributed Data Management (DDM) files of type *SNA, when SYSTEM(*RMT) or SYSTEM(*FILETYPE) is specified. 2. Renaming objects of type *CFGL, *CNNL, *CTLD, *DEVD, *LIND or *NWID will fail in multithreaded jobs. Notes: 1. References made to the following items may need to be updated by the user after a rename of a configuration object: v Connection lists v v v v v Work station entries Communication entries Display files Printer files Tape files
v Diskette files v ICF files v User profiles v Job descriptions v System objects v CL programs v QPRTDEV system value
88
Display descriptions referencing this as an auxiliary printer Communication side information (CSI) objects Distributed data management files (APPC device name) Integrated services digital network (ISDN) controller descriptions that refer to a renamed connection list (CNNL) v ISDN line descriptions that refer to a renamed CNNL v Other configuration objects. For example, lines, controllers, and other devices that refer to the renamed configuration objects. 2. References made to the renamed object by the following items are automatically changed by the system after a rename operation. The reference changes reflect the changes made to the renamed configuration objects. v QCONSOLE system values v v v v v message queues associated with display devices System/36 environment device tables output queues associated with the old printer device local work station controllers associated with a twinaxial data link control (TDLC) line TDLC lines associated with the local or remote work station controller
v v v v
Required Parameters OBJ Specifies the current qualified name of the object to be renamed. If no library qualifier is given, *LIBL is used to find the object. The object name should be qualified to ensure that the right object is renamed. The name of the object can be qualified by one of the following library values:
*LIBL: All libraries in the threads library list are searched until the first match is found. If ASPDEV is specified when this value is used, ASPDEV(*) is the only valid value.
*CURLIB: The current library for the thread is searched. If no library is specified as the If ASPDEV is specified when current library for the thread, the QGPL library is used. this value is used, ASPDEV(*) is the only valid value.
library-name: Specify the name of the library to be searched. object-name: Specify the current name of the object to be renamed. OBJTYPE Specifies the type of the object to be renamed. More information on this parameter is in commonly used parameters.
Note: Dependent logical files follow the renamed physical file.
NEWOBJ Specifies the new name of the object being renamed. The object remains in the same library. Enter the new name that identifies the object to the system. Optional Parameters
Command Descriptions
89
SYSTEM Specifies whether the file is on the local system (*LCL), the remote system or systems (*RMT), or on either the local or remote systems (*FILETYPE). *LCL: The rename is for a file on the local system. *RMT: The remote file referred to by the source distributed data management (DDM) file is renamed.
Note: If the user wants to rename a remote file, two DDM files must be used. The existing DDM file goes in the OBJ value and the new DDM file goes in the NEWOBJ value. The new DDM file must be in the same library as the existing DDM file. When the remote rename occurs, the remote file name in the existing DDM file is given to the new DDM file.
*FILETYPE: If the OBJ name is a DDM file, the renaming is remote, but if the OBJ name is not a DDM file, the renaming is local. ASPDEV Specifies the auxiliary storage pool (ASP) device name where storage is allocated for the library of the object or the library being renamed (OBJ parameter). If the library is in an ASP that is not part of the threads library name space, this parameter must be specified to ensure the correct library is used in the rename operation. ASPDEV(*) is the only valid value if *CURLIB or *LIBL is specified for the OBJ parameter. If a library to be renamed is in an auxiliary storage pool (ASP) device that is not currently part of the threads library name space, specify the library as OBJ(QSYS/yourlibrary-name) and the ASP device as ASPDEV(auxiliary-storage-pool-device-name). *: The ASPs that are currently part of the threads library name space will be searched to locate the library. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and, if the thread has an ASP group, the primary or secondary ASPs in the ASP group. *CURASPGRP: If the thread has an ASP group, the primary and secondary ASPs in the ASP group will be searched to locate the library. The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will not be searched. *SYSBAS: The system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32) will be searched to locate the library. No primary or secondary ASPs will be searched, even if the thread has an ASP group. auxiliary-storage-pool-device-name: The device name of the primary or secondary ASP to be searched to locate the library. The primary or secondary ASP must have been activated (by varying on the ASP device) and have a status of Active or Available for a rename library operation and a status of Available for a rename object operation. The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32) will not be searched. Example for RNMOBJ
RNMOBJ OBJ(PAYROLL/FILEX) NEWOBJ(MSTR) OBJTYPE(*FILE)
The library named PAYROLL is searched for the file named FILEX. If the file is found, and the user has object operational authority for FILEX and update authority for the PAYROLL library, FILEX is renamed MSTR. Error messages for RNMOBJ *ESCAPE Messages
90
CPFA030 Object already in use. CPFB8ED Device description &1 not correct for operation. CPF0601 Not allowed to do operation to file &1 in &2. CPF0602 File &1 already in library &2. CPF0605 Device file &1 in &2 saved with storage freed. CPF0610 File &1 in &2 not available. CPF0678 Operation not performed for file name &1 in &2. CPF1763 Cannot allocate one or more libraries. CPF180B Function &1 not allowed. CPF2105 Object &1 in &2 type *&3 not found. CPF2110 Library &1 not found. CPF2111 Library &1 already exists. CPF2112 Object &1 in &2 type *&3 already exists. CPF2113 Cannot allocate library &1. CPF2114 Cannot allocate object &1 in &2 type *&3. CPF2132 Object &1 already exists in library &2. CPF2136 Renaming library &1 failed. CPF2139 Rename of library &1 failed. CPF2140 Rename of library &1 previously failed. CPF2150 Object information function failed. CPF2151 Operation failed for &2 in &1 type *&3. CPF2160 Object type *&1 not eligible for requested function.
Command Descriptions
91
CPF2164 Rename of library &2 not complete. CPF2166 Library name &1 not valid. CPF2176 Library &1 damaged. CPF2173 Value for ASPDEV not valid with special value for library. CPF218C &1 not a primary or secondary ASP. CPF2182 Not authorized to library &1. CPF2189 Not authorized to object &1 in &2 type *&3. CPF2190 Not able to do remote delete or rename request. CPF22BC Object &1 type &3 is not program defined. CPF2451 Message queue &1 is allocated to another job. CPF2512 Operation not allowed for message queue &1. CPF2691 Rename of &2 type *&5 did not complete. CPF2692 Object &2 type *&5 must be varied off. CPF2693 &2 type *&5 cannot be used for rename. CPF2694 Object &2 type *&5 cannot be renamed. CPF2696 Object &2 type *&5 not renamed. CPF320B Operation was not valid for database file &1. CPF3201 File &1 in library &2 already exists. CPF3202 File &1 in library &2 in use. CPF3203 Cannot allocate object for file &1 in &2. CPF322D Operation not done for data base file &1. CPF3220 Cannot do operation on file &1 in &2.
92
CPF323C QRECOVERY library could not be allocated. CPF323D User does not have correct authority. CPF324C Concurrent authority holder operation prevents move, rename or restore. CPF3245 Damage to file &1 member &6 prevents operation on file &3. CPF326A Operation not successful for file &1 in library &2. CPF327F Operation not successful for file &1 in library &2. CPF329D Operation not successful for file &1 in library &2. CPF3323 Job queue &1 in &2 already exists. CPF3330 Necessary resource not available. CPF3353 Output queue &1 in &2 already exists. CPF3375 Job queue &1 in &2 not renamed. Job queue in use. CPF3376 Output queue &1 in &2 not renamed. Output queue in use. CPF3467 Output queue &1 deleted and then created again. CPF3469 Operation not allowed for output queue. CPF5702 File either not DDM file or not found. CPF7003 Entry not journaled to journal &1. Reason code &3. CPF8D05 Library &1 already exists. CPF88C4 Value &1 for new object is more than 8 characters. CPF9807 One or more libraries in library list deleted. CPF9808 Cannot allocate one or more libraries on library list. CPF9809 Library &1 cannot be accessed. CPF9814 Device &1 not found.
Command Descriptions
93
CPF9825 Not authorized to device &1. CPF9833 *CURASPGRP or *ASPGRPPRI specified and thread has no ASP group. CPF9876 Protected library &2 cannot be modified. CPF9899 Error occurred during processing of command.
94
This command replaces the host table entry internet address of 132.28.71.5 with the internet address of 142.48.81.6. All host names and the text description field associated with the entry remain the same. Error messages for RNMTCPHTE *ESCAPE Messages TCP1901 Internet address &1 not valid. TCP1902 Internet address &1 not valid. TCP1904 Duplicate internet address &1 found in host table. TCP1907 Internet address entry &1 does not exist. TCP1908 Internet address &1 not valid. TCP1910 LOOPBACK internet address &1 not valid. TCP1929 Host table not available.
Command Descriptions
95
Required Parameters DLO Specifies the document library object being reorganized. *ALL: All document library objects are reorganized. If FLR(*NONE) is specified with this parameter, all folderless documents are reorganized. If FLR(*ANY) is specified with this parameter, all filed documents and folders are reorganized. If MAIL(*YES) is specified with this parameter, all unfiled mail documents as well as all filed documents and folders are reorganized. If MAIL(*ONLY) is specified with this parameter, only unfiled mail documents are reorganized. If FLR(folder-name) is specified with this parameter, all folders and documents within it are reorganized. *SYSOBJNAM: A system object name specified on the SYSOBJNAM parameter is used to identify the document or folder being reorganized. document-or-folder-name: Specify the name of the document or folder being reorganized. The FLR parameter also can be used to reorganize a document by specifying reorganization of: v The folder that contains the document being reorganized v The folder that contains the nested folder that contains the document being reorganized Optional Parameters FLR Specifies the name of the folder that contains the document.
Note:
*NONE: The document or folder is not located in a folder. If DLO(*ALL) is specified, this refers to all folderless documents. If DLO(document-or-folder-name) is specified, this refers to a first-level folder. *ANY: The documents and folders being reorganized are not qualified by any folder. This value is valid only when DLO(*ALL) is specified. folder-name: Specify the folder name that contains the documents or folders. SYSOBJNAM Specifies the system object name. This parameter is valid only when DLO(*SYSOBJNAM) or DOCL(*SYSOBJNAM) is specified. A full ten characters must be specified. DAYS Specifies the number of days that must elapse since a document was last referred to before it is eligible for reorganization. 0: Any document may be reorganized. number-of-days: Specify the number of days that elapsed since a document or folder was last used before it is eligible for reorganization. MAIL Specifies whether objects being reorganized include, omit, or are limited to mail documents that have not been filed. *NO: Mail documents that have not been filed are not reorganized. *YES: Mail documents that have not been filed are reorganized along with other folders and documents. This value is valid only when DLO(*ALL) and FLR(*ANY) are specified. *ONLY: Only mail documents that have not been filed are reorganized. This value is valid only when DLO(*ALL) and FLR(*ANY) are specified. Examples for RGZDLO
96
This command reorganizes all filed folders and documents that exist on the system. Example 2: Reorganizing Folders, Documents, and Unfiled Mail
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*YES)
This command reorganizes all filed folders, documents, and all unfiled mail documents that exist on the system. Example 3: Reorganizing Unfiled Mail Documents
RGZDLO DLO(*ALL) FLR(*ANY) MAIL(*ONLY)
This command reorganizes all unfiled mail documents that exist on the system. Example 4: Reorganizing Folderless Documents
RGZDLO DLO(*ALL) FLR(*NONE)
This command reorganizes all folderless documents that exist on the system. Example 5: Reorganizing Documents Within Folders Within Folders
RGZDLO DLO(*ALL) FLR(FLRA)
This command reorganizes all documents within folders contained in folder FLRA, then the folders within folder FLRA are reorganized. Example 6: Reorganizing an Individual Document or Folder
RGZDLO DLO(*SYSOBJNAM) SYSOBJNAM(DCN1371951)
This command reorganizes the individual document or folder identified by the SYSOBJNAM object. Example 7: Reorganizing a Document
RGZDLO DLO(DOC1) FLR(FLRA)
This command reorganizes the document named DOC1 in folder FLRA. Example 8: Reorganizing Documents Not Referenced
RGZDLO DLO(*ALL) FLR(*ANY) DAYS(30)
This command reorganizes all filed documents and folders that have not been referenced in the past 30 days. Error messages for RGZDLO *ESCAPE Messages CPF8AB1 &1 objects reorganized; &2 objects not reorganized. CPF8AB2 RGZDLO command failed.
Command Descriptions
97
98
2. The user needs object operational authority, object management or alter authority, all data authority to the physical file containing the member to be reorganized, and execute authority to the library. The user also needs object operational authority to the file specified on the KEYFILE parameter and execute authority to the library. 3. In multithreaded jobs, this command is not threadsafe for distributed files and fails for distributed files that use relational databases of type *SNA. This command is also not threadsafe and fails for Distributed Data Management (DDM) files of type *SNA. Required Parameters FILE Specifies the qualified name of the physical file whose member is being reorganized. The name of the physical file can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. physical-file-name: Specify the name of the physical file.
Optional Parameters MBR Specifies the name of the member in the file being reorganized. *FIRST: The first member in the database file is used. *LAST: The last member of the specified physical file is reorganized. member-name: Specify the name of the file member being reorganized. SRCOPT Specifies, for physical source files only, whether the member places new numbers in the sequence number field, places zeros in the date field, or changes both fields. Changes occur after the records are compressed or reorganized. *SAME: The value does not change. *SEQNBR: The records have a new sequence number placed into the sequence number field. The SRCSEQ parameter specifies a start value and an increment value. If *SEQNBR is specified, *DATE can also be specified. *DATE: The records have a null date (000000) placed in the date field. If *DATE is specified, *SEQNBR can also be specified. SRCSEQ Specifies, only when SRCOPT(*SEQNBR) is also specified, the sequence number that is given to the first record in the source file member and the increment value that is used to renumber all other records in the member. If the member is renumbered but SRCSEQ is not specified, SRCSEQ(1.00 1.00) is assumed; the source records are renumbered sequentially starting with 1.00, and the whole number increment of 1 is used. Element 1: Starting Value 1.00: The first source record in the member has a sequence number of 0001.00.
Command Descriptions
99
starting-value: Specify the sequence number (ranging from 0000.01 through 9999.99) of the first source record in the member. A whole number of no more than four digits and/or a fraction of no more than two digits can be specified. If the starting value contains a fraction, a decimal point must be used. Examples are .01 and 3250.4. If a value has a fraction of .00, such as 5000.00, it can be coded without the fraction; either 5000 or 5000.00 is valid. Element 2: Increment Value 1.00: The source records are renumbered in the member with whole number increments of 1 (for example, 1.00, 2.00, 3.00 and so on). increment-value: Specify the increment value (ranging from 0000.01 through 9999.99) for renumbering all source records following the first record. A whole number of no more than four digits and/or a fraction of no more than two digits can be specified. If the increment value contains a fraction, a decimal point must be used. For example, if SRCSEQ(5000 10) is specified, the first record in the reorganized member is numbered 5000.00, the second is 5010.00, the third is 5020.00, and so on. If SRCSEQ(*N .25) is specified, the records are numbered 1.00, 1.25, 1.50, 1.75, 2.00, and so on. If a starting value of .01 and an increment value of .01 are specified, there are 999,999 unique sequence numbers possible. If the maximum sequence number of 9999.99 is reached, the remaining records are also assigned the sequence number 9999.99. KEYFILE Specifies whether the physical file member has its arrival sequence changed to match its keyed sequence, is reorganized in the sequence of a logical file member, or is not reorganized. If KEYFILE specifies a multiple-format logical file and member, the RCDFMT parameter must also be specified.
Note:
Join logical files cannot be specified as key files, and a logical file in this parameter is not allowed to have a select/omit access path.
*NONE: The member is not reorganized; it is only compressed by having its deleted records removed. *FILE: For a physical file member having a keyed sequence access path, the arrival sequence of the records in the member is changed to match their keyed sequence. Element 1: Logical File Name The name of the logical file can be qualified by one of the following library values:
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library to be searched. logical-file-name: Specify the qualified name of the logical file whose members sequence is used to reorganize the physical file member. Element 2: Member Name
100
member-name: Specify the name of the member whose sequence is used to reorganize the physical file member. RCDFMT Specifies the record format name if the physical file member is reorganized in the sequence of a multiple-format logical file. *ONLY: The logical file specified by the KEYFILE parameter has only one record format, which is used to reorganize the physical file member. record-format-name: Specify the name of a record format in the multiple-format logical file that is used to reorganize the physical file member.
Note: Compression of a file occurs when the space occupied by a deleted record is freed to hold a record that is not deleted.
This command compresses member MBR1 of the PAYROLL file by removing the deleted records from the file member. Example 2: Reorganizing in Keyed Sequence
RGZPFM FILE(QCLSRC) MBR(CLMBR2) SRCOPT(*SEQNBR *DATE) KEYFILE(*FILE) SRCSEQ(1.00 .25)
This command reorganizes the member CLMBR2 of the CL source file QCLSRC in keyed sequence, with the sequence number field used as the key. The reorganized member has new sequence numbers (starting at 1.00 and incrementing by .25) and a null date (000000) placed in all records when the original member is reorganized. Error messages for RGZPFM *ESCAPE Messages CPF2981 Member &3 file &1 in &2 not reorganized. CPF3135 Access path for member &2 already in use. CPF32B8 Distributed file error, reason code &3. CPF32CF Distributed file error, reason code &3. CPF32C3 Distributed file error, level ID mismatch CPF9801 Object &2 in library &3 not found. CPF9809 Library &1 cannot be accessed.
Command Descriptions
101
CPF9810 Library &1 not found. CPF9820 Not authorized to use library &1. *NOTIFY Messages CPF2985 Source sequence numbers exceeded maximum value allowed. (G C)
*LIBL: All libraries in the jobs library list are searched until the first match is found.
*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
102
Optional Parameters TOFLR Specifies the name of the folder that contains the document being replaced. *NONE: No folder name is specified. folder-name: Specify the name of the folder that contains the document being replaced. A folder name can consist of a series of folder names if the document being replaced is located in a folder that is contained in another folder. Up to 63 characters can be specified. DOCID Specifies the library-assigned name of the document being replaced. This is the name assigned to the document by the system when it is created. The library-assigned document name can be determined by using the Query Document Library (QRYDOCLIB) command. The library-assigned name is also returned in a completion message when using the File Document (FILDOC) command. Library-assigned document names are 24 characters in length with the following format: YYYYMMDDHHMNSSHSSNSNSNSN where YYYY = year MM = month DD = day HH = hour MN = minute SS = second HS = hundredths of a second SNSNSNSN = system name *NONE: No library-assigned document name is required when the document is identified by the TODOC parameter. library-assigned-document-name: Specify the library-assigned document name to be replaced. More information on library-assigned document names is in the SNA Distribution Services book.
Note: When the user is replacing a document and a cancel request is entered, the document may or may not be replaced.
DOCMBR Specifies the document database file member that contains the data and IDP to replace the current data and IDP in the document. *FIRST: The first member (in order of creation) in the database file contains the replacement data. member-name: Specify the name of the database file that contains the replacement data. DOCPART Specifies the part of the document to be replaced.
Command Descriptions
103
Note:
If you specify DOCPART(*BOTH) and the replacement of one fails, neither is replaced and the document remains checked out.
*DOC: Replace the document content only. If no document content records exist in the specified file, the document is replaced but a message is returned to alert the user that no document content was replaced. *IPD: Replace only the IDP of the document. If this value is specified, IDP records (record code 500) must exist in the specified file or the command fails. *BOTH: Replace both the document content and the IDP of the document. If this value is specified, IDP records (record code 500) must exist in the specified file or the command fails. DOCTYPE Specifies the type of replacement document. This identifier is used by the system to determine whether it can handle the data stream correctly. The system code (SYSCOD on the File Document (FILDOC) command) cannot be changed when the document contents are replaced. *DFT: The system creates the appropriate document type identifier depending on where the data comes from. If the document file is an output file created by the RCVDST or RTVDOC command, then the document type is taken from this file. If the file does not contain a document type or if the value in this file is document type 0, then an error message is sent. If the document file is a user-defined file, then the document type is 223 (data file). Document Description Type 2 3 4 5 6 7 8 9 10 11 12 13 14 15 223 Final form text document (FFTDCA) 5520 revisable form text document (RFT5520) Word processing EBCDIC (EBCDIC) Word processing information file (WRDPRCINFF) Image-data subset document (IMAGE) 3730 text data stream (TEXT3730) DIA document library descriptor document (DOCDESCDOC) 3732 display document data stream (DATAST3732) DIA display document data stream (DOCUNITCTL) Revisable form text document (RFTDCA) 1403 compatible data stream with variable length, unblocked records (PRT1403) Digitized ADS audio (AUDIO) IBM PC data file (PCFILE) Hard copy of document (HARDCOPY) Data file
104
32756 Version 2 DIA document, library document, descriptor document 32768 The iSeries 400 revisable-form document (RFTAS400) 32769 The iSeries 400 final-form document (FFTAS400) 32770 IBM DW4 revisable-form document (RFTDW4) 32912 ASCII data (ASCIIDATA) 65262 IBM S/38 revisable document (RFTS38) *FFT: The document is Final Form Text. This type of document is intended to be shown and printed and not edited by the receiver. *RFT: The document is Revisable Form Text. This type of document can be shown, printed, and edited by the receiver. document-type-number: Specify a number from 2 through 65535. The numbers from 2 through 32767 are controlled by registering them with the IBM Document Interchange Architecture and are used for IBM-defined document types. The numbers 32768 through 65535 are not registered with IBM and can be used for non-IBM defined document types.
USRID Specifies the user ID and address of the user for whom this request is made. The current user of this command must have the authority to work on behalf of the named user ID. Authority to work on behalf of another user is given with the Grant User Permission (GRTUSRPMN) command. *CURRENT: The user profile that is currently running is used. Element 1: User ID user-ID: Specify the user ID of the user whose the document is replaced. Element 2: User Address user-address: Specify the user address of the user for whom the document is replaced. DOCCHRID Specifies the character identifier (graphic character set and code page) for the data being filed. The character identifier is related to the display station that was used to create the data being filed. More information about CHRID processing is in the Database Programming topic in the Information Center. *SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system values. *DEVD: The system determines the graphic character set and code page values for the command parameter from the display device description where the command is entered. This option is valid only when specified from an interactive job. If this value is specified in an interactive CL program or a batch job, an error message is sent. Element 1: Character Set graphic-character-set: Specify the graphic character set used to create the data being filed. Element 2: Code Page code-page: Specify the code page value used to create the command parameters. Valid values range from 1 through 999. CMDCHRID Specifies the character identifier (graphic character set and code page) for data being specified as
Command Descriptions
105
parameter values on this command. This character identifier (CHRID) is related to the display device used to specify the command. More information about CHRID processing is in the Application Display Programming book.
Note: This value translates the USRID parameter to the character set and code page of 930 500. The SNA Distribution Services 500. book contains the character set and code page table for 930
*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system values. *DEVD: The system determines the graphic character set and code page values for the command parameter from the display device description where the command is entered. This option is valid only when specified from an interactive job. If this value is specified in an interactive CL program or a batch job, an error message is sent. Element 1: Character Set graphic-character-set: Specify the graphic character set values used to create the command parameter. Valid values range from 1 through 999. Element 2: Code Page code-page: Specify the code page value used to create the command parameters. Valid values range from 1 through 999. Example for RPLDOC
RPLDOC TODOC(*DOCID) DOCFILE(*LIBL/MYFILE) DOCPART(*BOTH) DOCID(1987060710102053SYSTEM1) DOCTYPE(*FFT)
This command replaces the document data and IDP with data in the file MYFILE. The data is placed in the document identified by the document identifier 1987060710102053SYSTEM1. The document type is changed to Final Form Text.
When the RQSORDAST command is successfully processed, a file containing the order information is created and sent along with the order assistance request. This file contains: v Hardware configuration information (vital product data (VPD) and topology data) v Software configuration information (installed IBM program products) The order information file is sent with all requests.
106
Restrictions: 1. This command is shipped with public *EXCLUDE authority. 2. You must have *ALLOBJ authority or be signed on as QSYSOPR or QSRV to use the command. There are no parameters for this command. Example for RQSORDAST
RQSORDAST
Restriction: The job must not be a group job. Optional Parameters RTGDTA Specifies the routing data used with this job description to start jobs. The routing data is used to determine the routing entry (in the subsystem description) that identifies the program in which the job runs. QCMDI: This routing data matches a routing entry in the IBM-supplied subsystem description (QINTER), which indicates a routing step that is processed by the IBM-supplied control language processor, QCMD, in the QSYS library. *RQSDTA: The first 80 characters of the request data specified in the RQSDTA parameter of this command is also used as the routing data for the next routing step. routing-data: Specify the character string used as the routing data for starting the next routing step. Up to 80 characters can be entered, enclosed in apostrophes if necessary. RQSDTA Specifies the request data that is added on the end of the jobs message queue for use by the new routing step. For example, if RTGDTA (QCMDB) is specified, the IBM-supplied batch
Command Descriptions
107
subsystem QBATCH is being used, and a CL command is supplied, it becomes a message that is read by the control language processor, QCMD (if the submitted job is routed to QCMD). *NONE: Request data is not placed in the jobs message queue. *RTGDTA: Routing data specified in the RTGDTA parameter is also placed at the end of the jobs message queue. request-data: Specify the character string placed at the end of the jobs message queue for use by the new routing step or some subsequent routing step in the job. Up to 256 characters can be entered, enclosed in apostrophes if necessary. When a CL command is entered, it must be enclosed in single apostrophes, and where apostrophes would normally be used inside the command, double apostrophes must be used. Example for RRTJOB
RRTJOB RTGDTA(INQUIRY)
This command reroutes the job in which the command is issued by starting a new routing step with the routing data INQUIRY. The job remains in the same subsystem. Error messages for RRTJOB *ESCAPE Messages CPF1315 Command &1 not allowed in this environment.
108
Printed in U.S.A.