VTOC-UPDATE

#### Search Results

Search

# VTOC-UPDATE

File | 7
Statement | `PROCESS`
Task | Perform VTOC updates, for example, rename, scratch, purge datasets.

## Fields

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`DSNAME` | A54 |  | D | Required.
`NEWNAME` | A54 |  | D | Relevant for `FUNCTION=RENAME`.
`FUNCTION` | A8 |  | D | Required.
`VOLSER` | A6 |  | D | Required.
`LEAVE` | N5 |  | D | Relevant for `FUNCTION=RELEASE`..
`CATALOG-UPDATE` | A3 |  | D | Relevant for `FUNCTION=RENAME` or `SCRATCH`.
`WAIT` | A3 |  | D | Relevant for `VOLSER=MIGRAT`.

## Relevant Error Codes

Code | Text
--- | ---
535 | File has invalid format.
539 | `DFHSMREQ` failed with RC=...
571 | `DSNAME` missing.
600 | Unknown function.
851 | File not on volume.
852 | No password supplied / VSAM data space.
853 | Retention cycle unexpired `/ NEWNAME` exists.

## Field Descriptions

Field Name | Type/Length
--- | ---
`CATALOG-UPDATE` | (A3)

Update catalog after a file is scratched or renamed. Possible options:

Option | Explanation
--- | ---
`NO` | Catalog is not updated.
`YES` | Catalog is updated.

Field Name | Type/Length
--- | ---
`DSNAME` | (A54)

Fully qualified dataset name.

Field Name | Type/Length
--- | ---
`FUNCTION` | (A8)

Possible functions are:

Function | Explanation
--- | ---
`PURGE` | Delete dataset or file regardless of expiration date.
`RELEASE` | Release unused space.
`RENAME` | Rename dataset or file.
`SCRATCH` | Delete dataset or file.

Field Name | Type/Length
--- | ---
`LEAVE` | (N5)

Number of free tracks after the unused tracks are freed with `FUNCTION=RELEASE`.

Field Name | Type/Length
--- | ---
`NEWNAME` | (N54)

Relevant when `FUNCTION=RENAME`. New name to be assigned to the dataset or file.

Field Name | Type/Length
--- | ---
`VOLSER` | (A6)

Volume serial number.

Field Name | Type/Length
--- | ---
`WAIT` | (A3)

Relevant when `VOLSER=MIGRAT`. Possible values are:

Value | Explanation
--- | ---
`YES` | Wait for the dataset to be recalled from a migration volume before deleting it.
`NO` | Delete the migrated dataset without recalling (default).

### On this page

- Fields
- Relevant Error Codes
- Field Descriptions