system i programming savs36f (save s/36...

System i

Programming

i5/OS commands

Starting with SAVS36F (Save S/36 File)

Version 6 Release 1

��

Note

Before using this information and the product it supports, be sure to read the information in

“Notices,” on page 629.

This edition applies to version 6, release 1, modification 0 of IBM i5/OS (product number 5761-SS1) and to all

subsequent releases and modifications until otherwise indicated in new editions. This version does not run on all

reduced instruction set computer (RISC) models nor does it run on CICS models.

© Copyright International Business Machines Corporation 1998, 2008. All rights reserved.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract

with IBM Corp.

Contents

Save S/36 File (SAVS36F) . . . . . . . 1

Parameters . . . . . . . . . . . . . . . 3

From file (FROMFILE) . . . . . . . . . . . 3

From library (FROMLIB) . . . . . . . . . . 4

Device (DEV) . . . . . . . . . . . . . . 4

File group qualifier (GROUP) . . . . . . . . . 4

Set identifier (SET) . . . . . . . . . . . . 4

File label (TOLABEL) . . . . . . . . . . . 5

Sequence number (SEQNBR) . . . . . . . . . 5

Volume identifier (VOL) . . . . . . . . . . 5

Retention period (RETAIN) . . . . . . . . . 6

End of tape option (ENDOPT) . . . . . . . . 6

Data compression (DTACPR) . . . . . . . . . 6

Physical file (PHYFILE) . . . . . . . . . . . 6

Data base member option (MBROPT) . . . . . . 7

Creation date (CRTDATE) . . . . . . . . . . 7

Examples . . . . . . . . . . . . . . . 7

Error messages . . . . . . . . . . . . . 9

Save S/36 Library Members

(SAVS36LIBM) . . . . . . . . . . . 11

Parameters . . . . . . . . . . . . . . 12

From member (FROMMBR) . . . . . . . . . 12

From library (FROMLIB) . . . . . . . . . . 13

Device (DEV) . . . . . . . . . . . . . . 13

S/36 source members (SRCMBRS) . . . . . . . 13

File label (TOLABEL) . . . . . . . . . . . 13

Sequence number (SEQNBR) . . . . . . . . 14


Retention period (RETAIN) . . . . . . . . . 14

Diskette file exchange type (EXCHTYPE) . . . . 14

End of tape option (ENDOPT) . . . . . . . . 15

Physical file (PHYFILE) . . . . . . . . . . 15

Data base member option (MBROPT) . . . . . . 15

Record length (RCDLEN) . . . . . . . . . . 16

Examples . . . . . . . . . . . . . . . 16

Error messages . . . . . . . . . . . . . 16

Save Save File Data (SAVSAVFDTA) . . 19

Parameters . . . . . . . . . . . . . . 19

Save file (SAVF) . . . . . . . . . . . . . 20

Device (DEV) . . . . . . . . . . . . . . 20



End of media option (ENDOPT) . . . . . . . 21

Optical file (OPTFILE) . . . . . . . . . . . 22

Use optimum block (USEOPTBLK) . . . . . . 22

Clear (CLEAR) . . . . . . . . . . . . . 22

File expiration date (EXPDATE) . . . . . . . 23

Data compaction (COMPACT) . . . . . . . . 23

Output (OUTPUT) . . . . . . . . . . . . 24

File to receive output (OUTFILE) . . . . . . . 24

Output member options (OUTMBR) . . . . . . 24

Examples . . . . . . . . . . . . . . . 25

Error messages . . . . . . . . . . . . . 25

Save Security Data (SAVSECDTA) . . . 27

Parameters . . . . . . . . . . . . . . 27

Device (DEV) . . . . . . . . . . . . . . 28






Save file (SAVF) . . . . . . . . . . . . . 30


ASP device (ASPDEV) . . . . . . . . . . . 31

Clear (CLEAR) . . . . . . . . . . . . . 31

Object pre-check (PRECHK) . . . . . . . . . 32

Data compression (DTACPR) . . . . . . . . 32


Output (OUTPUT) . . . . . . . . . . . . 33



Examples . . . . . . . . . . . . . . . 35

Error messages . . . . . . . . . . . . . 35

Save Storage (SAVSTG) . . . . . . . 39

Parameters . . . . . . . . . . . . . . 39

Tape device (DEV) . . . . . . . . . . . . 40


Clear (CLEAR) . . . . . . . . . . . . . 40

Examples . . . . . . . . . . . . . . . 41

Error messages . . . . . . . . . . . . . 41

Save System (SAVSYS) . . . . . . . 43

Parameters . . . . . . . . . . . . . . 43

Device (DEV) . . . . . . . . . . . . . . 44





Omit (OMIT) . . . . . . . . . . . . . . 46

Output (OUTPUT) . . . . . . . . . . . . 46



ASP device (ASPDEV) . . . . . . . . . . . 47

Clear (CLEAR) . . . . . . . . . . . . . 48



Examples . . . . . . . . . . . . . . . 50

Error messages . . . . . . . . . . . . . 50

Save System Information (SAVSYSINF) 53

Parameters . . . . . . . . . . . . . . 54

Device (DEV) . . . . . . . . . . . . . . 54





Save file (SAVF) . . . . . . . . . . . . . 56

© Copyright IBM Corp. 1998, 2008 iii



Clear (CLEAR) . . . . . . . . . . . . . 57



Output (OUTPUT) . . . . . . . . . . . . 59



Examples . . . . . . . . . . . . . . . 60

Error messages . . . . . . . . . . . . . 61

Submit Data Base Jobs (SBMDBJOB) 63

Parameters . . . . . . . . . . . . . . 63

Data base file (FILE) . . . . . . . . . . . 63

Member (MBR) . . . . . . . . . . . . . 64

Job queue (JOBQ) . . . . . . . . . . . . 64

Show on submitted job list (DSPSBMJOB) . . . . 65

Examples . . . . . . . . . . . . . . . 65

Error messages . . . . . . . . . . . . . 65

Submit Finance Job (SBMFNCJOB) . . 67

Parameters . . . . . . . . . . . . . . 67

Device table (DEVTBL) . . . . . . . . . . 67

Program table (PGMTBL) . . . . . . . . . . 68

User table (USRTBL) . . . . . . . . . . . 68

Job name (JOB) . . . . . . . . . . . . . 68

Job description (JOBD) . . . . . . . . . . 68

Message queue (MSGQ) . . . . . . . . . . 69

Examples . . . . . . . . . . . . . . . 69

Error messages . . . . . . . . . . . . . 70

Submit Job (SBMJOB) . . . . . . . . 71

Parameters . . . . . . . . . . . . . . 72

Command to run (CMD) . . . . . . . . . . 73

Job name (JOB) . . . . . . . . . . . . . 73


Job queue (JOBQ) . . . . . . . . . . . . 74

Job priority (on JOBQ) (JOBPTY) . . . . . . . 74

Output priority (on OUTQ) (OUTPTY) . . . . . 75

Print device (PRTDEV) . . . . . . . . . . 75

Output queue (OUTQ) . . . . . . . . . . 75

User (USER) . . . . . . . . . . . . . . 76

Accounting code (ACGCDE) . . . . . . . . . 77

Print text (PRTTXT) . . . . . . . . . . . . 77

Routing data (RTGDTA) . . . . . . . . . . 77

Request data or command (RQSDTA) . . . . . 78

System library list (SYSLIBL) . . . . . . . . 78

Current library (CURLIB) . . . . . . . . . . 78

Initial library list (INLLIBL) . . . . . . . . . 79

Initial ASP group (INLASPGRP) . . . . . . . 79

Message logging (LOG) . . . . . . . . . . 80

Log CL program commands (LOGCLPGM) . . . . 81

Job log output (LOGOUTPUT) . . . . . . . . 81

Job message queue maximum size (JOBMSGQMX) 82

Job message queue full action (JOBMSGQFL) . . . 82

Inquiry message reply (INQMSGRPY) . . . . . 82

Hold on job queue (HOLD) . . . . . . . . . 83

Schedule date (SCDDATE) . . . . . . . . . 83

Schedule time (SCDTIME) . . . . . . . . . 84

Job date (DATE) . . . . . . . . . . . . . 84

Job switches (SWS) . . . . . . . . . . . . 84

Allow display by WRKSBMJOB (DSPSBMJOB) . . 85

Submitted for (SBMFOR) . . . . . . . . . . 85


Sort sequence (SRTSEQ) . . . . . . . . . . 86

Language ID (LANGID) . . . . . . . . . . 87

Country or region ID (CNTRYID) . . . . . . . 87

Coded character set ID (CCSID) . . . . . . . 87

Copy environment variables (CPYENVVAR) . . . 88

Allow multiple threads (ALWMLTTHD) . . . . . 88

Spooled file action (SPLFACN) . . . . . . . . 88

Examples . . . . . . . . . . . . . . . 89

Error messages . . . . . . . . . . . . . 89

Submit Network Job (SBMNETJOB) . . 91

Parameters . . . . . . . . . . . . . . 91

File (FILE) . . . . . . . . . . . . . . . 92

User ID (TOUSRID) . . . . . . . . . . . 92

Member (MBR) . . . . . . . . . . . . . 92

Send priority (PTY) . . . . . . . . . . . . 92

Examples . . . . . . . . . . . . . . . 93

Error messages . . . . . . . . . . . . . 93

Submit Network Server Command

(SBMNWSCMD) . . . . . . . . . . . 95

Parameters . . . . . . . . . . . . . . 95

Command (CMD) . . . . . . . . . . . . 95

Server (SERVER) . . . . . . . . . . . . 96

Command (not logged) (NOLOGCMD) . . . . . 96

Server type (SVRTYPE) . . . . . . . . . . 96

Command type (CMDTYPE) . . . . . . . . 96

Load user profile (LODUSRPRF) . . . . . . . 97

Authentication domain (AUTDMN) . . . . . . 97

Command standard output (CMDSTDOUT) . . . 97

Convert standard output (CVTSTDOUT) . . . . 98

Examples . . . . . . . . . . . . . . . 98

Error messages . . . . . . . . . . . . . 98

Submit Remote Command

(SBMRMTCMD) . . . . . . . . . . . 99

Parameters . . . . . . . . . . . . . . 99

Command to run (CMD) . . . . . . . . . 100

DDM file (DDMFILE) . . . . . . . . . . 100

Examples . . . . . . . . . . . . . . . 100

Error messages . . . . . . . . . . . . . 102

Select (SELECT) . . . . . . . . . . 103

Parameters . . . . . . . . . . . . . . 103

Examples . . . . . . . . . . . . . . . 103

Error messages . . . . . . . . . . . . . 104

Set ASP Group (SETASPGRP) . . . . 105

Parameters . . . . . . . . . . . . . . 105

ASP group (ASPGRP) . . . . . . . . . . 106

System library list (SYSLIBL) . . . . . . . . 106

Current library (CURLIB) . . . . . . . . . 106

Libraries for current thread (USRLIBL) . . . . . 107

Examples . . . . . . . . . . . . . . . 107

Error messages . . . . . . . . . . . . . 108

iv System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

Set Attention Program (SETATNPGM) 109

Parameters . . . . . . . . . . . . . . 109

Program (PGM) . . . . . . . . . . . . 109

Set attention key (SET) . . . . . . . . . . 110

Examples . . . . . . . . . . . . . . . 110

Error messages . . . . . . . . . . . . . 111

Set Customization Data (SETCSTDTA) 113

Error messages for SETCSTDTA . . . . . . . 113

Parameters . . . . . . . . . . . . . . 113

User profile (USRPRF) . . . . . . . . . . 114

Customization data to use (VALUE) . . . . . . 114

Replace customization data (REPLACE) . . . . 114

Examples . . . . . . . . . . . . . . . 114

Error messages . . . . . . . . . . . . . 114

Set Keyboard Map (SETKBDMAP) . . 117

Parameters . . . . . . . . . . . . . . 117

Device (DEV) . . . . . . . . . . . . . 121

PF1 key value (PF1) . . . . . . . . . . . 121

PF2 key value (PF2) . . . . . . . . . . . 123

PF3 key value (PF3) . . . . . . . . . . . 124

PF4 key value (PF4) . . . . . . . . . . . 125

PF5 key value (PF5) . . . . . . . . . . . 126

PF6 key value (PF6) . . . . . . . . . . . 127

PF7 key value (PF7) . . . . . . . . . . . 128

PF8 key value (PF8) . . . . . . . . . . . 129

PF9 key value (PF9) . . . . . . . . . . . 130

PF10 key value (PF10) . . . . . . . . . . 132

PF11 key value (PF11) . . . . . . . . . . 133

PF12 key value (PF12) . . . . . . . . . . 134

PF13 key value (PF13) . . . . . . . . . . 135

PF14 key value (PF14) . . . . . . . . . . 136

PF15 key value (PF15) . . . . . . . . . . 137

PF16 key value (PF16) . . . . . . . . . . 138

PF17 key value (PF17) . . . . . . . . . . 139

PF18 key value (PF18) . . . . . . . . . . 141

PF19 key value (PF19) . . . . . . . . . . 142

PF20 key value (PF20) . . . . . . . . . . 143

PF21 key value (PF21) . . . . . . . . . . 144

PF22 key value (PF22) . . . . . . . . . . 145

PF23 key value (PF23) . . . . . . . . . . 146

PF24 key value (PF24) . . . . . . . . . . 147

PA1-PF1 key value (PA1PF1) . . . . . . . . 148









PA1-PF10 key value (PA1PF10) . . . . . . . 159















Examples . . . . . . . . . . . . . . . 175

Error messages . . . . . . . . . . . . . 176

Set Master Key (SETMSTKEY) . . . . 177

Parameters . . . . . . . . . . . . . . 177

Master key (MSTKEY) . . . . . . . . . . 177

Examples . . . . . . . . . . . . . . . 177

Error messages . . . . . . . . . . . . . 178

Set Object Access (SETOBJACC) . . . 179

Parameters . . . . . . . . . . . . . . 179

Object (OBJ) . . . . . . . . . . . . . . 180

Object type (OBJTYPE) . . . . . . . . . . 181

Storage pool (POOL) . . . . . . . . . . . 181

Member (MBR) . . . . . . . . . . . . . 181

Member data (MBRDATA) . . . . . . . . . 181

Examples . . . . . . . . . . . . . . . 182

Error messages . . . . . . . . . . . . . 182

Set Program Information

(SETPGMINF) . . . . . . . . . . . 183

Error messages for SETPGMINF . . . . . . . 183

Parameters . . . . . . . . . . . . . . 183

Root program (ROOTPGM) . . . . . . . . 184

Sub-programs (SUBPGM) . . . . . . . . . 185

Library information files (LIBFILE) . . . . . . 185

Listing detail (LISTDETAIL) . . . . . . . . 186

Print file (PRTFILE) . . . . . . . . . . . 186

Run attributes (RUNATTR) . . . . . . . . . 187

Performance options (PFROPT) . . . . . . . 187

Initial size of heap spaces (HEAPSIZE) . . . . . 188

Initial size of auto storage (STACKSIZE) . . . . 188

Session file attributes (SSNATTR) . . . . . . . 188

Debug options (DBGOPT) . . . . . . . . . 189

Examples . . . . . . . . . . . . . . . 189

Error messages . . . . . . . . . . . . . 189

Set Tape Category (SETTAPCGY) . . . 191

Parameters . . . . . . . . . . . . . . 191

Library device (DEV) . . . . . . . . . . . 191

Option (OPTION) . . . . . . . . . . . . 191

Category (CGY) . . . . . . . . . . . . 192

Cartridge order (CTGORDER) . . . . . . . . 193

Target category (TGTCGY) . . . . . . . . . 193

Mount identifier (MNTID) . . . . . . . . . 194

Examples . . . . . . . . . . . . . . . 194

Error messages . . . . . . . . . . . . . 195

Set Upgrade Environment

(SETUPGENV) . . . . . . . . . . . 197

Parameters . . . . . . . . . . . . . . 197

Upgrade environment (UPGENV) . . . . . . 197

Contents v

Target release (TGTRLS) . . . . . . . . . . 197

Target processor (TGTPRC) . . . . . . . . . 198

Merge with Advanced/36 (MERGE) . . . . . . 198

Upgrade environment identifier (UPGENVID) . . 198

Examples . . . . . . . . . . . . . . . 198

Error messages . . . . . . . . . . . . . 198

Sign Off (SIGNOFF) . . . . . . . . . 199

Parameters . . . . . . . . . . . . . . 199

Job log (LOG) . . . . . . . . . . . . . 199

Drop line (DROP) . . . . . . . . . . . . 199

End connection (ENDCNN) . . . . . . . . 200

Examples . . . . . . . . . . . . . . . 200

Error messages . . . . . . . . . . . . . 200

Select Command (SLTCMD) . . . . . 201

Parameters . . . . . . . . . . . . . . 201

Command (CMD) . . . . . . . . . . . . 201

Examples . . . . . . . . . . . . . . . 202

Error messages . . . . . . . . . . . . . 202

Send Break Message (SNDBRKMSG) 203

Parameters . . . . . . . . . . . . . . 203

Message text (MSG) . . . . . . . . . . . 203

To work station message queue (TOMSGQ) . . . 204

Message type (MSGTYPE) . . . . . . . . . 204

Message queue to get reply (RPYMSGQ) . . . . 204


Examples . . . . . . . . . . . . . . . 205

Error messages . . . . . . . . . . . . . 206

Send Distribution (SNDDST) . . . . . 207

Parameters . . . . . . . . . . . . . . 207

Information to be sent (TYPE) . . . . . . . . 209

Recipient (TOUSRID) . . . . . . . . . . . 209

Internet Recipient (TOINTNET) . . . . . . . 210

Description (DSTD) . . . . . . . . . . . 211

Message (MSG) . . . . . . . . . . . . . 211

Message (LONGMSG) . . . . . . . . . . 211

Confirmation of delivery (CFMDEL) . . . . . . 211

Sensitivity (SENSITIV) . . . . . . . . . . 212

Personal (PERSONAL) . . . . . . . . . . 212

Content importance (IMPORTANCE) . . . . . 212

Priority (PTY) . . . . . . . . . . . . . 213

User identifier (USRID) . . . . . . . . . . 213

Document file (DOCFILE) . . . . . . . . . 213

Document member (DOCMBR) . . . . . . . 214

Document type (DOCTYPE) . . . . . . . . 214

Send format (SNDFMT) . . . . . . . . . . 214

System code (SYSCOD) . . . . . . . . . . 215

Document character identifier (DOCCHRID) . . . 215

Distribution identifier (DSTID) . . . . . . . 215

Distribution ID extension (DSTIDEXN) . . . . . 216

Document (DOC) . . . . . . . . . . . . 216

In folder (FLR) . . . . . . . . . . . . . 216

Document identifier (DOCID) . . . . . . . . 216

Profile file (IDPFILE) . . . . . . . . . . . 217

Profile member (IDPMBR) . . . . . . . . . 218

Document description (DOCD) . . . . . . . 218

Author (AUTHOR) . . . . . . . . . . . 218

Document class (DOCCLS) . . . . . . . . . 218

Keyword (KWD) . . . . . . . . . . . . 219

Subject (SUBJECT) . . . . . . . . . . . . 219

Document date (DOCDATE) . . . . . . . . 219

File cabinet location (FILCAB) . . . . . . . . 220

Copy list (CPYLST) . . . . . . . . . . . 220

Expiration date (EXPDATE) . . . . . . . . 220

Creation date (CRTDATE) . . . . . . . . . 220

Reference (REFERENCE) . . . . . . . . . 221

Action due date (ACTDATE) . . . . . . . . 221

Reply requested (RPYDATE) . . . . . . . . 221

Document status (STATUS) . . . . . . . . . 222

Completion date (CMPDATE) . . . . . . . . 222

Project (PROJECT) . . . . . . . . . . . . 222

Language ID (DOCLANGID) . . . . . . . . 222

Country or region ID (DOCCNTRYID) . . . . . 223

Allow alternate recipient (ALWALTRCP) . . . . 223

Disclose recipient (DISCLOSE) . . . . . . . . 223

Allow X.400 conversion (ALWX400CNV) . . . . 224

Authorizing user (AUTUSR) . . . . . . . . 224

Distribution expiry indicator (DSTEXPDATE) . . . 224

Command character identifier (CMDCHRID) . . . 225

Examples . . . . . . . . . . . . . . . 226

Error messages . . . . . . . . . . . . . 226

Send Distribution Queue (SNDDSTQ) 229

Parameters . . . . . . . . . . . . . . 229

Distribution queue (DSTQ) . . . . . . . . . 230

Priority (PTY) . . . . . . . . . . . . . 230

Examples . . . . . . . . . . . . . . . 230

Error messages . . . . . . . . . . . . . 230

Send File (SNDF) . . . . . . . . . . 233

Parameters . . . . . . . . . . . . . . 233

Display device (DEV) . . . . . . . . . . . 233

Record format (RCDFMT) . . . . . . . . . 234

Open file identifier (OPNID) . . . . . . . . 234

Examples . . . . . . . . . . . . . . . 234

Error messages . . . . . . . . . . . . . 235

Send Journal Entry (SNDJRNE) . . . 237

Parameters . . . . . . . . . . . . . . 237

Journal (JRN) . . . . . . . . . . . . . 238

Journal entry type (TYPE) . . . . . . . . . 238

Entry data (ENTDTA) . . . . . . . . . . 239

Journaled physical file (FILE) . . . . . . . . 239

Object (OBJ) . . . . . . . . . . . . . . 240

Object (OBJPATH) . . . . . . . . . . . . 240

File identifier (OBJFID) . . . . . . . . . . 241

Force journal entry (FORCE) . . . . . . . . 241

Override journal state (OVRSTATE) . . . . . . 241

Examples . . . . . . . . . . . . . . . 242

Error messages . . . . . . . . . . . . . 242

Send Message (SNDMSG) . . . . . . 245

Parameters . . . . . . . . . . . . . . 245

Message text (MSG) . . . . . . . . . . . 246

To user profile (TOUSR) . . . . . . . . . . 246

To message queue (TOMSGQ) . . . . . . . . 246


vi System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)



Examples . . . . . . . . . . . . . . . 248

Error messages . . . . . . . . . . . . . 249

Send Network File (SNDNETF) . . . . 251

Parameters . . . . . . . . . . . . . . 251

File (FILE) . . . . . . . . . . . . . . 252

User ID (TOUSRID) . . . . . . . . . . . 252

Member (MBR) . . . . . . . . . . . . . 252

To file type (TOTYPE) . . . . . . . . . . 253

VM/MVS class (CLASS) . . . . . . . . . . 253

Send format (FORMAT) . . . . . . . . . . 253

Send priority (PTY) . . . . . . . . . . . 254

Examples . . . . . . . . . . . . . . . 254

Error messages . . . . . . . . . . . . . 254

Send Network Message

(SNDNETMSG) . . . . . . . . . . . 257

Parameters . . . . . . . . . . . . . . 257

Message text (MSG) . . . . . . . . . . . 257

User ID (TOUSRID) . . . . . . . . . . . 258

Examples . . . . . . . . . . . . . . . 258

Error messages . . . . . . . . . . . . . 258

Send Network Spooled File

(SNDNETSPLF) . . . . . . . . . . 261

Parameters . . . . . . . . . . . . . . 261

Spooled file (FILE) . . . . . . . . . . . 262

User ID (TOUSRID) . . . . . . . . . . . 262

Job name (JOB) . . . . . . . . . . . . . 262

Spooled file number (SPLNBR) . . . . . . . 263

Job system name (JOBSYSNAME) . . . . . . 263

Spooled file created (CRTDATE) . . . . . . . 263

Data format (DTAFMT) . . . . . . . . . . 264

VM/MVS class (CLASS) . . . . . . . . . . 265

Send priority (PTY) . . . . . . . . . . . 265

Examples . . . . . . . . . . . . . . . 266

Error messages . . . . . . . . . . . . . 266

Send Program Message

(SNDPGMMSG) . . . . . . . . . . 269

Parameters . . . . . . . . . . . . . . 269

Message text, or (MSG) . . . . . . . . . . 270

Message identifier (MSGID) . . . . . . . . 270

Message file (MSGF) . . . . . . . . . . . 271

Message data field values (MSGDTA) . . . . . 271

Call stack entry message queue (TOPGMQ) . . . 271

Send to non-pgm message queue (TOMSGQ) . . . 274




CL var for KEYVAR (4) (KEYVAR) . . . . . . 276


Examples . . . . . . . . . . . . . . . 277

Error messages . . . . . . . . . . . . . 278

Send PTF Order (SNDPTFORD) . . . . 281

Parameters . . . . . . . . . . . . . . 281

PTF identifier (PTFID) . . . . . . . . . . 282

PTF parts (PTFPART) . . . . . . . . . . . 283

Remote control point (RMTCPNAME) . . . . . 283

Remote network identifier (RMTNETID) . . . . 283

Delivery method (DELIVERY) . . . . . . . . 283

Delivery format (DLVRYFMT) . . . . . . . . 284

Order (ORDER) . . . . . . . . . . . . 284

Reorder (REORDER) . . . . . . . . . . . 284

Check PTF (CHKPTF) . . . . . . . . . . 284

Image option (IMGOPT) . . . . . . . . . . 285

Image directory (IMGDIR) . . . . . . . . . 285

Image prefix (IMGPFX) . . . . . . . . . . 285

Image catalog (IMGCLG) . . . . . . . . . 285

Examples . . . . . . . . . . . . . . . 286

Error messages . . . . . . . . . . . . . 287

Send/Receive File (SNDRCVF) . . . . 289

Parameters . . . . . . . . . . . . . . 289

Display device (DEV) . . . . . . . . . . . 289

Record format (RCDFMT) . . . . . . . . . 290

Open file identifier (OPNID) . . . . . . . . 290

Wait (WAIT) . . . . . . . . . . . . . . 290

Examples . . . . . . . . . . . . . . . 290

Error messages . . . . . . . . . . . . . 291

Send Reply (SNDRPY) . . . . . . . 293

Parameters . . . . . . . . . . . . . . 293

Message key (MSGKEY) . . . . . . . . . . 293


Reply (RPY) . . . . . . . . . . . . . . 294

Remove message (RMV) . . . . . . . . . . 294

Reject default reply (RJTDFTRPY) . . . . . . 295


Examples . . . . . . . . . . . . . . . 295

Error messages . . . . . . . . . . . . . 295

Send Service Request (SNDSRVRQS) 297

Parameters . . . . . . . . . . . . . . 297

Action (ACTION) . . . . . . . . . . . . 297

Remote control point (RMTCPNAME) . . . . . 297


Problem identifier (PRBID) . . . . . . . . . 298

Examples . . . . . . . . . . . . . . . 298

Error messages . . . . . . . . . . . . . 299

Send TIE File (SNDTIEF) . . . . . . . 301

Parameters . . . . . . . . . . . . . . 301

File (FILE) . . . . . . . . . . . . . . 301

Member (MBR) . . . . . . . . . . . . . 302

User ID (TOUSRID) . . . . . . . . . . . 302

Node (TONODE) . . . . . . . . . . . . 302

To file (TOFILE) . . . . . . . . . . . . 302

Type of contents of file (TYPE) . . . . . . . 302

Priority (PTY) . . . . . . . . . . . . . 303

Examples . . . . . . . . . . . . . . . 303

Error messages . . . . . . . . . . . . . 303

Send User Message (SNDUSRMSG) 305

Parameters . . . . . . . . . . . . . . 305

Message text, or (MSG) . . . . . . . . . . 306

Contents vii

Message identifier (MSGID) . . . . . . . . 306

Message file (MSGF) . . . . . . . . . . . 306

Message data field values (MSGDTA) . . . . . 307

Valid reply values (VALUES) . . . . . . . . 307

Default reply value (DFT) . . . . . . . . . 307


To message queue (TOMSGQ) . . . . . . . . 308


CL var for message reply (MSGRPY) . . . . . 309

Translate table (TRNTBL) . . . . . . . . . 309


Examples . . . . . . . . . . . . . . . 310

Error messages . . . . . . . . . . . . . 310

Display Mounted FS Information

(STATFS) . . . . . . . . . . . . . 313

Parameters . . . . . . . . . . . . . . 313

Object (OBJ) . . . . . . . . . . . . . . 313

Output (OUTPUT) . . . . . . . . . . . . 313

Examples . . . . . . . . . . . . . . . 314

Error messages . . . . . . . . . . . . . 314

Start Agent Services (STRAGTSRV) 315

Parameters . . . . . . . . . . . . . . 315

Preferences file directory (PREFDIR) . . . . . . 315

Home directory (HOMEDIR) . . . . . . . . 315

Additional classpath (CLASSPATH) . . . . . . 316

User profile for SBMJOB (SBMJOBUSER) . . . . 316

Examples . . . . . . . . . . . . . . . 317

Error messages . . . . . . . . . . . . . 317

Start ASP Balance (STRASPBAL) . . . 319

Parameters . . . . . . . . . . . . . . 320

Balance type (TYPE) . . . . . . . . . . . 320

Auxiliary storage pool ID (ASP) . . . . . . . 320

ASP device (ASPDEV) . . . . . . . . . . 321

Storage unit (UNIT) . . . . . . . . . . . 321

Time limit (TIMLMT) . . . . . . . . . . . 321

Examples . . . . . . . . . . . . . . . 322

Error messages . . . . . . . . . . . . . 322

Start CHT Server (STRCHTSVR) . . . 325

Parameters . . . . . . . . . . . . . . 325

Server (SERVER) . . . . . . . . . . . . 325

Request response timeout (RSPTIMO) . . . . . 326

Authorization list (AUTL) . . . . . . . . . 326

Node (NODE) . . . . . . . . . . . . . 326

Examples . . . . . . . . . . . . . . . 327

Error messages . . . . . . . . . . . . . 327

Start Cleanup (STRCLNUP) . . . . . 329

Parameters . . . . . . . . . . . . . . 329

Option (OPTION) . . . . . . . . . . . . 329

Examples . . . . . . . . . . . . . . . 330

Error messages . . . . . . . . . . . . . 330

Start Communications Server

(STRCMNSVR) . . . . . . . . . . . 333

Parameters . . . . . . . . . . . . . . 333

Server type (SERVER) . . . . . . . . . . 333

Number of servers (NBRPASTHR) . . . . . . 333

Examples . . . . . . . . . . . . . . . 334

Error messages . . . . . . . . . . . . . 334

Start Communications Trace

(STRCMNTRC) . . . . . . . . . . . 335

Parameters . . . . . . . . . . . . . . 336

Configuration object (CFGOBJ) . . . . . . . 337

Type (CFGTYPE) . . . . . . . . . . . . 337

Buffer size (MAXSTG) . . . . . . . . . . 337

Data direction (DTADIR) . . . . . . . . . 338

Trace full (TRCFULL) . . . . . . . . . . . 338

Number of user bytes to trace (USRDTA) . . . . 338

Communications trace options (CMNTRCOPTS) 339

DDI trace options (DDITRCOPTS) . . . . . . 339

Remote controller (RMTCTL) . . . . . . . . 340

Remote MAC address (RMTMAC) . . . . . . 340

Remote SAP (RMTSAP) . . . . . . . . . . 340

Local SAP (LCLSAP) . . . . . . . . . . . 340

IP protocol number (IPPCLNUM) . . . . . . 340

Remote IP address (RMTIPADR) . . . . . . . 341

LMI trace options (LMITRCOPTS) . . . . . . 341

NWS trace options (NWSTRCOPTS) . . . . . . 341

Watch for message (WCHMSG) . . . . . . . 341

Watched message queue (WCHMSGQ) . . . . . 342

Watched job (WCHJOB) . . . . . . . . . . 343

Watch for LIC log entry (WCHLICLOG) . . . . 344

Watch for PAL entry (WCHPAL) . . . . . . . 346

Length of time to watch (WCHTIMO) . . . . . 347

Trace program (TRCPGM) . . . . . . . . . 347

Time interval (TRCPGMITV) . . . . . . . . 349

Run priority (RUNPTY) . . . . . . . . . . 350

Trace description (TEXT) . . . . . . . . . 350

Examples . . . . . . . . . . . . . . . 350

Error messages . . . . . . . . . . . . . 351

Start Commitment Control

(STRCMTCTL) . . . . . . . . . . . 353

Parameters . . . . . . . . . . . . . . 353

Lock level (LCKLVL) . . . . . . . . . . . 354

Notify object (NFYOBJ) . . . . . . . . . . 354

Commitment definition scope (CMTSCOPE) . . . 355

Text ’description’ (TEXT) . . . . . . . . . 356

Journal (DFTJRN) . . . . . . . . . . . . 356

Journal entries to be omitted (OMTJRNE) . . . . 356

Examples . . . . . . . . . . . . . . . 357

Error messages . . . . . . . . . . . . . 357

Start Copy Screen (STRCPYSCN) . . . 359

Parameters . . . . . . . . . . . . . . 359

Source device (SRCDEV) . . . . . . . . . 360

Output device (OUTDEV) . . . . . . . . . 360

Job queue (JOBQ) . . . . . . . . . . . . 360



Examples . . . . . . . . . . . . . . . 362

Error messages . . . . . . . . . . . . . 362

Start Debug (STRDBG) . . . . . . . 363

viii System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

Parameters . . . . . . . . . . . . . . 364

Program (PGM) . . . . . . . . . . . . 364

Default program (DFTPGM) . . . . . . . . 365

Maximum trace statements (MAXTRC) . . . . . 365

Trace full (TRCFULL) . . . . . . . . . . . 366

Update production files (UPDPROD) . . . . . 366

OPM source level debug (OPMSRC) . . . . . . 366

Service program (SRVPGM) . . . . . . . . 367

Class file (CLASS) . . . . . . . . . . . . 367

Display module source (DSPMODSRC) . . . . . 368

Source debug program (SRCDBGPGM) . . . . . 368

Unmonitored message program (UNMONPGM) 368

Examples . . . . . . . . . . . . . . . 369

Error messages . . . . . . . . . . . . . 370

Start Debug Server (STRDBGSVR) 371

Parameters . . . . . . . . . . . . . . 371

Examples . . . . . . . . . . . . . . . 371

Error messages . . . . . . . . . . . . . 371

Start Database Monitor (STRDBMON) 373

Parameters . . . . . . . . . . . . . . 373



Job name (JOB) . . . . . . . . . . . . . 375

Type of records (TYPE) . . . . . . . . . . 376

Force record write (FRCRCD) . . . . . . . . 376

Run time threshold (RUNTHLD) . . . . . . . 376

Storage threshold (STGTHLD) . . . . . . . . 376

Include system SQL (INCSYSSQL) . . . . . . 377

Filter by database file (FTRFILE) . . . . . . . 377

Filter by user profile (FTRUSER) . . . . . . . 378

Filter by internet address (FTRINTNETA) . . . . 378

Filter by local port number (FTRLCLPORT) . . . 378

Filter by query governor (FTRQRYGOVR) . . . . 379

Comment (COMMENT) . . . . . . . . . . 379

Examples . . . . . . . . . . . . . . . 379

Error messages . . . . . . . . . . . . . 382

Start Data Base Reader (STRDBRDR) 383

Parameters . . . . . . . . . . . . . . 383


Member (MBR) . . . . . . . . . . . . . 384

Job queue (JOBQ) . . . . . . . . . . . . 384

Queue for reader messages (MSGQ) . . . . . . 385

Reader (RDR) . . . . . . . . . . . . . 385

Examples . . . . . . . . . . . . . . . 385

Error messages . . . . . . . . . . . . . 385

Start DFU (STRDFU) . . . . . . . . 387

Error messages for STRDFU . . . . . . . . 387

Parameters . . . . . . . . . . . . . . 387

Option (OPTION) . . . . . . . . . . . . 387

DFU program (DFUPGM) . . . . . . . . . 388


Member (MBR) . . . . . . . . . . . . . 388

Examples . . . . . . . . . . . . . . . 388

Error messages . . . . . . . . . . . . . 389

Start DIG Query (STRDIGQRY) . . . . 391

Parameters . . . . . . . . . . . . . . 391

Query name (HOSTNAME) . . . . . . . . 393

Query type (TYPE) . . . . . . . . . . . 393

Query class (CLASS) . . . . . . . . . . . 393

Reverse lookup (REVERSE) . . . . . . . . . 394

Domain name server (DMNNAMSVR) . . . . . 395

Domain name server port (PORT) . . . . . . 395

Query timeout (TIMEOUT) . . . . . . . . . 395

Use domain search list (USEDMNSCHL) . . . . 396

Domain search list (DMNSCHLIST) . . . . . . 396

Source address (SRCADR) . . . . . . . . . 396

Batch input file (BCHFILE) . . . . . . . . . 397

IP Version (IPVSN) . . . . . . . . . . . 398

Network protocol (PROTOCOL) . . . . . . . 398

Recursion desired (SETRDFLAG) . . . . . . . 398

Authoritative answers only (SETAAFLAG) . . . 398

Authentic data (SETADFLAG) . . . . . . . . 399

Disable DNSSEC checking (SETCDFLAG) . . . . 399

Print multiple lines (MULTILINE) . . . . . . 399

Print short answer (SHORT) . . . . . . . . 399

Print server in short answer (IDENTIFY) . . . . 399

Print query (PRTQRY) . . . . . . . . . . 400

Print RR class (PRTCLASS) . . . . . . . . . 400

Print RR TTL (PRTTTL) . . . . . . . . . . 400

Print all query detail (PRTALL) . . . . . . . 400

Print query command (CMD) . . . . . . . . 400

Print query comments (COMMENTS) . . . . . 401

Print query statistics (STATS) . . . . . . . . 401

Print question section (QUESTION) . . . . . . 401

Print answer section (ANSWER) . . . . . . . 401

Print authority section (AUTHORITY) . . . . . 401

Print additional section (ADDITIONAL) . . . . 402

Key file (KEYFILE) . . . . . . . . . . . 402

Key name (KEYNAME) . . . . . . . . . . 402

Stop on SERVFAIL (STOPFAIL) . . . . . . . 403

Ignore truncated responses (UDPTRUNC) . . . . 403

List authoritative servers (NSSCH) . . . . . . 403

Trace delegation path (TRACE) . . . . . . . 403

Times to try UDP query (UDPTRIES) . . . . . 403

UDP retry (UDPNBRRTY) . . . . . . . . . 404

Number of dots (NBRDOTS) . . . . . . . . 404

UDP buffer size for EDNS (BUFSIZE) . . . . . 404

Set EDNS version (EDNS) . . . . . . . . . 404

Clear EDNS version (NOEDNS) . . . . . . . 405

Best effort display (BESTEFFORT) . . . . . . 405

Request DNSSEC records (DNSSEC) . . . . . . 405

Chase DNSSEC chains (SIGCHASE) . . . . . . 405

Trusted keys file (TRUSTEDKEY) . . . . . . . 406

DNSSEC top down validation (TOPDOWN) . . . 406

Output file (TOSTMF) . . . . . . . . . . 406

Examples . . . . . . . . . . . . . . . 406

Error messages . . . . . . . . . . . . . 409

Start Directory Shadowing

(STRDIRSHD) . . . . . . . . . . . 411

Parameters . . . . . . . . . . . . . . 411

Examples . . . . . . . . . . . . . . . 411

Error messages . . . . . . . . . . . . . 411

Contents ix

Start NSLOOKUP Query

(STRDNSQRY) . . . . . . . . . . . 413

Parameters . . . . . . . . . . . . . . 415



Examples . . . . . . . . . . . . . . . 416

Error messages . . . . . . . . . . . . . 417

Start Disk Reorganization

(STRDSKRGZ) . . . . . . . . . . . 419

Parameters . . . . . . . . . . . . . . 419

Auxiliary storage pool ID (ASP) . . . . . . . 419


Time limit (TIMLMT) . . . . . . . . . . . 420

Examples . . . . . . . . . . . . . . . 420

Error messages . . . . . . . . . . . . . 421

Start Disk Watcher (STRDW) . . . . . 423

Parameters . . . . . . . . . . . . . . 423

Definition (DFN) . . . . . . . . . . . . 423

Collection (COL) . . . . . . . . . . . . 424

Library (LIB) . . . . . . . . . . . . . 424


Replace data (RPLDTA) . . . . . . . . . . 424

Collection interval (COLITV) . . . . . . . . 425

End collection (ENDCOL) . . . . . . . . . 425

Hardware file (HDWF) . . . . . . . . . . 425

Examples . . . . . . . . . . . . . . . 426

Error messages . . . . . . . . . . . . . 426

Start Education (STREDU) . . . . . . 429

Parameters . . . . . . . . . . . . . . 429

Examples . . . . . . . . . . . . . . . 429

Error messages . . . . . . . . . . . . . 429

Start 3270 Display Emulation

(STREML3270) . . . . . . . . . . . 431

Parameters . . . . . . . . . . . . . . 431

Emulation controller (EMLCTL) . . . . . . . 432

Emulation device (EMLDEV) . . . . . . . . 433

Emulation location (EMLLOC) . . . . . . . 433

Display device, batch only (DSPDEV) . . . . . 433

Page Up (Roll Down) key (PAGEUP) . . . . . 433

Page Down (Roll Up) key (PAGEDOWN) . . . . 434

Test Request key (TESTREQ) . . . . . . . . 434

Cursor Select key (CSRSLT) . . . . . . . . 435

SNA DBCS 3270PC emulation (IGCEMLPC) . . . 435

Emulation printer device (EMLPRTDEV) . . . . 435

Timeout wait for host (INZWAIT) . . . . . . 435

Numeric lock keyboard (NUMLCK) . . . . . . 436

Handle nulls (NULLS) . . . . . . . . . . 436

Host signon/logon command (LOGON) . . . . 436

Wait response (WAITRSP) . . . . . . . . . 437

End emulation conditions (ENDCOND) . . . . 437

Attention emulation menu (ATNEMLMNU) . . . 438

Function key program (FKEYPGM) . . . . . . 438

Keyboard language type (KBDTYPE) . . . . . 439

Outgoing translation table (TRNTBLOUT) . . . . 440

Incoming translation table (TRNTBLIN) . . . . 440

Configuration entry (EMLCFGE) . . . . . . . 440

Examples . . . . . . . . . . . . . . . 441

Error messages . . . . . . . . . . . . . 441

Start EPM Environment (STREPMENV) 445

Error messages for STREPMENV . . . . . . . 445

Parameters . . . . . . . . . . . . . . 445

Environment Name (EPMENV) . . . . . . . 445

Environment Program (ROOTPGM) . . . . . . 445

Examples . . . . . . . . . . . . . . . 446

Error messages . . . . . . . . . . . . . 446

Start Font Management Aid (STRFMA) 447

Error messages for STRFMA . . . . . . . . 447

Parameters . . . . . . . . . . . . . . 447

Examples . . . . . . . . . . . . . . . 447

Error messages . . . . . . . . . . . . . 447

Start HOST Query (STRHOSTQRY) 449

Parameters . . . . . . . . . . . . . . 449


Query type (TYPE) . . . . . . . . . . . 450

Query class (CLASS) . . . . . . . . . . . 450


Display SOA records (SOA) . . . . . . . . 451

List all hosts (AXFR) . . . . . . . . . . . 452

Use IP6.INT domain (IP6INT) . . . . . . . . 452

Recursion desired (SETRDFLAG) . . . . . . . 452

Network protocol (PROTOCOL) . . . . . . . 452

Show debug information (DEBUG) . . . . . . 452

IP Version (IPVSN) . . . . . . . . . . . 453

Number of dots (NBRDOTS) . . . . . . . . 453

Query timeout (TIMEOUT) . . . . . . . . . 453

UDP retry (UDPNBRRTY) . . . . . . . . . 453

Output file (TOSTMF) . . . . . . . . . . 453

Examples . . . . . . . . . . . . . . . 454

Error messages . . . . . . . . . . . . . 454

Start Host Server (STRHOSTSVR) . . 457

Error messages for STRHOSTSVR . . . . . . 457

Parameters . . . . . . . . . . . . . . 458

Server type (SERVER) . . . . . . . . . . 458

Required protocol (RQDPCL) . . . . . . . . 459

Examples . . . . . . . . . . . . . . . 459

Error messages . . . . . . . . . . . . . 459

Start IDDU (STRIDD) . . . . . . . . 461

Parameters . . . . . . . . . . . . . . 461

Examples . . . . . . . . . . . . . . . 461

Error messages . . . . . . . . . . . . . 461

Start IP over SNA Interface

(STRIPSIFC) . . . . . . . . . . . . 463

Parameters . . . . . . . . . . . . . . 463

Internet address (INTNETADR) . . . . . . . 463

Examples . . . . . . . . . . . . . . . 463

Error messages . . . . . . . . . . . . . 463

Start ITF (STRITF) . . . . . . . . . 465

x System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

Parameters . . . . . . . . . . . . . . 465

Remote location (RMTLOCNAME) . . . . . . 465

Examples . . . . . . . . . . . . . . . 465

Error messages . . . . . . . . . . . . . 465

Start Journal (STRJRN) . . . . . . . 467

Parameters . . . . . . . . . . . . . . 468

Objects (OBJ) . . . . . . . . . . . . . 468

File identifier (OBJFID) . . . . . . . . . . 469

Journal (JRN) . . . . . . . . . . . . . 469

Directory subtree (SUBTREE) . . . . . . . . 469

Name pattern (PATTERN) . . . . . . . . . 470

New objects inherit journaling (INHERIT) . . . . 471

Images (IMAGES) . . . . . . . . . . . . 471

Omit journal entry (OMTJRNE) . . . . . . . 471

Logging level (LOGLVL) . . . . . . . . . 471

Examples . . . . . . . . . . . . . . . 472

Error messages . . . . . . . . . . . . . 473

Start Journal Access Path

(STRJRNAP) . . . . . . . . . . . . 475

Parameters . . . . . . . . . . . . . . 476

Journaled file (FILE) . . . . . . . . . . . 476

Journal (JRN) . . . . . . . . . . . . . 477


Examples . . . . . . . . . . . . . . . 477

Error messages . . . . . . . . . . . . . 477

Start Journal Library (STRJRNLIB) 481

Parameters . . . . . . . . . . . . . . 482

Library (LIB) . . . . . . . . . . . . . 482

Journal (JRN) . . . . . . . . . . . . . 482

Inherit rules (INHRULES) . . . . . . . . . 483


Examples . . . . . . . . . . . . . . . 485

Error messages . . . . . . . . . . . . . 486

Start Journal Object (STRJRNOBJ) 487

Parameters . . . . . . . . . . . . . . 488

Object (OBJ) . . . . . . . . . . . . . . 488


Journal (JRN) . . . . . . . . . . . . . 489

Images (IMAGES) . . . . . . . . . . . . 489


Examples . . . . . . . . . . . . . . . 490

Error messages . . . . . . . . . . . . . 490

Start Journal Physical File

(STRJRNPF) . . . . . . . . . . . . 491

Parameters . . . . . . . . . . . . . . 492

Physical file to be journaled (FILE) . . . . . . 492

Journal (JRN) . . . . . . . . . . . . . 493

Record images (IMAGES) . . . . . . . . . 493

Journal entries to be omitted (OMTJRNE) . . . . 493


Examples . . . . . . . . . . . . . . . 494

Error messages . . . . . . . . . . . . . 494

Start Job Watcher (STRJW) . . . . . 497

Parameters . . . . . . . . . . . . . . 497

Definition (DFN) . . . . . . . . . . . . 498

Collection (COL) . . . . . . . . . . . . 498

Library (LIB) . . . . . . . . . . . . . 498


Replace data (RPLDTA) . . . . . . . . . . 499

Collection interval (COLITV) . . . . . . . . 499

End collection (ENDCOL) . . . . . . . . . 499

Job name (JOB) . . . . . . . . . . . . . 500

Task name (TASKNAME) . . . . . . . . . 501

TDE number (TDENBR) . . . . . . . . . . 501

Examples . . . . . . . . . . . . . . . 501

Error messages . . . . . . . . . . . . . 502

Start Job Log Server (STRLOGSVR) 503

Parameters . . . . . . . . . . . . . . 503

Number of servers (NBRSVR) . . . . . . . . 503

Examples . . . . . . . . . . . . . . . 503

Error messages . . . . . . . . . . . . . 504

Start Mode (STRMOD) . . . . . . . . 505

Parameters . . . . . . . . . . . . . . 505


Device (DEV) . . . . . . . . . . . . . 505

Mode (MODE) . . . . . . . . . . . . . 506

Local location (LCLLOCNAME) . . . . . . . 506


Examples . . . . . . . . . . . . . . . 507

Error messages . . . . . . . . . . . . . 507

Start Mail Server Framework

(STRMSF) . . . . . . . . . . . . . 509

Parameters . . . . . . . . . . . . . . 509

How to process mail messages (MSGOPT) . . . . 509

Number of MSF jobs (NBRMSFJOB) . . . . . . 509

Examples . . . . . . . . . . . . . . . 510

Error messages . . . . . . . . . . . . . 510

Start NFS Server (STRNFSSVR) . . . 511

Parameters . . . . . . . . . . . . . . 512

Server daemon (SERVER) . . . . . . . . . 512

Number of server daemons (NBRSVR) . . . . . 512

Number of block I/O daemons (NBRBIO) . . . . 513

Retrieve RPC registration (RTVRPCREG) . . . . 513

Timeout for start of daemon (STRJOBTIMO) . . . 513

Examples . . . . . . . . . . . . . . . 513

Error messages . . . . . . . . . . . . . 514

Start Object Conversion

(STROBJCVN) . . . . . . . . . . . 515

Parameters . . . . . . . . . . . . . . 516

Option (OPTION) . . . . . . . . . . . . 516

Library (LIB) . . . . . . . . . . . . . 516



Object (OBJ) . . . . . . . . . . . . . . 518

Directory subtree (SUBTREE) . . . . . . . . 518

Examples . . . . . . . . . . . . . . . 519

Error messages . . . . . . . . . . . . . 520

Contents xi

Start Pass-Through (STRPASTHR) 521

Parameters . . . . . . . . . . . . . . 521


APPC device (CNNDEV) . . . . . . . . . 522

Virtual controller (VRTCTL) . . . . . . . . 522

Virtual display device (VRTDEV) . . . . . . . 523

Mode (MODE) . . . . . . . . . . . . . 523



System request program (SRQ10PGM) . . . . . 524

User profile (RMTUSER) . . . . . . . . . 524

User password (RMTPWD) . . . . . . . . . 525

Initial program to call (RMTINLPGM) . . . . . 525

Initial menu (RMTINLMNU) . . . . . . . . 525

Current library (RMTCURLIB) . . . . . . . . 526

Display option (PASTHRSCN) . . . . . . . . 526

Examples . . . . . . . . . . . . . . . 526

Error messages . . . . . . . . . . . . . 527

Start PC Command (STRPCCMD) . . . 531

Error messages for STRPCCMD . . . . . . . 531

Parameters . . . . . . . . . . . . . . 531

PC command (PCCMD) . . . . . . . . . . 531

Pause (PAUSE) . . . . . . . . . . . . . 531

Examples . . . . . . . . . . . . . . . 532

Error messages . . . . . . . . . . . . . 532

Start Organizer (STRPCO) . . . . . . 533

Error messages for STRPCO . . . . . . . . 533

Parameters . . . . . . . . . . . . . . 533

Text Assist (PCTA) . . . . . . . . . . . 533

Examples . . . . . . . . . . . . . . . 533

Error messages . . . . . . . . . . . . . 533

Start Performance Explorer (STRPEX) 535

Parameters . . . . . . . . . . . . . . 535

Session ID (SSNID) . . . . . . . . . . . 535

Option (OPTION) . . . . . . . . . . . . 536

Definition (DFN) . . . . . . . . . . . . 536

Filter (FTR) . . . . . . . . . . . . . . 536

Examples . . . . . . . . . . . . . . . 536

Error messages . . . . . . . . . . . . . 537

Error messages for RMVPEXDFN . . . . . . 537

Start Performance Collection

(STRPFRCOL) . . . . . . . . . . . 539

Parameters . . . . . . . . . . . . . . 539

Default collection profile (COLPRF) . . . . . . 539

Cycle collection (CYCCOL) . . . . . . . . . 540

Examples . . . . . . . . . . . . . . . 540

Error messages . . . . . . . . . . . . . 541

Start Performance Trace

(STRPFRTRC) . . . . . . . . . . . 543

Parameters . . . . . . . . . . . . . . 543

Trace table size (SIZE) . . . . . . . . . . 543

Omit trace points (OMTTRCPNT) . . . . . . 544

Job types (JOBTYPE) . . . . . . . . . . . 544

Job trace interval (JOBTRCITV) . . . . . . . 545

Examples . . . . . . . . . . . . . . . 545

Error messages . . . . . . . . . . . . . 545

Start Program Export List

(STRPGMEXP) . . . . . . . . . . . 547

Parameters . . . . . . . . . . . . . . 547

Program level (PGMLVL) . . . . . . . . . 547

Signature level check (LVLCHK) . . . . . . . 547

Signature (SIGNATURE) . . . . . . . . . . 547

Examples . . . . . . . . . . . . . . . 548

Error messages . . . . . . . . . . . . . 548

Start Programmer Menu

(STRPGMMNU) . . . . . . . . . . . 549

Parameters . . . . . . . . . . . . . . 549

Source file (SRCFILE) . . . . . . . . . . . 549

Source library (SRCLIB) . . . . . . . . . . 550

Object library (OBJLIB) . . . . . . . . . . 550


Allow changes (ALWUSRCHG) . . . . . . . 550

Option 3 exit program (EXITPGM) . . . . . . 551

Delete option (DLTOPT) . . . . . . . . . . 551

Examples . . . . . . . . . . . . . . . 552

Error messages . . . . . . . . . . . . . 554

Start Program Profiling (STRPGMPRF) 555

Parameters . . . . . . . . . . . . . . 555

Examples . . . . . . . . . . . . . . . 555

Error messages . . . . . . . . . . . . . 555

Start Prestart Jobs (STRPJ) . . . . . 557

Parameters . . . . . . . . . . . . . . 557

Subsystem (SBS) . . . . . . . . . . . . 557

Program (PGM) . . . . . . . . . . . . 558

Examples . . . . . . . . . . . . . . . 558

Error messages . . . . . . . . . . . . . 558

Start Printer Emulation (STRPRTEML) 561

Parameters . . . . . . . . . . . . . . 561

Emulation controller (EMLCTL) . . . . . . . 562

Emulation device (EMLDEV) . . . . . . . . 562

Emulation location (EMLLOC) . . . . . . . 563

Print device (PRTDEV) . . . . . . . . . . 563

Job name (JOB) . . . . . . . . . . . . . 563

End Bracket eject (ENDBKTEJT) . . . . . . . 563

Printer file (PRTFILE) . . . . . . . . . . 564

Timeout wait eject (TIMOUTEJT) . . . . . . . 564

Defer printing spool output (DFRPRTOUT) . . . 564

Spool output (SPOOL) . . . . . . . . . . 565

Open printer file (OPNPRTF) . . . . . . . . 565

Print positions per line (NUMCOL) . . . . . . 565

Lines per page (NUMLIN) . . . . . . . . . 566

Lines per inch (LPI) . . . . . . . . . . . 566


Language character set (CHRSET) . . . . . . 567

Submit job (SBMJOB) . . . . . . . . . . . 567


Outgoing translation table (TRNTBLOUT) . . . . 568

Job queue (JOBQ) . . . . . . . . . . . . 568

xii System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

End emulation conditions (ENDCOND) . . . . 569

Acknowledge form feed (FORMFEED) . . . . . 569

Configuration entry (EMLCFGE) . . . . . . . 569

Examples . . . . . . . . . . . . . . . 570

Error messages . . . . . . . . . . . . . 570

Start Printer Writer (STRPRTWTR) 573

Parameters . . . . . . . . . . . . . . 573

Printer (DEV) . . . . . . . . . . . . . 574


Queue for writer messages (MSGQ) . . . . . . 575

Form type options (FORMTYPE) . . . . . . . 575

File separators (FILESEP) . . . . . . . . . 576

Drawer for separators (SEPDRAWER) . . . . . 576

Writer (WTR) . . . . . . . . . . . . . 577

Auto-end options (AUTOEND) . . . . . . . 577

Allow direct print (ALWDRTPRT) . . . . . . 577

Align page (ALIGN) . . . . . . . . . . . 578

Initialize printer (INIT) . . . . . . . . . . 578

Spooled file (FILE) . . . . . . . . . . . 578

Job name (JOB) . . . . . . . . . . . . . 578

Spooled file number (SPLNBR) . . . . . . . 579

Job system name (JOBSYSNAME) . . . . . . 579

Spooled file created (CRTDATE) . . . . . . . 580

Starting page (PAGE) . . . . . . . . . . . 580

Examples . . . . . . . . . . . . . . . 580

Error messages . . . . . . . . . . . . . 581

Start Query Management Proc

(STRQMPRC) . . . . . . . . . . . 583

Parameters . . . . . . . . . . . . . . 583

Source member (SRCMBR) . . . . . . . . . 583


Relational database (RDB) . . . . . . . . . 584

Connection Method (RDBCNNMTH) . . . . . 584

User (USER) . . . . . . . . . . . . . . 584

Password (PASSWORD) . . . . . . . . . . 585

Naming convention (NAMING) . . . . . . . 585

Allow information from QRYDFN (ALWQRYDFN) 585

Command source file (CMDSRCFILE) . . . . . 585

Source member (CMDSRCMBR) . . . . . . . 586

Display screens (ALWDSPLAY) . . . . . . . 586

Examples . . . . . . . . . . . . . . . 587

Error messages . . . . . . . . . . . . . 587

Start Query Management Query

(STRQMQRY) . . . . . . . . . . . 589

Parameters . . . . . . . . . . . . . . 589

Query management query (QMQRY) . . . . . 590

Output (OUTPUT) . . . . . . . . . . . . 590

Query management report form (QMFORM) . . . 591



Date and time (DATETIME) . . . . . . . . 592

Page numbers (PAGNBR) . . . . . . . . . 592

Relational database (RDB) . . . . . . . . . 592

Connection Method (RDBCNNMTH) . . . . . 593

User (USER) . . . . . . . . . . . . . . 593

Password (PASSWORD) . . . . . . . . . . 593

Naming convention (NAMING) . . . . . . . 593

Allow information from QRYDFN (ALWQRYDFN) 594

Set variables (SETVAR) . . . . . . . . . . 594

Examples . . . . . . . . . . . . . . . 594

Error messages . . . . . . . . . . . . . 595

Start Query (STRQRY) . . . . . . . 597

Parameters . . . . . . . . . . . . . . 597

Examples . . . . . . . . . . . . . . . 597

Error messages . . . . . . . . . . . . . 597

Start QSH (STRQSH) . . . . . . . . 599

Error messages for STRQSH . . . . . . . . 600

Parameters . . . . . . . . . . . . . . 600

Command (CMD) . . . . . . . . . . . . 600

Examples . . . . . . . . . . . . . . . 601

Error messages . . . . . . . . . . . . . 601

Start Question and Answer (STRQST) 603

Parameters . . . . . . . . . . . . . . 603

Q/A database (QSTDB) . . . . . . . . . . 603

Lib containing Q/A database (LIB) . . . . . . 603

Examples . . . . . . . . . . . . . . . 604

Error messages . . . . . . . . . . . . . 604

Start REXX Procedure (STRREXPRC) 605

Parameters . . . . . . . . . . . . . . 605

Source member (SRCMBR) . . . . . . . . . 605


Parameters (PARM) . . . . . . . . . . . 606

Command environment (CMDENV) . . . . . . 606

Exit program (EXITPGM) . . . . . . . . . 607

Examples . . . . . . . . . . . . . . . 608

Error messages . . . . . . . . . . . . . 608

Start Remote Support (STRRMTSPT) 611

Parameters . . . . . . . . . . . . . . 611

Device class (DEVCLS) . . . . . . . . . . 612

Display type (DSPTYPE) . . . . . . . . . 612

Display model (DSPMODEL) . . . . . . . . 613

Address (STNADR) . . . . . . . . . . . 613

User profile (USRPRF) . . . . . . . . . . 613

Resource name (RSRCNAME) . . . . . . . . 614




Maximum length of request unit (MAXLENRU) 615


Inbound data compression (INDTACPR) . . . . 616

Outbound data compression (OUTDTACPR) . . . 616

Modem (MODEM) . . . . . . . . . . . 617

Modem remote system (MDMRMTSYS) . . . . 618

Examples . . . . . . . . . . . . . . . 618

Error messages . . . . . . . . . . . . . 619

Start Remote Writer (STRRMTWTR) 621

Parameters . . . . . . . . . . . . . . 621


Queue for writer messages (MSGQ) . . . . . . 622

Form type options (FORMTYPE) . . . . . . . 623

Contents xiii

Writer (WTR) . . . . . . . . . . . . . 623

Auto-end options (AUTOEND) . . . . . . . 624

Examples . . . . . . . . . . . . . . . 624

Error messages . . . . . . . . . . . . . 624

Start S/36 Session (STRS36) . . . . . 625

Parameters . . . . . . . . . . . . . . 625

Menu (MENU) . . . . . . . . . . . . . 625

Current library (CURLIB) . . . . . . . . . 625

Procedure or program (PRC) . . . . . . . . 626

Force menu (FRCMNU) . . . . . . . . . . 626

Examples . . . . . . . . . . . . . . . 626

Error messages . . . . . . . . . . . . . 626

Appendix. Notices . . . . . . . . . 629

Programming interface information . . . . . . 630

Trademarks . . . . . . . . . . . . . . 631

Terms and conditions . . . . . . . . . . . 632

Code license and disclaimer information . . . . 632

xiv System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

Save S/36 File (SAVS36F)

Where allowed to run: All environments (*ALL)Threadsafe: No

ParametersExamples

Error messages

The Save System/36 File (SAVS36F) command can create:

v a copy of a single database physical file or logical file to diskette, tape magnetic media or another

database physical file in the same format as if a System/36 has saved the file.

v a copy of multiple database physical files or logical files to diskette or tape magnetic media in the

same format as if a System/36 had saved the files as a save all set. The files can be all files in a library,

all files that are not part of a file group, all files in a specific file group, or all files that begin with a

specified set of characters.

A Save All Set is a group (set) of files that share the same group (set) name and that are saved (copied)

to diskette or tape with one operation. The set of files can be restored (copied back from diskette or tape)

with a single operation by referring to the set name (see the Restore System/36 Files (RSTS36F)

command).

File groups are defined by file names that contain a period. The characters preceding the period identify

the file group, and the characters following the period identify the file within the group. As with file

names within the System/36 environment, the maximum number of characters is eight, including the

period. Files with names that do not contain a period are not part of a file group. The following examples

show the names of files within a file group.

PAYROL.A

PAYROL.B Files in File Group PAYROL

PAYROL.C

A.ACCTS

A.INV

A.PROL Files in File Group A

A.B.GO

A.B.INV

A.B.GO

A.B.INV Files in File Group A.B

The saved files can be restored to the following systems:

v System/36 (RESTORE procedure or $COPY utility)

v i5/OS (Restore System/36 File (RSTS36F) command)

The SAVS36F command is intended for exchanging files with a System/36. For creating a backup version

of a file, the i5/OS save commands (for example, Save Object (SAVOBJ) or Save Changed Object

(SAVCHGOBJ)) should be used.

Restrictions:

1. The following authorities are required (normally only applies when running on a system using

resource security):

v *USE authority for this command.

v *USE authority for the file or group of files specified in the FROMFILE parameter.

v *USE authority for the library specified in the FROMLIB parameter.

© Copyright IBM Corp. 1998, 2008 1

v *CHANGE authority to the file specified on the PHYFILE parameter if saving to an existing

physical file.

v *USE authority for the library specified in the PHYFILE parameter if saving to a physical file.

v *CHANGE authority for the library specified in the PHYFILE parameter if saving to a physical file

and the file does not exist.

v *USE authority for the diskette device description object, *USE authority for device file QSYSDKT,

in library QSYS if saving to diskette.

v *USE authority for the tape device description object, *USE authority for device file QSYSTAP, in

library QSYS if saving to tape.

v *USE authority for the based-on physical file if saving a logical file.2. All diskettes that are used for the save operation should be initialized using the INZDKT CL

command or the equivalent System/36 environment function (INIT operator control language (OCL)

procedure or $INIT SSP utility). For a two-sided diskette, use a sector size of 256 or 1024. For a

one-sided diskette, use a sector size of 128 or 512. If tape is used, each tape volume used should have

been initialized with standard labels using the INZTAP CL command or the equivalent System/36

environment function (TAPEINIT OCL procedure or $TINIT SSP utility). Use a density of 1600 bits

per inch when initializing the tape.

Note: If the tape or diskette has not been initialized as stated above, the System/36 will not be able to

process the media.

3. Object-level and record-level functions, other than read operations, should not be attempted for a file

being saved by SAVS36F. Concurrent activity against the file (for example, moving the file or adding

or removing records) can cause:

v For a save operation of a single file (FROMFILE(file-name)), the save operation will end with

escape message CPF9826 because the file cannot be allocated.

v For a save operation of multiple files (FROMFILE(*ALL or generic*-file-name)), the save function

sends an inquiry message CPA2C6A because the file cannot be allocated. The message allows an

ignore, retry and cancel response. The ignore response bypasses this file and attempts to save the

next file selected.4. When saving a single file to diskette, the diskette cannot already contain an active file with the same

label and creation date as the new file to be created.

5. When saving multiple files to diskette, the diskette used for the save cannot contain any active files.

6. Not all physical and logical files can be saved with the SAVS36F command.

v Only logical files created under the System/36 environment (for example, through the BLDINDEX

OCL procedure) or through a DDM request from a System/36 system can be saved. These files are

saved as System/36 alternative index files.

v All physical files created under the System/36 environment (for example, through the BLDFILE

OCL procedure) or through a DDM request from a System/36 system are saved using information

stored within the i5/OS file description. These files are saved as System/36 sequential, direct, or

indexed physical files.

v Any physical files created by i5/OS commands or utilities can be saved as long as the record length

is not greater than 4096. These files are saved as System/36 sequential files.7. To generate a save format which can be processed by the System/36 RESTORE procedure, the

following information is not saved:

v If saving a logical file, only the description of the file is saved. The index (or access path) is not

saved.

v If saving an indexed (keyed) physical file, the data is saved but the index is not. The index will be

rebuilt after the file is restored.8. The following restrictions apply to naming standards:

v When saving a single file, the specified name (FROMFILE parameter) must meet naming standards.

If not, message CPF0001 is sent when the SAVS36F command is processed.

2 System i: Programming i5/OS commands Starting with SAVS36F (Save S/36 File)

v If a file name is found during a save operation of multiple files (FROMFILE(*ALL or

generic*-file-name)) that does not meet the System/36 naming standards, diagnostic message

CPF2C0E is sent and the file is not saved.9. Multiple files (FROMFILE(*ALL) or FROMFILE(generic*-name)) cannot be saved to a physical file.

Top

Parameters

Keyword Description Choices Notes

FROMFILE From file Generic name, name, *ALL Required,

Positional 1

FROMLIB From library Name Required,

Positional 2

DEV Device Single values: *PHYFILEOther values (up to 4 repetitions): Name

Required,

Positional 3

GROUP File group qualifier Character value, *ALL, *NONE Optional

SET Set identifier Character value, #SAVE Optional

TOLABEL File label Character value Optional

SEQNBR Sequence number 1-9999, *END Optional

VOL Volume identifier Values (up to 50 repetitions): Character value, *MOUNTED Optional

RETAIN Retention period 0-999, 1 Optional

ENDOPT End of tape option *REWIND, *LEAVE, *UNLOAD Optional

DTACPR Data compression *YES, *NO Optional

PHYFILE Physical file Qualified object name Optional

Qualifier 1: Physical file Name

Qualifier 2: Library Name, *LIBL, *CURLIB

MBROPT Data base member option *NOREPLACE, *REPLACE Optional

CRTDATE Creation date Date, *LAST, *ALL Optional

Top

From file (FROMFILE)

Specifies the name of the file being saved. The file specified must exist in the library specified in the

From library prompt (FROMLIB parameter).

This is a required parameter.

file-name

Specify the name of a single file to save.

*ALL All files in the specified library are saved. To further describe which files are saved, use the File

group qualifier prompt (GROUP parameter).

generic*-file-name

Specify a generic name of a group of files in the specified library to save. All files with the same

prefix as the generic name are saved. A generic name is specified as a character string of one or

more characters, followed by an asterisk.

Top

Save S/36 File (SAVS36F) 3

From library (FROMLIB)

Specifies which library contains the database files to be saved.


Top

Device (DEV)

Specifies the name of a diskette unit or the names of one or more tape devices. A maximum of four tape

device names can be specified. If more than one tape device is used, enter the names of the devices in the

order in which they are used. Each device name must be already known on the system by a device

description.


*PHYFILE

A database physical file receives the copied file. The qualified name of the physical file must be

specified on the Physical file prompt (PHYFILE parameter). *PHYFILE is not valid if *ALL or a

generic*-file-name is specified for the From file prompt (FROMFILE parameter).

device-name

Specifies the name of the diskette unit or the names of one or more tape devices used for the

save operation.

Top

File group qualifier (GROUP)

Specifies which file groups are to be saved. This parameter is valid only if *ALL is specified for the From

file prompt (FROMFILE parameter).

*ALL All files are saved.

*NONE

No files that belong to a file group are saved. Only files that do not belong to file group are

saved.

group-name

Specify the name of a file group. All files that belong to that file group are saved. Files that do

not belong to the specified file group are not saved. A group name can be up to 7 characters in

length. The first character in the name must be an alphabetic character (A through Z, #, @, or $).

The remaining characters can be any combination of characters (numeric, alphabetic, and special)

except commas (,), apostrophes (’), quotation marks (″), question mark (?), asterisk (*), or blanks.

The period, which indicates a file group name, must not be included as part of the group name.

Top

Set identifier (SET)

Specifies the set identifier used to identify the entire set of files to be saved. This parameter is valid only

if *ALL or a generic name is specified for the From file prompt (FROMFILE parameter).

#SAVE

The default set identifier is used.


set-identifier

Specify the set identifier used to identify the entire set of files to be saved. The set identifier can

be up to 8 characters in length. The first character in the name must be an alphabetic character (A

through Z, #, @, or $). The remaining characters can be any combination of characters (numeric,

alphabetic, and special) except commas (,), apostrophes (’), quotation marks (″), question mark (?),

asterisk (*), or blanks.

Top

File label (TOLABEL)

Specifies the label value (eight characters maximum) given to the new diskette or tape file created by the

save operation of a single file. If no value is specified, the value of the From file prompt (FROMFILE

parameter) is used as the diskette or tape label.

This parameter is not allowed if *ALL or a generic name is specified for From file prompt (FROMFILE

parameter).

Top

Sequence number (SEQNBR)

Specifies, only when tape is used, which sequence number is used for the save operation.

*END The specified file or files are saved starting after the last sequence number on the first tape (that

is, this file follows all other files currently on the tape volume). If the first tape is full, an error

message is issued and the operation ends. If the sequence number to be assigned to the specified

file is greater than 9999, an error message is issued and the operation ends.

If multiple files are saved, the next file is saved to a file after the first file that was saved, and so

on. If the sequence number to be assigned ever exceeds 9999, an error message is issued and the

operation ends.

file-sequence-number

Specify the sequence number of the tape file that is used for the save operation. Valid values

range from 1 through 9999.

If this sequence number already exists on the tape volume, the tape label at that sequence

number must match the TOLABEL parameter. The existing file at that sequence number is

overwritten, and all subsequent files on the volume are not accessible after the save.

If a new tape file is added to the tape, the sequence number must be one higher than the

sequence number of the last tape file on that volume. No gaps are allowed in the series of

sequence numbers.

If multiple files are being saved, this sequence number is used for the first file. All remaining files

are saved as if *END was specified on the parameter SEQNBR. If the sequence number to be

assigned ever exceeds 9999, an error message is issued and the operation ends.

Top

Volume identifier (VOL)

Specifies the volume identifiers of the tape volumes on which the object data is to be saved. The volumes

must be placed in the device in the same order as the volume identifiers are specified for this parameter.

*MOUNTED

The volume currently placed in the device is used.


volume-identifier

Specify the volume identifiers of the tapes or diskettes used for the save operation. A maximum

of 50 volume identifiers can be specified.

Top

Retention period (RETAIN)

Specifies the retention period for the newly created tape or diskette file. The file is protected and cannot

be written over until the day after the retention period ends.

1 A retention period of one day is used.

retention-period

Specify the number of days the tape or diskette file should be kept. If a retention period of 999 is

specified, the tape or diskette file becomes a permanent file.

Top

End of tape option (ENDOPT)

Specifies, only when tape is used, what operation is automatically performed on the tape volume after

the save operation ends. This parameter applies only to the last reel used.

*REWIND

The tape is rewound, but not unloaded.

*LEAVE

The tape is not rewound.

*UNLOAD

The tape is automatically rewound and unloaded after the operation ends.

Top

Data compression (DTACPR)

Specifies, when a diskette is used, whether the data is compressed into System/36 compatible format

before it is written to the diskette. If the save command is operating while other jobs on the system are

active and data compression is used, the overall system performance may be affected. This parameter is

not valid if *PHYFILE or a tape device is specified on the Device prompt (DEV parameter).

The possible values are:

*NO The data is not compressed before being written to the diskette.

*YES The data is compressed before being written to the diskette.

Top

Physical file (PHYFILE)

Specifies the name of the file that receives the copied file. If the specified file does not exist, it is created

in the current library as a non-keyed, program-described file with a record length of 256. The copied

records are put in the first member of the physical file. If the file has no members, a member is created

using the system date.


The possible library values are:

*LIBL The library list is used to locate the file.

*CURLIB

The current library for the job is used to locate the file. If no library is specified as the current

library for the job, QGPL is used.

library-name

Specify the library where the file is located.

Top

Data base member option (MBROPT)

Specifies whether the new records replace or are added to the existing records.

*NOREPLACE

Specifies whether a file already exists by the name specified on the PHYFILE parameter in the

specified library, an error message is sent and the data in that member is not replaced.

*REPLACE

The PHYFILE member is cleared before copying the first record.

Top

Creation date (CRTDATE)

Specifies, for a date-differentiated file (maintained by the System/36 environment), which instance

(member) of the file or files is saved. A date-differentiated file has the same name as another file but it

has a different file creation date. On this system, date-differentiated files are multiple-member physical

files.

*LAST

The most recently created member for the specified file or files are saved.

*ALL All members in the date-differentiated file are saved. If the file being saved is not date

differentiated, only the last member created in the file is saved. *ALL is valid only when *ALL or

a generic file name is specified for From file prompt (FROMFILE parameter).

file-creation-date

Specify the creation date of the date-differentiated file member to save. A file creation date is

valid only when a single file is saved, or a file name is specified on the From file prompt

(FROMFILE parameter).

Top

Examples

Example 1: Saving a Single File

SAVS36F FROMFILE(PETE) FROMLIB(QS36F) DEV(I1)

This command saves the file named PETE located in library QS36F. Assuming that I1 is the name of a

diskette device description, the file is saved on the diskette placed in the diskette drive. The diskette file

label is PETE (same as the FROMFILE name). If PETE is a date-differentiated physical file, the most


recently created instance (member) of PETE is saved. The diskette file has a retention period of one day

(the retention period ends at midnight of the following day).

Example 2: Saving a Single File

SAVS36F FROMFILE(MSTRPAY) FROMLIB(PAYLIB) DEV(T1 T2)

TOLABEL(’PAY.MSTR’) RETAIN(999)

This command saves the file named MSTRPAY located in library PAYLIB. Assuming that T1 and T2 are

tape devices, the file is copied to the tapes on devices T1 and T2. The tape file label is PAY.MSTR and the

tape file is a permanent file. The last tape used for the save is rewound at the end of the save operation.

Example 3: Saving Multiple Files

SAVS36F FROMFILE(*ALL) FROMLIB(QS36F) DEV(T1 T2)

GROUP(*ALL) SET(ALLFL) RETAIN(999)

This command saves all database physical and logical files in library QS36F (including all files that

belong to a file group). If any of the files are date-differentiated files, only the last member created in

each file is saved. Assuming that T1 and T2 are tape devices, the files are copied to the tape volumes that

are placed in tape drives T1 and T2. The label of the tape files created are the same as the names of the

files that are saved. The first tape file created is located after the last sequence number on the tape. The

remaining files are located after that first file. The tape files created are permanent. The last tape used for

the save is rewound at the end of the save operation. The set identifier associated with this save all set is

ALLFL.


SAVS36F FROMFILE(*ALL) FROMLIB(QS36F) DEV(T1 T2)

GROUP(*NONE) CRTDATE(*LAST) SET(NOGFL) RETAIN(999)

This command saves all database physical and logical files in library QS36F except those files that belong

to a file group. If any of the files are date-differentiated files, only the last member created in each file is

saved. Assuming that T1 and T2 are tape devices, the files are copied to the tape volumes that are placed

in tape drives T1 and T2. The label of the tape files created is the same as the names of the files that are

saved. The first tape file created is located after the last sequence number on the tape. The remaining files

are located after that first file. The tape files created are permanent. The last tape used for the save is

rewound at the end of the save operation. The set identifier associated with this save all set is NOGFL.


SAVS36F FROMFILE(*ALL) FROMLIB(GRPLIB) DEV(I1)

GROUP(GRP) CRTDATE(*ALL)

This command saves all database physical and logical files in library GRPLIB that belong to file group

GRP (GRP.01, GRP.02, and so on). If any of the files are date-differentiated files, all members in the files

are saved. Assuming that I1 is a diskette drive, the files are copied to the diskette that is placed in the

diskette drive. The label of the diskette files created is the same as the names of the files that are saved.

The diskette files expire after one day. The set identifier associated with this save all set is #SAVE.



SAVS36F FROMFILE(PAY*) FROMLIB(PAYROLL) DEV(I1)

SET(PAYSET) CRTDATE(*LAST)

VOL(PAYDKT) RETAIN(10)

This command saves all database physical and logical files in library PAYROLL whose names begin with

the characters PAY (PAY.01, PAYRATE, and so on). If any of the files are date-differentiated files, only the

last member created is saved. Assuming that I1 is a diskette drive, the files are copied to a diskette with a

volume identifier of PAYDKT. The label of the diskette files created is the same as the names of the files

that are saved. The diskette files expire after ten days. The set identifier associated with this save all set is

PAYSET.

Top

Error messages

*ESCAPE Messages

CPF2C4A

Device &1 not correct for command.

CPF2C4B

Duplicate device &1 specified in device name list.

CPF2C4C

Diskette device &1 included in multiple device specification.

CPF2C4F

Diskette format not correct for DTACPR(*YES).

CPF2C47

Existing file &1 or member &3 in library &2 not replaced.

CPF2C48

Input file &1 in &2 not correct for command.

CPF2C49

Output file &1 in &2 not correct for command.

CPF2C5B

Not all files were saved.

CPF2C5C

Save operation ended before all files were saved.

CPF2C5D

No files saved from library &1.

CPF2C5E


CPF2C5F

Tape file sequence numbers beyond 9999 not allowed.

CPF2C50

File description for file &1 is not available.

CPF2C51

Member information for file &1 in library &2 is not available.

CPF2C52

Error occurred during attempt to create file &1 in library &2.


CPF2C54

FROMFILE name &1 too long to use for TOLABEL parameter.

CPF2C55

TOLABEL parameter value &1 contains embedded blank(s).

CPF2C56

Physical file name &1 too long.

CPF2C58

Diskette format not acceptable for System/36.

CPF2C59

FROMFILE name &1 too long.

CPF9810

Library &1 not found.

CPF9812

File &1 in library &2 not found.

CPF9814

Device &1 not found.

CPF9820

Not authorized to use library &1.

CPF9822

Not authorized to file &1 in library &2.

CPF9825

Not authorized to device &1.

CPF9826

Cannot allocate file &2.

CPF9830

Cannot assign library &1.

CPF9831

Cannot assign device &1.

CPF9845

Error occurred while opening file &1.

CPF9847

Error occurred while closing file &1 in library &2.

CPF9848

Cannot open file &1 in library &2 member &3.

CPF9849

Error while processing file &1 in library &2 member &3.

*STATUS Messages

CPI2C13

Copying records from file &1 in library &2 member &3.

Top


Save S/36 Library Members (SAVS36LIBM)


ParametersExamples

Error messages

The Save Library Members in System/36 Save/Restore Format (SAVS36LIBM) command creates a copy of

source file members in a file on diskette or tape that can be restored on a System/36, or into a database

physical file on this system that can be sent to a System/36. The saved member file is formatted like a

record-mode LIBRFILE created on a System/36 using the System/36 FROMLIBR system operator control

language (OCL) procedure (or the equivalent OCL use of the $MAINT SSP utility). On a System/36, the

diskette or tape or disk file can be restored using the TOLIBR system OCL procedure (or the equivalent

OCL use of the $MAINT SSP utility).

If a database physical file is specified using the Physical file prompt (PHYFILE parameter) but does not

exist, it is created.

This command is intended only for exchanging source and procedure data with a System/36. It provides

a simplified command interface for an i5/OS customer who migrated from a System/36, but is not

well-suited for backing up of i5/OS source files. Use the CL commands (SAVOBJ or SAVCHGOBJ) for

creating a backup copy of an i5/OS source file or individual source file members.

Restrictions:

1. The following authorities are required when running on a system using resource security:

v *USE authority for this command

v *USE authority for the library specified in the FROMLIB parameter

v *USE authority for file QS36SRC in the specified library if saving source library members

v *USE authority for file QS36PRC in the specified library if saving procedure library members

v *USE authority for the library specified in the PHYFILE parameter if saving to a physical file

v *CHANGE authority for the library specified in the PHYFILE parameter if saving to a physical file

and the file does not exist

v *CHANGE and *OBJMGMT authority for that file if saving to a physical file with MBROPT(*ADD)

v *ALL authority for the file if saving to a physical file with MBROPT(*REPLACE)

v *USE authority for the diskette device description object, *USE authority for device file QSYSDKT

in library QSYS if saving to diskette

v *USE authority for the tape device description object and *USE authority for device file QSYSTAP

in library QSYS if saving to tape2. All diskettes that are used to save the members should be initialized using the INZDKT CL command

or the equivalent System/36 environment function (INIT OCL procedure or $INIT SSP utility). For a

two-sided diskette, use a sector size of 256 or 1024. For a one-sided diskette, use a sector size of 128

or 512. If tape is used, each tape volume used should first be initialized with standard labels using the

INZTAP CL command or the equivalent System/36 environment function (TAPEINIT OCL procedure

or $TINIT SSP utility). Use a density of 1600 bits per inch when initializing the tape.

Note: If the tape or diskette has not been initialized as stated above, the System/36 will not be able to

process the media.

If a tape or diskette is used that has not been properly initialized, a message is sent to the system

operator that allows the operator to cancel the save or initialize the volume and continue.


3. Object-level functions, other than read operations, should not be used for files QS36SRC and

QS36PRC while members are being saved by SAVS36LIBM. If the necessary files cannot be allocated,

no members are saved.

Record-level functions, other than read operations, should not be used for members being saved.

Concurrent activity against a member (for example, adding or removing records) can cause the

member to be omitted from the save operation.

4. If saving a file to diskette, the diskettes used cannot contain an active file with the same name as the

TOLABEL parameter value, because the AS/400 system does not allow duplicate diskette file labels.

5. Only members from source files QS36SRC (for *SRC members) and QS36PRC (for *PRC members) in

the specified library can be saved using the SAVS36LIBM command. Only the member data is saved

from the source file member (that is, the source sequence number and change date fields are not

saved).

6. The specified member name or generic member name (FROMMBR parameter) must meet i5/OS

naming standards. When saving a member that has an extended name, the quotation mark characters

are not stored as part of the member name in the output file. For example, member ″A+B″ would be

saved as A+B.

Top

Parameters


FROMMBR From member Generic name, name, *ALL Required,

Positional 1

FROMLIB From library Name Required,

Positional 2

DEV Device Single values: *PHYFILEOther values (up to 4 repetitions): Name

Required,

Positional 3

SRCMBRS S/36 source members *ALL, *SRC, *PRC Optional

TOLABEL File label Character value Optional


VOL Volume identifier Values (up to 50 repetitions): Character value, *MOUNTED Optional

RETAIN Retention period 0-999, 1 Optional

EXCHTYPE Diskette file exchange type *E, *BASIC Optional

ENDOPT End of tape option *REWIND, *LEAVE, *UNLOAD Optional

PHYFILE Physical file Qualified object name Optional


Qualifier 2: Library Name, *CURLIB, *LIBL

MBROPT Data base member option *REPLACE, *ADD Optional

RCDLEN Record length 40-120, 120 Optional

Top

From member (FROMMBR)

Specifies the names of the members being saved.


*ALL All members of the member type specified on the S/36 source members prompt (SRCMBRS

parameter) are saved.


member-name

Specify the member name of the members to be saved.

generic*-member-name

Specify the generic member name of the members to be saved. A generic name is a character

string that contains one or more characters followed by an asterisk (*).

Top

From library (FROMLIB)

Specifies which library contains the members being saved.


Top

Device (DEV)

Specifies the names of the devices used for the save operation. A maximum of four devices may be

specified.


*PHYFILE

The output file is the database physical file specified by the Physical file prompt (PHYFILE

parameter).

device-name

Specify the name of the diskette unit or the names of one or more tape devices that are used for

the save operation. If more than one tape device is used, type the names of the devices in the

order in which they are used. A maximum of four tape device names can be specified.

Top

S/36 source members (SRCMBRS)

Specifies which source member types (source and procedure members on System/36) are saved.

*ALL System/36 source and procedure members (from QS36SRC and QS36PRC) that match the

member name specified on the From member prompt (FROMMBR parameter) are saved.

*SRC Only System/36 source members (from file QS36SRC) that match the member name specified on

the From member prompt (FROMMBR parameter) are saved.

*PRC Only System/36 OCL procedure members (from file QS36PRC) that match the member name

specified on the From member prompt (FROMMBR parameter) are saved.

Top

File label (TOLABEL)

Specifies the label value (eight characters maximum) of the output diskette or tape file. If *PHYFILE is

not specified on the Device prompt (DEV parameter), a value must be specified here.

Top

Save S/36 Library Members (SAVS36LIBM) 13


Specifies, only when tape is used, which sequence number is used for the save operation.

*END The specified members are saved starting after the last sequence number on the first tape (this

file is put after all other files currently on the tape volume). If the first tape is full, an error

message is issued and the operation ends. If the sequence number to be assigned to the specified

file is greater than 9999, an error message is issued and the operation ends.

file-sequence-number

Specify the sequence number of the tape file that is used when saving the specified members.

Valid values range from 1 through 9999.

If this sequence number already exists on the tape volume, the tape label at that sequence

number must match the TOLABEL parameter value. The existing data file at that sequence

number is overwritten, and all subsequent files on the volume are not accessible after the save

operation.

If a new tape file is added to the tape, the sequence number must be one greater than the

sequence number of the last tape file on that volume. No gaps are allowed in the series of

sequence numbers.

Top


Specifies the volume identifiers of the tape volumes on which the object data is to be saved. The volumes

must be placed in the device in the same order as the volume identifiers are specified for this parameter.

*MOUNTED

The volume currently placed in the device is used.

volume-identifier

Specify the volume identifiers of the tapes or diskettes used for saving the members. A maximum

of 50 volume identifiers can be specified.

Top

Retention period (RETAIN)

Specifies the retention period for the newly created tape or diskette file. The file is protected and cannot

be written over until the day after the retention period ends.

1 A retention period of one day is used.

retention-period

Specify the number of days the tape or diskette file should be kept. If a retention period of 999 is

specified, the tape or diskette file becomes a permanent file.

Top

Diskette file exchange type (EXCHTYPE)

Specifies the exchange type for the newly created diskette file.

*E The default is to create an E-exchange diskette file. An E-exchange file is a system save file that

can be restored on a System/36 using the TOLIBR procedure. It can also be restored to the

AS/400 system using the Restore System/36 Library Members (RSTS36LIBM) command.


*BASIC

The output diskette file is to be in basic exchange format. A basic exchange format file can be

restored or copied to a System/34 or System/32 or any other system that supports the basic

exchange diskette format.

Top

End of tape option (ENDOPT)

Specifies, only when tape is used, what operation is automatically performed on the tape volume after

the save operation ends. This parameter applies only to the last reel used.

*REWIND

The tape is rewound, but not unloaded.

*LEAVE

The tape is not rewound.

*UNLOAD

The tape is automatically rewound and unloaded after the operation ends.

Top

Physical file (PHYFILE)

Specifies the name of the physical file that receives the copied source file member data.

If a file by this name does not exist, it is created in the current library if a library name was not specified,

as a non-keyed, program-described physical file with the record length specified by the Logical record

length prompt (RCDLEN parameter). If a file already exists by this name, it is used as long as it is a

non-keyed physical file with a record length in the range from 40 through 120. The copied records are put

in the first member of the physical file.


*CURLIB



library-name


Top

Data base member option (MBROPT)

Specifies whether the new records replace or are added to the existing records.

*REPLACE

The member is cleared before copying the first record.

*ADD The system adds the new records to the end of the existing records.

Top


Record length (RCDLEN)

Specifies the file record length (in bytes) used when copying the members.

120 This is the maximum record length allowed for System/36 source and procedure library

members.

record-length

Specify a record length in bytes.

Top

Examples

Example 1: Saving Single Procedure Member

SAVS36LIBM FROMMBR(XYZ1) FROMLIB(JOHNSON)

DEV(I1) SRCMBRS(*PRC) TOLABEL(XYZ1)

This command saves the single OCL procedure member XYZ1 (in source file QS36PRC) in library

JOHNSON. Assuming I1 is a diskette device, the member is saved to diskette file XYZ1. The file length is

120 and the retention period is one day.

Example 2: Saving All Source and Procedure Members

SAVS36LIBM FROMMBR(X*) FROMLIB(ORDER) DEV(*PHYFILE)

PHYFILE(NETLIB/S36SRC) MBROPT(*ADD)

This command saves all source and procedure members (members in QS36SRC and QS36PRC) with

names starting with the character ’X’ in library ORDER. The members are saved into database physical

file S36SRC in library NETLIB. The copied records are added after any records already in the file.

Top

Error messages

*ESCAPE Messages

CPF2C4A

Device &1 not correct for command.

CPF2C4B

Duplicate device &1 specified in device name list.

CPF2C4C

Diskette device &1 included in multiple device specification.

CPF2C43

Saved &2 members from library &1, &3 members not saved.

CPF2C44

No members saved from library &1.

CPF2C48



CPF2C49

Output file &1 in &2 not correct for command.

CPF2C5E


CPF2C5F

Tape file sequence numbers beyond 9999 not allowed.

CPF2C50

File description for file &1 is not available.

CPF2C51

Member information for file &1 in library &2 is not available.

CPF2C52

Error occurred during attempt to create file &1 in library &2.

CPF2C55

TOLABEL parameter value &1 contains embedded blank(s).

CPF2C58

Diskette format not acceptable for System/36.

CPF9807

One or more libraries in library list deleted.

CPF9808

Cannot allocate one or more libraries on library list.

CPF9810


CPF9812


CPF9814


CPF9820


CPF9822


CPF9825


CPF9826

Cannot allocate file &2.

CPF9830


CPF9845


CPF9847


CPF9849


*STATUS Messages


CPI2C13

Copying records from file &1 in library &2 member &3.

Top


Save Save File Data (SAVSAVFDTA)


ParametersExamples

Error messages

The Save Save File Data (SAVSAVFDTA) command saves the contents of a save file to tape or optical

media. This command saves the save data in the save file to the device in a way that allows you to

restore objects directly from the device.

A save file containing data created by the Save Licensed Program (SAVLICPGM) command cannot be

saved by this command.

The information written on media by this command is similar to the data that was previously written to

the save file by the save command that originally created the save file data. This includes the object

descriptions, and object contents that existed when the original save operation was done.

This command uses only the save file and device description objects; it does not refer to or modify the

description or contents of the objects included in the file save data. Thus, objects included in the save file

are not locked during the running of this command, and the save history information (date, place, and

time when each object was last saved) is not updated by this command for each object in the save file.

The description of the save file is not included in the save operation (unless it was included with the

objects that were saved to create the save data in the file). In addition, this command does not update the

save history information for the save file object, so the last save operation date, time, and place always

identify the last save operation of the save file object description, not its contents.

Note: This command ignores all file overrides currently in effect for the job, except for the output file.

Restrictions:

v You must have use (*USE) authority for the save file and *USE authority for the tape or optical device

description.

v If a tape is used, it must have a standard label.

v The save file cannot be in use by a job running at the time the save operation occurs.

Top

Parameters


SAVF Save file Qualified object name Required,

Positional 1 Qualifier 1: Save file Name


DEV Device Values (up to 4 repetitions): Name Required,

Positional 2

VOL Volume identifier Single values: *MOUNTEDOther values (up to 75 repetitions): Character value

Optional,

Positional 3


ENDOPT End of media option *REWIND, *LEAVE, *UNLOAD Optional

OPTFILE Optical file Path name, * Optional



USEOPTBLK Use optimum block *YES, *NO Optional

CLEAR Clear *NONE, *ALL, *AFTER, *REPLACE Optional

EXPDATE File expiration date Date, *PERM Optional

COMPACT Data compaction *DEV, *NO Optional

OUTPUT Output *NONE, *PRINT, *OUTFILE Optional

OUTFILE File to receive output Qualified object name Optional

Qualifier 1: File to receive

output

Name


OUTMBR Output member options Element list Optional

Element 1: Member to

receive output

Name, *FIRST

Element 2: Replace or add

records

*REPLACE, *ADD

Top

Save file (SAVF)

Specifies the save file whose contents are to be saved.

Note: The save file must contain data written by a previous save command or an error message is sent,

and its contents are not saved to media.


Qualifier 1: Save file

name Specify the name of the save file whose contents are to be saved.

Qualifier 2: Library

*LIBL All libraries in the library list for the current thread are searched until the first match is found.

*CURLIB

The current library for the thread is used to locate the save file. If no current library entry exists

in the library list, the QGPL library is used.

name Specify the name of the library where the save file is located.

Top

Device (DEV)

Specifies the name of the device used for the save operation. The device name must already be known on

the system by a device description.


optical-device-name

Specify the name of the optical device used for the save operation.

tape-media-library-device-name

Specify the name of the tape media library device used for the save operation.


tape-device-name

Specify the names of one or more tape devices used for the save operation. If a virtual tape

device is used, it must be the only device specified. If multiple tape devices are used, they must

have compatible media formats and their names must be specified in the order in which they are

used. Using more than one tape device permits one tape volume to be rewound and unloaded

while another tape device processes the next tape volume.

Top


Specifies the volume identifiers of the volumes, or the cartridge identifiers of tapes in a tape media

library device, on which the data is saved. The volumes must be placed in the device in the same order

as specified for this parameter.

Single values

*MOUNTED

The data is saved on the volumes placed in the device. For a media library device, the volume to

be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY)

command.

Note: This value cannot be specified when using an optical media library device.

Other values (up to 75 repetitions)

character-value

Specify the identifiers of one or more volumes in the order in which they are placed in a device

and used to save the data.

Top


Specifies, when tape is used, the sequence number to use as the starting point for the save operation.

*END The save operation begins after the last sequence number on the first tape. If the first tape is full,

an error message is issued and the operation ends.

1-16777215

Specify the sequence number of the file to be used for the save operation.

Top

End of media option (ENDOPT)

Specifies the operation that is automatically done on the tape or optical volume after the save operation

ends. If more than one volume is used, this parameter applies only to the last volume used; all other

volumes are unloaded when the end of the volume is reached.

Note: This parameter is valid only if a tape or optical device name is specified for the DEV parameter.

For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be

ignored.

*REWIND

The tape is automatically rewound, but not unloaded, after the operation has ended.

Save Save File Data (SAVSAVFDTA) 21

*LEAVE

The tape does not rewind or unload after the operation ends. It remains at the current position on

the tape drive.

*UNLOAD

The tape is automatically rewound and unloaded after the operation ends. Some optical devices

will eject the volume after the operation ends.

Top

Optical file (OPTFILE)

Specifies the path name of the optical file that is used for the save operation, beginning with the root

directory of the volume.

For more information on specifying path names, refer to ″Object naming rules″ in the CL topic collection

in the Programming category in the i5/OS Information Center at http://www.ibm.com/systems/i/infocenter/.

* The system generates an optical file name in the root directory of the optical volume.

’optical-directory-path-name/*’

The system generates an optical file name in the specified directory of the optical volume.

Top

Use optimum block (USEOPTBLK)

Specifies whether or not the optimum block size is used for the save operation.

Note: Specifying USEOPTBLK(*YES) may result in a tape that can be duplicated only to a device that

supports the same block size.

*YES The optimum block size supported by the device is used for Save commands. If the block size

that is used is larger than a block size that is supported by all device types, then:

v Performance may improve.

v The tape file that is created is only compatible with a device that supports the block size used.

Commands such as Duplicate Tape (DUPTAP) do not duplicate files unless the files are being

duplicated to a device which supports the same block size that was used.

v The value for the DTACPR parameter is ignored.

*NO The optimum block size supported by the device is not used. Save commands use the default

block size supported by all device types. The tape volume can be duplicated to any media format

using the Duplicate Tape (DUPTAP) command.

Top

Clear (CLEAR)

Specifies whether active data on the media is automatically cleared or replaced. Active data is any file on

the media that has not expired. For saves to tape, clearing active data will make any files on the tape

volume beyond the last file written by the save operation no longer accessible. For saves to optical, the

files written by the save operation can be automatically replaced while other files on the volume remain

active, or all active files can be automatically cleared. Clearing does not erase the data, it just makes the

files no longer accessible.


Notes:

1. Clearing a tape does not initialize it. You should initialize tapes to a standard label format before the

save command is issued by using the Initialize Tape (INZTAP) command and specifying a value for

the NEWVOL parameter.

2. Clearing an optical volume does initialize it.

3. If a volume that is not initialized is encountered during the save operation, an inquiry message is sent

and an operator can initialize the volume.

*NONE

None of the media is automatically cleared. If the save operation encounters active data on a tape

volume or in a save file, an inquiry message is sent, allowing the operator to either end the save

operation or clear the media. If the save operation encounters the specified optical file, an inquiry

message is sent, allowing the operator to either end the save operation or replace the file.

*ALL All of the media is automatically cleared.

If tapes are used and a sequence number is specified for the SEQNBR parameter, the first tape is cleared

beginning at that sequence number. All tapes following that first tape are completely cleared. To clear the

entire first tape, SEQNBR(1) must be specified.

*AFTER

All media after the first volume is automatically cleared. If the save operation encounters active

data on the first tape volume, an inquiry message is sent, allowing the operator to either end the

save operation or clear the media. If the save operation encounters the specified optical file on

the first volume, an inquiry message is sent, allowing the operator to either end the save

operation or replace the file.

*REPLACE

Active data on the media is automatically replaced. Optical volumes are not initialized. Other

media is automatically cleared in the same way as the *ALL value.

Top

File expiration date (EXPDATE)

Specifies the expiration date of the file created by the save operation. If a date is specified, the file is

protected and cannot be overwritten until the specified expiration date.

Notes:

1. This parameter is valid for tape and optical files.

2. Specifying this parameter does not protect against a later save operation specifying CLEAR(*ALL).

*PERM

The file is protected permanently.

date Specify the date when protection for the file ends.

Top

Data compaction (COMPACT)

Specifies whether device data compaction is performed.

*DEV Device data compaction is performed if the data is saved to tape and all tape devices specified

for the Device (DEV) parameter support the compaction feature.

*NO Device data compaction is not performed.


Top

Output (OUTPUT)

Specifies whether a list with information about the saved objects is created. The information can be

printed with the job’s spooled output or directed to a database file.

*NONE

No output listing is created.

*PRINT

The output is printed with the job’s spooled output.

*OUTFILE

The output is directed to the database file specified for the File to receive output (OUTFILE)

parameter.

Note: You must specify a database file name for the File to receive output (OUTFILE) parameter

when OUTPUT(*OUTFILE) is specified.

Top

File to receive output (OUTFILE)

Specifies the database file to which the output of the command is directed. If the file does not exist, this

command creates a database file in the specified library. If the file is created, the public authority for the

file is the same as the create authority specified for the library in which the file is created. Use the

Display Library Description (DSPLIBD) command to show the library’s create authority.

Qualifier 1: File to receive output

name Specify the name of the database file to which the command output is directed.


*LIBL The library list is used to locate the file. If the file is not found, one is created in the current

library. If no current library exists, the file will be created in the QGPL library.

*CURLIB

The current library for the thread is used to locate the file. If no library is specified as the current

library for the thread, the QGPL library is used.

name Specify the name of the library to be searched.

Note: If a new file is created, the system uses the IBM-supplied file QASAVOBJ with format name

QSRSAV as a model.

Top

Output member options (OUTMBR)

Specifies the name of the database file member to which the output is directed when *OUTFILE is

specified for the Output (OUTPUT) parameter.

Element 1: Member to receive output


*FIRST

The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member

does not exist, the system creates a member with the name of the file specified for the File to

receive output (OUTFILE) parameter.

name Specify the name of the file member that receives the output. If OUTMBR(member-name) is

specified and the member does not exist, the system creates it.

If the member exists, you can add records to the end of the existing member or clear the existing

member and add the records.

Element 2: Replace or add records

*REPLACE

The existing records in the specified database file member are replaced by the new records.

*ADD The new records are added to the existing information in the specified database file member.

Top

Examples

SAVSAVFDTA SAVF(ONLINE) DEV(TAP01) SEQNBR(1) CLEAR(*ALL)

This command saves the contents of save file ONLINE to the first file on the tape volume on device

TAP01. Files that have not ended on either the first tape volume or on subsequent volumes are

overwritten without an inquiry message because CLEAR(*ALL) is specified.

Top

Error messages

*ESCAPE Messages

CPF3707

Save file &1 in &2 contains no data.

CPF3709

Tape devices do not support same densities.

CPF3727

Duplicate device &1 specified on device name list.

CPF3728

Device &1 specified with other devices.

CPF3733

&2 &1 in &3 previously damaged.

CPF3767


CPF3768

Device &1 not valid for command.

CPF3782

File &1 in &2 not a save file.

CPF3793

Machine or ASP storage limit reached.


CPF3794

Save or restore operation ended unsuccessfully.

CPF3805

Objects from save file &1 in &2 not restored.

CPF3812

Save file &1 in &2 in use.

CPF3814

No objects from save file &1 in &2 saved to media.

CPF384E

USEOPTBLK(*YES) not valid for CD-ROM premastering.

CPF388B

Optical file path name not valid.

CPF5729

Not able to allocate object &1.

CPF9812


CPF9822


CPF9825


Top


Save Security Data (SAVSECDTA)


ParametersExamples

Error messages

The Save Security Data (SAVSECDTA) command saves all security information without requiring a

system in a restricted state. The SAVSECDTA command saves the same security information that is saved

when a Save System (SAVSYS) command is run including the following:

v User Profiles

v Authorization Lists

v Authority Holders

Information saved with the SAVSYS or SAVSECDTA command can be restored using the Restore User

Profiles (RSTUSRPRF) and Restore Authority (RSTAUT) commands.

Restrictions:

v You must have save system (*SAVSYS) special authority to run this command.

v Changes made to user profiles while the SAVSECDTA command is being run may not be reflected on

the media, depending on when the changes occurred in relation to the save operation.

v Concurrent running of other SAVSECDTA commands is not allowed.

v If *YES is specified for the Object pre-check (PRECHK) parameter and a security object cannot be

saved, the save operation ends.

Top

Parameters


DEV Device Single values: *SAVFOther values (up to 4 repetitions): Name

Required,

Positional 1


Optional





SAVF Save file Qualified object name Optional

Qualifier 1: Save file Name



ASPDEV ASP device Name, *ALLAVL, *, *SYSBAS, *CURASPGRP Optional


PRECHK Object pre-check *NO, *YES Optional

DTACPR Data compression *DEV, *NO, *YES, *LOW, *MEDIUM, *HIGH Optional







output

Name




receive output

Name, *FIRST


records

*REPLACE, *ADD

Top

Device (DEV)




Single values

*SAVF The save operation is done using the save file specified for the Save file (SAVF) parameter.

Other values

optical-device-name




tape-device-name






Top





Single values

*MOUNTED



command.




character-value



Top





1-16777215


Top




Notes:



*PERM



Top







ignored.

*REWIND


*LEAVE


the tape drive.

*UNLOAD



Top

Save Security Data (SAVSECDTA) 29















Top

Save file (SAVF)

Specifies the save file that is used to contain the saved data. The save file must be empty, unless *ALL is

specified for the Clear (CLEAR) parameter.

Note: A value must be specified for this parameter if *SAVF is specified for the Device (DEV) parameter.


name Specify the name of save file to be used.



*CURLIB




Top










Top

ASP device (ASPDEV)

Specifies the auxiliary storage pool (ASP) device from which private authorities are to be saved.

*ALLAVL

The private authorities from the system ASP (ASP number 1), all basic user ASPs (ASP numbers

2-32), and all available independent ASPs are saved.

* The private authorities from the system ASP, all basic user ASPs, and, if the current thread has an

ASP group, all independent ASPs in the ASP group are saved.

*SYSBAS

The private authorities from the system ASP and all basic user ASPs are saved.

*CURASPGRP

If the current thread has an ASP group, the private authorities from all independent ASPs in the

ASP group are saved.

name Specify the ASP device name from which private authorities are to be saved.

Top

Clear (CLEAR)







Notes:







*NONE









*AFTER







Note: The *AFTER value is not valid for save files.

*REPLACE



Top

Object pre-check (PRECHK)

Specifies whether the save operation should end if all objects specified by this command do not satisfy

the following conditions of the save operation: (1) the objects exist, (2) they were not previously found to

be damaged, (3) they are not locked by another job, and (4) the requester of the save operation has

authority to save the objects.

*NO The save operation continues, saving only those objects that can be saved.

*YES If, after all specified objects are checked, one or more objects cannot be saved, the save operation

ends before any data is written.

Top


Specifies whether data compression is used. If the save is running while other jobs on the system are

active and software compression is used, the overall system performance may be affected.

Note: If *DEV is specified for both this parameter and the Data compaction (COMPACT) parameter, only

device data compaction is performed if device data compaction is supported on the device. Otherwise,

data compression is performed.

If *YES is specified for this parameter and *DEV is specified for the COMPACT parameter, both device

data compaction and device data compression are performed if supported on the device.

*DEV If the save is to tape and the target device supports compression, hardware compression is

performed. Otherwise, no data compression is performed.

*NO No data compression is performed.

*YES If the save is to tape and the target device supports compression, hardware compression is

performed. If compression is not supported, or if the save data is written to optical media or to a

save file, software compression is performed. Low software compression is used for all devices

except optical DVD, which uses medium software compression.

*LOW If the save operation is to a save file or optical, software data compression is performed with the

SNA algorithm. Low compression is usually faster and the compressed data is usually larger than

if medium or high compression is used.

Note: This value is not valid for tape.

*MEDIUM

If the save operation is to a save file or optical, software data compression is performed with the


TERSE algorithm. Medium compression is usually slower than low compression but faster than

high compression. The compressed data is usually smaller than if low compression is used and

larger than if high compression is used.


*HIGH


LZ1 algorithm. High compression is usually slower and the compressed data is usually smaller

than if low or medium compression is used.


Top





Note: If *DEV is specified for both the Data compression (DTACPR) parameter and this

parameter, only device data compaction is performed if device data compaction is supported on

the device. Otherwise, data compression is performed if supported on the device.

If *YES is specified for the DTACPR parameter and *DEV is specified for this parameter, both

device data compaction and device data compression are performed if supported on the device.


Top

Output (OUTPUT)



*NONE


*PRINT


*OUTFILE


parameter.



Top












*CURLIB





QSRSAV as a model.

Top





*FIRST









*REPLACE



Top


Examples

Example 1: Automatically Clearing Uncleared Tapes

SAVSECDTA DEV(TAP01) CLEAR(*ALL)

This command saves the security information, including user profiles, authorization lists, authority

holders. They are saved on the TAP01 tape drive. CLEAR(*ALL) automatically clears all uncleared tapes

when they are encountered.

Example 2: Sending Message When Storage Capacity Exceeded

SAVSECDTA DEV(TAP01) VOL(ABC)

This command saves the security information on the TAP01 tape drive, starting on the tape volume

labeled ABC. If the save operation exceeds the storage capacity of one tape, a message requesting that

another volume be put on the TAP01 tape drive is shown to the operator.

Top

Error messages

*ESCAPE Messages

CPF2206

User needs authority to do requested function on object.

CPF222E

&1 special authority is required.

CPF370A

Not all security objects saved to save file &3.

CPF3709


CPF3727


CPF3728


CPF3731

Cannot use &2 &1 in library &3.

CPF3733


CPF3735

Storage limit exceeded for user profile &1.

CPF3737

Save and restore data area &1 not found.

CPF3738

Device &1 used for save or restore is damaged.

CPF3767



CPF3768


CPF3782

File &1 in &2 not a save file.

CPF3793


CPF3794


CPF3812

Save file &1 in &2 in use.

CPF384E


CPF388B


CPF3893

Not all security objects saved.

CPF3894

Cancel reply received for message &1.

CPF38A4

ASP device &1 not correct.

CPF5729

Not able to allocate object &1.

CPF9809

Library &1 cannot be accessed.

CPF9812


CPF9814


CPF9833

*CURASPGRP or *ASPGRPPRI specified and thread has no ASP group.

CPF9845


CPF9846

Error while processing file &1 in library &2.

CPF9847


CPF9850

Override of printer file &1 not allowed.

CPF9851

Overflow value for file &1 in &2 too small.

CPF9860

Error occurred during output file processing.

CPFB8ED

Device description &1 not correct for operation.


Top


Save Storage (SAVSTG)

Where allowed to run: Interactive environments (*INTERACT

*IPGM *IREXX *EXEC)Threadsafe: No

ParametersExamples

Error messages

The Save Storage (SAVSTG) command saves a copy of the licensed internal code and the contents of

auxiliary storage (except unused space and temporary objects) to tape. This function is intended for

disaster recovery backup. Individual libraries or objects cannot be restored from a save storage tape.

This command issues the PWRDWNSYS (Power Down System) command with OPTION(*IMMED) and

RESTART(*YES) specified. While the system is powered down, a dedicated service tool (DST) that saves

all system storage is called. At that time, a standard labeled tape volume must be placed in the tape

device. Additional volumes are requested as needed. Hardware data compression is used if it is

supported by the tape device. After the save system storage function is complete, an initial program load

(IPL) takes place.

During the IPL after a save storage operation, a completion message is sent to the system operator

message queue. The save history information for the data area QSAVSTG in library QSYS is updated with

the date and time when the system storage data was saved. To show the information in this data area,

use the Display Object Description (DSPOBJD) command with DETAIL(*FULL).

The restore storage operation is done using the appropriate option on the DST menu. During the IPL,

after a restore storage operation, a completion message is sent to the system operator message queue, and

the last restore date and time history information in the QSAVSTG data area is updated with the current

date and time. In addition, the data portion of the QSAVSTG data area is updated with the date of the

save storage tape used in the restore system storage operation.

Note: Because media errors cause the save operation to start over from the last tape volume, use of this

command is recommended for smaller systems only.

Restrictions:

v You must have save system (*SAVSYS) special authority to run this command.

v The system cannot be running any other jobs; run the End Subsystem (ENDSBS) specifying SBS(*ALL)

or run the End System (ENDSYS) command to end all other jobs except the job running the SAVSTG

command.

v Tapes created using this command that will be used for installation should be initialized with a density

that is supported by the current alternate IPL device. If this is not done, the current IPL tape will have

to be changed to a tape device that supports the density of the created SAVSTG tapes before

installation can begin.

v Tapes created using the SAVSTG command should not be used for automatic installation.

Top

Parameters


DEV Tape device Name Required,

Positional 1




CLEAR Clear *NONE, *ALL Optional

Top

Tape device (DEV)

Specifies the tape device that is used for the save storage operation.


name Specify the name of the tape device to be used.

Top




*PERM

The tape files are protected permanently.

date Specify the date when protection for the tape files ends. The date must be specified in the job

date format.

Top

Clear (CLEAR)

Specifies whether uncleared tapes encountered during the save operation are automatically cleared. An

uncleared tape is one containing a file with an expiration date later than the date of the save operation,

which includes files protected permanently using EXPDATE(*PERM).

Note: This parameter does not control initializing the tapes. The tapes used to perform the save operation

should be initialized to a standard label format before the save command is issued. You can use the

Initialize Tape (INZTAP) command and specify a value for the NEWVOL parameter to initialize a tape to

a standard label format. If a tape volume that is not initialized is encountered during the save operation,

an inquiry message is sent and an operator can initialize the tape volume.

*NONE

None of the uncleared tapes encountered during the save operation are automatically cleared. If

the save operation cannot proceed because an uncleared tape is encountered, an inquiry message

is sent to the operator, who is allowed to end the save operation or to specify that the selected

tape be cleared so the operation can continue.

*ALL All uncleared tapes encountered during the save operation are automatically cleared.

Top


Examples

Example 1: Specifying Expiration Date

SAVSTG DEV(TAP01) EXPDATE(122290) CLEAR(*ALL)

This command saves the system storage on the tape put on the TAP01 tape drive. Each uncleared tape is

cleared automatically. The tape files written are protected and cannot be overwritten until December 22,

1990.

Example 2: Saving System Storage

SAVSTG DEV(TAP02)

The system storage is saved on tape drive TAP02. CLEAR was not specified, so uncleared tapes

encountered during the save operation cause an inquiry message to be sent to the operator, who either

ends the save operation or specifies that the currently selected tape be cleared so the operation can

continue. Because EXPDATE also was not specified, the tape files being written are protected

permanently.

Top

Error messages

*ESCAPE Messages

CPF2206


CPF222E


CPF376A

System must not be in manual mode.

CPF3767


CPF3768


CPF3785

Not all subsystems ended.

Top

Save Storage (SAVSTG) 41

Save System (SAVSYS)


ParametersExamples

Error messages

The Save System (SAVSYS) command saves a copy of the Licensed Internal Code and the QSYS library in

a format compatible with the installation of the operating system. It does not save objects from any other

library. In addition, it saves security and configuration objects that can also be saved using the Save

Security Data (SAVSECDTA) and Save Configuration (SAVCFG) commands.

To save the system data on offline storage, the system writes a copy of the objects onto the media. The

libraries and objects are not affected on the system. This command cannot be used to free any space

occupied by these objects. The history information for the data area QSAVUSRPRF in QSYS is updated

with the date, time, and place where user profiles are saved. The history information for the data area

QSAVSYS in QSYS is updated with the date, time, and place where the system is saved. The history

information for the data area QSAVCFG in QSYS is updated with the date, time, and place where

configuration objects are saved. The history information is not updated for the individual objects. To

display the information in these data areas, run the Display Object Description (DSPOBJD) command,

and specify DETAIL(*FULL). Save the information from the display of QSAVUSRPRF for the location

where the user profiles are saved.

When using this command, it is important to use the device on the system that is defined as the initial

program load (IPL) device. The IPL device was defined by the service representative when the system

was installed. If an IPL device is not used when using this command, then the system cannot be restored

using the SAVSYS media (if densities or media types are incompatible).

Restrictions:

1. You must have save system (*SAVSYS) special authority to run this command

2. All subsystems must be inactive before the SAVSYS command can be specified. The End System

(ENDSYS) or End Subsystem (ENDSBS) command can be used to make the subsystems inactive. You

must have job control (*JOBCTL) special authority to use the ENDSYS or the ENDSBS command.

3. Tapes created using this command that will be used for installation should be initialized with a

density that is supported by the current IPL tape unit. If this is not done, the current IPL tape will

have to be changed to a tape device that supports the density of the created SAVSYS tapes before

installation begins.

4. Tapes created using the SAVSYS command should not be used for automatic installation.

Top

Parameters


DEV Device Values (up to 4 repetitions): Name Required,

Positional 1


Optional,

Positional 2






OMIT Omit Single values: *NONEOther values (up to 2 repetitions): *CFG, *SECDTA

Optional




output

Name




receive output

Name, *FIRST


records

*REPLACE, *ADD

ASPDEV ASP device Name, *ALLAVL, *, *SYSBAS, *CURASPGRP Optional




Top

Device (DEV)




optical-device-name




tape-device-name






Top





Single values

*MOUNTED



command.




character-value



Top




*PERM

The files are protected permanently.

date Specify the date when protection for the files ends.

Top







ignored.

*REWIND


*LEAVE


the tape drive.

*UNLOAD



Top








Save System (SAVSYS) 45








Note: Not all files will be saved with optimum block size.

Top

Omit (OMIT)

Specifies what data to omit from the save system operation.

Single values

*NONE

All of the security data and configuration data are included in the save system operation.


*CFG All of the configuration data is omitted from the save system operation. You can use the SAVCFG

(Save Configuration) command to save just the configuration object information.

*SECDTA

All of the security data is omitted from the save system operation. You can use the SAVSECDTA

(Save Security Data) command to save just the system security data.

Top

Output (OUTPUT)



*NONE


*PRINT


*OUTFILE


parameter.



Top












*CURLIB





QSRSAV as a model.

Top





*FIRST









*REPLACE



Top

ASP device (ASPDEV)

Specifies the auxiliary storage pool (ASP) device from which private authorities are to be saved.


*ALLAVL

The private authorities from the system ASP (ASP number 1), all basic user ASPs (ASP numbers

2-32), and all available independent ASPs are saved.

* The private authorities from the system ASP, all basic user ASPs, and, if the current thread has an

ASP group, all independent ASPs in the ASP group are saved.

*SYSBAS

The private authorities from the system ASP and all basic user ASPs are saved.

*CURASPGRP

If the current thread has an ASP group, the private authorities from all independent ASPs in the

ASP group are saved.

name Specify the ASP device name from which private authorities are to be saved.

Top

Clear (CLEAR)


the media that has not expired. Clearing active data removes all files from the volume. Replacing active

data on optical media initializes the first volume, and replaces only the optical files created by this

operation on any volumes after the first volume.

Notes:







*NONE

None of the media is automatically cleared. If the save operation encounters active data on the

first volume, an inquiry message is sent, allowing the operator to either end the save operation or

clear the media. If the save operation encounters active data after the first volume, an inquiry

message is sent, allowing the operator to either end the save operation, clear the tape, or replace

the optical file.


*AFTER


data on the first tape, an inquiry message is sent, allowing the operator to either end the save

operation or clear the media. If the save operation encounters the specified optical file on the first

volume, an inquiry message is sent, allowing the operator to either end the save operation or

replace the file.

*REPLACE

Active data on the media is automatically replaced. The first optical volume is initialized. Other

optical volumes are not initialized. Tapes are automatically cleared in the same way as the *ALL

value.

Top





















*MEDIUM






*HIGH





Top











Top


Examples

Example 1: Tapes Cleared Automatically

SAVSYS DEV(TAP01) CLEAR(*ALL)

This command saves licensed internal code, system objects, all user profiles (including private authority

for objects), and all line, controller, and device descriptions. They are saved on the tape put on the TAP01

tape drive. Each uncleared tape is automatically cleared when it is encountered, and the save operation

continues without operator intervention.

Example 2: Operating Receives Message of Exceeded Storage Capacity

SAVSYS DEV(TAP01) VOL(ABCDE)

The system data is saved on the TAP01 tape drive, starting on the tape volume labeled ABCDE. If the

save operation exceeds the storage capacity of one tape, a message requesting that another volume be put

on the TAP01 tape drive is shown to the operator.

Example 3: Saving Data on Two Tape Drives in Alternating Order

SAVSYS DEV(TAP01 TAP02)

The system data is saved on tape drives TAP01 and TAP02 in alternating order. If the save operation

exceeds the storage capacity of two tapes, a message requesting that another volume be put on TAP01 is

shown to the operator. The tapes are rewound at the completion of the save system operation.

Top

Error messages

*ESCAPE Messages

CPF2206


CPF222E


CPF3703

&2 &1 in &3 not saved.

CPF3709


CPF372B

Not all objects were saved.

CPF3727


CPF3728



CPF3733


CPF3735

Storage limit exceeded for user profile &1.

CPF3738


CPF3767


CPF3768


CPF3772

SAVSYS completed. One or more objects not saved.

CPF3785

Not all subsystems ended.

CPF3793


CPF3794


CPF3797

Objects from library &3 not saved. Save limit exceeded.

CPF3798

Installation &2 &1 in &3 not found.

CPF384E


CPF3873

Licensed program &1 option &2 release &4 not saved.

CPF388B


CPF3894

Cancel reply received for message &1.

CPF38A4

ASP device &1 not correct.

CPF9814


CPF9833


CPF9845


CPF9846


CPF9847


CPF9850

Override of printer file &1 not allowed.


CPF9851

Overflow value for file &1 in &2 too small.

CPF9860


CPFB8ED

Device description &1 not correct for operation.

Top


Save System Information (SAVSYSINF)


ParametersExamples

Error messages

The Save System Information (SAVSYSINF) command saves a subset of system data and objects saved by

the Save System (SAVSYS) command. The system data and objects may be restored by the Restore System

Information (RSTSYSINF) command.

The history information for the data area QSYSINF in QSYS is updated with the date, time, and place

where the system information is saved.

SAVSYSINF is not to be considered a replacement for the SAVSYS command and is not to be used for

system upgrades or migrations.

Objects saved from QSYS include:

v *JOBD

v *JOBQ

v *EDTD

v *JRN

v *SBSD

v *CLS

v *MSGQ

v *TBL

v *IGCTBL

v *DTAARA

v *CMD objects changed since the last SAVSYS

v *MSGF objects changed since the last SAVSYS

Additional items saved include:

v System reply list

v Service attributes

v Environment variables

v Certain system values

v Network attributes

v PTFs applied since the last SAVSYS

Some items NOT saved as part of SAVSYSINF command:

v Licensed Internal Code

v QSYS library

v Security objects (use the SAVSECDTA command)

v Configuration objects (use the SAVCFG command)

v User profiles (use the SAVSECDTA command)

v System values related to date/time

v System values which cannot be changed. For system values which can be changed, refer to the i5/OS

Information Center at http://www.ibm.com/systems/i/infocenter/


v QPWDLVL (Password level) system value

Note: The SAVSYSINF command issues several save commands for saving objects. Parameters may or

may not be used for all save commands.

Top

Parameters


DEV Device Single values: *SAVFOther values (up to 4 repetitions): Name

Required,

Positional 1


Optional




SAVF Save file Qualified object name Optional

Qualifier 1: Save file Name










output

Name




receive output

Name, *FIRST


records

*REPLACE, *ADD

Top

Device (DEV)




Single values

*SAVF The save operation is done using the save file specified for the Save file (SAVF) parameter.

Other values


optical-device-name




tape-device-name






Top





Single values

*MOUNTED



command.



character-value



Top





1-16777215


Top




Notes:




*PERM



Top







ignored.

*REWIND


*LEAVE


the tape drive.

*UNLOAD



Top

Save file (SAVF)

Specifies the save file that is used to contain the saved data. The save file must be empty, unless *ALL is

specified for the Clear (CLEAR) parameter.

Note: A value must be specified for this parameter if *SAVF is specified for the Device (DEV) parameter.


name Specify the name of save file to be used.



*CURLIB




Top










Top















Top

Clear (CLEAR)







Notes:







*NONE










*AFTER






Note: The *AFTER value is not valid for save files.

*REPLACE



Top




















*MEDIUM






*HIGH






Top











Top

Output (OUTPUT)



*NONE


*PRINT


*OUTFILE


parameter.



Top












*CURLIB





QSRSAV as a model.

Top





*FIRST









*REPLACE



Top

Examples

Example 1: Tapes Cleared Automatically

SAVSYSINF DEV(TAP01) CLEAR(*ALL)

This command saves the system information on the tape put on the TAP01 tape drive. Each uncleared

tape is automatically cleared when it is encountered, and the save operation continues without operator

intervention.

Example 2: Save File Cleared Automatically and Output Generated to a File

SAVSYSINF DEV(*SAVF) SAVF(QGPL/SAVF) CLEAR(*ALL)

OUTPUT(*OUTFILE) OUTFILE(QGPL/OUTPUT)

This command saves the system information to the save file named SAVF in library QGPL. The save file

will be cleared automatically. Information about what was saved will be written to the first member of

the file named OUTPUT in library QGPL; the file and member will be created if they do not exist.


Top

Error messages

*ESCAPE Messages

CPF38A7

SAVSYSINF completed. One or more objects not saved.

CPD37AD

Save file not found for PTF &1-&2 &3.

Top


Submit Data Base Jobs (SBMDBJOB)


ParametersExamples

Error messages

The Submit Database Jobs (SBMDBJOB) command allows you to submit jobs to job queues so they can be

run as batch jobs. The input stream is read either from a physical database file or from a logical database

file that has a single-record format. This command allows you to specify the name of this database file

and its member, the name of the job queue to be used, and to decide whether jobs being submitted can

be displayed by the Work with Submitted Jobs (WRKSBMJOB) command

A Submit Database Jobs operation reads the file once and ends when the end-of-file is read or when an

End Input (ENDINP) command is encountered. The ENDINP command (a delimiter) is not recognized if

it is within an inline file that ends with characters that are not default ending characters (as specified in

the ENDCHAR parameter of the Data (DATA) command). The SBMDBJOB operation can be canceled

either by canceling the request from the system request menu or by canceling the job in which the

process is running.

In contrast to a spool reader started with the Start Database Reader (STRDBRDR) command, the

SBMDBJOB command operates in the same process as the requesting function and does not do syntax

checking on the input stream.

Restriction: The specified database file either must consist of single-field records and must have an

arrival sequence access path, or it must be a standard database source file.

Top

Parameters


FILE Data base file Qualified object name Required,

Positional 1 Qualifier 1: Data base file Name


MBR Member Name, *FIRST Optional,

Positional 2

JOBQ Job queue Qualified object name Optional,

Positional 3 Qualifier 1: Job queue Name, QBATCH


DSPSBMJOB Show on submitted job list *YES, *NO Optional

Top

Data base file (FILE)

Specifies the database file from which the input stream is read.


Qualifier 1: Data base file


name Specify the name of the database file that contains the input stream that you want to read.



*CURLIB

The current library for the job is used to locate the file. If no current library entry exists in the

library list, QGPL is used.

name Specify the name of the library where the file is located.

Top

Member (MBR)

Specifies the member in the specified file that contains the input stream to be read.

*FIRST

No member name is specified; the first member in the file is used.

name Specify the name of the member that contains the input stream to read.

Top

Job queue (JOBQ)

Specifies the job queue on which the job entries are placed. A job entry is placed on this queue for each

job in the input stream that has JOBQ(*RDR) specified on the Batch Job (BCHJOB) command. If *RDR is

not specified on the BCHJOB command, the job queue specified on the BCHJOB command or in the job

description is used. (The job queue for each job in the input stream can be different.) This parameter is

valid only if ACTION(*SUBMIT) is specified in the existing network job entry or in a subsequent Change

Network Job Entry (CHGNETJOBE) command.

Note: If both the user identified in the job description of the job being read and the user processing the

Submit Database Job (SBMDBJOB) command are not authorized to the job queue on which the job should

be placed, the job ends and a diagnostic message is placed in the job log. The input stream, continues to

be processed, starting with the next job. If either user is authorized to the job queue, the job runs without

error.

Qualifier 1: Job queue

QBATCH

The job entry is to be placed on the QBATCH job queue, which is the default job queue. This will

happen if *RDR is specified on the Job queue (JOBQ) parameter of the Batch Job (BCHJOB)

command. The Batch Job (BCHJOB) command is contained in the input stream itself.

name Specify the name of the job queue to which each job in the input stream will be sent. This will

happen if *RDR is specified on the JOBQ parameter of the Batch Job (BCHJOB) command.



*CURLIB

The current library for the job is used to locate the job queue.

name Specify the name of the library where the job queue is located.

Top


Show on submitted job list (DSPSBMJOB)

Specifies whether the jobs being submitted are displayed on the submitted jobs display. If *YES is

specified here, these submitted jobs can be displayed when the Work with Submitted Jobs (WRKSBMJOB)

command is used.

*YES This job can be displayed by the Work with Submitted Jobs (WRKSBMJOB) command.

*NO This job is not displayed on any display produced by the Work with Submitted Jobs

(WRKSBMJOB) command.

Top

Examples

SBMDBJOB FILE(QGPL/BILLING)

This command submits jobs using input from the database file named BILLING, which is in the QGPL

library. The first member in the BILLING file contains the input stream to be processed. The default

system-supplied job queue QBATCH is used.

Top

Error messages

*ESCAPE Messages

CPF1751

Error while processing job &3/&2/&1.

CPF1754

File &1 in library &2 not database file or DDM file.

CPF1760

Submit jobs command not allowed.

CPF2207

Not authorized to use object &1 in library &3 type *&2.

CPF3307

Job queue &1 in &2 not found.

CPF3330

Necessary resource not available.

CPF3363

Message queue &1 in library &2 not found.

CPF9802

Not authorized to object &2 in &3.

CPF9812


CPF9815

Member &5 file &2 in library &3 not found.

Submit Data Base Jobs (SBMDBJOB) 65

CPF9845


CPF9846


*STATUS Messages

CPF1762

Reading job &3/&2/&1.

Top


Submit Finance Job (SBMFNCJOB)


ParametersExamples

Error messages

The Submit Finance Job (SBMFNCJOB) command submits a batch job that lets your finance application

programs communicate with your 4701 or 4702 controller application programs.

Use the SBMFNCJOB command only if:

v Communicating with a 4701 or 4702 control unit

v A device table and a program table have been defined using the Work with Device Table

(WRKDEVTBL) and Work with Program Table (WRKPGMTBL) commands; defining a user table using

the Work with User Table (WRKUSRTBL) command is optional

v The user’s 4701 or 4702 control unit application program sends data (transactions) first and expects a

response

v The user’s 4701 or 4702 control unit application program passes data in the proper format

Restriction: This command is shipped with public *EXCLUDE authority.

Top

Parameters


DEVTBL Device table Name Required,

Positional 1

PGMTBL Program table Name Required,

Positional 2

USRTBL User table Name, *NONE Optional,

Positional 3

JOB Job name Name, QFNCJOB Optional

JOBD Job description Qualified object name Optional

Qualifier 1: Job description Name, QFNC


MSGQ Message queue Single values: *WRKSTN, *NONEOther values: Qualified object name

Optional

Qualifier 1: Message queue Name


Top

Device table (DEVTBL)

Specifies the name of the device table that the finance job uses to determine which 4704 or 3624 devices it

controls. This is a required parameter.

Top


Program table (PGMTBL)

Specifies the name of the program table that the finance job uses to determine, from the program ID (sent

in the data stream with a finance transaction), which user program names will process the finance

transaction. This is a required parameter.

Top

User table (USRTBL)

Specifies the name of the user table that the finance job uses to verify a valid user when a finance sign-on

is received.


*NONE

No user IDs are verified.

user-table-name

Specify the name of a user table that defines user IDs for the 4700 device.

Top

Job name (JOB)

Specifies the job name that is associated with the submitted finance job.


QFNCJOB

The job name is submitted as QFNCJOB.

job-name

Specify the user-defined job name that is associated with the submitted finance job.

Top

Job description (JOBD)

Specifies the name and library of the job description that is used by the finance job.


*QFNC

The submitted finance job uses the job description QFNC.

job-description-name

Specify the name and library of a job description that is used by the finance job. (If no library

name is given, the job description is found through the library list used by the job in which the

Submit Finance Job (SBMFNCJOB) command is entered.


*LIBL

The library list is used to locate the finance job.

*CURLIB


The current library for the job is used to locate the finance job. If no library is specified as

the library for the job, QGPL is used.

library-name

Specify the name of the library where the finance job is located.

Top

Message queue (MSGQ)

Specifies the name of the message queue, to which messages can be sent while the finance job is running.


WRKSTN

The finance messages are sent to the message queue of the work station from which the finance

job was submitted.

*NONE

No finance messages are sent to a message queue.

message-queue-name

Specify the name and library of the user-defined message queue to which messages are sent. (If

no library name is given, the library list of the job issuing the Submit Finance Job (SBMFNCJOB)

command is used to find the queue.)


*LIBL The library list is used to find the name of the message queue.

*CURLIB

The current library for the job is used to find the name of the message queue. If no

library is specified as the current library for the job, QGPL is used.

library-name

Specify the name of the library where the name of the message queue is located.

Top

Examples

Example 1: Submitting a Batch Job that Communicates with Devices it Acquires

SBMFNCJOB DEVTBL(DEVTBL1) PGMTBL(PGMTBL1) USRTBL(USRTBL1)

This command submits batch job QFNCJOB. The job communicates with all devices it acquires from

device table DEVTBL1, allowing users whose user IDs are found in USRTBL1 to sign on the devices. Each

transaction sent by the finance devices is processed by determining, in PGMTBL1, which application

program must be called, then it calls that program.

The job description used by the finance job in this example is QFNC. Messages sent as a result of the

finance job are sent to the message queue of the work station from which the job was submitted.

Example 2: User IDs Not Verified

Submit Finance Job (SBMFNCJOB) 69

SBMFNCJOB DEVTBL(DEVTBL2) PGMTBL(PGMTBL2)

JOB(CTFJOB) JOBD(CTFJOBD) MSGQ(*NONE)

This command submits batch job CTFJOB. CTFJOB runs under job description CTFJOBD and does not

send messages to any work station message queue while running. No verification of user IDs is

performed by the finance job.

Top

Error messages

*ESCAPE Messages

CPF8382

Finance job cannot be processed.

Top


Submit Job (SBMJOB)

Where allowed to run: All environments (*ALL)Threadsafe: Conditional

ParametersExamples

Error messages

The Submit Job (SBMJOB) command allows a job that is running to submit another job to a job queue to

be run later as a batch job. Only one element of request data can be placed on the new job’s message

queue. The request data can be a CL command if the routing entry used for the job specifies a CL

command processing program (such as the IBM-supplied QCMD program).

Restrictions:

1. The user that issues the SBMJOB command must have:

v use (*USE) authority to the user profile specified on the User (USER) parameter.

v use (*USE) authority to the command specified on the Command to run (CMD) parameter and

execute (*EXECUTE) authority to the library containing that command.

v use (*USE) authority to the job description specified on the Job description (JOBD) parameter and

execute (*EXECUTE) authority to the library containing that job description.

v use (*USE) authority to the job queue specified on the Job queue (JOBQ) parameter and execute

(*EXECUTE) authority to the library containing that job queue.

v use (*USE) and add (*ADD) authority to the message queue specified on the Message queue

(MSGQ) parameter and execute (*EXECUTE) authority to the library containing that message

queue.

v job control (*JOBCTL) special authority to use the Submitted for (SBMFOR) parameter.

v use (*USE) authority to the Change Accounting Code (CHGACGCDE) command in order to specify

a character-value accounting code on the Accounting code (ACGCDE) parameter.2. The user for the submitted job must have:

v use (*USE) authority to the job description specified on the Job description (JOBD) parameter.

v read (*READ) authority to the output queue specified on the Output queue (OUTQ) parameter and

execute (*EXECUTE) authority to the library, in the submitted job’s name space, that contains that

output queue.

v use (*USE) authority to all the libraries specified on the System library list (SYSLIBL) parameter.

v use (*USE) authority to the library specified on the Current library (CURLIB) parameter.

v use (*USE) authority to all the libraries specified on the Initial library list (INLLIBL) parameter.

v use (*USE) authority to all auxiliary storage pool (ASP) device descriptions specified on the Initial

ASP group (INLASPGRP) parameter.

v use (*USE) authority to the sort sequence table specified on the Sort sequence (SRTSEQ) parameter

and execute (*EXECUTE) authority to the library, in the submitted job’s name space, that contains

that sort sequence table.3. This command is conditionally threadsafe. If a Job Notification Exit Point has been registered to send

a message to a DDM data queue whenever a Submit Job is done, the message will not be sent if

SBMJOB command is issued in a multithreaded job. For more information on the Job Notification

function, refer to the Job Notification Exit Point in the Work Management chapter of the System API

Reference manual.

Top


Parameters


CMD Command to run Command string Optional

JOB Job name Name, *JOBD Optional,

Positional 1

JOBD Job description Single values: *USRPRFOther values: Qualified object name

Optional,

Positional 2

Qualifier 1: Job description Name


JOBQ Job queue Single values: *JOBDOther values: Qualified object name

Optional,

Positional 4

Qualifier 1: Job queue Name


JOBPTY Job priority (on JOBQ) 1-9, *JOBD Optional

OUTPTY Output priority (on OUTQ) 1-9, *JOBD Optional

PRTDEV Print device Name, *CURRENT, *USRPRF, *SYSVAL, *JOBD Optional

OUTQ Output queue Single values: *CURRENT, *USRPRF, *DEV, *JOBDOther values: Qualified object name

Optional

Qualifier 1: Output queue Name


USER User Name, *CURRENT, *JOBD Optional,

Positional 3

ACGCDE Accounting code Character value, *CURRENT, *USRPRF, *JOBD Optional

PRTTXT Print text Character value, *CURRENT, *JOBD, *SYSVAL, *BLANK Optional

RTGDTA Routing data Character value, QCMDB, *JOBD, *RQSDTA Optional

RQSDTA Request data or command Character value, *CMD, *JOBD, *NONE, *RTGDTA Optional

SYSLIBL System library list *CURRENT, *SYSVAL Optional

CURLIB Current library Name, *CURRENT, *USRPRF, *CRTDFT Optional

INLLIBL Initial library list Single values: *CURRENT, *JOBD, *SYSVAL, *NONEOther values (up to 250 repetitions): Name

Optional

INLASPGRP Initial ASP group Name, *CURRENT, *JOBD, *NONE Optional

LOG Message logging Element list Optional

Element 1: Level 0-4, *JOBD

Element 2: Severity 0-99, *JOBD

Element 3: Text *JOBD, *MSG, *SECLVL, *NOLIST

LOGCLPGM Log CL program commands *JOBD, *NO, *YES Optional

LOGOUTPUT Job log output *JOBD, *SYSVAL, *JOBLOGSVR, *JOBEND, *PND Optional

JOBMSGQMX Job message queue

maximum size

2-64, *JOBD, *SYSVAL Optional

JOBMSGQFL Job message queue full

action

*JOBD, *SYSVAL, *NOWRAP, *WRAP, *PRTWRAP Optional

INQMSGRPY Inquiry message reply *JOBD, *RQD, *DFT, *SYSRPYL Optional

HOLD Hold on job queue *JOBD, *NO, *YES Optional

SCDDATE Schedule date Date, *CURRENT, *MONTHSTR, *MONTHEND, *MON,

*TUE, *WED, *THU, *FRI, *SAT, *SUN

Optional

SCDTIME Schedule time Time, *CURRENT Optional

DATE Job date Date, *JOBD, *SYSVAL Optional

SWS Job switches Character value, *JOBD Optional



DSPSBMJOB Allow display by

WRKSBMJOB

*YES, *NO Optional

SBMFOR Submitted for Single values: *CURRENTOther values: Qualified job name

Optional

Qualifier 1: Submitted for Name

Qualifier 2: User Name

Qualifier 3: Number 000000-999999

MSGQ Message queue Single values: *USRPRF, *WRKSTN, *NONEOther values: Qualified object name

Optional



SRTSEQ Sort sequence Single values: *CURRENT, *USRPRF, *SYSVAL, *HEX,

*LANGIDUNQ, *LANGIDSHROther values: Qualified object name

Optional

Qualifier 1: Sort sequence Name


LANGID Language ID Character value, *CURRENT, *USRPRF, *SYSVAL Optional

CNTRYID Country or region ID Character value, *CURRENT, *USRPRF, *SYSVAL Optional

CCSID Coded character set ID 1-65535, *CURRENT, *USRPRF, *SYSVAL, *HEX Optional

CPYENVVAR Copy environment variables *NO, *YES Optional

ALWMLTTHD Allow multiple threads *JOBD, *NO, *YES Optional

SPLFACN Spooled file action *CURRENT, *JOBD, *SYSVAL, *KEEP, *DETACH Optional

Top

Command to run (CMD)

Specifies a command that runs in the batch job, if the routing program used when this batch job is

initiated is the IBM-supplied default routing program (QCMD). Because this command is used for the

request data, this parameter is mutually exclusive with the Request data or command (RQSDTA)

parameter.

command-string

Specify the command that is run in the batch job. The command cannot be longer than 20000

characters.

Top

Job name (JOB)

Specifies the name that is associated with the job when it is processed by the system.

*JOBD

The simple name of the job description used with this job is the name of the job itself.

name Specify the simple name of the job that is used while it is being processed by the system.

Top

Submit Job (SBMJOB) 73


Specifies the job description used with the job.

Single values

*USRPRF

The job description in the user profile under which the submitted job initially runs is used as the

job description of the submitted job.

Qualifier 1: Job description

name Specify the name of the job description used for the job.



*CURLIB

The current library for the thread is used to locate the job description. If no library is specified as

the current library for the thread, the QGPL library is used.

name Specify the library where the job description is located.

Top

Job queue (JOBQ)

Specifies the job queue in which this job is placed.

Single values

*JOBD

The submitted job is placed on the job queue named in the specified job description.


name Specify the name of the job queue.



*CURLIB

The current library for the thread is used to locate the job queue. If no library is specified as the

current library for the thread, the QGPL library is used.

name Specify the library where the job queue is located.

Top

Job priority (on JOBQ) (JOBPTY)

Specifies the job queue scheduling priority. The highest priority is 1 and the lowest priority is 9.

*JOBD

The scheduling priority specified in the job description is used for the job.

1-9 Specify the scheduling priority for the job.

Top


Output priority (on OUTQ) (OUTPTY)

Specifies the output priority for spooled output files that are produced by this job. The highest priority is

1 and the lowest priority is 9.

*JOBD

The output priority specified in the job description is used for the job.

1-9 Specify the priority of the submitted job’s output files.

Top

Print device (PRTDEV)

Specifies the qualified name of the default printer device for this job. If the printer file being used to

create the output specifies to spool the file, the spooled file is placed on the device’s output queue, which

is named the same as the device.

Note: This assumes the defaults are specified on the Output queue (OUTQ) parameter of the printer file,

job description, user profile and work station.

*CURRENT

The same printer device being used by the job that is currently running is used by the submitted

job.

*USRPRF

The printer device specified in the user profile under which the submitted job initially runs is

used as the printer device for this job. The printer device name is obtained from the profile when

this command is run.

*SYSVAL

The printer device specified in the system value, QPRTDEV, when this command is run is used

for the submitted job.

*JOBD

The printer device specified in the job description is used for the submitted job.

name Specify the name of the printer device used for the submitted job.

Top

Output queue (OUTQ)

Specifies the qualified name of the output queue used for spooled files that specify OUTQ(*JOB). This

parameter applies only to printer files that have *JOB specified on the OUTQ parameter.

Single values

*CURRENT

The output queue used by the job that is currently running is used for the submitted job.

*USRPRF

The output queue in the user profile under which the submitted job initially runs is used as the

output queue for the submitted job. The output queue name is obtained from the profile when

this command is run.

*DEV The output queue associated with the printer specified on the Device (DEV) parameter of the

printer file is used. The output queue has the same name as the printer. The printer file DEV


parameter is determined by the Create Printer File (CRTPRTF), Change Printer File (CHGPRTF),

or the Override with Printer File (OVRPRTF) commands.

Note: This assumes the defaults were specified on the OUTQ parameter for the printer file, job

description, user profile, and workstation.

*JOBD

The output queue named in the job description used with the submitted job is the job’s default

output queue.

Qualifier 1: Output queue

name Specify the name of the output queue that is used as the default output queue by the submitted

job.



*CURLIB

The current library for the thread is used to locate the output queue. If no library is specified as

the current library of the thread, the QGPL library is used.

name Specify the library where the output queue is located.

Top

User (USER)

Specifies the name of the user profile for the job being submitted. If *RQD is specified in the job

description, *JOBD cannot be specified. Instead, *CURRENT or a user-name must be specified.

Note: The following IBM-supplied objects are not valid for this parameter:

v QDBSHR

v QDFTOWN

v QDOC

v QLPAUTO

v QLPINSTALL

v QRJE

v QSECOFR

v QSPL

v QSYS

v QTSTRQS

*CURRENT

The same user profile used by the job that is currently running is used for the submitted job.

*JOBD

The user profile named in the specified job description is used for the job being submitted.

name Specify the name of the user profile that is used for the job being submitted.

Top


Accounting code (ACGCDE)

Specifies the accounting code that is used by the submitted job when logging the usage of system

resources in the system accounting journal QACGJRN.

*CURRENT

The accounting code used by the job that is currently running is used for the submitted job.

*USRPRF

The accounting code specified in the user profile under which the submitted job initially runs is

used.

*JOBD

The accounting code specified in the job description associated with the submitted job is used.

character-value

Specify the 15-character accounting code to be used by the submitted job. If less than 15

characters are specified, the string is padded on the right with blanks.

Top

Print text (PRTTXT)

Specifies the text that is printed at the bottom of each page of printed output and on separator pages.

*CURRENT

The same print text of the submitting job is used.

*JOBD

The value in the job description is used for this job.

*SYSVAL

The system value, QPRTTXT, is used.

*BLANK

No text is printed.

character-value

Specify the character string that is printed at the bottom of each page. A maximum of 30

characters can be entered, enclosed in apostrophes.

Top

Routing data (RTGDTA)

Specifies the routing data used to start the next routing step in the job. The routing data is used to

determine the routing entry that identifies the program that the job runs.

QCMDB

The routing data used by the IBM-supplied subsystems to route batch jobs to the IBM-supplied

control language processor QCMD is used.

*JOBD

The routing data specified in the job description is used.

*RQSDTA

The first 80 characters of the request data specified in the Request data or command (RQSDTA)

parameter of this command are used as the routing data for the job.


character-value

Specify the character string that is used as the routing data for starting the job. A maximum of 80

characters can be entered, enclosed in apostrophes if necessary.

Top

Request data or command (RQSDTA)

Specifies the request data that is placed as the last entry in this job’s message queue. The request data can

be a CL command to be run or a string of characters used by another program.

*CMD The input from the Command to run (CMD) parameter is placed in this job’s message queue.

*JOBD

The request data specified in the job description used by the job is placed in this job’s message

queue.

*NONE

No request data is placed in the job’s message queue.

*RTGDTA

The routing data specified in the Routing data (RTGDTA) parameter of this command is placed

as the last entry in the job’s message queue.

character-value

Specify the character string that is placed as the last entry in the submitted job’s message queue.

A maximum of 3000 characters can be entered, enclosed in apostrophes if necessary.

Top

System library list (SYSLIBL)

Specifies the system portion of the initial library list that is used by the submitted job.

*CURRENT

The same system library list being used by the thread that is currently running is used for the

submitted job.

*SYSVAL

The system default system library list is used by the job. It contains the library names that were

specified in the system value, QSYSLIBL, at the time that the job is started.

Top

Current library (CURLIB)

Specifies the name of the current library associated with the submitted job.

*CURRENT

The current library being used by the thread that is currently running is used for the submitted

job.

*USRPRF

The current library in the user profile under which the submitted job initially runs is used as the

current library for the submitted job.

*CRTDFT

There is no current library for the submitted job. If objects are created in the current library,

QGPL is used as the default current library.


name Specify the library used as the current library of the submitted job.

Top

Initial library list (INLLIBL)

Specifies the initial user part of the library list that is used to search for any object names that were

specified without a library qualifier.

Note: Duplication of library names in the library list is not allowed.

Single values

*CURRENT

The library list being used by the thread that is currently running is used for the submitted job.

*JOBD

The library list in the job description used with this job is used as the initial user part of the

library list for the job.

*SYSVAL

The system default user library list is used by this job. It contains the library names that were

specified in the system value QUSRLIBL at the time that the job is started.

*NONE

The user portion of the initial library list is empty.


name Specify the names of one or more libraries that are the user portion of the library list and are

used by this job. The libraries are searched in the same order as they are listed.

Top

Initial ASP group (INLASPGRP)

Specifies the initial setting for the auxiliary storage pool (ASP) group name for the initial thread of the

submitted job. A thread can use the Set ASP Group (SETASPGRP) command to change its library name

space. When an ASP group is associated with a thread, all libraries in the independent ASPs in the ASP

group are accessible and objects in those libraries can be referenced using regular library-qualified object

name syntax. The libraries in the independent ASPs in the specified ASP group plus the libraries in the

system ASP (ASP number 1) and basic user ASPs (ASP numbers 2-32) form the library name space for the

thread.

*CURRENT

The ASP group name for the current thread is used for the submitted job.

*JOBD

The initial ASP group name specified in the job description is used for the submitted job.

*NONE

Specifies the initial thread of the submitted job will be started with no ASP group. The library

name space will not include libraries from any ASP group. Only the libraries in the system ASP

and any basic user ASPs will be in the library name space.

name Specify the name of the ASP group to be set for the initial thread of the submitted job. The ASP

group name is the name of the primary ASP device within the ASP group. All libraries from all

ASPs in this ASP group will be included in the library name space.


Top

Message logging (LOG)

Specifies the message logging values used to determine the amount and type of information sent to the

job log by this job. This parameter has three elements: the message (or logging) level, the message

severity, and the level of message text.

Element 1: Level

*JOBD

The value specified for message logging in the job description is used for this job.

0-4 Specify the message logging level used for this job’s messages. The possible logging levels are:

0 No messages are logged.

1 All messages sent to the job’s external message queue with a severity greater than or

equal to the message logging severity are logged. This includes the indications of job

start, job end, and job completion status.

2 The following information is logged:

v Logging level 1 information

v Request messages which result in a high-level message with a severity code greater

than or equal to the message logging severity. Both the request message and all

associated messages are logged.

Note: A high-level message is one that is sent to the program message queue of the

program that receives the request message. For example, QCMD is an IBM-supplied

request processing program that receives request messages.


v Logging level 1 and 2 information

v All request messages

v Commands run by a CL program are logged if it is allowed by the logging of CL

programs job attribute and the log attribute of the CL program.


v All request messages and all messages with a severity greater than or equal to the

message logging severity, including trace messages.

v Commands run by a CL program are logged if it is allowed by the logging of CL

programs job attribute and the log attribute of the CL program.

Element 2: Severity

*JOBD


0-99 Specify the message severity that is used in conjunction with the logging level to determine

which error messages are logged in the job log.

Element 3: Text

*JOBD


*MSG Only the message text is written to the job log.


*SECLVL

Both the message text and the message help (cause and recovery) of the error message are written

to the job log.

*NOLIST

If the job ends normally, no job log is produced. If the job ends abnormally (if the job end code is

20 or higher), a job log is produced. The messages that appear in the job log contain both the

message text and the message help.

Top

Log CL program commands (LOGCLPGM)

Specifies whether the commands that are run in a control language program are logged to the job log by

way of the CL program’s message queue. This parameter sets the status of the job’s logging flag. If *JOB

has been specified for the Message logging (LOG) parameter in the Create CL Program (CRTCLPGM)

command, the flag set in the Log CL program commands (LOGCLPGM) parameter is used. Other values

for the Message logging (LOG) parameter override the Log CL program commands (LOGCLPGM)

parameter. The commands are logged in the same manner as the requests.

*JOBD

The value specified in the job description is used.

*NO The commands in a CL program are not logged to the job log.

*YES The commands in a CL program are logged to the job log.

Top

Job log output (LOGOUTPUT)

Specifies how the job log will be produced when the job completes. This does not affect job logs

produced when the message queue is full and the job message queue full action specifies *PRTWRAP.

Messages in the job message queue are written to a spooled file, from which the job log can be printed,

unless the Control Job Log Output (QMHCTLJL) API was used in the job to specify that the messages in

the job log are to be written to a database file.

The job log output value can be changed at any time until the job log has been produced or removed. To

change the job log output value for a job, use the Change Job (QWTCHGJB) API or the Change Job

(CHGJOB) command.

The job log can be displayed at any time until the job log has been produced or removed. To display the

job log, use the Display Job Log (DSPJOBLOG) command.

The job log can be removed when the job has completed and the job log has not yet been produced or

removed. To remove the job log, use the Remove Pending Job Log (QWTRMVJL) API or the End Job

(ENDJOB) command.

*JOBD

The value specified in the job description is used.

*SYSVAL

The value specified in the system value QLOGOUTPUT is used.

*JOBLOGSVR

The job log will be produced by a job log server. For more information about job log servers,

refer to the Start Job Log Server (STRLOGSVR) command.


*JOBEND

The job log will be produced by the job itself. If the job cannot produce its own job log, the job

log will be produced by a job log server. For example, a job does not produce its own job log

when the system is processing a Power Down System (PWRDWNSYS) command.

*PND The job log will not be produced. The job log remains pending until removed.

Top

Job message queue maximum size (JOBMSGQMX)

Specifies the maximum size of the job message queue.

*JOBD

The value specified in the job description determines maximum size of the job message queue.

*SYSVAL

The value in system value QJOBMSGQMX at the time the job is started is used as the maximum

size of the job message queue.

2-64 Specify the maximum size, in megabytes, of the job message queue.

Top

Job message queue full action (JOBMSGQFL)

Specifies the action that should be taken when the job message queue is full.

*JOBD

The value specified in the job description determines the action that should be taken.

*SYSVAL

The value specified for the QJOBMSGQFL system value is used.

*NOWRAP

The message queue does not wrap when it is full. This action ends the job.

*WRAP

The message queue wraps to the start of the message queue when full and starts filling the

message queue again.

*PRTWRAP

The message queue wraps the job message queue when full and prints the messages that are

being overlaid because of wrapping.

Top

Inquiry message reply (INQMSGRPY)

Specifies the way that predefined messages that are sent as a result of running this job are answered. You

can specify that the inquiry message reply control is taken from the job description, or that all inquiry

messages require a reply, or that a default reply is issued, or that the system reply list is checked for a

matching reply as each predefined inquiry message is sent.

*JOBD

The inquiry message reply control specified in the job description used with this job is used.

*RQD A reply is required by the receiver of the inquiry message for all inquiry messages that occur

when this command is run.


*DFT The default message reply is used to answer any inquiry messages issued when this command is

run.

*SYSRPYL

The system reply list is checked to see if there is an entry for any inquiry message that is issued

as a result of running this job that has a message identifier and any comparison data that match

the inquiry message identifier and message data. If a match occurs, the reply value in that entry

is used. If no entry exists for that message, a reply is required.

Top

Hold on job queue (HOLD)

Specifies whether this job is held at the time that it is put on the job queue. A job placed on the job queue

in the hold state is held until it is released by the Release Job (RLSJOB) command or ended, either by the

End Job (ENDJOB) command or by the Clear Job Queue (CLRJOBQ) command.

*JOBD

The value specified in the job description determines whether the job is held when it is put on

the job queue.

*NO The job is not held when it is put on the job queue.

*YES The job is held when it is put on the job queue until it is released ended.

Top

Schedule date (SCDDATE)

Specifies the date on which the scheduled job is submitted to the job queue and is eligible to run.

If your system or your job is configured to use the Julian date format, *MONTHSTR and *MONTHEND

are calculated as if the system or job did not use the Julian date format.

*CURRENT

The submitted job becomes eligible to run on the current date.

*MONTHSTR

The submitted job becomes eligible to run on the first day of the month. If today is the first day

of the month and the time you specify on the SCDTIME parameter has not passed, the job

becomes eligible to run today. Otherwise, the job becomes eligible on the first day of the next

month.

*MONTHEND

The submitted job becomes eligible to run on the last day of the month. If today is the last day of

the month and the time you specify on the SCDTIME parameter has not passed, the job becomes

eligible to run today. Otherwise, if today is the last day of the month and the time you specify on

the SCDTIME parameter has passed, the job becomes eligible on the last day of the next month.

*MON

The job becomes eligible to run on Monday.

*TUE The job becomes eligible to run on Tuesday.

*WED The job becomes eligible to run on Wednesday.

*THU The job becomes eligible to run on Thursday.

*FRI The job becomes eligible to run on Friday.

*SAT The job becomes eligible to run on Saturday.


*SUN The job becomes eligible to run on Sunday.

date Specify a date in the job date format with or without separators.

Top

Schedule time (SCDTIME)

Specifies the time on the scheduled date at which the job becomes eligible to run.

Note: Although the time can be specified to the second, the load on the system may affect the exact time

at which the submitted job becomes eligible to run.

The order that job entries with identical SCDDATE and SCDTIME values appear on the job queue may

be different than the order in which they arrived. Likewise, these jobs may leave the job queue to be

processed in an order different than the order in which they were entered. Do not assume jobs are

entered or processed sequentially when they are scheduled to start at exactly the same time.

*CURRENT

The job is submitted at the current time.

time Specify the time you want the job to start. The time is specified in 24-hour format and can be

specified with or without a time separator:

v Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh =

hours, mm = minutes, and ss = seconds. Valid values for hh range from 00 to 23. Valid values

for mm and ss range from 00 to 59.

v With a time separator, specify a string of 5 or 8 digits where the time separator specified for

your job is used to separate the hours, minutes, and seconds. If this command is entered from

the command line, the string must be enclosed in apostrophes. If a time separator other than

the separator specified for your job is used, this command will fail.

Top

Job date (DATE)

Specifies the date that is assigned to the job when it is started.

*JOBD

The date specified in the job description is the job date.

*SYSVAL

The value in the QDATE system value at the time the job is started is the job date.

date Specify the value that is used as the job date when the job is started; the date must be specified

in the job date format.

Top

Job switches (SWS)

Specifies the first settings for a group of eight job switches used with this job. These switches can be set

or tested in a CL program and used to control the flow of the program. Only 0’s (off) and 1’s (on) can be

specified in the 8-digit character string.

*JOBD

The value specified in the job description is the first setting for the job’s switches.


character-value

Specify any combination of eight zeros and ones that is used as the first switch setting for the

submitted job.

Top

Allow display by WRKSBMJOB (DSPSBMJOB)

Specifies whether the job being submitted is allowed to be shown on the Work with Submitted Jobs

panel. Any submitted job of the type specified by the Jobs submitted from (SBMFROM) parameter of

the Work with Submitted Jobs (WRKSBMJOB) command can be shown if the job is not prevented by this

parameter.

*YES This job can be shown by the WRKSBMJOB command.

*NO This job is not shown on any display produced by the WRKSBMJOB command.

Top

Submitted for (SBMFOR)

Specifies the job name to be used on the Jobs submitted from (SBMFROM) parameter of the Work with

Submitted Jobs (WRKSBMJOB) command.

Single values

*CURRENT

The name of the currently active job is used.

Qualifier 1: Submitted for

name Specify the name of the job.

Qualifier 2: User

name Specify the user name that identifies the user profile under which the job is run.

Qualifier 3: Number

000000-999999

Specify the job number.

Note: You must have job control (*JOBCTL) special authority to use this parameter.

Top


Specifies the message queue to which a completion message is sent when the submitted job has

completed running, either normally or abnormally. If an abnormal ending occurs, the help information

for the completion message specifies the possible causes.

Single values

*USRPRF

A completion message is sent to the message queue specified in the user profile of the submitter.


*WRKSTN

A completion message is sent to the work station message queue of the work station from which

the job was submitted. If the job is submitted by a batch job, no completion message is sent.

*NONE

No completion message is sent.

Qualifier 1: Message queue

name Specify the name of the message queue to which the completion message is sent.



*CURLIB

The current library for the thread is used to locate the message queue. If no library is specified as

the current library for the thread, the QGPL library is used.

name Specify the library where the message queue is located.

Top

Sort sequence (SRTSEQ)

Specifies the sort sequence table to be used for string comparisons for this job.

Single values

*CURRENT

The sort table specified for the job that is currently running is used.

*USRPRF

The sort table specified in the user profile under which the submitted job initially runs is used.

The user profile is specified on the User (USER) parameter.

*SYSVAL

The system value QSRTSEQ is used.

*HEX A sort sequence table is not used. The hexadecimal values of the characters are used to determine

the sort sequence.

*LANGIDUNQ

A unique-weight sort table is used.

*LANGIDSHR

A shared-weight sort table is used.

Qualifier 1: Sort sequence

name Specify the name of the sort sequence table.



*CURLIB

The current library for the thread is searched. If no library is specified as the current library for

the thread, the QGPL library is used.

name Specify the library where the sort sequence table is located.

Top


Language ID (LANGID)

Specifies the language identifier to be associated with this job. The language identifier is used when

*LANGIDUNQ or *LANGIDSHR is specified on the Sort sequence (SRTSEQ) parameter. If the job

CCSID is 65535, this parameter is also used to determine the value of the job default CCSID (DFTCCSID).

*CURRENT

The language identifier specified for the job that is currently running is used.

*USRPRF

The language ID specified in the user profile under which the submitted job runs is used. The

user profile is specified on the User (USER) parameter.

*SYSVAL

The system value QLANGID is used.

character-value

Specify the language identifier to be used by the job.

Top

Country or region ID (CNTRYID)

Specifies the country or region identifier (ID) to be used by the job.

*CURRENT

The country or region ID specified for the job that is currently running is used.

*USRPRF

The country or region ID specified in the user profile under which the submitted job runs is used.

The user profile is specified on the User (USER) parameter.

*SYSVAL

The system value QCNTRYID is used.

character-value

Specify the country or region ID to be used by the job.

Top

Coded character set ID (CCSID)

Specifies the coded character set identifier (CCSID) used for the submitted job.

*CURRENT

The CCSID specified for the job that is currently running is used.

*USRPRF

The CCSID specified in the user profile where the submitted job initially runs is used.

*SYSVAL

The CCSID specified in the system value QCCSID at the time the job is started is used.

*HEX The CCSID 65535 is used.

1-65535

Specify the CCSID.

Top


Copy environment variables (CPYENVVAR)

Specifies whether the environment variables from the submitting job are copied to the new job.

*NO The environment variables are not copied.

*YES The environment variables are copied.

Top

Allow multiple threads (ALWMLTTHD)

Specifies whether or not the job is allowed to run with multiple user threads. This attribute does not

prevent the operating system from creating system threads in the job. This attribute is not allowed to be

changed after the job is submitted.

*JOBD

The value specified in the job description determines whether or not the job is allowed to run

with multiple user threads.

*NO The job is not allowed to run with multiple user threads.

*YES The job is allowed to run with multiple user threads.

Top

Spooled file action (SPLFACN)

Specifies whether or not spooled files are accessed through job interfaces after the job ends. Keeping

spooled files with jobs allows job commands such as Work with Submitted Jobs (WRKSBMJOB) to work

with the spooled files even after the job has ended. Detaching spooled files from jobs reduces the use of

system resources by allowing job structures to be recycled when the jobs end.

*CURRENT

The value from the current job is used for the submitted job.

*JOBD

The value in the job description is used.

*SYSVAL

The value specified in the system value QSPLFACN is used.

*KEEP

When the job ends, if spooled files for the job exist in the system auxiliary storage pool (ASP 1)

or in a basic user ASP (ASPs 2-32), the spooled files are kept with the job and the status of the job

is updated to indicate that the job has completed. When all remaining spooled files for the job are

in independent ASPs (ASPs 33-255), the spooled files will be detached from the job and the job

will be removed from the system.

*DETACH

When the job ends, the spooled files are detached from the job and the job is removed from the

system.

Top


Examples

Example 1: Submitting a Job

SBMJOB JOB(SPECIAL) JOBD(MYLIB/MYJOBD) CMD(CALL MYPROG)

This command causes the job named SPECIAL to be submitted. Most of the attributes for the job are

taken from the job description MYJOBD, or the job that is currently running, except for the command.

The CALL command is placed on the submitted job’s message queue so that the program MYPROG can

be called and run later.

Example 2: Submitting a Job

SBMJOB JOB(PAYROLL) JOBD(PAYROLL) INQMSGRPY(*RQD)

This command submits a job named PAYROLL to the system. All the information needed for this job

(such as the job queue and routing data but not the inquiry message control value) is contained in the job

description PAYROLL, or the job that is currently running. The library list in effect for the job issuing this

command is used to find the job description. All inquiry messages sent during running of this job

requires the receiver of the inquiry message to reply.

Example 3: Submitting a Job to a Job Queue

SBMJOB JOBD(*USRPRF) JOB(COPY12) JOBQ(NIGHTQ)

CMD(CPYF FILEA FILEB)

This command submits the job COPY12, which uses the job description in the user profile of the

submitting job, to the job queue NIGHTQ. The CMD parameter provides the CL command necessary for

the job to run. A command such as this might be used to copy the file at night while the system is

unattended.

Top

Error messages

*ESCAPE Messages

CPF133A

SBMJOB not allowed during IPL.

CPF1338

Errors occurred on SBMJOB command.

CPF1651

Sort sequence table not accessed.

Top


Submit Network Job (SBMNETJOB)


ParametersExamples

Error messages

The Submit Network Job (SBMNETJOB) command sends an input stream to another user on the SNADS

network. (The input stream is sent to another user where it can be filed, submitted, or rejected.) When the

input stream arrives, its placement is governed by the job action (JOBACN) network attribute. If the

value of JOBACN is *SEARCH, the entry in the network job table at the receiving system is used to

determine the action taken. At the receiving system, the job may be submitted immediately, filed for

placement by the receiving user, or rejected.

When the input stream arrives at the destination system, a message is sent to both the recipient of the

input stream as well as the originator of the input stream stating that the input stream arrived. This

command can only be used to send a batch input stream to a user on a remote system.

Restrictions:

1. To use this command, the user must have object operational and read authority to the file that is

submitted, and for the library that contains the file.

2. The user must be enrolled in the system distribution directory to use this command. (For information

on enrolling in the system distribution directory, see the SNA Distribution Services book, SC41-5410.

3. If the job action (JOBACN) network attribute on the receiving system is set to *SEARCH, there must

be an entry for the user in the network job table on the receiving system. The entry in this table

specifies a user profile on the receiving system that is used to verify that the user is authorized to

submit the job on that system. The user profile on the receiving system must be authorized to use the

job queues, and must have object operational authority for the job descriptions specified by the JOB

commands in the input stream.

4. The file that is submitted cannot contain more than approximately 2 billion bytes of data.

Top

Parameters


FILE File Qualified object name Required,

Positional 1 Qualifier 1: File Name


TOUSRID User ID Values (up to 50 repetitions): Element list Required,

Positional 2 Element 1: User ID Character value

Element 2: Address Character value


Positional 3

PTY Send priority *NORMAL, *HIGH Optional

Top


File (FILE)

Specifies the name and library of the physical file containing the input stream that is sent.




*CURLIB



library-name


Top

User ID (TOUSRID)

Specifies the two-part user ID of one or more users to whom the input stream is submitted, or the name

of one or more distribution lists containing the two-part user IDs of one or more users to whom the file is

to be sent. A combination of both user IDs and distribution lists can be specified on the same command.

Each user ID or distribution list is specified as a two-part name, and both parts are required.

NOTES:

1. Depending on the type of work station being used, the internal value for a user identifier may differ

from the characters shown by the Display Directory Entries (DSPDIRE) command. If the byte-string

value specified for the TOUSRID 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.

2. The user specified in this parameter, or in the distribution list, must be a remote user. The

SBMNETJOB command cannot be used to send input streams to local users.

You can enter multiple values for this parameter.

Top

Member (MBR)

Specifies the member that is sent from the file.

*FIRST

The first member (in creation order) in the file is submitted.

member-name

Specify the name of the file member that is submitted.

Top

Send priority (PTY)

Specifies the queuing priority used for the input stream when it is being routed through a SNADS

network.



*NORMAL

The input stream is sent with a service level priority of data low, which is used for most data

traffic. On a System i5, data low distributions are placed on the normal distribution queue

specified for the route.

*HIGH

The input stream is sent with a service level priority of data high, which is used for high priority

data traffic. On a System i5, data high distributions are placed on the data high distribution

queue specified for the route.

Top

Examples

SBMNETJOB FILE(PAYROLL) TOUSRID(PAYROLL SYSTEM1)

MBR(WEEKLY)

This command sends the input streams contained in member WEEKLY of file PAYROLL to user ID

PAYROLL SYSTEM1.

Top

Error messages

*ESCAPE Messages

CPF8056

File &1 in &2 not a physical file.

CPF8058

File &1 is a spooled file.

CPF8063

Cannot assign necessary resource.

CPF8065

Input stream &1 in &2 member &3 not sent to any users.

CPF8066

One or more user identifiers on this command is not correct.

CPF8068

Error detected while processing file to be sent.

CPF8072

Object to be sent is greater than maximum size of 2GB.

CPF9005

System resource required to complete this request not available.

CPF9006

User not enrolled in system distribution directory.

CPF9803

Cannot allocate object &2 in library &3.

CPF9807


Submit Network Job (SBMNETJOB) 93

CPF9808


CPF9810


CPF9812


CPF9820


CPF9822


CPF9830


CPF9845


CPF9846


CPF9847


CPF9848


CPF9849


Top


Submit Network Server Command (SBMNWSCMD)


ParametersExamples

Error messages

The Submit Network Server Command (SBMNWSCMD) command submits a command to run on the

designated server. For SVRTYPE(*WINDOWS) or (*WINDOWSNT), command output is directed as

specified by the CMDSTDOUT parameter.

Top

Parameters


CMD Command Character value, *NOLOGCMD Required,

Positional 1

SERVER Server Character value Required,

Positional 2

NOLOGCMD Command (not logged) Character value Optional

SVRTYPE Server type *NWSUSRA, *NWSA, *WINDOWS, *WINDOWSNT Optional

CMDTYPE Command type *SVRTYPE, *WINDOWS, *WINDOWSNT Optional

LODUSRPRF Load user profile *YES, *NO Optional

AUTDMN Authentication domain Character value, *PRIMARY, *LOCAL Optional

CMDSTDOUT Command standard output Path name, *JOBLOG, *PRINT Optional

CVTSTDOUT Convert standard output *YES, *NO Optional

Top

Command (CMD)

Specifies the command submitted to the network server. The syntax of the command string specified for

this parameter is not checked.

*NOLOGCMD

Specifies the user wants to submit a command string that is not logged in the joblog. This is

useful if the command string contains sensitive data such as passwords. If *NOLOGCMD is

specified, a command string must be entered on the NOLOGCMD parameter.

command

The command string that is to be submitted to the network server. This command string will be

shown in the joblog.


Top


Server (SERVER)

Specifies the name of the server to which the command is submitted.


Top

Command (not logged) (NOLOGCMD)

Specifies the command string to be submitted to the network server. This command string will not be

echoed to the joblog. Use this parameter to submit commands that contain sensitive data such as

passwords. This parameter is required if, and is only allowed when, CMD(*NOLOGCMD) is specified.

Note: Since the command is being executed on a server, the presence of this option does not prevent the

server from returning the command string as part of the output data. Thus, depending on the command,

it may still be returned and displayed in the job log or spool file.

Top

Server type (SVRTYPE)

Specifies the type of server to which the command is sent.

*NWSUSRA

The server type specified in the network server attributes (CHGNWSUSRA command) for the

user profile running the SBMNWSCMD is used.

*NWSA

The server type specified in the network server attributes (CHGNWSA command) is used.

*WINDOWS or *WINDOWSNT

The server type is Windows. Only Windows commands will run on a local Windows server.

Note: *WINDOWS should be used in V5R4 and later releases. The *WINDOWSNT value is

supported for compatibility with releases prior to V5R4.

Top

Command type (CMDTYPE)

Specifies the type of command string specified in the CMD parameter. This is used by the system to

determine what type of processing needs to occur for the command string.

Note: This parameter is ignored.

*SVRTYPE

The command string is processed based on the type of server specified in the SVRTYPE

parameter. If the server is a *WINDOWS or a *WINDOWSNT server, the command string is

assumed to be a Windows command.

*WINDOWS or *WINDOWSNT

The command string is a Windows command.

Note: *WINDOWS should be used in V5R4 and later releases. The *WINDOWSNT value is

supported for compatibility with releases prior to V5R4.

Top


Load user profile (LODUSRPRF)

Specifies whether or not to load the user profile on the remote server as part of the login environment.

Note: This parameter is only valid when SVRTYPE(*WINDOWS) or (*WINDOWSNT) is specified.

*YES Load the user profile.

*NO Do not load the user profile.

Top

Authentication domain (AUTDMN)

Specifies the Windows domain where the user is authenticated.


*PRIMARY

The user is authenticated on the primary domain of the server.

*LOCAL

The user is authenticated on the local server.

’domain-name’

Specify the domain name where the user is authenticated.

Top

Command standard output (CMDSTDOUT)

Specifies where the standard output returned from the command is to be stored, if any exists. Standard

output can be written to the job log of the job that issues this command, it can be written to a spooled

file, or it can be written to a file. The standard error returned from the command is always directed to the

job log of the job that issues this command, if any exists.


*JOBLOG

The standard output of the network server command is directed to the job log of the job that

issues this command. It shares the job log with the standard error output of the network server

command. Both may be mixed in the job log, depending on the order by which the command

writes standard output and standard error information.

*PRINT

The standard output of the network server command is directed to a spooled file. If

CVTSTDOUT(*YES) is specified, certain control characters such as line feeds and carriage returns

are converted to new lines and other non-displayable control characters such as highlight and

underscore are converted to blanks.

’stream-file-path-name’

Specify the path name of the stream file to which the standard output of the network server

command is directed. The specified path must exist. If the stream file doesn’t exist, it is created. If

the stream file exists, all data is overlaid. Additional information about path name is in the

Integrated file system topic collection in the i5/OS Information Center at http://www.ibm.com/systems/i/infocenter/ book.

Submit Network Server Command (SBMNWSCMD) 97

Top

Convert standard output (CVTSTDOUT)

Specifies whether the standard output will be converted from the server’s code set to the CCSID of the

i5/OS user profile that submitted the command. For binary output, CVTSTDOUT(*NO) should be

specified.

Note: This parameter is only valid when CMDSTDOUT(*PRINT) or CMDSTDOUT(stream-file-path-name)

is specified.

*YES The output is converted from the server’s code set to the CCSID of the i5/OS user profile that

submitted the command.

*NO The output is not converted from the server’s code set.

Top

Examples

Example 1: Submitting a Windows Command

SBMNWSCMD CMD(’net config server’) SERVER(WINSVR)

CMDSTDOUT(*JOBLOG)

This command will display the Windows Server service settings on the Windows server WINSVR.

Standard output from the command is returned to i5/OS and directed to the job log.

Top

Error messages

*ESCAPE Messages

CPFA43F

Network server command not submitted.

CPFA46C

Unable to complete command processing on server &1.

CPFA46F

Network server description &1 not found.

Top


Submit Remote Command (SBMRMTCMD)


ParametersExamples

Error messages

The Submit Remote Command (SBMRMTCMD) command sends a CL command through Distributed

Data Management (DDM) to be run on the target system specified by a DDM file. The DDM file

determines the communications line used, and indirectly identifies the target system that receives the

submitted command.

This command sends only CL commands to a remote system which supports the SBMRMTCMD

command language. It cannot send non-CL commands to a different system type (for example, OCL

commands cannot be sent to a target System/36).

The primary purpose of this command is to allow a source system user or program to perform file

management operations and file authorization activities on files located on a target system.

v Create or delete physical, logical, device, or source files

v Grant or revoke object authority to remote files

v Check, rename, or move files or other objects

v Save or restore files or other objects

Restrictions:

v File processing on the target system operates independently of processing on the source system.

Commands dependent on a specific recursion level or request level may not function as expected.

v Output (such as spooled files) generated by a submitted command exists only on the target system.

The output is not sent back to the source system. Therefore display commands or commands that are

used to service programs should not be sent because the output results remain at the target system.

v Translation is not performed for impromptu messages caused by target system errors, because they are

not stored on the system; the text for an impromptu message is sent directly to the source system and

displayed. The message identifier of all other message types generated on the remote system is sent

back to the source system. The message text that exists for the message identifier on the source system

is displayed as it would be for the same error on the source system.

v A maximum of 10 messages, generated during the running of a submitted command, can be sent by

the target system to the source system. If more than 10 messages are generated, an additional

informational message is sent that indicates that the messages exist in the job log for the target job on

the target system. If one of those messages is an escape message, the first nine messages of other types

are sent, followed by the informational message and the escape message.

v In multithreaded jobs, this command is not threadsafe and fails for DDM files of type *SNA.

Top

Parameters


CMD Command to run Character value Required,

Positional 1



DDMFILE DDM file Qualified object name Required,

Positional 2 Qualifier 1: DDM file Name


Top

Command to run (CMD)

Specifies a character string of up to 2000 characters that represents a command that is run on the target

system. The command must be allowed in both batch and interactive environments on the target system.

The command must be enclosed in apostrophes if it contains embedded blanks or special characters. The

command must use the syntax of the target system.


Note: The normal rule of pairing apostrophes in quoted strings on the local system must be doubled when

the same string is submitted to a remote system. This is required to allow coding a quoted string within

another quoted string.

Top

DDM file (DDMFILE)

Specifies the name and library of the Distributed Data Management (DDM) file that is used to submit the

command to the target system. The DDM file is used only to determine the remote location representing

the target system. The remote file name associated with the DDM file is ignored by this command.




*CURLIB


library for the job, the QGPL library is used.

library-name


Top

Examples

Example 1: Deleting a File

SBMRMTCMD CMD(’DLTF LIBX/FRED’) DDMFILE(DENVER)

This command deletes the file named FRED in library LIBX on the target system that is associated with

the DDM file named DENVER.

Example 2: Creating a Physical File


SBMRMTCMD CMD(’CRTPF SALES/CAR QGPL/QDDSSRC MASTER’)

DDMFILE(DENVER)

This command creates the physical file CAR in library SALES using the data description specifications

(DDS) in the source file QDDSSRC and source member named MASTER in the QGPL library. The DDS

must already exist on the target system identified by the DDM file named DENVER in the target job’s

library list.

Example 3: Changing the Text Description

SBMRMTCMD CMD(’CHGDDMF FILE(LIBX/STANLEY)

TEXT(’’Don’’’’t forget to pair apostrophes.’’)’)

DDMFILE(SMITH)

This command changes the text in the description of the DDM file named STANLEY which is stored in

library LIBX. Because the submitted command requires an outside set of single apostrophes (for the CMD

parameter), each single or double apostrophe normally required in the TEXT parameter for local system

processing must be doubled for remote system processing. The coding above produces a single apostrophe

in the text when it is shown or printed on the remote system.

Example 4: Creating a DDM File

SBMRMTCMD CMD(’CRTDDMF FILE(SALES/MONTHLY)

RMTFILE(*NONSTD ’’CAR.SALES(JULY)’’

RMTLOCNAME(DALLAS)’)

DDMFILE(CHICAGO)

This command creates (on the target system identified by the information in the DDM file named

CHICAGO) another DDM file named MONTHLY. The new DDM file is stored in a library named SALES

on the CHICAGO system. The new DDM file on the CHICAGO system is used to access a file and

member on a different system named DALLAS. The accessed file is named SALES/CAR and the member

name in the file is JULY.

Note that this CRTDDMF command string contains three sets of single apostrophes: one set to enclose the

entire command being submitted, and a double set to enclose the file and member named in the

RMTFILE parameter. This is how any i5/OS file member name must be specified on the SBMRMTCMD

command, because of the parentheses needed to enclose the member name.

Example 5: Replacing a Portion of the Library List

SBMRMTCMD CMD(’RPLLIBL LIBL(QGPL QTEMP SALES EVANS)’)

DDMFILE(EVANS)

This command replaces the user’s portion of the library list being used by the target job associated with

the DDM file named EVANS, which is being used by the source job in which this SBMRMTCMD

command is being submitted. In that source job, if there are other open DDM files that specify the same

device and mode, this library list is used for them also.

Top

Submit Remote Command (SBMRMTCMD) 101

Error messages

*ESCAPE Messages

CPF9164

Target system does not support SBMRMTCMD.

CPF9165

File &1 in library &2 not a DDM File.

CPF917A

Error occurred on distributed file.

CPF917B

Target system &3 not available.

CPF9172

SBMRMTCMD command ended abnormally.

CPF9174

Error on call to user exit program on target system.

CPF9175

Error during processing of user exit program.

CPF9177

User exit program did not complete successfully.

CPF9178

Processing of the command specified by SBMRMTCMD failed.

CPF9182

Cannot start DDM communications.

Top


Select (SELECT)

Where allowed to run:

v Batch program (*BPGM)

v Interactive program (*IPGM)

Threadsafe: Yes

ParametersExamples

Error messages

The Select (SELECT) command begins a control structure to allow conditional processing of command

groups. The select group is ended with an End Select (ENDSELECT) command and must contain one or

more When (WHEN) commands and optionally an otherwise (OTHERWISE) command.

When a Select command is entered, the condition specified on the first When command is evaluated. If

the condition is true, the command specified on the THEN parameter is run. After the command or

group of commands is processed, control will pass to the matching ENDSELECT command. Only one

WHEN or the optional OTHERWISE will be processed within a SELECT group.

If the first WHEN condition is not true, subsequent WHEN commands are evaluated in the order

specified. If no WHEN command condition is true, control will pass to the command specified on the

OTHERWISE command, if OTHERWISE is specified.

Restrictions:

v This command is valid only within a CL program or ILE CL procedure.

v Up to 25 levels of nested SELECT commands are allowed.

There are no parameters for this command.

Top

Parameters

None

Top

Examples

DCL VAR(&INT) TYPE(*INT) LEN(4)

:

SELECT

WHEN COND(&INT *LT 0) THEN(DO)

: (group of CL commands)

ENDDO

WHEN COND(&INT *EQ 0) /* Do nothing when zero */

WHEN COND(&INT *GT 0) THEN(CHGVAR &INT (&INT - 1)

ENDSELECT

The SELECT command group will evaluates the conditions of the WHEN commands in the order they

are encountered. When a COND parameter results in a true value, the command specified on the THEN

parameter is processed. After the command on the THEN parameter is processed, control passes to the

command following the ENDSELECT command.


Top

Error messages

None

Top


Set ASP Group (SETASPGRP)


ParametersExamples

Error messages

The Set Auxiliary Storage Pool Group (SETASPGRP) command sets the auxiliary storage pool (ASP)

group for the current thread. Additionally, this command allows you to change the libraries in the library

list for the current thread. If an ASP group had already been set, this command will remove the old ASP

group from the current thread and set the specified ASP group for the current thread. Once the specified

ASP group has been set for the current thread, all libraries in the independent ASPs in the ASP group are

accessible and objects in those libraries can be referenced using regular library-qualified object name

syntax. The libraries in the independent ASPs in the specified ASP group plus the libraries in the system

ASP (ASP number 1) and basic user ASPs (ASP numbers 2-32) form the library name space for the thread.

All libraries in the library list need to be in the new library name space or the library list is not changed

and the new ASP group is not set.

Restrictions:

v You must have use (*USE) authority to all ASP device descriptions in the ASP group and to all the

specified libraries in the library list before the library name space and the library list are changed. If

you are not authorized to an ASP device description or to one of the libraries, the ASP group will not

be set and the library list will not be changed.

v When *CURUSR is specified for the ASP group (ASPGRP) or Libraries for current thread (USRLIBL)

parameter, you must have read (*READ) authority to the job description listed in your user profile and

execute (*EXECUTE) authority to the library where the job description is located.

v The SETASPGRP command is not allowed in the following:

– System jobs QPFRADJ, QJOBSCD, QSYSARB, QSYSARB3, QSYSARB4 and QLUS.

– All subsystem monitor jobs.

– DDM, DRDA, database host server and SQL server jobs once the initial namespace has been

established.

– Receive Journal Entry (RCVJRNE) and Delete Journal Receiver (DLTJRNRCV) command exit

programs.

– Management Central Registered Inventory Gathering Service (RIGS) Exit Programs (exit point

QIBM_QYIV_INVGTRSRV).

– Trigger or format selector programs that run as part of database I/O operations.

– Attention programs (the PGM parameter of the SETATNPGM command).

– Break handling programs (the PGM parameter of the CHGMSGQ command).

– Programming Development Manager (PDM) functions.

Top

Parameters


ASPGRP ASP group Name, *CURUSR, *NONE Required,

Positional 1

SYSLIBL System library list *CURSYSBAS, *SYSVAL Optional

CURLIB Current library Name, *CURSYSBAS, *CURUSR, *CRTDFT Optional



USRLIBL Libraries for current thread Single values: *CURSYSBAS, *CURUSR, *SYSVAL,

*NONEOther values (up to 250 repetitions): Name

Optional

Top

ASP group (ASPGRP)

Specifies the name of the auxiliary storage pool (ASP) group to set for the current thread. The ASP group

name is the name of the primary ASP device within the ASP group.


*CURUSR

The ASP group is set to the value defined for the Initial ASP group (INLASPGRP) in the default

job description of the user profile that the thread is currently running under.

*NONE

Specify for the current thread to have no ASP group. The library name space will not include

libraries from any ASP group. Only the libraries in the system ASP and any basic user ASPs will

be in the library name space.

name Specify the name of the primary ASP in the ASP group to be set for the current thread. All

libraries from all ASPs in this ASP group will be included in the library name space.

Top

System library list (SYSLIBL)

Specifies the system part of the library list for the thread in which the command is entered.

*CURSYSBAS

The libraries in the system part of the library list of the current thread that are found in the

system ASP (ASP number 1) or any configured basic user ASP (ASP numbers 2-32) are used as

the new system part of the library list.

*SYSVAL

The system part of the library list of the current thread is set from the current value of system

value QSYSLIBL.

Top


Specifies the library to be used in the current library entry of the library list for the thread. If *CURUSR

or a library name is specified and the library cannot be found in the new library name space, an error

message is sent and the library list and ASP group are not changed.

*CURSYSBAS

The library name in the current library entry of the library list is used as the new current library

if the library is found in the system ASP (ASP number 1) or any configured basic user ASP (ASP

numbers 2-32). If the library name in the current entry is not found in the system ASP or any

basic user ASP, the current library entry will be removed from the library list.


*CURUSR

The current library is set to the value defined for the Current library (CURLIB) attribute of the

user profile that the thread is currently running under.

*CRTDFT

Changes the library list to remove any name from the current library entry. If objects are created

specifying *CURLIB for the library name, library QGPL will be used.

name Specify the name of the library that replaces the current library entry in the library list.

Top

Libraries for current thread (USRLIBL)

Specifies the libraries that are placed in the user part of the library list. If *CURUSR or a list of library

names is specified and any of these libraries cannot be found in the new library name space, an error

message is sent and the library list and ASP group are not changed.

Single values

*CURSYSBAS

The libraries in the user part of the library list of the current thread that are found in the system

ASP (ASP number 1) or any configured basic user ASP (ASP numbers 2-32) are used as the new

user part of the library list.

*CURUSR

The user part of the library list for the thread is set to the value defined for the Initial library list

(INLLIBL) in the default job description of the user profile that the thread is currently running

under.

*SYSVAL

The user part of the library list is set from the current value of system value QUSRLIBL.

*NONE

Changes the user part of the library list to remove all library names.


name Specify the names of the libraries to be used as the user part of the library list, in the order in

which they are to be searched.

Top

Examples

Example 1: Set New ASP Group

SETASPGRP ASPGRP(WAREHOUSE1) SYSLIBL(*SYSVAL) CURLIB(*CURUSR)

USRLIBL(*CURSYSBAS)

This command will set the auxiliary storage pool (ASP) group for the thread in which the command runs

to be WAREHOUSE1. This will change the library name space for the thread to include all libraries in

any of the independent ASPs in the ASP group identified by the independent ASP device named

WAREHOUSE1. The system part of the library list will be set from system value QSYSLIBL. The current

library entry of the library list will be set from the Current library value defined in the user profile that

Set ASP Group (SETASPGRP) 107

the thread is currently running under. The user part of the library list will be set using the current user

part of the library list and removing any libraries that are not found in the system ASP or configured

basic user ASPs.

Example 2: Set to No ASP Group

SETASPGRP ASPGRP(*NONE) SYSLIBL(*CURSYSBAS) CURLIB(*CRTDFT)

USRLIBL(*NONE)

This command will remove any ASP group for the thread in which the command runs. This will change

the library name space for the thread to include only those libraries in the system ASP (ASP number 1)

and basic user ASPs (ASP numbers 2-32). The system part of the library list will be set using the current

system part of the library list and removing any libraries that are not found in the system ASP or

configured basic user ASPs. The current library entry of the library list will be changed to be empty

which will cause library QGPL to be used as the current library. The user part of the library list will be

changed to be empty.

Top

Error messages

*ESCAPE Messages

CPFB8E9

ASP group &1 not set for thread &2.

Top


Set Attention Program (SETATNPGM)



ParametersExamples

Error messages

The Set Attention Program (SETATNPGM) command sets up a program that is called when the Attention

key is pressed. The setting is in effect for this recursion level and lower levels if more programs are

called, but it is no longer in effect if the job returns from this recursion level to the previous one. If the

Attention key handler’s status is on, the specified program is called when the key is pressed. No

parameters are passed to the Attention key handler when it is called. The Attention handling program

runs in the same process with the same job attributes, overrides, and group authorities as the program

that issued the SETATNPGM command. However, program adopted authority is not carried over.

The handling of the attention key does not change the auxiliary storage pool (ASP) group that is in effect.

The ASP group determines the library name space of the thread. If the attention handling program

resides in an independent ASP and if that ASP is not part of the library name space for the thread at the

time the attention key is handled, the intended program will not be found. To avoid potential problems

when applications change the library name space, the program should reside in the system ASP or a basic

user ASP.

Top

Parameters


PGM Program Single values: *CURRENT, *PRVINVLVLOther values: Qualified object name

Required,

Positional 1

Qualifier 1: Program Name


SET Set attention key *ON, *OFF Optional,

Positional 2

Top

Program (PGM)

Specifies the qualified name of the program to be the Attention key handler at this recursion level.


Single values

*CURRENT

The program name of the Attention key handler currently in effect is used as the value of this

parameter.

*PRVINVLVL

The Attention key handler in effect at the previous recursion level is reinstated as the Attention

key handler at this recursion level. The Set attention key (SET) parameter is not allowed if this


special value is specified, because the SET status of the previous recursion level is also reinstated.

This option is used when a program has specified an Attention program and wants to revert back

to a previous level.

Qualifier 1: Program

name Specify the name of the Attention key handler program.


*LIBL All libraries in the thread’s library list are searched until a match is found.

*CURLIB

The current library for the thread is used to locate the object. If no library is specified as the


name Specify the library where the attention program is located.

Top

Set attention key (SET)

Specifies whether the Attention key handler indicated in the Program (PGM) parameter is called when

the Attention key is pressed. This parameter is not allowed if *PRVINVLVL is specified for the PGM

parameter.

*ON The Attention key handler specified in the Program (PGM) parameter is called when the

Attention key is pressed.

*OFF The Attention key handler specified in the Program (PGM) parameter is not called when the

Attention key is pressed.

Top

Examples

Example 1: Setting the ATTN Key Handler

SETATNPGM PGM(QGPL/ATTN) SET(*ON)

This command causes the program QGPL/ATTN to become the ATTN key handler. Because SET(*ON) is

specified, the program is called when the ATTN key is pressed.

Example 2: Setting the Attention Key Off

SETATNPGM PGM(*CURRENT) SET(*OFF)

The current attention handling program has its status changed to SET(*OFF). Because the status is

SET(*OFF) when the ATTN key is pressed, the attention handling program is not called.

Example 3: Previous Recursion-Level Support

SETATNPGM PGM(*PRVINVLVL)


The attention handling program and status that was in effect at the previous recursion level is reinstated

at this recursion level. If no attention handler is in effect, after this command is run nothing happens

when the ATTN key is pressed.

Example 4: Emulating the System Request Key

SETATNPGM PGM(QWSSYSRQ)

The system-supplied program QWSSYSRQ will be called when the ATTN key is pressed. This system

program allows the ATTN key to act as a system request key by showing the system request menu on the

display when the ATTN key is pressed.

Top

Error messages

*ESCAPE Messages

CPF1318

Attention key program &1 in &2 not set.

Top

Set Attention Program (SETATNPGM) 111

Set Customization Data (SETCSTDTA)


ParametersExamples

Error messages

The Set Customization Data (SETCSTDTA) command can be used to copy and delete information in

order to customize data, such as work area content and mouse double-click action values, for Graphical

Operations support.

Using this command, administrators can set up users by getting information from a named user profile

and copying it to other user profiles. Administrators can also remove the customized values for a named

user, and choose to replace those customized values with data from a named user profile.

Note: Do not precede an entry with an asterisk unless that entry is a ″special value″ that is shown (on the

display itself or in the help information) with an asterisk.

Error messages for SETCSTDTA

*ESCAPE Messages

CPF2204

User profile &1 not found.

CPF2217

Not authorized to user profile &1.

GUI0085

&1 does not have customization data.

GUI0087

Some user profiles did not have customization data copied successfully.

GUI0091

Some user profiles did not have customization data deleted successfully.

GUI0117

&1 is not valid for subset key.

Top

Parameters


USRPRF User profile Values (up to 300 repetitions): Simple name Required,

Positional 1

VALUE Customization data to use Simple name, *NONE Required,

Positional 2

REPLACE Replace customization data *NO, *YES Optional,

Positional 3

Top


User profile (USRPRF)

Specifies the names of the user profiles for which customized values are to be set or removed with the

option to set them again. A maximum of 300 user profiles can be named.

You can enter multiple values for this parameter. If you are on an entry display and you need additional

entry fields to enter these multiple values, type a plus sign (+) in the entry field opposite the phrase ″+

for more″, and press the Enter key.


Top

Customization data to use (VALUE)

Specifies the customization data value to which the user profile named on the User profile prompt

(USRPRF parameter) is to be set.


*NONE

The customization data is to be removed from the user profile and no customization value is to

be set.

user-profile

Specify the name of the user profile from which the customization value data is to be copied and

set.


Top

Replace customization data (REPLACE)

Specifies whether to replace existing customization data if the user profile named on the User profile

prompt (USRPRF parameter) has customization data.


*NO The existing customization data is not replaced. An exception message is issued.

*YES The existing customization data is replaced with the customization data from the user profile

specified on the Customization data to use prompt (VALUE parameter).

Top

Examples

None

Top

Error messages

*ESCAPE Messages


CPF2204

User profile &1 not found.

CPF2217

Not authorized to user profile &1.

GUI0085

&1 does not have customization data.

GUI0087

Some user profiles did not have customization data copied successfully.

GUI0091

Some user profiles did not have customization data deleted successfully.

GUI0117

&1 is not valid for subset key.

Top

Set Customization Data (SETCSTDTA) 115

Set Keyboard Map (SETKBDMAP)


ParametersExamples

Error messages

The Set Keyboard Map (SETKBDMAP) command allows the user to override the PA (Program Attention)

and PF (Program Function) key assignment defaults provided by the system.

This command assigns the specified F-to-PF map to the device where the command was entered (if it is a

3270 display station device) or to the 3270 display station specified if the user has authority to that

device. More information on the user-assignment keyboard mapping is in Remote Work Station Support

book, SC41-5402 book.

Top

Parameters


DEV Device Name, *REQUESTER Optional,

Positional 1

PF1 PF1 key value *HELP, *ATTN, *HLP3270, *CLEAR, *PRINT, *DSPATR,

*TEST, *DOWN, *UP, *NONE, *RESET, *SYSREQ,

*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional

PF2 PF2 key value *ATTN, *HELP, *HLP3270, *CLEAR, *PRINT, *DSPATR,


*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional





*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional

PF9 PF9 key value *NONE, *ATTN, *HELP, *HLP3270, *CLEAR, *PRINT,

*DSPATR, *TEST, *DOWN, *UP, *RESET, *SYSREQ,

*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional





*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional

PA1PF1 PA1-PF1 key value *ATTN, *HELP, *HLP3270, *CLEAR, *PRINT, *DSPATR,


*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional

Set Keyboard Map (SETKBDMAP) 119




*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional





*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional



*BCKSPC, *F13, *F14, *F15, *F16, *F17, *F18, *F19, *F20,

*F21, *F22, *F23, *F24, *F1, *F2, *F3, *F4, *F5, *F6, *F7, *F8,

*F9, *F10, *F11, *F12

Optional

Top

Device (DEV)

Specifies a valid 3270 display station that is assigned this keyboard mapping function.


*REQUESTER

This mapping is assigned to the device where the command is entered.

device-name

Specify the name of the device to which the new keyboard mapping is to apply. You must have

allocation rights to the specified device.

Top

PF1 key value (PF1)

Each valid key or key sequence is a separate parameter which, except for restrictions as noted, can be

assigned any function. If you do not specify a function for a particular key or key sequence, the function

currently assigned to that key or key sequence remains the same.

The possible functions that can be assigned are:

*HELP

5250 Help

*HLP3270

3270 Help Text (Display Active Keyboard Map)


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR

Display Imbedded Attributes

*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24

F1 through F24 Function Keys

Restrictions:

*HELP, *HLP3270, and *RESET must be assigned to one of the following 12-key sets of function keys:

v PF1 through PF12

v PA1/PF1 through PF12


The *HELP, *HLP3270, and *RESET functions are required for 3270 display station device support to

function properly. Since not all 3270 keyboards have 24 PF keys, *HELP, *HLP3270, or *RESET may not be

assigned to keys PF13 through PF24, unless these functions are also assigned to one of the three sets

listed above.

It is recommended that *F1 and *SYSREQ both also be assigned to one of the three sets.

The value *ATTN cannot be explicitly assigned to a 3270 remote attach display station. If the default

value *ATTN is taken, the value *NONE is substituted. However, if the value *ATTN is explicitly chosen,

a diagnostic message is sent.

Top


PF2 key value (PF2)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.






Top

PF3 key value (PF3)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12







listed above.





Top

PF4 key value (PF4)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:



v PF1 through PF12






listed above.





Top

PF5 key value (PF5)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace


*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top

PF6 key value (PF6)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment


*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top

PF7 key value (PF7)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request


*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top

PF8 key value (PF8)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen


*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top

PF9 key value (PF9)






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top


PF10 key value (PF10)





*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.






Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12







listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:



v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace


*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment


*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request


*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen


*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top







*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top







*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.






Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12







listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:



v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace


*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment


*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen

*PRINT

Print Screen

*DSPATR


*TEST Test Request


*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top






*HELP

5250 Help

*HLP3270


*CLEAR

Clear Screen


*PRINT

Print Screen

*DSPATR


*TEST Test Request

*DOWN

Roll Down

*UP Roll Up

*NONE

No Assignment

*RESET

Error Reset

*SYSREQ

System Request

*BCKSPC

Record Backspace

*ATTN

Attention

*F1-*F24


Restrictions:


v PF1 through PF12






listed above.





Top

PA1-PF1 key value (PA1PF1)




