From a45e2988263f5109a56b6dcb2c46ecbc6738cb3a Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 27 Aug 2020 14:58:25 -0400 Subject: Release 1.0.4 (#81) Release 1.0.4 Reviewed-by: https://github.com/apps/ansible-zuul --- docs/vyos.vyos.vyos_system_module.rst | 278 +++++++++++++++++----------------- 1 file changed, 138 insertions(+), 140 deletions(-) (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 index acca366..a71303c 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -31,205 +31,207 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
domain_name
string -
- - - - -
The new domain name to apply to the device.
- + + + + + +
The new domain name to apply to the device.
+ - - + +
domain_search
list - / elements=string
- - - - -
A list of domain names to search. Mutually exclusive with name_server
- + / elements=string + + + + + +
A list of domain names to search. Mutually exclusive with name_server
+ - - + +
host_name
string -
- - - - -
Configure the device hostname parameter. This option takes an ASCII string value.
- + + + + + +
Configure the device hostname parameter. This option takes an ASCII string value.
+ - - + +
name_server
list - / elements=string
- - - - -
A list of name servers to use with the device. Mutually exclusive with domain_search
-

aliases: name_servers
- + / elements=string + + + + + +
A list of name servers to use with the device. Mutually exclusive with domain_search
+

aliases: name_servers
+ - - + +
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.
- + + + + + +
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 -
- - - - -
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.
- + + + + + +
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.
- + + + + + +
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 -
- - - - -
Specifies the port to use when building the connection to the remote device.
- + + + + + +
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.
- + + + + + +
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 -
- - - - -
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.
- + + + + + +
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.
- + + + + + +
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
string -
- - - - - -
Whether to apply (present) or remove (absent) the settings.
- + + + + + + +
Whether to apply (present) or remove (absent) the settings.
+ - +
@@ -248,7 +250,6 @@ Examples .. code-block:: yaml+jinja - - name: configure hostname and domain-name vyos.vyos.vyos_system: host_name: vyos01 @@ -268,7 +269,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -281,24 +281,24 @@ Common return values are documented `here Returned Description - - + +
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']
- +
The list of configuration mode commands to send to the device
+
+
Sample:
+
['set system hostname vyos01', 'set system domain-name foo.example.com']
+ - +

@@ -310,5 +310,3 @@ Authors ~~~~~~~ - Nathaniel Case (@Qalthos) - - -- cgit v1.2.3