diff options
author | Peter Sprygada <privateip@users.noreply.github.com> | 2016-10-07 23:11:59 -0400 |
---|---|---|
committer | Peter Sprygada <psprygada@ansible.com> | 2016-10-07 23:12:37 -0400 |
commit | 75002208e9bbf70299507227601dc6002ff3627e (patch) | |
tree | ff3c3e68cbc98cd5de76deaaae75367000f461ee | |
parent | 0e990491f69610cb379b7bec8374c21d4fa5fb25 (diff) | |
download | ansible-modules-core-75002208e9bbf70299507227601dc6002ff3627e.tar.gz |
updates docstring for sros modules (#5197)
(cherry picked from commit b4763c297bc349ace0905f9e931b3df8d706e4e5)
-rw-r--r-- | network/sros/sros_command.py | 8 | ||||
-rw-r--r-- | network/sros/sros_config.py | 6 | ||||
-rw-r--r-- | network/sros/sros_rollback.py | 8 |
3 files changed, 11 insertions, 11 deletions
diff --git a/network/sros/sros_command.py b/network/sros/sros_command.py index e2e3acd6..e8b6a654 100644 --- a/network/sros/sros_command.py +++ b/network/sros/sros_command.py @@ -21,19 +21,19 @@ DOCUMENTATION = """ module: sros_command version_added: "2.2" author: "Peter Sprygada (@privateip)" -short_description: Run commands on remote devices running Nokia SROS +short_description: Run commands on remote devices running Nokia SR OS description: - - Sends arbitrary commands to an SROS node and returns the results + - Sends arbitrary commands to an SR OS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. - This module does not support running commands in configuration mode. - Please use M(sros_config) to configure SROS devices. + Please use M(sros_config) to configure SR OS devices. extends_documentation_fragment: sros options: commands: description: - - List of commands to send to the remote SROS device over the + - List of commands to send to the remote SR OS device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or diff --git a/network/sros/sros_config.py b/network/sros/sros_config.py index 186c7215..f1fd84a8 100644 --- a/network/sros/sros_config.py +++ b/network/sros/sros_config.py @@ -21,11 +21,11 @@ DOCUMENTATION = """ module: sros_config version_added: "2.2" author: "Peter Sprygada (@privateip)" -short_description: Manage Nokia SROS device configuration +short_description: Manage Nokia SR OS device configuration description: - - Nokia SROS configurations use a simple block indent file syntax + - Nokia SR OS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides - an implementation for working with SROS configuration sections in + an implementation for working with SR OS configuration sections in a deterministic way. extends_documentation_fragment: sros options: diff --git a/network/sros/sros_rollback.py b/network/sros/sros_rollback.py index d04437fb..8d9514c4 100644 --- a/network/sros/sros_rollback.py +++ b/network/sros/sros_rollback.py @@ -21,10 +21,10 @@ DOCUMENTATION = """ module: sros_rollback version_added: "2.2" author: "Peter Sprygada (@privateip)" -short_description: Configure Nokia SROS rollback +short_description: Configure Nokia SR OS rollback description: - Configure the rollback feature on remote Nokia devices running - the SROS operating system. this module provides a stateful + the SR OS operating system. this module provides a stateful implementation for managing the configuration of the rollback feature extends_documentation_fragment: sros @@ -33,7 +33,7 @@ options: description: - The I(rollback_location) specifies the location and filename of the rollback checkpoint files. This argument supports any - valid local or remote URL as specified in SROS + valid local or remote URL as specified in SR OS required: false default: null remote_max_checkpoints: @@ -56,7 +56,7 @@ options: description: - The I(rescue_location) specifies the location of the rescue file. This argument supports any valid local - or remote URL as specified in SROS + or remote URL as specified in SR OS required: false default: null state: |