https://netplan.io/

Netplan
Menu Close menu
Jump to main content

  * Reference
  * Design
  * Examples
  * FAQ
  * Troubleshooting

Netplan

The network configuration abstraction renderer

Netplan is a utility for easily configuring networking on a linux
system. You simply create a YAML description of the required network
interfaces and what each should be configured to do. From this
description Netplan will generate all the necessary configuration for
your chosen renderer tool.

[0fbee9c4-pictogram_internet]

How does it work?

Netplan reads network configuration from /etc/netplan/*.yaml which
are written by administrators, installers, cloud image
instantiations, or other OS deployments. During early boot, Netplan
generates backend specific configuration files in /run to hand off
control of devices to a particular networking daemon.

Netplan currently works with these supported renderers

  * NetworkManager
  * Systemd-networkd

[a1a80854-netplan_design_overview]

How do I use it?

Configuration

Obviously, without configuration, netplan will not do anything. The
most useful configuration snippet (to bring up things via dhcp) is as
follows:

network:
  version: 2
  renderer: NetworkManager

This will make NetworkManager manage all devices (and by default, any
ethernet device will come up with DHCP once carrier is detected).

Using networkd as a renderer does not let devices automatically come
up using DHCP; each interface needs to be specified in a file in /etc
/netplan for its configuration to be written and for it to be used in
networkd.

Commands

Netplan uses a set of subcommands to drive its behavior:

  * netplan generate: Use /etc/netplan to generate the required
    configuration for the renderers.
  * netplan apply: Apply all configuration for the renderers,
    restarting them as necessary.
  * netplan try: Apply configuration and wait for user confirmation;
    will roll back if network is broken or no confirmation is given.

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

Netplan

  * Home
  * Reference
  * Design
  * Examples

Need help?

  * Ask Ubuntu
  * Join #netplan on Libera Chat
  * Report a bug

Contribute

  * GitHub

(c) 2022 Canonical Ltd. Ubuntu and Canonical are registered trademarks
of Canonical Ltd.

  * Legal info
  * Manage your tracker settings
  * Report a bug with this site
  * Report a bug with Netplan

Go to the top of the page