Skip to content

Commit 0a8b578

Browse files
ddimatosddimatos
committed
Merge branch 'master' into release-v1.3.1
2 parents 0a405c7 + 7d5f71e commit 0a8b578

File tree

1 file changed

+72
-1
lines changed

1 file changed

+72
-1
lines changed

‎docs/source/modules/zos_mvs_raw.rst

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,9 @@ dds
116116
| **type**: str
117117
| **choices**: library, pds, pdse, large, basic, seq, rrds, esds, lds, ksds
118118
119+
| **required**: False
120+
| **type**: str
121+
| **choices**: library, pds, pdse, large, basic, seq, rrds, esds, lds, ksds
119122
120123
disposition
121124
*disposition* indicates the status of a data set.
@@ -134,6 +137,9 @@ dds
134137
| **type**: str
135138
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
136139
140+
| **required**: False
141+
| **type**: str
142+
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
137143
138144
disposition_abnormal
139145
*disposition_abnormal* indicates what to do with the data set after an abnormal termination of the program.
@@ -142,6 +148,9 @@ dds
142148
| **type**: str
143149
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
144150
151+
| **required**: False
152+
| **type**: str
153+
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
145154
146155
reuse
147156
Determines if a data set should be reused if *disposition=NEW* and if a data set with a matching name already exists.
@@ -174,6 +183,8 @@ dds
174183
| **required**: False
175184
| **type**: bool
176185
186+
| **required**: False
187+
| **type**: bool
177188
178189
backup
179190
Determines if a backup should be made of an existing data set when *disposition=NEW*, *replace=true*, and a data set with the desired name is found.
@@ -183,6 +194,8 @@ dds
183194
| **required**: False
184195
| **type**: bool
185196
197+
| **required**: False
198+
| **type**: bool
186199
187200
space_type
188201
The unit of measurement to use when allocating space for a new data set using *space_primary* and *space_secondary*.
@@ -213,6 +226,8 @@ dds
213226
| **required**: False
214227
| **type**: int
215228
229+
| **required**: False
230+
| **type**: int
216231
217232
volumes
218233
The volume or volumes on which a data set resides or will reside.
@@ -233,6 +248,8 @@ dds
233248
| **required**: False
234249
| **type**: str
235250
251+
| **required**: False
252+
| **type**: str
236253
237254
sms_storage_class
238255
The desired storage class for a new SMS-managed data set.
@@ -255,6 +272,8 @@ dds
255272
| **required**: False
256273
| **type**: str
257274
275+
| **required**: False
276+
| **type**: str
258277
259278
block_size
260279
The maximum length of a block in bytes.
@@ -271,6 +290,8 @@ dds
271290
| **required**: False
272291
| **type**: int
273292
293+
| **required**: False
294+
| **type**: int
274295
275296
key_label
276297
The label for the encryption key used by the system to encrypt the data set.
@@ -293,6 +314,8 @@ dds
293314
| **required**: False
294315
| **type**: dict
295316
317+
| **required**: False
318+
| **type**: dict
296319
297320
label
298321
The label for the key encrypting key used by the Encryption Key Manager.
@@ -306,6 +329,8 @@ dds
306329
| **required**: True
307330
| **type**: str
308331
332+
| **required**: True
333+
| **type**: str
309334
310335
encoding
311336
How the label for the key encrypting key specified by *label* is encoded by the Encryption Key Manager.
@@ -590,6 +615,7 @@ dds
590615
| **type**: str
591616
| **choices**: u, vb, vba, fb, fba
592617
618+
*dd_input* supports single or multiple lines of input.
593619

594620
return_content
595621
Determines how content should be returned to the user.
@@ -679,7 +705,7 @@ dds
679705

680706
``base64`` means return content in binary mode.
681707

682-
| **required**: True
708+
| **required**: False
683709
| **type**: str
684710
| **choices**: text, base64
685711
@@ -717,6 +743,8 @@ dds
717743
| **required**: True
718744
| **type**: str
719745
746+
| **required**: True
747+
| **type**: str
720748
721749
return_content
722750
Determines how content should be returned to the user.
@@ -726,6 +754,8 @@ dds
726754
| **required**: True
727755
| **type**: dict
728756
757+
| **required**: True
758+
| **type**: dict
729759
730760
type
731761
The type of the content to be returned.
@@ -740,6 +770,9 @@ dds
740770
| **type**: str
741771
| **choices**: text, base64
742772
773+
| **required**: True
774+
| **type**: str
775+
| **choices**: text, base64
743776
744777
src_encoding
745778
The encoding of the data set on the z/OS system.
@@ -750,6 +783,9 @@ dds
750783
| **type**: str
751784
| **default**: ibm-1047
752785
786+
| **required**: False
787+
| **type**: str
788+
| **default**: ibm-1047
753789
754790
response_encoding
755791
The encoding to use when returning the contents of the data set.
@@ -810,6 +846,8 @@ dds
810846
| **required**: True
811847
| **type**: str
812848
849+
| **required**: True
850+
| **type**: str
813851
814852
dds
815853
A list of DD statements, which can contain any of the following types: *dd_data_set*, *dd_unix*, and *dd_input*.
@@ -854,6 +892,9 @@ dds
854892
| **type**: str
855893
| **choices**: new, shr, mod, old
856894
895+
| **required**: False
896+
| **type**: str
897+
| **choices**: new, shr, mod, old
857898
858899
disposition_normal
859900
*disposition_normal* indicates what to do with the data set after normal termination of the program.
@@ -870,6 +911,9 @@ dds
870911
| **type**: str
871912
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
872913
914+
| **required**: False
915+
| **type**: str
916+
| **choices**: delete, keep, catlg, catalog, uncatlg, uncatalog
873917
874918
reuse
875919
Determines if data set should be reused if *disposition=NEW* and a data set with matching name already exists.
@@ -961,6 +1005,8 @@ dds
9611005
| **required**: False
9621006
| **type**: str
9631007
1008+
| **required**: False
1009+
| **type**: str
9641010
9651011
sms_storage_class
9661012
The desired storage class for a new SMS-managed data set.
@@ -972,6 +1018,8 @@ dds
9721018
| **required**: False
9731019
| **type**: str
9741020
1021+
| **required**: False
1022+
| **type**: str
9751023
9761024
sms_data_class
9771025
The desired data class for a new SMS-managed data set.
@@ -983,6 +1031,8 @@ dds
9831031
| **required**: False
9841032
| **type**: str
9851033
1034+
| **required**: False
1035+
| **type**: str
9861036
9871037
block_size
9881038
The maximum length of a block in bytes.
@@ -1034,6 +1084,8 @@ dds
10341084
| **required**: True
10351085
| **type**: str
10361086
1087+
| **required**: True
1088+
| **type**: str
10371089
10381090
encoding
10391091
How the label for the key encrypting key specified by *label* is encoded by the Encryption Key Manager.
@@ -1046,6 +1098,9 @@ dds
10461098
| **type**: str
10471099
| **choices**: l, h
10481100
1101+
| **required**: True
1102+
| **type**: str
1103+
| **choices**: l, h
10491104
10501105

10511106
encryption_key_2
@@ -1069,6 +1124,8 @@ dds
10691124
| **required**: True
10701125
| **type**: str
10711126
1127+
| **required**: True
1128+
| **type**: str
10721129
10731130
encoding
10741131
How the label for the key encrypting key specified by *label* is encoded by the Encryption Key Manager.
@@ -1081,6 +1138,7 @@ dds
10811138
| **type**: str
10821139
| **choices**: l, h
10831140
1141+
Maps to KEYCD2 on z/OS.
10841142

10851143

10861144
key_length
@@ -1104,6 +1162,7 @@ dds
11041162
| **required**: False
11051163
| **type**: int
11061164
1165+
Provide *key_offset* only for VSAM key-sequenced data sets.
11071166

11081167
record_length
11091168
The logical record length. (e.g ``80``).
@@ -1119,6 +1178,7 @@ dds
11191178
| **required**: False
11201179
| **type**: int
11211180
1181+
Maps to LRECL on z/OS.
11221182

11231183
record_format
11241184
The format and characteristics of the records for new data set.
@@ -1136,6 +1196,7 @@ dds
11361196
| **required**: False
11371197
| **type**: dict
11381198
1199+
If not provided, no content from the DD is returned.
11391200

11401201
type
11411202
The type of the content to be returned.
@@ -1150,6 +1211,7 @@ dds
11501211
| **type**: str
11511212
| **choices**: text, base64
11521213
1214+
``base64`` means return content in binary mode.
11531215

11541216
src_encoding
11551217
The encoding of the data set on the z/OS system.
@@ -1167,6 +1229,9 @@ dds
11671229
| **default**: iso8859-1
11681230
11691231

1232+
| **required**: False
1233+
| **type**: str
1234+
| **default**: iso8859-1
11701235
11711236

11721237
dd_unix
@@ -1175,6 +1240,8 @@ dds
11751240
| **required**: False
11761241
| **type**: dict
11771242
1243+
dd_unix
1244+
The path to a file in UNIX System Services (USS).
11781245

11791246
path
11801247
The path to an existing UNIX file.
@@ -1194,6 +1261,8 @@ dds
11941261
| **type**: str
11951262
| **choices**: keep, delete
11961263
1264+
disposition_normal
1265+
Indicates what to do with the UNIX file after normal termination of the program.
11971266

11981267
disposition_abnormal
11991268
Indicates what to do with the UNIX file after abnormal termination of the program.
@@ -1311,6 +1380,7 @@ dds
13111380
| **type**: str
13121381
| **choices**: u, vb, vba, fb, fba
13131382
1383+
*record_format* is required in situations where the data will be processed as records and therefore, *record_length*, *block_size* and *record_format* need to be supplied since a UNIX file would normally be treated as a stream of bytes.
13141384

13151385
return_content
13161386
Determines how content should be returned to the user.
@@ -1361,6 +1431,7 @@ dds
13611431
| **required**: False
13621432
| **type**: dict
13631433
1434+
Input will be saved to a temporary data set with a record length of 80.
13641435

13651436
content
13661437
The input contents for the DD.

0 commit comments

Comments
 (0)