diff options
| author | GomathiselviS <gomathiselvi@gmail.com> | 2020-07-31 17:53:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-31 21:53:09 +0000 |
| commit | 1b58f4b0195b866b5d322c314ce66dcf72f8a9af (patch) | |
| tree | dc36dad6a908abb339c831b891ebaebdd753436b /docs/vyos.vyos.vyos_command_module.rst | |
| parent | 84e5bb7da5cbafdd64325d26d57abc9bcf79b2dc (diff) | |
| download | vyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.tar.gz vyos.vyos-1b58f4b0195b866b5d322c314ce66dcf72f8a9af.zip | |
Update docs (#73)
vyos: Update docs
Reviewed-by: GomathiselviS
https://github.com/GomathiselviS
Diffstat (limited to 'docs/vyos.vyos.vyos_command_module.rst')
| -rw-r--r-- | docs/vyos.vyos.vyos_command_module.rst | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index dd7e2994..bd3d5e69 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -40,13 +40,14 @@ Parameters <b>commands</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - / <span style="color: red">required</span> </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=raw</span> / <span style="color: red">required</span> </div> </td> <td> </td> <td> <div>The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the <em>wait_for</em> argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.</div> + <div>If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage return, must be double quotes). Refer below examples.</div> </td> </tr> <tr> @@ -55,7 +56,7 @@ Parameters <b>interval</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -71,7 +72,7 @@ Parameters <b>match</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">string</span> </div> </td> <td> @@ -111,7 +112,7 @@ Parameters <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> <span style="color: purple">string</span> - / <span style="color: red">required</span> </div> + </div> </td> <td> </td> @@ -146,8 +147,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">22</div> - </td> + </td> <td> <div>Specifies the port to use when building the connection to the remote device.</div> </td> @@ -179,8 +179,7 @@ Parameters </div> </td> <td> - <b>Default:</b><br/><div style="color: blue">10</div> - </td> + </td> <td> <div>Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.</div> </td> @@ -208,7 +207,7 @@ Parameters <b>retries</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> + <span style="color: purple">integer</span> </div> </td> <td> @@ -224,8 +223,8 @@ Parameters <b>wait_for</b> <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> <div style="font-size: small"> - <span style="color: purple">-</span> - </div> + <span style="color: purple">list</span> + / <span style="color: purple">elements=string</span> </div> </td> <td> </td> |