From ec7fec4446b2a6e7c36fb46d486cf3ac4b3589cf Mon Sep 17 00:00:00 2001 From: omnom62 Date: Sun, 20 Sep 2026 09:05:24 +1000 Subject: https: T8989: auth_methods AI comments fixed --- docs/vyos.rest.vyos_httpapi.rst | 157 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 docs/vyos.rest.vyos_httpapi.rst diff --git a/docs/vyos.rest.vyos_httpapi.rst b/docs/vyos.rest.vyos_httpapi.rst new file mode 100644 index 0000000..99e1924 --- /dev/null +++ b/docs/vyos.rest.vyos_httpapi.rst @@ -0,0 +1,157 @@ +.. _vyos.rest.vyos_httpapi: + + +************** +vyos.rest.vyos +************** + +**HttpApi plugin for VyOS REST API** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- This HttpApi plugin provides methods to connect to VyOS devices via their HTTPS REST API. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsConfigurationComments
+
+ api_key + +
+ string +
+ 		+ +
env:VYOS_API_KEY
+
var: ansible_httpapi_api_key
+
var: ansible_vyos_api_key
+ 		+
The API key configured on the VyOS device.
+
+
+ auth_method + +
+ string +
+ 		+
    Choices: +
  • key ←
    • +
  • header
    • +
  • bearer
    • +
  • mtls
    • +
  • oidc
    • +
+ 		+
var: ansible_httpapi_vyos_auth_method
+
var: ansible_vyos_auth_method
+ 		+
+
+ oidc_client_id + +
+ string +
+ 		+ +
var: ansible_vyos_oidc_client_id
+ 		+
+
+ oidc_client_secret + +
+ string +
+ 		+ +
var: ansible_vyos_oidc_client_secret
+ 		+
+
+ oidc_token_url + +
+ string +
+ 		+ +
var: ansible_vyos_oidc_token_url
+ 		+
Full URL of the OAuth2/OIDC token endpoint.
+
Required when auth_method=oidc.
+
Must use https:// -- the client secret is sent in the request body, so an http:// URL is rejected to avoid transmitting it in plaintext.
+
+
+ + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- VyOS Community (@vyos) + + +.. 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. -- cgit v1.2.3