summaryrefslogtreecommitdiff
path: root/docs/interfaces/pseudo-ethernet.rst
diff options
context:
space:
mode:
authorDaniel Thorpe <1077065+dantho281@users.noreply.github.com>2021-02-11 02:25:57 +0000
committerGitHub <noreply@github.com>2021-02-11 02:25:57 +0000
commite88fba68357181bd54fcc7489cbba08780cee6cd (patch)
treeb67e88b1208fa835edf0420a42dd2b624ec2105b /docs/interfaces/pseudo-ethernet.rst
parentdab473bfd04ab2930c043b853ba9995d1ff335e6 (diff)
parentf33b0c78b07c80998d2c0e64d6a20bcb109f6db5 (diff)
downloadvyos-documentation-e88fba68357181bd54fcc7489cbba08780cee6cd.tar.gz
vyos-documentation-e88fba68357181bd54fcc7489cbba08780cee6cd.zip
Merge pull request #1 from vyos/master
Update fork
Diffstat (limited to 'docs/interfaces/pseudo-ethernet.rst')
-rw-r--r--docs/interfaces/pseudo-ethernet.rst89
1 files changed, 0 insertions, 89 deletions
diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/interfaces/pseudo-ethernet.rst
deleted file mode 100644
index a2066555..00000000
--- a/docs/interfaces/pseudo-ethernet.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-.. _pseudo-ethernet-interface:
-
-#######################
-Pseudo Ethernet/MACVLAN
-#######################
-
-Pseudo-Ethernet or MACVLAN interfaces can be seen as subinterfaces to regular
-ethernet interfaces. Each and every subinterface is created a different media
-access control (MAC) address, for a single physical Ethernet port. Pseudo-
-Ethernet interfaces have most of their application in virtualized environments,
-
-By using Pseudo-Ethernet interfaces there will be less system overhead compared
-to running a traditional bridging approach. Pseudo-Ethernet interfaces can also
-be used to workaround the general limit of 4096 virtual LANs (VLANs) per
-physical Ethernet port, since that limit is with respect to a single MAC
-address.
-
-Every Virtual Ethernet interfaces behaves like a real Ethernet interface. They
-can have IPv4/IPv6 addresses configured, or can request addresses by DHCP/
-DHCPv6 and are associated/mapped with a real ethernet port. This also makes
-Pseudo-Ethernet interfaces interesting for testing purposes. A Pseudo-Ethernet
-device will inherit characteristics (speed, duplex, ...) from its physical
-parent (the so called link) interface.
-
-Once created in the system, Pseudo-Ethernet interfaces can be referenced in
-the exact same way as other Ethernet interfaces. Notes about using Pseudo-
-Ethernet interfaces:
-
-* Pseudo-Ethernet interfaces can not be reached from your internal host. This
- means that you can not try to ping a Pseudo-Ethernet interface from the host
- system on which it is defined. The ping will be lost.
-* Loopbacks occurs at the IP level the same way as for other interfaces,
- ethernet frames are not forwarded between Pseudo-Ethernet interfaces.
-* Pseudo-Ethernet interfaces may not work in environments which expect a
- :abbr:`NIC (Network Interface Card)` to only have a single address. This
- applies to:
- - VMware machines using default settings
- - Network switches with security settings allowing only a single MAC address
- - xDSL modems that try to lear the MAC address of the NIC
-
-Configuration
-=============
-
-Address
--------
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> address <address | dhcp | dhcpv6>
-
- .. include:: common-ip-ipv6-addr.txt
-
- Example:
-
- .. code-block:: none
-
- set interfaces pseudo-ethernet peth0 address 192.0.2.1/24
- set interfaces pseudo-ethernet peth0 address 192.0.2.2/24
- set interfaces pseudo-ethernet peth0 address 2001:db8::ffff/64
- set interfaces pseudo-ethernet peth0 address 2001:db8:100::ffff/64
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> ipv6 address autoconf
-
- .. include:: common-ipv6-addr-autoconf.txt
-
-Physical Asignment
-------------------
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> source-interface <ethX>
-
- Specifies the physical `<ethX>` Ethernet interface associated with a Pseudo
- Ethernet `<interface>`.
-
-Link Administration
--------------------
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> description <description>
-
- Assign given `<description>` to interface. Description will also be passed
- to SNMP monitoring systems.
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> disable
-
- Disable given `<interface>`. It will be placed in administratively down
- (``A/D``) state.
-
-.. cfgcmd:: set interfaces pseudo-ethernet <interface> mac <mac-address>
-
- Configure user defined :abbr:`MAC (Media Access Control)` address on given
- `<interface>`.
-