From 84afad5130564a8ad48e756cca1566c17eaafc36 Mon Sep 17 00:00:00 2001 From: Rohit Date: Thu, 18 Jun 2020 01:48:45 +0530 Subject: [VyOS]: update readme and add .rst files (#44) [VyOS]: update readme and add .rst files Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_system_module.rst | 320 ++++++++++++++++++++++++++++++++++ 1 file changed, 320 insertions(+) create mode 100644 docs/vyos.vyos.vyos_system_module.rst (limited to 'docs/vyos.vyos.vyos_system_module.rst') diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst new file mode 100644 index 00000000..c74f3f7d --- /dev/null +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -0,0 +1,320 @@ +:orphan: + +.. _vyos.vyos.vyos_system_module: + + +********************* +vyos.vyos.vyos_system +********************* + +**Run `set system` commands on VyOS devices** + + +Version added: 1.0.0 + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. + + + + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsComments
+
+ domain_name + +
+ - +
+ 		+ +
The new domain name to apply to the device.
+
+
+ domain_search + +
+ - +
+ 		+ +
A list of domain names to search. Mutually exclusive with name_server
+
+
+ host_name + +
+ - +
+ 		+ +
Configure the device hostname parameter. This option takes an ASCII string value.
+
+
+ name_servers + +
+ - +
+ 		+ +
A list of name servers to use with the device. Mutually exclusive with domain_search
+

aliases: name_server
+
+
+ provider + +
+ dictionary +
+ 		+ +
Deprecated
+
Starting with Ansible 2.5 we recommend using connection: network_cli.
+
For more information please see the Network Guide.
+
+
A dict object containing connection details.
+
+
+ host + +
+ string + / required
+ 		+ +
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
+
+
+ password + +
+ string +
+ 		+ +
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
+
+
+ port + +
+ integer +
+ 		+ Default:
22
+ 		+
Specifies the port to use when building the connection to the remote device.
+
+
+ ssh_keyfile + +
+ path +
+ 		+ +
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
+
+
+ timeout + +
+ integer +
+ 		+ Default:
10
+ 		+
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
+
+
+ username + +
+ string +
+ 		+ +
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
+
+
+ state + +
+ - +
+ 		+
    Choices: +
  • present ←
    • +
  • absent
    • +
+ 		+
Whether to apply (present) or remove (absent) the settings.
+
+
+ + +Notes +----- + +.. note:: + - Tested against VyOS 1.1.8 (helium). + - This module works with connection ``network_cli``. See `the VyOS OS Platform Options <../network/user_guide/platform_vyos.html>`_. + - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` + + + +Examples +-------- + +.. code-block:: yaml+jinja + + + - name: configure hostname and domain-name + vyos.vyos.vyos_system: + host_name: vyos01 + domain_name: test.example.com + + - name: remove all configuration + vyos.vyos.vyos_system: + state: absent + + - name: configure name servers + vyos.vyos.vyos_system: name_servers - 8.8.8.8 - 8.8.4.4 + - name: configure domain search suffixes + vyos.vyos.vyos_system: + domain_search: + - sub1.example.com + - sub2.example.com + + + + +Return Values +------------- +Common return values are documented `here `_, the following are the fields unique to this module: + +.. raw:: html + + + + + + + + + + + + +
KeyReturnedDescription
+
+ commands + +
+ list +
+ 		always +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set system hostname vyos01', 'set system domain-name foo.example.com']
+
+

+ + +Status +------ + + +Authors +~~~~~~~ + +- Nathaniel Case (@Qalthos) + + +.. 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