From 1b58f4b0195b866b5d322c314ce66dcf72f8a9af Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Fri, 31 Jul 2020 17:53:09 -0400 Subject: Update docs (#73) vyos: Update docs Reviewed-by: GomathiselviS https://github.com/GomathiselviS --- docs/vyos.vyos.vyos_interface_module.rst | 274 ++++++++++++++++++++++++++----- 1 file changed, 234 insertions(+), 40 deletions(-) (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 index b01595a1..c00b430f 100644 --- a/docs/vyos.vyos.vyos_interface_module.rst +++ b/docs/vyos.vyos.vyos_interface_module.rst @@ -36,18 +36,18 @@ Parameters - + - @@ -55,29 +55,30 @@ Parameters
List of Interfaces definitions.
- - + + + - + - + - + - + - + - + @@ -173,12 +179,13 @@ Parameters + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - @@ -241,7 +437,7 @@ Parameters - - + - - + - - -
ParameterParameter Choices/Defaults Comments
+
aggregate
- - -
+ list + / elements=dictionary
+
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
@@ -87,19 +88,20 @@ Parameters
+
duplex
- - + string
    Choices:
  • full
  • half
    • -
  • auto ←
    • +
  • auto
 @@ -107,7 +109,8 @@ Parameters
+
enabled @@ -126,12 +129,13 @@ Parameters
+
mtu
- - + integer
@@ -141,12 +145,13 @@ Parameters
+
name
- - + string / required
@@ -156,13 +161,14 @@ Parameters
+
neighbors
- - -
+ list + / elements=dictionary
host
- - + string
@@ -189,12 +196,13 @@ Parameters
port
- - + string
@@ -205,7 +213,195 @@ Parameters
+ +
+ 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 @@ -225,13 +421,13 @@ Parameters
+
host
string - / required
+
+
password @@ -257,7 +453,7 @@ Parameters
+
port @@ -266,15 +462,14 @@ Parameters 		- Default:
22
-
Specifies the port to use when building the connection to the remote device.
+
ssh_keyfile @@ -290,7 +485,7 @@ Parameters
+
timeout @@ -299,15 +494,14 @@ Parameters 		- 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 @@ -323,12 +517,12 @@ Parameters
+
speed
- - + string
@@ -338,12 +532,12 @@ Parameters
+
state
- - + string
-- cgit v1.2.3