summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromnom62 <omnom62@outlook.com>2026-07-10 16:50:38 +1000
committeromnom62 <omnom62@outlook.com>2026-07-10 16:50:38 +1000
commit1e190aa2d3e8fcafdee25c3ee137fe03eccf6b7c (patch)
tree028454cc712e3be6e93df054d561667112d9c38a /docs
parentee7f171c6af8eb5ac37d34d1f58196fb3cb89cf4 (diff)
downloadrest.vyos-1e190aa2d3e8fcafdee25c3ee137fe03eccf6b7c.tar.gz
rest.vyos-1e190aa2d3e8fcafdee25c3ee137fe03eccf6b7c.zip
T8323: vyos_system module
Diffstat (limited to 'docs')
-rw-r--r--docs/vyos.rest.vyos_system_module.rst16
1 files changed, 2 insertions, 14 deletions
diff --git a/docs/vyos.rest.vyos_system_module.rst b/docs/vyos.rest.vyos_system_module.rst
index 9b97920..c14d88e 100644
--- a/docs/vyos.rest.vyos_system_module.rst
+++ b/docs/vyos.rest.vyos_system_module.rst
@@ -18,7 +18,6 @@ Version added: 1.0.0
Synopsis
--------
- Manages basic system settings on VyOS devices via the REST API.
-- Covers hostname, domain name, name servers, and domain search.
- Uses REST API (``connection=httpapi``) instead of CLI.
@@ -140,22 +139,11 @@ Examples
vyos.rest.vyos_system:
host_name: router1
domain_name: example.com
- state: present
-
- - name: Configure name servers
- vyos.rest.vyos_system:
name_server:
- 8.8.8.8
- 8.8.4.4
state: present
- - name: Configure domain search
- vyos.rest.vyos_system:
- domain_search:
- - sub1.example.com
- - sub2.example.com
- state: present
-
- name: Remove domain name and name servers
vyos.rest.vyos_system:
domain_name: example.com
@@ -188,7 +176,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
</td>
<td>when changed</td>
<td>
- <div>System configuration after this module ran.</div>
+ <div>Module-owned system configuration after this module ran.</div>
<br/>
</td>
</tr>
@@ -203,7 +191,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
</td>
<td>always</td>
<td>
- <div>System configuration before this module ran.</div>
+ <div>Module-owned system configuration before this module ran.</div>
<br/>
</td>
</tr>