netplan(8)

netplan8

Netplan runtime cli

Usage

netplan [--debug] [{generate | apply | try | get | set | status}]

Overview

This manual page provides an overview of the Netplan runtime CLI commands.

Options

--debug

Enable debug messages

Examples

netplan generate converts Netplan YAML into configuration files understood by the back ends ( systemd-networkd(8) or NetworkManager(8) ). It does not apply the generated configuration.

netplan apply applies the current Netplan configuration to a running system.

netplan try [ --timeout 120 ] takes a netplan(5) configuration, applies it, and automatically rolls it back if the user does not confirm the configuration within a time limit.

netplan get [ network.ethernets.eth0 ] reads YAML files from /{etc,lib,run}/netplan/*.yaml and returns a merged view of the current configuration.

netplan set [ network.ethernets.eth0={dhcp4: true, dhcp6: true} ] writes a given key/value pair or JSON struct into a YAML file in /etc/netplan/ and validates its format.

netplan status [ interface ] queries the current network configuration and displays it in human-readable format.

Files

/etc/netplan/

Directory with YAML configuration files, describing the network configuration.

Releases

12 releases since Debian 2.0 (Hamm); the text changed 4 times.

  1. 2.0
  2. 2.1
  3. 2.2
  4. 3.0–9
  5. 13

--debug since Debian 13 (Trixie).

-a until Debian 9 (Stretch); -d until Debian 9 (Stretch); -f until Debian 9 (Stretch); -v until Debian 9 (Stretch).

Author

Lukas Märdian ([email protected]).

From netplan.io 1.1.2-7 in Debian 13 (Trixie). Parsed by carta from the page's man source.