NETPLAN-STATUS(8)

๐Ÿ’… NETPLAN-STATUS(8) โ€” netplan-status, bestie edition ๐ŸŽ€

okay so this is the manual page for netplan-status, straight out of the System Manager's Manual โ€” it lives in section 8 of the netplan fam, and it's the one you call when you wanna know what your network is actually doing rn. let's get into it โœจ


๐ŸŒธ NAME ๐ŸŒธ

netplan-status โ€” query networking state of the running system. that's it. that's the vibe check for your network ๐Ÿ’–


๐Ÿฆ‹ SYNOPSIS ๐Ÿฆ‹

netplan [--debug] status -h|--help

netplan [--debug] status [interface]

โœจ DESCRIPTION โœจ

netplan status [interface] goes and queries the current network configuration and displays it in a human-readable format. literally so readable. a whole meal ๐Ÿ“

You can specify interface to display the status of a specific interface โ€” like, if you only care about one of them, just say so and it'll narrow it down for you ๐Ÿ’…

rn, netplan status depends on systemd-networkd as a source of data, and it will try to start it if it's not masked. so like, it needs its source, no cap. if you masked it, that's between you and your choices ๐Ÿ™ˆ


๐Ÿ’œ OPTIONS ๐Ÿ’œ

  • -h, --help โ€” Print basic help. the "what do these flags even do" button ๐Ÿซถ
  • --debug โ€” Print debugging output during the process. for when you need to see the receipts ๐Ÿ”ฅ
  • -a, --all โ€” Show all interface data including inactive. not just the main characters โ€” the whole cast ๐Ÿ‘‘
  • --diff โ€” Analyse and display differences between the current system configuration and network definitions present in the YAML files. The configuration analysed includes IP addresses, routes, MAC addresses, DNS addresses, search domains and missing network interfaces.

The output format is similar to popular diff tools, such diff and git diff. Configuration present only in the system (and therefore missing in the Netplan YAML) will be displayed with a + sign and will be highlighted in green. Configuration present only in Netplan (and therefore missing in the system) will be displayed with a - sign and highlighted in red. The same is applied to network interfaces. green means "system has it, YAML doesn't", red means "YAML has it, system doesn't" โ€” iconique side-by-side energy, iykyk ๐ŸŒˆ

  • --diff-only โ€” Same as --diff but omits all the information that is not a difference. strictly differences. no filler, no fluff, main character energy only ๐Ÿ’€
  • --root-dir โ€” Read YAML files from this root instead of /. for when your files live somewhere else and you're like "not me changing the root" ๐Ÿ™ˆ
  • --verbose โ€” Show extra information. more lore, more context, more everything โœจ
  • -f FORMAT, --format FORMAT โ€” Output in machine-readable json or yaml format. for when a robot is reading and not a girlie ๐Ÿค–

๐ŸŽ€ SEE ALSO ๐ŸŽ€

netplan(5), netplan-get(8), netplan-ip(8) โ€” the rest of the squad, go say hi ๐Ÿ’–


๐ŸŒŸ AUTHORS ๐ŸŒŸ

Danilo Egea Gondolfo (danilo.egea.gondolfo@canonical.com). slay, thank you for your service ๐Ÿซถ


ngl bestie, if you're about to trust a + or a - in that diff output, remember it's comparing your live system against your YAML โ€” if they disagree, that's the whole point ๐Ÿ’…

okay that's the whole page! ๐Ÿฆ‹ this one came from the System Manager's Manual, tagged NETPLAN-STATUS(8) at the top and bottom (page header and footer both yelling the same section name at you, as manpages do), and that title line was the source + section label, no date attached. go check your network, bestie, you got this ๐Ÿ’œโœจ

๐Ÿ“ฆ where this page comes from