The network-config-manager nmctl allows to configure and introspect the state of the network links as seen by systemd-networkd. nmctl can be used to query and configure links for Address, Routes, Gateways and also hostname, DNS, NTP or Domain. nmctl uses sd-bus, libudev APIs to interact with systemd, systemd-networkd, systemd-resolved, systemd-hostnamed, and systemd-timesyncd via dbus. nmctl uses networkd verbs to explain output. nmctl can generate configurations for required network links from YAML description. It also understands kernel command line specified in dracut's network configuration format and can generate systemd-networkd's configuration while the system boots and will persist between reboots.
Configure
- Static IPv4 and IPv6 Address, Routes, Gateway.
- DHCPv4/DHCPv6 Client (DHCP4 Client Identifier, UseMTU/UseDNS/UseDomains/UseNTP/UseRoutes).
- LLDP, Link Local Addressing, IPv4LLRoute, LLMNR.
- Per Link and global DNS, Domains
- NTP
- Routing Policy Rule
- Multiple default gateway with routing policy rules.
- Link's MAC, MTU.
- Create netdevs, vlan, vxlan, bridge, bond, veth, macvlan/macvtap, ipvlap/ipvtap, veth, tunnels(ipip, sit, gre, sit, vti), wireguard.
- Hostname.
- DHCPv4 Server.
- IPv6 Router Advertisements.
- Add delete and view nftables table, chains and rules.
- Edit network configuration via vim/vi.
Please see systemd.network for more information.
Gererates networkd unit configs from
Introspect
- Links.
- DNS and Domains.
- Hostname.
- nftable
- Supports JSON format.
meson, ninja-build, systemd-devel, libudev-devel, libyaml-devel, glib-devel, python3-sphinx libmnl-devel libnftnl-devel libnftables-devel json-c-devel
On Photon OS
➜ ~ tdnf install -y build-essential
➜ ~ tdnf install meson ninja-build systemd-devel libudev-devel libyaml-devel glib-devel libmnl-devel libnftnl-devel libnftables-devel json-c-devel
➜ ~ meson build
➜ ~ ninja -C build
➜ ~ sudo ninja -C build installOn Fedora/CentOS/RHEL
➜ ~ sudo dnf group install 'Development Tools'
➜ ~ sudo dnf install meson ninja-build systemd-devel libudev-devel libyaml-devel glib2-devel python3-sphinx libmnl-devel libnftnl-devel libnftables-devel json-c-devel
➜ ~ meson build
➜ ~ ninja -C build
➜ ~ sudo ninja -C build installOr by simply doing
❯ make
❯ sudo make install
➜ ~ nmctl --helpnmctl can generate configurations for required network links from YAML description. Configuration written to disk under /etc/systemd/network will persist between reboots. When netmgr-yaml-generator.service is enabled it reads yaml files from /etc/network-config-manager/yaml and generates systemd-networkd configuration files.
nmctl uses similar format as defined by different YAML format.
To set the link named eth1 get an address via DHCP4 and client identifier as mac create a YAML file with the following:
network:
link:
name: eth1
dhcp: ipv4
dhcp-client-identifier: macTo set a static IP address, use the addresses key, which takes a list of (IPv4 or IPv6), addresses along with the subnet prefix length (e.g. /24). Gateway and DNS information can be provided as well:
network:
link:
name: eth1
gateway: 192.168.1.1/24
gateway-onlink: yes
nameservers: [192.168.0.1, 8.8.8.8]
ntps: [192.168.0.2, 8.8.8.1]
addresses:
- 192.168.1.5/24 network:
link:
name: eth1
addresses: [ 192.168.1.45/24 ]
gateway: 192.168.1.1
gateway-onlink: true network:
link:
name: eth1
addresses: [ 192.168.1.45/24, 192.168.1.46 ]
gateway: 192.168.1.1 network:
link:
name: eth1
mtu : 1200
mac-address: 00:0c:29:3a:bc:89
match-mac-address: 00:0c:29:3a:bc:89
dhcp: yes
dhcp-client-identifier: mac
lldp: yes
link-local: yes
ipv6-accept-ra: yes
use-mtu: yes
use-domain: yes
gateway: 192.168.1.1/24
gateway-onlink: yes
nameservers: [192.168.0.1, 8.8.8.8]
ntps: [192.168.0.2, 8.8.8.1]
addresses:
- 5.0.0.5/24
- 10.0.0.12/24
- 11.0.0.13/24
routes:
- to: 0.0.0.0/0
via: 5.0.0.1
- to: 0.0.0.1/0
via: 5.0.0.2nmctl can generate WPA Supplicant configuration from yaml file. When a yml file with wifi
configuration are found it generates a confiration file found in /etc/network-config-manager/wpa_supplicant_photon_os.conf which is understood by wpa_supplicant.
network:
link:
name: wlan1
dhcp: yes
use-dns: no
use-mtu: yes
use-domain: yes
gateway: 192.168.1.1/24
gateway-onlink: yes
nameservers: [192.168.0.1, 8.8.8.8]
access-points:
- ssid-name: "network_ssid_name1"
password: "test123"
- ssid-name: "network_ssid_name2"
password: "test456" network:
link:
name: wlan0
dhcp: yes
access-points:
- ssid-name: "network_ssid_name1"
password: "test123"
method: ttls
anonymous-identity: "@test.example.com"
identity: "[email protected]" network:
link:
name: wlan1
dhcp: yes
access-points:
- ssid-name: "network_ssid_name1"
key-management: eap
method: tls
anonymous-identity: "@test.example.com"
identity: "[email protected]"
ca-certificate: /etc/ssl/cust-cacrt.pem
client-certificate: /etc/ssl/cust-crt.pem
client-key: /etc/ssl/cust-key.pem
client-key-password: "QZTrSEtq:h_d.W7_"nmctl understands kernel command line specified in dracut's network configuration format and can generate systemd-networkd's configuration while the system boots and will persist between reboots.
Network
ip={dhcp|on|any|dhcp6|auto6}
dhcp|on|any: get ip from dhcp server from all links. If root=dhcp, loop
sequentially through all links (eth0, eth1, ...) and use the first with a valid
DHCP root-path.
auto6: IPv6 autoconfiguration
dhcp6: IPv6 DHCP
ip=<link>:{dhcp|on|any|dhcp6|auto6}
dhcp|on|any|dhcp6: get ip from dhcp server on a specific link
auto6: do IPv6 autoconfiguration
This parameter can be specified multiple times.
ip=<client-IP>:[ <server-id>]:<gateway-IP>:<netmask>:<client_hostname>:<link>:{none|off}
explicit network configuration.
ifname=<link>:<MAC>
Assign network device name <link> (ie eth0) to the NIC with MAC <MAC>. Note
letters in the MAC-address must be lowercase! Note: If you use this option you must
specify an ifname= argument for all links used in ip= or fcoe= arguments. This
parameter can be specified multiple times.
nameserver=<IP>[nameserver=<IP> ...]
specify nameserver(s) to use➜ ~ cat /proc/cmdline
BOOT_IMAGE=/boot/vmlinuz-4.19.52-2.ph3-esx root=PARTUUID=ebf01b6d-7e9c-4345-93f4-122f44eb2726
init=/lib/systemd/systemd rcupdate.rcu_expedited=1 rw systemd.show_status=0 quiet noreplace-smp
cpu_init_udelay=0 net.ifnames=0 plymouth.enable=0 systemd.legacy_systemd_cgroup_controller=yes
ip=dhcpnetwork-config-manager-generator.service is a oneshot type systemd service unit which runs while system boots. It parses the kernel command line and generates networkd config in /etc/systemd/network.
➜ ~ sudo systemctl enable network-config-manager-generator.service
Created symlink /etc/systemd/system/network.target.wants/network-config-manager-generator.service → /usr/lib/systemd/system/network-config-manager-generator.service.
Note: Only IPv4 configuration is supported for static configs.
The network-config-manager project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.
Please join #photon https://code.vmware.com/web/code/join