ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-25 14:20:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

vyos_command Document ANSIBLE_VYOS_TERMINAL_LENGTH (#5676)

Browse source 
* 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:
Sam Doran 2016-11-22 11:00:01 -05:00 • committed by Matt Clay
commit bf184b1a92
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/modules/network/vyos/vyos_command.py
View file

@ -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:
@ -43,15 +47,15 @@ options:
- Specifies what to evaluate from the output of the command - Specifies what to evaluate from the output of the command
and what conditionals to apply. This argument will cause and what conditionals to apply. This argument will cause
the task to wait for a particular conditional to be true the task to wait for a particular conditional to be true
before moving forward. If the conditional is not true before moving forward. If the conditional is not true
by the configured I(retries), the task fails. See examples. by the configured I(retries), the task fails. See examples.
required: false required: false
default: null default: null
aliases: ['waitfor'] aliases: ['waitfor']
match: match:
description: description:
- The I(match) argument is used in conjunction with the - The I(match) argument is used in conjunction with the
I(wait_for) argument to specify the match policy. Valid I(wait_for) argument to specify the match policy. Valid
values are C(all) or C(any). If the value is set to C(all) values are C(all) or C(any). If the value is set to C(all)
then all conditionals in the wait_for must be satisfied. If then all conditionals in the wait_for must be satisfied. If
the value is set to C(any) then only one of the values must be the value is set to C(any) then only one of the values must be
@ -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 = """