Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document backup_path #31844

Merged
merged 1 commit into from
Oct 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/ansible/modules/network/asa/asa_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
a change needs to be made. This allows the playbook designer
the opportunity to perform configuration commands prior to pushing
any changes without affecting how the set of commands are matched
against the system
against the system.
required: false
default: null
after:
Expand Down
8 changes: 6 additions & 2 deletions lib/ansible/modules/network/dellos10/dellos10_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
- Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can
either be the full path on the Ansible control host or a relative
path from the playbook or role root dir. This argument is mutually
path from the playbook or role root directory. This argument is mutually
exclusive with I(lines).
required: false
default: null
Expand Down Expand Up @@ -182,7 +182,11 @@
returned: When not check_mode.
type: bool
sample: True

backup_path:
description: The full path to the backup file
returned: when backup is yes
type: string
sample: /playbooks/ansible/backup/dellos10_config.2016-07-16@22:28:34
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.dellos10 import get_config, get_sublevel_config
Expand Down
13 changes: 9 additions & 4 deletions lib/ansible/modules/network/dellos6/dellos6_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
parents:
description:
- The ordered set of parents that uniquely identify the section
the commands should be checked against. If you do not specify the parents argument, the commands are checked against the set of top
the commands should be checked against. If you omit the parents argument, the commands are checked against the set of top
level or global commands.
required: false
default: null
Expand All @@ -47,7 +47,7 @@
- Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can
either be the full path on the Ansible control host or a relative
path from the playbook or role root dir. This argument is mutually
path from the playbook or role root directory. This argument is mutually
exclusive with I(lines).
required: false
default: null
Expand All @@ -63,7 +63,7 @@
after:
description:
- The ordered set of commands to append to the end of the command
stack if a change needs to be made. As with I(before), the playbook desinger can use this to append a set of commands to be
stack if a change needs to be made. As with I(before), the playbook designer can use this to append a set of commands to be
executed after the command set.
required: false
default: null
Expand All @@ -75,7 +75,7 @@
match to I(strict), command lines matched by respect
to position. If you set match to I(exact), command lines
must be an equal match. Finally, if you set match to I(none), the
module does not attempt to compare the source configuration with
module does not attempt to compare the source configuration with
the running configuration on the remote device.
required: false
default: line
Expand Down Expand Up @@ -181,6 +181,11 @@
type: bool
sample: True

backup_path:
description: The full path to the backup file
returned: when backup is yes
type: string
sample: /playbooks/ansible/backup/dellos6_config.2016-07-16@22:28:34
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.dellos6 import get_config, get_sublevel_config, Dellos6NetworkConfig
Expand Down
14 changes: 9 additions & 5 deletions lib/ansible/modules/network/dellos9/dellos9_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
- Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can
either be the full path on the Ansible control host or a relative
path from the playbook or role root dir. This argument is mutually
path from the playbook or role root directory. This argument is mutually
exclusive with I(lines).
required: false
default: null
Expand All @@ -74,7 +74,7 @@
match to I(line), commands match line by line. If you set
match to I(strict), command lines match by position. If you set match to I(exact), command lines
must be an equal match. Finally, if you set match to I(none), the
module does not attempt to compare the source configuration with
module does not attempt to compare the source configuration with
the running configuration on the remote device.
required: false
default: line
Expand Down Expand Up @@ -112,9 +112,9 @@
choices: ['yes', 'no']
config:
description:
- The playbook designer can use the C(config) argument to supply
- The playbook designer can use the C(config) argument to supply
the base configuration to be used to validate necessary configuration
changes. If you provide this argument, the module
changes. If you specify this argument, the module
does not download the running-config from the remote node.
required: false
default: null
Expand Down Expand Up @@ -184,10 +184,14 @@
description: Returns whether the configuration is saved to the startup
configuration or not.
returned: When not check_mode.

type: bool
sample: True

backup_path:
description: The full path to the backup file
returned: when backup is yes
type: string
sample: /playbooks/ansible/backup/dellos9_config.2016-07-16@22:28:34
"""
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.dellos9 import get_config, get_sublevel_config
Expand Down
4 changes: 2 additions & 2 deletions lib/ansible/modules/network/eos/eos_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,8 +184,8 @@
version_added: "2.4"
diff_against:
description:
- When using the C(ansible-playbook --diff) command line argument the i
module can generate diffs against different sources.
- When using the C(ansible-playbook --diff) command line argument
the module can generate diffs against different sources.
- When this option is configure as I(startup), the module will return
the diff of the running-config against the startup-config.
- When this option is configured as I(intended), the module will
Expand Down
5 changes: 5 additions & 0 deletions lib/ansible/modules/network/vyos/vyos_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@
returned: always
type: list
sample: ['...', '...']
backup_path:
description: The full path to the backup file
returned: when backup is yes
type: string
sample: /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34
"""
import re

Expand Down