diff options
| author | omnom62 <omnom62@outlook.com> | 2026-03-20 21:50:13 +1000 |
|---|---|---|
| committer | omnom62 <omnom62@outlook.com> | 2026-03-20 21:50:13 +1000 |
| commit | 7599ba96bc3b659cb2a5f00b1be46ab6f55f48a6 (patch) | |
| tree | 35b39a126fe94f8917352aa2c229d3022d1223e4 /docs/vyos.rest.vyos_httpapi.rst | |
| parent | 9dc03bb92e08455812e0969505495309456a4bfb (diff) | |
| download | rest.vyos-7599ba96bc3b659cb2a5f00b1be46ab6f55f48a6.tar.gz rest.vyos-7599ba96bc3b659cb2a5f00b1be46ab6f55f48a6.zip | |
precommit changes
Diffstat (limited to 'docs/vyos.rest.vyos_httpapi.rst')
| -rw-r--r-- | docs/vyos.rest.vyos_httpapi.rst | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/vyos.rest.vyos_httpapi.rst b/docs/vyos.rest.vyos_httpapi.rst new file mode 100644 index 0000000..7d887b5 --- /dev/null +++ b/docs/vyos.rest.vyos_httpapi.rst @@ -0,0 +1,79 @@ +.. _vyos.rest.vyos_httpapi: + + +************** +vyos.rest.vyos +************** + +**VyOS REST API** + + + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- HTTPAPI plugin for interacting with VyOS REST API. + + + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th>Configuration</th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>api_key</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">string</span> + </div> + </td> + <td> + </td> + <td> + <div> ini entries: + <p>[httpapi]<br>api_key = VALUE</p> + </div> + <div>env:ANSIBLE_HTTPAPI_API_KEY</div> + <div>var: ansible_httpapi_api_key</div> + </td> + <td> + <div>VyOS API key</div> + </td> + </tr> + </table> + <br/> + + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- Evgeny Molotkov (@eomnom62) + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. |