File: netplan-get.md

package info (click to toggle)
netplan.io 1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 4,268 kB
  • sloc: python: 34,640; ansic: 14,096; xml: 4,989; javascript: 2,165; sh: 513; makefile: 118
file content (39 lines) | stat: -rw-r--r-- 934 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
---
title: NETPLAN-GET
section: 8
author:
- Lukas Märdian (lukas.maerdian@canonical.com)
...

## 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).

## 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-set`**(8), **`netplan-dbus`**(8)