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
|
# Netplan CLI
```{toctree}
---
maxdepth: 1
hidden: true
---
generate <netplan-generate>
apply <netplan-apply>
try <netplan-try>
get <netplan-get>
set <netplan-set>
info <netplan-info>
ip <netplan-ip>
rebind <netplan-rebind>
status <netplan-status>
```
Netplan provides a command line interface called `netplan`, which a user can
use to control certain aspects of the Netplan configuration.
| Tool | Description |
| --- | --- |
| help | Show a generic help message |
| [generate](/netplan-generate) | Generate back-end specific configuration files from `/etc/netplan/*.yaml` |
| [apply](/netplan-apply) | Apply current Netplan configuration to running system |
| [try](/netplan-try) | Try to apply a new Netplan configuration to running system, with automatic rollback |
| [get](/netplan-get) | Get a setting by specifying a nested key like `"ethernets.eth0.addresses"`, or `"all"` |
| [set](/netplan-set) | Add new setting by specifying a dotted `key=value` pair like `"ethernets.eth0.dhcp4=true"` |
| [info](/netplan-info) | Show available features |
| [ip](/netplan-ip) | Retrieve IP information (like DHCP leases) from the system |
| [rebind](/netplan-rebind) | Rebind SR-IOV virtual functions of given physical functions to their driver |
| [status](/netplan-status) | Query networking state of the running system |
|
