Netplan documentation#

Netplan is a network configuration abstraction renderer.

It is a utility for network configuration on a Linux system. You create a description of the required interfaces and define what each should do.

Netplan meets the need of easy, descriptive network configuration in YAML across a versatile set of server, desktop, cloud or IoT installations.

It is useful for administrators of a Linux system who want to use a common network configuration, controlling different backends like NetworkManager or systemd-networkd.

Tutorials

How-to guides

Get started - hands-on introduction to Netplan for new users

Step-by-step guides covering key operations and common tasks

Explanation

Reference

Discussion and clarification of key topics

Technical information - specifications, APIs, architecture

Project and community#

Netplan is a member of the Ubuntu family. It’s an open source project that warmly welcomes community contributions, suggestions, fixes and constructive feedback.

Thinking about using Netplan? Get in touch!