centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-27 13:28:51 +07:00
Code Issues Packages Projects Releases Wiki Activity

clarify backup_file (#1391) (#1440)

Browse Source 
* add conditional

Also backup_file would not be present if updated is not changed

* clarify docs too

* better desc

(cherry picked from commit ba398559c0)

Co-authored-by: Brian Coca <bcoca@users.noreply.github.com>
This commit is contained in:
patchback[bot]
2024-05-09 17:18:43 -04:00
committed by GitHub
parent 8025c52e78
commit 24571d081d
2 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docsite/rst/reference_appendices/common_return_values.rst
View File

@@ -18,7 +18,7 @@ Common
backup_file
```````````
For those modules that implement `backup=no|yes` when manipulating files, a path to the backup file created.
For those modules that implement `backup=no|yes` when manipulating files, a path to the backup file created if original file was changed.
.. code-block:: console

11
docs/docsite/rst/reference_appendices/faq.rst
View File

@@ -826,11 +826,11 @@ and backups, which most file based modules also support:
.. code-block:: yaml
- name: update config and backout if validation fails
- name: maintain config and backout if validation after change fails
block:
- name: do the actual update, works with copy, lineinfile and any action that allows for `backup`.
template: src=template.j2 dest=/x/y/z backup=yes moreoptions=stuff
register: updated
- name: do the actual update, works with copy, lineinfile and any action that allows for `backup`.
template: src=template.j2 dest=/x/y/z backup=yes moreoptions=stuff
register: updated
- name: run validation, this will change a lot as needed. We assume it returns an error when not passing, use `failed_when` if otherwise.
shell: run_validation_commmand
@@ -838,17 +838,20 @@ and backups, which most file based modules also support:
become_user: requiredbyapp
environment:
WEIRD_REQUIREMENT: 1
when: updated is changed
rescue:
- name: restore backup file to original, in the hope the previous configuration was working.
copy:
remote_src: true
dest: /x/y/z
src: "{{ updated['backup_file'] }}"
when: updated is changed
always:
- name: We choose to always delete backup, but could copy or move, or only delete in rescue.
file:
path: "{{ updated['backup_file'] }}"
state: absent
when: updated is changed
.. _jinja2_faqs: