1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Document backup_path (#31844)

Fix a few consistency issues at the same time
This commit is contained in:
John R Barker 2017-10-18 14:07:28 +01:00 committed by GitHub
parent 6bf0cc36a7
commit 598084fbc8
6 changed files with 32 additions and 14 deletions

View file

@ -58,7 +58,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:

View file

@ -48,7 +48,7 @@ options:
- Specifies the source path to the file that contains the configuration - Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can 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 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). exclusive with I(lines).
required: false required: false
default: null default: null
@ -182,7 +182,11 @@ saved:
returned: When not check_mode. returned: When not check_mode.
type: bool type: bool
sample: True 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.basic import AnsibleModule
from ansible.module_utils.dellos10 import get_config, get_sublevel_config from ansible.module_utils.dellos10 import get_config, get_sublevel_config

View file

@ -38,7 +38,7 @@ options:
parents: parents:
description: description:
- The ordered set of parents that uniquely identify the section - 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. level or global commands.
required: false required: false
default: null default: null
@ -47,7 +47,7 @@ options:
- Specifies the source path to the file that contains the configuration - Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can 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 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). exclusive with I(lines).
required: false required: false
default: null default: null
@ -63,7 +63,7 @@ options:
after: after:
description: description:
- The ordered set of commands to append to the end of the command - 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. executed after the command set.
required: false required: false
default: null default: null
@ -75,7 +75,7 @@ options:
match to I(strict), command lines matched by respect match to I(strict), command lines matched by respect
to position. If you set match to I(exact), command lines 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 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. the running configuration on the remote device.
required: false required: false
default: line default: line
@ -181,6 +181,11 @@ saved:
type: bool type: bool
sample: True 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.basic import AnsibleModule
from ansible.module_utils.dellos6 import get_config, get_sublevel_config, Dellos6NetworkConfig from ansible.module_utils.dellos6 import get_config, get_sublevel_config, Dellos6NetworkConfig

View file

@ -47,7 +47,7 @@ options:
- Specifies the source path to the file that contains the configuration - Specifies the source path to the file that contains the configuration
or configuration template to load. The path to the source file can 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 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). exclusive with I(lines).
required: false required: false
default: null default: null
@ -74,7 +74,7 @@ options:
match to I(line), commands match line by line. If you set 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 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 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. the running configuration on the remote device.
required: false required: false
default: line default: line
@ -112,9 +112,9 @@ options:
choices: ['yes', 'no'] choices: ['yes', 'no']
config: config:
description: 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 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. does not download the running-config from the remote node.
required: false required: false
default: null default: null
@ -184,10 +184,14 @@ saved:
description: Returns whether the configuration is saved to the startup description: Returns whether the configuration is saved to the startup
configuration or not. configuration or not.
returned: When not check_mode. returned: When not check_mode.
type: bool type: bool
sample: True 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.basic import AnsibleModule
from ansible.module_utils.dellos9 import get_config, get_sublevel_config from ansible.module_utils.dellos9 import get_config, get_sublevel_config

View file

@ -184,8 +184,8 @@ options:
version_added: "2.4" version_added: "2.4"
diff_against: diff_against:
description: description:
- When using the C(ansible-playbook --diff) command line argument the i - When using the C(ansible-playbook --diff) command line argument
module can generate diffs against different sources. the module can generate diffs against different sources.
- When this option is configure as I(startup), the module will return - When this option is configure as I(startup), the module will return
the diff of the running-config against the startup-config. the diff of the running-config against the startup-config.
- When this option is configured as I(intended), the module will - When this option is configured as I(intended), the module will

View file

@ -123,6 +123,11 @@ filtered:
returned: always returned: always
type: list type: list
sample: ['...', '...'] 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 import re