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_interface_module.rst | 494 +++++++++++++++++++++++++++++++ 1 file changed, 494 insertions(+) create mode 100644 docs/vyos.vyos.vyos_interface_module.rst (limited to 'docs/vyos.vyos.vyos_interface_module.rst') diff --git a/docs/vyos.vyos.vyos_interface_module.rst b/docs/vyos.vyos.vyos_interface_module.rst new file mode 100644 index 00000000..a6f65ba4 --- /dev/null +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -0,0 +1,494 @@ +:orphan: + +.. _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 of Interfaces definitions.
+
+
+ delay + +
+ - +
+ 		+ 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 + +
+ - +
+ 		+ +
Description of Interface.
+
+
+ duplex + +
+ - +
+ 		+
    Choices: +
  • full
    • +
  • half
    • +
  • auto ←
    • +
+ 		+
Interface link status.
+
+
+ enabled + +
+ boolean +
+ 		+
    Choices: +
  • no
    • +
  • yes
    • +
+ 		+
Interface link status.
+
+
+ mtu + +
+ - +
+ 		+ +
Maximum size of transmit packet.
+
+
+ name + +
+ - + / required
+ 		+ +
Name of the Interface.
+
+
+ neighbors + +
+ - +
+ 		+ +
Check the operational state of given interface name for LLDP neighbor.
+
The following suboptions are available.
+
+
+ host + +
+ - +
+ 		+ +
LLDP neighbor host for given interface name.
+
+
+ port + +
+ - +
+ 		+ +
LLDP neighbor port to which given interface name is connected.
+
+
+ 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.
+
+
+ speed + +
+ - +
+ 		+ +
Interface link speed.
+
+
+ state + +
+ - +
+ 		+
    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+jinja + + + - 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 version . *[deprecated]* +- For more information see `DEPRECATED`_. + + +Authors +~~~~~~~ + +- Ganesh Nalawade (@ganeshrn) + + +.. 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