From 42d5d7b21b39f44cf6c6ddcd930754ca79775ea9 Mon Sep 17 00:00:00 2001 From: John Barker Date: Wed, 14 Sep 2016 12:06:18 +0100 Subject: [PATCH] Docs improvements to _config --- .../modules/network/dnos10/dnos10_config.py | 6 +++--- lib/ansible/modules/network/eos/eos_config.py | 18 +++++++++-------- lib/ansible/modules/network/ios/ios_config.py | 8 ++++---- .../modules/network/iosxr/iosxr_config.py | 12 +++++------ .../modules/network/junos/junos_config.py | 4 ++-- .../modules/network/nxos/nxos_config.py | 20 +++++++++---------- .../modules/network/openswitch/ops_config.py | 13 ++++++------ .../modules/network/sros/sros_config.py | 6 +++--- 8 files changed, 45 insertions(+), 42 deletions(-) diff --git a/lib/ansible/modules/network/dnos10/dnos10_config.py b/lib/ansible/modules/network/dnos10/dnos10_config.py index 8aa64c973d2..9e630ce33b2 100644 --- a/lib/ansible/modules/network/dnos10/dnos10_config.py +++ b/lib/ansible/modules/network/dnos10/dnos10_config.py @@ -35,7 +35,7 @@ options: section. The commands must be the exact same commands as found in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the - device config parser. This argument is mutually exclusive with O(src). + device config parser. This argument is mutually exclusive with I(src). required: false default: null aliases: ['commands'] @@ -53,7 +53,7 @@ options: 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 - exclusive with O(lines). + exclusive with I(lines). required: false default: null before: @@ -68,7 +68,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 diff --git a/lib/ansible/modules/network/eos/eos_config.py b/lib/ansible/modules/network/eos/eos_config.py index 9137946ca42..2707bc90fe6 100644 --- a/lib/ansible/modules/network/eos/eos_config.py +++ b/lib/ansible/modules/network/eos/eos_config.py @@ -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 diff --git a/lib/ansible/modules/network/ios/ios_config.py b/lib/ansible/modules/network/ios/ios_config.py index b4bce06758f..aa67959998c 100644 --- a/lib/ansible/modules/network/ios/ios_config.py +++ b/lib/ansible/modules/network/ios/ios_config.py @@ -94,7 +94,7 @@ options: the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any - line is not correct + line is not correct. required: false default: line choices: ['line', 'block'] @@ -105,7 +105,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 @@ -204,8 +204,8 @@ vars: RETURN = """ updates: description: The set of commands that will be pushed to the remote device - returned: always - type: when lines is defined + returned: Only when C(lines) is specified. + type: list sample: ['...', '...'] backup_path: description: The full path to the backup file diff --git a/lib/ansible/modules/network/iosxr/iosxr_config.py b/lib/ansible/modules/network/iosxr/iosxr_config.py index 25ffad7c7e6..9f9e84f0ffa 100644 --- a/lib/ansible/modules/network/iosxr/iosxr_config.py +++ b/lib/ansible/modules/network/iosxr/iosxr_config.py @@ -63,13 +63,13 @@ options: 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: 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 @@ -94,7 +94,7 @@ options: the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any - line is not correct + line is not correct. required: false default: line choices: ['line', 'block', 'config'] @@ -105,7 +105,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 equivalent, 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 @@ -177,8 +177,8 @@ vars: RETURN = """ updates: description: The set of commands that will be pushed to the remote device - returned: always - type: when lines is defined + returned: Only when C(lines) is specified. + type: list sample: ['...', '...'] backup_path: description: The full path to the backup file diff --git a/lib/ansible/modules/network/junos/junos_config.py b/lib/ansible/modules/network/junos/junos_config.py index ac821d00bc3..1a082d81a86 100644 --- a/lib/ansible/modules/network/junos/junos_config.py +++ b/lib/ansible/modules/network/junos/junos_config.py @@ -43,7 +43,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 @@ -133,7 +133,7 @@ requirements: - junos-eznc notes: - This module requires the netconf system service be enabled on - the remote device being managed + the remote device being managed. """ EXAMPLES = """ diff --git a/lib/ansible/modules/network/nxos/nxos_config.py b/lib/ansible/modules/network/nxos/nxos_config.py index ab628fa7926..d3875e634fd 100644 --- a/lib/ansible/modules/network/nxos/nxos_config.py +++ b/lib/ansible/modules/network/nxos/nxos_config.py @@ -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,11 +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. - - Version 2.2 added a new choice I(none). When match is set to - none, the configure is loaded into the remote device without - consulting the configuration. + 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'] @@ -107,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 @@ -146,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,7 +199,7 @@ vars: RETURN = """ updates: description: The set of commands that will be pushed to the remote device - returned: when list is specified + returned: Only when C(lines) is specified. type: list sample: ['...', '...'] backup_path: @@ -331,5 +330,6 @@ def main(): module.exit_json(**result) + if __name__ == '__main__': main() diff --git a/lib/ansible/modules/network/openswitch/ops_config.py b/lib/ansible/modules/network/openswitch/ops_config.py index a83bda2f764..8c65144b079 100644 --- a/lib/ansible/modules/network/openswitch/ops_config.py +++ b/lib/ansible/modules/network/openswitch/ops_config.py @@ -52,7 +52,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 @@ -69,7 +69,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 @@ -80,8 +80,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'] @@ -103,7 +105,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 equivalent, 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 @@ -304,4 +306,3 @@ def main(): if __name__ == '__main__': main() - diff --git a/lib/ansible/modules/network/sros/sros_config.py b/lib/ansible/modules/network/sros/sros_config.py index 2ac47b83074..1ebc2297730 100644 --- a/lib/ansible/modules/network/sros/sros_config.py +++ b/lib/ansible/modules/network/sros/sros_config.py @@ -63,7 +63,7 @@ options: 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: @@ -94,7 +94,7 @@ options: the modified lines are pushed to the device in configuration mode. If the replace argument is set to I(block) then the entire command block is pushed to the device in configuration mode if any - line is not correct + line is not correct. required: false default: line choices: ['line', 'block'] @@ -105,7 +105,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