summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoromnom62 <omnom62@outlook.com>2026-04-15 07:24:24 +1000
committeromnom62 <omnom62@outlook.com>2026-04-15 07:24:24 +1000
commitc3671c4e3e2ad7efa119982f2ee41334fcacd073 (patch)
tree0084638d1b9f71b6be671324779238439f9da5d6 /README.md
parentc9e5c5f6d91bae587a6ce8b7f055b0d068129fe2 (diff)
downloadrest.vyos-c3671c4e3e2ad7efa119982f2ee41334fcacd073.tar.gz
rest.vyos-c3671c4e3e2ad7efa119982f2ee41334fcacd073.zip
Rest API module
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 22 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1d76b68..537d81e 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,27 @@
Ansible collection for managing VyOS via REST API.
-## Plugins
-
-### Httpapi Plugins
-<!--start: httpapi -->
-<!--end: httpapi -->
+<!--start collection content-->
+### Httpapi plugins
+Name | Description
+--- | ---
+[vyos.rest.vyos](https://github.com/vyos/vyos.rest/blob/main/docs/vyos.rest.vyos_httpapi.rst)|VyOS REST API
### Modules
-<!--start: modules -->
-<!--end: modules -->
+Name | Description
+--- | ---
+[vyos.rest.vyos_banner](https://github.com/vyos/vyos.rest/blob/main/docs/vyos.rest.vyos_banner_module.rst)|Manage login banners on VyOS devices using REST API
+[vyos.rest.vyos_hostname](https://github.com/vyos/vyos.rest/blob/main/docs/vyos.rest.vyos_hostname_module.rst)|Manage the hostname of a VyOS device using REST API
+[vyos.rest.vyos_snmp_server](https://github.com/vyos/vyos.rest/blob/main/docs/vyos.rest.vyos_snmp_server_module.rst)|Manage SNMP server configuration on VyOS devices using REST API
+
+<!--end collection content-->
+
+<!--start requires_ansible-->
+## Ansible version compatibility
+
+This collection has been tested against the following Ansible versions: **>=2.16.0**.
+
+Plugins and modules within a collection may be tested with only specific Ansible versions.
+A collection may contain metadata that identifies these versions.
+PEP440 is the schema used to describe the versions of Ansible.
+<!--end requires_ansible-->