updates docstring for sros modules (#5197)

This commit is contained in:
Peter Sprygada 2016-10-07 23:11:59 -04:00 committed by Matt Clay
parent a89992f70f
commit 3fbae6f10f
3 changed files with 11 additions and 11 deletions

View file

@ -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

View file

@ -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:

View file

@ -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: