From 829f9fda7a67fb84a8b93fee166db18b86eef113 Mon Sep 17 00:00:00 2001 From: Deepak Agrawal Date: Mon, 16 Apr 2018 12:30:05 +0530 Subject: [PATCH] doc changes for backup option of network _config modules (#38797) --- .../fragments/doc_chnages_for_network_config_modules.yaml | 2 ++ lib/ansible/modules/network/eos/eos_config.py | 5 +++-- lib/ansible/modules/network/ios/ios_config.py | 5 +++-- lib/ansible/modules/network/iosxr/iosxr_config.py | 5 +++-- lib/ansible/modules/network/junos/junos_config.py | 5 +++-- lib/ansible/modules/network/nxos/nxos_config.py | 5 +++-- lib/ansible/modules/network/vyos/vyos_config.py | 4 +++- 7 files changed, 20 insertions(+), 11 deletions(-) create mode 100644 changelogs/fragments/doc_chnages_for_network_config_modules.yaml diff --git a/changelogs/fragments/doc_chnages_for_network_config_modules.yaml b/changelogs/fragments/doc_chnages_for_network_config_modules.yaml new file mode 100644 index 00000000000..19f7b648559 --- /dev/null +++ b/changelogs/fragments/doc_chnages_for_network_config_modules.yaml @@ -0,0 +1,2 @@ +bugfixes: +- backup options doc change to reflect backup directory location in case playbook is run from a role diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index 2d1cd133c8e..d4a79d0d517 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -126,8 +126,9 @@ options: - This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) - folder in the playbook root directory. If the directory does not - exist, it is created. + folder in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not exist, + it is created. required: false default: no type: bool diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index 326ed1a74e7..244baee4499 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -131,8 +131,9 @@ options: - This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) - folder in the playbook root directory. If the directory does not - exist, it is created. + folder in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not exist, + it is created. required: false default: no type: bool diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index 10a98b109f6..c3691fc6039 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -128,8 +128,9 @@ options: - This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) - folder in the playbook root directory. If the directory does not - exist, it is created. + folder in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not exist, + it is created. required: false default: no choices: ['yes', 'no'] diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 10e6d7e3d2b..7bc23605021 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -105,8 +105,9 @@ options: - This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) - folder in the playbook root directory. If the directory does not - exist, it is created. + folder in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not exist, + it is created. required: false default: no choices: ['yes', 'no'] diff --git a/lib/ansible/modules/network/nxos/nxos_config.py b/lib/ansible/modules/network/nxos/nxos_config.py index e59887747e8..69b2ed2b450 100644 --- a/lib/ansible/modules/network/nxos/nxos_config.py +++ b/lib/ansible/modules/network/nxos/nxos_config.py @@ -134,8 +134,9 @@ options: - This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) - folder in the playbook root directory. If the directory does not - exist, it is created. + folder in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not exist, + it is created. required: false default: false type: bool diff --git a/lib/ansible/modules/network/vyos/vyos_config.py b/lib/ansible/modules/network/vyos/vyos_config.py index d533977910c..848ae6fa823 100644 --- a/lib/ansible/modules/network/vyos/vyos_config.py +++ b/lib/ansible/modules/network/vyos/vyos_config.py @@ -68,7 +68,9 @@ options: - The C(backup) argument will backup the current devices active configuration to the Ansible control host prior to making any changes. The backup file will be located in the backup folder - in the root of the playbook + in the playbook root directory or role root directory, if + playbook is part of an ansible role. If the directory does not + exist, it is created. required: false default: false choices: ['yes', 'no']