Nmstate

https://nmstate.io/devel/
Admin
Nmstate provides a declarative API for querying and applying host network state, typically in YAML...
Tokens:10,966
Snippets:125
Trust Score:7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Interface Controller Attachment Example

Source: https://nmstate.io/devel/yaml_api.html

Example of attaching an interface (eth1) to a controller (br0).

```yaml
---
interfaces:
- name: eth1
  state: up
  controller: br0

```

--------------------------------

### Interface Description Example

Source: https://nmstate.io/devel/yaml_api.html

Example of setting a descriptive string for a network interface.

```yaml
---
interfaces:
- name: eth1
  type: ethernet
  state: up
  description: "Main interface connected to switch S1"

```

--------------------------------

### Example Ethtool Configuration for netdevsim

Source: https://nmstate.io/devel/yaml_api.html

This snippet shows a comprehensive example of ethtool settings for a simulated network interface, including pause, feature, coalesce, and ring parameters.

```yaml
interfaces:
- name: sim0
  type: ethernet
  state: up
  ethtool:
    pause:
      rx: true
      tx: true
      autoneg: false
    feature:
      rx-gro: true
      tx-nocache-copy: false
      hw-tc-offload: false
      rx-udp_tunnel-port-offload: true
      tx-generic-segmentation: true
      rx-udp-gro-forwarding: false
      rx-gro-list: false
    coalesce:
      adaptive-rx: false
      adaptive-tx: false
      pkt-rate-high: 0
      pkt-rate-low: 0
      rx-frames: 0
      rx-frames-high: 0
      rx-frames-low: 0
      rx-usecs: 0
      rx-usecs-high: 0
      rx-usecs-irq: 0
      rx-usecs-low: 0
      sample-interval: 0
      stats-block-usecs: 0
      tx-frames: 0
      tx-frames-high: 0
      tx-frames-irq: 0
      tx-frames-low: 0
      tx-usecs: 0
      tx-usecs-high: 0
      tx-usecs-irq: 0
      tx-usecs-low: 0
    ring:
      rx: 0
      rx-max: 4096
      rx-jumbo: 0
      rx-jumbo-max: 4096
      rx-mini: 0
      rx-mini-max: 4096
      tx: 0
      tx-max: 4096

```

--------------------------------

### Open vSwitch Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example configures an Open vSwitch bridge and interfaces, including setting external IDs for the bridge and its ports.

```yaml
---
interfaces:
- name: br0
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: ovs0
    - name: eth1
  ovs-db:
    external_ids:
      gris: 10
- name: ovs0
  type: ovs-interface
  state: up
  ovs-db:
    external_ids:
      gris: abc
- name: eth1
  ovs-db:
    external_ids:
      gris: xyz

```

--------------------------------

### Interface MAC Address Example

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring an interface by its MAC address, enabling DHCP for IPv4 and IPv6.

```yaml
---
interfaces:
  - name: wan0
    type: ethernet
    state: up
    identifier: mac-address
    mac-address: 00:23:45:67:89:1a
    ipv4:
      enabled: true
      dhcp: true
    ipv6:
      enabled: true
      dhcp: true
      autoconf: true

```

--------------------------------

### Example of Running and Config Routes

Source: https://nmstate.io/devel/yaml_api.html

Illustrates the structure for both 'running' and 'config' routes. Note that 'running' routes are ignored during application, while 'config' routes are appended.

```yaml
routes:
  running:
  - destination: 0.0.0.0/0
    next-hop-interface: eth1
    next-hop-address: 192.0.2.1
    table-id: 254
  config:
  - destination: 0.0.0.0/0
    next-hop-interface: eth1
    next-hop-address: 192.0.2.1
    table-id: 254

```

--------------------------------

### Interface Profile Name Example

Source: https://nmstate.io/devel/yaml_api.html

Example of assigning a profile name to a virtual Ethernet interface.

```yaml
---
interfaces:
- name: eth1
  profile-name: wan0
  type: veth
  state: up
  identifier: mac-address
  mac-address: 8A:8C:92:1A:F6:98

```

--------------------------------

### Configure Interface Dispatch Scripts

Source: https://nmstate.io/devel/yaml_api.html

This example shows how to configure scripts to be executed upon interface activation and deactivation. Scripts are invoked using `systemd-cat`.

```yaml
---
interfaces:
- name: eth1
  type: ethernet
  state: up
  dispatch:
    post-activation: |
      echo post-up-eth1 | systemd-cat
    post-deactivation: |
      echo post-down-eth1 | systemd-cat

```

--------------------------------

### Add Alternative Interface Names

Source: https://nmstate.io/devel/yaml_api.html

This example demonstrates how to configure alternative names for a network interface. nmstate performs incremental changes, appending new names.

```yaml
---
interfaces:
  - name: enp7s0
    alt-names:
      - name: port1
      - name: veryveryveryverylonglonglongname

```

--------------------------------

### Interface PCI Address Example

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring an interface using its PCI address, enabling DHCP for IPv4 and IPv6.

```yaml
---
interfaces:
  - name: wan0
    type: ethernet
    state: up
    identifier: pci-address
    pci-address: 0000:07:00.0
    ipv4:
      enabled: true
      dhcp: true
    ipv6:
      enabled: true
      dhcp: true
      autoconf: true

```

--------------------------------

### IPsec Encryption Configuration

Source: https://nmstate.io/devel/yaml_api.html

Example of an X509 based authentication IPsec connection using nmstate. Ensure Libreswan and NetworkManager-libreswan are installed.

```yaml
--- 
interfaces:
- name: hosta_conn
  type: ipsec
  ipv4:
    enabled: true
    dhcp: true
  libreswan:
    right: 192.0.2.252
    rightid: '@hostb.example.org'
    left: 192.0.2.251
    leftid: '%fromcert'
    leftcert: hosta.example.org
    ikev2: insist

```

--------------------------------

### OpenvSwitch Bridge Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring an OpenvSwitch bridge interface with basic options and ports. This demonstrates setting STP, RSTP, and multicast snooping.

```yaml
interfaces:
- name: br0
  type: ovs-bridge
  state: up
  wait-ip: any
  bridge:
    options:
      stp: false
      rstp: false
      mcast-snooping-enable: false
    port:
    - name: ovs0
    - name: eth1

```

--------------------------------

### Open vSwitch DPDK Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example configures an Open vSwitch interface 'ovs0' to use DPDK with a specific PCI device and sets up an Open vSwitch bridge 'br0'. It also enables DPDK initialization globally.

```yaml
---
interfaces:
- name: ovs0
  type: ovs-interface
  state: up
  dpdk:
    devargs: "0000:af:00.1"
    rx-queue: 100
- name: br0
  type: ovs-bridge
  state: up
  bridge:
    options:
      datapath: "netdev"
    port:
    - name: ovs0
vs-db:
  other_config:
    dpdk-init: "true"

```

--------------------------------

### Configure Ethernet Interface Settings

Source: https://nmstate.io/devel/yaml_api.html

This example demonstrates how to configure basic Ethernet interface parameters such as speed, duplex, and auto-negotiation. Note that speed and duplex settings are ignored if auto-negotiation is enabled.

```yaml
---
interfaces:
  - name: eth1
    type: ethernet
    state: up
    ethernet:
      speed: 10000
      duplex: full
      auto-negotiation: false

```

--------------------------------

### Example Ethtool Ring Configuration

Source: https://nmstate.io/devel/yaml_api.html

This YAML snippet demonstrates how to configure the ring parameters for an Ethernet interface, specifying values for RX and TX rings.

```yaml
---
interfaces:
  - name: enp1s0
    state: up
    ethtool:
      ring:
        rx: 256
        rx-jumbo: 0
        rx-mini: 0
        tx: 256

```

--------------------------------

### Configure Linux Bridge Interface

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring a Linux Bridge interface with various options including STP and port configurations.

```yaml
interfaces:
- name: br0
  type: linux-bridge
  state: up
  bridge:
    options:
      gc-timer: 29657
      group-addr: 01:80:C2:00:00:00
      group-forward-mask: 0
      group-fwd-mask: 0
      hash-max: 4096
      hello-timer: 0
      mac-ageing-time: 300
      multicast-last-member-count: 2
      multicast-last-member-interval: 100
      multicast-membership-interval: 26000
      multicast-querier: false
      multicast-querier-interval: 25500
      multicast-query-interval: 12500
      multicast-query-response-interval: 1000
      multicast-query-use-ifaddr: false
      multicast-router: auto
      multicast-snooping: true
      multicast-startup-query-count: 2
      multicast-startup-query-interval: 3125
      stp:
        enabled: false
        forward-delay: 15
        hello-time: 2
        max-age: 20
        priority: 32768
      vlan-protocol: 802.1q
    port:
    - name: eth1
      stp-hairpin-mode: false
      stp-path-cost: 100
      stp-priority: 32

```

--------------------------------

### Purging Static DNS Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example shows how to purge the static DNS configuration by setting the config section to an empty object.

```yaml
dns-resolver:
  config: {}

```

--------------------------------

### Configure Bridge with Copied MAC Address

Source: https://nmstate.io/devel/yaml_api.html

This example demonstrates how to create a Linux bridge and copy the MAC address from another interface. Ensure the source interface exists.

```yaml
---
interfaces:
  - name: br0
    type: linux-bridge
    state: up
    copy-mac-from: eth2
    bridge:
      port:
      - name: eth2
      - name: eth1

```

--------------------------------

### Configure VLAN Interface

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring a VLAN interface with a base interface and VLAN ID. Supports 802.1q and 802.1ad protocols.

```yaml
interfaces:
  - name: eth1.101
    type: vlan
    state: up
    vlan:
      base-iface: eth1
      id: 101
      protocol: 802.1q

```

--------------------------------

### Configure Dynamic IP Addresses with Auto Settings

Source: https://nmstate.io/devel/yaml_api.html

This example configures an interface to obtain IPv4 and IPv6 addresses dynamically via DHCP, with automatic DNS, gateway, and route settings.

```yaml
---
interfaces:
  - name: eth1
    type: ethernet
    state: up
    ipv4:
      enabled: true
      dhcp: true
      auto-dns: true
      auto-gateway: true
      auto-routes: true
      auto-route-table-id: 0
      auto-route-metric: 101
      dhcp-client-id: ll
    ipv6:
      enabled: true
      dhcp: true
      autoconf: true
      auto-dns: true
      auto-gateway: true
      auto-routes: true
      auto-route-table-id: 0
      auto-route-metric: 102
      dhcp-duid: ll

```

--------------------------------

### Configure IPv4-over-IPv4 Tunnel Interface

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring an IPv4-over-IPv4 tunnel interface. Ensure the 'ip-tunnel' type is specified with 'mode: ipip'.

```yaml
interfaces:
- name: ipip0
  type: ip-tunnel
  state: up
  mtu: 1480
  ip-tunnel:
    mode: ipip
    local: 192.0.2.1
    remote: 192.0.2.2
    ttl: 42
    tos: 22
    pmtu-disc: true
    fwmark: 0

```

--------------------------------

### Loopback Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

Example YAML for configuring a loopback interface. Use `state: absent` to revert to kernel defaults. Nmstate ensures default IPs are present.

```yaml
interfaces:
- name: lo
  type: loopback
  state: up
  mac-address: 00:00:00:00:00:00
  mtu: 65536
  ipv4:
    enabled: true
    dhcp: false
    address:
    - ip: 127.0.0.1
      prefix-length: 8
  ipv6:
    enabled: true
    dhcp: false
    address:
    - ip: ::1
      prefix-length: 128

```

--------------------------------

### Configure Bond Interface with Link Aggregation

Source: https://nmstate.io/devel/yaml_api.html

This example configures a bond interface using link aggregation. It specifies the bond mode (e.g., balance-rr) and various options for managing the aggregated links, including port assignments. Consult kernel documentation for detailed explanations of each bond mode.

```yaml
---
interfaces:
- name: bond99
  type: bond
  state: up
  link-aggregation:
    mode: balance-rr
    options:
      all_slaves_active: dropped
      arp_all_targets: any
      arp_interval: 0
      arp_validate: none
      downdelay: 0
      lp_interval: 1
      miimon: 100
      min_links: 0
      packets_per_slave: 1
      primary_reselect: always
      resend_igmp: 1
      updelay: 0
      use_carrier: true
    port:
    - eth1
    - eth2

```

--------------------------------

### Configure VxLAN Interface

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring a VxLAN interface with a base interface, VLAN ID, and remote/local IP addresses. Supports IPv6.

```yaml
interfaces:
- name: eth1.102
  type: vxlan
  state: up
  ipv6:
    enabled: true
  vxlan:
    base-iface: eth1
    id: 102
    remote: 192.0.2.251
    local: 192.0.2.252
    learning: false
    destination-port: 1235

```

--------------------------------

### Deleting a Route Rule

Source: https://nmstate.io/devel/yaml_api.html

This example demonstrates how to delete a specific route rule by setting its state to 'absent'.

```yaml
---
route-rules:
  config:
    - ip-from: 192.168.3.2/32
      route-table: 200
      state: absent

```

--------------------------------

### Configure Static IP Addresses with MPTCP Flags

Source: https://nmstate.io/devel/yaml_api.html

This example configures static IPv4 and IPv6 addresses on an interface, including MPTCP flags for signal and subflow.

```yaml
---
interfaces:
- name: eth1
  state: up
  ipv4:
    enabled: true
    dhcp: false
    address:
    - ip: 192.0.2.252
      prefix-length: 24
      mptcp-flags:
      - signal
      - subflow
    - ip: 192.0.2.251
      prefix-length: 24
      mptcp-flags:
      - signal
      - subflow
  ipv6:
    enabled: true
    autoconf: false
    dhcp: false
    address:
    - ip: 2001:db8:2::1
      prefix-length: 64
      mptcp-flags:
      - signal
      - subflow
    - ip: 2001:db8:1::1
      prefix-length: 64
      mptcp-flags:
      - signal
      - subflow

```

--------------------------------

### Remove Alternative Interface Names

Source: https://nmstate.io/devel/yaml_api.html

This example shows how to mark alternative interface names for removal. Only names explicitly set to `state: absent` will be removed.

```yaml
---
interfaces:
  - name: enp7s0
    alt-names:
      - name: port1
        state: absent
      - name: veryveryveryverylonglonglongname
        state: absent

```

--------------------------------

### Delete All Routes with Specific Interface

Source: https://nmstate.io/devel/yaml_api.html

Example of deleting all routes associated with a specific 'next-hop-interface'. The 'state: absent' directive is crucial for removal.

```yaml
routes:
  config:
  - destination: 0.0.0.0/0
    next-hop-interface: eth1
    state: absent

```

--------------------------------

### IPVLAN Interface Configuration (L3 Mode)

Source: https://nmstate.io/devel/yaml_api.html

Example YAML for configuring an IPVLAN interface in L3 mode. The `base-iface` specifies the parent interface. Ensure correct `mode` and `base-iface` are set.

```yaml
interfaces:
- name: ipvlan0
  type: ipvlan
  state: up
  ipvlan:
    mode: l3
    base-iface: eth1
    private: false
    vepa: false

```

--------------------------------

### Open vSwitch Patch Interfaces Connecting Two Bridges

Source: https://nmstate.io/devel/yaml_api.html

This example demonstrates connecting two Open vSwitch bridges, 'ovs-br0' and 'ovs-br1', using patch interfaces 'patch0' and 'patch1'. Each patch interface is configured with its peer.

```yaml
---
interfaces:
- name: patch0
  type: ovs-interface
  state: up
  patch:
    peer: patch1
- name: ovs-br0
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: patch0
- name: patch1
  type: ovs-interface
  state: up
  patch:
    peer: patch0
- name: ovs-br1
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: patch1

```

--------------------------------

### Linux Virtual Ethernet (veth) Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example configures a Linux veth interface named 'veth1' and specifies its peer interface as 'veth1peer'.

```yaml
---
interfaces:
- name: veth1
  type: veth
  state: up
  veth:
    peer: veth1peer

```

--------------------------------

### Base Interface Properties Example

Source: https://nmstate.io/devel/yaml_api.html

This YAML snippet defines desired state for base interface properties including name, profile name, type, state, MAC address, PCI address, MTU, and wait-IP settings.

```yaml
interfaces:
- name: eth1
  profile-name: wan0
  type: ethernet
  state: up
  mac-address: 1C:FF:EE:DD:3B:D3
  permanent-mac-address: 1C:FF:EE:DD:BB:D3
  pci-address: 0000:07:00.0
  mtu: 1500
  min-mtu: 256
  max-mtu: 2304
  wait-ip: any
  accept-all-mac-addresses: false


```

--------------------------------

### Use Alternative Names in nmstate Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example illustrates using alternative interface names in various nmstate configurations, including as interface names, bond ports, VLAN base interfaces, bridge ports, and route next-hop interfaces.

```yaml
---
interfaces:
  - name: enp7s0
    type: ethernet
    state: up
    alt-names:
      - name: port1
      - name: veryveryveryverylonglonglongname
  - name: bond99
    type: bond
    bond:
      mode: 0
      ports:
        - veryveryveryverylonglonglongname
  - name: vlan101
    type: vlan
    state: up
    vlan:
      base-iface: veryveryveryverylonglonglongname
      id: 101
routes:
  config:
  - destination: 198.51.100.0/24
    metric: 150
    next-hop-address: 192.0.2.1
    next-hop-interface: veryveryveryverylonglonglongname
    table-id: 254

```

--------------------------------

### MAC VLAN Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This example configures a MAC VLAN interface named 'mac0' on top of 'eth1'. It sets the mode to 'passthru' and enables promiscuous mode.

```yaml
interfaces:
- name: mac0
  type: mac-vlan
  state: up
  mac-vlan:
    base-iface: eth1
    mode: passthru
    promiscuous: true

```

--------------------------------

### HSR/PRP Interface Configuration (PRP Protocol)

Source: https://nmstate.io/devel/yaml_api.html

Example YAML for configuring a PRP interface using the HSR type. The `copy-mac-from` and `hsr` section specify the ports and protocol.

```yaml
interfaces:
  - name: hsr0
    type: hsr
    state: up
    copy-mac-from: eth1
    hsr:
      port1: eth1
      port2: eth2
      multicast-spec: 40
      protocol: prp

```

--------------------------------

### SR-IOV VF Interface Naming Convention

Source: https://nmstate.io/devel/yaml_api.html

This example shows the naming convention for referring to a SR-IOV Virtual Function (VF) interface using the format sriov:<pf_name>:<vf_id>.

```yaml
sriov:<pf_name>:<vf_id>


```

--------------------------------

### Linux Bridge Port VLAN Configuration

Source: https://nmstate.io/devel/yaml_api.html

Example of configuring VLAN settings for a Linux bridge port in trunk mode. This includes specifying trunk tags, ID ranges, and enabling native VLAN support.

```yaml
--- 
interfaces:
  - name: br0
    type: linux-bridge
    state: up
    bridge:
      port:
        - name: eth1
          vlan:
            mode: trunk
            trunk-tags:
            - id: 101
            - id-range:
                min: 500
                max: 599
            tag: 100
            enable-native: true
        - name: eth2
          vlan:
            mode: trunk
            trunk-tags:
            - id: 500

```

--------------------------------

### Create OpenvSwitch Bridge with Python

Source: https://nmstate.io/devel/yaml_api.html

This Python snippet demonstrates how to create an OpenvSwitch bridge and attach an ethernet interface to it using libnmstate and PyYAML.

```python
#!/usr/bin/python3

import yaml
import libnmstate

desire_state = """
interfaces:
- name: eth1
  type: ethernet
  state: up
- name: br0
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: eth1
    - name: br0
- name: br0
  type: ovs-interface
  state: up
"""

libnmstate.apply(yaml.load(desire_state, Loader=yaml.SafeLoader))

```

--------------------------------

### Hostname Configuration

Source: https://nmstate.io/devel/yaml_api.html

This snippet illustrates the configuration for both the running and static hostname of a system.

```yaml
hostname:
  running: "c9sr"
  config: "c9ss"

```

--------------------------------

### Open vSwitch Global Configuration

Source: https://nmstate.io/devel/yaml_api.html

This snippet shows the global configuration for Open vSwitch, including other_config and external_ids.

```yaml
ovs-db:
  other_config:
    stats-update-interval: "1000"
  external_ids:
    ovn-localnet-bridge-mappings: "ovn-external:breth0"

```

--------------------------------

### Create OpenvSwitch Bridge with Rust

Source: https://nmstate.io/devel/yaml_api.html

This Rust snippet shows how to create an OpenvSwitch bridge and attach an ethernet interface using the nmstate Rust crate and serde_yaml for YAML parsing.

```rust
// SPDX-License-Identifier: Apache-2.0

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let desire_state: nmstate::NetworkState = serde_yaml::from_str(
        r#"---
interfaces:
- name: eth1
  type: ethernet
  state: up
- name: br0
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: eth1
    - name: br0
- name: br0
  type: ovs-interface
  state: up
"#,
    )?;
    desire_state.apply()?;
    Ok(())
}



```

--------------------------------

### Configure SR-IOV Virtual Functions (VFs)

Source: https://nmstate.io/devel/yaml_api.html

This YAML snippet shows how to configure SR-IOV settings for an Ethernet interface, including the total number of VFs, maximum supported VFs, and specific configurations for individual VFs like MAC address, spoof check, and VLAN settings. When defining VFs, all configurations must be provided as nmstate will not merge them with the current status.

```yaml
---
interfaces:
  - name: eth1
    type: ethernet
    state: up
    ethernet:
      sr-iov:
        total-vfs: 2
        max-vfs: 63
        vfs:
        - id: 0
          mac-address: 00:11:22:33:00:FF
          spoof-check: true
          trust: false
          min-tx-rate: 0
          max-tx-rate: 0
          vlan-id: 0
          qos: 0
        - id: 1
          mac-address: 00:11:22:33:00:EF
          spoof-check: true
          trust: false
          min-tx-rate: 0
          max-tx-rate: 0
          vlan-id: 0
          qos: 0

```

--------------------------------

### IP over InfiniBand Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This YAML defines an IP over InfiniBand interface 'ib2.8001' with a specific P-key and connection mode. It also specifies the base interface and MTU.

```yaml
---
interfaces:
  - name: ib2.8001
    type: infiniband
    state: up
    mtu: 1280
    infiniband:
      pkey: "0x8001"
      mode: "connected"
      base-iface: "ib2"

```

--------------------------------

### Open vSwitch Internal Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This YAML defines an Open vSwitch internal interface named 'ovs0'. It includes settings for MAC address, MTU, and IP configuration, though IPv4 and IPv6 are disabled.

```yaml
- name: ovs0
  type: ovs-interface
  state: up
  mac-address: 92:7C:8B:BF:AA:D8
  mtu: 1500
  min-mtu: 68
  max-mtu: 65535
  wait-ip: any
  ipv4:
    enabled: false
  ipv6:
    enabled: false

```

--------------------------------

### IP Route Rules Configuration

Source: https://nmstate.io/devel/yaml_api.html

This snippet shows how to configure IP route rules for both IPv4 and IPv6, including specifying source IP, priority, and route table.

```yaml
route-rules:
  config:
  - ip-from: 192.168.3.2/32
    priority: 1000
    route-table: 200
  - ip-from: 2001:db8:b::/64
    priority: 1000
    route-table: 200
routes:
  config:
  - destination: 192.168.2.0/24
    next-hop-interface: eth1
    next-hop-address: 192.168.1.3
    metric: 108
    table-id: 200
  - destination: 2001:db8:a::/64
    next-hop-interface: eth1
    next-hop-address: 2001:db8:1::2
    metric: 108
    table-id: 200

```

--------------------------------

### DNS Resolver Configuration

Source: https://nmstate.io/devel/yaml_api.html

This snippet shows the configuration for DNS resolvers, including both running and static configurations for servers and search domains.

```yaml
dns-resolver:
  running:
    server:
    - 2001:4860:4860::8888
    - 2001:4860:4860::8844
    - 8.8.4.4
    search:
    - example.com
    - example.org
  config:
    server:
    - 2001:4860:4860::8888
    - 2001:4860:4860::8844
    - 8.8.4.4
    search:
    - example.com
    - example.org

```

--------------------------------

### Open vSwitch Bridge with Various Port Types

Source: https://nmstate.io/devel/yaml_api.html

This snippet defines an Open vSwitch bridge named 'br0' with three types of ports: 'veth1' (internal), 'ovs0' (system), and 'bond1' (bond interface). The bond interface includes link aggregation and VLAN configuration.

```yaml
- name: br0
  type: ovs-bridge
  state: up
  bridge:
    port:
    - name: veth1
    - name: ovs0
    - name: bond1
      link-aggregation:
        mode: balance-slb
        port:
          - name: eth2
          - name: eth1
      vlan:
        mode: access
        tag: 100

```

--------------------------------

### Add and Modify Default Gateway Route

Source: https://nmstate.io/devel/yaml_api.html

Demonstrates how to change the default gateway by first deleting the old route and then adding a new one. The 'state: absent' is used to remove existing routes.

```yaml
routes:
  config:
  - destination: 0.0.0.0/0
    next-hop-interface: eth1
    state: absent
  - destination: 0.0.0.0/0
    next-hop-address: 192.0.2.1
    next-hop-interface: eth1

```

--------------------------------

### Configure Multipath TCP Flags on an Interface

Source: https://nmstate.io/devel/yaml_api.html

This snippet demonstrates how to enable and configure Multipath TCP flags for an interface. It sets the interface to 'up', disables DHCP, assigns a static IPv4 address, and specifies MPTCP flags like 'backup' and 'signal'.

```yaml
interfaces:
  - name: eth1
    type: ethernet
    state: up
    mptcp:
      address-flags:
      - backup
      - signal
    ipv4:
      enabled: true
      dhcp: false
      address:
        - ip: 192.0.2.2
          prefix-length: 24
```

--------------------------------

### VRF Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This snippet defines a VRF interface named 'vrf0' with associated ports 'eth1' and 'eth2', and assigns it to route table ID 100.

```yaml
- name: vrf0
  type: vrf
  state: up
  vrf:
    port:
    - eth1
    - eth2
    route-table-id: 100

```

--------------------------------

### MAC VTAP Interface Configuration

Source: https://nmstate.io/devel/yaml_api.html

This YAML configures a MAC VTAP interface named 'mac0' on top of 'eth1'. It specifies the mode as 'passthru' and enables promiscuous mode.

```yaml
interfaces:
- name: mac0
  type: mac-vtap
  state: up
  mac-vtap:
    base-iface: eth1
    mode: passthru
    promiscuous: true

```

--------------------------------

### Disable Ethtool FEC and Enforce LLRS Mode

Source: https://nmstate.io/devel/yaml_api.html

Use this YAML configuration to disable automatic Forward Error Correction (FEC) and enforce the LLRS mode for a specified interface. Ensure the switch is configured first to avoid verification errors.

```yaml
---
interfaces:
  - name: sim0
    type: ethernet
    ethtool:
      fec:
        auto: false
        mode: llrs

```
Tokens:
Raw