diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/interfaces/advanced-index.rst | 1 | ||||
-rw-r--r-- | docs/interfaces/common-ip-ipv6-addr.txt | 8 | ||||
-rw-r--r-- | docs/interfaces/ethernet.rst | 9 | ||||
-rw-r--r-- | docs/interfaces/pseudo-ethernet.rst | 90 |
4 files changed, 100 insertions, 8 deletions
diff --git a/docs/interfaces/advanced-index.rst b/docs/interfaces/advanced-index.rst index 00c1c73e..e86a9330 100644 --- a/docs/interfaces/advanced-index.rst +++ b/docs/interfaces/advanced-index.rst @@ -11,6 +11,7 @@ Network Interfaces bridge bond l2tpv3 + pseudo-ethernet wireless tunnel vlan diff --git a/docs/interfaces/common-ip-ipv6-addr.txt b/docs/interfaces/common-ip-ipv6-addr.txt new file mode 100644 index 00000000..f53eaeee --- /dev/null +++ b/docs/interfaces/common-ip-ipv6-addr.txt @@ -0,0 +1,8 @@ +Configure interface `<interface>` with one or more interface addresses. + +* **address** can be specified multiple times as IPv4 and/or IPv6 address, + e.g. 192.0.2.1/24 and/or 2001:db8::1/64 +* **dhcp** interface address is received by DHCP from a DHCP server on this + segment. +* **dhcpv6** interface address is received by DHCPv6 from a DHCPv6 server on + this segment. diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst index 1f691269..295a6404 100644 --- a/docs/interfaces/ethernet.rst +++ b/docs/interfaces/ethernet.rst @@ -12,14 +12,7 @@ Address .. cfgcmd:: set interfaces ethernet <interface> address <address | dhcp | dhcpv6> - Configure interface `<interface>` with one or more interface addresses. - - * **address** can be specified multiple times as IPv4 and/or IPv6 address, - e.g. 192.0.2.1/24 and/or 2001:db8::1/64 - * **dhcp** interface address is received by DHCP from a DHCP server on this - segment. - * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6 server on - this segment. + .. include:: common-ip-ipv6-addr.txt Example: diff --git a/docs/interfaces/pseudo-ethernet.rst b/docs/interfaces/pseudo-ethernet.rst new file mode 100644 index 00000000..ab60996f --- /dev/null +++ b/docs/interfaces/pseudo-ethernet.rst @@ -0,0 +1,90 @@ +.. _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 packets are not forwarded between Pseudo-Ethernet interfaces. +* Pseudo-Ethernet interfaces can not participate in Link Bonding. +* 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> link <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>`. + |