NETPLAN(8)

🎀 NETPLAN(8) 🎀

okay so welcome to the System Manager's Manual page for netplan, the Netplan runtime CLI. 💅

✨ NAME ✨

netplan - Netplan runtime CLI 🌸

🧚 SYNOPSIS 🧚

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

💜 DESCRIPTION 💜

this page gives you the highlights of the Netplan runtime CLI commands. it's giving "read this first" energy 🫶

👑 OPTIONS 👑

• --debug — turns on debug messages, so you can see everything that's happening behind the scenes 🔍

🔥 EXAMPLES 🔥

• netplan generate — converts Netplan YAML into configuration files that the back ends ( systemd-networkd(8) or NetworkManager(8) ) actually understand. it does not apply the generated configuration, so nothing changes on your running system 🙈
• netplan apply — applies the current Netplan configuration to a running system. iconic ✨
• netplan try [ --timeout 120 ] — takes a netplan(5) configuration, applies it, and automatically rolls it back if the user doesn't confirm the configuration within a time limit. no cap, this is a lifesaver 😭
• 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. the validation part is so important bestie 🎀
• netplan status [ interface ] — queries the current network configuration and displays it in a human-readable format. very main character energy 💖

🌈 FILES 🌈

• /etc/netplan/ — the directory with YAML configuration files that describe your network configuration 🍓

🦋 SEE ALSO 🦋

netplan(5), netplan-generate(8), netplan-apply(8), netplan-try(8), netplan-get(8), netplan-set(8), netplan-status(8). go check these out, they're all iconic ⭐

💅 AUTHOR 💅

Lukas Märdian (slyon@ubuntu.com). the queen who made all of this happen 👑

okay bestie that's the whole thing, love you, mean it 💖✨🌈 NETPLAN(8), last updated 23 January 2025 🫶💜