Skip to content

Commit

Permalink
vlan: Add document for VLAN/VxLAN over unmanaged interface
Browse files Browse the repository at this point in the history
Signed-off-by: Gris Ge <[email protected]>
  • Loading branch information
cathay4t committed Jun 18, 2024
1 parent 04a9c48 commit 6a4da7c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions devel/yaml_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -949,6 +949,14 @@ The `vlan` sections contains two parameters:
* `id`: VLAN ID integer.
* `protocol`: `802.1q` (default) or `802.1ad`

With nmstate 2.2.1+, when using Nmstate with NetworkManager backend, nmstate
can creating VLAN over unmanaged interface, hence if you never mention VLAN
parent in `interfafaces` section of desired state, nmstate will not convert
VxLAN parent interface from unmanaged to managed.

For `generate configuration(gc)` mode, unmentioned VLAN parent will not
get automatically created interface profile.

### VxLAN Interface

The `vxlan` section of interface holds the parameters of VxLAN specific
Expand Down Expand Up @@ -982,6 +990,14 @@ The `vxlan` sections contains two parameters:

Currently, we only support VxLAN based on IEEE 802.1Q protocol.

With nmstate 2.2.1+, when using Nmstate with NetworkManager backend, nmstate
can creating VxLAN over unmanaged interface, if you never mention VxLAN parent
in `interfafaces` section of desired state, nmstate will not convert VxLAN
parent interface from unmanaged to managed.

For `generate configuration(gc)` mode, unmentioned VxLAN parent will not
get automatically created interface profile.

### Linux Bridge Interface

The `bridge` section of interface could hold parameters of Linux Bridge
Expand Down

0 comments on commit 6a4da7c

Please sign in to comment.