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_facts_module.rst | 352 +++++++++++++++++------------------ 1 file changed, 175 insertions(+), 177 deletions(-) (limited to 'docs/vyos.vyos.vyos_facts_module.rst') diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index f609b9e..d285864 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -31,156 +31,158 @@ Parameters Parameter Choices/Defaults - Comments + Comments - - + +
gather_network_resources
list - / elements=string
- - - - -
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'.
- + / elements=string + + + + + +
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. Valid subsets are 'all', 'interfaces', 'l3_interfaces', 'lag_interfaces', 'lldp_global', 'lldp_interfaces', 'static_routes', 'firewall_rules', 'firewall_global', 'firewall_interfaces', 'ospfv3', 'ospfv2'.
+ - - + +
gather_subset
list - / elements=string
- - - Default:
"!config"
- - -
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
- + / elements=string + + + + Default:
"!config"
+ + +
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected.
+ - - + +
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.
+ - - + +
@@ -199,7 +201,6 @@ Examples .. code-block:: yaml+jinja - # Gather all facts - vyos.vyos.vyos_facts: gather_subset: all @@ -233,7 +234,6 @@ Examples - Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: @@ -246,172 +246,172 @@ Common return values are documented `here Returned Description - - + +
ansible_net_api
string -
- + + always -
The name of the transport
-
- +
The name of the transport
+
+ - - + +
ansible_net_commits
list -
- + + when present -
The set of available configuration revisions
-
- +
The set of available configuration revisions
+
+ - - + +
ansible_net_config
string -
- + + when config is configured -
The running-config from the device
-
- +
The running-config from the device
+
+ - - + +
ansible_net_gather_network_resources
list -
- + + always -
The list of fact resource subsets collected from the device
-
- +
The list of fact resource subsets collected from the device
+
+ - - + +
ansible_net_gather_subset
list -
- + + always -
The list of subsets gathered by the module
-
- +
The list of subsets gathered by the module
+
+ - - + +
ansible_net_hostname
string -
- + + always -
The configured system hostname
-
- +
The configured system hostname
+
+ - - + +
ansible_net_model
string -
- + + always -
The device model string
-
- +
The device model string
+
+ - - + +
ansible_net_neighbors
list -
- + + when interface is configured -
The set of LLDP neighbors
-
- +
The set of LLDP neighbors
+
+ - - + +
ansible_net_python_version
string -
- + + always -
The Python version Ansible controller is using
-
- +
The Python version Ansible controller is using
+
+ - - + +
ansible_net_serialnum
string -
- + + always -
The serial number of the device
-
- +
The serial number of the device
+
+ - - + +
ansible_net_version
string -
- + + always -
The version of the software running
-
- +
The version of the software running
+
+ - +

@@ -425,5 +425,3 @@ Authors - Nathaniel Case (@qalthos) - Nilashish Chakraborty (@Nilashishc) - Rohit Thakur (@rohitthakur2590) - - -- cgit v1.2.3