mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
Commit c46473a ("docs: add ..cmdinclude:: directive") added support for including
common text but only replacing individual labels so there can be source of truth
also for the documentation.
262 lines
8.7 KiB
ReStructuredText
262 lines
8.7 KiB
ReStructuredText
.. _ethernet-interface:
|
|
|
|
########
|
|
Ethernet
|
|
########
|
|
|
|
Configuration
|
|
#############
|
|
|
|
Address
|
|
-------
|
|
|
|
.. cmdinclude:: ../_include/interface-address.txt
|
|
:var0: ethernet
|
|
:var1: eth0
|
|
|
|
.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
|
|
:var0: ethernet
|
|
:var1: eth0
|
|
|
|
.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
|
|
:var0: ethernet
|
|
:var1: eth0
|
|
|
|
Speed/Duplex
|
|
------------
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> duplex <auto | full | half>
|
|
|
|
Configure physical interface duplex setting.
|
|
|
|
* auto - interface duplex setting is auto-negotiated
|
|
* full - always use full-duplex
|
|
* half - always use half-duplex
|
|
|
|
VyOS default will be `auto`.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> speed <auto | 10 | 100 | 1000 | 2500 | 5000 | 10000 | 25000 | 40000 | 50000 | 100000>
|
|
|
|
Configure physical interface speed setting.
|
|
|
|
* auto - interface speed is auto-negotiated
|
|
* 10 - 10 MBit/s
|
|
* 100 - 100 MBit/s
|
|
* 1000 - 1 GBit/s
|
|
* 2500 - 2.5 GBit/s
|
|
* 5000 - 5 GBit/s
|
|
* 10000 - 10 GBit/s
|
|
* 25000 - 25 GBit/s
|
|
* 40000 - 40 GBit/s
|
|
* 50000 - 50 GBit/s
|
|
* 100000 - 100 GBit/s
|
|
|
|
VyOS default will be `auto`.
|
|
|
|
Link Administration
|
|
-------------------
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> description <description>
|
|
|
|
Assign given `<description>` to interface. Description will also be passed
|
|
to SNMP monitoring systems.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> disable
|
|
|
|
Disable given `<interface>`. It will be placed in administratively down
|
|
(``A/D``) state.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> disable-flow-control
|
|
|
|
Disable Ethernet flow control (pause frames).
|
|
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> mac <mac-address>
|
|
|
|
Configure user defined :abbr:`MAC (Media Access Control)` address on given
|
|
`<interface>`.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <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.
|
|
|
|
Prefix Delegation (DHCPv6-PD)
|
|
-----------------------------
|
|
|
|
VyOS 1.3 (equuleus) supports DHCPv6-PD. DHCPv6 Prefix Delegation is supported
|
|
by most ISPs who provide native IPv6 for consumers on fixed networks.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> length <length>
|
|
|
|
Some ISPs by default only delegate a /64 prefix. To request for a specific
|
|
prefix size use this option to request for a bigger delegation for this pd
|
|
`<id>`. This value
|
|
is in the range from 32 - 64 so you could request up to /32 down to a /64
|
|
delegation.
|
|
|
|
Default value is 64.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> interface <delegatee> address <address>
|
|
|
|
Specify the interface address used locally on the interfcae where the prefix
|
|
has been delegated to. ID must be a decimal integer.
|
|
|
|
It will be combined with the delegated prefix and the sla-id to form a complete
|
|
interface address. The default is to use the EUI-64 address of the interface.
|
|
|
|
Example:
|
|
|
|
Using ``<id>`` value 65535 will assign IPv6 address ``<prefix>::ffff`` to the
|
|
interface.
|
|
|
|
.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> interface <delegatee> sla-id <id>
|
|
|
|
Specify the identifier value of the site-level aggregator (SLA) on the
|
|
interface. ID must be a decimal number greater then 0 which fits in the length
|
|
of SLA IDs (see below). For example, if ID is 1 and the client is delegated
|
|
an IPv6 prefix 2001:db8:ffff::/48, dhcp6c will combine the two values into a
|
|
single IPv6 prefix, 2001:db8:ffff:1::/64, and will configure the prefix on
|
|
the specified interface.
|
|
|
|
Operation
|
|
=========
|
|
|
|
.. opcmd:: show interfaces ethernet
|
|
|
|
Show brief interface information.
|
|
|
|
.. code-block:: none
|
|
|
|
vyos@vyos:~$ show interfaces ethernet
|
|
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
|
|
Interface IP Address S/L Description
|
|
--------- ---------- --- -----------
|
|
eth0 172.18.201.10/24 u/u LAN
|
|
eth1 172.18.202.11/24 u/u WAN
|
|
eth2 - u/D
|
|
|
|
.. opcmd:: show interfaces ethernet <interface>
|
|
|
|
Show detailed information on given `<interface>`
|
|
|
|
.. code-block:: none
|
|
|
|
vyos@vyos:~$ show interfaces ethernet eth0
|
|
eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
|
|
link/ether 00:50:44:00:f5:c9 brd ff:ff:ff:ff:ff:ff
|
|
inet6 fe80::250:44ff:fe00:f5c9/64 scope link
|
|
valid_lft forever preferred_lft forever
|
|
|
|
RX: bytes packets errors dropped overrun mcast
|
|
56735451 179841 0 0 0 142380
|
|
TX: bytes packets errors dropped carrier collisions
|
|
5601460 62595 0 0 0 0
|
|
|
|
.. opcmd:: show interfaces ethernet <interface> physical
|
|
|
|
Show information about physical `<interface>`
|
|
|
|
.. code-block:: none
|
|
|
|
vyos@vyos:~$ show interfaces ethernet eth0 physical
|
|
Settings for eth0:
|
|
Supported ports: [ TP ]
|
|
Supported link modes: 1000baseT/Full
|
|
10000baseT/Full
|
|
Supported pause frame use: No
|
|
Supports auto-negotiation: No
|
|
Supported FEC modes: Not reported
|
|
Advertised link modes: Not reported
|
|
Advertised pause frame use: No
|
|
Advertised auto-negotiation: No
|
|
Advertised FEC modes: Not reported
|
|
Speed: 10000Mb/s
|
|
Duplex: Full
|
|
Port: Twisted Pair
|
|
PHYAD: 0
|
|
Transceiver: internal
|
|
Auto-negotiation: off
|
|
MDI-X: Unknown
|
|
Supports Wake-on: uag
|
|
Wake-on: d
|
|
Link detected: yes
|
|
driver: vmxnet3
|
|
version: 1.4.16.0-k-NAPI
|
|
firmware-version:
|
|
expansion-rom-version:
|
|
bus-info: 0000:0b:00.0
|
|
supports-statistics: yes
|
|
supports-test: no
|
|
supports-eeprom-access: no
|
|
supports-register-dump: yes
|
|
supports-priv-flags: no
|
|
|
|
.. opcmd:: show interfaces ethernet <interface> physical offload
|
|
|
|
Show available offloading functions on given `<interface>`
|
|
|
|
.. code-block:: none
|
|
|
|
vyos@vyos:~$ show interfaces ethernet eth0 physical offload
|
|
rx-checksumming on
|
|
tx-checksumming on
|
|
tx-checksum-ip-generic on
|
|
scatter-gather off
|
|
tx-scatter-gather off
|
|
tcp-segmentation-offload off
|
|
tx-tcp-segmentation off
|
|
tx-tcp-mangleid-segmentation off
|
|
tx-tcp6-segmentation off
|
|
udp-fragmentation-offload off
|
|
generic-segmentation-offload off
|
|
generic-receive-offload off
|
|
large-receive-offload off
|
|
rx-vlan-offload on
|
|
tx-vlan-offload on
|
|
ntuple-filters off
|
|
receive-hashing on
|
|
tx-gre-segmentation on
|
|
tx-gre-csum-segmentation on
|
|
tx-udp_tnl-segmentation on
|
|
tx-udp_tnl-csum-segmentation on
|
|
tx-gso-partial on
|
|
tx-nocache-copy off
|
|
rx-all off
|
|
|
|
.. opcmd:: show interfaces ethernet <interface> transceiver
|
|
|
|
Show transceiver information from plugin modules, e.g SFP+, QSFP
|
|
|
|
.. code-block:: none
|
|
|
|
vyos@vyos:~$ show interfaces ethernet eth5 transceiver
|
|
Identifier : 0x03 (SFP)
|
|
Extended identifier : 0x04 (GBIC/SFP defined by 2-wire interface ID)
|
|
Connector : 0x07 (LC)
|
|
Transceiver codes : 0x00 0x00 0x00 0x01 0x00 0x00 0x00 0x00 0x00
|
|
Transceiver type : Ethernet: 1000BASE-SX
|
|
Encoding : 0x01 (8B/10B)
|
|
BR, Nominal : 1300MBd
|
|
Rate identifier : 0x00 (unspecified)
|
|
Length (SMF,km) : 0km
|
|
Length (SMF) : 0m
|
|
Length (50um) : 550m
|
|
Length (62.5um) : 270m
|
|
Length (Copper) : 0m
|
|
Length (OM3) : 0m
|
|
Laser wavelength : 850nm
|
|
Vendor name : CISCO-FINISAR
|
|
Vendor OUI : 00:90:65
|
|
Vendor PN : FTRJ-8519-7D-CS4
|
|
Vendor rev : A
|
|
Option values : 0x00 0x1a
|
|
Option : RX_LOS implemented
|
|
Option : TX_FAULT implemented
|
|
Option : TX_DISABLE implemented
|
|
BR margin, max : 0%
|
|
BR margin, min : 0%
|
|
Vendor SN : FNS092xxxxx
|
|
Date code : 0506xx
|
|
|