mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-26 22:51:23 -07:00
vyos_command Document ANSIBLE_VYOS_TERMINAL_LENGTH (#5676)
* Update documentation for vyos_command Add information on new environment variable added in #18546. Add note on command that should not be run via Ansible. * White space changes Two spaces after period.
This commit is contained in:
parent
1fe0bd33f3
commit
bf184b1a92
1 changed files with 11 additions and 3 deletions
|
@ -28,6 +28,10 @@ description:
|
||||||
to validate key parameters before returning successfully. If the
|
to validate key parameters before returning successfully. If the
|
||||||
conditional statements are not met in the wait period, the task
|
conditional statements are not met in the wait period, the task
|
||||||
fails.
|
fails.
|
||||||
|
- Certain C(show) commands in VyOS produce many lines of output and
|
||||||
|
use a custom pager that can cause this module to hang. If the
|
||||||
|
value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH)
|
||||||
|
is not set, the default number of 10000 is used.
|
||||||
extends_documentation_fragment: vyos
|
extends_documentation_fragment: vyos
|
||||||
options:
|
options:
|
||||||
commands:
|
commands:
|
||||||
|
@ -75,6 +79,10 @@ options:
|
||||||
trying the command again.
|
trying the command again.
|
||||||
required: false
|
required: false
|
||||||
default: 1
|
default: 1
|
||||||
|
|
||||||
|
notes:
|
||||||
|
- Running C(show system boot-messages all) will cause the module to hang since
|
||||||
|
VyOS is using a custom pager setting to display the output of that command.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = """
|
EXAMPLES = """
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue