You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _sources/ibm_zos_core/docs/source/modules/zos_apf.rst.txt
+34-34Lines changed: 34 additions & 34 deletions
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ library
37
37
38
38
39
39
state
40
-
Ensure that the library is added ``state=present`` or removed ``state=absent``.
40
+
Ensure that the library is added \ :literal:`state=present`\ or removed \ :literal:`state=absent`\ .
41
41
42
42
The APF list format has to be "DYNAMIC".
43
43
@@ -58,38 +58,38 @@ force_dynamic
58
58
59
59
60
60
volume
61
-
The identifier for the volume containing the library specified in the ``library`` parameter. The values must be one the following.
61
+
The identifier for the volume containing the library specified in the \ :literal:`library`\ parameter. The values must be one the following.
62
62
63
63
1. The volume serial number.
64
64
65
-
2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
65
+
2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
66
66
67
-
3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.
67
+
3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
68
68
69
-
If ``volume`` is not specified, ``library`` has to be cataloged.
69
+
If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
70
70
71
71
|**required**: False
72
72
|**type**: str
73
73
74
74
75
75
sms
76
-
Indicates that the library specified in the ``library`` parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
76
+
Indicates that the library specified in the \ :literal:`library`\ parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
77
77
78
-
If ``sms=True``, ``volume`` value will be ignored.
78
+
If \ :literal:`sms=True`\ , \ :literal:`volume`\ value will be ignored.
79
79
80
80
|**required**: False
81
81
|**type**: bool
82
82
|**default**: False
83
83
84
84
85
85
operation
86
-
Change APF list format to "DYNAMIC" ``operation=set_dynamic`` or "STATIC" ``operation=set_static``
86
+
Change APF list format to "DYNAMIC" \ :literal:`operation=set\_dynamic`\ or "STATIC" \ :literal:`operation=set\_static`\
87
87
88
-
Display APF list current format ``operation=check_format``
88
+
Display APF list current format \ :literal:`operation=check\_format`\
89
89
90
-
Display APF list entries when ``operation=list`` ``library``, ``volume`` and ``sms`` will be used as filters.
90
+
Display APF list entries when \ :literal:`operation=list`\ \ :literal:`library`\ , \ :literal:`volume`\ and \ :literal:`sms`\ will be used as filters.
91
91
92
-
If ``operation`` is not set, add or remove operation will be ignored.
92
+
If \ :literal:`operation`\ is not set, add or remove operation will be ignored.
93
93
94
94
|**required**: False
95
95
|**type**: str
@@ -99,23 +99,23 @@ operation
99
99
tmp_hlq
100
100
Override the default high level qualifier (HLQ) for temporary and backup datasets.
101
101
102
-
The default HLQ is the Ansible user used to execute the module and if that is not available, then the value ``TMPHLQ`` is used.
102
+
The default HLQ is the Ansible user used to execute the module and if that is not available, then the value \ :literal:`TMPHLQ`\ is used.
103
103
104
104
|**required**: False
105
105
|**type**: str
106
106
107
107
108
108
persistent
109
-
Add/remove persistent entries to or from *data_set_name*
109
+
Add/remove persistent entries to or from \ :emphasis:`data\_set\_name`\
110
110
111
-
``library`` will not be persisted or removed if ``persistent=None``
111
+
\ :literal:`library`\ will not be persisted or removed if \ :literal:`persistent=None`\
112
112
113
113
|**required**: False
114
114
|**type**: dict
115
115
116
116
117
117
data_set_name
118
-
The data set name used for persisting or removing a ``library`` from the APF list.
118
+
The data set name used for persisting or removing a \ :literal:`library`\ from the APF list.
119
119
120
120
|**required**: True
121
121
|**type**: str
@@ -124,23 +124,23 @@ persistent
124
124
marker
125
125
The marker line template.
126
126
127
-
``{mark}`` will be replaced with "BEGIN" and "END".
127
+
\ :literal:`{mark}`\ will be replaced with "BEGIN" and "END".
128
128
129
-
Using a custom marker without the ``{mark}`` variable may result in the block being repeatedly inserted on subsequent playbook runs.
129
+
Using a custom marker without the \ :literal:`{mark}`\ variable may result in the block being repeatedly inserted on subsequent playbook runs.
130
130
131
-
``{mark}`` length may not exceed 72 characters.
131
+
\ :literal:`{mark}`\ length may not exceed 72 characters.
132
132
133
-
The timestamp (<timestamp>) used in the default marker follows the '+%Y%m%d-%H%M%S' date format
133
+
The timestamp (\<timestamp\>) used in the default marker follows the '+%Y%m%d-%H%M%S' date format
Creates a backup file or backup data set for *data_set_name*, including the timestamp information to ensure that you retrieve the original APF list defined in *data_set_name*".
141
+
Creates a backup file or backup data set for \ :emphasis:`data\_set\_name`\ , including the timestamp information to ensure that you retrieve the original APF list defined in \ :emphasis:`data\_set\_name`\ ".
142
142
143
-
*backup_name* can be used to specify a backup file name if *backup=true*.
143
+
\ :emphasis:`backup\_name`\ can be used to specify a backup file name if \ :emphasis:`backup=true`\ .
144
144
145
145
The backup file name will be return on either success or failure of module execution such that data can be retrieved.
146
146
@@ -152,11 +152,11 @@ persistent
152
152
backup_name
153
153
Specify the USS file name or data set name for the destination backup.
154
154
155
-
If the source *data_set_name* is a USS file or path, the backup_name name must be a file or path name, and the USS file or path must be an absolute path name.
155
+
If the source \ :emphasis:`data\_set\_name`\ is a USS file or path, the backup\_name name must be a file or path name, and the USS file or path must be an absolute path name.
156
156
157
-
If the source is an MVS data set, the backup_name must be an MVS data set name.
157
+
If the source is an MVS data set, the backup\_name must be an MVS data set name.
158
158
159
-
If the backup_name is not provided, the default backup_name will be used. If the source is a USS file or path, the name of the backup file will be the source file or path name appended with a timestamp. For example, ``/path/file_name.2020-04-23-08-32-29-bak.tar``.
159
+
If the backup\_name is not provided, the default backup\_name will be used. If the source is a USS file or path, the name of the backup file will be the source file or path name appended with a timestamp. For example, \ :literal:`/path/file\_name.2020-04-23-08-32-29-bak.tar`\ .
160
160
161
161
If the source is an MVS data set, it will be a data set with a random name generated by calling the ZOAU API. The MVS backup data set recovery can be done by renaming it.
162
162
@@ -168,9 +168,9 @@ persistent
168
168
batch
169
169
A list of dictionaries for adding or removing libraries.
170
170
171
-
This is mutually exclusive with ``library``, ``volume``, ``sms``
171
+
This is mutually exclusive with \ :literal:`library`\ , \ :literal:`volume`\ , \ :literal:`sms`\
172
172
173
-
Can be used with ``persistent``
173
+
Can be used with \ :literal:`persistent`\
174
174
175
175
|**required**: False
176
176
|**type**: list
@@ -185,24 +185,24 @@ batch
185
185
186
186
187
187
volume
188
-
The identifier for the volume containing the library specified on the ``library`` parameter. The values must be one of the following.
188
+
The identifier for the volume containing the library specified on the \ :literal:`library`\ parameter. The values must be one of the following.
189
189
190
190
1. The volume serial number
191
191
192
-
2. Six asterisks ``******``, indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
192
+
2. Six asterisks \ :literal:`\*\*\*\*\*\*`\ , indicating that the system must use the volume serial number of the current system residence (SYSRES) volume.
193
193
194
-
3. *MCAT*, indicating that the system must use the volume serial number of the volume containing the master catalog.
194
+
3. \*MCAT\*, indicating that the system must use the volume serial number of the volume containing the master catalog.
195
195
196
-
If ``volume`` is not specified, ``library`` has to be cataloged.
196
+
If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
197
197
198
198
|**required**: False
199
199
|**type**: str
200
200
201
201
202
202
sms
203
-
Indicates that the library specified in the ``library`` parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
203
+
Indicates that the library specified in the \ :literal:`library`\ parameter is managed by the storage management subsystem (SMS), and therefore no volume is associated with the library.
204
204
205
-
If true ``volume`` will be ignored.
205
+
If true \ :literal:`volume`\ will be ignored.
206
206
207
207
|**required**: False
208
208
|**type**: bool
@@ -283,9 +283,9 @@ Return Values
283
283
stdout
284
284
The stdout from ZOAU command apfadm. Output varies based on the type of operation.
285
285
286
-
state> stdout of the executed operator command (opercmd), "SETPROG" from ZOAU command apfadm
286
+
state\> stdout of the executed operator command (opercmd), "SETPROG" from ZOAU command apfadm
287
287
288
-
operation> stdout of operation options list> Returns a list of dictionaries of APF list entries [{'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFHAUTH'}, {'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFJAUTH'}, ...] set_dynamic> Set to DYNAMIC set_static> Set to STATIC check_format> DYNAMIC or STATIC
288
+
operation\> stdout of operation options list\> Returns a list of dictionaries of APF list entries [{'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFHAUTH'}, {'vol': 'PP0L6P', 'ds': 'DFH.V5R3M0.CICS.SDFJAUTH'}, ...] set\_dynamic\> Set to DYNAMIC set\_static\> Set to STATIC check\_format\> DYNAMIC or STATIC
0 commit comments