---
name: "netplan-get"
section: "8"
platform: "linux"
package: "netplan"
version: "1.2.2-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/netplan-get"
---

# netplan-get(8)

read merged Netplan YAML configuration

## NAME

`netplan-get` - read merged Netplan YAML configuration

## SYNOPSIS

**netplan** \[*--debug*\] **get** **-h**\|**--help**

**netplan** \[*--debug*\] **get** \[*--root-dir=ROOT\_DIR*\] \[*key*\]

## DESCRIPTION

**netplan get key** reads all YAML files from `/{etc,lib,run}/netplan/*.yaml` and returns a merged view of the current configuration.

You can specify `all` as a key (the default) to get the full YAML tree or extract a subtree by specifying a nested key like: `[network.]ethernets.eth0`.

For details of the configuration file format, see [**netplan**(5)](/netplan/5.md).

## OPTIONS

- `-h`, `--help`

  Print basic help.

- `--debug`

  Print debugging output during the process.

- `--root-dir`

  Read YAML files from this root instead of `/`.

## SEE ALSO

[**netplan**(5)](/netplan/5.md), [**netplan-set**(8)](/netplan-set/8.md), [**netplan-dbus**(8)](/netplan-dbus/8.md)

## AUTHORS

Lukas Märdian (lukas.maerdian@canonical.com).