network_cli modules don't always return stdout or stdout_lines (#23573)

It's possible that if the module has a low-level failure, such as
"unable to open shell", or something else in the action plugin that
stdout and stdout_lines will not be returned.

Update the documentation to clarify this point.
This commit is contained in:
John R Barker 2017-04-13 11:59:23 -04:00 committed by GitHub
parent 952e842720
commit 2bb25d031b
10 changed files with 40 additions and 25 deletions

View file

@ -118,13 +118,13 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]

View file

@ -118,13 +118,13 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]

View file

@ -126,22 +126,19 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']
warnings:
description: The list of warnings (if any) generated by module based on arguments
returned: always

View file

@ -116,8 +116,18 @@ EXAMPLES = """
"""
RETURN = """
stdout:
description: The set of responses from the commands
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: the conditionals that failed
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']

View file

@ -115,12 +115,12 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:

View file

@ -115,12 +115,12 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:

View file

@ -129,8 +129,18 @@ EXAMPLES = """
"""
RETURN = """
stdout:
description: The set of responses from the commands
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: the conditionals that failed
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']

View file

@ -138,19 +138,17 @@ vars:
RETURN = """
stdout:
description: the set of responses from the commands
returned: always
description: The set of responses from the commands
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: the conditionals that failed
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']

View file

@ -128,13 +128,13 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]

View file

@ -112,7 +112,7 @@ tasks:
RETURN = """
stdout:
description: The set of responses from the commands
returned: always
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
@ -121,7 +121,7 @@ stdout_lines:
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: The conditionals that have failed
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']