Skip to content

Commit cc9dc10

Browse files
committed
Automated commit to update documentation
1 parent 660e6aa commit cc9dc10

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1352
-908
lines changed

_sources/ibm_zos_core/docs/source/modules/zos_apf.rst.txt

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ library
3737
3838

3939
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`\ .
4141

4242
The APF list format has to be "DYNAMIC".
4343

@@ -58,38 +58,38 @@ force_dynamic
5858
5959

6060
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.
6262

6363
1. The volume serial number.
6464

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.
6666

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.
6868

69-
If ``volume`` is not specified, ``library`` has to be cataloged.
69+
If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
7070

7171
| **required**: False
7272
| **type**: str
7373
7474

7575
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.
7777

78-
If ``sms=True``, ``volume`` value will be ignored.
78+
If \ :literal:`sms=True`\ , \ :literal:`volume`\ value will be ignored.
7979

8080
| **required**: False
8181
| **type**: bool
8282
| **default**: False
8383
8484

8585
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`\
8787

88-
Display APF list current format ``operation=check_format``
88+
Display APF list current format \ :literal:`operation=check\_format`\
8989

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.
9191

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.
9393

9494
| **required**: False
9595
| **type**: str
@@ -99,23 +99,23 @@ operation
9999
tmp_hlq
100100
Override the default high level qualifier (HLQ) for temporary and backup datasets.
101101

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.
103103

104104
| **required**: False
105105
| **type**: str
106106
107107

108108
persistent
109-
Add/remove persistent entries to or from *data_set_name*
109+
Add/remove persistent entries to or from \ :emphasis:`data\_set\_name`\
110110

111-
``library`` will not be persisted or removed if ``persistent=None``
111+
\ :literal:`library`\ will not be persisted or removed if \ :literal:`persistent=None`\
112112

113113
| **required**: False
114114
| **type**: dict
115115
116116

117117
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.
119119

120120
| **required**: True
121121
| **type**: str
@@ -124,23 +124,23 @@ persistent
124124
marker
125125
The marker line template.
126126

127-
``{mark}`` will be replaced with "BEGIN" and "END".
127+
\ :literal:`{mark}`\ will be replaced with "BEGIN" and "END".
128128

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.
130130

131-
``{mark}`` length may not exceed 72 characters.
131+
\ :literal:`{mark}`\ length may not exceed 72 characters.
132132

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
134134

135135
| **required**: False
136136
| **type**: str
137137
| **default**: /* {mark} ANSIBLE MANAGED BLOCK <timestamp> \*/
138138
139139

140140
backup
141-
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`\ ".
142142

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`\ .
144144

145145
The backup file name will be return on either success or failure of module execution such that data can be retrieved.
146146

@@ -152,11 +152,11 @@ persistent
152152
backup_name
153153
Specify the USS file name or data set name for the destination backup.
154154

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.
156156

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.
158158

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`\ .
160160

161161
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.
162162

@@ -168,9 +168,9 @@ persistent
168168
batch
169169
A list of dictionaries for adding or removing libraries.
170170

171-
This is mutually exclusive with ``library``, ``volume``, ``sms``
171+
This is mutually exclusive with \ :literal:`library`\ , \ :literal:`volume`\ , \ :literal:`sms`\
172172

173-
Can be used with ``persistent``
173+
Can be used with \ :literal:`persistent`\
174174

175175
| **required**: False
176176
| **type**: list
@@ -185,24 +185,24 @@ batch
185185
186186

187187
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.
189189

190190
1. The volume serial number
191191

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.
193193

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.
195195

196-
If ``volume`` is not specified, ``library`` has to be cataloged.
196+
If \ :literal:`volume`\ is not specified, \ :literal:`library`\ has to be cataloged.
197197

198198
| **required**: False
199199
| **type**: str
200200
201201

202202
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.
204204

205-
If true ``volume`` will be ignored.
205+
If true \ :literal:`volume`\ will be ignored.
206206

207207
| **required**: False
208208
| **type**: bool
@@ -283,9 +283,9 @@ Return Values
283283
stdout
284284
The stdout from ZOAU command apfadm. Output varies based on the type of operation.
285285

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
287287

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
289289

290290
| **returned**: always
291291
| **type**: str

0 commit comments

Comments
 (0)