@@ -210,17 +210,17 @@ <h2 id="bootloader_gather_facts">bootloader_gather_facts</h2>
210210< p > Default: < code > false</ code > </ p >
211211< p > Type: < code > bool</ code > </ p >
212212< h2 id ="bootloader_settings "> bootloader_settings</ h2 >
213- < p > With this variable, list kernels and their command line parameters
214- that you want to set .</ p >
213+ < p > Use this variable to list kernels and their command line
214+ parameters .</ p >
215215< p > Available keys:</ p >
216216< ol type ="1 ">
217217< li > < p > < code > kernel</ code > - with this, specify the kernel to update
218- settings for. Each list should specify the same kernel using one or
219- multiple keys.</ p >
218+ settings for. Each entry should specify a kernel using one or more
219+ keys.</ p >
220220< p > If you want to add a kernel, you must specify three keys:
221221< code > path</ code > , < code > title</ code > , < code > initrd</ code > .</ p >
222222< p > If you want to modify or remove a kernel, you can specify one or more
223- key .</ p >
223+ keys .</ p >
224224< p > You can also specify < code > DEFAULT</ code > or < code > ALL</ code > to
225225update the default or all kernels.</ p >
226226< p > Available keys:</ p >
@@ -238,22 +238,23 @@ <h2 id="bootloader_settings">bootloader_settings</h2>
238238< li > < p > < code > state</ code > - state of the kernel.</ p >
239239< p > Available values: < code > present</ code > , < code > absent</ code > </ p >
240240< p > Default: < code > present</ code > </ p > </ li >
241- < li > < p > < code > options</ code > - with this, specify settings to update</ p >
241+ < li > < p > < code > options</ code > - use this to specify settings to update</ p >
242242< ul >
243- < li > < code > name</ code > - The name of the setting. < code > name</ code > is
244- omitted when using < code > replaced</ code > .</ li >
243+ < li > < code > name</ code > - The name of the setting. Omit < code > name</ code >
244+ when using < code > replaced</ code > .</ li >
245245< li > < code > value</ code > - The value for the setting. You must omit
246246< code > value</ code > if the setting has no value, e.g.
247247< code > quiet</ code > .</ li >
248248< li > < code > state</ code > - < code > present</ code > (default) or
249249< code > absent</ code > . The value < code > absent</ code > means to remove a
250- setting with < code > name</ code > name - name must be provided.</ li >
251- < li > < code > previous</ code > - Optional - the only value is
252- < code > replaced</ code > - this is used to specify that the previous
253- settings should be replaced with the given settings.</ li >
254- < li > < code > copy_default</ code > - Optional - when you create a kernel, you
250+ setting with the given < code > name</ code > - the name must be
251+ provided.</ li >
252+ < li > < code > previous</ code > - Optional - the only supported value is
253+ < code > replaced</ code > - use this to specify that the previous settings
254+ should be replaced with the given settings.</ li >
255+ < li > < code > copy_default</ code > - Optional - when creating a kernel, you
255256can specify < code > copy_default: true</ code > to copy the default
256- arguments to the created kernel</ li >
257+ arguments to the created kernel. </ li >
257258</ ul > </ li >
258259< li > < p > < code > default</ code > - boolean that identifies whether to make
259260this kernel the default. By default, the role does not change the
@@ -264,43 +265,41 @@ <h2 id="bootloader_settings">bootloader_settings</h2>
264265< p > Default: < code > {}</ code > </ p >
265266< p > Type: < code > dict</ code > </ p >
266267< h2 id ="bootloader_timeout "> bootloader_timeout</ h2 >
267- < p > With this variable, you can customize the loading time of the GRUB
268+ < p > Use this variable to customize the loading time of the GRUB
268269bootloader.</ p >
269270< p > Default: < code > 5</ code > </ p >
270271< p > Type: < code > int</ code > </ p >
271272< h2 id ="bootloader_password "> bootloader_password</ h2 >
272- < p > With this variable, you can protect boot parameters with a
273- password.</ p >
274- < p > < strong > WARNING</ strong > : Changing bootloader password is not
273+ < p > Use this variable to protect boot parameters with a password.</ p >
274+ < p > < strong > WARNING</ strong > : Changing the bootloader password is not
275275idempotent.</ p >
276- < p > Boot loader username is always < code > root</ code > .</ p >
276+ < p > The bootloader username is always < code > root</ code > .</ p >
277277< p > This should come from vault.</ p >
278278< p > If unset, current configuration is not touched.</ p >
279279< p > Default: < code > null</ code > </ p >
280280< p > Type: < code > string</ code > </ p >
281281< h2 id ="bootloader_remove_password "> bootloader_remove_password</ h2 >
282- < p > By setting this variable to < code > true</ code > , you can remove
283- bootloader password.</ p >
282+ < p > Set this variable to < code > true</ code > to remove the bootloader
283+ password.</ p >
284284< p > Default: < code > false</ code > </ p >
285285< p > Type: < code > bool</ code > </ p >
286286< h2 id ="bootloader_reboot_ok "> bootloader_reboot_ok</ h2 >
287- < p > If < code > true</ code > , if the role detects that something was changed
288- that requires a reboot to take effect, the role will reboot the managed
289- host.</ p >
287+ < p > If < code > true</ code > , the role will reboot the managed host when it
288+ detects that changes require a reboot to take effect.</ p >
290289< p > If < code > false</ code > , it is up to you to determine when to reboot
291290the managed host.</ p >
292- < p > The role will returns the variable
291+ < p > The role will return the variable
293292< code > bootloader_reboot_required</ code > (see below) with a value of
294- < code > true</ code > to indicate that some change has occurred which needs
295- a reboot to take effect.</ p >
293+ < code > true</ code > to indicate that changes have occurred which need a
294+ reboot to take effect.</ p >
296295< p > Default: < code > false</ code > </ p >
297296< p > Type: < code > bool</ code > </ p >
298297< h1 id ="variables-exported-by-the-role "> Variables Exported by the
299298Role</ h1 >
300299< p > The role exports the following variables:</ p >
301300< h2 id ="bootloader_reboot_needed "> bootloader_reboot_needed</ h2 >
302- < p > Default < code > false</ code > - if < code > true</ code > , this means a
303- reboot is needed to apply the changes made by the role</ p >
301+ < p > Default: < code > false</ code > - if < code > true</ code > , this means a
302+ reboot is needed to apply the changes made by the role. </ p >
304303< h2 id ="bootloader_facts "> bootloader_facts</ h2 >
305304< p > Contains boot information for all kernels.</ p >
306305< p > The role returns this variable when you set
0 commit comments