From 92b7323c353f473c9d5bdb7930e9490a5dafcd41 Mon Sep 17 00:00:00 2001 From: omnom62 Date: Tue, 19 May 2026 05:35:04 +1000 Subject: lldp_global --- docs/vyos.rest.vyos_info_module.rst | 222 ------------------------------------ 1 file changed, 222 deletions(-) delete mode 100644 docs/vyos.rest.vyos_info_module.rst (limited to 'docs') diff --git a/docs/vyos.rest.vyos_info_module.rst b/docs/vyos.rest.vyos_info_module.rst deleted file mode 100644 index 60cf87d..0000000 --- a/docs/vyos.rest.vyos_info_module.rst +++ /dev/null @@ -1,222 +0,0 @@ -.. _vyos.rest.vyos_info_module: - - -******************* -vyos.rest.vyos_info -******************* - -**Retrieve system information from a VyOS device via the REST API.** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - - -Synopsis --------- -- Queries the public ``/info`` endpoint (HTTP GET) which requires no authentication and returns the VyOS version, hostname, and a welcome banner. - - - -Requirements ------------- -The below requirements are needed on the host that executes this module. - -- VyOS 1.3+ - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- api_key - -
- string -
- 		- -
API key. Not required for this module (the /info endpoint is public) but kept in the spec for consistency with other modules in this collection.
-
-
- hostname - -
- string - / required -
- 		- -
IP address or FQDN of the VyOS device.
-
-
- port - -
- integer -
- 		- Default:
443
- 		-
HTTPS port for the REST API.
-
-
- timeout - -
- integer -
- 		- Default:
10
- 		-
Request timeout in seconds.
-
-
- verify_ssl - -
- boolean -
- 		-
    Choices: -
  • no ←
    • -
  • yes
    • -
- 		-
Validate the device's TLS certificate.
-
-
- - - - - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeyReturnedDescription
-
- banner - -
- string -
- 		success -
Welcome banner text.
-
-
Sample:
-
Welcome to VyOS
-
-
- hostname - -
- string -
- 		success -
System hostname.
-
-
Sample:
-
vyos-router
-
-
- info - -
- dictionary -
- 		success -
Full info dict as returned by the device.
-
-
-
- version - -
- string -
- 		success -
VyOS version string.
-
-
Sample:
-
1.4-rolling-202401010000
-
-

- - -Status ------- - - -Authors -~~~~~~~ - -- VyOS Community (@vyos) -- cgit v1.2.3