diff options
| author | Christian Poessinger <christian@poessinger.com> | 2020-11-10 21:42:38 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2020-11-10 21:42:38 +0100 |
| commit | f6ee81e58268ce1a666f68504f327f49c4402130 (patch) | |
| tree | c19a0799fde38e1883937367965c547c56bba970 /docs/_include | |
| parent | ab3552884ee1c5560fb37c5deb5e4ee1662f20bc (diff) | |
| download | vyos-documentation-f6ee81e58268ce1a666f68504f327f49c4402130.tar.gz vyos-documentation-f6ee81e58268ce1a666f68504f327f49c4402130.zip | |
interface: move mac and mtu documentation to common file
Diffstat (limited to 'docs/_include')
| -rw-r--r-- | docs/_include/interface-common.txt | 12 | ||||
| -rw-r--r-- | docs/_include/interface-disable.txt | 10 | ||||
| -rw-r--r-- | docs/_include/interface-mac.txt | 10 | ||||
| -rw-r--r-- | docs/_include/interface-mtu.txt | 10 |
4 files changed, 42 insertions, 0 deletions
diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt index 56d4a22e..052088df 100644 --- a/docs/_include/interface-common.txt +++ b/docs/_include/interface-common.txt @@ -2,6 +2,18 @@ :var0: {{ var0 }} :var1: {{ var1 }} +.. cmdinclude:: ../_include/interface-disable.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + +.. cmdinclude:: ../_include/interface-mac.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + +.. cmdinclude:: ../_include/interface-mtu.txt + :var0: {{ var0 }} + :var1: {{ var1 }} + .. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-disable.txt b/docs/_include/interface-disable.txt new file mode 100644 index 00000000..83ef3e53 --- /dev/null +++ b/docs/_include/interface-disable.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} <interface> disable + + Disable given `<interface>`. It will be placed in administratively down + (``A/D``) state. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} disable
\ No newline at end of file diff --git a/docs/_include/interface-mac.txt b/docs/_include/interface-mac.txt new file mode 100644 index 00000000..29157555 --- /dev/null +++ b/docs/_include/interface-mac.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} <interface> mac <xx:xx:xx:xx:xx:xx> + + Configure user defined :abbr:`MAC (Media Access Control)` address on given + `<interface>`. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} mac '00:01:02:03:04:05'
\ No newline at end of file diff --git a/docs/_include/interface-mtu.txt b/docs/_include/interface-mtu.txt new file mode 100644 index 00000000..e727c3e9 --- /dev/null +++ b/docs/_include/interface-mtu.txt @@ -0,0 +1,10 @@ +.. cfgcmd:: set interfaces {{ var0 }} <interface> mtu <mtu> + + Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It + is the size (in bytes) of the largest ethernet frame sent on this link. + + Example: + + .. code-block:: none + + set interfaces {{ var0 }} {{ var1 }} mtu 1450
\ No newline at end of file |