NETPLAN-TRY(8)

๐ŸŽ€ netplan-try(8) ๐ŸŽ€

okay so bestie, this is the netplan-try page from the System Manager's Manual, and itโ€™s literally the โ€œtry it before you commitโ€ vibe check for your network config. Manual name folded in right here instead of copying the header line, periodt. ๐Ÿ’…

๐ŸŒธ NAME ๐ŸŒธ

netplan-try โ€” try a configuration, optionally rolling it back

โœจ SYNOPSIS โœจ

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

netplan [--debug] try [--config-file CONFIG_FILE] [--timeout TIMEOUT]

๐Ÿ’– DESCRIPTION ๐Ÿ’–

netplan try takes a netplan(5) configuration, applies it, and automatically rolls it back if the user does not confirm the configuration within a time limit. Itโ€™s giving safety net, ngl. ๐Ÿ˜ญ

A configuration can be confirmed or rejected interactively or by sending the SIGUSR1 or SIGINT signals.

This may be especially useful on remote systems, to prevent an administrator being permanently locked out of systems in the case of a network configuration error. Remote-admin main character energy, fr fr. ๐Ÿซถ

๐Ÿ’… OPTIONS ๐Ÿ’…

  • -h, --help โ€” Print basic help. Simple, iconic, does what it says.
  • --debug โ€” Print debugging output during the process. For when you need the receipts. ๐Ÿ”ฅ
  • --config-file CONFIG_FILE โ€” In addition to the usual configuration, apply CONFIG_FILE. It must be a YAML file in the netplan(5) format.
  • --timeout TIMEOUT โ€” Wait for TIMEOUT seconds before reverting. Defaults to 120 seconds. Note that some network configurations (such as STP) may take over a minute to settle. So like, donโ€™t rush the vibe check. ๐ŸŒธ

๐Ÿ˜ญ KNOWN ISSUES ๐Ÿ˜ญ

netplan try uses similar procedures to netplan apply, so some of the same caveats apply around virtual devices.

There are also some known bugs: if netplan try times out or is cancelled, make sure to verify if the network configuration has in fact been reverted.

As with netplan apply, a reboot should fix any issues. However, be sure to verify that the configuration on disk is in the state you expect before rebooting!

โš ๏ธ bestie, read that last bit again: verify the config on disk before you reboot. The drama is not worth it. ๐Ÿ’€

๐Ÿ”ฅ SEE ALSO ๐Ÿ”ฅ

netplan(5), netplan-generate(8), netplan-apply(8)

๐Ÿ‘‘ AUTHORS ๐Ÿ‘‘

Daniel Axtens (daniel.axtens@canonical.com).

๐Ÿซถ and thatโ€™s the whole netplan-try(8) page from the System Manager's Manual โ€” the footer didnโ€™t print a version or date, so this is the cute sign-off instead. ๐Ÿ’œ

๐Ÿ“ฆ where this page comes from