From 6de49f084c3a8b21d301ecd20b45d8266e51b707 Mon Sep 17 00:00:00 2001 From: Deepak Agrawal Date: Fri, 13 Apr 2018 12:48:49 +0530 Subject: [PATCH] doc for _config backup argument (#38650) --- 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 +++- 6 files changed, 18 insertions(+), 11 deletions(-) diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index 658d1554373..cca91532a0a 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -113,8 +113,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. type: bool default: 'no' version_added: "2.2" diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index 321c9f0374c..f490070f358 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -117,8 +117,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. type: bool default: 'no' version_added: "2.2" diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index 0d0fbf4c1c0..9f0153e044a 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -113,8 +113,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. type: bool default: 'no' version_added: "2.2" diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index 58523626890..dc7a74f7555 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -92,8 +92,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. type: bool default: 'no' version_added: "2.2" diff --git a/lib/ansible/modules/network/nxos/nxos_config.py b/lib/ansible/modules/network/nxos/nxos_config.py index 98139799ac1..c88cf111978 100644 --- a/lib/ansible/modules/network/nxos/nxos_config.py +++ b/lib/ansible/modules/network/nxos/nxos_config.py @@ -119,8 +119,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. type: bool default: 'no' version_added: "2.2" diff --git a/lib/ansible/modules/network/vyos/vyos_config.py b/lib/ansible/modules/network/vyos/vyos_config.py index bd78c17dddf..e768f212135 100644 --- a/lib/ansible/modules/network/vyos/vyos_config.py +++ b/lib/ansible/modules/network/vyos/vyos_config.py @@ -63,7 +63,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. type: bool default: 'no' comment: