From 5c6a97ae5052684aed513427f81dc1da96c094e3 Mon Sep 17 00:00:00 2001 From: Kate Case Date: Thu, 13 Oct 2022 13:11:19 -0400 Subject: Remove deprecated modules and provider (#277) * Remove deprecated modules and provider * Remove tests for removed modules * Remove references to vyos_argument_spec --- docs/vyos.vyos.vyos_banner_module.rst | 122 +---- docs/vyos.vyos.vyos_command_module.rst | 126 +---- docs/vyos.vyos.vyos_config_module.rst | 116 ----- docs/vyos.vyos.vyos_facts_module.rst | 124 +---- docs/vyos.vyos.vyos_interface_module.rst | 684 -------------------------- docs/vyos.vyos.vyos_l3_interface_module.rst | 396 --------------- docs/vyos.vyos.vyos_linkagg_module.rst | 424 ---------------- docs/vyos.vyos.vyos_lldp_interface_module.rst | 344 ------------- docs/vyos.vyos.vyos_lldp_module.rst | 268 ---------- docs/vyos.vyos.vyos_logging_module.rst | 116 ----- docs/vyos.vyos.vyos_ping_module.rst | 130 +---- docs/vyos.vyos.vyos_static_route_module.rst | 437 ---------------- docs/vyos.vyos.vyos_system_module.rst | 126 +---- docs/vyos.vyos.vyos_user_module.rst | 124 +---- docs/vyos.vyos.vyos_vlan_module.rst | 116 ----- 15 files changed, 28 insertions(+), 3625 deletions(-) delete mode 100644 docs/vyos.vyos.vyos_interface_module.rst delete mode 100644 docs/vyos.vyos.vyos_l3_interface_module.rst delete mode 100644 docs/vyos.vyos.vyos_linkagg_module.rst delete mode 100644 docs/vyos.vyos.vyos_lldp_interface_module.rst delete mode 100644 docs/vyos.vyos.vyos_lldp_module.rst delete mode 100644 docs/vyos.vyos.vyos_static_route_module.rst (limited to 'docs') diff --git a/docs/vyos.vyos.vyos_banner_module.rst b/docs/vyos.vyos.vyos_banner_module.rst index f42364a2..4a847f77 100644 --- a/docs/vyos.vyos.vyos_banner_module.rst +++ b/docs/vyos.vyos.vyos_banner_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
banner @@ -54,123 +54,7 @@ Parameters
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 @@ -189,7 +73,7 @@ Parameters
+
text diff --git a/docs/vyos.vyos.vyos_command_module.rst b/docs/vyos.vyos.vyos_command_module.rst index bb79752d..c6ce2cc4 100644 --- a/docs/vyos.vyos.vyos_command_module.rst +++ b/docs/vyos.vyos.vyos_command_module.rst @@ -30,12 +30,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
commands @@ -53,7 +53,7 @@ Parameters
+
interval @@ -69,7 +69,7 @@ Parameters
+
match @@ -88,123 +88,7 @@ Parameters
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
retries @@ -220,7 +104,7 @@ Parameters
+
wait_for diff --git a/docs/vyos.vyos.vyos_config_module.rst b/docs/vyos.vyos.vyos_config_module.rst index ddd1c535..a99e2643 100644 --- a/docs/vyos.vyos.vyos_config_module.rst +++ b/docs/vyos.vyos.vyos_config_module.rst @@ -166,122 +166,6 @@ Parameters
The match argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the match argument is set to none the active configuration is ignored and the configuration is always loaded.
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
diff --git a/docs/vyos.vyos.vyos_facts_module.rst b/docs/vyos.vyos.vyos_facts_module.rst index 66e84980..af392839 100644 --- a/docs/vyos.vyos.vyos_facts_module.rst +++ b/docs/vyos.vyos.vyos_facts_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
available_network_resources @@ -53,7 +53,7 @@ Parameters
+
gather_network_resources @@ -69,7 +69,7 @@ Parameters
+
gather_subset @@ -85,122 +85,6 @@ Parameters
When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, neighbors and min. 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: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-

diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst deleted file mode 100644 index 62329777..00000000 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ /dev/null @@ -1,684 +0,0 @@ -.. _vyos.vyos.vyos_interface_module: - - -************************ -vyos.vyos.vyos_interface -************************ - -**(deprecated, removed after 2022-06-01) Manage Interface on VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_interfaces - - - -Synopsis --------- -- This module provides declarative management of Interfaces on VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of Interfaces definitions.
-
-
- delay - -
- integer -
- 		- -
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
-
-
- description - -
- string -
- 		- -
Description of Interface.
-
-
- duplex - -
- string -
- 		-
    Choices: -
  • full
    • -
  • half
    • -
  • auto
    • -
- 		-
Interface link status.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes
    • -
- 		-
Interface link status.
-
-
- mtu - -
- integer -
- 		- -
Maximum size of transmit packet.
-
-
- name - -
- string - / required -
- 		- -
Name of the Interface.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Check the operational state of given interface name for LLDP neighbor.
-
The following suboptions are available.
-
-
- host - -
- string -
- 		- -
LLDP neighbor host for given interface name.
-
-
- port - -
- string -
- 		- -
LLDP neighbor port to which given interface name is connected.
-
-
- speed - -
- string -
- 		- -
Interface link speed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- 		-
State of the Interface configuration, up means present and operationally up and down means present and operationally down
-
-
- delay - -
- integer -
- 		- Default:
10
- 		-
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down and neighbors.
-
-
- description - -
- string -
- 		- -
Description of Interface.
-
-
- duplex - -
- string -
- 		-
    Choices: -
  • full
    • -
  • half
    • -
  • auto
    • -
- 		-
Interface link status.
-
-
- enabled - -
- boolean -
- 		-
    Choices: -
  • no
    • -
  • yes ←
    • -
- 		-
Interface link status.
-
-
- mtu - -
- integer -
- 		- -
Maximum size of transmit packet.
-
-
- name - -
- string -
- 		- -
Name of the Interface.
-
-
- neighbors - -
- list - / elements=dictionary -
- 		- -
Check the operational state of given interface name for LLDP neighbor.
-
The following suboptions are available.
-
-
- host - -
- string -
- 		- -
LLDP neighbor host for given interface name.
-
-
- port - -
- string -
- 		- -
LLDP neighbor port to which given interface name is connected.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
-
- speed - -
- string -
- 		- -
Interface link speed.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- 		-
State of the Interface configuration, up means present and operationally up and down means present and operationally down
-
-
- - -Notes ------ - -.. note:: - - Tested against VYOS 1.1.7 - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: configure interface - vyos.vyos.vyos_interface: - name: eth0 - description: test-interface - - - name: remove interface - vyos.vyos.vyos_interface: - name: eth0 - state: absent - - - name: make interface down - vyos.vyos.vyos_interface: - name: eth0 - enabled: false - - - name: make interface up - vyos.vyos.vyos_interface: - name: eth0 - enabled: true - - - name: Configure interface speed, mtu, duplex - vyos.vyos.vyos_interface: - name: eth5 - state: present - speed: 100 - mtu: 256 - duplex: full - - - name: Set interface using aggregate - vyos.vyos.vyos_interface: - aggregate: - - {name: eth1, description: test-interface-1, speed: 100, duplex: half, mtu: 512} - - {name: eth2, description: test-interface-2, speed: 1000, duplex: full, mtu: 256} - - - name: Disable interface on aggregate - net_interface: - aggregate: - - name: eth1 - - name: eth2 - enabled: false - - - name: Delete interface using aggregate - net_interface: - aggregate: - - name: eth1 - - name: eth2 - state: absent - - - name: Check lldp neighbors intent arguments - vyos.vyos.vyos_interface: - name: eth0 - neighbors: - - port: eth0 - host: netdev - - - name: Config + intent - vyos.vyos.vyos_interface: - name: eth1 - enabled: false - state: down - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces ethernet eth0 description "test-interface"', 'set interfaces ethernet eth0 speed 100', 'set interfaces ethernet eth0 mtu 256', 'set interfaces ethernet eth0 duplex full']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ganesh Nalawade (@ganeshrn) diff --git a/docs/vyos.vyos.vyos_l3_interface_module.rst b/docs/vyos.vyos.vyos_l3_interface_module.rst deleted file mode 100644 index 8f639f52..00000000 --- a/docs/vyos.vyos.vyos_l3_interface_module.rst +++ /dev/null @@ -1,396 +0,0 @@ -.. _vyos.vyos.vyos_l3_interface_module: - - -*************************** -vyos.vyos.vyos_l3_interface -*************************** - -**(deprecated, removed after 2022-06-01) Manage L3 interfaces on VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_l3_interfaces - - - -Synopsis --------- -- This module provides declarative management of L3 interfaces on VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of L3 interfaces definitions
-
-
- ipv4 - -
- string -
- 		- -
IPv4 of the L3 interface.
-
-
- ipv6 - -
- string -
- 		- -
IPv6 of the L3 interface.
-
-
- name - -
- string - / required -
- 		- -
Name of the L3 interface.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
State of the L3 interface configuration.
-
-
- ipv4 - -
- string -
- 		- -
IPv4 of the L3 interface.
-
-
- ipv6 - -
- string -
- 		- -
IPv6 of the L3 interface.
-
-
- name - -
- string -
- 		- -
Name of the L3 interface.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the L3 interface configuration.
-
-
- - -Notes ------ - -.. note:: - - Tested against VYOS 1.1.7 - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: Set eth0 IPv4 address - vyos.vyos.vyos_l3_interface: - name: eth0 - ipv4: 192.168.0.1/24 - - - name: Remove eth0 IPv4 address - vyos.vyos.vyos_l3_interface: - name: eth0 - state: absent - - - name: Set IP addresses on aggregate - vyos.vyos.vyos_l3_interface: - aggregate: - - {name: eth1, ipv4: 192.168.2.10/24} - - {name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64"} - - - name: Remove IP addresses on aggregate - vyos.vyos.vyos_l3_interface: - aggregate: - - {name: eth1, ipv4: 192.168.2.10/24} - - {name: eth2, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64"} - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
["set interfaces ethernet eth0 address '192.168.0.1/24'"]
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/docs/vyos.vyos.vyos_linkagg_module.rst b/docs/vyos.vyos.vyos_linkagg_module.rst deleted file mode 100644 index a2948041..00000000 --- a/docs/vyos.vyos.vyos_linkagg_module.rst +++ /dev/null @@ -1,424 +0,0 @@ -.. _vyos.vyos.vyos_linkagg_module: - - -********************** -vyos.vyos.vyos_linkagg -********************** - -**(deprecated, removed after 2022-06-01) Manage link aggregation groups on VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_lag_interfaces - - - -Synopsis --------- -- This module provides declarative management of link aggregation groups on VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of link aggregation definitions.
-
-
- members - -
- list - / elements=string -
- 		- -
List of members of the link aggregation group.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • 802.3ad
    • -
  • active-backup
    • -
  • broadcast
    • -
  • round-robin
    • -
  • transmit-load-balance
    • -
  • adaptive-load-balance
    • -
  • xor-hash
    • -
  • on
    • -
- 		-
Mode of the link aggregation group.
-
-
- name - -
- string - / required -
- 		- -
Name of the link aggregation group.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- 		-
State of the link aggregation group.
-
-
- members - -
- list - / elements=string -
- 		- -
List of members of the link aggregation group.
-
-
- mode - -
- string -
- 		-
    Choices: -
  • 802.3ad ←
    • -
  • active-backup
    • -
  • broadcast
    • -
  • round-robin
    • -
  • transmit-load-balance
    • -
  • adaptive-load-balance
    • -
  • xor-hash
    • -
  • on
    • -
- 		-
Mode of the link aggregation group.
-
-
- name - -
- string -
- 		- -
Name of the link aggregation group.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • up
    • -
  • down
    • -
- 		-
State of the link aggregation group.
-
-
- - -Notes ------ - -.. note:: - - Tested against VYOS 1.1.7 - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: configure link aggregation group - vyos.vyos.vyos_linkagg: - name: bond0 - members: - - eth0 - - eth1 - - - name: remove configuration - vyos.vyos.vyos_linkagg: - name: bond0 - state: absent - - - name: Create aggregate of linkagg definitions - vyos.vyos.vyos_linkagg: - aggregate: - - {name: bond0, members: [eth1]} - - {name: bond1, members: [eth2]} - - - name: Remove aggregate of linkagg definitions - vyos.vyos.vyos_linkagg: - aggregate: - - name: bond0 - - name: bond1 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set interfaces bonding bond0', "set interfaces ethernet eth0 bond-group 'bond0'", "set interfaces ethernet eth1 bond-group 'bond0'"]
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/docs/vyos.vyos.vyos_lldp_interface_module.rst b/docs/vyos.vyos.vyos_lldp_interface_module.rst deleted file mode 100644 index b93f13c3..00000000 --- a/docs/vyos.vyos.vyos_lldp_interface_module.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. _vyos.vyos.vyos_lldp_interface_module: - - -***************************** -vyos.vyos.vyos_lldp_interface -***************************** - -**(deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration on VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_lldp_interfaces - - - -Synopsis --------- -- This module provides declarative management of LLDP interfaces configuration on VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of interfaces LLDP should be configured on.
-
-
- name - -
- string - / required -
- 		- -
Name of the interface LLDP should be configured on.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
  • enabled
    • -
  • disabled
    • -
- 		-
State of the LLDP configuration.
-
-
- name - -
- string -
- 		- -
Name of the interface LLDP should be configured on.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • enabled
    • -
  • disabled
    • -
- 		-
State of the LLDP configuration.
-
-
- - -Notes ------ - -.. note:: - - Tested against VYOS 1.1.7 - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable LLDP on eth1 - net_lldp_interface: - state: present - - - name: Enable LLDP on specific interfaces - net_lldp_interface: - interfaces: - - eth1 - - eth2 - state: present - - - name: Disable LLDP globally - net_lldp_interface: - state: disabled - - - name: Create aggregate of LLDP interface configurations - vyos.vyos.vyos_lldp_interface: - aggregate: - - name: eth1 - - name: eth2 - state: present - - - name: Delete aggregate of LLDP interface configurations - vyos.vyos.vyos_lldp_interface: - aggregate: - - name: eth1 - - name: eth2 - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set service lldp eth1', 'set service lldp eth2 disable']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/docs/vyos.vyos.vyos_lldp_module.rst b/docs/vyos.vyos.vyos_lldp_module.rst deleted file mode 100644 index c0a0d22f..00000000 --- a/docs/vyos.vyos.vyos_lldp_module.rst +++ /dev/null @@ -1,268 +0,0 @@ -.. _vyos.vyos.vyos_lldp_module: - - -******************* -vyos.vyos.vyos_lldp -******************* - -**(deprecated, removed after 2022-06-01) Manage LLDP configuration on VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_lldp_global - - - -Synopsis --------- -- This module provides declarative management of LLDP service on VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- interfaces - -
- list - / elements=string -
- 		- -
Name of the interfaces.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
  • enabled
    • -
  • disabled
    • -
- 		-
State of the link aggregation group.
-
-
- - -Notes ------ - -.. note:: - - Tested against VYOS 1.1.7 - - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - - - -Examples --------- - -.. code-block:: yaml - - - name: Enable LLDP service - vyos.vyos.vyos_lldp: - state: present - - - name: Disable LLDP service - vyos.vyos.vyos_lldp: - state: absent - - - -Return Values -------------- -Common return values are documented `here `_, the following are the fields unique to this module: - -.. raw:: html - - - - - - - - - - - - -
KeyReturnedDescription
-
- commands - -
- list -
- 		always, except for the platforms that use Netconf transport to manage the device. -
The list of configuration mode commands to send to the device
-
-
Sample:
-
['set service lldp']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Ricardo Carrillo Cruz (@rcarrillocruz) diff --git a/docs/vyos.vyos.vyos_logging_module.rst b/docs/vyos.vyos.vyos_logging_module.rst index c846cf92..969190b5 100644 --- a/docs/vyos.vyos.vyos_logging_module.rst +++ b/docs/vyos.vyos.vyos_logging_module.rst @@ -215,122 +215,6 @@ Parameters
If value of dest is file it indicates file-name, for user it indicates username and for host indicates the host name to be notified.
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
diff --git a/docs/vyos.vyos.vyos_ping_module.rst b/docs/vyos.vyos.vyos_ping_module.rst index 7b2e2d05..e18552b8 100644 --- a/docs/vyos.vyos.vyos_ping_module.rst +++ b/docs/vyos.vyos.vyos_ping_module.rst @@ -33,12 +33,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
count @@ -54,7 +54,7 @@ Parameters
+
dest @@ -70,7 +70,7 @@ Parameters
+
interval @@ -85,123 +85,7 @@ Parameters
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
size @@ -216,7 +100,7 @@ Parameters
+
source @@ -231,7 +115,7 @@ Parameters
+
state @@ -250,7 +134,7 @@ Parameters
+
ttl diff --git a/docs/vyos.vyos.vyos_static_route_module.rst b/docs/vyos.vyos.vyos_static_route_module.rst deleted file mode 100644 index 98200af9..00000000 --- a/docs/vyos.vyos.vyos_static_route_module.rst +++ /dev/null @@ -1,437 +0,0 @@ -.. _vyos.vyos.vyos_static_route_module: - - -*************************** -vyos.vyos.vyos_static_route -*************************** - -**(deprecated, removed after 2022-06-01) Manage static IP routes on Vyatta VyOS network devices** - - -Version added: 1.0.0 - -.. contents:: - :local: - :depth: 1 - -DEPRECATED ----------- -:Removed in collection release after 2022-06-01 -:Why: Updated modules released with more functionality. -:Alternative: vyos_static_routes - - - -Synopsis --------- -- This module provides declarative management of static IP routes on Vyatta VyOS network devices. - - - - -Parameters ----------- - -.. raw:: html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterChoices/DefaultsComments
-
- admin_distance - -
- integer -
- 		- -
Admin distance of the static route.
-
-
- aggregate - -
- list - / elements=dictionary -
- 		- -
List of static route definitions
-
-
- admin_distance - -
- integer -
- 		- -
Admin distance of the static route.
-
-
- mask - -
- string -
- 		- -
Network prefix mask of the static route.
-
-
- next_hop - -
- string -
- 		- -
Next hop IP of the static route.
-
-
- prefix - -
- string - / required -
- 		- -
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
-
-
- state - -
- string -
- 		-
    Choices: -
  • present
    • -
  • absent
    • -
- 		-
State of the static route configuration.
-
-
- mask - -
- string -
- 		- -
Network prefix mask of the static route.
-
-
- next_hop - -
- string -
- 		- -
Next hop IP of the static route.
-
-
- prefix - -
- string -
- 		- -
Network prefix of the static route. mask param should be ignored if prefix is provided with mask value prefix/mask.
-
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 - -
- string -
- 		-
    Choices: -
  • present ←
    • -
  • absent
    • -
- 		-
State of the static route configuration.
-
-
- - -Notes ------ - -.. note:: - - Tested against VyOS 1.1.8 (helium). - - This module works with connection ``ansible.netcommon.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 - - - name: configure static route - vyos.vyos.vyos_static_route: - prefix: 192.168.2.0 - mask: 24 - next_hop: 10.0.0.1 - - - name: configure static route prefix/mask - vyos.vyos.vyos_static_route: - prefix: 192.168.2.0/16 - next_hop: 10.0.0.1 - - - name: remove configuration - vyos.vyos.vyos_static_route: - prefix: 192.168.2.0 - mask: 16 - next_hop: 10.0.0.1 - state: absent - - - name: configure aggregates of static routes - vyos.vyos.vyos_static_route: - aggregate: - - {prefix: 192.168.2.0, mask: 24, next_hop: 10.0.0.1} - - {prefix: 192.168.3.0, mask: 16, next_hop: 10.0.2.1} - - {prefix: 192.168.3.0/16, next_hop: 10.0.2.1} - - - name: Remove static route collections - vyos.vyos.vyos_static_route: - aggregate: - - {prefix: 172.24.1.0/24, next_hop: 192.168.42.64} - - {prefix: 172.24.3.0/24, next_hop: 192.168.42.64} - state: absent - - - -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 protocols static route 192.168.2.0/16 next-hop 10.0.0.1']
-
-

- - -Status ------- - - -- This module will be removed in a release after 2022-06-01. *[deprecated]* -- For more information see `DEPRECATED`_. - - -Authors -~~~~~~~ - -- Trishna Guha (@trishnaguha) diff --git a/docs/vyos.vyos.vyos_system_module.rst b/docs/vyos.vyos.vyos_system_module.rst index b3b51e80..b5524e7e 100644 --- a/docs/vyos.vyos.vyos_system_module.rst +++ b/docs/vyos.vyos.vyos_system_module.rst @@ -29,12 +29,12 @@ Parameters - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -113,7 +113,7 @@ Parameters @@ -169,7 +169,7 @@ Parameters @@ -215,125 +215,9 @@ Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
domain_name @@ -49,7 +49,7 @@ Parameters
+
domain_search @@ -65,7 +65,7 @@ Parameters
+
host_name @@ -80,7 +80,7 @@ Parameters
+
name_server @@ -97,123 +97,7 @@ Parameters
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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 diff --git a/docs/vyos.vyos.vyos_user_module.rst b/docs/vyos.vyos.vyos_user_module.rst index 3af72486..8fb47b8d 100644 --- a/docs/vyos.vyos.vyos_user_module.rst +++ b/docs/vyos.vyos.vyos_user_module.rst @@ -63,7 +63,7 @@ Parameters 		-
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
+
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device.
-
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device. Please note that this option is not same as provider password.
+
The password to be configured on the VyOS device. The password needs to be provided in clear and it will be encrypted on the device.
-
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument. Please note that this option is not same as provider username.
+
The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the aggregate argument.
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
diff --git a/docs/vyos.vyos.vyos_vlan_module.rst b/docs/vyos.vyos.vyos_vlan_module.rst index 970928f4..601cda9a 100644 --- a/docs/vyos.vyos.vyos_vlan_module.rst +++ b/docs/vyos.vyos.vyos_vlan_module.rst @@ -248,122 +248,6 @@ Parameters
Name of the VLAN.
-
- provider - -
- dictionary -
- 		- -
Deprecated
-
Starting with Ansible 2.5 we recommend using connection: ansible.netcommon.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.
-
-
- 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 -
- 		- -
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 -
- 		- -
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.
-
-- cgit v1.2.3