IDCAMS Parameter Description
IDCAMS is the utility which is used to perform utility functions on VSAM
files. This section defines the more common IDCAMS functions which a
programmer will typically need to define, load and maintain VSAM files.
Notation used in the following parameters
{OPT1|OPT2|OPT3} Pick one of the available options
First option is ususally the default
[optional entry] Entry may be used but is not required
UPPERCASE Required syntax
lowercase User supplied value
/* comments */ Comments may be entered between these delimiters
Alter Parameters
Key Words Abbreviation
ALTER
entryname[/password]
[ADDVOLUMES(volser[ volser...])] AVOL
[ATTEMPTS(number)] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[BUFND] BFND
[BUFNI] BFNI
[BUFFERSPACE(size)] BUFSP,BUFSPC
[CATALOG(catname[/password])] CAT
[CODE(code)] -
[CONTROLPW(password)] CTLPW
[{DESTAGEWAIT|NODESTAGEWAIT}] DSTGW NDSTGW
[{EMPTY|NOEMPTY}] EMP NEMP
[{ERASE|NOERASE}] ERAS NERAS
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[FREESPACE(CI-percent CA-percent)] FSPC
[{INHIBIT|UNINHIBIT}] INH UNINH
[KEYS(length offset)] -
[LOCK|UNLOCK] -
[MASTERPW(password)] MRPW
[NEWNAME(newname)] NEWNM
[NULLIFY( NULL
[AUTHORIZATION({MODULE|STRING})] AUTH MDLE STRG
[CODE] -
[CONTROLPW] CTLPW
[EXCEPTIONEXIT] EEXT
[MASTERPW] -
[OWNER] -
[READPW] RDPW
[RETENTION] RETN
[UPDATEPW] )] UPDPW
[OWNER(ownerid)] -
[READPW(password)] RDPW
[RECORDSIZE(averge maximum)] RECSZ
[REMOVEVOLUMES(volser[ volser ...])] RVOL
[{SCRATCH|NOSCRATCH}] SCR NSCR
[SHAREOPTIONS(crossregion[ crosssystem])] SHR
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[STRNO] -
[{TO(date|FOR(days)}] -
[TYPE(LINEAR)] - LIN
[{UNIQUEKEY|NONUNIQUEKEY}] UNQK NUNQK
[{UPDATE|NOUPDATE}] UPD NUPD
[UPDATEPW(password)] UPDPW
[{UPGRADE|NOUPGRADE}] UPG NUPG
[{WRITECHECK|NOWRITECHECK}] WCK NWCK
Build Alternate Index
Key Words Abbreviation
BLDINDEX BIX
{INFILE(ddname[/password]) | IFILE
INDATASET(entryname[/password])} IDS
{OUTFILE(ddname[/password] OFILE
[ ddname[/password] ...]) |
OUTDATASET(entryname[/password] ODS
[ entryname[/password] ...])}
[CATALOG(catname[/password])] CAT
[INTERNALSORT|EXTERNALSORT] ISORT ESORT
[WORKFILES(ddname ddname)] WFILE
Define Alternate Index
Key Words Abbreviation
DEFINE ALTERNATEINDEX DEF AIX
(NAME(entryname) -
RELATE(entryname[/password]) REL
{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])} TRK
VOLUMES(volser[ volser ...]) VOL
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[BUFFERSPACE(size)] BUFSP, BUFSPC
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[{NOERASE|ERASE}] NERAS ERAS
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[FREESPACE{(0 0)|(CI-percent[ CA-percent])}] FSPC
[{NOIMBED|IMBED}] NIMBD IMBD
[KEYRANGES((lowkey highkey)[(lowkey highkey) ...])] KRNG
[KEYS{(64 0)|(length offset)] -
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[{NORECATALOG|RECATALOG}] NRCTLG RCTLG
[RECORDSIZE{(4086 32600)|(average maximum)}] RECSZ
[{NOREPLICATE|REPLICATE}] NREPL REPL
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{RECOVERY|SPEED}] RCVY -
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[{TO(date)|FOR(days)}] -
[{NONUNIQUEKEY|UNIQUEKEY}] NUNQK UNQK
[UPDATEPW(password)] UPDPW
[{UPGRADE|NOUPGRADE}] UPG NUPG
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[DATA ( -
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[BUFFERSPACE(size)] BUFSP, BUFSPC
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])}] TRK
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[{NOERASE|ERASE}] NERAS ERAS
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[FREESPACE{(0 0)|(CI-percent[ CA-percent])}] FSPC
[KEYRANGES((lowkey highkey)[(lowkey highkey) ...])] KRNG
[KEYS{(64 0)|(length offset)] -
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[NAME(entryname)] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[RECORDSIZE{(4086 32600)|(average maximum)}] RECSZ
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{RECOVERY|SPEED}] RCVY -
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[{NONUNIQUEKEY|UNIQUEKEY}] NUNQK UNQK
[UPDATEPW(password)] UPDPW
[VOLUMES(volser[ volser ...])] VOL
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[INDEX ( -
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])}] TRK
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[{NOIMBED|IMBED}] NIMBD IMBD
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[NAME(entryname)] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[UPDATEPW(password)] UPDPW
[VOLUMES(volser[ volser ...])] VOL
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[CATALOG(catname[/password])] CAT
Define Cluster
Key Words Abbreviation
DEFINE CLUSTER DEF AIX
(NAME(entryname) -
{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])} TRK
VOLUMES(volser[ volser ...]) VOL
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[BUFFERSPACE(size)] BUFSP, BUFSPC
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[{NOERASE|ERASE}] NERAS ERAS
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[FREESPACE{(0 0)|(CI-percent[ CA-percent])}] FSPC
[{NOIMBED|IMBED}] NIMBD IMBD
[{INDEXED|LINEAR|NONINDEXED|NUMBERED}] IXD LIN NIXD NUMD
[KEYRANGES((lowkey highkey)[(lowkey highkey) ...])] KRNG
[KEYS{(64 0)|(length offset)] -
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[{NORECATALOG|RECATALOG}] NRCTLG RCTLG
[RECORDSIZE{(4086 32600)|(average maximum)}] RECSZ
[{NOREPLICATE|REPLICATE}] NREPL REPL
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{RECOVERY|SPEED}] RCVY -
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[{TO(date)|FOR(days)}] -
[UPDATEPW(password)] UPDPW
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[DATA ( -
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[BUFFERSPACE(size)] BUFSP, BUFSPC
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])}] TRK
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[{NOERASE|ERASE}] NERAS ERAS
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[FREESPACE{(0 0)|(CI-percent[ CA-percent])}] FSPC
[KEYRANGES((lowkey highkey)[(lowkey highkey) ...])] KRNG
[KEYS{(64 0)|(length offset)] -
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[NAME(entryname)] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[RECORDSIZE{(4086 32600)|(average maximum)}] RECSZ
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{NONSPANNED|SPANNED}] NSPND SPND
[{RECOVERY|SPEED}] RCVY -
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[{UNIQUE|SUBALLOCATION}] UNQ SUBAL
[UPDATEPW(password)] UPDPW
[VOLUMES(volser[ volser ...])] VOL
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[INDEX ( -
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[CODE(code)] -
[CONTROLINTERVALSIZE(size)] CISZ, CNVSZ
[CONTROLPW(password)] CTLPW
[{CYLINDERS(primary[ secondary]) | CYL
RECORDS(primary[ secondary]) | REC
TRACKS(primary[ secondary])}] TRK
[{NODESTAGEWAIT|DESTAGEWAIT}] NDSTGW DSTGW
[EXCEPTIONEXIT(entrypoint)] EEXT
[FILE(ddname)] -
[{NOIMBED|IMBED}] NIMBD IMBD
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[NAME(entryname)] -
[{UNORDERED|ORDERED}] UNORD ORD
[OWNER(ownerid)] -
[READPW(password)] RDPW
[{NOREPLICATE|REPLICATE}] NREPL REPL
[{NOREUSE|REUSE}] NRUS RUS
[SHAROPTIONS{(1 3)|(crossregion[ crosssystem])}] SHR
[{STAGE|BIND|CYLINDERFAULT}] - - CYLF
[UPDATEPW(password)] UPDPW
[VOLUMES(volser[ volser ...])] VOL
[{NOWRITECHECK|WRITECHECK}] ) NWCK WCK
[CATALOG(catname[/password])] CAT
Define Path
Key Words Abbreviation
DEFINE PATH ( DEF -
NAME(entryname) -
PATHENTRY(entryname[/password]) PENT
[ATTEMPTS({2|number})] ATT
[AUTHORIZATION(entrypoint[ string])] AUTH
[CODE(code)] -
[CONTROLPW(password)] CTLPW
[MASTERPW(password)] MRPW
[MODEL(entryname[/password][ catname[/password]])] -
[OWNER(ownerid)] -
[READPW(password)] RDPW
[{NORECATALOG|RECATALOG}] NRCTLG RCTLG
[{TO(date)|FOR(days)}] -
[{UPDATE|NOUPDATE}] UPD NUPD
[UPDATEPW(password)] ) UPDPW
[CATALOG(catname[/password])] CAT
Delete AIX Cluster Path
Key Words Abbreviation
DELETE DEL
(entryname[/password][ entryname[/password] ...]) -
{ALIAS| -
ALTERNATEINDEX| AIX
CLUSTER| CL
NONVSAM| NVSAM
PATH| -
USERCATALOG| UCAT
VVR} -
[{NOERASE|ERASE}] NERAS ERAS
[FILE(ddname)] -
[{NOFORCE|FORCE}] NFRC FRC
[{NOPURGE|PURGE}] NPRG PRG
[{NORECOVERY|RECOVERY}] NRCVRY RCVRY
[{SCRATCH|NOSCRATCH}] SCR NSCR
[CATALOG(catname[/password])] CAT
List Catalog Entries
Key Words Abbreviation
LISTCAT LISTC
{ALIAS| -
ALTERNATEINDEX| AIX
CLUSTER| CL
NONVSAM| NVSAM
PATH| -
USERCATALOG| UCAT
VVR} -
[CREATION(days)] CREAT
[ENTRIES(entryname[/password] ENT
[ entryname[/password] ...])
[EXPIRATION(days)] EXPIR
[FILE(ddname)] -
[{NAME|HISTORY|VOLUME|ALLOCATION|ALL}] - HIST VOL ALLOC -
[OUTFILE(ddname)] OFILE
[CATALOG(catname[/password])] CAT
Print Files or Records
Key Words Abbreviation
PRINT -
{INFILE(ddname[/password]) | IFILE
INDATASET(entryname[/password])} IDS
[OUTFILE(ddname)] OFILE
[{DUMP|CHARACTER|HEX}] - CHAR -
[{FROMKEY(key)|FROMADDRESS(address)| FKEY FADDR
FROMNUMBER(number)|SKIP(number)}] FNUM -
[{TOKEY(key)|TOADDRESS(address)| - TADDR
TONUMBER(number)|COUNT(number)}] TNUM -
Copy from or to VSAM Files
Key Words Abbreviation
REPRO -
{INFILE(ddname[/password] IFILE
[ENVIRONMENT(DUMMY)]) | ENV DUM
INDATASET(entryname[/password] IDS
[ENVIRONMENT(DUMMY)]) ENV DUM
{OUTFILE(ddname[/password] | OFILE
OUTDATASET(entryname[/password])} ODS
[ENTRIES(entryname[/password] ENT
[ entryname[/password] ...])
[FILE(ddname)] -
[{FROMKEY(key)|FROMADDRESS(address)| FKEY FADDR
FROMNUMBER(number)|SKIP(number)}] FNUM -
[{NOREPLACE|REPLACE}] NREP REP
[{NOREUSE|REUSE}] NRUS RUS
[{TOKEY(key)|TOADDRESS(address)| - TADDR
TONUMBER(number)|COUNT(number)}] TNUM -
Verify Data Structure
Key Words Abbreviation
VERIFY -
{FILE(ddname[/password] | -
DATASET(entryname[/password]} DS
