summaryrefslogtreecommitdiff
path: root/plugins/modules/vyos_system.py
diff options
context:
space:
mode:
authorRohit <rohitthakur2590@outlook.com>2020-06-01 13:05:52 +0530
committerGitHub <noreply@github.com>2020-06-01 07:35:52 +0000
commit06235439435396c852535c2569542939bf65ef43 (patch)
treeff9facb3636f13b205bea0d14c7b0c9b12e3f18a /plugins/modules/vyos_system.py
parent24a6864db07e5f61cdd952a528d4fd6c147d8db4 (diff)
downloadvyos.vyos-06235439435396c852535c2569542939bf65ef43.tar.gz
vyos.vyos-06235439435396c852535c2569542939bf65ef43.zip
[VyOS: ]all modules updated with FQCN and new doc changes (#33)
[VyOS: ]all modules updated with FQCN and new doc changes Reviewed-by: https://github.com/apps/ansible-zuul
Diffstat (limited to 'plugins/modules/vyos_system.py')
-rw-r--r--plugins/modules/vyos_system.py26
1 files changed, 9 insertions, 17 deletions
diff --git a/plugins/modules/vyos_system.py b/plugins/modules/vyos_system.py
index b49462b6..53b04c8c 100644
--- a/plugins/modules/vyos_system.py
+++ b/plugins/modules/vyos_system.py
@@ -17,19 +17,15 @@
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
-ANSIBLE_METADATA = {
- "metadata_version": "1.1",
- "status": ["preview"],
- "supported_by": "network",
-}
-
-DOCUMENTATION = """module: vyos_system
+DOCUMENTATION = """
+module: vyos_system
author: Nathaniel Case (@Qalthos)
short_description: Run `set system` commands on VyOS devices
description:
- Runs one or more commands on remote devices running VyOS. This module can also be
introspected to validate key parameters before returning successfully.
+version_added: 1.0.0
extends_documentation_fragment:
- vyos.vyos.vyos
notes:
@@ -71,25 +67,21 @@ commands:
EXAMPLES = """
- name: configure hostname and domain-name
- vyos_system:
+ vyos.vyos.vyos_system:
host_name: vyos01
domain_name: test.example.com
- name: remove all configuration
- vyos_system:
+ vyos.vyos.vyos_system:
state: absent
- name: configure name servers
- vyos_system:
- name_servers
- - 8.8.8.8
- - 8.8.4.4
-
+ vyos.vyos.vyos_system: name_servers - 8.8.8.8 - 8.8.4.4
- name: configure domain search suffixes
- vyos_system:
+ vyos.vyos.vyos_system:
domain_search:
- - sub1.example.com
- - sub2.example.com
+ - sub1.example.com
+ - sub2.example.com
"""
from ansible.module_utils.basic import AnsibleModule