diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vyos.rest.vyos_command_module.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/vyos.rest.vyos_command_module.rst b/docs/vyos.rest.vyos_command_module.rst index 7075ec6..56354ca 100644 --- a/docs/vyos.rest.vyos_command_module.rst +++ b/docs/vyos.rest.vyos_command_module.rst @@ -134,6 +134,7 @@ Notes - ``ansible_network_os`` must be set to ``vyos.rest.vyos``. - Only ``show`` commands are supported via the REST API. - Commands are passed as path lists to the ``/show`` endpoint. + - A command the device rejects fails the task at once and is not retried. ``stdout`` then holds the output of the commands that ran before it. @@ -194,6 +195,21 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late <tr> <td colspan="1"> <div class="ansibleOptionAnchor" id="return-"></div> + <b>failed_command</b> + <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> + <div style="font-size: small"> + <span style="color: purple">raw</span> + </div> + </td> + <td>failed, when a command was rejected</td> + <td> + <div>The command the device rejected.</div> + <br/> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="return-"></div> <b>failed_conditions</b> <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> <div style="font-size: small"> |
