Document backup
options
To make future diffing easier, use consistent ordering
This commit is contained in:
parent
9d32e313b7
commit
c01328b597
3 changed files with 28 additions and 7 deletions
|
@ -15,6 +15,7 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
#
|
#
|
||||||
|
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: eos_config
|
module: eos_config
|
||||||
|
@ -108,6 +109,17 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
choices: ['yes', 'no']
|
choices: ['yes', 'no']
|
||||||
|
backup:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
required: false
|
||||||
|
default: no
|
||||||
|
choices: ['yes', 'no']
|
||||||
|
version_added: "2.2"
|
||||||
config:
|
config:
|
||||||
description:
|
description:
|
||||||
- The module, by default, will connect to the remote device and
|
- The module, by default, will connect to the remote device and
|
||||||
|
@ -270,11 +282,11 @@ def main():
|
||||||
""" main entry point for module execution
|
""" main entry point for module execution
|
||||||
"""
|
"""
|
||||||
argument_spec = dict(
|
argument_spec = dict(
|
||||||
|
src=dict(type='path'),
|
||||||
|
|
||||||
lines=dict(aliases=['commands'], type='list'),
|
lines=dict(aliases=['commands'], type='list'),
|
||||||
parents=dict(type='list'),
|
parents=dict(type='list'),
|
||||||
|
|
||||||
src=dict(type='path'),
|
|
||||||
|
|
||||||
before=dict(type='list'),
|
before=dict(type='list'),
|
||||||
after=dict(type='list'),
|
after=dict(type='list'),
|
||||||
|
|
||||||
|
@ -285,11 +297,10 @@ def main():
|
||||||
# it will be removed in a future version
|
# it will be removed in a future version
|
||||||
force=dict(default=False, type='bool'),
|
force=dict(default=False, type='bool'),
|
||||||
|
|
||||||
backup=dict(type='bool', default=False),
|
|
||||||
|
|
||||||
config=dict(),
|
config=dict(),
|
||||||
defaults=dict(type='bool', default=False),
|
defaults=dict(type='bool', default=False),
|
||||||
|
|
||||||
|
backup=dict(type='bool', default=False),
|
||||||
save=dict(default=False, type='bool'),
|
save=dict(default=False, type='bool'),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ options:
|
||||||
a change needs to be made. This allows the playbook designer
|
a change needs to be made. This allows the playbook designer
|
||||||
the opportunity to perform configuration commands prior to pushing
|
the opportunity to perform configuration commands prior to pushing
|
||||||
any changes without affecting how the set of commands are matched
|
any changes without affecting how the set of commands are matched
|
||||||
against the system
|
against the system.
|
||||||
required: false
|
required: false
|
||||||
default: null
|
default: null
|
||||||
after:
|
after:
|
||||||
|
@ -322,8 +322,8 @@ def main():
|
||||||
config=dict(),
|
config=dict(),
|
||||||
default=dict(type='bool', default=False),
|
default=dict(type='bool', default=False),
|
||||||
|
|
||||||
save=dict(type='bool', default=False),
|
|
||||||
backup=dict(type='bool', default=False),
|
backup=dict(type='bool', default=False),
|
||||||
|
save=dict(default=False, type='bool'),
|
||||||
)
|
)
|
||||||
|
|
||||||
mutually_exclusive = [('lines', 'src')]
|
mutually_exclusive = [('lines', 'src')]
|
||||||
|
|
|
@ -112,6 +112,17 @@ options:
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
choices: [ "true", "false" ]
|
choices: [ "true", "false" ]
|
||||||
|
backup:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
required: false
|
||||||
|
default: no
|
||||||
|
choices: ['yes', 'no']
|
||||||
|
version_added: "2.2"
|
||||||
config:
|
config:
|
||||||
description:
|
description:
|
||||||
- The module, by default, will connect to the remote device and
|
- The module, by default, will connect to the remote device and
|
||||||
|
@ -146,7 +157,6 @@ options:
|
||||||
version_added: "2.2"
|
version_added: "2.2"
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
# Note: examples below use the following provider dict to handle
|
# Note: examples below use the following provider dict to handle
|
||||||
# transport and authentication to the node.
|
# transport and authentication to the node.
|
||||||
|
|
Loading…
Reference in a new issue