cookbook 'netplan', '~> 1.1.0'
netplan (13) Versions 1.1.0 Follow1
Provides custom resources to install netplan and manage /etc/netplan YAML fragments
cookbook 'netplan', '~> 1.1.0', :supermarket
knife supermarket install netplan
knife supermarket download netplan
netplan
Provides custom resources to install Netplan and manage /etc/netplan YAML fragments on Debian and Ubuntu.
Netplan is a declarative network configuration renderer. This cookbook writes and validates YAML configuration, but it does not apply live networking changes unless a resource explicitly sets apply true.
Resources
netplan_installnetplan_confignetplan_ethernetnetplan_bridgenetplan_bondnetplan_vlan
Examples
Install Netplan:
netplan_install 'default'
Write a raw YAML fragment and validate it with netplan generate:
netplan_config '10-static' do config( network: { version: 2, renderer: 'networkd', ethernets: { eth0: { dhcp4: false, addresses: ['192.0.2.10/24'], nameservers: { addresses: ['192.0.2.53'], }, }, }, } ) end
Manage a simple DHCP ethernet fragment without applying it live:
netplan_ethernet 'eth0' do filename '20-eth0.yaml' renderer 'networkd' dhcp4 true optional true end
Apply changed configuration explicitly:
netplan_config '50-lan' do apply true config( network: { version: 2, renderer: 'networkd', ethernets: { eth0: { dhcp4: true, }, }, } ) end
Documentation
See the files in documentation/ for full resource properties and examples.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
netplan Cookbook Changelog
This file is used to list changes made in each version of the netplan cookbook.
1.1.0 (2026-06-30)
Features
Bug Fixes
0.1.13 (2025-10-15)
Bug Fixes
0.1.2 - 2023-03-13
- Update workflows to 2.0.1
- Remove mdl and replace with markdownlint-cli2
- Update tested platforms
Collaborator Number Metric
1.1.0 passed this metric
Contributing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 passed this metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Cookstyle Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 passed this metric
1.1.0 passed this metric
Testing File Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.0 failed this metric
1.1.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number