mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
Docs improvements to _config
This commit is contained in:
@@ -53,7 +53,7 @@ options:
|
||||
to load into the remote system. The path can either be a full
|
||||
system path to the configuration file if the value starts with /
|
||||
or relative to the root of the implemented role or playbook.
|
||||
This arugment is mutually exclusive with the I(lines) and
|
||||
This argument is mutually exclusive with the I(lines) and
|
||||
I(parents) arguments.
|
||||
required: false
|
||||
default: null
|
||||
@@ -70,7 +70,7 @@ options:
|
||||
after:
|
||||
description:
|
||||
- The ordered set of commands to append to the end of the command
|
||||
stack if a changed needs to be made. Just like with I(before) this
|
||||
stack if a change needs to be made. Just like with I(before) this
|
||||
allows the playbook designer to append a set of commands to be
|
||||
executed after the command set.
|
||||
required: false
|
||||
@@ -81,8 +81,10 @@ options:
|
||||
the set of commands against the current device config. If
|
||||
match is set to I(line), commands are matched line by line. If
|
||||
match is set to I(strict), command lines are matched with respect
|
||||
to position. Finally if match is set to I(exact), command lines
|
||||
must be an equal match.
|
||||
to position. If match is set to I(exact), command lines
|
||||
must be an equal match. Finally, if match is set to I(none), the
|
||||
module will not attempt to compare the source configuration with
|
||||
the running configuration on the remote device.
|
||||
required: false
|
||||
default: line
|
||||
choices: ['line', 'strict', 'exact', 'none']
|
||||
@@ -104,7 +106,7 @@ options:
|
||||
cause the module to push the contents of I(src) into the device
|
||||
without first checking if already configured.
|
||||
- Note this argument should be considered deprecated. To achieve
|
||||
the equivalient, set the match argument to none. This argument
|
||||
the equivalent, set the C(match=none) which is idempotent. This argument
|
||||
will be removed in a future release.
|
||||
required: false
|
||||
default: false
|
||||
@@ -143,7 +145,7 @@ options:
|
||||
version_added: "2.2"
|
||||
save:
|
||||
description:
|
||||
- The I(save) argument will instruct the module to save the
|
||||
- The C(save) argument instructs the module to save the
|
||||
running-config to startup-config. This operation is performed
|
||||
after any changes are made to the current running config. If
|
||||
no changes are made, the configuration is still saved to the
|
||||
@@ -200,8 +202,8 @@ vars:
|
||||
RETURN = """
|
||||
updates:
|
||||
description: The set of commands that will be pushed to the remote device
|
||||
returned: when lines is specified
|
||||
type: when lines is specified
|
||||
returned: Only when C(lines) is specified.
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
backup_path:
|
||||
description: The full path to the backup file
|
||||
|
||||
Reference in New Issue
Block a user