From e465722b908aa870bdc293b9a417d3c15294aa6d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 25 Dec 2024 20:36:29 +0100 Subject: New upstream version 1.50.1 --- docs/api/html/NetworkManager-dispatcher.html | 430 -- .../html/NetworkManager-wait-online.service.html | 144 - docs/api/html/NetworkManager.conf.html | 1947 ------ docs/api/html/NetworkManager.devhelp2 | 927 --- docs/api/html/NetworkManager.html | 391 -- docs/api/html/ch01.html | 199 - docs/api/html/dbus-secret-agent.html | 32 - docs/api/html/dbus-types.html | 32 - docs/api/html/dbus-vpn-plugin.html | 32 - docs/api/html/dbus-vpn-types.html | 32 - ...org.freedesktop.NetworkManager.AccessPoint.html | 191 - ...rg.freedesktop.NetworkManager.AgentManager.html | 122 - ...-org.freedesktop.NetworkManager.Checkpoint.html | 86 - ...eedesktop.NetworkManager.Connection.Active.html | 321 - ...org.freedesktop.NetworkManager.DHCP4Config.html | 63 - ...org.freedesktop.NetworkManager.DHCP6Config.html | 63 - ...org.freedesktop.NetworkManager.Device.Adsl.html | 68 - ...reedesktop.NetworkManager.Device.Bluetooth.html | 92 - ...org.freedesktop.NetworkManager.Device.Bond.html | 94 - ...g.freedesktop.NetworkManager.Device.Bridge.html | 94 - ...rg.freedesktop.NetworkManager.Device.Dummy.html | 65 - ....freedesktop.NetworkManager.Device.Generic.html | 76 - ...-org.freedesktop.NetworkManager.Device.Hsr.html | 113 - ...freedesktop.NetworkManager.Device.IPTunnel.html | 201 - ...eedesktop.NetworkManager.Device.Infiniband.html | 81 - ...freedesktop.NetworkManager.Device.Loopback.html | 45 - ...g.freedesktop.NetworkManager.Device.Lowpan.html | 78 - ...g.freedesktop.NetworkManager.Device.Macsec.html | 202 - ....freedesktop.NetworkManager.Device.Macvlan.html | 97 - ...rg.freedesktop.NetworkManager.Device.Modem.html | 124 - ...freedesktop.NetworkManager.Device.OlpcMesh.html | 89 - ...reedesktop.NetworkManager.Device.OvsBridge.html | 67 - ...desktop.NetworkManager.Device.OvsInterface.html | 45 - ....freedesktop.NetworkManager.Device.OvsPort.html | 67 - ...-org.freedesktop.NetworkManager.Device.Ppp.html | 45 - ...eedesktop.NetworkManager.Device.Statistics.html | 89 - ...org.freedesktop.NetworkManager.Device.Team.html | 105 - ...-org.freedesktop.NetworkManager.Device.Tun.html | 134 - ...org.freedesktop.NetworkManager.Device.Veth.html | 64 - ...org.freedesktop.NetworkManager.Device.Vlan.html | 103 - ...-org.freedesktop.NetworkManager.Device.Vrf.html | 64 - ...rg.freedesktop.NetworkManager.Device.Vxlan.html | 248 - ....freedesktop.NetworkManager.Device.WifiP2P.html | 200 - ...reedesktop.NetworkManager.Device.WireGuard.html | 87 - ...rg.freedesktop.NetworkManager.Device.Wired.html | 116 - ...freedesktop.NetworkManager.Device.Wireless.html | 287 - ...org.freedesktop.NetworkManager.Device.Wpan.html | 67 - ...dbus-org.freedesktop.NetworkManager.Device.html | 696 -- ...-org.freedesktop.NetworkManager.DnsManager.html | 91 - ...s-org.freedesktop.NetworkManager.IP4Config.html | 223 - ...s-org.freedesktop.NetworkManager.IP6Config.html | 174 - .../gdbus-org.freedesktop.NetworkManager.PPP.html | 200 - ...org.freedesktop.NetworkManager.SecretAgent.html | 231 - ...desktop.NetworkManager.Settings.Connection.html | 426 -- ...us-org.freedesktop.NetworkManager.Settings.html | 521 -- ....freedesktop.NetworkManager.VPN.Connection.html | 118 - ...-org.freedesktop.NetworkManager.VPN.Plugin.html | 475 -- ...org.freedesktop.NetworkManager.WifiP2PPeer.html | 179 - .../html/gdbus-org.freedesktop.NetworkManager.html | 1205 ---- docs/api/html/home.png | Bin 256 -> 0 bytes docs/api/html/index.html | 474 -- docs/api/html/ix01.html | 1769 ----- docs/api/html/left-insensitive.png | Bin 395 -> 0 bytes docs/api/html/left.png | Bin 262 -> 0 bytes docs/api/html/license.html | 51 - docs/api/html/manpages.html | 79 - docs/api/html/nm-cloud-setup.html | 351 - docs/api/html/nm-dbus-types.html | 5761 ---------------- docs/api/html/nm-initrd-generator.html | 186 - docs/api/html/nm-online.html | 140 - docs/api/html/nm-openvswitch.html | 177 - docs/api/html/nm-settings-dbus.html | 5213 -------------- docs/api/html/nm-settings-ifcfg-rh.html | 2743 -------- docs/api/html/nm-settings-keyfile.html | 629 -- docs/api/html/nm-settings-nmcli.html | 7123 -------------------- docs/api/html/nm-vpn-dbus-types.html | 560 -- docs/api/html/nmcli-examples.html | 710 -- docs/api/html/nmcli.html | 1914 ------ docs/api/html/nmtui.html | 88 - docs/api/html/ref-dbus-access-points.html | 32 - docs/api/html/ref-dbus-active-connections.html | 37 - docs/api/html/ref-dbus-agent-manager.html | 32 - docs/api/html/ref-dbus-checkpoint.html | 32 - docs/api/html/ref-dbus-devices.html | 130 - docs/api/html/ref-dbus-dhcp4-configs.html | 32 - docs/api/html/ref-dbus-dhcp6-configs.html | 32 - docs/api/html/ref-dbus-dns-manager.html | 32 - docs/api/html/ref-dbus-ip4-configs.html | 32 - docs/api/html/ref-dbus-ip6-configs.html | 32 - docs/api/html/ref-dbus-manager.html | 32 - docs/api/html/ref-dbus-settings-manager.html | 32 - docs/api/html/ref-dbus-settings.html | 32 - docs/api/html/ref-dbus-wifi-p2p-peers.html | 32 - docs/api/html/ref-settings.html | 213 - docs/api/html/right-insensitive.png | Bin 373 -> 0 bytes docs/api/html/right.png | Bin 261 -> 0 bytes docs/api/html/secret-agents.html | 38 - docs/api/html/secrets-flags.html | 63 - docs/api/html/settings-6lowpan.html | 69 - docs/api/html/settings-802-11-olpc-mesh.html | 85 - .../html/settings-802-11-wireless-security.html | 191 - docs/api/html/settings-802-11-wireless.html | 227 - docs/api/html/settings-802-1x.html | 375 -- docs/api/html/settings-802-3-ethernet.html | 177 - docs/api/html/settings-adsl.html | 107 - docs/api/html/settings-bluetooth.html | 77 - docs/api/html/settings-bond-port.html | 77 - docs/api/html/settings-bond.html | 77 - docs/api/html/settings-bridge-port.html | 95 - docs/api/html/settings-bridge.html | 247 - docs/api/html/settings-cdma.html | 95 - docs/api/html/settings-connection.html | 331 - docs/api/html/settings-dcb.html | 157 - docs/api/html/settings-dummy.html | 64 - docs/api/html/settings-ethtool.html | 64 - docs/api/html/settings-generic.html | 73 - docs/api/html/settings-gsm.html | 163 - docs/api/html/settings-hostname.html | 101 - docs/api/html/settings-hsr.html | 89 - docs/api/html/settings-infiniband.html | 99 - docs/api/html/settings-ip-tunnel.html | 149 - docs/api/html/settings-ipv4.html | 359 - docs/api/html/settings-ipv6.html | 407 -- docs/api/html/settings-link.html | 89 - docs/api/html/settings-loopback.html | 69 - docs/api/html/settings-macsec.html | 131 - docs/api/html/settings-macvlan.html | 89 - docs/api/html/settings-match.html | 103 - docs/api/html/settings-ovs-bridge.html | 95 - docs/api/html/settings-ovs-dpdk.html | 89 - docs/api/html/settings-ovs-external-ids.html | 69 - docs/api/html/settings-ovs-interface.html | 77 - docs/api/html/settings-ovs-other-config.html | 69 - docs/api/html/settings-ovs-patch.html | 69 - docs/api/html/settings-ovs-port.html | 109 - docs/api/html/settings-ppp.html | 173 - docs/api/html/settings-pppoe.html | 95 - docs/api/html/settings-proxy.html | 89 - docs/api/html/settings-serial.html | 95 - docs/api/html/settings-sriov.html | 137 - docs/api/html/settings-tc.html | 85 - docs/api/html/settings-team-port.html | 107 - docs/api/html/settings-team.html | 167 - docs/api/html/settings-tun.html | 101 - docs/api/html/settings-user.html | 69 - docs/api/html/settings-veth.html | 69 - docs/api/html/settings-vlan.html | 111 - docs/api/html/settings-vpn.html | 101 - docs/api/html/settings-vrf.html | 69 - docs/api/html/settings-vxlan.html | 161 - docs/api/html/settings-wifi-p2p.html | 87 - docs/api/html/settings-wimax.html | 77 - docs/api/html/settings-wireguard.html | 129 - docs/api/html/settings-wpan.html | 95 - docs/api/html/spec.html | 201 - docs/api/html/style.css | 531 -- docs/api/html/up-insensitive.png | Bin 374 -> 0 bytes docs/api/html/up.png | Bin 260 -> 0 bytes docs/api/html/vpn-plugins.html | 42 - 159 files changed, 49495 deletions(-) delete mode 100644 docs/api/html/NetworkManager-dispatcher.html delete mode 100644 docs/api/html/NetworkManager-wait-online.service.html delete mode 100644 docs/api/html/NetworkManager.conf.html delete mode 100644 docs/api/html/NetworkManager.devhelp2 delete mode 100644 docs/api/html/NetworkManager.html delete mode 100644 docs/api/html/ch01.html delete mode 100644 docs/api/html/dbus-secret-agent.html delete mode 100644 docs/api/html/dbus-types.html delete mode 100644 docs/api/html/dbus-vpn-plugin.html delete mode 100644 docs/api/html/dbus-vpn-types.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Hsr.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Loopback.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html delete mode 100644 docs/api/html/gdbus-org.freedesktop.NetworkManager.html delete mode 100644 docs/api/html/home.png delete mode 100644 docs/api/html/index.html delete mode 100644 docs/api/html/ix01.html delete mode 100644 docs/api/html/left-insensitive.png delete mode 100644 docs/api/html/left.png delete mode 100644 docs/api/html/license.html delete mode 100644 docs/api/html/manpages.html delete mode 100644 docs/api/html/nm-cloud-setup.html delete mode 100644 docs/api/html/nm-dbus-types.html delete mode 100644 docs/api/html/nm-initrd-generator.html delete mode 100644 docs/api/html/nm-online.html delete mode 100644 docs/api/html/nm-openvswitch.html delete mode 100644 docs/api/html/nm-settings-dbus.html delete mode 100644 docs/api/html/nm-settings-ifcfg-rh.html delete mode 100644 docs/api/html/nm-settings-keyfile.html delete mode 100644 docs/api/html/nm-settings-nmcli.html delete mode 100644 docs/api/html/nm-vpn-dbus-types.html delete mode 100644 docs/api/html/nmcli-examples.html delete mode 100644 docs/api/html/nmcli.html delete mode 100644 docs/api/html/nmtui.html delete mode 100644 docs/api/html/ref-dbus-access-points.html delete mode 100644 docs/api/html/ref-dbus-active-connections.html delete mode 100644 docs/api/html/ref-dbus-agent-manager.html delete mode 100644 docs/api/html/ref-dbus-checkpoint.html delete mode 100644 docs/api/html/ref-dbus-devices.html delete mode 100644 docs/api/html/ref-dbus-dhcp4-configs.html delete mode 100644 docs/api/html/ref-dbus-dhcp6-configs.html delete mode 100644 docs/api/html/ref-dbus-dns-manager.html delete mode 100644 docs/api/html/ref-dbus-ip4-configs.html delete mode 100644 docs/api/html/ref-dbus-ip6-configs.html delete mode 100644 docs/api/html/ref-dbus-manager.html delete mode 100644 docs/api/html/ref-dbus-settings-manager.html delete mode 100644 docs/api/html/ref-dbus-settings.html delete mode 100644 docs/api/html/ref-dbus-wifi-p2p-peers.html delete mode 100644 docs/api/html/ref-settings.html delete mode 100644 docs/api/html/right-insensitive.png delete mode 100644 docs/api/html/right.png delete mode 100644 docs/api/html/secret-agents.html delete mode 100644 docs/api/html/secrets-flags.html delete mode 100644 docs/api/html/settings-6lowpan.html delete mode 100644 docs/api/html/settings-802-11-olpc-mesh.html delete mode 100644 docs/api/html/settings-802-11-wireless-security.html delete mode 100644 docs/api/html/settings-802-11-wireless.html delete mode 100644 docs/api/html/settings-802-1x.html delete mode 100644 docs/api/html/settings-802-3-ethernet.html delete mode 100644 docs/api/html/settings-adsl.html delete mode 100644 docs/api/html/settings-bluetooth.html delete mode 100644 docs/api/html/settings-bond-port.html delete mode 100644 docs/api/html/settings-bond.html delete mode 100644 docs/api/html/settings-bridge-port.html delete mode 100644 docs/api/html/settings-bridge.html delete mode 100644 docs/api/html/settings-cdma.html delete mode 100644 docs/api/html/settings-connection.html delete mode 100644 docs/api/html/settings-dcb.html delete mode 100644 docs/api/html/settings-dummy.html delete mode 100644 docs/api/html/settings-ethtool.html delete mode 100644 docs/api/html/settings-generic.html delete mode 100644 docs/api/html/settings-gsm.html delete mode 100644 docs/api/html/settings-hostname.html delete mode 100644 docs/api/html/settings-hsr.html delete mode 100644 docs/api/html/settings-infiniband.html delete mode 100644 docs/api/html/settings-ip-tunnel.html delete mode 100644 docs/api/html/settings-ipv4.html delete mode 100644 docs/api/html/settings-ipv6.html delete mode 100644 docs/api/html/settings-link.html delete mode 100644 docs/api/html/settings-loopback.html delete mode 100644 docs/api/html/settings-macsec.html delete mode 100644 docs/api/html/settings-macvlan.html delete mode 100644 docs/api/html/settings-match.html delete mode 100644 docs/api/html/settings-ovs-bridge.html delete mode 100644 docs/api/html/settings-ovs-dpdk.html delete mode 100644 docs/api/html/settings-ovs-external-ids.html delete mode 100644 docs/api/html/settings-ovs-interface.html delete mode 100644 docs/api/html/settings-ovs-other-config.html delete mode 100644 docs/api/html/settings-ovs-patch.html delete mode 100644 docs/api/html/settings-ovs-port.html delete mode 100644 docs/api/html/settings-ppp.html delete mode 100644 docs/api/html/settings-pppoe.html delete mode 100644 docs/api/html/settings-proxy.html delete mode 100644 docs/api/html/settings-serial.html delete mode 100644 docs/api/html/settings-sriov.html delete mode 100644 docs/api/html/settings-tc.html delete mode 100644 docs/api/html/settings-team-port.html delete mode 100644 docs/api/html/settings-team.html delete mode 100644 docs/api/html/settings-tun.html delete mode 100644 docs/api/html/settings-user.html delete mode 100644 docs/api/html/settings-veth.html delete mode 100644 docs/api/html/settings-vlan.html delete mode 100644 docs/api/html/settings-vpn.html delete mode 100644 docs/api/html/settings-vrf.html delete mode 100644 docs/api/html/settings-vxlan.html delete mode 100644 docs/api/html/settings-wifi-p2p.html delete mode 100644 docs/api/html/settings-wimax.html delete mode 100644 docs/api/html/settings-wireguard.html delete mode 100644 docs/api/html/settings-wpan.html delete mode 100644 docs/api/html/spec.html delete mode 100644 docs/api/html/style.css delete mode 100644 docs/api/html/up-insensitive.png delete mode 100644 docs/api/html/up.png delete mode 100644 docs/api/html/vpn-plugins.html (limited to 'docs/api/html') diff --git a/docs/api/html/NetworkManager-dispatcher.html b/docs/api/html/NetworkManager-dispatcher.html deleted file mode 100644 index 47286d32..00000000 --- a/docs/api/html/NetworkManager-dispatcher.html +++ /dev/null @@ -1,430 +0,0 @@ - - - - -NetworkManager-dispatcher: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NetworkManager-dispatcher

-

NetworkManager-dispatcher — Dispatch user scripts for NetworkManager

-
-
-

Synopsis

-

NetworkManager [OPTIONS...]

-
-
-

Description

-

- NetworkManager-dispatcher service is a D-Bus activated service that - runs user provided scripts upon certain changes in NetworkManager. -

-

- NetworkManager-dispatcher will execute scripts in the - /{etc,usr/lib}/NetworkManager/dispatcher.d - directory or subdirectories in - alphabetical order in response to network events. Each script should - be a regular executable file owned by root. Furthermore, it must not be - writable by group or other, and not setuid. -

-

- Each script receives two arguments, the first being the interface name of the - device an operation just happened on, and second the action. For device actions, - the interface is the name of the kernel interface suitable for IP configuration. - Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable. - For the hostname action the device name is always - "none". For connectivity-change and - dns-change it is empty. -

-

The actions are:

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

pre-up

The interface is connected to the network but is not - yet fully activated. Scripts acting on this event must be placed or - symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d - directory, and NetworkManager will wait for script execution to complete before - indicating to applications that the interface is fully activated. -

up

The interface has been activated.

pre-down

The interface will be deactivated but has not yet been - disconnected from the network. Scripts acting on this event must be - placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d - directory, and NetworkManager will wait for script execution to complete - before disconnecting the interface from its network. Note that this - event is not emitted for forced disconnections, like when carrier is - lost or a wireless signal fades. It is only emitted when there is - an opportunity to cleanly handle a network disconnection event. -

down

- The interface has been deactivated. -

vpn-pre-up

The VPN is connected to the network but is not yet - fully activated. Scripts acting on this event must be placed or - symlinked into the /etc/NetworkManager/dispatcher.d/pre-up.d - directory, and NetworkManager will wait for script execution to complete before - indicating to applications that the VPN is fully activated. -

vpn-up

- A VPN connection has been activated. -

vpn-pre-down

The VPN will be deactivated but has not yet been - disconnected from the network. Scripts acting on this event must be - placed or symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d - directory, and NetworkManager will wait for script execution to complete - before disconnecting the VPN from its network. Note that this - event is not emitted for forced disconnections, like when the VPN - terminates unexpectedly or general connectivity is lost. It is only - emitted when there is an opportunity to cleanly handle a VPN - disconnection event. -

vpn-down

- A VPN connection has been deactivated. -

hostname

- The system hostname has been updated. Use gethostname(2) to retrieve it. - The interface name (first argument) is empty and no environment variable is - set for this action. -

dhcp4-change

- The DHCPv4 lease has changed (renewed, rebound, etc). -

dhcp6-change

- The DHCPv6 lease has changed (renewed, rebound, etc). -

connectivity-change

- The network connectivity state has changed (no connectivity, went online, etc). -

reapply

- The connection was reapplied on the device. -

dns-change

- The DNS configuration has changed. This action is raised even if - NetworkManager is configured to not manage resolv.conf (for example, - via dns=none). In such case, the dispatch script can discover the - DNS configuration provided by currently active connections by - looking at file /run/NetworkManager/resolv.conf -

device-add

 -

- This action is called when a connection of type generic - has the generic.device-handler property set. The property - indicates the name of a dispatcher script to be executed in directory - /{etc,usr/lib}/NetworkManager/dispatcher.d/device. Note - that differently from other actions, only one script is executed. -

-

- The script needs to perform any action needed to create the device - for the generic connection. On successful termination, the script - returns zero. Otherwise, it returns a non-zero value to indicate an - error. The script can return values to NetworkManager by writing to - standard output; each line should contain a key name followed by the - equal sign '=' and a key value. The keys understood at the moment - are: -

-
---- - - - - - - - - - - -

IFINDEX

Indicates the interface index of the interface - created by the script. This key is required when the script - succeeds; if it is not set, the activation will fail. The key is - ignored in case of script failure.

ERROR

Specifies an error message indicating the cause - of the script failure. It is ignored when the script succeeds. -

-

- Since the dispatcher service captures stdout for parsing those keys, - anything written to stdout will not appear in the dispatcher service - journal log. Use stderr if you want to print messages to the journal - (for example, for debugging). Only the first 8KiB of stdout are - considered and among those, only the first 64 lines; the rest is - ignored. -

-

device-delete

- This action is the counterpart of device-add and - is called to delete the device for a generic connection. All the - aspects described for device-add also apply to - this action, with the only exception that key - IFINDEX is ignored. It is not necessary to delete - the kernel link in the handler because NetworkManager already does - that; therefore the action is useful for any additional cleanup - needed. -

-

- The environment contains more information about the interface and the connection. - The following variables are available for the use in the dispatcher scripts: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

NM_DISPATCHER_ACTION

- The dispatcher action like "up" or "dhcp4-change", identical to the first - command line argument. Since NetworkManager 1.12.0. -

CONNECTION_UUID

- The UUID of the connection profile. -

CONNECTION_ID

- The name (ID) of the connection profile. -

CONNECTION_DBUS_PATH

- The NetworkManager D-Bus path of the connection. -

CONNECTION_FILENAME

- The backing file name of the connection profile (if any). -

CONNECTION_EXTERNAL

- If "1", this indicates that the connection describes a - network configuration created outside of NetworkManager. -

DEVICE_IFACE

- The interface name of the control interface of the device. - Depending on the device type, this differs from - DEVICE_IP_IFACE. For example for - ADSL devices, this could be 'atm0' or for WWAN devices - it might be 'ttyUSB0'. -

DEVICE_IP_IFACE

- The IP interface name of the device. This is the network - interface on which IP addresses and routes will be configured. -

IP4_ADDRESS_N

- The IPv4 address in the format "address/prefix gateway", where N is a number - from 0 to (# IPv4 addresses - 1). gateway item in this variable is deprecated, - use IP4_GATEWAY instead. -

IP4_NUM_ADDRESSES

- The variable contains the number of IPv4 addresses the script may expect. -

IP4_GATEWAY

- The gateway IPv4 address in traditional numbers-and-dots notation. -

IP4_ROUTE_N

- The IPv4 route in the format "address/prefix next-hop metric", where N is a number - from 0 to (# IPv4 routes - 1). -

IP4_NUM_ROUTES

- The variable contains the number of IPv4 routes the script may expect. -

IP4_NAMESERVERS

- The variable contains a space-separated list of the DNS servers. -

IP4_DOMAINS

- The variable contains a space-separated list of the search domains. -

DHCP4_<dhcp-option-name>

- If the connection used DHCP for address configuration, the received DHCP - configuration is passed in the environment using standard DHCP - option names, prefixed with "DHCP4_", like "DHCP4_HOST_NAME=foobar". -

IP6_<name> and DHCP6_<name>

- The same variables as for IPv4 are available for IPv6, but the prefixes are IP6_ - and DHCP6_ instead. -

CONNECTIVITY_STATE

The network connectivity state, which can - take the values defined by the NMConnectivityState type, - from the org.freedesktop.NetworkManager D-Bus API: UNKNOWN, - NONE, PORTAL, LIMITED - or FULL. Note: this variable will only - be set for connectivity-change actions. -

-

-

-

- In case of VPN, VPN_IP_IFACE is set, and IP4_*, IP6_* variables with VPN prefix are - exported too, like VPN_IP4_ADDRESS_0, VPN_IP4_NUM_ADDRESSES. -

-

- The content of the user setting for the connection - being activated is also passed via environment variables. Each key is - stored in a variable with name CONNECTION_USER_ - concatenated with the encoding of the key name. The encoding works as - follows: -

-
    -

  • lowercase letters become uppercase

    • -

  • uppercase letters are prefixed with an underscore

    • -

  • numbers do not change

    • -

  • a dot is replaced with a double underscore

    • -

  • any other character is encoded with an underscore followed by - its 3-digit octal representation

    • -
-

- For example, key test.foo-Bar2 is stored in a variable named - CONNECTION_USER_TEST__FOO_055_BAR2. -

-

- Dispatcher scripts are run one at a time, but asynchronously from the main - NetworkManager process, and will be killed if they run for too long. If your script - might take arbitrarily long to complete, you should spawn a child process and have the - parent return immediately. Scripts that are symbolic links pointing inside the - /etc/NetworkManager/dispatcher.d/no-wait.d/ - directory are run immediately, without - waiting for the termination of previous scripts, and in parallel. Also beware that - once a script is queued, it will always be run, even if a later event renders it - obsolete. (Eg, if an interface goes up, and then back down again quickly, it is - possible that one or more "up" scripts will be run after the interface has gone down.) -

-
-
-

Bugs

-

- Please report any bugs you find in NetworkManager at the - NetworkManager issue tracker. -

-
-
-

See Also

-

- NetworkManager home page, - NetworkManager(8), -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/NetworkManager-wait-online.service.html b/docs/api/html/NetworkManager-wait-online.service.html deleted file mode 100644 index 7afbace9..00000000 --- a/docs/api/html/NetworkManager-wait-online.service.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - -NetworkManager-wait-online.service: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NetworkManager-wait-online.service

-

NetworkManager-wait-online.service — Wait for the network to come online

-
-
-

Description

-

- The NetworkManager-wait-online service is a oneshot - systemd service that delays reaching the network-online target until - NetworkManager reports that the startup is completed on the D-Bus. -

-

- When the system boots, for example, remote mounts defined in /etc/fstab, - require that the network is up. For this, these systemd units contain the - After=network-online.target setting to order themselves after this - target. NetworkManager-wait-online ensures that the - network-online target is reached only after the network is available. -

-

- Optimally, all services on the host react dynamically to network changes and systemd - services do not need to be configured to start after reaching the - network-online target. In this case, - NetworkManager-wait-online.service has no effect and does not delay - the boot time. On the other hand, if you encounter a long boot time due to the delay - of NetworkManager-wait-online, investigate the services that require - network access and fix them. -

-

- Except for the time out value in the NetworkManager-wait-online.service - unit, you cannot configure this service. Instead, settings in NetworkManager and the - connection profiles affect the behavior: -

-
    -
  • -

    - Startup is not complete as long as NetworkManager profiles are in an activating - state. During boot, NetworkManager starts profiles with the - connection.autoconnect=yes setting. If activation fails, - NetworkManager retries the activation depending on the value of the - connection.autoconnect-retries setting. -

    -

    - NetworkManager reports startup complete when all profiles and devices are either - activated or in a disconnect state and no further events are expected. -

    -
    • -
  • -

    - When a device reaches the activate state depends on its configuration. For example, - with a profile that has both IPv4 and IPv6 enabled, by default, NetworkManager - considers the device as fully activated already when only one of the address - families is ready. -

    -

    - The ipv4.may-fail and ipv6.may-fail settings - control this behavior. Additionally, the following settings influence when the - two address families complete: ipv4.required-timeout, - ipv6.required-timeout, ipv4.dhcp-timeout, - and ipv6.ra-timeout. For details, see - nm-settings-nmcli(5). -

    -
    • -

  • - NetworkManager cannot set IP addresses on bridge and bond devices that have ports - that do not auto-activate. Because of this configuration error, - NetworkManager-wait-online blocks until the service reaches - its timeout value. -

    • -

  • - Dispatcher scripts for the pre-up event run at a late stage - during activation of a profile. These scripts block the activation for when - NetworkManager considers the profile fully activated. For details, see - NetworkManager-dispatcher(8). -

    • -

  • - The property connection.wait-activation-delay adds an additional - delay during activation and delays startup complete. This setting works around - certain cases where a device is known to not be ready for a certain amount of time. -

    • -

  • - The property connection.wait-device-timeout in the connection - profiles cause a delay until the waiting devices appear. This is useful if the - driver takes a longer time to detect the networking interfaces. This setting is - similar to the connection.gateway-ping-timeout property. -

    • -

  • - With Wi-Fi devices, NetworkManager needs to wait for the first scan result to - know which networks are available. That adds a delay. -

    • -

  • - With Ethernet devices, NetworkManager waits for the carrier until the value in - [device*].carrier-wait-timeout is reached. This is because some - devices take a long time to detect the carrier. Consequently, booting with cable - unplugged, unnecessarily delays NetworkManager-wait-online.service. -

    • -
-
-
-

Bugs

-

- Please report any bugs in NetworkManager at the - NetworkManager issue tracker. -

-
-
-

See Also

-

- NetworkManager home page, - NetworkManager(8), - nm-online(1), - the network-online.target description in systemd.special(7) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html deleted file mode 100644 index 174f6ecc..00000000 --- a/docs/api/html/NetworkManager.conf.html +++ /dev/null @@ -1,1947 +0,0 @@ - - - - -NetworkManager.conf: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NetworkManager.conf

-

NetworkManager.conf — NetworkManager configuration file

-
-
-

Synopsis

-

/etc/NetworkManager/NetworkManager.conf, - /etc/NetworkManager/conf.d/name.conf, - /run/NetworkManager/conf.d/name.conf, - /usr/lib/NetworkManager/conf.d/name.conf, - /var/lib/NetworkManager/NetworkManager-intern.conf -

-
-
-

Description

-

NetworkManager.conf is the configuration file for NetworkManager. It is used - to set up various aspects of NetworkManager's behavior. The - location of the main file and configuration directories may be changed - through use of the --config, --config-dir, - --system-config-dir, and --intern-config - argument for NetworkManager, respectively. -

-

If a default NetworkManager.conf is - provided by your distribution's packages, you should not modify - it, since your changes may get overwritten by package - updates. Instead, you can add additional .conf - files to the /etc/NetworkManager/conf.d directory. - These will be read in order, with later files overriding earlier ones. - Packages might install further configuration snippets to /usr/lib/NetworkManager/conf.d. - This directory is parsed first, even before NetworkManager.conf. - Scripts can also put per-boot configuration into /run/NetworkManager/conf.d. - This directory is parsed second, also before NetworkManager.conf. - The loading of a file /run/NetworkManager/conf.d/name.conf - can be prevented by adding a file /etc/NetworkManager/conf.d/name.conf. - Likewise, a file /usr/lib/NetworkManager/conf.d/name.conf - can be shadowed by putting a file of the same name to either /etc/NetworkManager/conf.d - or /run/NetworkManager/conf.d. -

-

- NetworkManager can overwrite certain user configuration options via D-Bus or other internal - operations. In this case it writes those changes to /var/lib/NetworkManager/NetworkManager-intern.conf. - This file is not intended to be modified by the user, but it is read last and can shadow - user configuration from NetworkManager.conf. -

-

- Certain settings from the configuration can be reloaded at runtime either by sending SIGHUP signal or via - D-Bus' Reload call. -

-

- NetworkManager does not require any configuration in NetworkManager.conf. Depending - on your use case, you may remove all files to restore the default configuration (factory reset). But - note that your distribution or other packages may drop configuration snippets for NetworkManager, such - that they are part of the factory default. -

-
-
-

File Format

-

- The configuration file format is so-called key file (sort of - ini-style format). It consists of sections (groups) of - key-value pairs. Lines beginning with a '#' and blank lines are - considered comments. Sections are started by a header line - containing the section enclosed in '[' and ']', and ended - implicitly by the start of the next section or the end of the - file. Each key-value pair must be contained in a section. -

-

- For keys that take a list of devices as their value, you can - specify devices by their MAC addresses or interface names, or - "*" to specify all devices. See the section called “Device List Format” - below. -

-

- A simple configuration file looks like this: -

-
-[main]
-plugins=keyfile
-
-

-

-

- As an extension to the normal keyfile format, you can also - append a value to a previously-set list-valued key by doing: -

-
-plugins+=another-plugin
-plugins-=remove-me
-
-

-

-
-
-

-main section

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

plugins

 -

- Lists system settings plugin names separated by ','. These - plugins are used to read and write system-wide - connection profiles. When multiple plugins are specified, the - connections are read from all listed plugins. When writing - connections, the plugins will be asked to save the - connection in the order listed here; if the first plugin - cannot write out that connection type (or can't write out - any connections) the next plugin is tried, etc. If none of - the plugins can save the connection, an error is returned - to the user. -

-

- The default value and the number of available plugins is - distro-specific. See the section called “Plugins” - below for the available plugins. - Note that NetworkManager's native keyfile - plugin is always appended to the end of this list (if it doesn't - already appear earlier in the list). -

-

monitor-connection-files

This setting is deprecated and has no effect. Profiles - from disk are never automatically reloaded. Use for example nmcli connection (re)load - for that.

auth-polkit

Whether the system uses PolicyKit for authorization. - If true, non-root requests are authorized using PolicyKit. - Requests from root (user ID zero) are always granted without asking PolicyKit. - If false, all requests will be allowed and PolicyKit is - not used. If set to root-only PolicyKit is not used and - all requests except root are denied. - The default value is true. -

dhcp

 -

This key sets up what DHCP client - NetworkManager will use. Allowed values depend on build configuration and - typically include internal and dhcpcd. - Support for unmaintained dhclient client has been deprecated - and disabled by default.

-

The internal client is built-in, while other options - may require an external DHCP client to be installed.

-

If this key is missing, internal - is used with a fallback to other suppored clients in this order: - internal, dhcpcd, - dhclient.

-

no-auto-default

 -

Specify devices for which - NetworkManager shouldn't create default wired connection - (Auto eth0). By default, NetworkManager creates a temporary - wired connection for any Ethernet device that is managed and - doesn't have a connection configured. List a device in this - option to inhibit creating the default connection for the - device. May have the special value * to - apply to all devices.

-

When the default wired connection is deleted or saved - to a new persistent connection by a plugin, the device is - added to a list in the file - /var/lib/NetworkManager/no-auto-default.state - to prevent creating the default connection for that device - again.

-

See the section called “Device List Format” for the syntax how to - specify a device. -

-

- Example: -

-
-no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee
-no-auto-default=eth0,eth1
-no-auto-default=*
-
-

-

-

ignore-carrier

- This setting is deprecated for the per-device setting - ignore-carrier which overwrites this setting - if specified (See ignore-carrier). - Otherwise, it is a list of matches to specify for which device - carrier should be ignored. See the section called “Device List Format” for the - syntax how to specify a device. Note that controller types like - bond, bridge, and team ignore carrier by default. You can however - revert that default using the "except:" specifier (or better, - use the per-device setting instead of the deprecated setting). -

assume-ipv6ll-only

 -

- Specify devices for which NetworkManager will try to - generate a connection based on initial configuration when - the device only has an IPv6 link-local address. -

-

See the section called “Device List Format” for the syntax how to - specify a device. -

-

configure-and-quit

 -

- This option is no longer useful to configure in NetworkManager.conf file. - It can however also be configured on the command line with the same - values, where it has some use. -

-

- When set to 'initrd', NetworkManager does not connect - to D-Bus and quits after configuring the network. This is an implementation - detail how the NetworkManager module of dracut can run NetworkManager. - An alternative to this is having NetworkManager as a systemd service - with D-Bus in initrd. -

-

- The value 'true' is unsupported since version 1.36. - Previously this was a mode where NetworkManager would quit after configuring - the network and run helper processes for DHCP and SLAAC. -

-

- Otherwise, NetworkManager runs a system service with D-Bus and does not - quit during normal operation. -

-

hostname-mode

 -

- Set the management mode of the hostname. This parameter will - affect only the transient hostname. If a valid static hostname is set, - NetworkManager will skip the update of the hostname despite the value of - this option. An hostname empty or equal to 'localhost', 'localhost6', - 'localhost.localdomain' or 'localhost6.localdomain' is considered invalid. -

-

default: NetworkManager will update the - hostname with the one provided via DHCP or reverse DNS lookup of the - IP address on the connection with the default route or on any - connection with the property hostname.only-from-default set to - 'false'. Connections are considered in order of - increasing value of the hostname.priority - property. In case multiple connections have the same priority, - connections activated earlier are considered first. If no hostname can - be determined in such way, the hostname will be updated to the last - one set outside NetworkManager or to 'localhost.localdomain'. -

-

dhcp: this is similar to - 'default', with the difference that after trying to - get the DHCP hostname, reverse DNS lookup is not done. Note that - selecting this option is equivalent to setting the property - 'hostname.from-dns-lookup' to - 'false' globally for all connections in - NetworkManager.conf. -

-

none: NetworkManager will not manage the transient - hostname and will never set it. -

-

dns

 -

Set the DNS processing mode.

-

If the key is unspecified, default is used, - unless /etc/resolv.conf is a symlink to - /run/systemd/resolve/stub-resolv.conf, - /run/systemd/resolve/resolv.conf, - /lib/systemd/resolv.conf or - /usr/lib/systemd/resolv.conf. - In that case, systemd-resolved is chosen automatically. -

-

default: NetworkManager will update - /etc/resolv.conf to reflect the nameservers - provided by currently active connections. The rc-manager - setting (below) controls how this is done.

-

dnsmasq: NetworkManager will run - dnsmasq as a local caching nameserver, using "Conditional Forwarding" - if you are connected to a VPN, and then update - resolv.conf to point to the local - nameserver. It is possible to pass custom options to the - dnsmasq instance by adding them to files in the - "/etc/NetworkManager/dnsmasq.d/" - directory. Note that when multiple upstream servers are - available, dnsmasq will initially contact them in parallel and - then use the fastest to respond, probing again other servers - after some time. This behavior can be modified passing the - 'all-servers' or 'strict-order' options to dnsmasq (see the - manual page for more details).

-

systemd-resolved: NetworkManager will - push the DNS configuration to systemd-resolved

-

none: NetworkManager will not - modify resolv.conf. This implies - rc-manager unmanaged

-

Note that the plugins dnsmasq and systemd-resolved - are caching local nameservers. - Hence, when NetworkManager writes /run/NetworkManager/resolv.conf - and /etc/resolv.conf (according to rc-manager - setting below), the name server there will be localhost only. - NetworkManager also writes a file /run/NetworkManager/no-stub-resolv.conf - that contains the original name servers pushed to the DNS plugin.

-

When using dnsmasq and systemd-resolved, - per-connection added dns servers will always be queried using - the device the connection has been activated on.

-

rc-manager

 -

Set the resolv.conf - management mode. This option is about how NetworkManager writes to - /etc/resolv.conf, if at all. - The default value depends on NetworkManager build - options, and this version of NetworkManager was build with a default of - "auto". - Regardless of this setting, NetworkManager will - always write its version of resolv.conf to its runtime state directory - as /run/NetworkManager/resolv.conf. -

-

If you configure dns=none or make /etc/resolv.conf - immutable with chattr +i, NetworkManager will ignore this setting and - always choose unmanaged (below). -

-

auto: if systemd-resolved plugin is configured via - the dns setting or if it gets detected as main DNS plugin, - NetworkManager will update systemd-resolved without touching /etc/resolv.conf. - Alternatively, if resolvconf or netconfig are enabled - at compile time and the respective binary is found, NetworkManager will automatically use it. - Note that if you install or uninstall these binaries, you need to reload the - rc-manager setting with SIGHUP or - systemctl reload NetworkManager. As last fallback - it uses the symlink option (see next). -

-

symlink: If /etc/resolv.conf is - a regular file or does not exist, NetworkManager will write the file directly. - If /etc/resolv.conf is instead a symlink, NetworkManager - will leave it alone. Unless the symlink points to the internal file - /run/NetworkManager/resolv.conf, - in which case the symlink will be updated to emit an inotify notification. - This allows the user to conveniently instruct NetworkManager not - to manage /etc/resolv.conf by replacing it with - a symlink. -

-

file: NetworkManager will write - /etc/resolv.conf as regular file. If it finds - a symlink to an existing target, it will follow the symlink and - update the target instead. In no case will an existing symlink - be replaced by a file. Note that older versions of NetworkManager - behaved differently and would replace dangling symlinks with a - plain file. -

-

resolvconf: NetworkManager will run - resolvconf to update the DNS configuration.

-

netconfig: NetworkManager will run - netconfig to update the DNS configuration.

-

unmanaged: don't touch - /etc/resolv.conf.

-

none: deprecated alias for - symlink.

-

systemd-resolved

 -

Additionally, send the connection DNS configuration to - systemd-resolved. Defaults to "true". -

-

Note that this setting has no effect if the main dns - plugin is already systemd-resolved. It is complementary to the - dns setting to configure systemd-resolved alongside the - main plugin.

-

If systemd-resolved is enabled, either via this setting or the main - DNS plugin, the connectivity check resolves the - hostname per-device.

-

debug

 -

Comma separated list of options to aid - debugging. This value will be combined with the environment - variable NM_DEBUG. Currently, the following - values are supported:

-

- RLIMIT_CORE: set ulimit -c unlimited - to write out core dumps. Beware, that a core dump can contain - sensitive information such as passwords or configuration settings. -

-

- fatal-warnings: set g_log_set_always_fatal() - to core dump on warning messages from glib. This is equivalent - to the --g-fatal-warnings command line option. -

-

autoconnect-retries-default

- The number of times a connection activation should be - automatically tried before switching to another one. This - value applies only to connections that can auto-connect - and have a - connection.autoconnect-retries property - set to -1. If not specified, connections will be tried 4 - times. Setting this value to 1 means to try activation once, - without retry. -

firewall-backend

- The firewall backend for configuring masquerading - with shared mode. - Set to either iptables, nftables - or none. - iptables and nftables - require iptables and nft - application, respectively. - none means to skip firewall configuration if - the users wish to manage firewall themselves. - If unspecified, it will be auto detected. -

iwd-config-path

 -

- If the value is "auto" (the default), IWD is queried for its - current state directory when it appears on D-Bus -- the - directory where IWD keeps its network configuration files -- - usually /var/lib/iwd. NetworkManager will then attempt to - write copies of new or modified Wi-Fi connection profiles, - converted into the IWD format, into this directory thus making - IWD connection properties editable. NM will overwrite existing - files without preserving their contents. -

-

- The path can also be overridden by pointing to a specific - existing and writable directory. On the other hand setting - this to an empty string or any other value disables the - profile conversion mechanism. -

-

- This mechanism allows editing connection profile settings such - as the 802.1x configuration using NetworkManager clients. - Without it such changes have no effect in IWD. -

-

migrate-ifcfg-rh

Whether NetworkManager tries to automatically convert - any connection profile stored in ifcfg-rh format to the keyfile format. - Support for ifcfg-rh is deprecated and will be eventually removed. If - enabled, the migration is performed at every startup of the daemon. - The default value is false. -

-
-
-

-keyfile section

-

This section contains keyfile-plugin-specific options, and - is normally only used when you are not using any other - distro-specific plugin.

-

-

-
---- - - - - - - - - - - - - - - - - - - -

hostname

This key is deprecated and has no effect - since the hostname is now stored in /etc/hostname - or other system configuration files according to build options. -

path

The location where keyfiles are read and stored. - This defaults to "/etc/NetworkManager/system-connections". -

rename

- NetworkManager automatically chooses a filename when storing - a new profile to disk. That name depends on the profile's name - (connection.id). When updating a profile's name, the file is - not renamed to not break scripts that rely on the filename - for the profile. - By setting this option to "true", NetworkManager renames - the keyfile on update of the profile, to follow the profile's - name. This defaults to "false". -

unmanaged-devices

 -

Set devices that should be ignored by NetworkManager. -

-

- A device unmanaged due to this option is strictly - unmanaged and cannot be overruled by using the API like - nmcli device set $IFNAME managed yes. - Also, a device that is unmanaged for other reasons, like - an udev rule, cannot be made managed with this option (e.g. by - using an except: specifier). - These two points make it different from the device*.managed - option which for that reason may be a better choice. -

-

See the section called “Device List Format” for the syntax on how to - specify a device. -

-

- Example: -

-
-unmanaged-devices=interface-name:em4
-unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
-
-

-

-
-

-

-
-
-

-ifupdown section

-

This section contains ifupdown-specific options and thus only - has effect when using the ifupdown plugin.

-

-

-
---- - - - - -

managed

 -

If set to true, then - interfaces listed in - /etc/network/interfaces are managed by - NetworkManager. If set to false, then - any interface listed in - /etc/network/interfaces will be ignored - by NetworkManager. Remember that NetworkManager controls the - default route, so because the interface is ignored, - NetworkManager may assign the default route to some other - interface.

-

- The default value is false. -

-
-

-

-
-
-

-logging section

-

- This section controls NetworkManager's logging. - Logging is very important to understand what NetworkManager is doing. - When you report a bug, do not unnecessarily filter or limit the log file. - Just enable level=TRACE and domains=ALL - to collect everything. -

-

- The recommended way for enabling logging is with a file /etc/NetworkManager/conf.d/95-logging.conf - that contains -

-
-[logging]
-level=TRACE
-domains=ALL
-
-

- and restart the daemon with systemctl restart NetworkManager. Then - reproduce the problem. You can find the logs in syslog (for example - journalctl, or journalctl -u NetworkManager - to show only logs from NetworkManager). -

-

- Any settings here are overridden by the --log-level - and --log-domains command-line options. - Logging can also be reconfigured at runtime with - nmcli general logging level "$LEVEL" domains "$DOMAINS". - However, often it is interesting to get a complete log from the - start. Especially, when debugging an issue, enable debug logging - in NetworkManager.conf and restart the service to enable verbose logging - early on. -

-

- By setting nm.debug on the kernel command line (either from - /run/NetworkManager/proc-cmdline or /proc/cmdline), - debug logging is enabled. This overrides both the command-line options and the settings - from NetworkManager.conf. -

-

- NetworkManager's logging aims not to contain private sensitive data - and you should be fine sharing the debug logs. Still, there will - be IP addresses and your network setup, if you consider that private - then review the log before sharing. However, try not to mangle the logfile - in a way that distorts the meaning too much. -

-

- NetworkManager uses syslog or systemd-journald, depending on configuration. - In any case, debug logs are verbose and might be rate limited - or filtered by the logging daemon. For systemd-journald, see - RateLimitIntervalSec and RateLimitBurst - in journald.conf manual for how to disable that. -

-

-

-
---- - - - - - - - - - - - - - - - - - - - - - - -

level

 -

The default logging verbosity level. - One of OFF, ERR, - WARN, INFO, - DEBUG, TRACE, - in order of verbosity. -

-

- OFF disables all logging. INFO - is the default verbosity for regular operation. TRACE - is for debugging. -

-

- The other levels are in most cases not useful. For example, DEBUG - is between TRACE and INFO, but it's too - verbose for regular operation and lacks possibly interesting messages for debugging. - Almost always, when debugging an issue or reporting a bug, collect full - level TRACE logs to get the full picture. -

-

domains

 -

Filter the messages by their topic. When debugging - an issue, it's better to collect all logs (ALL domain) - upfront. The unnecessary parts can always be ignored - later. -

-

In the uncommon case to tune out certain topics, the following log - domains are available: - PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, - WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, - AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, - INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, - TEAM, CONCHECK, DCB, DISPATCH, AUDIT, SYSTEMD, VPN_PLUGIN, - PROXY.

-

In addition, these special domains can be used: NONE, - ALL, DEFAULT, DHCP, IP.

-

You can specify per-domain log level overrides by - adding a colon and a log level to any domain. E.g., - "WIFI:DEBUG,WIFI_SCAN:OFF". - Another example is ALL,VPN_PLUGIN:TRACE - to enable all the logging there is (see about VPN_PLUGIN - below). -

-

backend

The logging backend. Supported values - are "syslog" and "journal". - When NetworkManager is started with "--debug" - in addition all messages will be printed to stderr. - If unspecified, the default is "syslog". -

audit

Whether the audit records are delivered to - auditd, the audit daemon. If false, audit - records will be sent only to the NetworkManager logging - system. If set to true, they will be also - sent to auditd. The default value is false. -

-

-

-
-
-

-connection section

-

Specify default values for connections. -

-

- Such default values are only consulted if the corresponding per-connection property - explicitly allows for that. That means, all these properties correspond to - a property of the connection profile (for example connection.mud-url). - Only if the per-profile property is set to a special value that indicates to use the - default, the default value from NetworkManager.conf is consulted. It depends on the - property, which is the special value that indicates fallback to the default, but it - usually is something like empty, unset values or special numeric values like 0 or -1. - That means the effectively used value can first always be configured for each profile, - and these default values only matter if the per-profile values explicitly indicates - to use the default from NetworkManager.conf. -

-

- Note that while nmcli supports various aliases and convenience features for configuring - properties, the settings in this section do not. For example, enum values usually only - can be configured via their numeric magic number. -

-

- Example: -

-
-[connection]
-ipv6.ip6-privacy=0
-
-

-

-
-

Supported Properties

-

- Not all properties can be overwritten, only the following - properties are supported to have their default values configured - (see nm-settings-nmcli(5) for details). -

-

- - -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

802-1x.auth-timeout

cdma.mtu

connection.auth-retries

If left unspecified, the default value is 3 tries before failing the connection. -

connection.autoconnect-ports

connection.autoconnect-slaves

This is deprecated, please use "connection.autoconnect-ports" instead. -

connection.down-on-poweroff

Whether the connection will be brought down before the system is powered off.

connection.mud-url

If unspecified, MUD URL defaults to "none".

connection.lldp

connection.llmnr

If unspecified, the ultimate default values depends on the DNS plugin. With systemd-resolved the default currently is "yes" (2) and for all other plugins "no" (0).

connection.mdns

- Currently only the systemd-resolve DNS plugin supports this setting. - If the setting is unspecified both in the profile and in the global - default here, then the default is determined by systemd-resolved. - See MulticastDNS= in - resolved.conf(5). -

connection.mptcp-flags

If unspecified, the fallback is 0x22 ("enabled,subflow"). Note that if sysctl /proc/sys/net/mptcp/enabled is disabled, NetworkManager will still not configure endpoints.

connection.dns-over-tls

If unspecified, the ultimate default values depends on the DNS plugin. With systemd-resolved the default currently is global setting and for all other plugins "no" (0).

connection.stable-id

ethernet.cloned-mac-address

If left unspecified, it defaults to "preserve".

ethernet.generate-mac-address-mask

ethernet.mtu

If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is not reconfigured during activation.

ethernet.wake-on-lan

gsm.mtu

hostname.from-dhcp

hostname.from-dns-lookup

hostname.only-from-default

hostname.priority

infiniband.mtu

If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation.

ip-tunnel.mtu

If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500.

ipv4.dad-timeout

ipv4.dhcp-client-id

ipv4.dhcp-dscp

ipv4.dhcp-iaid

If left unspecified, it defaults to "ifname".

ipv4.dhcp-hostname-flags

If left unspecified, the value 3 (fqdn-encoded,fqdn-serv-update) is used.

ipv4.dhcp-send-release

Whether the DHCP client will send RELEASE message when bringing the connection down.

ipv4.dhcp-timeout

If left unspecified, the default value for - the interface type is used.

ipv4.dhcp-vendor-class-identifier

If left unspecified, the default is to not send the DHCP option to the server.

ipv4.dns-priority

If unspecified or zero, use 50 for VPN profiles - and 100 for other profiles.

ipv4.required-timeout

ipv4.link-local

If left unspecified, fallback to "auto" which makes it dependent on "ipv4.method" setting.

ipv4.route-metric

ipv4.route-table

If left unspecified, routes are only added to the main table. Note that this - is different from explicitly selecting the main table 254, because of how NetworkManager - removes extraneous routes from the tables. -

ipv6.addr-gen-mode

If the per-profile setting is either "default" or "default-or-eui64", the - global default is used. If the default is unspecified, the fallback value is either "stable-privacy" - or "eui64", depending on whether the per-profile setting is "default" or "default-or-eui64, respectively.

ipv6.ra-timeout

If left unspecified, the default value depends on the sysctl solicitation settings.

ipv6.dhcp-duid

If left unspecified, it defaults to "lease".

ipv6.dhcp-iaid

If left unspecified, it defaults to "ifname".

ipv6.dhcp-hostname-flags

If left unspecified, the value 1 (fqdn-serv-update) is used.

ipv6.dhcp-send-release

Whether the DHCP client will send RELEASE message when bringing the connection down.

ipv6.dhcp-timeout

If left unspecified, the default value for - the interface type is used.

ipv6.dns-priority

If unspecified or zero, use 50 for VPN profiles - and 100 for other profiles.

ipv6.ip6-privacy

If ipv6.ip6-privacy is unset, use the content of - "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback. -

ipv6.temp-valid-lifetime

If ipv6.temp-valid-lifetime is unset, use the - content of "/proc/sys/net/ipv6/conf/default/temp_valid_lft" as last fallback. -

ipv6.temp-preferred-lifetime

If ipv6.temp-preferred-lifetime is unset, use - the content of "/proc/sys/net/ipv6/conf/default/temp_prefered_lft" as last fallback. -

ipv6.required-timeout

ipv6.route-metric

ipv6.route-table

If left unspecified, routes are only added to the main table. Note that this - is different from explicitly selecting the main table 254, because of how NetworkManager - removes extraneous routes from the tables. -

loopback.mtu

If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation.

macsec.offload

sriov.autoprobe-drivers

If left unspecified, drivers are autoprobed when the SR-IOV VF gets created.

vpn.timeout

If left unspecified, default value of 60 seconds is used.

wifi.ap-isolation

If left unspecified, AP isolation is disabled.

wifi.cloned-mac-address

If left unspecified, it defaults to "preserve".

wifi.generate-mac-address-mask

wifi.mac-address-randomization

If left unspecified, MAC address randomization is disabled. - This setting is deprecated for wifi.cloned-mac-address. -

wifi.mtu

If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500.

wifi.powersave

If left unspecified, the default value - "ignore" will be used.

wifi-sec.pmf

If left unspecified, the default value - "optional" will be used.

wifi-sec.fils

If left unspecified, the default value - "optional" will be used.

wifi.wake-on-wlan

wireguard.mtu

-

- - -

-
-
-
-

Sections

-

- You can configure multiple connection - sections, by having different sections with a name that all start - with "connection". - Example: -

-
-[connection]
-ipv6.ip6-privacy=0
-connection.autoconnect-ports=1
-vpn.timeout=120
-
-[connection-wifi-wlan0]
-match-device=interface-name:wlan0
-ipv4.route-metric=50
-
-[connection-wifi-other]
-match-device=type:wifi
-ipv4.route-metric=55
-ipv6.ip6-privacy=1
-
-

-

-

- The sections within one file are considered in order of appearance, with the - exception that the [connection] section is always - considered last. In the example above, this order is [connection-wifi-wlan0], - [connection-wlan-other], and [connection]. - When checking for a default configuration value, the sections are searched until - the requested value is found. - In the example above, "ipv4.route-metric" for wlan0 interface is set to 50, - and for all other Wi-Fi typed interfaces to 55. Also, Wi-Fi devices would have - IPv6 private addresses enabled by default, but other devices would have it disabled. - Note that also "wlan0" gets "ipv6.ip6-privacy=1", because although the section - "[connection-wifi-wlan0]" matches the device, it does not contain that property - and the search continues. -

-

- When having different sections in multiple files, sections from files that are read - later have higher priority. So within one file the priority of the sections is - top-to-bottom. Across multiple files later definitions take precedence. -

-

- The following properties further control how a connection section applies. -

-
---- - - - - - - - - - - -

match-device

An optional device spec that restricts - when the section applies. See the section called “Device List Format” - for the possible values. -

stop-match

An optional boolean value which defaults to - no. If the section matches (based on - match-device), further sections will not be - considered even if the property in question is not present. In - the example above, if [connection-wifi-wlan0] would - have stop-match set to yes, - the device wlan0 would have ipv6.ip6-privacy - property unspecified. That is, the search for the property would not continue - in the connection sections [connection-wifi-other] - or [connection]. -

-

-

-
-
-
-

-device section

-

Contains per-device persistent configuration. -

-

- Example: -

-
-[device]
-match-device=interface-name:eth3
-managed=1
-
-

-

-
-

Supported Properties

-

- The following properties can be configured per-device. -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

managed

- Whether the device is managed or not. A device can be - marked as managed via udev rules (ENV{NM_UNMANAGED}), - or via setting plugins (keyfile.unmanaged-devices). - This is yet another way. Note that this configuration - can be overruled at runtime via D-Bus. Also, it has - higher priority then udev rules. -

carrier-wait-timeout

 -

- Specify the timeout for waiting for carrier in milliseconds. - The default is 6000 milliseconds. - This setting exists because certain drivers/hardware can take - a long time to detect whether the cable is plugged in. -

-

- When the device loses carrier, NetworkManager does not react - immediately. Instead, it waits for this timeout before considering - the link lost. -

-

- Also, on startup, NetworkManager considers the - device as busy for this time, as long as the device has no carrier. - This delays startup-complete signal and NetworkManager-wait-online. - Configuring this too high means to block NetworkManager-wait-online - longer than necessary when booting with cable unplugged. Configuring - it too low, means that NetworkManager will declare startup-complete too - soon, although carrier is about to come and auto-activation to kick in. - Note that if a profile only has static IP configuration or Layer 3 configuration - disabled, then it can already autoconnect without carrier on the device. - Once such a profile reaches full activated state, startup-complete - is considered as reached even if the device has no carrier yet. -

-

ignore-carrier

 -

- Specify devices for which NetworkManager will (partially) - ignore the carrier state. Normally, for - device types that support carrier-detect, such as Ethernet - and InfiniBand, NetworkManager will only allow a - connection to be activated on the device if carrier is - present (ie, a cable is plugged in), and it will - deactivate the device if carrier drops for more than a few - seconds. -

-

- A device with carrier ignored will allow activating connections on - that device even when it does not have carrier, provided - that the connection uses only statically-configured IP - addresses. Additionally, it will allow any active - connection (whether static or dynamic) to remain active on - the device when carrier is lost. -

-

- Note that the "carrier" property of NMDevices and device D-Bus - interfaces will still reflect the actual device state; it's just - that NetworkManager will not make use of that information. -

-

- Master types like bond, bridge and team ignore carrier by default, - while other device types react on carrier changes by default. -

-

- This setting overwrites the deprecated main.ignore-carrier - setting above. -

-

keep-configuration

 -

- On startup, NetworkManager tries to not interfere with - interfaces that are already configured. It does so by - generating a in-memory connection based on the interface - current configuration. -

-

- If this generated connection matches one of the existing - persistent connections, the persistent connection gets - activated. If there is no match, the generated - connection gets activated as "external", which means - that the connection is considered as active, but - NetworkManager doesn't actually touch the interface. -

-

- It is possible to disable this behavior by setting - keep-configuration to - no. In this way, on startup - NetworkManager always tries to activate the most - suitable persistent connection (the one with highest - autoconnect-priority or, in case of a tie, the one - activated most recently). -

-

- Note that when NetworkManager gets restarted, it stores - the previous state in - /run/NetworkManager; in particular - it saves the UUID of the connection that was previously - active so that it can be activated again after the - restart. Therefore, - keep-configuration does not have - any effect on service restart. -

-

allowed-connections

 -

- A list of connections that can be activated on the - device. See the section called “Connection List Format” for the - syntax to specify a connection. If this option is not - specified, all connections can be potentially activated - on the device, provided that the connection type and - other settings match. -

-

- A notable use case for this is to filter which - connections can be activated based on how they were - created; see the origin keyword in - the section called “Connection List Format”. -

-

wifi.scan-rand-mac-address

- Configures MAC address randomization of a Wi-Fi device during - scanning. This defaults to yes in which case - a random, locally-administered MAC address will be used. - The setting wifi.scan-generate-mac-address-mask - allows to influence the generated MAC address to use certain vendor - OUIs. - If disabled, the MAC address during scanning is left unchanged to - whatever is configured. - For the configured MAC address while the device is associated, see instead - the per-connection setting wifi.cloned-mac-address. -

wifi.backend

- Specify the Wi-Fi backend used for the device. Currently, supported - are wpa_supplicant and iwd (experimental). - If unspecified, the default is "wpa_supplicant". -

wifi.scan-generate-mac-address-mask

- Like the per-connection settings ethernet.generate-mac-address-mask - and wifi.generate-mac-address-mask, this allows to configure the - generated MAC addresses during scanning. See nm-settings-nmcli(5) - for details. -

wifi.iwd.autoconnect

- If wifi.backend is iwd, setting this to - false forces IWD's autoconnect mechanism to be disabled for - this device and connections will only be initiated by NetworkManager whether - commanded by a client or automatically. Leaving it true (default) - stops NetworkManager from automatically initiating connections and allows - IWD to use its network ranking and scanning logic to decide the best networks - to autoconnect to next. Connections' autoconnect-priority, - autoconnect-retries settings will be ignored. Other settings - like permissions or multi-connect may interfere - with IWD connection attempts. -

sriov-num-vfs

- Specify the number of virtual functions (VF) to enable - for a PCI physical device that supports single-root I/O - virtualization (SR-IOV). -

-

-

-
-
-
-

Sections

-

- The [device] section works the same as the [connection] section. - That is, multiple sections that all start with the prefix "device" can be specified. - The settings "match-device" and "stop-match" are available to match a device section - on a device. The order of multiple sections is also top-down within the file and - later files overwrite previous settings. See “Sections” under the section called “CONNECTION SECTION” - for details. -

-
-
-
-

-connectivity section

-

This section controls NetworkManager's optional connectivity - checking functionality. This allows NetworkManager to detect - whether or not the system can actually access the internet or - whether it is behind a captive portal.

-

Connectivity checking serves two purposes. For one, it exposes - a connectivity state on D-Bus, which other applications may use. For example, - Gnome's portal helper uses this as signal to show a captive portal login - page. - The other use is that default-route of devices without global connectivity - get a penalty of +20000 to the route-metric. This has the purpose to give a - better default-route to devices that have global connectivity. For example, - when being connected to WWAN and to a Wi-Fi network which is behind a captive - portal, WWAN still gets preferred until login.

-

Note that your distribution might set /proc/sys/net/ipv4/conf/*/rp_filter to - strict filtering. That works badly with per-device connectivity checking, - which uses SO_BINDDEVICE to send requests on all devices. A strict rp_filter - setting will reject any response and the connectivity check on all but the - best route will fail.

-

-

-
---- - - - - - - - - - - - - - - - - - - - - - - -

enabled

Whether connectivity check is enabled. - Note that to enable connectivity check, a valid uri must - also be configured. The value defaults to true, but since - the uri is unset by default, connectivity check may be disabled. - The main purpose of this option is to have a single flag - to disable connectivity check. Note that this setting can - also be set via D-Bus API at runtime. In that case, the value gets - stored in /var/lib/NetworkManager/NetworkManager-intern.conf - file. -

uri

The URI of a web page to periodically - request when connectivity is being checked. This page - should return the header "X-NetworkManager-Status" with a - value of "online". Alternatively, its body content should - be set to "NetworkManager is online". The body content - check can be controlled by the response - option. If this option is blank or missing, connectivity - checking is disabled. -

interval

Specified in seconds; controls how often - connectivity is checked when a network connection exists. If - set to 0 connectivity checking is disabled. If missing, the - default is 300 seconds.

timeout

Specified in seconds; controls how long - to wait for a response before connectivity is marked as - limited. If missing, the default is 20 seconds.

response

If set, controls what body content - NetworkManager checks for when requesting the URI for - connectivity checking. Note that this only compares - that the HTTP response starts with the specifid text, - it does not compare the exact string. This behavior - might change in the future, so avoid relying on it. - If missing, the response defaults to "NetworkManager is online". - If set to empty, the HTTP server is expected to answer with - status code 204 or send no data.

-

-

-
-
-

-global-dns section

-

This section specifies DNS settings that are applied - globally, in addition to connection-specific ones.

-

-

-
---- - - - - - - - - - - -

searches

- A list of search domains to be used during hostname lookup. -

options

- A list of options to be passed to the hostname resolver. -

-

-

-
-
-

-global-dns-domain sections

-

Sections with a name starting with the "global-dns-domain-" - prefix allow to define global DNS configuration for specific - domains. The part of section name after "global-dns-domain-" - specifies the domain name a section applies to (for example, a - section could be named "global-dns-domain-foobar.com"). More - specific domains have the precedence over less specific ones and - the default domain is represented by the wildcard "*". - - To be valid, global DNS domains must include a section for the - default domain "*". When the global DNS domains are valid, the - name servers and domains defined globally override the ones from - active connections. -

-

-

-
---- - - - - - - - - - - -

servers

- A list of addresses of DNS servers to be used for the given domain. -

options

- A list of domain-specific DNS options. Not used at the moment. -

-

-

-
-
-

-.config sections

-

This is a special section that contains options which apply - to the configuration file that contains the option. -

-

-

-
---- - - - - -

enable

 -

- Defaults to "true". If "false", - the configuration file will be skipped during loading. - Note that the main configuration file NetworkManager.conf - cannot be disabled. -

-
-# always skip loading the config file
-[.config]
-enable=false
-
-

-

-

- You can also match against the version of NetworkManager. For example - the following are valid configurations: -

-
-# only load on version 1.0.6
-[.config]
-enable=nm-version:1.0.6
-
-# load on all versions 1.0.x, but not 1.2.x
-[.config]
-enable=nm-version:1.0
-
-# only load on versions >= 1.1.6. This does not match
-# with version 1.2.0 or 1.4.4. Only the last digit is considered.
-[.config]
-enable=nm-version-min:1.1.6
-
-# only load on versions >= 1.2. Contrary to the previous
-# example, this also matches with 1.2.0, 1.2.10, 1.4.4, etc.
-[.config]
-enable=nm-version-min:1.2
-
-# Match against the maximum allowed version. The example matches
-# versions 1.2.0, 1.2.2, 1.2.4. Again, only the last version digit
-# is allowed to be smaller. So this would not match on 1.1.10.
-[.config]
-enable=nm-version-max:1.2.6
-
-

-

-

- You can also match against the value of the environment variable - NM_CONFIG_ENABLE_TAG, like: -

-
-# only load the file when running NetworkManager with
-# environment variable "NM_CONFIG_ENABLE_TAG=TAG1"
-[.config]
-enable=env:TAG1
-
-

-

-

- More then one match can be specified. The configuration will be - enabled if one of the predicates matches ("or"). The special prefix "except:" can - be used to negate the match. Note that if one except-predicate - matches, the entire configuration will be disabled. - In other words, a except predicate always wins over other predicates. - If the setting only consists of "except:" matches and none of the - negative conditions are satisfied, the configuration is still enabled. -

-
-# enable the configuration either when the environment variable
-# is present or the version is at least 1.2.0.
-[.config]
-enable=env:TAG2,nm-version-min:1.2
-
-# enable the configuration for version >= 1.2.0, but disable
-# it when the environment variable is set to "TAG3"
-[.config]
-enable=except:env:TAG3,nm-version-min:1.2
-
-# enable the configuration on >= 1.3, >= 1.2.6, and >= 1.0.16.
-# Useful if a certain feature is only present since those releases.
-[.config]
-enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16
-
-

-

-
-

-

-
-
-

Plugins

-

- Settings plugins for reading and writing connection profiles. The number of - available plugins is distribution specific. -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

keyfile

 -

- The keyfile plugin is the generic - plugin that supports all the connection types and - capabilities that NetworkManager has. It writes files out - in an .ini-style format in - /etc/NetworkManager/system-connections. - See nm-settings-keyfile(5) - for details about the file format. -

-

- The stored connection file may contain passwords, secrets and - private keys in plain text, so it will be made readable only to - root, and the plugin will ignore files that are readable or - writable by any user or group other than root. See "Secret flag types" - in nm-settings-nmcli(5) - for how to avoid storing passwords in plain text. -

-

- This plugin is always active, and will automatically be - used to store any connections that aren't supported by any - other active plugin. -

-

ifcfg-rh

- This plugin is now deprecated; it can be used on the - Fedora and Red Hat Enterprise Linux distributions to read - and write configuration from the standard - /etc/sysconfig/network-scripts/ifcfg-* - files. It currently supports reading Ethernet, Wi-Fi, - InfiniBand, VLAN, Bond, Bridge, and Team connections. - Enabling ifcfg-rh implicitly enables - ibft plugin, if it is available. - This can be disabled by adding no-ibft. - See /usr/share/doc/initscripts/sysconfig.txt - and nm-settings-ifcfg-rh(5) - for more information about the ifcfg file format. -

ifupdown

 -

- This plugin is used on the Debian and Ubuntu - distributions, and reads Ethernet and Wi-Fi connections - from /etc/network/interfaces. -

-

- This plugin is read-only; any connections (of any type) - added from within NetworkManager when you are using this - plugin will be saved using the keyfile - plugin instead. -

-

ibft, no-ibft

- These plugins are deprecated and their selection has no effect. - This is now handled by nm-initrd-generator. -

ifcfg-suse, ifnet

- These plugins are deprecated and their selection has no effect. - The keyfile plugin should be used - instead. -

-
-
-

Appendix

-
-

Device List Format

-

- The configuration options main.no-auto-default, main.ignore-carrier, - keyfile.unmanaged-devices, connection*.match-device and - device*.match-device select devices based on a list of matchings. - Devices can be specified using the following format: -

-

-

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

*

Matches every device.

IFNAME

Case sensitive match of interface name of the device. Globbing is not supported.

HWADDR

Match the permanent MAC address of the device. Globbing is not supported

interface-name:IFNAME, interface-name:~IFNAME

Case sensitive match of interface name of the device. Simple globbing is supported with - * and ?. Ranges and escaping is not supported.

interface-name:=IFNAME

Case sensitive match of interface name of the device. Globbing is disabled and IFNAME - is taken literally.

mac:HWADDR

Match the permanent MAC address of the device. Globbing is not supported

s390-subchannels:HWADDR

Match the device based on the subchannel address. Globbing is not supported

type:TYPE

Match the device type. Valid type names are as reported by "nmcli -f GENERAL.TYPE device show". - Globbing is not supported.

driver:DRIVER

Match the device driver as reported by "nmcli -f GENERAL.DRIVER,GENERAL.DRIVER-VERSION device show". - "DRIVER" must match the driver name exactly and does not support globbing. - Optionally, a driver version may be specified separated by '/'. Globbing is supported for the version. -

dhcp-plugin:DHCP

Match the configured DHCP plugin "main.dhcp". -

except:SPEC

 -

Negative match of a device. SPEC must be explicitly qualified with - a prefix such as interface-name:. A negative match has higher priority then the positive - matches above.

-

If there is a list consisting only of negative matches, the behavior is the same as if there - is also match-all. That means, if none of all the negative matches is satisfied, the overall result is - still a positive match. That means, "except:interface-name:eth0" is the same as - "*,except:interface-name:eth0".

-

SPEC[,;]SPEC

 -

Multiple specs can be concatenated with commas or semicolons. The order does not matter as - matches are either inclusive or negative (except:), with negative matches having higher - priority. -

-

Backslash is supported to escape the separators ';' and ',', and to express special - characters such as newline ('\n'), tabulator ('\t'), whitespace ('\s') and backslash ('\\'). The globbing of - interface names cannot be escaped. Whitespace is not a separator but will be trimmed between - two specs (unless escaped as '\s'). -

-
-

-

-

- Example: -

-
-interface-name:em4
-mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
-interface-name:vboxnet*,except:interface-name:vboxnet2
-*,except:mac:00:22:68:1c:59:b1
-
-

-

-
-
-
-

Connection List Format

-

- Connections can be specified using the following format: -

-

-

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

*

Matches every connection.

uuid:UUID

Match the connection by UUID, for example - "uuid:83037490-1d17-4986-a397-01f1db3a7fc2"

id=ID

Match the connection by name.

origin:ORIGIN

Match the connection by origin, stored in the - org.freedesktop.NetworkManager.origin tag of the user setting. For example, use - "except:origin:nm-initrd-generator" to forbid activation of connections created by the - initrd generator.

except:SPEC

 -

Negative match of a connection. A negative match has higher priority then the positive - matches above.

-

If there is a list consisting only of negative matches, the behavior is the same as if there is also - match-all. That means, if none of all the negative matches is satisfied, the overall result is still a - positive match.

-

SPEC[,;]SPEC

 -

Multiple specs can be concatenated with commas or semicolons. The order does not matter as - matches are either inclusive or negative (except:), with negative matches having higher - priority.

-

Backslash is supported to escape the separators ';' and ',', and to express special characters such as - newline ('\n'), tabulator ('\t'), whitespace ('\s') and backslash ('\\'). Whitespace is not a separator but - will be trimmed between two specs (unless escaped as '\s').

-
-

-

-
-
-
-

See Also

-

- NetworkManager(8), - nmcli(1), - nmcli-examples(7), - nm-online(1), - nm-settings-nmcli(5), - nm-applet(1), - nm-connection-editor(1) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 deleted file mode 100644 index 2fa066ba..00000000 --- a/docs/api/html/NetworkManager.devhelp2 +++ /dev/null @@ -1,927 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/api/html/NetworkManager.html b/docs/api/html/NetworkManager.html deleted file mode 100644 index f3be2764..00000000 --- a/docs/api/html/NetworkManager.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - -NetworkManager: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NetworkManager

-

NetworkManager — network management daemon

-
-
-

Synopsis

-

NetworkManager [OPTIONS...]

-
-
-

Description

-

- The NetworkManager daemon attempts to make networking - configuration and operation as painless and automatic as - possible by managing the primary network connection and other - network interfaces, like Ethernet, Wi-Fi, and Mobile Broadband - devices. NetworkManager will connect any network device when a - connection for that device becomes available, unless that - behavior is disabled. Information about networking is exported - via a D-Bus interface to any interested application, providing a - rich API with which to inspect and control network settings and - operation. -

-
-
-

Dispatcher scripts

-

- NetworkManager-dispatcher service can execute scripts for the user - in response to network events. See - NetworkManager-dispatcher(8) manual. -

-
-
-

Options

-

The following options are understood:

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

--version | -V

Print the NetworkManager software version and exit. -

--help | -h

Print NetworkManager's available options and exit. -

--no-daemon | -n

Do not daemonize. -

--debug | -d

Do not daemonize, and direct log output to the - controlling terminal in addition to syslog. -

--pid-file | -p

Specify location of a PID file. The PID file - is used for storing PID of the running process and prevents - running multiple instances. -

--state-file

Specify file for storing state of the - NetworkManager persistently. If not specified, the default - value of /var/lib/NetworkManager/NetworkManager.state - is used. -

--config

Specify configuration file to set up various - settings for NetworkManager. If not specified, the default - value of /etc/NetworkManager/NetworkManager.conf - is used with - a fallback to the older 'nm-system-settings.conf' if located - in the same directory. See - NetworkManager.conf(5) - for more information on configuration file. -

--configure-and-quit [initrd]

Quit after all devices reach a stable state. - The optional initrd parameter enables mode, where no - processes are left running after NetworkManager stops, which is useful - for running from an initial ramdisk on rearly boot.

--plugins

List plugins used to manage system-wide - connection settings. This list has preference over plugins - specified in the configuration file. See main.plugins - setting in NetworkManager.conf(5) - for supported options. -

--log-level

- Sets how much information NetworkManager sends to the log destination (usually - syslog's "daemon" facility). By default, only informational, warning, and error - messages are logged. See the section on logging in - NetworkManager.conf(5) - for more information. -

--log-domains

- A comma-separated list specifying which operations are logged to the log - destination (usually syslog). By default, most domains are logging-enabled. - See the section on logging in - NetworkManager.conf(5) - for more information. -

--print-config

 -

- Print the NetworkManager configuration to stdout and exit. See - NetworkManager.conf(5). - This does not include connection profiles. View them with nmcli connection. -

-

- This reads configuration files from disk. If NetworkManager is currently running, - make sure that it has the same configuration loaded. -

-
-
-
-

Udev Properties

-

- udev(7) - device manager is used for the network device discovery. The following - property influences how NetworkManager manages the devices: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

NM_UNMANAGED

- If set to "1" or "true", the device is - configured as unmanaged by NetworkManager. Note that the user still can - explicitly overrule this configuration via means like - nmcli device set "$DEVICE" managed yes or - "device*.managed=1" in NetworkManager.conf. -

ID_NET_MANAGED_BY

- If NM_UNMANAGED is set, this has no effect. Otherwise, - if the attribute is set to anything but - "org.freedesktop.NetworkManager", the device is unmanaged. -

NM_AUTO_DEFAULT_LINK_LOCAL_ONLY

- If set to "1" or "true", the - automatically generated connections "Wired connection N" will only - enable link local addressing for IPv4 and IPv6. This can be useful - on thunderbolt devices or host-to-host USB devices. -

ID_NET_AUTO_LINK_LOCAL_ONLY

- Honored and treated the same as if NM_AUTO_DEFAULT_LINK_LOCAL_ONLY - were set. -

ID_NET_DHCP_BROADCAST

- If set to "1" or "true", use - broadcast requests for DHCPv4 offers. This can make sense of devices - that can't handle unicast messages until being configured. -

-
-
-

SIGNALS

-

- NetworkManager process handles the following signals: -

-
---- - - - - - - - - - - - - - - -

SIGHUP

- The signal causes a reload of NetworkManager's configuration. - Note that not all configuration parameters can be changed at - runtime and therefore some changes may be applied only after - the next restart of the daemon. - A SIGHUP also involves further reloading actions, like doing - a DNS update and restarting the DNS plugin. The latter can be - useful for example when using the dnsmasq plugin and changing - its configuration in /etc/NetworkManager/dnsmasq.d. - However, it also means this will shortly interrupt name resolution. - In the future, there may be further actions added. - A SIGHUP means to update NetworkManager configuration and reload - everything that is supported. Note that this does not reload - connections from disk. For that there is a D-Bus API and - nmcli's reload action -

SIGUSR1

- The signal forces a rewrite of DNS configuration. Contrary - to SIGHUP, this does not restart the DNS plugin and will not - interrupt name resolution. - - When NetworkManager is not managing DNS, the signal forces - a restart of operations that depend on the DNS - configuration (like the resolution of the system hostname - via reverse DNS, or the resolution of WireGuard peers); - therefore, it can be used to tell NetworkManager that the - content of resolv.conf was changed externally. - - In the future, further actions may be added. A SIGUSR1 - means to write out data like resolv.conf, or refresh a cache. - It is a subset of what is done for SIGHUP without reloading - configuration from disk. -

SIGUSR2

- The signal has no effect at the moment but is reserved for future - use. -

-

-

-

- An alternative to a signal to reload configuration is the Reload D-Bus call. - It allows for more fine-grained selection of what to reload, it only returns - after the reload is complete, and it is guarded by PolicyKit. -

-
-
-

Debugging

-

- NetworkManager only configures your system. So when your networking setup doesn't - work as expected, the first step is to look at your system to understand what is actually - configured, and whether that is correct. The second step is to find out how to tell - NetworkManager to do the right thing. -

-

- You can for example try to ping hosts (by - IP address or DNS name), look at ip link show, ip address show and ip route show, - and look at /etc/resolv.conf for name resolution issues. - Also look at the connection profiles that you have configured in NetworkManager (nmcli connection - and nmcli connection show "$PROFILE") - and the configured interfaces (nmcli device). -

-

- If that does not suffice, look at the logfiles of NetworkManager. NetworkManager - logs to syslog, so depending on your system configuration you can call journalctl - to get the logs. - By default, NetworkManager logs are not verbose and thus not very helpful for investigating - a problem in detail. You can change the logging level at runtime with nmcli general logging level TRACE domains ALL. - But usually a better way is to collect full logs from the start, by configuring - level=TRACE in NetworkManager.conf. See - NetworkManager.conf(5) - manual. Note that trace logs of NetworkManager are verbose and systemd-journald might rate limit - some lines. Possibly disable rate limiting first with the RateLimitIntervalSec and - RateLimitBurst options of journald (see - journald.conf(5) manual). -

-

- NetworkManager does not log any secrets. However, you are advised to check whether anything - private sensitive gets logged before posting. When reporting an issue, provide complete - logs and avoid modifications (for privacy) that distort the meaning. -

-
-
-

/var/lib/NetworkManager/secret_key and /etc/machine-id

-

- The identity of a machine is important as various settings depend on it. For example, - ipv6.addr-gen-mode=stable and ethernet.cloned-mac-address=stable - generate identifiers by hashing the machine's identity. See also the - connection.stable-id connection property which is a per-profile seed - that gets hashed with the machine identity for generating such addresses and identifiers. -

-

- If you backup and restore a machine, the identity of the machine probably should be preserved. - In that case, preserve the files /var/lib/NetworkManager/secret_key and - /etc/machine-id. On the other hand, if you clone a virtual machine, you - probably want that the clone has a different identity. There is already existing tooling on Linux for - handling /etc/machine-id (see - machine-id(5)). -

-

- The identity of the machine is determined by the /var/lib/NetworkManager/secret_key. - If such a file does not exist, NetworkManager will create a file with random content. To generate - a new identity just delete the file and after restart a new file will be created. - The file should be read-only to root and contain at least 16 bytes that will be used to seed the various places - where a stable identifier is used. -

-

- Since 1.16.0, NetworkManager supports a version 2 of secret-keys. For such keys - /var/lib/NetworkManager/secret_key starts with ASCII "nm-v2:" - followed by at least 32 bytes of random data. - Also, recent versions of NetworkManager always create such kinds of secret-keys, when - the file does not yet exist. - With version 2 of the secret-key, /etc/machine-id is also hashed as part - of the generation for addresses and identifiers. The advantage is that you can keep /var/lib/NetworkManager/secret_key - stable, and only regenerate /etc/machine-id when cloning a VM. -

-
-
-

Bugs

-

- Please report any bugs you find in NetworkManager at the - NetworkManager issue tracker. -

-
-
-

See Also

-

- NetworkManager home page, - NetworkManager.conf(5), - NetworkManager-dispatcher(8), - NetworkManager-wait-online.service(8), - nmcli(1), - nmcli-examples(7), - nm-online(1), - nm-settings-nmcli(5), - nm-applet(1), - nm-connection-editor(1), - udev(7) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ch01.html b/docs/api/html/ch01.html deleted file mode 100644 index af0badca..00000000 --- a/docs/api/html/ch01.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - -Configuration Settings: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Configuration Settings

-
-
-connection — General Connection Profile Settings -
-
-6lowpan — 6LoWPAN Settings -
-
-802-1x — IEEE 802.1x Authentication Settings -
-
-adsl — ADSL Settings -
-
-bluetooth — Bluetooth Settings -
-
-bond — Bonding Settings -
-
-bridge — Bridging Settings -
-
-bridge-port — Bridge Port Settings -
-
-cdma — CDMA-based Mobile Broadband Settings -
-
-dcb — Data Center Bridging Settings -
-
-dummy — Dummy Link Settings -
-
-ethtool — Ethtool Ethernet Settings -
-
-generic — Generic Link Settings -
-
-gsm — GSM-based Mobile Broadband Settings -
-
-hsr — HSR/PRP Settings -
-
-infiniband — Infiniband Settings -
-
-ipv4 — IPv4 Settings -
-
-ipv6 — IPv6 Settings -
-
-ip-tunnel — IP Tunneling Settings -
-
-macsec — MACSec Settings -
-
-macvlan — MAC VLAN Settings -
-
-match — Match settings -
-
-802-11-olpc-mesh — OLPC Wireless Mesh Settings -
-
-ovs-bridge — OvsBridge Link Settings -
-
-ovs-dpdk — OvsDpdk Link Settings -
-
-ovs-interface — Open vSwitch Interface Settings -
-
-ovs-patch — OvsPatch Link Settings -
-
-ovs-port — OvsPort Link Settings -
-
-ppp — Point-to-Point Protocol Settings -
-
-pppoe — PPP-over-Ethernet Settings -
-
-proxy — WWW Proxy Settings -
-
-serial — Serial Link Settings -
-
-sriov — SR-IOV settings -
-
-tc — Linux Traffic Control Settings -
-
-team — Teaming Settings -
-
-team-port — Team Port Settings -
-
-tun — Tunnel Settings -
-
-user — General User Profile Settings -
-
-vlan — VLAN Settings -
-
-vpn — VPN Settings -
-
-vrf — VRF settings -
-
-vxlan — VXLAN Settings -
-
-wifi-p2p — Wi-Fi P2P Settings -
-
-wimax — WiMax Settings -
-
-802-3-ethernet — Wired Ethernet Settings -
-
-wireguard — WireGuard Settings -
-
-802-11-wireless — Wi-Fi Settings -
-
-802-11-wireless-security — Wi-Fi Security Settings -
-
-wpan — IEEE 802.15.4 (WPAN) MAC Settings -
-
-bond-port — Bond Port Settings -
-
-hostname — Hostname settings -
-
-link — Link settings -
-
-loopback — Loopback Link Settings -
-
-ovs-external-ids — OVS External IDs Settings -
-
-ovs-other-config — OVS Other Config Settings -
-
-veth — Veth Settings -
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/dbus-secret-agent.html b/docs/api/html/dbus-secret-agent.html deleted file mode 100644 index b2c2a2f9..00000000 --- a/docs/api/html/dbus-secret-agent.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -Secret agents: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Secret agents

-
-org.freedesktop.NetworkManager.SecretAgent — User Secret Agent. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/dbus-types.html b/docs/api/html/dbus-types.html deleted file mode 100644 index ff087c12..00000000 --- a/docs/api/html/dbus-types.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -Types: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Types

-
-NetworkManager D-Bus API Types -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/dbus-vpn-plugin.html b/docs/api/html/dbus-vpn-plugin.html deleted file mode 100644 index 145b8357..00000000 --- a/docs/api/html/dbus-vpn-plugin.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -VPN services: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-VPN services

-
-org.freedesktop.NetworkManager.VPN.Plugin — VPN Service. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/dbus-vpn-types.html b/docs/api/html/dbus-vpn-types.html deleted file mode 100644 index e5171774..00000000 --- a/docs/api/html/dbus-vpn-types.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -Types: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Types

-
-VPN Plugin D-Bus API Types -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html deleted file mode 100644 index 4713ebe6..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AccessPoint.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - -org.freedesktop.NetworkManager.AccessPoint: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.AccessPoint

-

org.freedesktop.NetworkManager.AccessPoint — Wi-Fi Access Point.

-
-
-

Properties

-
-Flags       readable   u
-WpaFlags    readable   u
-RsnFlags    readable   u
-Ssid        readable   ay
-Frequency   readable   u
-HwAddress   readable   s
-Mode        readable   u
-MaxBitrate  readable   u
-Bandwidth   readable   u
-Strength    readable   y
-LastSeen    readable   i
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Flags" property

-
-Flags  readable   u
-
-

-Flags describing the capabilities of the access point. -

-

-Returns: NM80211ApFlags -

-
-
-
-

The "WpaFlags" property

-
-WpaFlags  readable   u
-
-

-Flags describing the access point's capabilities according to WPA (Wifi -Protected Access). -

-

-Returns: NM80211ApSecurityFlags -

-
-
-
-

The "RsnFlags" property

-
-RsnFlags  readable   u
-
-

-Flags describing the access point's capabilities according to the RSN -(Robust Secure Network) protocol. -

-

-Returns: NM80211ApSecurityFlags -

-
-
-
-

The "Ssid" property

-
-Ssid  readable   ay
-
-

-The Service Set Identifier identifying the access point. -

-
-
-
-

The "Frequency" property

-
-Frequency  readable   u
-
-

-The radio channel frequency in use by the access point, in MHz. -

-
-
-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The hardware address (BSSID) of the access point. -

-
-
-
-

The "Mode" property

-
-Mode  readable   u
-
-

-Describes the operating mode of the access point. -

-

-Returns: NM80211Mode -

-
-
-
-

The "MaxBitrate" property

-
-MaxBitrate  readable   u
-
-

-The maximum bitrate this access point is capable of, in kilobits/second -(Kb/s). -

-
-
-
-

The "Bandwidth" property

-
-Bandwidth  readable   u
-
-

-The bandwidth announced by the access point in MHz. -

-
-
-
-

The "Strength" property

-
-Strength  readable   y
-
-

-The current signal quality of the access point, in percent. -

-
-
-
-

The "LastSeen" property

-
-LastSeen  readable   i
-
-

-The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access -point was found in scan results. A value of -1 means the access point has -never been found in scan results. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html deleted file mode 100644 index 2e3ebed4..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.AgentManager.html +++ /dev/null @@ -1,122 +0,0 @@ - - - - -org.freedesktop.NetworkManager.AgentManager: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.AgentManager

-

org.freedesktop.NetworkManager.AgentManager — Secret Agent Manager.

-
-
-

Methods

-
-Register                 (IN  s identifier);
-RegisterWithCapabilities (IN  s identifier,
-                          IN  u capabilities);
-Unregister               ();
-
-
-
-

Description

-

-

-

-

-
-
-

Method Details

-
-

The Register() method

-
-Register (IN  s identifier);
-
-

-Called by secret Agents to register their ability to provide and save -network secrets. -

-
---- - - - - -

IN s identifier:

-Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes). -

-
-
-
-

The RegisterWithCapabilities() method

-
-RegisterWithCapabilities (IN  s identifier,
-                          IN  u capabilities);
-
-

-Like Register() but indicates agent capabilities to NetworkManager. -

-
---- - - - - - - - - - - -

IN s identifier:

-See the Register() method's identifier argument. -

IN u capabilities:

-(NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager. -

-
-
-
-

The Unregister() method

-
-Unregister ();
-
-

-Called by secret Agents to notify NetworkManager that they will no longer -handle requests for network secrets. Agents are automatically unregistered -when they disconnect from D-Bus. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html deleted file mode 100644 index 692aad68..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Checkpoint.html +++ /dev/null @@ -1,86 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Checkpoint: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Checkpoint

-

org.freedesktop.NetworkManager.Checkpoint — Configuration and State Snapshot.

-
-
-

Properties

-
-Devices          readable   ao
-Created          readable   x
-RollbackTimeout  readable   u
-
-
-
-

Description

-

-A snapshot of NetworkManager state for a given device list -

-
-
-

Property Details

-
-

The "Devices" property

-
-Devices  readable   ao
-
-

-Array of object paths for devices which are part of this -checkpoint. -

-
-
-
-

The "Created" property

-
-Created  readable   x
-
-

-The timestamp (in CLOCK_BOOTTIME milliseconds) of checkpoint creation. -

-
-
-
-

The "RollbackTimeout" property

-
-RollbackTimeout  readable   u
-
-

-Timeout in seconds for automatic rollback, or zero. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html deleted file mode 100644 index 01887d52..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Connection.Active: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Connection.Active

-

org.freedesktop.NetworkManager.Connection.Active — Active Connection.

-
-
-

Signals

-
-StateChanged (u state,
-              u reason);
-
-
-
-

Properties

-
-Connection      readable   o
-SpecificObject  readable   o
-Id              readable   s
-Uuid            readable   s
-Type            readable   s
-Devices         readable   ao
-State           readable   u
-StateFlags      readable   u
-Default         readable   b
-Ip4Config       readable   o
-Dhcp4Config     readable   o
-Default6        readable   b
-Ip6Config       readable   o
-Dhcp6Config     readable   o
-Vpn             readable   b
-Controller      readable   o
-Master          readable   o
-
-
-
-

Description

-

-Objects that implement the Connection.Active interface represent an -attempt to connect to a network using the details provided by a Connection -object. The Connection.Active object tracks the life-cycle of the -connection attempt and if successful indicates whether the connected -network is the "default" or preferred network for access. NetworkManager -has the concept of connections, which can be thought of as settings, a -profile or a configuration that can be applied on a networking device. -Such settings-connections are exposed as D-Bus object and the -active-connection expresses this relationship between device and -settings-connection. At any time a settings-connection can only be -activated on one device and vice versa. However, during activation and -deactivation multiple active-connections can reference the same device or -settings-connection as they are waiting to be activated or to be -deactivated. -

-
-
-

Signal Details

-
-

The "StateChanged" signal

-
-StateChanged (u state,
-              u reason);
-
-

-Emitted when the state of the active connection has changed. -

-
---- - - - - - - - - - - -

u state:

-(NMActiveConnectionState) The new state of the active connection. -

u reason:

-(NMActiveConnectionStateReason) Reason code describing the change to the new state. -

-

Since 1.8

-
-
-
-

Property Details

-
-

The "Connection" property

-
-Connection  readable   o
-
-

-The path of the connection. -

-
-
-
-

The "SpecificObject" property

-
-SpecificObject  readable   o
-
-

-A specific object associated with the active connection. This property -reflects the specific object used during connection activation, and will -not change over the lifetime of the ActiveConnection once set. -

-
-
-
-

The "Id" property

-
-Id  readable   s
-
-

-The ID of the connection, provided as a convenience so that clients do not -have to retrieve all connection details. -

-
-
-
-

The "Uuid" property

-
-Uuid  readable   s
-
-

-The UUID of the connection, provided as a convenience so that clients do -not have to retrieve all connection details. -

-
-
-
-

The "Type" property

-
-Type  readable   s
-
-

-The type of the connection, provided as a convenience so that clients do -not have to retrieve all connection details. -

-
-
-
-

The "Devices" property

-
-Devices  readable   ao
-
-

-Array of object paths representing devices which are part of this active -connection. -

-
-
-
-

The "State" property

-
-State  readable   u
-
-

-The state of this active connection. -

-

-Returns: NMActiveConnectionState -

-
-
-
-

The "StateFlags" property

-
-StateFlags  readable   u
-
-

-The state flags of this active connection. -

-

-Returns: NMActivationStateFlags -

-
-
-
-

The "Default" property

-
-Default  readable   b
-
-

-Whether this active connection is the default IPv4 connection, i.e. -whether it currently owns the default IPv4 route. -

-
-
-
-

The "Ip4Config" property

-
-Ip4Config  readable   o
-
-

-Object path of the Ip4Config object describing the configuration of the -connection. Only valid when the connection is in the -NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

-
-
-
-

The "Dhcp4Config" property

-
-Dhcp4Config  readable   o
-
-

-Object path of the Dhcp4Config object describing the DHCP options returned -by the DHCP server (assuming the connection used DHCP). Only valid when -the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

-
-
-
-

The "Default6" property

-
-Default6  readable   b
-
-

-Whether this active connection is the default IPv6 connection, i.e. -whether it currently owns the default IPv6 route. -

-
-
-
-

The "Ip6Config" property

-
-Ip6Config  readable   o
-
-

-Object path of the Ip6Config object describing the configuration of the -connection. Only valid when the connection is in the -NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

-
-
-
-

The "Dhcp6Config" property

-
-Dhcp6Config  readable   o
-
-

-Object path of the Dhcp6Config object describing the DHCP options returned -by the DHCP server (assuming the connection used DHCP). Only valid when -the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. -

-
-
-
-

The "Vpn" property

-
-Vpn  readable   b
-
-

-Whether this active connection is also a VPN connection. -

-
-
-
-

The "Controller" property

-
-Controller  readable   o
-
-

-The path to the controller device if the connection is a port. This -property replaces the deprecated 'Master' property. -

-
-
-
-

The "Master" property

-
-Master  readable   o
-
-

-The path to the controller device if the connection is a port. -

-

-DEPRECATED. This property is deprecated in favor of the 'Controller' -property since 1.44. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html deleted file mode 100644 index cc9381db..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP4Config.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - -org.freedesktop.NetworkManager.DHCP4Config: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.DHCP4Config

-

org.freedesktop.NetworkManager.DHCP4Config — IPv4 DHCP Client State.

-
-
-

Properties

-
-Options  readable   a{sv}
-
-
-
-

Description

-

-Options and configuration returned by the IPv4 DHCP server. -

-
-
-

Property Details

-
-

The "Options" property

-
-Options  readable   a{sv}
-
-

-Configuration options returned by a DHCP server, if any. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html deleted file mode 100644 index 80c6db78..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DHCP6Config.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - -org.freedesktop.NetworkManager.DHCP6Config: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.DHCP6Config

-

org.freedesktop.NetworkManager.DHCP6Config — IPv6 DHCP Client State.

-
-
-

Properties

-
-Options  readable   a{sv}
-
-
-
-

Description

-

-Options and configuration returned by the IPv6 DHCP server. -

-
-
-

Property Details

-
-

The "Options" property

-
-Options  readable   a{sv}
-
-

-Configuration options returned by a DHCP server, if any. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html deleted file mode 100644 index 17437b92..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Adsl.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Adsl: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Adsl

-

org.freedesktop.NetworkManager.Device.Adsl — ADSL Device.

-
-
-

Properties

-
-Carrier  readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found. -

-

-DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html deleted file mode 100644 index 66c4431c..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bluetooth.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Bluetooth: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Bluetooth

-

org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device.

-
-
-

Properties

-
-HwAddress       readable   s
-Name            readable   s
-BtCapabilities  readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-Bluetooth hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-

The "Name" property

-
-Name  readable   s
-
-

-Bluetooth name of the device. -

-
-
-
-

The "BtCapabilities" property

-
-BtCapabilities  readable   u
-
-

-Bluetooth capabilities of the device (either DUN or NAP). -

-

-Returns: NMBluetoothCapabilities -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html deleted file mode 100644 index 02f71788..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bond.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Bond: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Bond

-

org.freedesktop.NetworkManager.Device.Bond — Bonding Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Carrier    readable   b
-Slaves     readable   ao
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-

The "Slaves" property

-
-Slaves  readable   ao
-
-

-DEPRECATED. Use the "Ports" property in -"org.freedesktop.NetworkManager.Device" instead which exists since -version NetworkManager 1.34.0. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html deleted file mode 100644 index 5de60033..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Bridge.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Bridge: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Bridge

-

org.freedesktop.NetworkManager.Device.Bridge — Bridging Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Carrier    readable   b
-Slaves     readable   ao
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-

The "Slaves" property

-
-Slaves  readable   ao
-
-

-DEPRECATED. Use the "Ports" property in -"org.freedesktop.NetworkManager.Device" instead which exists since -version NetworkManager 1.34.0. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html deleted file mode 100644 index 9f38cb1c..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Dummy.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Dummy: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Dummy

-

org.freedesktop.NetworkManager.Device.Dummy — Dummy Device.

-
-
-

Properties

-
-HwAddress  readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html deleted file mode 100644 index f4f15654..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Generic.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Generic: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Generic

-

org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device.

-
-
-

Properties

-
-HwAddress        readable   s
-TypeDescription  readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "TypeDescription" property

-
-TypeDescription  readable   s
-
-

-A (non-localized) description of the interface type, if known. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Hsr.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Hsr.html deleted file mode 100644 index 5bc88103..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Hsr.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Hsr: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Hsr

-

org.freedesktop.NetworkManager.Device.Hsr — HSR Device.

-
-
-

Properties

-
-Port1               readable   o
-Port2               readable   o
-SupervisionAddress  readable   s
-MulticastSpec       readable   y
-Prp                 readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Port1" property

-
-Port1  readable   o
-
-

-The device's port1 device. -

-

Since 1.46

-
-
-
-

The "Port2" property

-
-Port2  readable   o
-
-

-The device's port2 device. -

-

Since 1.46

-
-
-
-

The "SupervisionAddress" property

-
-SupervisionAddress  readable   s
-
-

-The supervision MAC address. -

-

Since 1.46

-
-
-
-

The "MulticastSpec" property

-
-MulticastSpec  readable   y
-
-

-The last byte of the supervision address. -

-

Since 1.46

-
-
-
-

The "Prp" property

-
-Prp  readable   b
-
-

-Whether the PRP protocol is used or not. -

-

Since 1.46

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html deleted file mode 100644 index f3bb358f..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.IPTunnel.html +++ /dev/null @@ -1,201 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.IPTunnel: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.IPTunnel

-

org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device.

-
-
-

Properties

-
-Mode                readable   u
-Parent              readable   o
-Local               readable   s
-Remote              readable   s
-Ttl                 readable   y
-Tos                 readable   y
-PathMtuDiscovery    readable   b
-InputKey            readable   s
-OutputKey           readable   s
-EncapsulationLimit  readable   y
-FlowLabel           readable   u
-FwMark              readable   u
-Flags               readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Mode" property

-
-Mode  readable   u
-
-

-The tunneling mode. -

-
-
-
-

The "Parent" property

-
-Parent  readable   o
-
-

-The object path of the parent device. -

-
-
-
-

The "Local" property

-
-Local  readable   s
-
-

-The local endpoint of the tunnel. -

-
-
-
-

The "Remote" property

-
-Remote  readable   s
-
-

-The remote endpoint of the tunnel. -

-
-
-
-

The "Ttl" property

-
-Ttl  readable   y
-
-

-The TTL assigned to tunneled packets. 0 is a special value meaning that -packets inherit the TTL value -

-
-
-
-

The "Tos" property

-
-Tos  readable   y
-
-

-The type of service (IPv4) or traffic class (IPv6) assigned to tunneled -packets. -

-
-
-
-

The "PathMtuDiscovery" property

-
-PathMtuDiscovery  readable   b
-
-

-Whether path MTU discovery is enabled on this tunnel. -

-
-
-
-

The "InputKey" property

-
-InputKey  readable   s
-
-

-The key used for incoming packets. -

-
-
-
-

The "OutputKey" property

-
-OutputKey  readable   s
-
-

-The key used for outgoing packets. -

-
-
-
-

The "EncapsulationLimit" property

-
-EncapsulationLimit  readable   y
-
-

-How many additional levels of encapsulation are permitted to be prepended -to packets. This property applies only to IPv6 tunnels. -

-
-
-
-

The "FlowLabel" property

-
-FlowLabel  readable   u
-
-

-The flow label to assign to tunnel packets. This property applies only to -IPv6 tunnels. -

-
-
-
-

The "FwMark" property

-
-FwMark  readable   u
-
-

-The fwmark value to assign to tunnel packets. This property applies only to -VTI tunnels. -

-
-
-
-

The "Flags" property

-
-Flags  readable   u
-
-

-Tunnel flags. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html deleted file mode 100644 index cb6fb901..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Infiniband.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Infiniband: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Infiniband

-

org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Carrier    readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Loopback.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Loopback.html deleted file mode 100644 index ed96f8df..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Loopback.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Loopback: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Loopback

-

org.freedesktop.NetworkManager.Device.Loopback — Loopback Device.

-
-
-

Description

-

-

-

-

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html deleted file mode 100644 index 9d8c6dcd..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Lowpan.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Lowpan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Lowpan

-

org.freedesktop.NetworkManager.Device.Lowpan — 6LoWPAN Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Parent     readable   o
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The active hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-

The "Parent" property

-
-Parent  readable   o
-
-

-The object path of the parent device. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html deleted file mode 100644 index ad2b626c..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macsec.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Macsec: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Macsec

-

org.freedesktop.NetworkManager.Device.Macsec — MACSec Device.

-
-
-

Properties

-
-Parent         readable   o
-Sci            readable   t
-IcvLength      readable   y
-CipherSuite    readable   t
-Window         readable   u
-EncodingSa     readable   y
-Validation     readable   s
-Encrypt        readable   b
-Protect        readable   b
-IncludeSci     readable   b
-Es             readable   b
-Scb            readable   b
-ReplayProtect  readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Parent" property

-
-Parent  readable   o
-
-

-The object path of the parent device. -

-
-
-
-

The "Sci" property

-
-Sci  readable   t
-
-

-The Secure Channel Identifier in use. -

-
-
-
-

The "IcvLength" property

-
-IcvLength  readable   y
-
-

-The length of ICV (Integrity Check Value). -

-
-
-
-

The "CipherSuite" property

-
-CipherSuite  readable   t
-
-

-The set of cryptographic algorithms in use -(e.g. 0x0080020001000001 for GCM-AES-128). -

-
-
-
-

The "Window" property

-
-Window  readable   u
-
-

-The size of the replay window. -

-
-
-
-

The "EncodingSa" property

-
-EncodingSa  readable   y
-
-

-The value of the Association Number (0..3) for the Security -Association in use. -

-
-
-
-

The "Validation" property

-
-Validation  readable   s
-
-

-The validation mode for incoming packets (strict, check, -disabled). -

-
-
-
-

The "Encrypt" property

-
-Encrypt  readable   b
-
-

-Whether encryption of transmitted frames is enabled. -

-
-
-
-

The "Protect" property

-
-Protect  readable   b
-
-

-Whether protection of transmitted frames is enabled. -

-
-
-
-

The "IncludeSci" property

-
-IncludeSci  readable   b
-
-

-Whether the SCI is always included in SecTAG for transmitted -frames. -

-
-
-
-

The "Es" property

-
-Es  readable   b
-
-

-Whether the ES (End station) bit is enabled in SecTAG for -transmitted frames. -

-
-
-
-

The "Scb" property

-
-Scb  readable   b
-
-

-Whether the SCB (Single Copy Broadcast) bit is enabled in -SecTAG for transmitted frames. -

-
-
-
-

The "ReplayProtect" property

-
-ReplayProtect  readable   b
-
-

-Whether replay protection is enabled. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html deleted file mode 100644 index 93d90f23..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Macvlan.html +++ /dev/null @@ -1,97 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Macvlan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Macvlan

-

org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device.

-
-
-

Properties

-
-Parent     readable   o
-Mode       readable   s
-NoPromisc  readable   b
-Tap        readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Parent" property

-
-Parent  readable   o
-
-

-The object path of the parent device. -

-
-
-
-

The "Mode" property

-
-Mode  readable   s
-
-

-The macvlan mode, one of "private", "vepa", "bridge", or "passthru". -

-
-
-
-

The "NoPromisc" property

-
-NoPromisc  readable   b
-
-

-Whether the device is blocked from going into promiscuous mode. -

-
-
-
-

The "Tap" property

-
-Tap  readable   b
-
-

-Whether the device is a macvtap. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html deleted file mode 100644 index e68e77c0..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Modem.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Modem: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Modem

-

org.freedesktop.NetworkManager.Device.Modem — Modem Device.

-
-
-

Properties

-
-ModemCapabilities    readable   u
-CurrentCapabilities  readable   u
-DeviceId             readable   s
-OperatorCode         readable   s
-Apn                  readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "ModemCapabilities" property

-
-ModemCapabilities  readable   u
-
-

-The generic family of access technologies the modem supports. Not all -capabilities are available at the same time however; some modems require a -firmware reload or other reinitialization to switch between eg CDMA/EVDO -and GSM/UMTS. -

-

-Returns: NMDeviceModemCapabilities -

-
-
-
-

The "CurrentCapabilities" property

-
-CurrentCapabilities  readable   u
-
-

-The generic family of access technologies the modem currently supports -without a firmware reload or reinitialization. -

-

-Returns: NMDeviceModemCapabilities -

-
-
-
-

The "DeviceId" property

-
-DeviceId  readable   s
-
-

-An identifier used by the modem backend (ModemManager) that aims to -uniquely identify the a device. Can be used to match a connection to a -particular device. -

-

Since 1.20

-
-
-
-

The "OperatorCode" property

-
-OperatorCode  readable   s
-
-

-The MCC and MNC (concatenated) of the network the modem is connected to. -Blank if disconnected or not a 3GPP modem. -

-

Since 1.20

-
-
-
-

The "Apn" property

-
-Apn  readable   s
-
-

-The access point name the modem is connected to. Blank if disconnected. -

-

Since 1.20

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html deleted file mode 100644 index 1fac4edf..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OlpcMesh.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.OlpcMesh: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.OlpcMesh

-

org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device.

-
-
-

Properties

-
-HwAddress      readable   s
-Companion      readable   o
-ActiveChannel  readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-

The "Companion" property

-
-Companion  readable   o
-
-

-The object path of the companion device. -

-
-
-
-

The "ActiveChannel" property

-
-ActiveChannel  readable   u
-
-

-The currently active channel. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html deleted file mode 100644 index 12fa1ac1..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsBridge.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.OvsBridge: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.OvsBridge

-

org.freedesktop.NetworkManager.Device.OvsBridge — OvsBridge Device.

-
-
-

Properties

-
-Slaves  readable   ao
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Slaves" property

-
-Slaves  readable   ao
-
-

-DEPRECATED. Use the "Ports" property in -"org.freedesktop.NetworkManager.Device" instead which exists since -version NetworkManager 1.34.0. -

-

Since 1.14

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html deleted file mode 100644 index 4928e07d..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsInterface.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.OvsInterface: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.OvsInterface

-

org.freedesktop.NetworkManager.Device.OvsInterface — OvsInterface Device.

-
-
-

Description

-

-

-

-

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html deleted file mode 100644 index 429466b3..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.OvsPort.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.OvsPort: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.OvsPort

-

org.freedesktop.NetworkManager.Device.OvsPort — OvsPort Device.

-
-
-

Properties

-
-Slaves  readable   ao
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Slaves" property

-
-Slaves  readable   ao
-
-

-DEPRECATED. Use the "Ports" property in -"org.freedesktop.NetworkManager.Device" instead which exists since -version NetworkManager 1.34.0. -

-

Since 1.14

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html deleted file mode 100644 index 8b8fc2ad..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Ppp.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Ppp: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Ppp

-

org.freedesktop.NetworkManager.Device.Ppp — PPP Device.

-
-
-

Description

-

-

-

-

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html deleted file mode 100644 index 22f8304c..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Statistics.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Statistics: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Statistics

-

org.freedesktop.NetworkManager.Device.Statistics — Device Statistic Counters.

-
-
-

Properties

-
-RefreshRateMs  readwrite  u
-TxBytes        readable   t
-RxBytes        readable   t
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "RefreshRateMs" property

-
-RefreshRateMs  readwrite  u
-
-

-Refresh rate of the rest of properties of this interface. The properties -are guaranteed to be refreshed each RefreshRateMs milliseconds in case -the underlying counter has changed too. -If zero, there is no guaranteed refresh rate of the properties. -

-
-
-
-

The "TxBytes" property

-
-TxBytes  readable   t
-
-

-Number of transmitted bytes -

-
-
-
-

The "RxBytes" property

-
-RxBytes  readable   t
-
-

-Number of received bytes -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html deleted file mode 100644 index 00c48e0b..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Team.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Team: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Team

-

org.freedesktop.NetworkManager.Device.Team — Teaming Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Carrier    readable   b
-Slaves     readable   ao
-Config     readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "lower-up" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-

The "Slaves" property

-
-Slaves  readable   ao
-
-

-DEPRECATED. Use the "Ports" property in -"org.freedesktop.NetworkManager.Device" instead which exists since -version NetworkManager 1.34.0. -

-
-
-
-

The "Config" property

-
-Config  readable   s
-
-

-The JSON configuration currently applied on the device. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html deleted file mode 100644 index 4190d659..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Tun.html +++ /dev/null @@ -1,134 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Tun: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Tun

-

org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device.

-
-
-

Properties

-
-Owner       readable   x
-Group       readable   x
-Mode        readable   s
-NoPi        readable   b
-VnetHdr     readable   b
-MultiQueue  readable   b
-HwAddress   readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Owner" property

-
-Owner  readable   x
-
-

-The uid of the tunnel owner, or -1 if it has no owner. -

-
-
-
-

The "Group" property

-
-Group  readable   x
-
-

-The gid of the tunnel group, or -1 if it has no owner. -

-
-
-
-

The "Mode" property

-
-Mode  readable   s
-
-

-The tunnel mode, either "tun" or "tap". -

-
-
-
-

The "NoPi" property

-
-NoPi  readable   b
-
-

-The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to -the tunnel packets. -

-
-
-
-

The "VnetHdr" property

-
-VnetHdr  readable   b
-
-

-The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a -virtio network header. -

-
-
-
-

The "MultiQueue" property

-
-MultiQueue  readable   b
-
-

-The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap -device multiple times, for multiple send/receive queues. -

-
-
-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html deleted file mode 100644 index 81aa95a5..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Veth.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Veth: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Veth

-

org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device.

-
-
-

Properties

-
-Peer  readable   o
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Peer" property

-
-Peer  readable   o
-
-

-The object path of the device's peer. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html deleted file mode 100644 index 6fc275e3..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vlan.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Vlan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Vlan

-

org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device.

-
-
-

Properties

-
-HwAddress  readable   s
-Carrier    readable   b
-Parent     readable   o
-VlanId     readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-

The "Parent" property

-
-Parent  readable   o
-
-

-Object path of the parent device of this VLAN device. -

-
-
-
-

The "VlanId" property

-
-VlanId  readable   u
-
-

-The VLAN ID of this VLAN interface. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html deleted file mode 100644 index 9c70d47f..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vrf.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Vrf: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Vrf

-

org.freedesktop.NetworkManager.Device.Vrf — VRF Device.

-
-
-

Properties

-
-Table  readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Table" property

-
-Table  readable   u
-
-

-The routing table of the VRF. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html deleted file mode 100644 index 662d8246..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Vxlan.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Vxlan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Vxlan

-

org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device.

-
-
-

Properties

-
-Parent      readable   o
-HwAddress   readable   s
-Id          readable   u
-Group       readable   s
-Local       readable   s
-Tos         readable   y
-Ttl         readable   y
-Learning    readable   b
-Ageing      readable   u
-Limit       readable   u
-DstPort     readable   q
-SrcPortMin  readable   q
-SrcPortMax  readable   q
-Proxy       readable   b
-Rsc         readable   b
-L2miss      readable   b
-L3miss      readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Parent" property

-
-Parent  readable   o
-
-

-The object path of the parent device (if the VXLAN is not purely internal -to this host). -

-
-
-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-

-

-

-
-
-
-

The "Id" property

-
-Id  readable   u
-
-

-The VXLAN Network Identifier (VNI). -

-
-
-
-

The "Group" property

-
-Group  readable   s
-
-

-The IP (v4 or v6) multicast group used to communicate with other physical -hosts on this VXLAN. -

-
-
-
-

The "Local" property

-
-Local  readable   s
-
-

-The local IPv4 or IPv6 address to use when sending VXLAN packets to other -physical hosts. -

-
-
-
-

The "Tos" property

-
-Tos  readable   y
-
-

-The value to use in the IP ToS field for VXLAN packets sent to other -physical hosts. -

-
-
-
-

The "Ttl" property

-
-Ttl  readable   y
-
-

-The value to use in the IP TTL field for VXLAN packets sent to other -physical hosts. -

-
-
-
-

The "Learning" property

-
-Learning  readable   b
-
-

-True if the VXLAN dynamically learns remote IP addresses. -

-
-
-
-

The "Ageing" property

-
-Ageing  readable   u
-
-

-The interval in seconds at which the kernel purges stale cached addresses. -

-
-
-
-

The "Limit" property

-
-Limit  readable   u
-
-

-The maximum number of entries that can be added to the VXLAN's forwarding -table. -

-
-
-
-

The "DstPort" property

-
-DstPort  readable   q
-
-

-Destination port for outgoing VXLAN packets. -

-
-
-
-

The "SrcPortMin" property

-
-SrcPortMin  readable   q
-
-

-The lowest source port number to use for outgoing VXLAN packets. -

-
-
-
-

The "SrcPortMax" property

-
-SrcPortMax  readable   q
-
-

-The highest source port number to use for outgoing VXLAN packets. -

-
-
-
-

The "Proxy" property

-
-Proxy  readable   b
-
-

-True if the VXLAN is implementing DOVE ARP proxying for remote clients. -

-
-
-
-

The "Rsc" property

-
-Rsc  readable   b
-
-

-True if the VXLAN is implementing DOVE route short-circuiting of known -remote IP addresses. -

-
-
-
-

The "L2miss" property

-
-L2miss  readable   b
-
-

-True if the VXLAN will emit netlink notifications of L2 switch misses. -

-
-
-
-

The "L3miss" property

-
-L3miss  readable   b
-
-

-True if the VXLAN will emit netlink notifications of L3 switch misses. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html deleted file mode 100644 index 2b970d21..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.WifiP2P: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.WifiP2P

-

org.freedesktop.NetworkManager.Device.WifiP2P — Wi-Fi P2P Device.

-
-
-

Methods

-
-StartFind (IN  a{sv} options);
-StopFind  ();
-
-
-
-

Signals

-
-PeerAdded   (o peer);
-PeerRemoved (o peer);
-
-
-
-

Properties

-
-HwAddress  readable   s
-Peers      readable   ao
-
-
-
-

Description

-

-

-

-

-

Since 1.16

-
-
-

Method Details

-
-

The StartFind() method

-
-StartFind (IN  a{sv} options);
-
-

-Start a find operation for Wi-Fi P2P peers. -

-

-The options argument accepts the following keys: -

-

-

-
---- - - - - -

i timeout:

 -

Timeout value in the range of 1-600 seconds.

-

The default is 30 seconds.

-
-

-

-
---- - - - - -

IN a{sv} options:

-Options of find. -

-

Since 1.16

-
-
-
-

The StopFind() method

-
-StopFind ();
-
-

-Stop an ongoing find operation again. -

-

Since 1.16

-
-
-
-

Signal Details

-
-

The "PeerAdded" signal

-
-PeerAdded (o peer);
-
-

-Emitted when a new Wi-Fi P2P peer is found by the device. -

-
---- - - - - -

o peer:

-The object path of the newly found access point. -

-

Since 1.16

-
-
-
-

The "PeerRemoved" signal

-
-PeerRemoved (o peer);
-
-

-Emitted when a Wi-Fi P2P peer disappears from view of the device. -

-
---- - - - - -

o peer:

-The object path of the Wi-Fi P2P peer that has disappeared. -

-

Since 1.16

-
-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The active hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-

Since 1.16

-
-
-
-

The "Peers" property

-
-Peers  readable   ao
-
-

-List of object paths of peers visible to this Wi-Fi P2P device. -

-

Since 1.16

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html deleted file mode 100644 index 440eb05a..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.WireGuard.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.WireGuard: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.WireGuard

-

org.freedesktop.NetworkManager.Device.WireGuard — WireGuard Device.

-
-
-

Properties

-
-PublicKey   readable   ay
-ListenPort  readable   q
-FwMark      readable   u
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "PublicKey" property

-
-PublicKey  readable   ay
-
-

-32-byte public WireGuard key. -

-
-
-
-

The "ListenPort" property

-
-ListenPort  readable   q
-
-

-Local UDP listening port. -

-
-
-
-

The "FwMark" property

-
-FwMark  readable   u
-
-

-Optional 32-bit mark used to set routing policy for outgoing encrypted packets. -See: ip-rule(8) -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html deleted file mode 100644 index 2be8b474..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wired.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Wired: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Wired

-

org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device.

-
-
-

Properties

-
-HwAddress        readable   s
-PermHwAddress    readable   s
-Speed            readable   u
-S390Subchannels  readable   as
-Carrier          readable   b
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-Active hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-

The "PermHwAddress" property

-
-PermHwAddress  readable   s
-
-

-Permanent hardware address of the device. -

-
-
-
-

The "Speed" property

-
-Speed  readable   u
-
-

-Design speed of the device, in megabits/second (Mb/s). -

-
-
-
-

The "S390Subchannels" property

-
-S390Subchannels  readable   as
-
-

-Array of S/390 subchannels for S/390 or z/Architecture devices. -

-
-
-
-

The "Carrier" property

-
-Carrier  readable   b
-
-

-Indicates whether the physical carrier is found (e.g. whether a cable is -plugged in or not). -

-

-DEPRECATED: check for the "carrier" flag in the "InterfaceFlags" -property on the "org.freedesktop.NetworkManager.Device" interface. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html deleted file mode 100644 index 180aca23..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wireless.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Wireless: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Wireless

-

org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device.

-
-
-

Methods

-
-GetAccessPoints    (OUT ao    access_points);
-GetAllAccessPoints (OUT ao    access_points);
-RequestScan        (IN  a{sv} options);
-
-
-
-

Signals

-
-AccessPointAdded   (o access_point);
-AccessPointRemoved (o access_point);
-
-
-
-

Properties

-
-HwAddress             readable   s
-PermHwAddress         readable   s
-Mode                  readable   u
-Bitrate               readable   u
-AccessPoints          readable   ao
-ActiveAccessPoint     readable   o
-WirelessCapabilities  readable   u
-LastScan              readable   x
-
-
-
-

Description

-

-

-

-

-
-
-

Method Details

-
-

The GetAccessPoints() method

-
-GetAccessPoints (OUT ao access_points);
-
-

-DEPRECATED. Get the list of access points visible to this device. Note -that this list does not include access points which hide their SSID. To -retrieve a list of all access points (including hidden ones) use the -GetAllAccessPoints() method. -

-
---- - - - - -

OUT ao access_points:

-List of access point object paths. -

-
-
-
-

The GetAllAccessPoints() method

-
-GetAllAccessPoints (OUT ao access_points);
-
-

-Get the list of all access points visible to this device, including hidden -ones for which the SSID is not yet known. -

-
---- - - - - -

OUT ao access_points:

-List of access point object paths. -

-
-
-
-

The RequestScan() method

-
-RequestScan (IN  a{sv} options);
-
-

-Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property. -

-
---- - - - - -

IN a{sv} options:

-Options of scan. Currently, 'ssids' option with value of "aay" type is supported. -

-
-
-
-

Signal Details

-
-

The "AccessPointAdded" signal

-
-AccessPointAdded (o access_point);
-
-

-Emitted when a new access point is found by the device. -

-
---- - - - - -

o access_point:

-The object path of the newly found access point. -

-
-
-
-

The "AccessPointRemoved" signal

-
-AccessPointRemoved (o access_point);
-
-

-Emitted when an access point disappears from view of the device. -

-
---- - - - - -

o access_point:

-The object path of the access point that has disappeared. -

-
-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The active hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-

The "PermHwAddress" property

-
-PermHwAddress  readable   s
-
-

-The permanent hardware address of the device. -

-
-
-
-

The "Mode" property

-
-Mode  readable   u
-
-

-The operating mode of the wireless device. -

-

-Returns: NM80211Mode -

-
-
-
-

The "Bitrate" property

-
-Bitrate  readable   u
-
-

-The bit rate currently used by the wireless device, in kilobits/second -(Kb/s). -

-
-
-
-

The "AccessPoints" property

-
-AccessPoints  readable   ao
-
-

-List of object paths of access point visible to this wireless device. -

-
-
-
-

The "ActiveAccessPoint" property

-
-ActiveAccessPoint  readable   o
-
-

-Object path of the access point currently used by the wireless device. -

-
-
-
-

The "WirelessCapabilities" property

-
-WirelessCapabilities  readable   u
-
-

-The capabilities of the wireless device. -

-

-Returns: NMDeviceWifiCapabilities -

-
-
-
-

The "LastScan" property

-
-LastScan  readable   x
-
-

-The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. -A value of -1 means the device never scanned for access points. -

-

Since 1.12

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html deleted file mode 100644 index 3d80ae43..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.Wpan.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device.Wpan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device.Wpan

-

org.freedesktop.NetworkManager.Device.Wpan — IEEE 802.15.4 (WPAN) MAC Layer Device.

-
-
-

Properties

-
-HwAddress  readable   s
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The active hardware address of the device. -

-

-DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html deleted file mode 100644 index 6a1d4275..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Device.html +++ /dev/null @@ -1,696 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Device: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Device

-

org.freedesktop.NetworkManager.Device — Device.

-
-
-

Methods

-
-Reapply              (IN  a{sa{sv}} connection,
-                      IN  t         version_id,
-                      IN  u         flags);
-GetAppliedConnection (IN  u         flags,
-                      OUT a{sa{sv}} connection,
-                      OUT t         version_id);
-Disconnect           ();
-Delete               ();
-
-
-
-

Signals

-
-StateChanged (u new_state,
-              u old_state,
-              u reason);
-
-
-
-

Properties

-
-Udi                   readable   s
-Path                  readable   s
-Interface             readable   s
-IpInterface           readable   s
-Driver                readable   s
-DriverVersion         readable   s
-FirmwareVersion       readable   s
-Capabilities          readable   u
-Ip4Address            readable   u
-State                 readable   u
-StateReason           readable   (uu)
-ActiveConnection      readable   o
-Ip4Config             readable   o
-Dhcp4Config           readable   o
-Ip6Config             readable   o
-Dhcp6Config           readable   o
-Managed               readwrite  b
-Autoconnect           readwrite  b
-FirmwareMissing       readable   b
-NmPluginMissing       readable   b
-DeviceType            readable   u
-AvailableConnections  readable   ao
-PhysicalPortId        readable   s
-Mtu                   readable   u
-Metered               readable   u
-LldpNeighbors         readable   aa{sv}
-Real                  readable   b
-Ip4Connectivity       readable   u
-Ip6Connectivity       readable   u
-InterfaceFlags        readable   u
-HwAddress             readable   s
-Ports                 readable   ao
-
-
-
-

Description

-

-

-

-

-
-
-

Method Details

-
-

The Reapply() method

-
-Reapply (IN  a{sa{sv}} connection,
-         IN  t         version_id,
-         IN  u         flags);
-
-

-Attempts to update the configuration of a device without deactivating it. -NetworkManager has the concept of connections, which are profiles that -contain the configuration for a networking device. Those connections are -exposed via D-Bus as individual objects that can be created, modified and -deleted. When activating such a settings-connection on a device, the -settings-connection is cloned to become an applied-connection and used to -configure the device (see GetAppliedConnection). Subsequent modification -of the settings-connection don't propagate automatically to the device's -applied-connection (with exception of the firewall-zone and the metered -property). For the changes to take effect, you can either re-activate the -settings-connection, or call Reapply. The Reapply call allows you to -directly update the applied-connection and reconfigure the device. Reapply -can also be useful if the currently applied-connection is equal to the -connection that is about to be reapplied. This allows to reconfigure the -device and revert external changes like removing or adding an IP address -(which NetworkManager doesn't revert automatically because it is assumed -that the user made these changes intentionally outside of NetworkManager). -Reapply can make the applied-connection different from the -settings-connection, just like updating the settings-connection can make -them different. -

-

-Since 1.42, "preserve-external-ip" flag (0x1) is supported to not remove -externally added IP addresses and routes on the device during reapply. -

-
---- - - - - - - - - - - - - - - -

IN a{sa{sv}} connection:

-The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarily differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. -

IN t version_id:

-If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. -

IN u flags:

-Flags which would modify the behavior of the Reapply call. Invalid flags are rejected. -

-
-
-
-

The GetAppliedConnection() method

-
-GetAppliedConnection (IN  u         flags,
-                      OUT a{sa{sv}} connection,
-                      OUT t         version_id);
-
-

-Get the currently applied connection on the device. This is a snapshot of -the last activated connection on the device, that is the configuration -that is currently applied on the device. Usually this is the same as -GetSettings of the referenced settings connection. However, it can differ -if the settings connection was subsequently modified or the applied -connection was modified by Reapply. The applied connection is set when -activating a device or when calling Reapply. -

-
---- - - - - - - - - - - - - - - -

IN u flags:

-Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0. -

OUT a{sa{sv}} connection:

-The effective connection settings that the connection has currently applied. -

OUT t version_id:

-The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail. -

-
-
-
-

The Disconnect() method

-
-Disconnect ();
-
-

-Disconnects a device and prevents the device from automatically activating -further connections without user intervention. -

-
-
-
-

The Delete() method

-
-Delete ();
-
-

-Deletes a software device from NetworkManager and removes the interface -from the system. The method returns an error when called for a hardware -device. -

-
-
-
-

Signal Details

-
-

The "StateChanged" signal

-
-StateChanged (u new_state,
-              u old_state,
-              u reason);
-
-

-

-

-

-
---- - - - - - - - - - - - - - - -

u new_state:

-(NMDeviceState) The new state of the device. -

u old_state:

-(NMDeviceState) The previous state of the device. -

u reason:

-(NMDeviceStateReason) A reason for the state transition. -

-
-
-
-

Property Details

-
-

The "Udi" property

-
-Udi  readable   s
-
-

-Operating-system specific transient device hardware identifier. This is an -opaque string representing the underlying hardware for the device, and -shouldn't be used to keep track of individual devices. For some device -types (Bluetooth, Modems) it is an identifier used by the hardware service -(ie bluez or ModemManager) to refer to that device, and client programs -use it get additional information from those services which NM does not -provide. The Udi is not guaranteed to be consistent across reboots or -hotplugs of the hardware. If you're looking for a way to uniquely track -each device in your application, use the object path. If you're looking -for a way to track a specific piece of hardware across reboot or hotplug, -use a MAC address or USB serial number. -

-

-Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() -to obtain the true (non-UTF-8) string. -

-
-
-
-

The "Path" property

-
-Path  readable   s
-
-

-The path of the device as exposed by the udev property ID_PATH. -

-

-Note that non-UTF-8 characters are backslash escaped. Use g_strcompress() -to obtain the true (non-UTF-8) string. -

-
-
-
-

The "Interface" property

-
-Interface  readable   s
-
-

-The name of the device's control (and often data) interface. -Note that non UTF-8 characters are backslash escaped, so the -resulting name may be longer then 15 characters. Use g_strcompress() -to revert the escaping. -

-
-
-
-

The "IpInterface" property

-
-IpInterface  readable   s
-
-

-The name of the device's data interface when available. This property may -not refer to the actual data interface until the device has successfully -established a data connection, indicated by the device's State becoming -ACTIVATED. -Note that non UTF-8 characters are backslash escaped, so the -resulting name may be longer then 15 characters. Use g_strcompress() -to revert the escaping. -

-
-
-
-

The "Driver" property

-
-Driver  readable   s
-
-

-The driver handling the device. -Non-UTF-8 sequences are backslash escaped. Use g_strcompress() -to revert. -

-
-
-
-

The "DriverVersion" property

-
-DriverVersion  readable   s
-
-

-The version of the driver handling the device. -Non-UTF-8 sequences are backslash escaped. Use g_strcompress() -to revert. -

-
-
-
-

The "FirmwareVersion" property

-
-FirmwareVersion  readable   s
-
-

-The firmware version for the device. -Non-UTF-8 sequences are backslash escaped. Use g_strcompress() -to revert. -

-
-
-
-

The "Capabilities" property

-
-Capabilities  readable   u
-
-

-Flags describing the capabilities of the device. -

-

-Returns: NMDeviceCapabilities -

-
-
-
-

The "Ip4Address" property

-
-Ip4Address  readable   u
-
-

-DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object -instead. This property always returns 0.0.0.0 (numeric 0) as address. -

-
-
-
-

The "State" property

-
-State  readable   u
-
-

-The current state of the device. -

-

-Returns: NMDeviceState -

-
-
-
-

The "StateReason" property

-
-StateReason  readable   (uu)
-
-

-The current state and reason for changing to that state. -

-

-Returns: A tuple of NMDeviceState and NMDeviceStateReason. -

-
-
-
-

The "ActiveConnection" property

-
-ActiveConnection  readable   o
-
-

-Object path of an ActiveConnection object that "owns" this device during -activation. The ActiveConnection object tracks the life-cycle of a -connection to a specific network and implements the -org.freedesktop.NetworkManager.Connection.Active D-Bus interface. -

-
-
-
-

The "Ip4Config" property

-
-Ip4Config  readable   o
-
-

-Object path of the Ip4Config object describing the configuration of the -device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED -state. -

-
-
-
-

The "Dhcp4Config" property

-
-Dhcp4Config  readable   o
-
-

-Object path of the Dhcp4Config object describing the DHCP options returned -by the DHCP server. Only valid when the device is in the -NM_DEVICE_STATE_ACTIVATED state. -

-
-
-
-

The "Ip6Config" property

-
-Ip6Config  readable   o
-
-

-Object path of the Ip6Config object describing the configuration of the -device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED -state. -

-
-
-
-

The "Dhcp6Config" property

-
-Dhcp6Config  readable   o
-
-

-Object path of the Dhcp6Config object describing the DHCP options returned -by the DHCP server. Only valid when the device is in the -NM_DEVICE_STATE_ACTIVATED state. -

-
-
-
-

The "Managed" property

-
-Managed  readwrite  b
-
-

-Whether or not this device is managed by NetworkManager. Setting this -property has a similar effect to configuring the device as unmanaged via -the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to -this value are not persistent and lost after NetworkManager restart. -

-
-
-
-

The "Autoconnect" property

-
-Autoconnect  readwrite  b
-
-

-If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual -intervention is required before the device will automatically connect to a -known network, such as activating a connection using the device, or -setting this property to TRUE. This property cannot be set to TRUE for -default-unmanaged devices, since they never autoconnect. -

-
-
-
-

The "FirmwareMissing" property

-
-FirmwareMissing  readable   b
-
-

-If TRUE, indicates the device is likely missing firmware necessary for its -operation. -

-
-
-
-

The "NmPluginMissing" property

-
-NmPluginMissing  readable   b
-
-

-If TRUE, indicates the NetworkManager plugin for the device is likely -missing or misconfigured. -

-
-
-
-

The "DeviceType" property

-
-DeviceType  readable   u
-
-

-The general type of the network device; ie Ethernet, Wi-Fi, etc. -

-

-Returns: NMDeviceType -

-
-
-
-

The "AvailableConnections" property

-
-AvailableConnections  readable   ao
-
-

-An array of object paths of every configured connection that is currently -'available' through this device. -

-
-
-
-

The "PhysicalPortId" property

-
-PhysicalPortId  readable   s
-
-

-If non-empty, an (opaque) indicator of the physical network port -associated with the device. This can be used to recognize when two -seemingly-separate hardware devices are actually just different virtual -interfaces to the same physical port. -

-
-
-
-

The "Mtu" property

-
-Mtu  readable   u
-
-

-The device MTU (maximum transmission unit). -

-
-
-
-

The "Metered" property

-
-Metered  readable   u
-
-

-Whether the amount of traffic flowing through the device is subject to -limitations, for example set by service providers. -

-

-Returns: NMMetered -

-
-
-
-

The "LldpNeighbors" property

-
-LldpNeighbors  readable   aa{sv}
-
-

-Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV -names to variant boxed values. -

-
-
-
-

The "Real" property

-
-Real  readable   b
-
-

-True if the device exists, or False for placeholder devices that do not -yet exist but could be automatically created by NetworkManager if one of -their AvailableConnections was activated. -

-
-
-
-

The "Ip4Connectivity" property

-
-Ip4Connectivity  readable   u
-
-

-The result of the last IPv4 connectivity check. -

-

-Returns: NMConnectivityState -

-

Since 1.16

-
-
-
-

The "Ip6Connectivity" property

-
-Ip6Connectivity  readable   u
-
-

-The result of the last IPv6 connectivity check. -

-

-Returns: NMConnectivityState -

-

Since 1.16

-
-
-
-

The "InterfaceFlags" property

-
-InterfaceFlags  readable   u
-
-

-The flags of the network interface. See -NMDeviceInterfaceFlags for -the currently defined flags. -

-

Since 1.22

-
-
-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The hardware address of the device. -

-

-This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces. -

-

Since 1.24

-
-
-
-

The "Ports" property

-
-Ports  readable   ao
-
-

-The port devices of the controller device. -

-

-Array of object paths representing devices which are currently set as -port of this device. This replaces the 'Slaves' properties on the -device-specific D-Bus interfaces. -

-

Since 1.34

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html deleted file mode 100644 index 692eb068..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.DnsManager.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -org.freedesktop.NetworkManager.DnsManager: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.DnsManager

-

org.freedesktop.NetworkManager.DnsManager — DNS Configuration State.

-
-
-

Properties

-
-Mode           readable   s
-RcManager      readable   s
-Configuration  readable   aa{sv}
-
-
-
-

Description

-

-The interface contains DNS-related information. -

-
-
-

Property Details

-
-

The "Mode" property

-
-Mode  readable   s
-
-

-The current DNS processing mode. -

-
-
-
-

The "RcManager" property

-
-RcManager  readable   s
-
-

-The current resolv.conf management mode. -

-
-
-
-

The "Configuration" property

-
-Configuration  readable   aa{sv}
-
-

-The current DNS configuration represented as an array of -dictionaries. Each dictionary has the "nameservers", -"priority" keys and, optionally, "interface" and "vpn". -"nameservers" is the list of DNS servers, "priority" their -relative priority, "interface" the interface on which these -servers are contacted, "vpn" a boolean telling whether the -configuration was obtained from a VPN connection. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html deleted file mode 100644 index 6f1d909d..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP4Config.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - -org.freedesktop.NetworkManager.IP4Config: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.IP4Config

-

org.freedesktop.NetworkManager.IP4Config — IPv4 Configuration Set.

-
-
-

Properties

-
-Addresses       readable   aau
-AddressData     readable   aa{sv}
-Gateway         readable   s
-Routes          readable   aau
-RouteData       readable   aa{sv}
-Nameservers     readable   au
-NameserverData  readable   aa{sv}
-Domains         readable   as
-Searches        readable   as
-DnsOptions      readable   as
-DnsPriority     readable   i
-WinsServers     readable   au
-WinsServerData  readable   as
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Addresses" property

-
-Addresses  readable   aau
-
-

-Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each -array are in network byte order. Essentially: [(addr, prefix, gateway), -(addr, prefix, gateway), ...]. -

-

-DEPRECATED: use AddressData and Gateway -

-
-
-
-

The "AddressData" property

-
-AddressData  readable   aa{sv}
-
-

-Array of IP address data objects. All addresses will include "address" (an -IP address string), and "prefix" (a uint). Some addresses may include -additional attributes. -

-
-
-
-

The "Gateway" property

-
-Gateway  readable   s
-
-

-The gateway in use. -

-
-
-
-

The "Routes" property

-
-Routes  readable   aau
-
-

-Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of each tuple -are in network byte order. 'route' and 'next hop' are IPv4 addresses, -while prefix and metric are simple unsigned integers. Essentially: -[(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), -...]. -

-

-DEPRECATED: use RouteData -

-
-
-
-

The "RouteData" property

-
-RouteData  readable   aa{sv}
-
-

-Array of IP route data objects. All routes will include "dest" (an IP -address string) and "prefix" (a uint). Some routes may include "next-hop" -(an IP address string), "metric" (a uint), and additional attributes. -

-
-
-
-

The "Nameservers" property

-
-Nameservers  readable   au
-
-

-The nameservers in use. -

-

-DEPRECATED: use NameserverData -

-
-
-
-

The "NameserverData" property

-
-NameserverData  readable   aa{sv}
-
-

-The nameservers in use. Currently, only the value "address" -is recognized (with an IP address string). -

-

Since 1.14

-
-
-
-

The "Domains" property

-
-Domains  readable   as
-
-

-A list of domains this address belongs to. -

-
-
-
-

The "Searches" property

-
-Searches  readable   as
-
-

-A list of dns searches. -

-
-
-
-

The "DnsOptions" property

-
-DnsOptions  readable   as
-
-

-A list of DNS options that modify the behavior of the DNS resolver. See -resolv.conf(5) manual page for the list of supported options. -

-
-
-
-

The "DnsPriority" property

-
-DnsPriority  readable   i
-
-

-The relative priority of DNS servers. -

-
-
-
-

The "WinsServers" property

-
-WinsServers  readable   au
-
-

-The Windows Internet Name Service servers associated with the connection. -Each address is in network byte order. -

-

-DEPRECATED: use WinsServerData -

-
-
-
-

The "WinsServerData" property

-
-WinsServerData  readable   as
-
-

-The Windows Internet Name Service servers associated with the connection. -

-

Since 1.14

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html deleted file mode 100644 index a02eb2fa..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.IP6Config.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - -org.freedesktop.NetworkManager.IP6Config: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.IP6Config

-

org.freedesktop.NetworkManager.IP6Config — IPv6 Configuration Set.

-
-
-

Properties

-
-Addresses    readable   a(ayuay)
-AddressData  readable   aa{sv}
-Gateway      readable   s
-Routes       readable   a(ayuayu)
-RouteData    readable   aa{sv}
-Nameservers  readable   aay
-Domains      readable   as
-Searches     readable   as
-DnsOptions   readable   as
-DnsPriority  readable   i
-
-
-
-

Description

-

-

-

-

-
-
-

Property Details

-
-

The "Addresses" property

-
-Addresses  readable   a(ayuay)
-
-

-Array of tuples of IPv6 address/prefix/gateway. -

-

-DEPRECATED: use AddressData and Gateway. -

-
-
-
-

The "AddressData" property

-
-AddressData  readable   aa{sv}
-
-

-Array of IP address data objects. All addresses will include "address" (an -IP address string), and "prefix" (a uint). Some addresses may include -additional attributes. -

-
-
-
-

The "Gateway" property

-
-Gateway  readable   s
-
-

-The gateway in use. -

-
-
-
-

The "Routes" property

-
-Routes  readable   a(ayuayu)
-
-

-Tuples of IPv6 route/prefix/next-hop/metric. -

-

-DEPRECATED: use RouteData. -

-
-
-
-

The "RouteData" property

-
-RouteData  readable   aa{sv}
-
-

-Array of IP route data objects. All routes will include "dest" (an IP -address string) and "prefix" (a uint). Some routes may include "next-hop" -(an IP address string), "metric" (a uint), and additional attributes. -

-
-
-
-

The "Nameservers" property

-
-Nameservers  readable   aay
-
-

-The nameservers in use. -

-
-
-
-

The "Domains" property

-
-Domains  readable   as
-
-

-A list of domains this address belongs to. -

-
-
-
-

The "Searches" property

-
-Searches  readable   as
-
-

-A list of dns searches. -

-
-
-
-

The "DnsOptions" property

-
-DnsOptions  readable   as
-
-

-A list of DNS options that modify the behavior of the DNS resolver. See -resolv.conf(5) manual page for the list of supported options. -

-
-
-
-

The "DnsPriority" property

-
-DnsPriority  readable   i
-
-

-The relative priority of DNS servers. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html deleted file mode 100644 index 1ed0b601..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.PPP.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - -org.freedesktop.NetworkManager.PPP: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.PPP

-

org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin.

-
-
-

Methods

-
-NeedSecrets  (OUT s     username,
-              OUT s     password);
-SetIp4Config (IN  a{sv} config);
-SetIp6Config (IN  a{sv} config);
-SetState     (IN  u     state);
-SetIfindex   (IN  i     ifindex);
-
-
-
-

Description

-

-

-

-

-
-
-

Method Details

-
-

The NeedSecrets() method

-
-NeedSecrets (OUT s username,
-             OUT s password);
-
-

-

-

-

-
---- - - - - - - - - - - -

OUT s username:

 -

-

-

-

-

OUT s password:

 -

-

-

-

-
-
-
-
-

The SetIp4Config() method

-
-SetIp4Config (IN  a{sv} config);
-
-

-

-

-

-
---- - - - - -

IN a{sv} config:

 -

-

-

-

-
-
-
-
-

The SetIp6Config() method

-
-SetIp6Config (IN  a{sv} config);
-
-

-

-

-

-
---- - - - - -

IN a{sv} config:

 -

-

-

-

-
-
-
-
-

The SetState() method

-
-SetState (IN  u state);
-
-

-

-

-

-
---- - - - - -

IN u state:

 -

-

-

-

-
-
-
-
-

The SetIfindex() method

-
-SetIfindex (IN  i ifindex);
-
-

-

-

-

-
---- - - - - -

IN i ifindex:

 -

-

-

-

-
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html deleted file mode 100644 index 51a3578c..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - -org.freedesktop.NetworkManager.SecretAgent: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.SecretAgent

-

org.freedesktop.NetworkManager.SecretAgent — User Secret Agent.

-
-
-

Methods

-
-GetSecrets       (IN  a{sa{sv}} connection,
-                  IN  o         connection_path,
-                  IN  s         setting_name,
-                  IN  as        hints,
-                  IN  u         flags,
-                  OUT a{sa{sv}} secrets);
-CancelGetSecrets (IN  o         connection_path,
-                  IN  s         setting_name);
-SaveSecrets      (IN  a{sa{sv}} connection,
-                  IN  o         connection_path);
-DeleteSecrets    (IN  a{sa{sv}} connection,
-                  IN  o         connection_path);
-
-
-
-

Description

-

-Private D-Bus interface used by secret agents that store and provide -secrets to NetworkManager. If an agent provides secrets to NetworkManager -as part of connection creation, and the some of those secrets are "agent -owned" the agent should store those secrets itself and should not expect -its SaveSecrets() method to be called. SaveSecrets() will be called eg if -some program other than the agent itself (like a connection editor) -changes the secrets out of band. The agent should implement this D-Bus -interface on an object with the path -/org/freedesktop/NetworkManager/SecretAgent. -

-
-
-

Method Details

-
-

The GetSecrets() method

-
-GetSecrets (IN  a{sa{sv}} connection,
-            IN  o         connection_path,
-            IN  s         setting_name,
-            IN  as        hints,
-            IN  u         flags,
-            OUT a{sa{sv}} secrets);
-
-

-Retrieve and return stored secrets, if any, or request new secrets from -the agent's user. If user interaction is allowed and the user enters new -secrets, the agent is expected to save the new secrets to persistent -storage (if the secret's flags include AGENT_OWNED) as NetworkManager will -not send these secrets back to the same agent via a SaveSecrets() call. If -the user canceled any interaction, the agent should return the -UserCanceled error (see below). -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

IN a{sa{sv}} connection:

-Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction. -

IN o connection_path:

-Object path of the connection for which secrets are being requested. -

IN s setting_name:

-Setting name for which secrets are being requested. -

IN as hints:

-Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:". -

IN u flags:

-(NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user. -

OUT a{sa{sv}} secrets:

-Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets. -

-
-
-
-

The CancelGetSecrets() method

-
-CancelGetSecrets (IN  o connection_path,
-                  IN  s setting_name);
-
-

-Cancel a pending GetSecrets request for secrets of the given connection. -Any GetSecrets request with the same 'connection_path' and 'setting_name' -that are given in a CancelGetSecrets request should be canceled. -

-
---- - - - - - - - - - - -

IN o connection_path:

-Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. -

IN s setting_name:

-Setting name for which secrets for this connection were originally being requested. -

-
-
-
-

The SaveSecrets() method

-
-SaveSecrets (IN  a{sa{sv}} connection,
-             IN  o         connection_path);
-
-

-Save given secrets to backing storage. -

-
---- - - - - - - - - - - -

IN a{sa{sv}} connection:

-Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already. -

IN o connection_path:

-Object path of the connection for which the agent should save secrets to backing storage. -

-
-
-
-

The DeleteSecrets() method

-
-DeleteSecrets (IN  a{sa{sv}} connection,
-               IN  o         connection_path);
-
-

-Delete secrets from backing storage. -

-
---- - - - - - - - - - - -

IN a{sa{sv}} connection:

-Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. -

IN o connection_path:

-Object path of the connection for which the agent should delete secrets from backing storage. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html deleted file mode 100644 index b5e89291..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Settings.Connection: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Settings.Connection

-

org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile.

-
-
-

Methods

-
-Update        (IN  a{sa{sv}} properties);
-UpdateUnsaved (IN  a{sa{sv}} properties);
-Delete        ();
-GetSettings   (OUT a{sa{sv}} settings);
-GetSecrets    (IN  s         setting_name,
-               OUT a{sa{sv}} secrets);
-ClearSecrets  ();
-Save          ();
-Update2       (IN  a{sa{sv}} settings,
-               IN  u         flags,
-               IN  a{sv}     args,
-               OUT a{sv}     result);
-
-
-
-

Signals

-
-Updated ();
-Removed ();
-
-
-
-

Properties

-
-Unsaved   readable   b
-Flags     readable   u
-Filename  readable   s
-
-
-
-

Description

-

-Represents a single network connection configuration. -

-
-
-

Method Details

-
-

The Update() method

-
-Update (IN  a{sa{sv}} properties);
-
-

-Update the connection with new settings and properties (replacing all -previous settings and properties) and save the connection to disk. Secrets -may be part of the update request, and will be either stored in persistent -storage or sent to a Secret Agent for storage, depending on the flags -associated with each secret. -

-
---- - - - - -

IN a{sa{sv}} properties:

-New connection settings, properties, and (optionally) secrets. -

-
-
-
-

The UpdateUnsaved() method

-
-UpdateUnsaved (IN  a{sa{sv}} properties);
-
-

-Update the connection with new settings and properties (replacing all -previous settings and properties) but do not immediately save the -connection to disk. Secrets may be part of the update request and may sent -to a Secret Agent for storage, depending on the flags associated with each -secret. Use the 'Save' method to save these changes to disk. Note that -unsaved changes will be lost if the connection is reloaded from disk -(either automatically on file change or due to an explicit -ReloadConnections call). -

-
---- - - - - -

IN a{sa{sv}} properties:

-New connection settings, properties, and (optionally) secrets. -

-
-
-
-

The Delete() method

-
-Delete ();
-
-

-Delete the connection. -

-
-
-
-

The GetSettings() method

-
-GetSettings (OUT a{sa{sv}} settings);
-
-

-Get the settings maps describing this network configuration. This will -never include any secrets required for connection to the network, as those -are often protected. Secrets must be requested separately using the -GetSecrets() call. -

-
---- - - - - -

OUT a{sa{sv}} settings:

-The nested settings maps describing this object. -

-
-
-
-

The GetSecrets() method

-
-GetSecrets (IN  s         setting_name,
-            OUT a{sa{sv}} secrets);
-
-

-Get the secrets belonging to this network configuration. Only secrets from -persistent storage or a Secret Agent running in the requestor's session -will be returned. The user will never be prompted for secrets as a result -of this request. -

-
---- - - - - - - - - - - -

IN s setting_name:

-Name of the setting to return secrets for. If empty, all secrets will be returned. -

OUT a{sa{sv}} secrets:

-Nested settings maps containing secrets. -

-
-
-
-

The ClearSecrets() method

-
-ClearSecrets ();
-
-

-Clear the secrets belonging to this network connection profile. -

-
-
-
-

The Save() method

-
-Save ();
-
-

-Saves a "dirty" connection (that had previously been updated with -UpdateUnsaved) to persistent storage. -

-
-
-
-

The Update2() method

-
-Update2 (IN  a{sa{sv}} settings,
-         IN  u         flags,
-         IN  a{sv}     args,
-         OUT a{sv}     result);
-
-

-Update the connection with new settings and properties (replacing all -previous settings and properties). -

-

-Update2 is an alternative to -Update, -UpdateUnsaved -and Save -extensible with extra flags and args arguments. -

-

-The flags argument accepts the combination of following values, -logically or-ed together: -

-

-

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

0x1 (to-disk):

The connection is persisted to disk.

0x2 (in-memory):

The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only.

0x4 (in-memory-detached):

Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.

0x8 (in-memory-only):

Like "in-memory", but behaves slightly different when migrating - the profile from disk to in-memory.

0x10 (volatile):

0x20 (block-autoconnect):

Blocks auto-connect on the updated profile

0x40 (no-reapply):

Prevents "connection.zone" and "connection.metered" properties - to take effect on currently active devices.

-

-

-

-The args argument accepts the following keys: -

-

-

-
---- - - - - -

plugin:, version-id:

 -

The settings plugin the connection will be migrated to - such as "keyfile" or "ifcfg-rh".

-

Since 1.38

-

If specified, the update request is rejected if the - profile's version-id does not match. This can be used to catch concurrent - modifications. Zero means no version check.

-

Since 1.44

-
-

-

-

-Secrets may be part of the update request, and will be either stored in persistent -storage or sent to a Secret Agent for storage, depending on the flags -associated with each secret. -

-
---- - - - - - - - - - - - - - - - - - - -

IN a{sa{sv}} settings:

-New connection settings, properties, and (optionally) secrets. Provide an empty array to use the current settings. -

IN u flags:

-Optional flags. Unknown flags cause the call to fail. -

IN a{sv} args:

-Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. -

OUT a{sv} result:

-Currently no results are returned. -

-

Since 1.12

-
-
-
-

Signal Details

-
-

The "Updated" signal

-
-Updated ();
-
-

-Emitted when any settings or permissions change. When handling this -signal, clients should re-read the connection using the GetSettings method -to get the changes and to ensure the client still has permission to access -the connection. -

-
-
-
-

The "Removed" signal

-
-Removed ();
-
-

-Emitted when this connection is no longer available. This happens when the -connection is deleted or if it is no longer accessible by any of the -system's logged-in users. After receipt of this signal, the object no -longer exists. Also see the Settings.ConnectionRemoved signal. -

-
-
-
-

Property Details

-
-

The "Unsaved" property

-
-Unsaved  readable   b
-
-

-If set, indicates that the in-memory state of the connection does not -match the on-disk state. This flag will be set when UpdateUnsaved() is -called or when any connection details change, and cleared when the -connection is saved to disk via Save() or from internal operations. -

-
-
-
-

The "Flags" property

-
-Flags  readable   u
-
-

-Additional flags of the connection profile. -

-

-Returns: NMSettingsConnectionFlags -

-

Since 1.12

-
-
-
-

The "Filename" property

-
-Filename  readable   s
-
-

-File that stores the connection in case the connection is file-backed. -

-

Since 1.12

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html deleted file mode 100644 index a1ad3864..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - -org.freedesktop.NetworkManager.Settings: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.Settings

-

org.freedesktop.NetworkManager.Settings — Connection Settings Profile Manager.

-
-
-

Methods

-
-ListConnections      (OUT ao        connections);
-GetConnectionByUuid  (IN  s         uuid,
-                      OUT o         connection);
-AddConnection        (IN  a{sa{sv}} connection,
-                      OUT o         path);
-AddConnectionUnsaved (IN  a{sa{sv}} connection,
-                      OUT o         path);
-AddConnection2       (IN  a{sa{sv}} settings,
-                      IN  u         flags,
-                      IN  a{sv}     args,
-                      OUT o         path,
-                      OUT a{sv}     result);
-LoadConnections      (IN  as        filenames,
-                      OUT b         status,
-                      OUT as        failures);
-ReloadConnections    (OUT b         status);
-SaveHostname         (IN  s         hostname);
-
-
-
-

Signals

-
-NewConnection     (o connection);
-ConnectionRemoved (o connection);
-
-
-
-

Properties

-
-Connections  readable   ao
-Hostname     readable   s
-CanModify    readable   b
-VersionId    readable   t
-
-
-
-

Description

-

-The Settings interface allows clients to view and administrate the -connections stored and used by NetworkManager. -

-
-
-

Method Details

-
-

The ListConnections() method

-
-ListConnections (OUT ao connections);
-
-

-List the saved network connections known to NetworkManager. -

-
---- - - - - -

OUT ao connections:

-List of connections. -

-
-
-
-

The GetConnectionByUuid() method

-
-GetConnectionByUuid (IN  s uuid,
-                     OUT o connection);
-
-

-Retrieve the object path of a connection, given that connection's UUID. -

-
---- - - - - - - - - - - -

IN s uuid:

-The UUID to find the connection object path for. -

OUT o connection:

-The connection's object path. -

-
-
-
-

The AddConnection() method

-
-AddConnection (IN  a{sa{sv}} connection,
-               OUT o         path);
-
-

-Add new connection and save it to disk. This operation does not start the -network connection unless (1) device is idle and able to connect to the -network described by the new connection, and (2) the connection is allowed -to be started automatically. -

-
---- - - - - - - - - - - -

IN a{sa{sv}} connection:

-Connection settings and properties. -

OUT o path:

-Object path of the new connection that was just added. -

-
-
-
-

The AddConnectionUnsaved() method

-
-AddConnectionUnsaved (IN  a{sa{sv}} connection,
-                      OUT o         path);
-
-

-Add new connection but do not save it to disk immediately. This operation -does not start the network connection unless (1) device is idle and able -to connect to the network described by the new connection, and (2) the -connection is allowed to be started automatically. Use the 'Save' method -on the connection to save these changes to disk. -

-
---- - - - - - - - - - - -

IN a{sa{sv}} connection:

-Connection settings and properties. -

OUT o path:

-Object path of the new connection that was just added. -

-
-
-
-

The AddConnection2() method

-
-AddConnection2 (IN  a{sa{sv}} settings,
-                IN  u         flags,
-                IN  a{sv}     args,
-                OUT o         path,
-                OUT a{sv}     result);
-
-

-Add a new connection profile. -

-

-AddConnection2 is an alternative to -AddConnection and -AddConnectionUnsaved. -The new variant can do everything that the older variants could, and more. -Its behavior is extensible via extra flags and args arguments. -

-

-The flags argument accepts the combination of following values, -logically or-ed together: -

-

-

-
---- - - - - - - - - - - - - - - -

0x1 (to-disk):

The connection is persisted to disk.

0x2 (in-memory):

The change is only made in memory (without touching an eventual - profile on disk). If neither 0x1 nor 0x2 is set, the change is made in memory - only, if the connection is already in memory only.

0x20 (block-autoconnect):

Blocks auto-connect on the new profile

-

-

-

-The args argument accepts the following keys: -

-

-

-
---- - - - - -

plugin:

 -

The settings plugin the newly added connection will - use, such as "keyfile" or "ifcfg-rh".

-

Since 1.38

-
-

-

-

-Either the flags 0x1 (to-disk) or 0x2 (in-memory) must be specified. -The effect is whether to behave like -AddConnection or -AddConnectionUnsaved. -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

IN a{sa{sv}} settings:

-New connection settings, properties, and (optionally) secrets. -

IN u flags:

-Flags. Unknown flags cause the call to fail. -

IN a{sv} args:

-Optional arguments dictionary, for extentibility. Specifying unknown keys causes the call to fail. -

OUT o path:

-Object path of the new connection that was just added. -

OUT a{sv} result:

-Output argument, currently no additional results are returned. -

-

Since 1.20

-
-
-
-

The LoadConnections() method

-
-LoadConnections (IN  as filenames,
-                 OUT b  status,
-                 OUT as failures);
-
-

-Loads or reloads the indicated connections from disk. You should call this -after making changes directly to an on-disk connection file to make sure -that NetworkManager sees the changes. -As with AddConnection(), this operation does not necessarily -start the network connection. -

-

-Note that before 1.20, NetworkManager had a bug and this status value was wrong. -It is better to assume success if the method does not return with a D-Bus error. -On top of that, you can look at failures to know whether any of the requested files failed. -

-
---- - - - - - - - - - - - - - - -

IN as filenames:

-Array of paths to on-disk connection profiles in directories monitored by NetworkManager. -

OUT b status:

-Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied). -

OUT as failures:

-Paths of connection files that could not be loaded. -

-
-
-
-

The ReloadConnections() method

-
-ReloadConnections (OUT b status);
-
-

-Tells NetworkManager to reload all connection files from disk, including -noticing any added or deleted connection files. -

-
---- - - - - -

OUT b status:

-This always returns TRUE. -

-
-
-
-

The SaveHostname() method

-
-SaveHostname (IN  s hostname);
-
-

-Save the hostname to persistent configuration. -

-
---- - - - - -

IN s hostname:

-The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. -

-
-
-
-

Signal Details

-
-

The "NewConnection" signal

-
-NewConnection (o connection);
-
-

-Emitted when a new connection has been added after NetworkManager has -started up and initialized. This signal is not emitted for connections -read while starting up, because NetworkManager's D-Bus service is only -available after all connections have been read, and to prevent spamming -listeners with too many signals at one time. To retrieve the initial -connection list, call the ListConnections() method once, and then listen -for individual Settings.NewConnection and Settings.Connection.Deleted -signals for further updates. -

-
---- - - - - -

o connection:

-Object path of the new connection. -

-
-
-
-

The "ConnectionRemoved" signal

-
-ConnectionRemoved (o connection);
-
-

-Emitted when a connection is no longer available. This happens when the -connection is deleted or if it is no longer accessible by any of the -system's logged-in users. After receipt of this signal, the connection no -longer exists and cannot be used. Also see the Settings.Connection.Removed -signal. -

-
---- - - - - -

o connection:

-Object path of the removed connection. -

-
-
-
-

Property Details

-
-

The "Connections" property

-
-Connections  readable   ao
-
-

-List of object paths of available network connection profiles. -

-
-
-
-

The "Hostname" property

-
-Hostname  readable   s
-
-

-The machine hostname stored in persistent configuration. -

-
-
-
-

The "CanModify" property

-
-CanModify  readable   b
-
-

-If true, adding and modifying connections is supported. -

-
-
-
-

The "VersionId" property

-
-VersionId  readable   t
-
-

-The version of the settings. This is incremented whenever the profile -changes and can be used to detect concurrent modifications. -

-

-Since: 1.44 -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html deleted file mode 100644 index 0163313f..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - -org.freedesktop.NetworkManager.VPN.Connection: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.VPN.Connection

-

org.freedesktop.NetworkManager.VPN.Connection — Active VPN Connection.

-
-
-

Signals

-
-VpnStateChanged (u state,
-                 u reason);
-
-
-
-

Properties

-
-VpnState  readable   u
-Banner    readable   s
-
-
-
-

Description

-

-Represents an active connection to a Virtual Private Network. -

-
-
-

Signal Details

-
-

The "VpnStateChanged" signal

-
-VpnStateChanged (u state,
-                 u reason);
-
-

-Emitted when the state of the VPN connection has changed. -

-
---- - - - - - - - - - - -

u state:

-(NMVpnConnectionState) The new state of the VPN connection. -

u reason:

-(NMActiveConnectionStateReason) Reason code describing the change to the new state. -

-
-
-
-

Property Details

-
-

The "VpnState" property

-
-VpnState  readable   u
-
-

-The VPN-specific state of the connection. -

-

-Returns: NMVpnConnectionState -

-
-
-
-

The "Banner" property

-
-Banner  readable   s
-
-

-The banner string of the VPN connection. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html deleted file mode 100644 index 663e07d3..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html +++ /dev/null @@ -1,475 +0,0 @@ - - - - -org.freedesktop.NetworkManager.VPN.Plugin: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.VPN.Plugin

-

org.freedesktop.NetworkManager.VPN.Plugin — VPN Service.

-
-
-

Methods

-
-Connect            (IN  a{sa{sv}} connection);
-ConnectInteractive (IN  a{sa{sv}} connection,
-                    IN  a{sv}     details);
-NeedSecrets        (IN  a{sa{sv}} settings,
-                    OUT s         setting_name);
-Disconnect         ();
-SetConfig          (IN  a{sv}     config);
-SetIp4Config       (IN  a{sv}     config);
-SetIp6Config       (IN  a{sv}     config);
-SetFailure         (IN  s         reason);
-NewSecrets         (IN  a{sa{sv}} connection);
-
-
-
-

Signals

-
-StateChanged    (u     state);
-SecretsRequired (s     message,
-                 as    secrets);
-Config          (a{sv} config);
-Ip4Config       (a{sv} ip4config);
-Ip6Config       (a{sv} ip6config);
-LoginBanner     (s     banner);
-Failure         (u     reason);
-
-
-
-

Properties

-
-State  readable   u
-
-
-
-

Description

-

-This interface is provided by plugins providing VPN services to the -NetworkManager daemon. -

-
-
-

Method Details

-
-

The Connect() method

-
-Connect (IN  a{sa{sv}} connection);
-
-

-Tells the plugin to connect. Interactive secrets requests (eg, emitting -the SecretsRequired signal) are not allowed. -

-
---- - - - - -

IN a{sa{sv}} connection:

-Describes the connection to be established. -

-
-
-
-

The ConnectInteractive() method

-
-ConnectInteractive (IN  a{sa{sv}} connection,
-                    IN  a{sv}     details);
-
-

-Tells the plugin to connect, allowing interactive secrets requests (eg the -plugin is allowed to emit the SecretsRequired signal if the VPN service -indicates that it needs additional secrets during the connect process). -

-
---- - - - - - - - - - - -

IN a{sa{sv}} connection:

-Describes the connection to be established. -

IN a{sv} details:

-Additional details about the Connect process. -

-
-
-
-

The NeedSecrets() method

-
-NeedSecrets (IN  a{sa{sv}} settings,
-             OUT s         setting_name);
-
-

-Asks the plugin whether the provided connection will require secrets to -connect successfully. -

-
---- - - - - - - - - - - -

IN a{sa{sv}} settings:

-Describes the connection that may need secrets. -

OUT s setting_name:

-The setting name within the provided connection that requires secrets, if any. -

-
-
-
-

The Disconnect() method

-
-Disconnect ();
-
-

-Disconnect the plugin. -

-
-
-
-

The SetConfig() method

-
-SetConfig (IN  a{sv} config);
-
-

-Set generic connection details on the connection. -

-
---- - - - - -

IN a{sv} config:

-Generic configuration details for the connection. -

-
-
-
-

The SetIp4Config() method

-
-SetIp4Config (IN  a{sv} config);
-
-

-Set IPv4 details on the connection. -

-
---- - - - - -

IN a{sv} config:

-Ip4Config details for the connection. You must call SetConfig() before calling this. -

-
-
-
-

The SetIp6Config() method

-
-SetIp6Config (IN  a{sv} config);
-
-

-Set IPv6 details on the connection. -

-
---- - - - - -

IN a{sv} config:

-Ip6Config details for the connection. You must call SetConfig() before calling this. -

-
-
-
-

The SetFailure() method

-
-SetFailure (IN  s reason);
-
-

-Indicate a failure to the plugin. -

-
---- - - - - -

IN s reason:

-The reason for the failure. -

-
-
-
-

The NewSecrets() method

-
-NewSecrets (IN  a{sa{sv}} connection);
-
-

-Called in response to a SecretsRequired signal to deliver updated secrets -or other information to the plugin. -

-
---- - - - - -

IN a{sa{sv}} connection:

-Describes the connection including the new secrets. -

-
-
-
-

Signal Details

-
-

The "StateChanged" signal

-
-StateChanged (u state);
-
-

-Emitted when the plugin state changes. -

-
---- - - - - -

u state:

-(NMVpnServiceState) The new state of the plugin. -

-
-
-
-

The "SecretsRequired" signal

-
-SecretsRequired (s  message,
-                 as secrets);
-
-

-Emitted during an ongoing ConnectInteractive() request when the plugin has -determined that new secrets are required. NetworkManager will then call -the NewSecrets() method with a connection hash including the new secrets. -

-
---- - - - - - - - - - - -

s message:

-Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN. -

as secrets:

-Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end. -

-
-
-
-

The "Config" signal

-
-Config (a{sv} config);
-
-

-The plugin obtained generic configuration information. -

-
---- - - - - -

a{sv} config:

-The configuration information. -

-
-
-
-

The "Ip4Config" signal

-
-Ip4Config (a{sv} ip4config);
-
-

-The plugin obtained an IPv4 configuration. -

-
---- - - - - -

a{sv} ip4config:

-The IPv4 configuration. -

-
-
-
-

The "Ip6Config" signal

-
-Ip6Config (a{sv} ip6config);
-
-

-The plugin obtained an IPv6 configuration. -

-
---- - - - - -

a{sv} ip6config:

-The IPv6 configuration. -

-
-
-
-

The "LoginBanner" signal

-
-LoginBanner (s banner);
-
-

-Emitted when the plugin receives a login banner from the VPN service. -

-
---- - - - - -

s banner:

-The login banner string. -

-
-
-
-

The "Failure" signal

-
-Failure (u reason);
-
-

-Emitted when a failure in the VPN plugin occurs. -

-
---- - - - - -

u reason:

-(NMVpnPluginFailure) Reason code for the failure. -

-
-
-
-

Property Details

-
-

The "State" property

-
-State  readable   u
-
-

-The state of the plugin. -

-

-Returns: NMVpnServiceState -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html deleted file mode 100644 index ba2211c2..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.WifiP2PPeer.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - -org.freedesktop.NetworkManager.WifiP2PPeer: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager.WifiP2PPeer

-

org.freedesktop.NetworkManager.WifiP2PPeer — Wi-Fi P2P Peer.

-
-
-

Properties

-
-Name          readable   s
-Flags         readable   u
-Manufacturer  readable   s
-Model         readable   s
-ModelNumber   readable   s
-Serial        readable   s
-WfdIEs        readable   ay
-HwAddress     readable   s
-Strength      readable   y
-LastSeen      readable   i
-
-
-
-

Description

-

-

-

-

-

Since 1.16

-
-
-

Property Details

-
-

The "Name" property

-
-Name  readable   s
-
-

-Device name. -

-

Since 1.16

-
-
-
-

The "Flags" property

-
-Flags  readable   u
-
-

-Flags describing the capabilities of the access point. -

-

-Returns: NM80211ApFlags -

-

Since 1.16

-
-
-
-

The "Manufacturer" property

-
-Manufacturer  readable   s
-
-

-The manufacturer of the Wi-Fi P2P peer. -

-

Since 1.16

-
-
-
-

The "Model" property

-
-Model  readable   s
-
-

-The model of the Wi-Fi P2P peer. -

-

Since 1.16

-
-
-
-

The "ModelNumber" property

-
-ModelNumber  readable   s
-
-

-The model number of the Wi-Fi P2P peer. -

-

Since 1.16

-
-
-
-

The "Serial" property

-
-Serial  readable   s
-
-

-The serial number of the Wi-Fi P2P peer. -

-

Since 1.16

-
-
-
-

The "WfdIEs" property

-
-WfdIEs  readable   ay
-
-

-The Wi-Fi Display Information Elements of the Wi-Fi P2P peer. -

-

Since 1.16

-
-
-
-

The "HwAddress" property

-
-HwAddress  readable   s
-
-

-The hardware address (BSSID) of the access point. -

-

Since 1.16

-
-
-
-

The "Strength" property

-
-Strength  readable   y
-
-

-The current signal quality of the access point, in percent. -

-

Since 1.16

-
-
-
-

The "LastSeen" property

-
-LastSeen  readable   i
-
-

-The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access -point was found in scan results. A value of -1 means the access point has -never been found in scan results. -

-

Since 1.16

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html deleted file mode 100644 index 5f80af06..00000000 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html +++ /dev/null @@ -1,1205 +0,0 @@ - - - - -org.freedesktop.NetworkManager: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

org.freedesktop.NetworkManager

-

org.freedesktop.NetworkManager — Connection Manager.

-
-
-

Methods

-
-Reload                          (IN  u         flags);
-GetDevices                      (OUT ao        devices);
-GetAllDevices                   (OUT ao        devices);
-GetDeviceByIpIface              (IN  s         iface,
-                                 OUT o         device);
-ActivateConnection              (IN  o         connection,
-                                 IN  o         device,
-                                 IN  o         specific_object,
-                                 OUT o         active_connection);
-AddAndActivateConnection        (IN  a{sa{sv}} connection,
-                                 IN  o         device,
-                                 IN  o         specific_object,
-                                 OUT o         path,
-                                 OUT o         active_connection);
-AddAndActivateConnection2       (IN  a{sa{sv}} connection,
-                                 IN  o         device,
-                                 IN  o         specific_object,
-                                 IN  a{sv}     options,
-                                 OUT o         path,
-                                 OUT o         active_connection,
-                                 OUT a{sv}     result);
-DeactivateConnection            (IN  o         active_connection);
-Sleep                           (IN  b         sleep);
-Enable                          (IN  b         enable);
-GetPermissions                  (OUT a{ss}     permissions);
-SetLogging                      (IN  s         level,
-                                 IN  s         domains);
-GetLogging                      (OUT s         level,
-                                 OUT s         domains);
-CheckConnectivity               (OUT u         connectivity);
-state                           (OUT u         state);
-CheckpointCreate                (IN  ao        devices,
-                                 IN  u         rollback_timeout,
-                                 IN  u         flags,
-                                 OUT o         checkpoint);
-CheckpointDestroy               (IN  o         checkpoint);
-CheckpointRollback              (IN  o         checkpoint,
-                                 OUT a{su}     result);
-CheckpointAdjustRollbackTimeout (IN  o         checkpoint,
-                                 IN  u         add_timeout);
-
-
-
-

Signals

-
-CheckPermissions ();
-StateChanged     (u state);
-DeviceAdded      (o device_path);
-DeviceRemoved    (o device_path);
-
-
-
-

Properties

-
-Devices                     readable   ao
-AllDevices                  readable   ao
-Checkpoints                 readable   ao
-NetworkingEnabled           readable   b
-WirelessEnabled             readwrite  b
-WirelessHardwareEnabled     readable   b
-WwanEnabled                 readwrite  b
-WwanHardwareEnabled         readable   b
-WimaxEnabled                readwrite  b
-WimaxHardwareEnabled        readable   b
-RadioFlags                  readable   u
-ActiveConnections           readable   ao
-PrimaryConnection           readable   o
-PrimaryConnectionType       readable   s
-Metered                     readable   u
-ActivatingConnection        readable   o
-Startup                     readable   b
-Version                     readable   s
-VersionInfo                 readable   au
-Capabilities                readable   au
-State                       readable   u
-Connectivity                readable   u
-ConnectivityCheckAvailable  readable   b
-ConnectivityCheckEnabled    readwrite  b
-ConnectivityCheckUri        readable   s
-GlobalDnsConfiguration      readwrite  a{sv}
-
-
-
-

Description

-

-

-

-

-
-
-

Method Details

-
-

The Reload() method

-
-Reload (IN  u flags);
-
-

-Reload NetworkManager's configuration and perform certain updates, like flushing a cache or -rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it -allows for more fine-grained control over what to reload (see flags). It also allows -non-root access via PolicyKit and contrary to signals it is synchronous. -

-

-No flags (0x00) means to reload everything that is supported which is identical to -sending a SIGHUP. -(0x01) means to reload the NetworkManager.conf configuration from disk. Note that this -does not include connections, which can be reloaded via Setting's ReloadConnections. -(0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf -anew. -(0x04) means to restart the DNS plugin. This is for example useful when using -dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. -If you edit those files, you can restart the DNS plugin. This action shortly interrupts -name resolution. -Note that flags may affect each other. For example, restarting the DNS plugin (0x04) -implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes -to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting -the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration -changes in NetworkManager.conf. -

-
---- - - - - -

IN u flags:

-Optional flags to specify which parts shall be reloaded. -

-
-
-
-

The GetDevices() method

-
-GetDevices (OUT ao devices);
-
-

-Get the list of realized network devices. -

-
---- - - - - -

OUT ao devices:

-List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). -

-
-
-
-

The GetAllDevices() method

-
-GetAllDevices (OUT ao devices);
-
-

-Get the list of all network devices. -

-
---- - - - - -

OUT ao devices:

-List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). -

-
-
-
-

The GetDeviceByIpIface() method

-
-GetDeviceByIpIface (IN  s iface,
-                    OUT o device);
-
-

-Return the object path of the network device referenced by its IP -interface name. Note that some devices (usually modems) only have an IP -interface name when they are connected. -

-
---- - - - - - - - - - - -

IN s iface:

-Interface name of the device to find. -

OUT o device:

-Object path of the network device. -

-
-
-
-

The ActivateConnection() method

-
-ActivateConnection (IN  o connection,
-                    IN  o device,
-                    IN  o specific_object,
-                    OUT o active_connection);
-
-

-Activate a connection using the supplied device. -

-
---- - - - - - - - - - - - - - - - - - - -

IN o connection:

-The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. -

IN o device:

-The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. -

IN o specific_object:

-The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. -

OUT o active_connection:

-The path of the active connection object representing this active connection. -

-
-
-
-

The AddAndActivateConnection() method

-
-AddAndActivateConnection (IN  a{sa{sv}} connection,
-                          IN  o         device,
-                          IN  o         specific_object,
-                          OUT o         path,
-                          OUT o         active_connection);
-
-

-Adds a new connection using the given details (if any) as a template -(automatically filling in missing settings with the capabilities of the -given device and specific object), then activate the new connection. -Cannot be used for VPN connections at this time. -

-

-See also AddAndActivateConnection2. -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

IN a{sa{sv}} connection:

-Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. -

IN o device:

-The object path of device to be activated using the given connection. -

IN o specific_object:

-The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. -

OUT o path:

-Object path of the new connection that was just added. -

OUT o active_connection:

-The path of the active connection object representing this active connection. -

-
-
-
-

The AddAndActivateConnection2() method

-
-AddAndActivateConnection2 (IN  a{sa{sv}} connection,
-                           IN  o         device,
-                           IN  o         specific_object,
-                           IN  a{sv}     options,
-                           OUT o         path,
-                           OUT o         active_connection,
-                           OUT a{sv}     result);
-
-

-Adds a new connection using the given details (if any) as a template -(automatically filling in missing settings with the capabilities of the -given device and specific object), then activate the new connection. -Cannot be used for VPN connections at this time. -

-

-This method extends AddAndActivateConnection to allow passing further -parameters. At this time the following options are supported: -

-

- * persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected. - * bind-activation: Bind the activation lifetime. Set to "dbus-client" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally. -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

IN a{sa{sv}} connection:

-Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. -

IN o device:

-The object path of device to be activated using the given connection. -

IN o specific_object:

-The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For Wi-Fi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. -

IN a{sv} options:

-Further options for the method call. -

OUT o path:

-Object path of the new connection that was just added. -

OUT o active_connection:

-The path of the active connection object representing this active connection. -

OUT a{sv} result:

-A dictionary of additional output arguments for future extension. Currently, not additional output arguments are supported. -

-
-
-
-

The DeactivateConnection() method

-
-DeactivateConnection (IN  o active_connection);
-
-

-Deactivate an active connection. -

-
---- - - - - -

IN o active_connection:

-The currently active connection to deactivate. -

-
-
-
-

The Sleep() method

-
-Sleep (IN  b sleep);
-
-

-Control the NetworkManager daemon's sleep state. When asleep, all -interfaces that it manages are deactivated. When awake, devices are -available to be activated. This command should not be called directly by -users or clients; it is intended for system suspend/resume tracking. -

-
---- - - - - -

IN b sleep:

-Indicates whether the NetworkManager daemon should sleep or wake. -

-
-
-
-

The Enable() method

-
-Enable (IN  b enable);
-
-

-Control whether overall networking is enabled or disabled. When disabled, -all interfaces that NM manages are deactivated. When enabled, all managed -interfaces are re-enabled and available to be activated. This command -should be used by clients that provide to users the ability to -enable/disable all networking. -

-
---- - - - - -

IN b enable:

-If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. -

-
-
-
-

The GetPermissions() method

-
-GetPermissions (OUT a{ss} permissions);
-
-

-Returns the permissions a caller has for various authenticated operations -that NetworkManager provides, like Enable/Disable networking, changing -Wi-Fi, WWAN, and WiMAX state, etc. -

-
---- - - - - -

OUT a{ss} permissions:

-Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. -

-
-
-
-

The SetLogging() method

-
-SetLogging (IN  s level,
-            IN  s domains);
-
-

-Set logging verbosity and which operations are logged. -

-
---- - - - - - - - - - - -

IN s level:

-One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. -

IN s domains:

-A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. -

-
-
-
-

The GetLogging() method

-
-GetLogging (OUT s level,
-            OUT s domains);
-
-

-Get current logging verbosity level and operations domains. -

-
---- - - - - - - - - - - -

OUT s level:

-One of [ERR, WARN, INFO, DEBUG, TRACE]. -

OUT s domains:

-For available domains see SetLogging() call. -

-
-
-
-

The CheckConnectivity() method

-
-CheckConnectivity (OUT u connectivity);
-
-

-Re-check the network connectivity state. -

-
---- - - - - -

OUT u connectivity:

-(NMConnectivityState) The current connectivity state. -

-
-
-
-

The state() method

-
-state (OUT u state);
-
-

-The overall networking state as determined by the NetworkManager daemon, -based on the state of network devices under its management. -

-
---- - - - - -

OUT u state:

-NMState -

-
-
-
-

The CheckpointCreate() method

-
-CheckpointCreate (IN  ao devices,
-                  IN  u  rollback_timeout,
-                  IN  u  flags,
-                  OUT o  checkpoint);
-
-

-Create a checkpoint of the current networking configuration -for given interfaces. If rollback_timeout is not zero, a -rollback is automatically performed after the given timeout. -

-
---- - - - - - - - - - - - - - - - - - - -

IN ao devices:

-A list of device paths for which a checkpoint should be created. An empty list means all devices. -

IN u rollback_timeout:

-The time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite. -

IN u flags:

-(NMCheckpointCreateFlags) Flags for the creation. -

OUT o checkpoint:

-On success, the path of the new checkpoint. -

-
-
-
-

The CheckpointDestroy() method

-
-CheckpointDestroy (IN  o checkpoint);
-
-

-Destroy a previously created checkpoint. -

-
---- - - - - -

IN o checkpoint:

-The checkpoint to be destroyed. Set to empty to cancel all pending checkpoints. -

-
-
-
-

The CheckpointRollback() method

-
-CheckpointRollback (IN  o     checkpoint,
-                    OUT a{su} result);
-
-

-Rollback a checkpoint before the timeout is reached. -

-
---- - - - - - - - - - - -

IN o checkpoint:

-The checkpoint to be rolled back. -

OUT a{su} result:

-On return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult. -

-
-
-
-

The CheckpointAdjustRollbackTimeout() method

-
-CheckpointAdjustRollbackTimeout (IN  o checkpoint,
-                                 IN  u add_timeout);
-
-

-Reset the timeout for rollback for the checkpoint. -

-

-Note that the added seconds start counting from now, -not "Created" timestamp or the previous expiration -time. Note that the "Created" property of the checkpoint -will stay unchanged by this call. However, the "RollbackTimeout" -will be recalculated to give the approximate new expiration time. -The new "RollbackTimeout" property will be approximate up to -one second precision, which is the accuracy of the property. -

-
---- - - - - - - - - - - -

IN o checkpoint:

-The checkpoint to be rolled back. -

IN u add_timeout:

-Number of seconds from now in which the timeout will expire. Set to 0 to disable the timeout. -

-

Since 1.12

-
-
-
-

Signal Details

-
-

The "CheckPermissions" signal

-
-CheckPermissions ();
-
-

-Emitted when system authorization details change, indicating that clients -may wish to recheck permissions with GetPermissions. -

-
-
-
-

The "StateChanged" signal

-
-StateChanged (u state);
-
-

-NetworkManager's state changed. -

-
---- - - - - -

u state:

-(NMState) The new state of NetworkManager. -

-
-
-
-

The "DeviceAdded" signal

-
-DeviceAdded (o device_path);
-
-

-A device was added to the system -

-
---- - - - - -

o device_path:

-The object path of the newly added device. -

-
-
-
-

The "DeviceRemoved" signal

-
-DeviceRemoved (o device_path);
-
-

-A device was removed from the system, and is no longer available. -

-
---- - - - - -

o device_path:

-The object path of the device that was just removed. -

-
-
-
-

Property Details

-
-

The "Devices" property

-
-Devices  readable   ao
-
-

-The list of realized network devices. Realized devices are those which -have backing resources (eg from the kernel or a management daemon like -ModemManager, teamd, etc). -

-
-
-
-

The "AllDevices" property

-
-AllDevices  readable   ao
-
-

-The list of both realized and un-realized network devices. Un-realized -devices are software devices which do not yet have backing resources, but -for which backing resources can be created if the device is activated. -

-
-
-
-

The "Checkpoints" property

-
-Checkpoints  readable   ao
-
-

-The list of active checkpoints. -

-
-
-
-

The "NetworkingEnabled" property

-
-NetworkingEnabled  readable   b
-
-

-Indicates if overall networking is currently enabled or not. See the -Enable() method. -

-
-
-
-

The "WirelessEnabled" property

-
-WirelessEnabled  readwrite  b
-
-

-Indicates if wireless is currently enabled or not. -

-
-
-
-

The "WirelessHardwareEnabled" property

-
-WirelessHardwareEnabled  readable   b
-
-

-Indicates if the wireless hardware is currently enabled, i.e. the state of -the RF kill switch. -

-
-
-
-

The "WwanEnabled" property

-
-WwanEnabled  readwrite  b
-
-

-Indicates if mobile broadband devices are currently enabled or not. -

-
-
-
-

The "WwanHardwareEnabled" property

-
-WwanHardwareEnabled  readable   b
-
-

-Indicates if the mobile broadband hardware is currently enabled, i.e. the -state of the RF kill switch. -

-
-
-
-

The "WimaxEnabled" property

-
-WimaxEnabled  readwrite  b
-
-

-DEPRECATED. Doesn't have any meaning and is around only for -compatibility reasons. -

-
-
-
-

The "WimaxHardwareEnabled" property

-
-WimaxHardwareEnabled  readable   b
-
-

-DEPRECATED. Doesn't have any meaning and is around only for -compatibility reasons. -

-
-
-
-

The "RadioFlags" property

-
-RadioFlags  readable   u
-
-

-Flags related to radio devices. See NMRadioFlags for the list of flags -supported. -

-

Since 1.38

-
-
-
-

The "ActiveConnections" property

-
-ActiveConnections  readable   ao
-
-

-List of active connection object paths. -

-
-
-
-

The "PrimaryConnection" property

-
-PrimaryConnection  readable   o
-
-

-The object path of the "primary" active connection being used to access -the network. In particular, if there is no VPN active, or the VPN does not -have the default route, then this indicates the connection that has the -default route. If there is a VPN active with the default route, then this -indicates the connection that contains the route to the VPN endpoint. -

-
-
-
-

The "PrimaryConnectionType" property

-
-PrimaryConnectionType  readable   s
-
-

-The connection type of the "primary" active connection being used to -access the network. This is the same as the Type property on the object -indicated by PrimaryConnection. -

-
-
-
-

The "Metered" property

-
-Metered  readable   u
-
-

-Indicates whether the connectivity is metered. This is equivalent to the -metered property of the device associated with the primary connection. -

-

-Returns: NMMetered -

-
-
-
-

The "ActivatingConnection" property

-
-ActivatingConnection  readable   o
-
-

-The object path of an active connection that is currently being activated -and which is expected to become the new PrimaryConnection when it finishes -activating. -

-
-
-
-

The "Startup" property

-
-Startup  readable   b
-
-

-Indicates whether NM is still starting up; this becomes FALSE when NM has -finished attempting to activate every connection that it might be able to -activate at startup. -

-
-
-
-

The "Version" property

-
-Version  readable   s
-
-

-NetworkManager version. -

-
-
-
-

The "VersionInfo" property

-
-VersionInfo  readable   au
-
-

-NetworkManager version and capabilities. -

-

-The first element in the array is the NM_VERSION of the daemon. It is a binary representation -of the "Version" and can be compared numerically. The version is encoded as -"(major << 16 | minor << 8 | micro)". -

-

-The following elements are a bitfield of static capabilities of the daemon. See -#NMVersionInfoCapability for the available capability numbers. -

-

-Since: 1.42 -

-
-
-
-

The "Capabilities" property

-
-Capabilities  readable   au
-
-

-The current set of capabilities. See NMCapability for currently -defined capability numbers. The array is guaranteed to -be sorted in ascending order without duplicates. -

-
-
-
-

The "State" property

-
-State  readable   u
-
-

-The overall state of the NetworkManager daemon. -

-

-This takes state of all active connections and the connectivity state into account -to produce a single indicator of the network accessibility status. -

-

-The graphical shells may use this property to provide network connection status -indication and applications may use this to check if Internet connection is -accessible. Shell that is able to cope with captive portals should use the -"Connectivity" property to decide whether to present a captive portal authentication -dialog. -

-

-Returns: NMState -

-
-
-
-

The "Connectivity" property

-
-Connectivity  readable   u
-
-

-The result of the last connectivity check. The connectivity check is triggered -automatically when a default connection becomes available, periodically and by -calling a CheckConnectivity() method. -

-

-This property is in general useful for the graphical shell to determine whether -the Internet access is being hijacked by an authentication gateway (a "captive -portal"). In such case it would typically present a web browser window to give -the user a chance to authenticate and call CheckConnectivity() when the user -submits a form or dismisses the window. -

-

-To determine the whether the user is able to access the Internet without dealing -with captive portals (e.g. to provide a network connection indicator or disable -controls that require Internet access), the "State" property is more suitable. -

-

-Returns: NMConnectivityState -

-
-
-
-

The "ConnectivityCheckAvailable" property

-
-ConnectivityCheckAvailable  readable   b
-
-

-Indicates whether connectivity checking service has been -configured. This may return true even if the service is not -currently enabled. -

-

-This is primarily intended for use in a privacy control panel, -as a way to determine whether to show an option to -enable/disable the feature. -

-
-
-
-

The "ConnectivityCheckEnabled" property

-
-ConnectivityCheckEnabled  readwrite  b
-
-

-Indicates whether connectivity checking is enabled. This -property can also be written to disable connectivity -checking (as a privacy control panel might want to do). -

-
-
-
-

The "ConnectivityCheckUri" property

-
-ConnectivityCheckUri  readable   s
-
-

-The URI that NetworkManager will hit to check if there is internet connectivity. -

-
-
-
-

The "GlobalDnsConfiguration" property

-
-GlobalDnsConfiguration  readwrite  a{sv}
-
-

-Dictionary of global DNS settings where the key is one of "searches", -"options" and "domains". The values for the "searches" and "options" keys -are string arrays describing the list of search domains and resolver -options, respectively. The value of the "domains" key is a second-level -dictionary, where each key is a domain name, and each key's value is a -third-level dictionary with the keys "servers" and "options". "servers" is -a string array of DNS servers, "options" is a string array of -domain-specific options. -

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/home.png b/docs/api/html/home.png deleted file mode 100644 index 9346b336..00000000 Binary files a/docs/api/html/home.png and /dev/null differ diff --git a/docs/api/html/index.html b/docs/api/html/index.html deleted file mode 100644 index 77edfb70..00000000 --- a/docs/api/html/index.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - -NetworkManager Reference Manual: NetworkManager Reference Manual - - - - - - - - -
-
-
-
-

- for NetworkManager 1.50.0 - - The latest version of this documentation can be found on-line at - https://networkmanager.dev/docs/api/latest/. -

-

Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018 The NetworkManager Authors

-
-

- Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free - Documentation License, Version 1.1 or any later - version published by the Free Software Foundation with no - Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free - Documentation License from the Free Software - Foundation by visiting their Web site. -

-
-
-

- This manual is the reference documentation for NetworkManager, the standard - Linux network management service. It is intended for system administrators and - integrators who need to understand the capabilities of NetworkManager, its - configuration options, command line tools and the D-Bus API for programmatic - control of the service. -

-

- The end users NetworkManager should instead refer to respective documentation - of their desktop environment of choice. -

-

- The application developers who prefer not to use the D-Bus API directly can use the - libnm library - shipped with NetworkManager or its bindings to a higher level language such as - Python, Ruby or Vala via GObject introspection. -

-
-
-
-
-
-
I. Manual Pages
-
-
-NetworkManager — network management daemon -
-
-NetworkManager.conf — NetworkManager configuration file -
-
-NetworkManager-dispatcher — Dispatch user scripts for NetworkManager -
-
-NetworkManager-wait-online.service — Wait for the network to come online -
-
-nmcli — command-line tool for controlling NetworkManager -
-
-nmcli-examples — usage examples of nmcli -
-
-nmtui — Text User Interface for controlling NetworkManager -
-
-nm-settings-dbus — Description of settings and properties of NetworkManager connection profiles on the D-Bus API -
-
-nm-settings-nmcli — Description of settings and properties of NetworkManager connection profiles for nmcli -
-
-nm-settings-keyfile — Description of keyfile settings plugin -
-
-nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin -
-
-nm-online — ask NetworkManager whether the network is connected -
-
-nm-initrd-generator — early boot NetworkManager configuration generator -
-
-nm-cloud-setup — Overview of Automatic Network Configuration in Cloud -
-
-nm-openvswitch — overview of NetworkManager Open vSwitch support -
-
-
II. Network Configuration Setting Specification
-
-
Configuration Settings
-
-
-connection — General Connection Profile Settings -
-
-6lowpan — 6LoWPAN Settings -
-
-802-1x — IEEE 802.1x Authentication Settings -
-
-adsl — ADSL Settings -
-
-bluetooth — Bluetooth Settings -
-
-bond — Bonding Settings -
-
-bridge — Bridging Settings -
-
-bridge-port — Bridge Port Settings -
-
-cdma — CDMA-based Mobile Broadband Settings -
-
-dcb — Data Center Bridging Settings -
-
-dummy — Dummy Link Settings -
-
-ethtool — Ethtool Ethernet Settings -
-
-generic — Generic Link Settings -
-
-gsm — GSM-based Mobile Broadband Settings -
-
-hsr — HSR/PRP Settings -
-
-infiniband — Infiniband Settings -
-
-ipv4 — IPv4 Settings -
-
-ipv6 — IPv6 Settings -
-
-ip-tunnel — IP Tunneling Settings -
-
-macsec — MACSec Settings -
-
-macvlan — MAC VLAN Settings -
-
-match — Match settings -
-
-802-11-olpc-mesh — OLPC Wireless Mesh Settings -
-
-ovs-bridge — OvsBridge Link Settings -
-
-ovs-dpdk — OvsDpdk Link Settings -
-
-ovs-interface — Open vSwitch Interface Settings -
-
-ovs-patch — OvsPatch Link Settings -
-
-ovs-port — OvsPort Link Settings -
-
-ppp — Point-to-Point Protocol Settings -
-
-pppoe — PPP-over-Ethernet Settings -
-
-proxy — WWW Proxy Settings -
-
-serial — Serial Link Settings -
-
-sriov — SR-IOV settings -
-
-tc — Linux Traffic Control Settings -
-
-team — Teaming Settings -
-
-team-port — Team Port Settings -
-
-tun — Tunnel Settings -
-
-user — General User Profile Settings -
-
-vlan — VLAN Settings -
-
-vpn — VPN Settings -
-
-vrf — VRF settings -
-
-vxlan — VXLAN Settings -
-
-wifi-p2p — Wi-Fi P2P Settings -
-
-wimax — WiMax Settings -
-
-802-3-ethernet — Wired Ethernet Settings -
-
-wireguard — WireGuard Settings -
-
-802-11-wireless — Wi-Fi Settings -
-
-802-11-wireless-security — Wi-Fi Security Settings -
-
-wpan — IEEE 802.15.4 (WPAN) MAC Settings -
-
-bond-port — Bond Port Settings -
-
-hostname — Hostname settings -
-
-link — Link settings -
-
-loopback — Loopback Link Settings -
-
-ovs-external-ids — OVS External IDs Settings -
-
-ovs-other-config — OVS Other Config Settings -
-
-veth — Veth Settings -
-
-
Secret flag types
-
-
III. D-Bus API Reference
-
-
The /org/freedesktop/NetworkManager object
-
-org.freedesktop.NetworkManager — Connection Manager. -
-
The /org/freedesktop/NetworkManager/AgentManager object
-
-org.freedesktop.NetworkManager.AgentManager — Secret Agent Manager. -
-
The /org/freedesktop/NetworkManager/DnsManager object
-
-org.freedesktop.NetworkManager.DnsManager — DNS Configuration State. -
-
The /org/freedesktop/NetworkManager/Settings object
-
-org.freedesktop.NetworkManager.Settings — Connection Settings Profile Manager. -
-
The /org/freedesktop/NetworkManager/Settings/* objects
-
-org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile. -
-
The /org/freedesktop/NetworkManager/Devices/* objects
-
-
-org.freedesktop.NetworkManager.Device — Device. -
-
-org.freedesktop.NetworkManager.Device.Statistics — Device Statistic Counters. -
-
-org.freedesktop.NetworkManager.Device.Adsl — ADSL Device. -
-
-org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device. -
-
-org.freedesktop.NetworkManager.Device.Bond — Bonding Device. -
-
-org.freedesktop.NetworkManager.Device.Bridge — Bridging Device. -
-
-org.freedesktop.NetworkManager.Device.Dummy — Dummy Device. -
-
-org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device. -
-
-org.freedesktop.NetworkManager.Device.Hsr — HSR Device. -
-
-org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device. -
-
-org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device. -
-
-org.freedesktop.NetworkManager.Device.Loopback — Loopback Device. -
-
-org.freedesktop.NetworkManager.Device.Lowpan — 6LoWPAN Device. -
-
-org.freedesktop.NetworkManager.Device.Macsec — MACSec Device. -
-
-org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device. -
-
-org.freedesktop.NetworkManager.Device.Modem — Modem Device. -
-
-org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device. -
-
-org.freedesktop.NetworkManager.Device.OvsBridge — OvsBridge Device. -
-
-org.freedesktop.NetworkManager.Device.OvsInterface — OvsInterface Device. -
-
-org.freedesktop.NetworkManager.Device.OvsPort — OvsPort Device. -
-
-org.freedesktop.NetworkManager.Device.Ppp — PPP Device. -
-
-org.freedesktop.NetworkManager.Device.Team — Teaming Device. -
-
-org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device. -
-
-org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device. -
-
-org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device. -
-
-org.freedesktop.NetworkManager.Device.Vrf — VRF Device. -
-
-org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device. -
-
-org.freedesktop.NetworkManager.Device.WifiP2P — Wi-Fi P2P Device. -
-
-org.freedesktop.NetworkManager.Device.WireGuard — WireGuard Device. -
-
-org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device. -
-
-org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device. -
-
-org.freedesktop.NetworkManager.Device.Wpan — IEEE 802.15.4 (WPAN) MAC Layer Device. -
-
-org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin. -
-
-
The /org/freedesktop/NetworkManager/ActiveConnection/* objects
-
-
-org.freedesktop.NetworkManager.Connection.Active — Active Connection. -
-
-org.freedesktop.NetworkManager.VPN.Connection — Active VPN Connection. -
-
-
The /org/freedesktop/NetworkManager/IP4Config/* objects
-
-org.freedesktop.NetworkManager.IP4Config — IPv4 Configuration Set. -
-
The /org/freedesktop/NetworkManager/IP6Config/* objects
-
-org.freedesktop.NetworkManager.IP6Config — IPv6 Configuration Set. -
-
The /org/freedesktop/NetworkManager/DHCP4Config/* objects
-
-org.freedesktop.NetworkManager.DHCP4Config — IPv4 DHCP Client State. -
-
The /org/freedesktop/NetworkManager/DHCP4Config/* objects
-
-org.freedesktop.NetworkManager.DHCP6Config — IPv6 DHCP Client State. -
-
The /org/freedesktop/NetworkManager/AccessPoint/* objects
-
-org.freedesktop.NetworkManager.AccessPoint — Wi-Fi Access Point. -
-
The /org.freedesktop.NetworkManager.WifiP2PPeer/* objects
-
-org.freedesktop.NetworkManager.WifiP2PPeer — Wi-Fi P2P Peer. -
-
The /org/freedesktop/NetworkManager/Checkpoint/* objects
-
-org.freedesktop.NetworkManager.Checkpoint — Configuration and State Snapshot. -
-
Types
-
-NetworkManager D-Bus API Types -
-
-
IV. Secret Agent D-Bus API Reference
-
-
Secret agents
-
-org.freedesktop.NetworkManager.SecretAgent — User Secret Agent. -
-
-
V. VPN Plugin D-Bus API Reference
-
-
VPN services
-
-org.freedesktop.NetworkManager.VPN.Plugin — VPN Service. -
-
Types
-
-VPN Plugin D-Bus API Types -
-
-
Index
-
A. License
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html deleted file mode 100644 index c5801ca3..00000000 --- a/docs/api/html/ix01.html +++ /dev/null @@ -1,1769 +0,0 @@ - - - - -Index: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Index

-
-
-

Symbols

-
-
org.freedesktop.NetworkManager.AccessPoint, org.freedesktop.NetworkManager.AccessPoint -
-
org.freedesktop.NetworkManager.AccessPoint:Bandwidth, The "Bandwidth" property -
-
org.freedesktop.NetworkManager.AccessPoint:Flags, The "Flags" property -
-
org.freedesktop.NetworkManager.AccessPoint:Frequency, The "Frequency" property -
-
org.freedesktop.NetworkManager.AccessPoint:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.AccessPoint:LastSeen, The "LastSeen" property -
-
org.freedesktop.NetworkManager.AccessPoint:MaxBitrate, The "MaxBitrate" property -
-
org.freedesktop.NetworkManager.AccessPoint:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.AccessPoint:RsnFlags, The "RsnFlags" property -
-
org.freedesktop.NetworkManager.AccessPoint:Ssid, The "Ssid" property -
-
org.freedesktop.NetworkManager.AccessPoint:Strength, The "Strength" property -
-
org.freedesktop.NetworkManager.AccessPoint:WpaFlags, The "WpaFlags" property -
-
org.freedesktop.NetworkManager.AgentManager, org.freedesktop.NetworkManager.AgentManager -
-
org.freedesktop.NetworkManager.AgentManager.Register(), The Register() method -
-
org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities(), The RegisterWithCapabilities() method -
-
org.freedesktop.NetworkManager.AgentManager.Unregister(), The Unregister() method -
-
org.freedesktop.NetworkManager.Device, org.freedesktop.NetworkManager.Device -
-
org.freedesktop.NetworkManager.Device.Adsl, org.freedesktop.NetworkManager.Device.Adsl -
-
org.freedesktop.NetworkManager.Device.Adsl:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Bluetooth, org.freedesktop.NetworkManager.Device.Bluetooth -
-
org.freedesktop.NetworkManager.Device.Bluetooth:BtCapabilities, The "BtCapabilities" property -
-
org.freedesktop.NetworkManager.Device.Bluetooth:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Bluetooth:Name, The "Name" property -
-
org.freedesktop.NetworkManager.Device.Bond, org.freedesktop.NetworkManager.Device.Bond -
-
org.freedesktop.NetworkManager.Device.Bond:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Bond:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Bond:Slaves, The "Slaves" property -
-
org.freedesktop.NetworkManager.Device.Bridge, org.freedesktop.NetworkManager.Device.Bridge -
-
org.freedesktop.NetworkManager.Device.Bridge:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Bridge:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Bridge:Slaves, The "Slaves" property -
-
org.freedesktop.NetworkManager.Device.Delete(), The Delete() method -
-
org.freedesktop.NetworkManager.Device.Disconnect(), The Disconnect() method -
-
org.freedesktop.NetworkManager.Device.Dummy, org.freedesktop.NetworkManager.Device.Dummy -
-
org.freedesktop.NetworkManager.Device.Dummy:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Generic, org.freedesktop.NetworkManager.Device.Generic -
-
org.freedesktop.NetworkManager.Device.Generic:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Generic:TypeDescription, The "TypeDescription" property -
-
org.freedesktop.NetworkManager.Device.GetAppliedConnection(), The GetAppliedConnection() method -
-
org.freedesktop.NetworkManager.Device.Hsr, org.freedesktop.NetworkManager.Device.Hsr -
-
org.freedesktop.NetworkManager.Device.Hsr:MulticastSpec, The "MulticastSpec" property -
-
org.freedesktop.NetworkManager.Device.Hsr:Port1, The "Port1" property -
-
org.freedesktop.NetworkManager.Device.Hsr:Port2, The "Port2" property -
-
org.freedesktop.NetworkManager.Device.Hsr:Prp, The "Prp" property -
-
org.freedesktop.NetworkManager.Device.Hsr:SupervisionAddress, The "SupervisionAddress" property -
-
org.freedesktop.NetworkManager.Device.Infiniband, org.freedesktop.NetworkManager.Device.Infiniband -
-
org.freedesktop.NetworkManager.Device.Infiniband:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Infiniband:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel, org.freedesktop.NetworkManager.Device.IPTunnel -
-
org.freedesktop.NetworkManager.Device.IPTunnel:EncapsulationLimit, The "EncapsulationLimit" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Flags, The "Flags" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:FlowLabel, The "FlowLabel" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:FwMark, The "FwMark" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:InputKey, The "InputKey" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Local, The "Local" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:OutputKey, The "OutputKey" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:PathMtuDiscovery, The "PathMtuDiscovery" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Remote, The "Remote" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Tos, The "Tos" property -
-
org.freedesktop.NetworkManager.Device.IPTunnel:Ttl, The "Ttl" property -
-
org.freedesktop.NetworkManager.Device.Loopback, org.freedesktop.NetworkManager.Device.Loopback -
-
org.freedesktop.NetworkManager.Device.Lowpan, org.freedesktop.NetworkManager.Device.Lowpan -
-
org.freedesktop.NetworkManager.Device.Lowpan:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Lowpan:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.Macsec, org.freedesktop.NetworkManager.Device.Macsec -
-
org.freedesktop.NetworkManager.Device.Macsec:CipherSuite, The "CipherSuite" property -
-
org.freedesktop.NetworkManager.Device.Macsec:EncodingSa, The "EncodingSa" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Encrypt, The "Encrypt" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Es, The "Es" property -
-
org.freedesktop.NetworkManager.Device.Macsec:IcvLength, The "IcvLength" property -
-
org.freedesktop.NetworkManager.Device.Macsec:IncludeSci, The "IncludeSci" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Protect, The "Protect" property -
-
org.freedesktop.NetworkManager.Device.Macsec:ReplayProtect, The "ReplayProtect" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Scb, The "Scb" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Sci, The "Sci" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Validation, The "Validation" property -
-
org.freedesktop.NetworkManager.Device.Macsec:Window, The "Window" property -
-
org.freedesktop.NetworkManager.Device.Macvlan, org.freedesktop.NetworkManager.Device.Macvlan -
-
org.freedesktop.NetworkManager.Device.Macvlan:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.Device.Macvlan:NoPromisc, The "NoPromisc" property -
-
org.freedesktop.NetworkManager.Device.Macvlan:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.Macvlan:Tap, The "Tap" property -
-
org.freedesktop.NetworkManager.Device.Modem, org.freedesktop.NetworkManager.Device.Modem -
-
org.freedesktop.NetworkManager.Device.Modem:Apn, The "Apn" property -
-
org.freedesktop.NetworkManager.Device.Modem:CurrentCapabilities, The "CurrentCapabilities" property -
-
org.freedesktop.NetworkManager.Device.Modem:DeviceId, The "DeviceId" property -
-
org.freedesktop.NetworkManager.Device.Modem:ModemCapabilities, The "ModemCapabilities" property -
-
org.freedesktop.NetworkManager.Device.Modem:OperatorCode, The "OperatorCode" property -
-
org.freedesktop.NetworkManager.Device.OlpcMesh, org.freedesktop.NetworkManager.Device.OlpcMesh -
-
org.freedesktop.NetworkManager.Device.OlpcMesh:ActiveChannel, The "ActiveChannel" property -
-
org.freedesktop.NetworkManager.Device.OlpcMesh:Companion, The "Companion" property -
-
org.freedesktop.NetworkManager.Device.OlpcMesh:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.OvsBridge, org.freedesktop.NetworkManager.Device.OvsBridge -
-
org.freedesktop.NetworkManager.Device.OvsBridge:Slaves, The "Slaves" property -
-
org.freedesktop.NetworkManager.Device.OvsInterface, org.freedesktop.NetworkManager.Device.OvsInterface -
-
org.freedesktop.NetworkManager.Device.OvsPort, org.freedesktop.NetworkManager.Device.OvsPort -
-
org.freedesktop.NetworkManager.Device.OvsPort:Slaves, The "Slaves" property -
-
org.freedesktop.NetworkManager.Device.Ppp, org.freedesktop.NetworkManager.Device.Ppp -
-
org.freedesktop.NetworkManager.Device.Reapply(), The Reapply() method -
-
org.freedesktop.NetworkManager.Device.Statistics, org.freedesktop.NetworkManager.Device.Statistics -
-
org.freedesktop.NetworkManager.Device.Statistics:RefreshRateMs, The "RefreshRateMs" property -
-
org.freedesktop.NetworkManager.Device.Statistics:RxBytes, The "RxBytes" property -
-
org.freedesktop.NetworkManager.Device.Statistics:TxBytes, The "TxBytes" property -
-
org.freedesktop.NetworkManager.Device.Team, org.freedesktop.NetworkManager.Device.Team -
-
org.freedesktop.NetworkManager.Device.Team:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Team:Config, The "Config" property -
-
org.freedesktop.NetworkManager.Device.Team:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Team:Slaves, The "Slaves" property -
-
org.freedesktop.NetworkManager.Device.Tun, org.freedesktop.NetworkManager.Device.Tun -
-
org.freedesktop.NetworkManager.Device.Tun:Group, The "Group" property -
-
org.freedesktop.NetworkManager.Device.Tun:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Tun:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.Device.Tun:MultiQueue, The "MultiQueue" property -
-
org.freedesktop.NetworkManager.Device.Tun:NoPi, The "NoPi" property -
-
org.freedesktop.NetworkManager.Device.Tun:Owner, The "Owner" property -
-
org.freedesktop.NetworkManager.Device.Tun:VnetHdr, The "VnetHdr" property -
-
org.freedesktop.NetworkManager.Device.Veth, org.freedesktop.NetworkManager.Device.Veth -
-
org.freedesktop.NetworkManager.Device.Veth:Peer, The "Peer" property -
-
org.freedesktop.NetworkManager.Device.Vlan, org.freedesktop.NetworkManager.Device.Vlan -
-
org.freedesktop.NetworkManager.Device.Vlan:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Vlan:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Vlan:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.Vlan:VlanId, The "VlanId" property -
-
org.freedesktop.NetworkManager.Device.Vrf, org.freedesktop.NetworkManager.Device.Vrf -
-
org.freedesktop.NetworkManager.Device.Vrf:Table, The "Table" property -
-
org.freedesktop.NetworkManager.Device.Vxlan, org.freedesktop.NetworkManager.Device.Vxlan -
-
org.freedesktop.NetworkManager.Device.Vxlan:Ageing, The "Ageing" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:DstPort, The "DstPort" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Group, The "Group" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Id, The "Id" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:L2miss, The "L2miss" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:L3miss, The "L3miss" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Learning, The "Learning" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Limit, The "Limit" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Local, The "Local" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Parent, The "Parent" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Proxy, The "Proxy" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Rsc, The "Rsc" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:SrcPortMax, The "SrcPortMax" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:SrcPortMin, The "SrcPortMin" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Tos, The "Tos" property -
-
org.freedesktop.NetworkManager.Device.Vxlan:Ttl, The "Ttl" property -
-
org.freedesktop.NetworkManager.Device.WireGuard, org.freedesktop.NetworkManager.Device.WireGuard -
-
org.freedesktop.NetworkManager.Device.WireGuard:FwMark, The "FwMark" property -
-
org.freedesktop.NetworkManager.Device.WireGuard:ListenPort, The "ListenPort" property -
-
org.freedesktop.NetworkManager.Device.WireGuard:PublicKey, The "PublicKey" property -
-
org.freedesktop.NetworkManager.Device.Wpan, org.freedesktop.NetworkManager.Device.Wpan -
-
org.freedesktop.NetworkManager.Device.Wpan:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device::StateChanged, The "StateChanged" signal -
-
org.freedesktop.NetworkManager.Device:ActiveConnection, The "ActiveConnection" property -
-
org.freedesktop.NetworkManager.Device:Autoconnect, The "Autoconnect" property -
-
org.freedesktop.NetworkManager.Device:AvailableConnections, The "AvailableConnections" property -
-
org.freedesktop.NetworkManager.Device:Capabilities, The "Capabilities" property -
-
org.freedesktop.NetworkManager.Device:DeviceType, The "DeviceType" property -
-
org.freedesktop.NetworkManager.Device:Dhcp4Config, The "Dhcp4Config" property -
-
org.freedesktop.NetworkManager.Device:Dhcp6Config, The "Dhcp6Config" property -
-
org.freedesktop.NetworkManager.Device:Driver, The "Driver" property -
-
org.freedesktop.NetworkManager.Device:DriverVersion, The "DriverVersion" property -
-
org.freedesktop.NetworkManager.Device:FirmwareMissing, The "FirmwareMissing" property -
-
org.freedesktop.NetworkManager.Device:FirmwareVersion, The "FirmwareVersion" property -
-
org.freedesktop.NetworkManager.Device:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device:Interface, The "Interface" property -
-
org.freedesktop.NetworkManager.Device:InterfaceFlags, The "InterfaceFlags" property -
-
org.freedesktop.NetworkManager.Device:Ip4Address, The "Ip4Address" property -
-
org.freedesktop.NetworkManager.Device:Ip4Config, The "Ip4Config" property -
-
org.freedesktop.NetworkManager.Device:Ip4Connectivity, The "Ip4Connectivity" property -
-
org.freedesktop.NetworkManager.Device:Ip6Config, The "Ip6Config" property -
-
org.freedesktop.NetworkManager.Device:Ip6Connectivity, The "Ip6Connectivity" property -
-
org.freedesktop.NetworkManager.Device:IpInterface, The "IpInterface" property -
-
org.freedesktop.NetworkManager.Device:LldpNeighbors, The "LldpNeighbors" property -
-
org.freedesktop.NetworkManager.Device:Managed, The "Managed" property -
-
org.freedesktop.NetworkManager.Device:Metered, The "Metered" property -
-
org.freedesktop.NetworkManager.Device:Mtu, The "Mtu" property -
-
org.freedesktop.NetworkManager.Device:NmPluginMissing, The "NmPluginMissing" property -
-
org.freedesktop.NetworkManager.Device:Path, The "Path" property -
-
org.freedesktop.NetworkManager.Device:PhysicalPortId, The "PhysicalPortId" property -
-
org.freedesktop.NetworkManager.Device:Ports, The "Ports" property -
-
org.freedesktop.NetworkManager.Device:Real, The "Real" property -
-
org.freedesktop.NetworkManager.Device:State, The "State" property -
-
org.freedesktop.NetworkManager.Device:StateReason, The "StateReason" property -
-
org.freedesktop.NetworkManager.Device:Udi, The "Udi" property -
-
org.freedesktop.NetworkManager.DnsManager, org.freedesktop.NetworkManager.DnsManager -
-
org.freedesktop.NetworkManager.DnsManager:Configuration, The "Configuration" property -
-
org.freedesktop.NetworkManager.DnsManager:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.DnsManager:RcManager, The "RcManager" property -
-
org.freedesktop.NetworkManager.IP4Config, org.freedesktop.NetworkManager.IP4Config -
-
org.freedesktop.NetworkManager.IP4Config:AddressData, The "AddressData" property -
-
org.freedesktop.NetworkManager.IP4Config:Addresses, The "Addresses" property -
-
org.freedesktop.NetworkManager.IP4Config:DnsOptions, The "DnsOptions" property -
-
org.freedesktop.NetworkManager.IP4Config:DnsPriority, The "DnsPriority" property -
-
org.freedesktop.NetworkManager.IP4Config:Domains, The "Domains" property -
-
org.freedesktop.NetworkManager.IP4Config:Gateway, The "Gateway" property -
-
org.freedesktop.NetworkManager.IP4Config:NameserverData, The "NameserverData" property -
-
org.freedesktop.NetworkManager.IP4Config:Nameservers, The "Nameservers" property -
-
org.freedesktop.NetworkManager.IP4Config:RouteData, The "RouteData" property -
-
org.freedesktop.NetworkManager.IP4Config:Routes, The "Routes" property -
-
org.freedesktop.NetworkManager.IP4Config:Searches, The "Searches" property -
-
org.freedesktop.NetworkManager.IP4Config:WinsServerData, The "WinsServerData" property -
-
org.freedesktop.NetworkManager.IP4Config:WinsServers, The "WinsServers" property -
-
org.freedesktop.NetworkManager.IP6Config, org.freedesktop.NetworkManager.IP6Config -
-
org.freedesktop.NetworkManager.IP6Config:AddressData, The "AddressData" property -
-
org.freedesktop.NetworkManager.IP6Config:Addresses, The "Addresses" property -
-
org.freedesktop.NetworkManager.IP6Config:DnsOptions, The "DnsOptions" property -
-
org.freedesktop.NetworkManager.IP6Config:DnsPriority, The "DnsPriority" property -
-
org.freedesktop.NetworkManager.IP6Config:Domains, The "Domains" property -
-
org.freedesktop.NetworkManager.IP6Config:Gateway, The "Gateway" property -
-
org.freedesktop.NetworkManager.IP6Config:Nameservers, The "Nameservers" property -
-
org.freedesktop.NetworkManager.IP6Config:RouteData, The "RouteData" property -
-
org.freedesktop.NetworkManager.IP6Config:Routes, The "Routes" property -
-
org.freedesktop.NetworkManager.IP6Config:Searches, The "Searches" property -
-
org.freedesktop.NetworkManager.SecretAgent, org.freedesktop.NetworkManager.SecretAgent -
-
org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets(), The CancelGetSecrets() method -
-
org.freedesktop.NetworkManager.SecretAgent.DeleteSecrets(), The DeleteSecrets() method -
-
org.freedesktop.NetworkManager.SecretAgent.GetSecrets(), The GetSecrets() method -
-
org.freedesktop.NetworkManager.SecretAgent.SaveSecrets(), The SaveSecrets() method -
-
org.freedesktop.NetworkManager.Settings, org.freedesktop.NetworkManager.Settings -
-
org.freedesktop.NetworkManager.Settings.AddConnection(), The AddConnection() method -
-
org.freedesktop.NetworkManager.Settings.AddConnection2(), The AddConnection2() method -
-
org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved(), The AddConnectionUnsaved() method -
-
org.freedesktop.NetworkManager.Settings.Connection, org.freedesktop.NetworkManager.Settings.Connection -
-
org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets(), The ClearSecrets() method -
-
org.freedesktop.NetworkManager.Settings.Connection.Delete(), The Delete() method -
-
org.freedesktop.NetworkManager.Settings.Connection.GetSecrets(), The GetSecrets() method -
-
org.freedesktop.NetworkManager.Settings.Connection.GetSettings(), The GetSettings() method -
-
org.freedesktop.NetworkManager.Settings.Connection.Save(), The Save() method -
-
org.freedesktop.NetworkManager.Settings.Connection.Update(), The Update() method -
-
org.freedesktop.NetworkManager.Settings.Connection.Update2(), The Update2() method -
-
org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved(), The UpdateUnsaved() method -
-
org.freedesktop.NetworkManager.Settings.Connection::Removed, The "Removed" signal -
-
org.freedesktop.NetworkManager.Settings.Connection::Updated, The "Updated" signal -
-
org.freedesktop.NetworkManager.Settings.Connection:Filename, The "Filename" property -
-
org.freedesktop.NetworkManager.Settings.Connection:Flags, The "Flags" property -
-
org.freedesktop.NetworkManager.Settings.Connection:Unsaved, The "Unsaved" property -
-
org.freedesktop.NetworkManager.Settings.GetConnectionByUuid(), The GetConnectionByUuid() method -
-
org.freedesktop.NetworkManager.Settings.ListConnections(), The ListConnections() method -
-
org.freedesktop.NetworkManager.Settings.LoadConnections(), The LoadConnections() method -
-
org.freedesktop.NetworkManager.Settings.ReloadConnections(), The ReloadConnections() method -
-
org.freedesktop.NetworkManager.Settings.SaveHostname(), The SaveHostname() method -
-
org.freedesktop.NetworkManager.Settings::ConnectionRemoved, The "ConnectionRemoved" signal -
-
org.freedesktop.NetworkManager.Settings::NewConnection, The "NewConnection" signal -
-
org.freedesktop.NetworkManager.Settings:CanModify, The "CanModify" property -
-
org.freedesktop.NetworkManager.Settings:Connections, The "Connections" property -
-
org.freedesktop.NetworkManager.Settings:Hostname, The "Hostname" property -
-
org.freedesktop.NetworkManager.Settings:VersionId, The "VersionId" property -
-
-
-
-

A

-
-
accept-all-mac-addresses, 802-3-ethernet -
-
org.freedesktop.NetworkManager.Connection.Active, org.freedesktop.NetworkManager.Connection.Active -
-
org.freedesktop.NetworkManager.Connection.Active::StateChanged, The "StateChanged" signal -
-
org.freedesktop.NetworkManager.Connection.Active:Connection, The "Connection" property -
-
org.freedesktop.NetworkManager.Connection.Active:Controller, The "Controller" property -
-
org.freedesktop.NetworkManager.Connection.Active:Default, The "Default" property -
-
org.freedesktop.NetworkManager.Connection.Active:Default6, The "Default6" property -
-
org.freedesktop.NetworkManager.Connection.Active:Devices, The "Devices" property -
-
org.freedesktop.NetworkManager.Connection.Active:Dhcp4Config, The "Dhcp4Config" property -
-
org.freedesktop.NetworkManager.Connection.Active:Dhcp6Config, The "Dhcp6Config" property -
-
org.freedesktop.NetworkManager.Connection.Active:Id, The "Id" property -
-
org.freedesktop.NetworkManager.Connection.Active:Ip4Config, The "Ip4Config" property -
-
org.freedesktop.NetworkManager.Connection.Active:Ip6Config, The "Ip6Config" property -
-
org.freedesktop.NetworkManager.Connection.Active:Master, The "Master" property -
-
org.freedesktop.NetworkManager.Connection.Active:SpecificObject, The "SpecificObject" property -
-
org.freedesktop.NetworkManager.Connection.Active:State, The "State" property -
-
org.freedesktop.NetworkManager.Connection.Active:StateFlags, The "StateFlags" property -
-
org.freedesktop.NetworkManager.Connection.Active:Type, The "Type" property -
-
org.freedesktop.NetworkManager.Connection.Active:Uuid, The "Uuid" property -
-
org.freedesktop.NetworkManager.Connection.Active:Vpn, The "Vpn" property -
-
addr-gen-mode, ipv6 -
-
address-data, ipv4, ipv6 -
-
addresses, ipv4, ipv6 -
-
ageing, vxlan -
-
ageing-time, bridge -
-
altsubject-matches, 802-1x -
-
anonymous-identity, 802-1x -
-
ap-isolation, 802-11-wireless -
-
apn, gsm -
-
app-fcoe-flags, dcb -
-
app-fcoe-mode, dcb -
-
app-fcoe-priority, dcb -
-
app-fip-flags, dcb -
-
app-fip-priority, dcb -
-
app-iscsi-flags, dcb -
-
app-iscsi-priority, dcb -
-
assigned-mac-address, 802-3-ethernet, 802-11-wireless -
-
auth-alg, 802-11-wireless-security -
-
auth-retries, connection -
-
auth-timeout, 802-1x -
-
auto-config, gsm -
-
auto-negotiate, 802-3-ethernet -
-
auto-route-ext-gw, ipv4, ipv6 -
-
autoconnect, connection -
-
autoconnect-ports, connection -
-
autoconnect-priority, connection -
-
autoconnect-retries, connection -
-
autoconnect-slaves, connection -
-
autoprobe-drivers, sriov -
-
-
-
-

B

-
-
band, 802-11-wireless -
-
baud, ppp, serial -
-
bdaddr, bluetooth -
-
bits, serial -
-
bond-downdelay, ovs-port -
-
bond-mode, ovs-port -
-
bond-updelay, ovs-port -
-
browser-only, proxy -
-
bssid, 802-11-wireless -
-
-
-
-

C

-
-
ca-cert, 802-1x -
-
ca-cert-password, 802-1x -
-
ca-cert-password-flags, 802-1x -
-
ca-path, 802-1x -
-
channel, 802-11-olpc-mesh, 802-11-wireless, wpan -
-
channel-width, 802-11-wireless -
-
org.freedesktop.NetworkManager.Checkpoint, org.freedesktop.NetworkManager.Checkpoint -
-
org.freedesktop.NetworkManager.Checkpoint:Created, The "Created" property -
-
org.freedesktop.NetworkManager.Checkpoint:Devices, The "Devices" property -
-
org.freedesktop.NetworkManager.Checkpoint:RollbackTimeout, The "RollbackTimeout" property -
-
client-cert, 802-1x -
-
client-cert-password, 802-1x -
-
client-cert-password-flags, 802-1x -
-
cloned-mac-address, 802-3-ethernet, 802-11-wireless -
-
config, team, team-port -
-
controller, connection -
-
crtscts, ppp -
-
-
-
-

D

-
-
dad-timeout, ipv4, ipv6 -
-
data, user, vpn, ovs-external-ids, ovs-other-config -
-
datapath-type, ovs-bridge -
-
destination-port, vxlan -
-
devargs, ovs-dpdk -
-
device-handler, generic -
-
device-id, gsm -
-
org.freedesktop.NetworkManager.Device.Wired, org.freedesktop.NetworkManager.Device.Wired -
-
org.freedesktop.NetworkManager.Device.Wired:Carrier, The "Carrier" property -
-
org.freedesktop.NetworkManager.Device.Wired:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Wired:PermHwAddress, The "PermHwAddress" property -
-
org.freedesktop.NetworkManager.Device.Wired:S390Subchannels, The "S390Subchannels" property -
-
org.freedesktop.NetworkManager.Device.Wired:Speed, The "Speed" property -
-
org.freedesktop.NetworkManager.Device.Wireless, org.freedesktop.NetworkManager.Device.Wireless -
-
org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints(), The GetAccessPoints() method -
-
org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints(), The GetAllAccessPoints() method -
-
org.freedesktop.NetworkManager.Device.Wireless.RequestScan(), The RequestScan() method -
-
org.freedesktop.NetworkManager.Device.Wireless::AccessPointAdded, The "AccessPointAdded" signal -
-
org.freedesktop.NetworkManager.Device.Wireless::AccessPointRemoved, The "AccessPointRemoved" signal -
-
org.freedesktop.NetworkManager.Device.Wireless:AccessPoints, The "AccessPoints" property -
-
org.freedesktop.NetworkManager.Device.Wireless:ActiveAccessPoint, The "ActiveAccessPoint" property -
-
org.freedesktop.NetworkManager.Device.Wireless:Bitrate, The "Bitrate" property -
-
org.freedesktop.NetworkManager.Device.Wireless:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.Wireless:LastScan, The "LastScan" property -
-
org.freedesktop.NetworkManager.Device.Wireless:Mode, The "Mode" property -
-
org.freedesktop.NetworkManager.Device.Wireless:PermHwAddress, The "PermHwAddress" property -
-
org.freedesktop.NetworkManager.Device.Wireless:WirelessCapabilities, The "WirelessCapabilities" property -
-
org.freedesktop.NetworkManager.Device.WifiP2P, org.freedesktop.NetworkManager.Device.WifiP2P -
-
org.freedesktop.NetworkManager.Device.WifiP2P.StartFind(), The StartFind() method -
-
org.freedesktop.NetworkManager.Device.WifiP2P.StopFind(), The StopFind() method -
-
org.freedesktop.NetworkManager.Device.WifiP2P::PeerAdded, The "PeerAdded" signal -
-
org.freedesktop.NetworkManager.Device.WifiP2P::PeerRemoved, The "PeerRemoved" signal -
-
org.freedesktop.NetworkManager.Device.WifiP2P:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.Device.WifiP2P:Peers, The "Peers" property -
-
dhcp-anycast-address, 802-11-olpc-mesh -
-
dhcp-client-id, ipv4 -
-
dhcp-dscp, ipv4, ipv6 -
-
dhcp-duid, ipv6 -
-
dhcp-fqdn, ipv4 -
-
dhcp-hostname, ipv4, ipv6 -
-
dhcp-hostname-flags, ipv4, ipv6 -
-
dhcp-iaid, ipv4, ipv6 -
-
dhcp-pd-hint, ipv6 -
-
dhcp-reject-servers, ipv4, ipv6 -
-
dhcp-send-hostname, ipv4, ipv6 -
-
dhcp-send-release, ipv4, ipv6 -
-
dhcp-timeout, ipv4, ipv6 -
-
dhcp-vendor-class-identifier, ipv4 -
-
org.freedesktop.NetworkManager.DHCP4Config, org.freedesktop.NetworkManager.DHCP4Config -
-
org.freedesktop.NetworkManager.DHCP4Config:Options, The "Options" property -
-
org.freedesktop.NetworkManager.DHCP6Config, org.freedesktop.NetworkManager.DHCP6Config -
-
org.freedesktop.NetworkManager.DHCP6Config:Options, The "Options" property -
-
dns, ipv4, ipv6 -
-
dns-data, ipv4, ipv6 -
-
dns-options, ipv4, ipv6 -
-
dns-over-tls, connection -
-
dns-priority, ipv4, ipv6 -
-
dns-search, ipv4, ipv6 -
-
domain-match, 802-1x -
-
domain-suffix-match, 802-1x -
-
down-on-poweroff, connection -
-
driver, match -
-
duplex, 802-3-ethernet -
-
-
-
-

E

-
-
eap, 802-1x -
-
egress-priority-map, vlan -
-
encapsulation, adsl -
-
encapsulation-limit, ip-tunnel -
-
encrypt, macsec -
-
eswitch-encap-mode, sriov -
-
eswitch-inline-mode, sriov -
-
eswitch-mode, sriov -
-
-
-
-

F

-
-
fail-mode, ovs-bridge -
-
fils, 802-11-wireless-security -
-
flags, ip-tunnel, vlan -
-
flow-label, ip-tunnel -
-
forward-delay, bridge -
-
from-dhcp, hostname -
-
from-dns-lookup, hostname -
-
fwmark, ip-tunnel, wireguard -
-
-
-
-

G

-
-
gateway, ipv4, ipv6 -
-
gateway-ping-timeout, connection -
-
generate-mac-address-mask, 802-3-ethernet, 802-11-wireless -
-
gro-max-size, link -
-
group, tun, 802-11-wireless-security -
-
group-address, bridge -
-
group-forward-mask, bridge -
-
gso-max-segments, link -
-
gso-max-size, link -
-
-
-
-

H

-
-
hairpin-mode, bridge-port -
-
hello-time, bridge -
-
hidden, 802-11-wireless -
-
home-only, gsm -
-
-
-
-

I

-
-
id, connection, vlan, vxlan -
-
identity, 802-1x -
-
ignore-auto-dns, ipv4, ipv6 -
-
ignore-auto-routes, ipv4, ipv6 -
-
ingress-priority-map, vlan -
-
initial-eps-bearer-apn, gsm -
-
initial-eps-bearer-configure, gsm -
-
input-key, ip-tunnel -
-
interface-name, connection, bond, bridge, match, team, vlan -
-
ip4-auto-default-route, wireguard -
-
ip6-auto-default-route, wireguard -
-
ip6-privacy, ipv6 -
-
-
-
-

K

-
-
kernel-command-line, match -
-
key-mgmt, 802-11-wireless-security -
-
-
-
-

L

-
-
l2-miss, vxlan -
-
l3-miss, vxlan -
-
lacp, ovs-port -
-
lacp-key, team-port -
-
lacp-prio, team-port -
-
lcp-echo-failure, ppp -
-
lcp-echo-interval, ppp -
-
leap-password, 802-11-wireless-security -
-
leap-password-flags, 802-11-wireless-security -
-
leap-username, 802-11-wireless-security -
-
learning, vxlan -
-
limit, vxlan -
-
link-local, ipv4 -
-
link-watchers, team, team-port -
-
listen-port, wireguard -
-
lldp, connection -
-
llmnr, connection -
-
local, ip-tunnel, vxlan -
-
-
-
-

M

-
-
mac-address, bridge, infiniband, wimax, 802-3-ethernet, 802-11-wireless, wpan -
-
mac-address-blacklist, 802-3-ethernet, 802-11-wireless -
-
mac-address-denylist, 802-3-ethernet, 802-11-wireless -
-
mac-address-randomization, 802-11-wireless -
-
org.freedesktop.NetworkManager, org.freedesktop.NetworkManager -
-
org.freedesktop.NetworkManager.ActivateConnection(), The ActivateConnection() method -
-
org.freedesktop.NetworkManager.AddAndActivateConnection(), The AddAndActivateConnection() method -
-
org.freedesktop.NetworkManager.AddAndActivateConnection2(), The AddAndActivateConnection2() method -
-
org.freedesktop.NetworkManager.CheckConnectivity(), The CheckConnectivity() method -
-
org.freedesktop.NetworkManager.CheckpointAdjustRollbackTimeout(), The CheckpointAdjustRollbackTimeout() method -
-
org.freedesktop.NetworkManager.CheckpointCreate(), The CheckpointCreate() method -
-
org.freedesktop.NetworkManager.CheckpointDestroy(), The CheckpointDestroy() method -
-
org.freedesktop.NetworkManager.CheckpointRollback(), The CheckpointRollback() method -
-
org.freedesktop.NetworkManager.DeactivateConnection(), The DeactivateConnection() method -
-
org.freedesktop.NetworkManager.Enable(), The Enable() method -
-
org.freedesktop.NetworkManager.GetAllDevices(), The GetAllDevices() method -
-
org.freedesktop.NetworkManager.GetDeviceByIpIface(), The GetDeviceByIpIface() method -
-
org.freedesktop.NetworkManager.GetDevices(), The GetDevices() method -
-
org.freedesktop.NetworkManager.GetLogging(), The GetLogging() method -
-
org.freedesktop.NetworkManager.GetPermissions(), The GetPermissions() method -
-
org.freedesktop.NetworkManager.Reload(), The Reload() method -
-
org.freedesktop.NetworkManager.SetLogging(), The SetLogging() method -
-
org.freedesktop.NetworkManager.Sleep(), The Sleep() method -
-
org.freedesktop.NetworkManager.state(), The state() method -
-
org.freedesktop.NetworkManager::CheckPermissions, The "CheckPermissions" signal -
-
org.freedesktop.NetworkManager::DeviceAdded, The "DeviceAdded" signal -
-
org.freedesktop.NetworkManager::DeviceRemoved, The "DeviceRemoved" signal -
-
org.freedesktop.NetworkManager::StateChanged, The "StateChanged" signal -
-
org.freedesktop.NetworkManager:ActivatingConnection, The "ActivatingConnection" property -
-
org.freedesktop.NetworkManager:ActiveConnections, The "ActiveConnections" property -
-
org.freedesktop.NetworkManager:AllDevices, The "AllDevices" property -
-
org.freedesktop.NetworkManager:Capabilities, The "Capabilities" property -
-
org.freedesktop.NetworkManager:Checkpoints, The "Checkpoints" property -
-
org.freedesktop.NetworkManager:Connectivity, The "Connectivity" property -
-
org.freedesktop.NetworkManager:ConnectivityCheckAvailable, The "ConnectivityCheckAvailable" property -
-
org.freedesktop.NetworkManager:ConnectivityCheckEnabled, The "ConnectivityCheckEnabled" property -
-
org.freedesktop.NetworkManager:ConnectivityCheckUri, The "ConnectivityCheckUri" property -
-
org.freedesktop.NetworkManager:Devices, The "Devices" property -
-
org.freedesktop.NetworkManager:GlobalDnsConfiguration, The "GlobalDnsConfiguration" property -
-
org.freedesktop.NetworkManager:Metered, The "Metered" property -
-
org.freedesktop.NetworkManager:NetworkingEnabled, The "NetworkingEnabled" property -
-
org.freedesktop.NetworkManager:PrimaryConnection, The "PrimaryConnection" property -
-
org.freedesktop.NetworkManager:PrimaryConnectionType, The "PrimaryConnectionType" property -
-
org.freedesktop.NetworkManager:RadioFlags, The "RadioFlags" property -
-
org.freedesktop.NetworkManager:Startup, The "Startup" property -
-
org.freedesktop.NetworkManager:State, The "State" property -
-
org.freedesktop.NetworkManager:Version, The "Version" property -
-
org.freedesktop.NetworkManager:VersionInfo, The "VersionInfo" property -
-
org.freedesktop.NetworkManager:WimaxEnabled, The "WimaxEnabled" property -
-
org.freedesktop.NetworkManager:WimaxHardwareEnabled, The "WimaxHardwareEnabled" property -
-
org.freedesktop.NetworkManager:WirelessEnabled, The "WirelessEnabled" property -
-
org.freedesktop.NetworkManager:WirelessHardwareEnabled, The "WirelessHardwareEnabled" property -
-
org.freedesktop.NetworkManager:WwanEnabled, The "WwanEnabled" property -
-
org.freedesktop.NetworkManager:WwanHardwareEnabled, The "WwanHardwareEnabled" property -
-
master, connection -
-
max-age, bridge -
-
may-fail, ipv4, ipv6 -
-
mcast-rejoin-count, team -
-
mcast-rejoin-interval, team -
-
mcast-snooping-enable, ovs-bridge -
-
mdns, connection -
-
metered, connection -
-
method, ipv4, ipv6, proxy -
-
mka-cak, macsec -
-
mka-cak-flags, macsec -
-
mka-ckn, macsec -
-
mode, ip-tunnel, macsec, macvlan, tun, 802-11-wireless -
-
mppe-stateful, ppp -
-
mptcp-flags, connection -
-
mru, ppp -
-
mtu, cdma, gsm, infiniband, ipv6, ip-tunnel, ppp, 802-3-ethernet, wireguard, 802-11-wireless, loopback -
-
mud-url, connection -
-
multi-connect, connection -
-
multi-queue, tun -
-
multicast-hash-max, bridge -
-
multicast-last-member-count, bridge -
-
multicast-last-member-interval, bridge -
-
multicast-membership-interval, bridge -
-
multicast-querier, bridge -
-
multicast-querier-interval, bridge -
-
multicast-query-interval, bridge -
-
multicast-query-response-interval, bridge -
-
multicast-query-use-ifaddr, bridge -
-
multicast-router, bridge -
-
multicast-snooping, bridge -
-
multicast-spec, hsr -
-
multicast-startup-query-count, bridge -
-
multicast-startup-query-interval, bridge -
-
-
-
-

N

-
-
n-rxq, ovs-dpdk -
-
n-rxq-desc, ovs-dpdk -
-
n-txq-desc, ovs-dpdk -
-
network-id, gsm -
-
network-name, wimax -
-
never-default, ipv4, ipv6 -
-
NM80211ApFlags, enum NM80211ApFlags -
-
NM80211ApSecurityFlags, enum NM80211ApSecurityFlags -
-
NM80211Mode, enum NM80211Mode -
-
NMActivationStateFlags, enum NMActivationStateFlags -
-
NMActiveConnectionState, enum NMActiveConnectionState -
-
NMActiveConnectionStateReason, enum NMActiveConnectionStateReason -
-
NMBluetoothCapabilities, enum NMBluetoothCapabilities -
-
NMCapability, enum NMCapability -
-
NMCheckpointCreateFlags, enum NMCheckpointCreateFlags -
-
NMClientPermission, enum NMClientPermission -
-
NMClientPermissionResult, enum NMClientPermissionResult -
-
NMConnectionMultiConnect, enum NMConnectionMultiConnect -
-
NMConnectivityState, enum NMConnectivityState -
-
NMDeviceCapabilities, enum NMDeviceCapabilities -
-
NMDeviceInterfaceFlags, enum NMDeviceInterfaceFlags -
-
NMDeviceModemCapabilities, enum NMDeviceModemCapabilities -
-
NMDeviceReapplyFlags, enum NMDeviceReapplyFlags -
-
NMDeviceState, enum NMDeviceState -
-
NMDeviceStateReason, enum NMDeviceStateReason -
-
NMDeviceType, enum NMDeviceType -
-
NMDeviceWifiCapabilities, enum NMDeviceWifiCapabilities -
-
NMIPTunnelMode, enum NMIPTunnelMode -
-
NMManagerReloadFlags, enum NMManagerReloadFlags -
-
NMMetered, enum NMMetered -
-
NMMptcpFlags, enum NMMptcpFlags -
-
NMRadioFlags, enum NMRadioFlags -
-
NMRollbackResult, enum NMRollbackResult -
-
NMSecretAgentCapabilities, enum NMSecretAgentCapabilities -
-
NMSecretAgentGetSecretsFlags, enum NMSecretAgentGetSecretsFlags -
-
NMSettingsAddConnection2Flags, enum NMSettingsAddConnection2Flags -
-
NMSettingsConnectionFlags, enum NMSettingsConnectionFlags -
-
NMSettingsUpdate2Flags, enum NMSettingsUpdate2Flags -
-
NMState, enum NMState -
-
NMTernary, enum NMTernary -
-
NMVersionInfoCapability, enum NMVersionInfoCapability -
-
NMVpnConnectionState, enum NMVpnConnectionState -
-
NMVpnConnectionStateReason, enum NMVpnConnectionStateReason -
-
NMVpnPluginFailure, enum NMVpnPluginFailure -
-
NMVpnServiceState, enum NMVpnServiceState -
-
NMWimaxNspNetworkType, enum NMWimaxNspNetworkType -
-
no-vj-comp, ppp -
-
noauth, ppp -
-
nobsdcomp, ppp -
-
nodeflate, ppp -
-
notify-peers-count, team -
-
notify-peers-interval, team -
-
number, cdma, gsm -
-
-
-
-

O

-
-
offload, macsec -
-
ofport-request, ovs-interface -
-
only-from-default, hostname -
-
openssl-ciphers, 802-1x -
-
optional, 802-1x -
-
options, bond -
-
output-key, ip-tunnel -
-
owner, tun -
-
-
-
-

P

-
-
p-key, infiniband -
-
pac-file, 802-1x -
-
pac-script, proxy -
-
pac-url, proxy -
-
page, wpan -
-
pairwise, 802-11-wireless-security -
-
pan-id, wpan -
-
parent, 6lowpan, infiniband, ip-tunnel, macsec, macvlan, pppoe, vlan, vxlan -
-
parity, serial -
-
password, 802-1x, adsl, cdma, gsm, pppoe -
-
password-flags, 802-1x, adsl, cdma, gsm, pppoe -
-
password-raw, 802-1x -
-
password-raw-flags, 802-1x -
-
path, match -
-
path-cost, bridge-port -
-
path-mtu-discovery, ip-tunnel -
-
peer, ovs-patch, wifi-p2p, veth -
-
peer-routes, wireguard -
-
peers, wireguard -
-
permissions, connection -
-
persistent, vpn -
-
phase1-auth-flags, 802-1x -
-
phase1-fast-provisioning, 802-1x -
-
phase1-peaplabel, 802-1x -
-
phase1-peapver, 802-1x -
-
phase2-altsubject-matches, 802-1x -
-
phase2-auth, 802-1x -
-
phase2-autheap, 802-1x -
-
phase2-ca-cert, 802-1x -
-
phase2-ca-cert-password, 802-1x -
-
phase2-ca-cert-password-flags, 802-1x -
-
phase2-ca-path, 802-1x -
-
phase2-client-cert, 802-1x -
-
phase2-client-cert-password, 802-1x -
-
phase2-client-cert-password-flags, 802-1x -
-
phase2-domain-match, 802-1x -
-
phase2-domain-suffix-match, 802-1x -
-
phase2-private-key, 802-1x -
-
phase2-private-key-password, 802-1x -
-
phase2-private-key-password-flags, 802-1x -
-
phase2-subject-match, 802-1x -
-
pi, tun -
-
pin, 802-1x, gsm -
-
pin-flags, 802-1x, gsm -
-
pmf, 802-11-wireless-security -
-
port, macsec, 802-3-ethernet -
-
port-type, connection -
-
port1, hsr -
-
port2, hsr -
-
powersave, 802-11-wireless -
-
org.freedesktop.NetworkManager.PPP, org.freedesktop.NetworkManager.PPP -
-
org.freedesktop.NetworkManager.PPP.NeedSecrets(), The NeedSecrets() method -
-
org.freedesktop.NetworkManager.PPP.SetIfindex(), The SetIfindex() method -
-
org.freedesktop.NetworkManager.PPP.SetIp4Config(), The SetIp4Config() method -
-
org.freedesktop.NetworkManager.PPP.SetIp6Config(), The SetIp6Config() method -
-
org.freedesktop.NetworkManager.PPP.SetState(), The SetState() method -
-
prio, team-port, bond-port -
-
priority, bridge, bridge-port, hostname -
-
priority-bandwidth, dcb -
-
priority-flow-control, dcb -
-
priority-flow-control-flags, dcb -
-
priority-group-bandwidth, dcb -
-
priority-group-flags, dcb -
-
priority-group-id, dcb -
-
priority-strict-bandwidth, dcb -
-
priority-traffic-class, dcb -
-
private-key, 802-1x, wireguard -
-
private-key-flags, wireguard -
-
private-key-password, 802-1x -
-
private-key-password-flags, 802-1x -
-
promiscuous, macvlan -
-
proto, 802-11-wireless-security -
-
protocol, adsl, vlan -
-
proxy, vxlan -
-
prp, hsr -
-
psk, 802-11-wireless-security -
-
psk-flags, 802-11-wireless-security -
-
-
-
-

Q

-
-
qdiscs, tc -
-
queue-id, team-port, bond-port -
-
-
-
-

R

-
-
ra-timeout, ipv6 -
-
rate, 802-11-wireless -
-
read-only, connection -
-
refuse-chap, ppp -
-
refuse-eap, ppp -
-
refuse-mschap, ppp -
-
refuse-mschapv2, ppp -
-
refuse-pap, ppp -
-
remote, ip-tunnel, vxlan -
-
replace-local-rule, ipv4, ipv6 -
-
require-mppe, ppp -
-
require-mppe-128, ppp -
-
required-timeout, ipv4, ipv6 -
-
route-data, ipv4, ipv6 -
-
route-metric, ipv4, ipv6 -
-
route-table, ipv4, ipv6 -
-
routes, ipv4, ipv6 -
-
routing-rules, ipv4, ipv6 -
-
rsc, vxlan -
-
rstp-enable, ovs-bridge -
-
runner, team -
-
runner-active, team -
-
runner-agg-select-policy, team -
-
runner-fast-rate, team -
-
runner-hwaddr-policy, team -
-
runner-min-ports, team -
-
runner-sys-prio, team -
-
runner-tx-balancer, team -
-
runner-tx-balancer-interval, team -
-
runner-tx-hash, team -
-
-
-
-

S

-
-
s390-nettype, 802-3-ethernet -
-
s390-options, 802-3-ethernet -
-
s390-subchannels, 802-3-ethernet -
-
secondaries, connection -
-
secrets, vpn -
-
security, 802-11-wireless -
-
seen-bssids, 802-11-wireless -
-
send-delay, serial -
-
send-sci, macsec -
-
service, pppoe -
-
service-type, vpn -
-
short-address, wpan -
-
sim-id, gsm -
-
sim-operator-id, gsm -
-
slave-type, connection -
-
source-port-max, vxlan -
-
source-port-min, vxlan -
-
speed, 802-3-ethernet -
-
ssid, 802-11-olpc-mesh, 802-11-wireless -
-
stable-id, connection -
-
sticky, team-port -
-
stopbits, serial -
-
stp, bridge -
-
stp-enable, ovs-bridge -
-
subject-match, 802-1x -
-
system-ca-certs, 802-1x -
-
-
-
-

T

-
-
table, vrf -
-
tag, ovs-port -
-
tap, macvlan -
-
temp-preferred-lifetime, ipv6 -
-
temp-valid-lifetime, ipv6 -
-
tfilters, tc -
-
timeout, vpn -
-
timestamp, connection -
-
token, ipv6 -
-
tos, ip-tunnel, vxlan -
-
total-vfs, sriov -
-
transport-mode, infiniband -
-
trunks, ovs-port -
-
ttl, ip-tunnel, vxlan -
-
tx-power, 802-11-wireless -
-
tx-queue-length, link -
-
type, connection, bluetooth, ovs-interface -
-
-
-
-

U

-
-
user-name, vpn -
-
username, adsl, cdma, gsm, pppoe -
-
uuid, connection -
-
-
-
-

V

-
-
validation, macsec -
-
vci, adsl -
-
vfs, sriov -
-
vlan-default-pvid, bridge -
-
vlan-filtering, bridge -
-
vlan-mode, ovs-port -
-
vlan-protocol, bridge -
-
vlan-stats-enabled, bridge -
-
vlans, bridge, bridge-port -
-
vnet-hdr, tun -
-
vpi, adsl -
-
org.freedesktop.NetworkManager.VPN.Connection, org.freedesktop.NetworkManager.VPN.Connection -
-
org.freedesktop.NetworkManager.VPN.Connection::VpnStateChanged, The "VpnStateChanged" signal -
-
org.freedesktop.NetworkManager.VPN.Connection:Banner, The "Banner" property -
-
org.freedesktop.NetworkManager.VPN.Connection:VpnState, The "VpnState" property -
-
org.freedesktop.NetworkManager.VPN.Plugin, org.freedesktop.NetworkManager.VPN.Plugin -
-
org.freedesktop.NetworkManager.VPN.Plugin.Connect(), The Connect() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive(), The ConnectInteractive() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.Disconnect(), The Disconnect() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets(), The NeedSecrets() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets(), The NewSecrets() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.SetConfig(), The SetConfig() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.SetFailure(), The SetFailure() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config(), The SetIp4Config() method -
-
org.freedesktop.NetworkManager.VPN.Plugin.SetIp6Config(), The SetIp6Config() method -
-
org.freedesktop.NetworkManager.VPN.Plugin::Config, The "Config" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::Failure, The "Failure" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::Ip4Config, The "Ip4Config" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::Ip6Config, The "Ip6Config" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::LoginBanner, The "LoginBanner" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::SecretsRequired, The "SecretsRequired" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin::StateChanged, The "StateChanged" signal -
-
org.freedesktop.NetworkManager.VPN.Plugin:State, The "State" property -
-
-
-
-

W

-
-
wait-activation-delay, connection -
-
wait-device-timeout, connection -
-
wake-on-lan, 802-3-ethernet -
-
wake-on-lan-password, 802-3-ethernet -
-
wake-on-wlan, 802-11-wireless -
-
wep-key-flags, 802-11-wireless-security -
-
wep-key-type, 802-11-wireless-security -
-
wep-key0, 802-11-wireless-security -
-
wep-key1, 802-11-wireless-security -
-
wep-key2, 802-11-wireless-security -
-
wep-key3, 802-11-wireless-security -
-
wep-tx-keyidx, 802-11-wireless-security -
-
wfd-ies, wifi-p2p -
-
org.freedesktop.NetworkManager.WifiP2PPeer, org.freedesktop.NetworkManager.WifiP2PPeer -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Flags, The "Flags" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:HwAddress, The "HwAddress" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:LastSeen, The "LastSeen" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Manufacturer, The "Manufacturer" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Model, The "Model" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:ModelNumber, The "ModelNumber" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Name, The "Name" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Serial, The "Serial" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:Strength, The "Strength" property -
-
org.freedesktop.NetworkManager.WifiP2PPeer:WfdIEs, The "WfdIEs" property -
-
wps-method, wifi-p2p, 802-11-wireless-security -
-
-
-
-

Z

-
zone, connection -
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/left-insensitive.png b/docs/api/html/left-insensitive.png deleted file mode 100644 index 3269393a..00000000 Binary files a/docs/api/html/left-insensitive.png and /dev/null differ diff --git a/docs/api/html/left.png b/docs/api/html/left.png deleted file mode 100644 index 2abde032..00000000 Binary files a/docs/api/html/left.png and /dev/null differ diff --git a/docs/api/html/license.html b/docs/api/html/license.html deleted file mode 100644 index 2932fe3a..00000000 --- a/docs/api/html/license.html +++ /dev/null @@ -1,51 +0,0 @@ - - - - -Appendix A. License: NetworkManager Reference Manual - - - - - - - - - - - - - - - -
-

-Appendix A. License

-

- This program is free software; you can redistribute - it and/or modify it under the terms of the GNU - General Public License as published by the Free - Software Foundation; either version 2 of the License, or - (at your option) any later version. -

-

- This program is distributed in the hope that it will - be useful, but WITHOUT ANY WARRANTY; without even the - implied warranty of MERCHANTABILITY or FITNESS FOR A - PARTICULAR PURPOSE. See the GNU General Public License for - more details. -

-

- You should have received a copy of the GNU - General Public License along with this program. -

-

- A copy of the GNU General Public License - can also be obtained from the - GNU web site. -

-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/manpages.html b/docs/api/html/manpages.html deleted file mode 100644 index 5874dd19..00000000 --- a/docs/api/html/manpages.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - -Part I. Manual Pages: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Part I. Manual Pages

-
-

Table of Contents

-
-
-NetworkManager — network management daemon -
-
-NetworkManager.conf — NetworkManager configuration file -
-
-NetworkManager-dispatcher — Dispatch user scripts for NetworkManager -
-
-NetworkManager-wait-online.service — Wait for the network to come online -
-
-nmcli — command-line tool for controlling NetworkManager -
-
-nmcli-examples — usage examples of nmcli -
-
-nmtui — Text User Interface for controlling NetworkManager -
-
-nm-settings-dbus — Description of settings and properties of NetworkManager connection profiles on the D-Bus API -
-
-nm-settings-nmcli — Description of settings and properties of NetworkManager connection profiles for nmcli -
-
-nm-settings-keyfile — Description of keyfile settings plugin -
-
-nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin -
-
-nm-online — ask NetworkManager whether the network is connected -
-
-nm-initrd-generator — early boot NetworkManager configuration generator -
-
-nm-cloud-setup — Overview of Automatic Network Configuration in Cloud -
-
-nm-openvswitch — overview of NetworkManager Open vSwitch support -
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-cloud-setup.html b/docs/api/html/nm-cloud-setup.html deleted file mode 100644 index da035f07..00000000 --- a/docs/api/html/nm-cloud-setup.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - -nm-cloud-setup: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-cloud-setup

-

nm-cloud-setup — Overview of Automatic Network Configuration in Cloud

-
-
-

Overview

-

When running a virtual machine in a public cloud environment, it is - desirable to automatically configure the network of that VM. - In simple setups, the VM only has one network interface and the public - cloud supports automatic configuration via DHCP, DHCP6 or IPv6 autoconf. - However, the virtual machine might have multiple network - interfaces, or multiple IP addresses and IP subnets - on one interface which cannot be configured via DHCP. Also, the administrator - may reconfigure the network while the machine is running. NetworkManager's - nm-cloud-setup is a tool - that automatically picks up such configuration in cloud environments and updates the network - configuration of the host.

-

Multiple cloud providers are supported. See the section called “Supported Cloud Providers”.

-
-
-

Use

-

The goal of nm-cloud-setup is to be configuration-less and work automatically. - All you need is to opt-in to the desired cloud providers (see the section called “Environment Variables”) - and run /usr/libexec/nm-cloud-setup.

-

Usually this is done by enabling the nm-cloud-setup.service systemd service - and let it run periodically. For that there is both a nm-cloud-setup.timer systemd timer - and a NetworkManager dispatcher script.

-
-
-

Details

-

- nm-cloud-setup configures the network by fetching the configuration from - the well-known meta data server of the cloud provider. That means, it already - needs the network configured to the point where it can reach the meta data - server. Commonly that means, that a simple connection profile is activated - that possibly uses DHCP to get the primary IP address. NetworkManager will - create such a profile for ethernet devices automatically if it is not configured - otherwise via "no-auto-default" setting in NetworkManager.conf. - One possible alternative may be to create such an initial profile with - nmcli device connect "$DEVICE" or - nmcli connection add type ethernet .... -

-

- By setting the user-data org.freedesktop.nm-cloud-setup.skip=yes - on the profile, nm-cloud-setup will skip the device. -

-

nm-cloud-setup modifies the run time configuration akin to nmcli device modify. - With this approach, the configuration is not persisted - and only preserved until the device disconnects.

-
-

/usr/libexec/nm-cloud-setup

-

The binary /usr/libexec/nm-cloud-setup does most of the - work. It supports no command line arguments but can be configured via environment - variables. - See the section called “Environment Variables” for the supported environment variables.

-

By default, all cloud providers are disabled unless you opt-in by enabling one - or several providers. If cloud providers are enabled, the program - tries to fetch the host's configuration from a meta data server of the cloud via HTTP. - If configuration could be not fetched, no cloud provider are detected and the - program quits. - If host configuration is obtained, the corresponding cloud provider is - successfully detected. Then the network of the host will be configured.

-

It is intended to re-run nm-cloud-setup every time when the configuration - (maybe) changes. The tool is idempotent, so it should be OK to also run it - more often than necessary. You could run /usr/libexec/nm-cloud-setup - directly. However it may be preferable to restart the nm-cloud-setup systemd - service instead or use the timer or dispatcher script to run it periodically (see below).

-
-
-
-

nm-cloud-setup.service systemd unit

-

Usually /usr/libexec/nm-cloud-setup is not run directly, - but only by systemctl restart nm-cloud-setup.service. This - ensures that the tool only runs once at any time. It also allows to integrate - with the nm-cloud-setup systemd timer, - and to enable/disable the service via systemd.

-

As you need to set environment variable to configure nm-cloud-setup binary, - you can do so via systemd override files. Try systemctl edit nm-cloud-setup.service.

-
-
-
-

nm-cloud-setup.timer systemd timer

-

/usr/libexec/nm-cloud-setup is intended to run - whenever an update is necessary. For example, during boot when when - changing the network configuration of the virtual machine via the cloud - provider.

-

One way to do this, is by enabling the nm-cloud-setup.timer systemd timer - with systemctl enable --now nm-cloud-setup.timer.

-
-
-
-

/usr/lib/NetworkManager/dispatcher.d/90-nm-cloud-setup.sh

-

There is also a NetworkManager dispatcher script that will - run for example when an interface is activated by NetworkManager. - Together with the nm-cloud-setup.timer systemd timer this - script is to automatically pick up changes to the network.

-

The dispatcher script will do nothing, unless the systemd service is - enabled. To use the dispatcher script you should therefor run - systemctl enable nm-cloud-setup.service once.

-
-
-
-

Environment Variables

-

The following environment variables are used to configure /usr/libexec/nm-cloud-setup. - You may want to configure them with a drop-in for the systemd service. - For example by calling systemctl edit nm-cloud-setup.service - and configuring [Service] Environment=, as described in - systemd.exec(5) - manual.

-
    -

  • NM_CLOUD_SETUP_LOG: control the logging verbosity. Set it - to one of TRACE, DEBUG, INFO, - WARN, ERR or OFF. The program - will print message on stdout and the default level is WARN. When - run as systemd service, the log will be collected by journald can can be seen with - journalctl.

    • -

  • NM_CLOUD_SETUP_AZURE: boolean, whether Microsoft Azure support is enabled. Defaults - to no.

    • -

  • NM_CLOUD_SETUP_EC2: boolean, whether Amazon EC2 (AWS) support is enabled. Defaults - to no.

    • -

  • NM_CLOUD_SETUP_GCP: boolean, whether Google GCP support is enabled. Defaults - to no.

    • -

  • NM_CLOUD_SETUP_ALIYUN: boolean, whether Alibaba Cloud (Aliyun) support is enabled. Defaults - to no.

    • -
-
-
-

Debugging

-

Enable debug logging by setting NM_CLOUD_SETUP_LOG environment variable to TRACE.

-

In the common case where nm-cloud-setup is running as systemd service, this can be done via systemctl edit nm-cloud-setup.service - and add Environment=NM_CLOUD_SETUP_LOG=TRACE to the [Service] section. Afterwards, the log can - be found in syslog via journalctl. You may also want to enable debug logging in NetworkManager as descibed - in the DEBUGGING section in NetworkManager(5) - manual. When sharing logs, it's best to share complete logs and not preemptively filter for NetworkManager or nm-cloud-setup logs.

-
-
-

Example Setup for Configuring and Predeploying nm-cloud-setup

-

As detailed before, nm-cloud-setup needs to be explicitly enabled. As it - runs as a systemd service and timer, that basically means to enable and configure - those. This can be done by dropping the correct files and symlinks to disk. -

-

- The following example enables nm-cloud-setup for Amazon EC2 cloud: -

-
-dnf install -y NetworkManager-cloud-setup
-
-mkdir -p /etc/systemd/system/nm-cloud-setup.service.d
-cat > /etc/systemd/system/nm-cloud-setup.service.d/10-enable-ec2.conf << EOF
-[Service]
-Environment=NM_CLOUD_SETUP_EC2=yes
-EOF
-
-# systemctl enable nm-cloud-setup.service
-mkdir -p /etc/systemd/system/NetworkManager.service.wants/
-ln -s /usr/lib/systemd/system/nm-cloud-setup.service /etc/systemd/system/NetworkManager.service.wants/nm-cloud-setup.service
-
-# systemctl enable nm-cloud-setup.timer
-mkdir -p /etc/systemd/system/timers.target.wants/
-ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/systemd/system/nm-cloud-setup.timer
-
-# systemctl daemon-reload
-
-

-

-
-
-

Supported Cloud Providers

-
-

Amazon EC2 (AWS)

-

For AWS, the tools tries to fetch configuration from http://169.254.169.254/. Currently, it only - configures IPv4 and does nothing about IPv6. It will do the following.

-
    -

  • First fetch http://169.254.169.254/latest/meta-data/ to determine whether the - expected API is present. This determines whether EC2 environment is detected and whether to proceed - to configure the host using EC2 meta data.

    • -

  • Fetch http://169.254.169.254/2018-09-24/meta-data/network/interfaces/macs/ to get the list - of available interface. Interfaces are identified by their MAC address.

    • -

  • Then for each interface fetch http://169.254.169.254/2018-09-24/meta-data/network/interfaces/macs/$MAC/subnet-ipv4-cidr-block - and http://169.254.169.254/2018-09-24/meta-data/network/interfaces/macs/$MAC/local-ipv4s. - Thereby we get a list of local IPv4 addresses and one CIDR subnet block.

    • -
  • -

    Then nm-cloud-setup iterates over all interfaces for which it could fetch IP configuration. - If no ethernet device for the respective MAC address is found, it is skipped. - Also, if the device is currently not activated in NetworkManager or if the currently - activated profile has a user-data org.freedesktop.nm-cloud-setup.skip=yes, - it is skipped.

    -

    If only one interface and one address is configured, then the tool does nothing - and leaves the automatic configuration that was obtained via DHCP.

    -

    Otherwise, the tool will change the runtime configuration of the device. -

    -
      -

    • Add static IPv4 addresses for all the configured addresses from local-ipv4s with - prefix length according to subnet-ipv4-cidr-block. For example, - we might have here 2 IP addresses like "172.16.5.3/24,172.16.5.4/24".

      • -
    • -

      Choose a route table 30400 + the index of the interface and - add a default route 0.0.0.0/0. The gateway - is the first IP address in the CIDR subnet block. For - example, we might get a route "0.0.0.0/0 172.16.5.1 10 table=30400".

      -

      Also choose a route table 30200 + the interface index. This - contains a direct routes to the subnets of this interface.

      -
      • -

    • Finally, add a policy routing rule for each address. For example - "priority 30200 from 172.16.5.3/32 table 30200, priority 30200 from 172.16.5.4/32 table 30200". - and - "priority 30400 from 172.16.5.3/32 table 30400, priority 30400 from 172.16.5.4/32 table 30400" - The 30200+ rules select the table to reach the subnet directly, while the 30400+ rules use the - default route. Also add a rule - "priority 30350 table main suppress_prefixlength 0". This has a priority between - the two previous rules and causes a lookup of routes in the main table while ignoring the default - route. The purpose of this is so that other specific routes in the main table are honored over - the default route in table 30400+.

      • -
    -

    - With above example, this roughly corresponds for interface eth0 to - nmcli device modify "eth0" ipv4.addresses "172.16.5.3/24,172.16.5.4/24" ipv4.routes "172.16.5.0/24 0.0.0.0 10 table=30200, 0.0.0.0/0 172.16.5.1 10 table=30400" ipv4.routing-rules "priority 30200 from 172.16.5.3/32 table 30200, priority 30200 from 172.16.5.4/32 table 30200, priority 20350 table main suppress_prefixlength 0, priority 30400 from 172.16.5.3/32 table 30400, priority 30400 from 172.16.5.4/32 table 30400". - Note that this replaces the previous addresses, routes and rules with the new information. - But also note that this only changes the run time configuration of the device. The - connection profile on disk is not affected. -

    -
    • -
-
-
-
-

Google Cloud Platform (GCP)

-

- For GCP, the meta data is fetched from URIs starting with http://metadata.google.internal/computeMetadata/v1/ with a - HTTP header "Metadata-Flavor: Google". - Currently, the tool only configures IPv4 and does nothing about IPv6. It will do the following. -

-
    -

  • First fetch http://metadata.google.internal/computeMetadata/v1/instance/id to detect whether the tool - runs on Google Cloud Platform. Only if the platform is detected, it will continue fetching the configuration.

    • -

  • Fetch http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/ to get the list - of available interface indexes. These indexes can be used for further lookups.

    • -

  • Then, for each interface fetch http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/$IFACE_INDEX/mac to get - the corresponding MAC address of the found interfaces. The MAC address is used to identify the device later on.

    • -

  • Then, for each interface with a MAC address fetch http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/$IFACE_INDEX/forwarded-ips/ - and then all the found IP addresses at http://metadata.google.internal/computeMetadata/v1/instance/network-interfaces/$IFACE_INDEX/forwarded-ips/$FIPS_INDEX. -

    • -
  • -

    At this point, we have a list of all interfaces (by MAC address) and their configured IPv4 addresses.

    -

    For each device, we lookup the currently applied connection in NetworkManager. That implies, that the device is currently activated - in NetworkManager. If no such device was in NetworkManager, or if the profile has user-data org.freedesktop.nm-cloud-setup.skip=yes, - we skip the device. Now for each found IP address we add a static route "$FIPS_ADDR/32 0.0.0.0 100 type=local" and reapply the change.

    -

    The effect is not unlike calling nmcli device modify "$DEVICE" ipv4.routes "$FIPS_ADDR/32 0.0.0.0 100 type=local [,...]" for all relevant - devices and all found addresses.

    -
    • -
-
-
-
-

Microsoft Azure

-

- For Azure, the meta data is fetched from URIs starting with http://169.254.169.254/metadata/instance with a - URL parameter "?format=text&api-version=2017-04-02" and a HTTP header "Metadata:true". - Currently, the tool only configures IPv4 and does nothing about IPv6. It will do the following. -

-
    -

  • First fetch http://169.254.169.254/metadata/instance?format=text&api-version=2017-04-02 to detect whether the tool - runs on Azure Cloud. Only if the platform is detected, it will continue fetching the configuration.

    • -

  • Fetch http://169.254.169.254/metadata/instance/network/interface/?format=text&api-version=2017-04-02 to get the list - of available interface indexes. These indexes can be used for further lookups.

    • -

  • Then, for each interface fetch http://169.254.169.254/metadata/instance/network/interface/$IFACE_INDEX/macAddress?format=text&api-version=2017-04-02 - to get the corresponding MAC address of the found interfaces. The MAC address is used to identify the device later on.

    • -

  • Then, for each interface with a MAC address fetch http://169.254.169.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/ipAddress/?format=text&api-version=2017-04-02 - to get the list of (indexes of) IP addresses on that interface. -

    • -

  • Then, for each IP address index fetch the address at - http://169.254.169.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/ipAddress/$ADDR_INDEX/privateIpAddress?format=text&api-version=2017-04-02. - Also fetch the size of the subnet and prefix for the interface from - http://169.254.169.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/subnet/0/address/?format=text&api-version=2017-04-02. - and - http://169.254.169.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/subnet/0/prefix/?format=text&api-version=2017-04-02. -

    • -
  • -

    At this point, we have a list of all interfaces (by MAC address) and their configured IPv4 addresses.

    -

    Then the tool configures the system like doing for AWS environment. That is, using source based policy routing - with the tables/rules 30200/30400.

    -
    • -
-
-
-
-

Alibaba Cloud (Aliyun)

-

For Aliyun, the tools tries to fetch configuration from http://100.100.100.200/. Currently, it only - configures IPv4 and does nothing about IPv6. It will do the following.

-
    -

  • First fetch http://100.100.100.200/2016-01-01/meta-data/ to determine whether the - expected API is present. This determines whether Aliyun environment is detected and whether to proceed - to configure the host using Aliyun meta data.

    • -

  • Fetch http://100.100.100.200/2016-01-01/meta-data/network/interfaces/macs/ to get the list - of available interface. Interfaces are identified by their MAC address.

    • -

  • Then for each interface fetch http://100.100.100.200/2016-01-01/meta-data/network/interfaces/macs/$MAC/vpc-cidr-block, - http://100.100.100.200/2016-01-01/meta-data/network/interfaces/macs/$MAC/private-ipv4s, - http://100.100.100.200/2016-01-01/meta-data/network/interfaces/macs/$MAC/netmask and - http://100.100.100.200/2016-01-01/meta-data/network/interfaces/macs/$MAC/gateway. - Thereby we get a list of private IPv4 addresses, one CIDR subnet block and private IPv4 addresses prefix.

    • -
  • -

    Then nm-cloud-setup iterates over all interfaces for which it could fetch IP configuration. - If no ethernet device for the respective MAC address is found, it is skipped. - Also, if the device is currently not activated in NetworkManager or if the currently - activated profile has a user-data org.freedesktop.nm-cloud-setup.skip=yes, - it is skipped. Also, there is only one interface and one IP address, the tool does nothing.

    -

    Then the tool configures the system like doing for AWS environment. That is, using source based policy routing - with the tables/rules 30200/30400. One difference to AWS is that the gateway is also fetched via metadata instead - of using the first IP address in the subnet.

    -
    • -
-
-
-
-

See Also

-

- NetworkManager(8) - nmcli(1) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html deleted file mode 100644 index 0a4807df..00000000 --- a/docs/api/html/nm-dbus-types.html +++ /dev/null @@ -1,5761 +0,0 @@ - - - - -NetworkManager D-Bus API Types: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NetworkManager D-Bus API Types

-

NetworkManager D-Bus API Types

-
-
-

enum NMVersionInfoCapability

-

%_NM_VERSION_INFO_CAPABILITY_UNUSED: a dummy capability. It has no meaning, don't use it.

-

Currently no enum values are defined. These capabilities are exposed on D-Bus in the "VersionInfo" bit field.

-

Since: 1.42

-

-
-

Values

-
------ - -
-
-
-
-
-

enum NMCapability

-

NMCapability names the numbers in the Capabilities property. Capabilities are positive numbers. They are part of stable API and a certain capability number is guaranteed not to change.

-

The range 0x7000 - 0x7FFF of capabilities is guaranteed not to be used by upstream NetworkManager. It could thus be used for downstream extensions.

-

Since: 1.6

-

-
-

Values

-
------ - - - - - - - - - - - - - - -
-

NM_CAPABILITY_TEAM

-

-		 -

= 1

-

-		 -

Teams can be managed. This means the team device plugin is loaded.

-

-		 
-

NM_CAPABILITY_OVS

-

-		 -

= 2

-

-		 -

OpenVSwitch can be managed. This means the OVS device plugin is loaded. Since: 1.24.

-

-		 
-
-
-
-
-

enum NMState

-

NMState values indicate the current overall networking state.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_STATE_UNKNOWN

-

-		 -

= 0

-

-		 -

Networking state is unknown. This indicates a daemon error that makes it unable to reasonably assess the state. In such event the applications are expected to assume Internet connectivity might be present and not disable controls that require network access. The graphical shells may hide the network accessibility indicator altogether since no meaningful status indication can be provided.

-

-		 
-

NM_STATE_ASLEEP

-

-		 -

= 10

-

-		 -

Networking is not enabled, the system is being suspended or resumed from suspend.

-

-		 
-

NM_STATE_DISCONNECTED

-

-		 -

= 20

-

-		 -

There is no active network connection. The graphical shell should indicate no network connectivity and the applications should not attempt to access the network.

-

-		 
-

NM_STATE_DISCONNECTING

-

-		 -

= 30

-

-		 -

Network connections are being cleaned up. The applications should tear down their network sessions.

-

-		 
-

NM_STATE_CONNECTING

-

-		 -

= 40

-

-		 -

A network connection is being started The graphical shell should indicate the network is being connected while the applications should still make no attempts to connect the network.

-

-		 
-

NM_STATE_CONNECTED_LOCAL

-

-		 -

= 50

-

-		 -

There is only local IPv4 and/or IPv6 connectivity, but no default route to access the Internet. The graphical shell should indicate no network connectivity.

-

-		 
-

NM_STATE_CONNECTED_SITE

-

-		 -

= 60

-

-		 -

There is only site-wide IPv4 and/or IPv6 connectivity. This means a default route is available, but the Internet connectivity check (see "Connectivity" property) did not succeed. The graphical shell should indicate limited network connectivity.

-

-		 
-

NM_STATE_CONNECTED_GLOBAL

-

-		 -

= 70

-

-		 -

There is global IPv4 and/or IPv6 Internet connectivity This means the Internet connectivity check succeeded, the graphical shell should indicate full network connectivity.

-

-		 
-
-
-
-
-

enum NMConnectivityState

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_CONNECTIVITY_UNKNOWN

-

-		 -

= 0

-

-		 -

Network connectivity is unknown. This means the connectivity checks are disabled (e.g. on server installations) or has not run yet. The graphical shell should assume the Internet connection might be available and not present a captive portal window.

-

-		 
-

NM_CONNECTIVITY_NONE

-

-		 -

= 1

-

-		 -

The host is not connected to any network. There's no active connection that contains a default route to the internet and thus it makes no sense to even attempt a connectivity check. The graphical shell should use this state to indicate the network connection is unavailable.

-

-		 
-

NM_CONNECTIVITY_PORTAL

-

-		 -

= 2

-

-		 -

The Internet connection is hijacked by a captive portal gateway. The graphical shell may open a sandboxed web browser window (because the captive portals typically attempt a man-in-the-middle attacks against the https connections) for the purpose of authenticating to a gateway and retrigger the connectivity check with CheckConnectivity() when the browser window is dismissed.

-

-		 
-

NM_CONNECTIVITY_LIMITED

-

-		 -

= 3

-

-		 -

The host is connected to a network, does not appear to be able to reach the full Internet, but a captive portal has not been detected.

-

-		 
-

NM_CONNECTIVITY_FULL

-

-		 -

= 4

-

-		 -

The host is connected to a network, and appears to be able to reach the full Internet.

-

-		 
-
-
-
-
-

enum NMDeviceType

-

NMDeviceType values indicate the type of hardware represented by a device object.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_TYPE_UNKNOWN

-

-		 -

= 0

-

-		 -

unknown device

-

-		 
-

NM_DEVICE_TYPE_GENERIC

-

-		 -

= 14

-

-		 -

generic support for unrecognized device types

-

-		 
-

NM_DEVICE_TYPE_ETHERNET

-

-		 -

= 1

-

-		 -

a wired ethernet device

-

-		 
-

NM_DEVICE_TYPE_WIFI

-

-		 -

= 2

-

-		 -

an 802.11 Wi-Fi device

-

-		 
-

NM_DEVICE_TYPE_UNUSED1

-

-		 -

= 3

-

-		 -

not used

-

-		 
-

NM_DEVICE_TYPE_UNUSED2

-

-		 -

= 4

-

-		 -

not used

-

-		 
-

NM_DEVICE_TYPE_BT

-

-		 -

= 5

-

-		 -

a Bluetooth device supporting PAN or DUN access protocols

-

-		 
-

NM_DEVICE_TYPE_OLPC_MESH

-

-		 -

= 6

-

-		 -

an OLPC XO mesh networking device

-

-		 
-

NM_DEVICE_TYPE_WIMAX

-

-		 -

= 7

-

-		 -

an 802.16e Mobile WiMAX broadband device

-

-		 
-

NM_DEVICE_TYPE_MODEM

-

-		 -

= 8

-

-		 -

a modem supporting analog telephone, CDMA/EVDO, GSM/UMTS, or LTE network access protocols

-

-		 
-

NM_DEVICE_TYPE_INFINIBAND

-

-		 -

= 9

-

-		 -

an IP-over-InfiniBand device

-

-		 
-

NM_DEVICE_TYPE_BOND

-

-		 -

= 10

-

-		 -

a bond controller interface

-

-		 
-

NM_DEVICE_TYPE_VLAN

-

-		 -

= 11

-

-		 -

an 802.1Q VLAN interface

-

-		 
-

NM_DEVICE_TYPE_ADSL

-

-		 -

= 12

-

-		 -

ADSL modem

-

-		 
-

NM_DEVICE_TYPE_BRIDGE

-

-		 -

= 13

-

-		 -

a bridge controller interface

-

-		 
-

NM_DEVICE_TYPE_TEAM

-

-		 -

= 15

-

-		 -

a team controller interface

-

-		 
-

NM_DEVICE_TYPE_TUN

-

-		 -

= 16

-

-		 -

a TUN or TAP interface

-

-		 
-

NM_DEVICE_TYPE_IP_TUNNEL

-

-		 -

= 17

-

-		 -

a IP tunnel interface

-

-		 
-

NM_DEVICE_TYPE_MACVLAN

-

-		 -

= 18

-

-		 -

a MACVLAN interface

-

-		 
-

NM_DEVICE_TYPE_VXLAN

-

-		 -

= 19

-

-		 -

a VXLAN interface

-

-		 
-

NM_DEVICE_TYPE_VETH

-

-		 -

= 20

-

-		 -

a VETH interface

-

-		 
-

NM_DEVICE_TYPE_MACSEC

-

-		 -

= 21

-

-		 -

a MACsec interface

-

-		 
-

NM_DEVICE_TYPE_DUMMY

-

-		 -

= 22

-

-		 -

a dummy interface

-

-		 
-

NM_DEVICE_TYPE_PPP

-

-		 -

= 23

-

-		 -

a PPP interface

-

-		 
-

NM_DEVICE_TYPE_OVS_INTERFACE

-

-		 -

= 24

-

-		 -

a Open vSwitch interface

-

-		 
-

NM_DEVICE_TYPE_OVS_PORT

-

-		 -

= 25

-

-		 -

a Open vSwitch port

-

-		 
-

NM_DEVICE_TYPE_OVS_BRIDGE

-

-		 -

= 26

-

-		 -

a Open vSwitch bridge

-

-		 
-

NM_DEVICE_TYPE_WPAN

-

-		 -

= 27

-

-		 -

a IEEE 802.15.4 (WPAN) MAC Layer Device

-

-		 
-

NM_DEVICE_TYPE_6LOWPAN

-

-		 -

= 28

-

-		 -

6LoWPAN interface

-

-		 
-

NM_DEVICE_TYPE_WIREGUARD

-

-		 -

= 29

-

-		 -

a WireGuard interface

-

-		 
-

NM_DEVICE_TYPE_WIFI_P2P

-

-		 -

= 30

-

-		 -

an 802.11 Wi-Fi P2P device. Since: 1.16.

-

-		 
-

NM_DEVICE_TYPE_VRF

-

-		 -

= 31

-

-		 -

A VRF (Virtual Routing and Forwarding) interface. Since: 1.24.

-

-		 
-

NM_DEVICE_TYPE_LOOPBACK

-

-		 -

= 32

-

-		 -

a loopback interface. Since: 1.42.

-

-		 
-

NM_DEVICE_TYPE_HSR

-

-		 -

= 33

-

-		 -

A HSR/PRP device. Since: 1.46.

-

-		 
-
-
-
-
-

enum NMDeviceCapabilities

-

General device capability flags.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_CAP_NONE

-

-		 -

= 0x00000000

-

-		 -

device has no special capabilities

-

-		 
-

NM_DEVICE_CAP_NM_SUPPORTED

-

-		 -

= 0x00000001

-

-		 -

NetworkManager supports this device

-

-		 
-

NM_DEVICE_CAP_CARRIER_DETECT

-

-		 -

= 0x00000002

-

-		 -

this device can indicate carrier status

-

-		 
-

NM_DEVICE_CAP_IS_SOFTWARE

-

-		 -

= 0x00000004

-

-		 -

this device is a software device

-

-		 
-

NM_DEVICE_CAP_SRIOV

-

-		 -

= 0x00000008

-

-		 -

this device supports single-root I/O virtualization

-

-		 
-
-
-
-
-

enum NMDeviceWifiCapabilities

-

802.11 specific device encryption and authentication capabilities.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_WIFI_DEVICE_CAP_NONE

-

-		 -

= 0x00000000

-

-		 -

device has no encryption/authentication capabilities

-

-		 
-

NM_WIFI_DEVICE_CAP_CIPHER_WEP40

-

-		 -

= 0x00000001

-

-		 -

device supports 40/64-bit WEP encryption

-

-		 
-

NM_WIFI_DEVICE_CAP_CIPHER_WEP104

-

-		 -

= 0x00000002

-

-		 -

device supports 104/128-bit WEP encryption

-

-		 
-

NM_WIFI_DEVICE_CAP_CIPHER_TKIP

-

-		 -

= 0x00000004

-

-		 -

device supports TKIP encryption

-

-		 
-

NM_WIFI_DEVICE_CAP_CIPHER_CCMP

-

-		 -

= 0x00000008

-

-		 -

device supports AES/CCMP encryption

-

-		 
-

NM_WIFI_DEVICE_CAP_WPA

-

-		 -

= 0x00000010

-

-		 -

device supports WPA1 authentication

-

-		 
-

NM_WIFI_DEVICE_CAP_RSN

-

-		 -

= 0x00000020

-

-		 -

device supports WPA2/RSN authentication

-

-		 
-

NM_WIFI_DEVICE_CAP_AP

-

-		 -

= 0x00000040

-

-		 -

device supports Access Point mode

-

-		 
-

NM_WIFI_DEVICE_CAP_ADHOC

-

-		 -

= 0x00000080

-

-		 -

device supports Ad-Hoc mode

-

-		 
-

NM_WIFI_DEVICE_CAP_FREQ_VALID

-

-		 -

= 0x00000100

-

-		 -

device reports frequency capabilities

-

-		 
-

NM_WIFI_DEVICE_CAP_FREQ_2GHZ

-

-		 -

= 0x00000200

-

-		 -

device supports 2.4GHz frequencies

-

-		 
-

NM_WIFI_DEVICE_CAP_FREQ_5GHZ

-

-		 -

= 0x00000400

-

-		 -

device supports 5GHz frequencies

-

-		 
-

NM_WIFI_DEVICE_CAP_FREQ_6GHZ

-

-		 -

= 0x00000800

-

-		 -

device supports 6GHz frequencies. Since: 1.46.

-

-		 
-

NM_WIFI_DEVICE_CAP_MESH

-

-		 -

= 0x00001000

-

-		 -

device supports acting as a mesh point. Since: 1.20.

-

-		 
-

NM_WIFI_DEVICE_CAP_IBSS_RSN

-

-		 -

= 0x00002000

-

-		 -

device supports WPA2/RSN in an IBSS network. Since: 1.22.

-

-		 
-
-
-
-
-

enum NM80211ApFlags

-

802.11 access point flags.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_802_11_AP_FLAGS_NONE

-

-		 -

= 0x00000000

-

-		 -

access point has no special capabilities

-

-		 
-

NM_802_11_AP_FLAGS_PRIVACY

-

-		 -

= 0x00000001

-

-		 -

access point requires authentication and encryption (usually means WEP)

-

-		 
-

NM_802_11_AP_FLAGS_WPS

-

-		 -

= 0x00000002

-

-		 -

access point supports some WPS method

-

-		 
-

NM_802_11_AP_FLAGS_WPS_PBC

-

-		 -

= 0x00000004

-

-		 -

access point supports push-button WPS

-

-		 
-

NM_802_11_AP_FLAGS_WPS_PIN

-

-		 -

= 0x00000008

-

-		 -

access point supports PIN-based WPS

-

-		 
-
-
-
-
-

enum NM80211ApSecurityFlags

-

802.11 access point security and authentication flags. These flags describe the current security requirements of an access point as determined from the access point's beacon.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_802_11_AP_SEC_NONE

-

-		 -

= 0x00000000

-

-		 -

the access point has no special security requirements

-

-		 
-

NM_802_11_AP_SEC_PAIR_WEP40

-

-		 -

= 0x00000001

-

-		 -

40/64-bit WEP is supported for pairwise/unicast encryption

-

-		 
-

NM_802_11_AP_SEC_PAIR_WEP104

-

-		 -

= 0x00000002

-

-		 -

104/128-bit WEP is supported for pairwise/unicast encryption

-

-		 
-

NM_802_11_AP_SEC_PAIR_TKIP

-

-		 -

= 0x00000004

-

-		 -

TKIP is supported for pairwise/unicast encryption

-

-		 
-

NM_802_11_AP_SEC_PAIR_CCMP

-

-		 -

= 0x00000008

-

-		 -

AES/CCMP is supported for pairwise/unicast encryption

-

-		 
-

NM_802_11_AP_SEC_GROUP_WEP40

-

-		 -

= 0x00000010

-

-		 -

40/64-bit WEP is supported for group/broadcast encryption

-

-		 
-

NM_802_11_AP_SEC_GROUP_WEP104

-

-		 -

= 0x00000020

-

-		 -

104/128-bit WEP is supported for group/broadcast encryption

-

-		 
-

NM_802_11_AP_SEC_GROUP_TKIP

-

-		 -

= 0x00000040

-

-		 -

TKIP is supported for group/broadcast encryption

-

-		 
-

NM_802_11_AP_SEC_GROUP_CCMP

-

-		 -

= 0x00000080

-

-		 -

AES/CCMP is supported for group/broadcast encryption

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_PSK

-

-		 -

= 0x00000100

-

-		 -

WPA/RSN Pre-Shared Key encryption is supported

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_802_1X

-

-		 -

= 0x00000200

-

-		 -

802.1x authentication and key management is supported

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_SAE

-

-		 -

= 0x00000400

-

-		 -

WPA/RSN Simultaneous Authentication of Equals is supported

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_OWE

-

-		 -

= 0x00000800

-

-		 -

WPA/RSN Opportunistic Wireless Encryption is supported

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_OWE_TM

-

-		 -

= 0x00001000

-

-		 -

WPA/RSN Opportunistic Wireless Encryption transition mode is supported. Since: 1.26.

-

-		 
-

NM_802_11_AP_SEC_KEY_MGMT_EAP_SUITE_B_192

-

-		 -

= 0x00002000

-

-		 -

WPA3 Enterprise Suite-B 192 bit mode is supported. Since: 1.30.

-

-		 
-
-
-
-
-

enum NM80211Mode

-

Indicates the 802.11 mode an access point or device is currently in.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_802_11_MODE_UNKNOWN

-

-		 -

= 0

-

-		 -

the device or access point mode is unknown

-

-		 
-

NM_802_11_MODE_ADHOC

-

-		 -

= 1

-

-		 -

for both devices and access point objects, indicates the object is part of an Ad-Hoc 802.11 network without a central coordinating access point.

-

-		 
-

NM_802_11_MODE_INFRA

-

-		 -

= 2

-

-		 -

the device or access point is in infrastructure mode. For devices, this indicates the device is an 802.11 client/station. For access point objects, this indicates the object is an access point that provides connectivity to clients.

-

-		 
-

NM_802_11_MODE_AP

-

-		 -

= 3

-

-		 -

the device is an access point/hotspot. Not valid for access point objects; used only for hotspot mode on the local machine.

-

-		 
-

NM_802_11_MODE_MESH

-

-		 -

= 4

-

-		 -

the device is a 802.11s mesh point. Since: 1.20.

-

-		 
-
-
-
-
-

enum NMBluetoothCapabilities

-

NMBluetoothCapabilities values indicate the usable capabilities of a Bluetooth device.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - -
-

NM_BT_CAPABILITY_NONE

-

-		 -

= 0x00000000

-

-		 -

device has no usable capabilities

-

-		 
-

NM_BT_CAPABILITY_DUN

-

-		 -

= 0x00000001

-

-		 -

device provides Dial-Up Networking capability

-

-		 
-

NM_BT_CAPABILITY_NAP

-

-		 -

= 0x00000002

-

-		 -

device provides Network Access Point capability

-

-		 
-
-
-
-
-

enum NMDeviceModemCapabilities

-

NMDeviceModemCapabilities values indicate the generic radio access technology families a modem device supports. For more information on the specific access technologies the device supports use the ModemManager D-Bus API.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_MODEM_CAPABILITY_NONE

-

-		 -

= 0x00000000

-

-		 -

modem has no usable capabilities

-

-		 
-

NM_DEVICE_MODEM_CAPABILITY_POTS

-

-		 -

= 0x00000001

-

-		 -

modem uses the analog wired telephone network and is not a wireless/cellular device

-

-		 
-

NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO

-

-		 -

= 0x00000002

-

-		 -

modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO revision A, or EVDO revision B

-

-		 
-

NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS

-

-		 -

= 0x00000004

-

-		 -

modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or HSPA+ packet switched data capability

-

-		 
-

NM_DEVICE_MODEM_CAPABILITY_LTE

-

-		 -

= 0x00000008

-

-		 -

modem has LTE data capability

-

-		 
-

NM_DEVICE_MODEM_CAPABILITY_5GNR

-

-		 -

= 0x00000040

-

-		 -

modem has 5GNR data capability. Since: 1.36.

-

-		 
-
-
-
-
-

enum NMWimaxNspNetworkType

-

WiMAX network type.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

-

-		 -

= 0

-

-		 -

unknown network type

-

-		 
-

NM_WIMAX_NSP_NETWORK_TYPE_HOME

-

-		 -

= 1

-

-		 -

home network

-

-		 
-

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

-

-		 -

= 2

-

-		 -

partner network

-

-		 
-

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

-

-		 -

= 3

-

-		 -

roaming partner network

-

-		 
-
-
-
-
-

enum NMDeviceState

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_STATE_UNKNOWN

-

-		 -

= 0

-

-		 -

the device's state is unknown

-

-		 
-

NM_DEVICE_STATE_UNMANAGED

-

-		 -

= 10

-

-		 -

the device is recognized, but not managed by NetworkManager

-

-		 
-

NM_DEVICE_STATE_UNAVAILABLE

-

-		 -

= 20

-

-		 -

the device is managed by NetworkManager, but is not available for use. Reasons may include the wireless switched off, missing firmware, no ethernet carrier, missing supplicant or modem manager, etc.

-

-		 
-

NM_DEVICE_STATE_DISCONNECTED

-

-		 -

= 30

-

-		 -

the device can be activated, but is currently idle and not connected to a network.

-

-		 
-

NM_DEVICE_STATE_PREPARE

-

-		 -

= 40

-

-		 -

the device is preparing the connection to the network. This may include operations like changing the MAC address, setting physical link properties, and anything else required to connect to the requested network.

-

-		 
-

NM_DEVICE_STATE_CONFIG

-

-		 -

= 50

-

-		 -

the device is connecting to the requested network. This may include operations like associating with the Wi-Fi AP, dialing the modem, connecting to the remote Bluetooth device, etc.

-

-		 
-

NM_DEVICE_STATE_NEED_AUTH

-

-		 -

= 60

-

-		 -

the device requires more information to continue connecting to the requested network. This includes secrets like WiFi passphrases, login passwords, PIN codes, etc.

-

-		 
-

NM_DEVICE_STATE_IP_CONFIG

-

-		 -

= 70

-

-		 -

the device is requesting IPv4 and/or IPv6 addresses and routing information from the network.

-

-		 
-

NM_DEVICE_STATE_IP_CHECK

-

-		 -

= 80

-

-		 -

the device is checking whether further action is required for the requested network connection. This may include checking whether only local network access is available, whether a captive portal is blocking access to the Internet, etc.

-

-		 
-

NM_DEVICE_STATE_SECONDARIES

-

-		 -

= 90

-

-		 -

the device is waiting for a secondary connection (like a VPN) which must activated before the device can be activated

-

-		 
-

NM_DEVICE_STATE_ACTIVATED

-

-		 -

= 100

-

-		 -

the device has a network connection, either local or global.

-

-		 
-

NM_DEVICE_STATE_DEACTIVATING

-

-		 -

= 110

-

-		 -

a disconnection from the current network connection was requested, and the device is cleaning up resources used for that connection. The network connection may still be valid.

-

-		 
-

NM_DEVICE_STATE_FAILED

-

-		 -

= 120

-

-		 -

the device failed to connect to the requested network and is cleaning up the connection request

-

-		 
-
-
-
-
-

enum NMDeviceStateReason

-

Device state change reason codes

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_STATE_REASON_NONE

-

-		 -

= 0

-

-		 -

No reason given

-

-		 
-

NM_DEVICE_STATE_REASON_UNKNOWN

-

-		 -

= 1

-

-		 -

Unknown error

-

-		 
-

NM_DEVICE_STATE_REASON_NOW_MANAGED

-

-		 -

= 2

-

-		 -

Device is now managed

-

-		 
-

NM_DEVICE_STATE_REASON_NOW_UNMANAGED

-

-		 -

= 3

-

-		 -

Device is now unmanaged

-

-		 
-

NM_DEVICE_STATE_REASON_CONFIG_FAILED

-

-		 -

= 4

-

-		 -

The device could not be readied for configuration

-

-		 
-

NM_DEVICE_STATE_REASON_IP_CONFIG_UNAVAILABLE

-

-		 -

= 5

-

-		 -

IP configuration could not be reserved (no available address, timeout, etc)

-

-		 
-

NM_DEVICE_STATE_REASON_IP_CONFIG_EXPIRED

-

-		 -

= 6

-

-		 -

The IP config is no longer valid

-

-		 
-

NM_DEVICE_STATE_REASON_NO_SECRETS

-

-		 -

= 7

-

-		 -

Secrets were required, but not provided

-

-		 
-

NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT

-

-		 -

= 8

-

-		 -

802.1x supplicant disconnected

-

-		 
-

NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED

-

-		 -

= 9

-

-		 -

802.1x supplicant configuration failed

-

-		 
-

NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED

-

-		 -

= 10

-

-		 -

802.1x supplicant failed

-

-		 
-

NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT

-

-		 -

= 11

-

-		 -

802.1x supplicant took too long to authenticate

-

-		 
-

NM_DEVICE_STATE_REASON_PPP_START_FAILED

-

-		 -

= 12

-

-		 -

PPP service failed to start

-

-		 
-

NM_DEVICE_STATE_REASON_PPP_DISCONNECT

-

-		 -

= 13

-

-		 -

PPP service disconnected

-

-		 
-

NM_DEVICE_STATE_REASON_PPP_FAILED

-

-		 -

= 14

-

-		 -

PPP failed

-

-		 
-

NM_DEVICE_STATE_REASON_DHCP_START_FAILED

-

-		 -

= 15

-

-		 -

DHCP client failed to start

-

-		 
-

NM_DEVICE_STATE_REASON_DHCP_ERROR

-

-		 -

= 16

-

-		 -

DHCP client error

-

-		 
-

NM_DEVICE_STATE_REASON_DHCP_FAILED

-

-		 -

= 17

-

-		 -

DHCP client failed

-

-		 
-

NM_DEVICE_STATE_REASON_SHARED_START_FAILED

-

-		 -

= 18

-

-		 -

Shared connection service failed to start

-

-		 
-

NM_DEVICE_STATE_REASON_SHARED_FAILED

-

-		 -

= 19

-

-		 -

Shared connection service failed

-

-		 
-

NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED

-

-		 -

= 20

-

-		 -

AutoIP service failed to start

-

-		 
-

NM_DEVICE_STATE_REASON_AUTOIP_ERROR

-

-		 -

= 21

-

-		 -

AutoIP service error

-

-		 
-

NM_DEVICE_STATE_REASON_AUTOIP_FAILED

-

-		 -

= 22

-

-		 -

AutoIP service failed

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_BUSY

-

-		 -

= 23

-

-		 -

The line is busy

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE

-

-		 -

= 24

-

-		 -

No dial tone

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER

-

-		 -

= 25

-

-		 -

No carrier could be established

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT

-

-		 -

= 26

-

-		 -

The dialing request timed out

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED

-

-		 -

= 27

-

-		 -

The dialing attempt failed

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED

-

-		 -

= 28

-

-		 -

Modem initialization failed

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_APN_FAILED

-

-		 -

= 29

-

-		 -

Failed to select the specified APN

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING

-

-		 -

= 30

-

-		 -

Not searching for networks

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED

-

-		 -

= 31

-

-		 -

Network registration denied

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT

-

-		 -

= 32

-

-		 -

Network registration timed out

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED

-

-		 -

= 33

-

-		 -

Failed to register with the requested network

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED

-

-		 -

= 34

-

-		 -

PIN check failed

-

-		 
-

NM_DEVICE_STATE_REASON_FIRMWARE_MISSING

-

-		 -

= 35

-

-		 -

Necessary firmware for the device may be missing

-

-		 
-

NM_DEVICE_STATE_REASON_REMOVED

-

-		 -

= 36

-

-		 -

The device was removed

-

-		 
-

NM_DEVICE_STATE_REASON_SLEEPING

-

-		 -

= 37

-

-		 -

NetworkManager went to sleep

-

-		 
-

NM_DEVICE_STATE_REASON_CONNECTION_REMOVED

-

-		 -

= 38

-

-		 -

The device's active connection disappeared

-

-		 
-

NM_DEVICE_STATE_REASON_USER_REQUESTED

-

-		 -

= 39

-

-		 -

Device disconnected by user or client

-

-		 
-

NM_DEVICE_STATE_REASON_CARRIER

-

-		 -

= 40

-

-		 -

Carrier/link changed

-

-		 
-

NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED

-

-		 -

= 41

-

-		 -

The device's existing connection was assumed

-

-		 
-

NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE

-

-		 -

= 42

-

-		 -

The supplicant is now available

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND

-

-		 -

= 43

-

-		 -

The modem could not be found

-

-		 
-

NM_DEVICE_STATE_REASON_BT_FAILED

-

-		 -

= 44

-

-		 -

The Bluetooth connection failed or timed out

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED

-

-		 -

= 45

-

-		 -

GSM Modem's SIM Card not inserted

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED

-

-		 -

= 46

-

-		 -

GSM Modem's SIM Pin required

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED

-

-		 -

= 47

-

-		 -

GSM Modem's SIM Puk required

-

-		 
-

NM_DEVICE_STATE_REASON_GSM_SIM_WRONG

-

-		 -

= 48

-

-		 -

GSM Modem's SIM wrong

-

-		 
-

NM_DEVICE_STATE_REASON_INFINIBAND_MODE

-

-		 -

= 49

-

-		 -

InfiniBand device does not support connected mode

-

-		 
-

NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED

-

-		 -

= 50

-

-		 -

A dependency of the connection failed

-

-		 
-

NM_DEVICE_STATE_REASON_BR2684_FAILED

-

-		 -

= 51

-

-		 -

Problem with the RFC 2684 Ethernet over ADSL bridge

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE

-

-		 -

= 52

-

-		 -

ModemManager not running

-

-		 
-

NM_DEVICE_STATE_REASON_SSID_NOT_FOUND

-

-		 -

= 53

-

-		 -

The Wi-Fi network could not be found

-

-		 
-

NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED

-

-		 -

= 54

-

-		 -

A secondary connection of the base connection failed

-

-		 
-

NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED

-

-		 -

= 55

-

-		 -

DCB or FCoE setup failed

-

-		 
-

NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED

-

-		 -

= 56

-

-		 -

teamd control failed

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_FAILED

-

-		 -

= 57

-

-		 -

Modem failed or no longer available

-

-		 
-

NM_DEVICE_STATE_REASON_MODEM_AVAILABLE

-

-		 -

= 58

-

-		 -

Modem now ready and available

-

-		 
-

NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT

-

-		 -

= 59

-

-		 -

SIM PIN was incorrect

-

-		 
-

NM_DEVICE_STATE_REASON_NEW_ACTIVATION

-

-		 -

= 60

-

-		 -

New connection activation was enqueued

-

-		 
-

NM_DEVICE_STATE_REASON_PARENT_CHANGED

-

-		 -

= 61

-

-		 -

the device's parent changed

-

-		 
-

NM_DEVICE_STATE_REASON_PARENT_MANAGED_CHANGED

-

-		 -

= 62

-

-		 -

the device parent's management changed

-

-		 
-

NM_DEVICE_STATE_REASON_OVSDB_FAILED

-

-		 -

= 63

-

-		 -

problem communicating with Open vSwitch database

-

-		 
-

NM_DEVICE_STATE_REASON_IP_ADDRESS_DUPLICATE

-

-		 -

= 64

-

-		 -

a duplicate IP address was detected

-

-		 
-

NM_DEVICE_STATE_REASON_IP_METHOD_UNSUPPORTED

-

-		 -

= 65

-

-		 -

The selected IP method is not supported

-

-		 
-

NM_DEVICE_STATE_REASON_SRIOV_CONFIGURATION_FAILED

-

-		 -

= 66

-

-		 -

configuration of SR-IOV parameters failed

-

-		 
-

NM_DEVICE_STATE_REASON_PEER_NOT_FOUND

-

-		 -

= 67

-

-		 -

The Wi-Fi P2P peer could not be found

-

-		 
-

NM_DEVICE_STATE_REASON_DEVICE_HANDLER_FAILED

-

-		 -

= 68

-

-		 -

The device handler dispatcher returned an error. Since: 1.46

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_BY_DEFAULT

-

-		 -

= 69

-

-		 -

The device is unmanaged because the device type is unmanaged by default. Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_EXTERNAL_DOWN

-

-		 -

= 70

-

-		 -

The device is unmanaged because it is an external device and is unconfigured (down or without addresses). Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_LINK_NOT_INIT

-

-		 -

= 71

-

-		 -

The device is unmanaged because the link is not initialized by udev. Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_QUITTING

-

-		 -

= 72

-

-		 -

The device is unmanaged because NetworkManager is quitting. Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_SLEEPING

-

-		 -

= 73

-

-		 -

The device is unmanaged because networking is disabled or the system is suspended. Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_USER_CONF

-

-		 -

= 74

-

-		 -

The device is unmanaged by user decision in NetworkManager.conf ('unmanaged' in a [device*] section). Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_USER_EXPLICIT

-

-		 -

= 75

-

-		 -

The device is unmanaged by explicit user decision (e.g. 'nmcli device set $DEV managed no'). Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_USER_SETTINGS

-

-		 -

= 76

-

-		 -

The device is unmanaged by user decision via settings plugin ('unmanaged-devices' for keyfile or 'NM_CONTROLLED=no' for ifcfg-rh). Since: 1.48

-

-		 
-

NM_DEVICE_STATE_REASON_UNMANAGED_USER_UDEV

-

-		 -

= 77

-

-		 -

The device is unmanaged via udev rule. Since: 1.48

-

-		 
-
-
-
-
-

enum NMMetered

-

The NMMetered enum has two different purposes: one is to configure "connection.metered" setting of a connection profile in NMSettingConnection, and the other is to express the actual metered state of the NMDevice at a given moment.

-

For the connection profile only NM_METERED_UNKNOWN, NM_METERED_NO and NM_METERED_YES are allowed.

-

The device's metered state at runtime is determined by the profile which is currently active. If the profile explicitly specifies NM_METERED_NO or NM_METERED_YES, then the device's metered state is as such. If the connection profile leaves it undecided at NM_METERED_UNKNOWN (the default), then NetworkManager tries to guess the metered state, for example based on the device type or on DHCP options (like Android devices exposing a "ANDROID_METERED" DHCP vendor option). This then leads to either NM_METERED_GUESS_NO or NM_METERED_GUESS_YES.

-

Most applications probably should treat the runtime state NM_METERED_GUESS_YES like NM_METERED_YES, and all other states as not metered.

-

Note that the per-device metered states are then combined to a global metered state. This is basically the metered state of the device with the best default route. However, that generalization of a global metered state may not be correct if the default routes for IPv4 and IPv6 are on different devices, or if policy routing is configured. In general, the global metered state tries to express whether the traffic is likely metered, but since that depends on the traffic itself, there is not one answer in all cases. Hence, an application may want to consider the per-device's metered states.

-

Since: 1.2

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_METERED_UNKNOWN

-

-		 -

= 0

-

-		 -

The metered status is unknown

-

-		 
-

NM_METERED_YES

-

-		 -

= 1

-

-		 -

Metered, the value was explicitly configured

-

-		 
-

NM_METERED_NO

-

-		 -

= 2

-

-		 -

Not metered, the value was explicitly configured

-

-		 
-

NM_METERED_GUESS_YES

-

-		 -

= 3

-

-		 -

Metered, the value was guessed

-

-		 
-

NM_METERED_GUESS_NO

-

-		 -

= 4

-

-		 -

Not metered, the value was guessed

-

-		 
-
-
-
-
-

enum NMConnectionMultiConnect

-

Since: 1.14

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_CONNECTION_MULTI_CONNECT_DEFAULT

-

-		 -

= 0

-

-		 -

indicates that the per-connection setting is unspecified. In this case, it will fallback to the default value, which is %NM_CONNECTION_MULTI_CONNECT_SINGLE.

-

-		 
-

NM_CONNECTION_MULTI_CONNECT_SINGLE

-

-		 -

= 1

-

-		 -

the connection profile can only be active once at each moment. Activating a profile that is already active, will first deactivate it.

-

-		 
-

NM_CONNECTION_MULTI_CONNECT_MANUAL_MULTIPLE

-

-		 -

= 2

-

-		 -

the profile can be manually activated multiple times on different devices. However, regarding autoconnect, the profile will autoconnect only if it is currently not connected otherwise.

-

-		 
-

NM_CONNECTION_MULTI_CONNECT_MULTIPLE

-

-		 -

= 3

-

-		 -

the profile can autoactivate and be manually activated multiple times together.

-

-		 
-
-
-
-
-

enum NMActiveConnectionState

-

NMActiveConnectionState values indicate the state of a connection to a specific network while it is starting, connected, or disconnecting from that network.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_ACTIVE_CONNECTION_STATE_UNKNOWN

-

-		 -

= 0

-

-		 -

the state of the connection is unknown

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_ACTIVATING

-

-		 -

= 1

-

-		 -

a network connection is being prepared

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_ACTIVATED

-

-		 -

= 2

-

-		 -

there is a connection to the network

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_DEACTIVATING

-

-		 -

= 3

-

-		 -

the network connection is being torn down and cleaned up

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_DEACTIVATED

-

-		 -

= 4

-

-		 -

the network connection is disconnected and will be removed

-

-		 
-
-
-
-
-

enum NMActiveConnectionStateReason

-

Active connection state reasons.

-

Since: 1.8

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_ACTIVE_CONNECTION_STATE_REASON_UNKNOWN

-

-		 -

= 0

-

-		 -

The reason for the active connection state change is unknown.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_NONE

-

-		 -

= 1

-

-		 -

No reason was given for the active connection state change.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_USER_DISCONNECTED

-

-		 -

= 2

-

-		 -

The active connection changed state because the user disconnected it.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED

-

-		 -

= 3

-

-		 -

The active connection changed state because the device it was using was disconnected.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_SERVICE_STOPPED

-

-		 -

= 4

-

-		 -

The service providing the VPN connection was stopped.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_IP_CONFIG_INVALID

-

-		 -

= 5

-

-		 -

The IP config of the active connection was invalid.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_CONNECT_TIMEOUT

-

-		 -

= 6

-

-		 -

The connection attempt to the VPN service timed out.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT

-

-		 -

= 7

-

-		 -

A timeout occurred while starting the service providing the VPN connection.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_SERVICE_START_FAILED

-

-		 -

= 8

-

-		 -

Starting the service providing the VPN connection failed.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_NO_SECRETS

-

-		 -

= 9

-

-		 -

Necessary secrets for the connection were not provided.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_LOGIN_FAILED

-

-		 -

= 10

-

-		 -

Authentication to the server failed.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_CONNECTION_REMOVED

-

-		 -

= 11

-

-		 -

The connection was deleted from settings.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_DEPENDENCY_FAILED

-

-		 -

= 12

-

-		 -

Master connection of this connection failed to activate.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_DEVICE_REALIZE_FAILED

-

-		 -

= 13

-

-		 -

Could not create the software device link.

-

-		 
-

NM_ACTIVE_CONNECTION_STATE_REASON_DEVICE_REMOVED

-

-		 -

= 14

-

-		 -

The device this connection depended on disappeared.

-

-		 
-
-
-
-
-

enum NMSecretAgentGetSecretsFlags

-

NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE

-

-		 -

= 0x0

-

-		 -

no special behavior; by default no user interaction is allowed and requests for secrets are fulfilled from persistent storage, or if no secrets are available an error is returned.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION

-

-		 -

= 0x1

-

-		 -

allows the request to interact with the user, possibly prompting via UI for secrets if any are required, or if none are found in persistent storage.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW

-

-		 -

= 0x2

-

-		 -

explicitly prompt for new secrets from the user. This flag signals that NetworkManager thinks any existing secrets are invalid or wrong. This flag implies that interaction is allowed.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED

-

-		 -

= 0x4

-

-		 -

set if the request was initiated by user-requested action via the D-Bus interface, as opposed to automatically initiated by NetworkManager in response to (for example) scan results or carrier changes.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_WPS_PBC_ACTIVE

-

-		 -

= 0x8

-

-		 -

indicates that WPS enrollment is active with PBC method. The agent may suggest that the user pushes a button on the router instead of supplying a PSK.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_ONLY_SYSTEM

-

-		 -

= 0x80000000

-

-		 -

Internal flag, not part of the D-Bus API.

-

-		 
-

NM_SECRET_AGENT_GET_SECRETS_FLAG_NO_ERRORS

-

-		 -

= 0x40000000

-

-		 -

Internal flag, not part of the D-Bus API.

-

-		 
-
-
-
-
-

enum NMSecretAgentCapabilities

-

NMSecretAgentCapabilities indicate various capabilities of the agent.

-

-
-

Values

-
------ - - - - - - - - - - - - - - -
-

NM_SECRET_AGENT_CAPABILITY_NONE

-

-		 -

= 0x0

-

-		 -

the agent supports no special capabilities

-

-		 
-

NM_SECRET_AGENT_CAPABILITY_VPN_HINTS

-

-		 -

= 0x1

-

-		 -

the agent supports passing hints to VPN plugin authentication dialogs.

-

-		 
-
-
-
-
-

enum NMIPTunnelMode

-

The tunneling mode.

-

Since: 1.2

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_IP_TUNNEL_MODE_UNKNOWN

-

-		 -

= 0

-

-		 -

Unknown/unset tunnel mode

-

-		 
-

NM_IP_TUNNEL_MODE_IPIP

-

-		 -

= 1

-

-		 -

IP in IP tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_GRE

-

-		 -

= 2

-

-		 -

GRE tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_SIT

-

-		 -

= 3

-

-		 -

SIT tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_ISATAP

-

-		 -

= 4

-

-		 -

ISATAP tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_VTI

-

-		 -

= 5

-

-		 -

VTI tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_IP6IP6

-

-		 -

= 6

-

-		 -

IPv6 in IPv6 tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_IPIP6

-

-		 -

= 7

-

-		 -

IPv4 in IPv6 tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_IP6GRE

-

-		 -

= 8

-

-		 -

IPv6 GRE tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_VTI6

-

-		 -

= 9

-

-		 -

IPv6 VTI tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_GRETAP

-

-		 -

= 10

-

-		 -

GRETAP tunnel

-

-		 
-

NM_IP_TUNNEL_MODE_IP6GRETAP

-

-		 -

= 11

-

-		 -

IPv6 GRETAP tunnel

-

-		 
-
-
-
-
-

enum NMCheckpointCreateFlags

-

The flags for CheckpointCreate call

-

Since: 1.12: Public since 1.4, g-ir since 1.12.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_CHECKPOINT_CREATE_FLAG_NONE

-

-		 -

= 0

-

-		 -

no flags

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_DESTROY_ALL

-

-		 -

= 0x01

-

-		 -

when creating a new checkpoint, destroy all existing ones.

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_DELETE_NEW_CONNECTIONS

-

-		 -

= 0x02

-

-		 -

upon rollback, delete any new connection added after the checkpoint. Since: 1.6.

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_DISCONNECT_NEW_DEVICES

-

-		 -

= 0x04

-

-		 -

upon rollback, disconnect any new device appeared after the checkpoint. Since: 1.6.

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_ALLOW_OVERLAPPING

-

-		 -

= 0x08

-

-		 -

by default, creating a checkpoint fails if there are already existing checkpoints that reference the same devices. With this flag, creation of such checkpoints is allowed, however, if an older checkpoint that references overlapping devices gets rolled back, it will automatically destroy this checkpoint during rollback. This allows to create several overlapping checkpoints in parallel, and rollback to them at will. With the special case that rolling back to an older checkpoint will invalidate all overlapping younger checkpoints. This opts-in that the checkpoint can be automatically destroyed by the rollback of an older checkpoint. Since: 1.12.

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_NO_PRESERVE_EXTERNAL_PORTS

-

-		 -

= 0x10

-

-		 -

during rollback, by default externally added ports attached to bridge devices are preserved. With this flag, the rollback detaches all external ports. This only has an effect for bridge ports. Before 1.38, this was the default behavior. Since: 1.38.

-

-		 
-

NM_CHECKPOINT_CREATE_FLAG_TRACK_INTERNAL_GLOBAL_DNS

-

-		 -

= 0x20

-

-		 -

during rollback, by default changes to global DNS via D-BUS interface are preserved. With this flag, the rollback reverts the global DNS changes made via D-Bus interface. Global DNS defined in [global-dns] section of NetworkManager.conf is not impacted by this flag. Since: 1.48.

-

-		 
-
-
-
-
-

enum NMRollbackResult

-

The result of a checkpoint Rollback() operation for a specific device.

-

Since: 1.4

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_ROLLBACK_RESULT_OK

-

-		 -

= 0

-

-		 -

the rollback succeeded.

-

-		 
-

NM_ROLLBACK_RESULT_ERR_NO_DEVICE

-

-		 -

= 1

-

-		 -

the device no longer exists.

-

-		 
-

NM_ROLLBACK_RESULT_ERR_DEVICE_UNMANAGED

-

-		 -

= 2

-

-		 -

the device is now unmanaged.

-

-		 
-

NM_ROLLBACK_RESULT_ERR_FAILED

-

-		 -

= 3

-

-		 -

other errors during rollback.

-

-		 
-
-
-
-
-

enum NMSettingsConnectionFlags

-

Flags describing the current activation state.

-

Since: 1.12

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_SETTINGS_CONNECTION_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_SETTINGS_CONNECTION_FLAG_UNSAVED

-

-		 -

= 0x01

-

-		 -

the connection is not saved to disk. That either means, that the connection is in-memory only and currently is not backed by a file. Or, that the connection is backed by a file, but has modifications in-memory that were not persisted to disk.

-

-		 
-

NM_SETTINGS_CONNECTION_FLAG_NM_GENERATED

-

-		 -

= 0x02

-

-		 -

A connection is "nm-generated" if it was generated by NetworkManger. If the connection gets modified or saved by the user, the flag gets cleared. A nm-generated is also unsaved and has no backing file as it is in-memory only.

-

-		 
-

NM_SETTINGS_CONNECTION_FLAG_VOLATILE

-

-		 -

= 0x04

-

-		 -

The connection will be deleted when it disconnects. That is for in-memory connections (unsaved), which are currently active but deleted on disconnect. Volatile connections are always unsaved, but they are also no backing file on disk and are entirely in-memory only.

-

-		 
-

NM_SETTINGS_CONNECTION_FLAG_EXTERNAL

-

-		 -

= 0x08

-

-		 -

the profile was generated to represent an external configuration of a networking device. Since: 1.26.

-

-		 
-
-
-
-
-

enum NMActivationStateFlags

-

Flags describing the current activation state.

-

Since: 1.10

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_ACTIVATION_STATE_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_IS_CONTROLLER

-

-		 -

= 0x1

-

-		 -

the device is a controller.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_IS_PORT

-

-		 -

= 0x2

-

-		 -

the device is a port.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_LAYER2_READY

-

-		 -

= 0x4

-

-		 -

layer2 is activated and ready.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_IP4_READY

-

-		 -

= 0x8

-

-		 -

IPv4 setting is completed.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_IP6_READY

-

-		 -

= 0x10

-

-		 -

IPv6 setting is completed.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_CONTROLLER_HAS_PORTS

-

-		 -

= 0x20

-

-		 -

The controller has any port devices attached. This only makes sense if the device is a controller.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_LIFETIME_BOUND_TO_PROFILE_VISIBILITY

-

-		 -

= 0x40

-

-		 -

the lifetime of the activation is bound to the visibility of the connection profile, which in turn depends on "connection.permissions" and whether a session for the user exists. Since: 1.16.

-

-		 
-

NM_ACTIVATION_STATE_FLAG_EXTERNAL

-

-		 -

= 0x80

-

-		 -

the active connection was generated to represent an external configuration of a networking device. Since: 1.26.

-

-		 
-
-
-
-
-

enum NMSettingsAddConnection2Flags

-

Numeric flags for the "flags" argument of AddConnection2() D-Bus API.

-

Since: 1.20

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_SETTINGS_ADD_CONNECTION2_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_SETTINGS_ADD_CONNECTION2_FLAG_TO_DISK

-

-		 -

= 0x1

-

-		 -

to persist the connection to disk.

-

-		 
-

NM_SETTINGS_ADD_CONNECTION2_FLAG_IN_MEMORY

-

-		 -

= 0x2

-

-		 -

to make the connection in-memory only.

-

-		 
-

NM_SETTINGS_ADD_CONNECTION2_FLAG_BLOCK_AUTOCONNECT

-

-		 -

= 0x20

-

-		 -

usually, when the connection has autoconnect enabled and gets added, it becomes eligible to autoconnect right away. Setting this flag, disables autoconnect until the connection is manually activated.

-

-		 
-
-
-
-
-

enum NMSettingsUpdate2Flags

-

Since: 1.12

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_SETTINGS_UPDATE2_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_TO_DISK

-

-		 -

= 0x1

-

-		 -

to persist the connection to disk.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY

-

-		 -

= 0x2

-

-		 -

makes the profile in-memory. Note that such profiles are stored in keyfile format under /run. If the file is already in-memory, the file in /run is updated in-place. Otherwise, the previous storage for the profile is left unchanged on disk, and the in-memory copy shadows it. Note that the original filename of the previous persistent storage (if any) is remembered. That means, when later persisting the profile again to disk, the file on disk will be overwritten again. Likewise, when finally deleting the profile, both the storage from /run and persistent storage are deleted (or if the persistent storage does not allow deletion, and nmmeta file is written to mark the UUID as deleted).

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY_DETACHED

-

-		 -

= 0x4

-

-		 -

this is almost the same as %NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY, with one difference: when later deleting the profile, the original profile will not be deleted. Instead a nmmeta file is written to /run to indicate that the profile is gone. Note that if such a nmmeta tombstone file exists and hides a file in persistent storage, then when re-adding the profile with the same UUID, then the original storage is taken over again.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY_ONLY

-

-		 -

= 0x8

-

-		 -

this is like %NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY, but if the connection has a corresponding file on persistent storage, the file will be deleted right away. If the profile is later again persisted to disk, a new, unused filename will be chosen.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_VOLATILE

-

-		 -

= 0x10

-

-		 -

This can be specified with either %NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY, %NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY_DETACHED or %NM_SETTINGS_UPDATE2_FLAG_IN_MEMORY_ONLY. After making the connection in-memory only, the connection is marked as volatile. That means, if the connection is currently not active it will be deleted right away. Otherwise, it is marked to for deletion once the connection deactivates. A volatile connection cannot autoactivate again (because it's about to be deleted), but a manual activation will clear the volatile flag.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_BLOCK_AUTOCONNECT

-

-		 -

= 0x20

-

-		 -

usually, when the connection has autoconnect enabled and is modified, it becomes eligible to autoconnect right away. Setting this flag, disables autoconnect until the connection is manually activated.

-

-		 
-

NM_SETTINGS_UPDATE2_FLAG_NO_REAPPLY

-

-		 -

= 0x40

-

-		 -

when a profile gets modified that is currently active, then these changes don't take effect for the active device unless the profile gets reactivated or the configuration reapplied. There are two exceptions: by default "connection.zone" and "connection.metered" properties take effect immediately. Specify this flag to prevent these properties to take effect, so that the change is restricted to modify the profile. Since: 1.20.

-

-		 
-
-
-
-
-

enum NMDeviceReapplyFlags

-

Flags for the Reapply() D-Bus call of a device and nm_device_reapply_async().

-

Since: 1.42

-

-
-

Values

-
------ - - - - - - - - - - - - - - -
-

NM_DEVICE_REAPPLY_FLAGS_NONE

-

-		 -

= 0

-

-		 -

no flag set.

-

-		 
-

NM_DEVICE_REAPPLY_FLAGS_PRESERVE_EXTERNAL_IP

-

-		 -

= 0x1

-

-		 -

during reapply, preserve external IP addresses and routes.

-

-		 
-
-
-
-
-

enum NMTernary

-

An boolean value that can be overridden by a default.

-

Since: 1.14

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - -
-

NM_TERNARY_DEFAULT

-

-		 -

= -1

-

-		 -

use the globally-configured default value.

-

-		 
-

NM_TERNARY_FALSE

-

-		 -

= 0

-

-		 -

the option is disabled.

-

-		 
-

NM_TERNARY_TRUE

-

-		 -

= 1

-

-		 -

the option is enabled.

-

-		 
-
-
-
-
-

enum NMManagerReloadFlags

-

Flags for the manager Reload() call.

-

Since: 1.22

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_MANAGER_RELOAD_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set. This reloads everything that is supported and is identical to a SIGHUP.

-

-		 
-

NM_MANAGER_RELOAD_FLAG_CONF

-

-		 -

= 0x1

-

-		 -

reload the NetworkManager.conf configuration from disk. Note that this does not include connections, which can be reloaded via Setting's ReloadConnections().

-

-		 
-

NM_MANAGER_RELOAD_FLAG_DNS_RC

-

-		 -

= 0x2

-

-		 -

update DNS configuration, which usually involves writing /etc/resolv.conf anew.

-

-		 
-

NM_MANAGER_RELOAD_FLAG_DNS_FULL

-

-		 -

= 0x4

-

-		 -

means to restart the DNS plugin. This is for example useful when using dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d. If you edit those files, you can restart the DNS plugin. This action shortly interrupts name resolution.

-

-		 
-

NM_MANAGER_RELOAD_FLAG_ALL

-

-		 -

= 0x7

-

-		 -

all flags.

-

-		 
-
-
-
-
-

enum NMDeviceInterfaceFlags

-

Flags for a network interface.

-

Since: 1.22

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_DEVICE_INTERFACE_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_DEVICE_INTERFACE_FLAG_UP

-

-		 -

= 0x1

-

-		 -

the interface is enabled from the administrative point of view. Corresponds to kernel IFF_UP.

-

-		 
-

NM_DEVICE_INTERFACE_FLAG_LOWER_UP

-

-		 -

= 0x2

-

-		 -

the physical link is up. Corresponds to kernel IFF_LOWER_UP.

-

-		 
-

NM_DEVICE_INTERFACE_FLAG_PROMISC

-

-		 -

= 0x4

-

-		 -

receive all packets. Corresponds to kernel IFF_PROMISC. Since: 1.32.

-

-		 
-

NM_DEVICE_INTERFACE_FLAG_CARRIER

-

-		 -

= 0x10000

-

-		 -

the interface has carrier. In most cases this is equal to the value of @NM_DEVICE_INTERFACE_FLAG_LOWER_UP. However some devices have a non-standard carrier detection mechanism.

-

-		 
-

NM_DEVICE_INTERFACE_FLAG_LLDP_CLIENT_ENABLED

-

-		 -

= 0x20000

-

-		 -

the flag to indicate device LLDP status. Since: 1.32.

-

-		 
-
-
-
-
-

enum NMClientPermission

-

NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_CLIENT_PERMISSION_NONE

-

-		 -

= 0

-

-		 -

unknown or no permission

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

-

-		 -

= 1

-

-		 -

controls whether networking can be globally enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

-

-		 -

= 2

-

-		 -

controls whether Wi-Fi can be globally enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

-

-		 -

= 3

-

-		 -

controls whether WWAN (3G) can be globally enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

-

-		 -

= 4

-

-		 -

controls whether WiMAX can be globally enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_SLEEP_WAKE

-

-		 -

= 5

-

-		 -

controls whether the client can ask NetworkManager to sleep and wake

-

-		 
-

NM_CLIENT_PERMISSION_NETWORK_CONTROL

-

-		 -

= 6

-

-		 -

controls whether networking connections can be started, stopped, and changed

-

-		 
-

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

-

-		 -

= 7

-

-		 -

controls whether a password protected Wi-Fi hotspot can be created

-

-		 
-

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

-

-		 -

= 8

-

-		 -

controls whether an open Wi-Fi hotspot can be created

-

-		 
-

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

-

-		 -

= 9

-

-		 -

controls whether connections that are available to all users can be modified

-

-		 
-

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN

-

-		 -

= 10

-

-		 -

controls whether connections owned by the current user can be modified

-

-		 
-

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

-

-		 -

= 11

-

-		 -

controls whether the persistent hostname can be changed

-

-		 
-

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_GLOBAL_DNS

-

-		 -

= 12

-

-		 -

modify persistent global DNS configuration

-

-		 
-

NM_CLIENT_PERMISSION_RELOAD

-

-		 -

= 13

-

-		 -

controls access to Reload.

-

-		 
-

NM_CLIENT_PERMISSION_CHECKPOINT_ROLLBACK

-

-		 -

= 14

-

-		 -

permission to create checkpoints.

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS

-

-		 -

= 15

-

-		 -

controls whether device statistics can be globally enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_ENABLE_DISABLE_CONNECTIVITY_CHECK

-

-		 -

= 16

-

-		 -

controls whether connectivity check can be enabled or disabled

-

-		 
-

NM_CLIENT_PERMISSION_WIFI_SCAN

-

-		 -

= 17

-

-		 -

controls whether wifi scans can be performed

-

-		 
-
-
-
-
-

enum NMClientPermissionResult

-

NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_CLIENT_PERMISSION_RESULT_UNKNOWN

-

-		 -

= 0

-

-		 -

unknown or no authorization

-

-		 
-

NM_CLIENT_PERMISSION_RESULT_YES

-

-		 -

= 1

-

-		 -

the permission is available

-

-		 
-

NM_CLIENT_PERMISSION_RESULT_AUTH

-

-		 -

= 2

-

-		 -

authorization is necessary before the permission is available

-

-		 
-

NM_CLIENT_PERMISSION_RESULT_NO

-

-		 -

= 3

-

-		 -

permission to perform the operation is denied by system policy

-

-		 
-
-
-
-
-

enum NMRadioFlags

-

Flags related to radio interfaces.

-

Since: 1.38

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - -
-

NM_RADIO_FLAG_NONE

-

-		 -

= 0

-

-		 -

an alias for numeric zero, no flags set.

-

-		 
-

NM_RADIO_FLAG_WLAN_AVAILABLE

-

-		 -

= 0x1

-

-		 -

A Wireless LAN device or rfkill switch is detected in the system.

-

-		 
-

NM_RADIO_FLAG_WWAN_AVAILABLE

-

-		 -

= 0x2

-

-		 -

A Wireless WAN device or rfkill switch is detected in the system.

-

-		 
-
-
-
-
-

enum NMMptcpFlags

-

Since: 1.40

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_MPTCP_FLAGS_NONE

-

-		 -

= 0

-

-		 -

The default, meaning that no MPTCP flags are set.

-

-		 
-

NM_MPTCP_FLAGS_DISABLED

-

-		 -

= 0x1

-

-		 -

don't configure MPTCP endpoints on the device.

-

-		 
-

NM_MPTCP_FLAGS_ENABLED

-

-		 -

= 0x2

-

-		 -

MPTCP is enabled and endpoints will be configured. This flag is implied if any of the other flags indicate that MPTCP is enabled and therefore in most cases unnecessary. Note that if "/proc/sys/net/mptcp/enabled" sysctl is disabled, MPTCP handling is disabled despite this flag. This can be overruled with the "also-without-sysctl" flag. Note that by default interfaces that don't have a default route are excluded from having MPTCP endpoints configured. This can be overruled with the "also-without-default-route" and this affects endpoints per address family.

-

-		 
-

NM_MPTCP_FLAGS_ALSO_WITHOUT_SYSCTL

-

-		 -

= 0x4

-

-		 -

even if MPTCP handling is enabled via the "enabled" flag, it is ignored unless "/proc/sys/net/mptcp/enabled" is on. With this flag, MPTCP endpoints will be configured regardless of the sysctl setting.

-

-		 
-

NM_MPTCP_FLAGS_ALSO_WITHOUT_DEFAULT_ROUTE

-

-		 -

= 0x8

-

-		 -

even if MPTCP handling is enabled via the "enabled" flag, it is ignored per-address family unless NetworkManager configures a default route. With this flag, NetworkManager will also configure MPTCP endpoints if there is no default route. This takes effect per-address family.

-

-		 
-

NM_MPTCP_FLAGS_SIGNAL

-

-		 -

= 0x10

-

-		 -

Flag for the MPTCP endpoint. The endpoint will be announced/signaled to each peer via an MPTCP ADD_ADDR sub-option.

-

-		 
-

NM_MPTCP_FLAGS_SUBFLOW

-

-		 -

= 0x20

-

-		 -

Flag for the MPTCP endpoint. If additional subflow creation is allowed by the MPTCP limits, the MPTCP path manager will try to create an additional subflow using this endpoint as the source address after the MPTCP connection is established.

-

-		 
-

NM_MPTCP_FLAGS_BACKUP

-

-		 -

= 0x40

-

-		 -

Flag for the MPTCP endpoint. If this is a subflow endpoint, the subflows created using this endpoint will have the backup flag set during the connection process. This flag instructs the peer to only send data on a given subflow when all non-backup subflows are unavailable. This does not affect outgoing data, where subflow priority is determined by the backup/non-backup flag received from the peer

-

-		 
-

NM_MPTCP_FLAGS_FULLMESH

-

-		 -

= 0x80

-

-		 -

Flag for the MPTCP endpoint. If this is a subflow endpoint and additional subflow creation is allowed by the MPTCP limits, the MPTCP path manager will try to create an additional subflow for each known peer address, using this endpoint as the source address. This will occur after the MPTCP connection is established. If the peer did not announce any additional addresses using the MPTCP ADD_ADDR sub-option, this will behave the same as a plain subflow endpoint. When the peer does announce addresses, each received ADD_ADDR sub-option will trigger creation of an additional subflow to generate a full mesh topology.

-

-		 
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-initrd-generator.html b/docs/api/html/nm-initrd-generator.html deleted file mode 100644 index c2fdee5a..00000000 --- a/docs/api/html/nm-initrd-generator.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - -nm-initrd-generator: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-initrd-generator

-

nm-initrd-generator — early boot NetworkManager configuration generator

-
-
-

Synopsis

-

nm-initrd-generator [OPTIONS...] -- [CMDLINE...]

-
-
-

Description

-

nm-initrd-generator scans the command line for options - relevant to network configuration and creates configuration files for an early - instance of NetworkManager run from the initial ramdisk during early boot.

-
-
-

Options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- -c | --connections-dir - path -

Output connection directory.

- -p | --persistent-connections-dir - path -

Persistent connection directory. If it exists, rd.neednet will not - cause a default connection to be generated in absence of other options.

- -i | --initrd-data-dir - path -

Output directory for initrd data (e.g. hostname).

- -d | --sysfs-dir - path -

The sysfs mount point.

- -r | --run-config-dir - path -

Output directory for config files.

- -s | --stdout -

Dump connections to standard output. Useful for debugging.

CMDLINE

 -

The options that appear on the kernel command line. The following options are recognized:

- - - - - - - - - - - - - - - - - - - - - - - - -
ip
rd.route
bridge
bond
team
vlan
ib.pkey
bootdev
nameserver
net.ifnames
rd.peerdns
rd.iscsi.ibft
rd.bootif
rd.neednet
rd.ethtool
rd.net.timeout.dhcp
rd.net.dhcp.retry
rd.net.dhcp.vendor-class
rd.net.dhcp.dscp
rd.net.timeout.carrier
rd.znet
rd.znet_ifname
BOOTIF
-

Please consult the dracut.cmdline(7) - manual for the documentation of the precise format of the values supported.

-
-
-
-

Differences from the network-legacy dracut module

-

nm-initrd-generator generates a set of - connections that are then configured by the NetworkManager - instance running in the initrd. There are some differences in - behavior compared to the network-legacy dracut module:

-
    -

  • When an interface is configured with a static address - and a gateway, the network-legacy module waits that the - gateway responds to arping requests before proceeding, while - NetworkManager doesn't.

    • -

  • network-legacy configures interfaces one by one in the - order in which they are announced by udev. If multiple - interfaces specify a hostname (from command line or from - DHCP), the one from the last interface activated wins. With - NetworkManager, hostnames from command line have higher - precedence over ones from DHCP, and the last that appears in - the command line wins.

    • -

  • NetworkManager supports the - ib.pkey=PARENT.PKEY - argument to set up an Infiniband partition on IPoIB parent - device PARENT using the specified - partition key PKEY. The partition - key must be in hexadecimal notation without leading "0x", for - example "ib.pkey=ib0.8004". -

    • -

  • NetworkManager supports the - rd.ethtool=INTERFACE:AUTONEG:SPEED - kernel command line option to set up ethtool NIC configuration parameters - AUTONEG and SPEED. - The INTERFACE being configured must be - specified, and the other parameters are optional and can be left blank. - When SPEED is set, duplex mode is - automatically set to 'full'. INTERFACE - accepts string values, AUTONEG accepts - boolean values (true and false / on or off / 0 or 1), and - SPEED accepts positive integer values. -

    • -

  • NetworkManager supports the - rd.net.dhcp.dscp={CS0|CS4|CS6} - kernel command line option to set a specific DSCP (TOS) value - in the IP header of DHCP messages. -

    • -
-
-
-

Exit Status

-

nm-initrd-generator exits with status 0. It ignores unrecognized - options and prints an error message if it encounters a malformed option.

-
-
-

See Also

-

dracut.cmdline(7), - NetworkManager(8).

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-online.html b/docs/api/html/nm-online.html deleted file mode 100644 index 168b305b..00000000 --- a/docs/api/html/nm-online.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - -nm-online: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-online

-

nm-online — ask NetworkManager whether the network is connected

-
-
-

Synopsis

-

nm-online [OPTIONS...]

-
-
-

Description

-

nm-online is a utility to find out whether we are - online. It is done by asking NetworkManager about its status. When run, - nm-online waits until NetworkManager reports an active - connection, or specified timeout expires. On exit, the returned status code - should be checked (see the return codes below).

-

This tool is not very useful to call directly. It is however used by - NetworkManager-wait-online.service with - --wait-for-startup argument - (see NetworkManager-wait-online.service(8)). -

-

By default, connections have the ipv4.may-fail and - ipv6.may-fail properties set to yes; - this means that NetworkManager waits for one of the two address families to - complete configuration before considering the connection activated. If you - need a specific address family configured before - network-online.target is reached, set the corresponding - may-fail property to no.

-
-
-

Options

-
---- - - - - - - - - - - - - - - - - - - - - - - -

-h | --help

Print help information.

-q | --quiet

Don't print anything.

-s | --wait-for-startup

-

Wait for NetworkManager startup to complete, rather than waiting for - network connectivity specifically. Startup is considered complete once - NetworkManager has activated (or attempted to activate) every auto-activate - connection which is available given the current network state. This corresponds - to the moment when NetworkManager logs "startup complete". - This mode is generally only useful at boot time. After startup has completed, - nm-online -s will just return immediately, regardless of the - current network state.

-

There are various ways to affect when startup complete is reached. - For details see - NetworkManager-wait-online.service(8). -

-

- -t | --timeout - seconds -

Time to wait for a connection, in seconds. If the option is not provided, - the environment variable NM_ONLINE_TIMEOUT is honored. - The default timeout is 30 seconds.

-x | --exit

Exit immediately if NetworkManager is not running or connecting.

-
-
-

Exit Status

-

nm-online exits with status 0 if it succeeds, a value - greater than 0 is returned if an error occurs.

-
---- - - - - - - - - - - - - - - -

0

Success – already online or connection established within given timeout.

1

Offline or not online within given timeout.

2

Unknown or unspecified error.

-
-
-

See Also

-

nmcli(1), - NetworkManager(8), - NetworkManager-wait-online.service(8). -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-openvswitch.html b/docs/api/html/nm-openvswitch.html deleted file mode 100644 index 3f1b8460..00000000 --- a/docs/api/html/nm-openvswitch.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - -nm-openvswitch: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-openvswitch

-

nm-openvswitch — overview of NetworkManager Open vSwitch support

-
-
-

Overview

-

NetworkManager includes basic Open vSwitch support, good enough - to be capable of setting up simple Open vSwitch configurations. It is not - extensive and does not expose all functionality of Open vSwitch provides. - For large or complicated deployments users are advised to use native tools - shipped with Open vSwitch. This document seeks to provide overview of - functionality currently provided by NetworkManager, its capabilities and - limitations.

-

First and foremost: NetworkManager applies the configuration by - modifying the OVSDB directly. Its configuration model follows the OVSDB - database model closely and it does not provide the level of abstraction - ovs-vsctl provides.

-

In practical terms it means the following: -

-
    -

  • NetworkManager only ever talks to a single OVSDB instance via an - UNIX domain socket.

    • -

  • The configuration is made up of Bridges, Ports and - Interfaces. Interfaces are always attached to Ports, and Ports are always - attached to Bridges.

    • -

  • NetworkManager only creates Bridges, Ports and Interfaces - you ask it to. Unlike ovs-vsctl, it doesn't create the - local interface nor its port automatically.

    • -

  • You can't attach Interface directly to a Bridge. You - always need a Port, even if it has just one interface.

    • -

  • There are no VLANs. The VLAN tagging is enabled by setting a - ovs-port.tag - property on a Port.

    • -

  • There are no bonds either. The bonding is enabled by - enslaving multiple Interfaces to a Port and configured by setting - properties on a port.

    • -
-

-

-
-

Bridges

-

Bridges are represented by connections of ovs-bridge - type. - Due to the limitations of OVSDB, "empty" Bridges (with no Ports) can't exist. - NetworkManager inserts the records for Bridges into OVSDB when a Port is - attached. -

-
-
-
-

Ports

-

Ports are represented by connections of ovs-port - type. - Due to the limitations of OVSDB, "empty" Ports (with no Interfaces) can't - exist. Ports can also be configured to do VLAN tagging or Bonding. - NetworkManager inserts the records for Ports into OVSDB when an Interface is - attached. Ports must be attached to a Bridge.

-
-
-
-

Interfaces

-

Interfaces are represented by a connections attached to a Port. The - system interfaces (that have a corresponding Linux link) have a respective - connection.type - of the link (e.g. "wired", "bond", "dummy", etc.). Other interfaces ("internal" - or "patch" interfaces) are of ovs-interface type. The OVSDB entries are - inserted upon attachment to a Port.

-
-
-
-

Examples

-
-

Example 20. Creating a Bridge with a single internal Interface

-
-
$ nmcli conn add type ovs-bridge conn.interface bridge0
-Connection 'ovs-bridge-bridge0' (d10fc64d-1d48-4394-a1b8-e1aea72f27d5) successfully added.
-$ nmcli conn add type ovs-port conn.interface port0 controller bridge0
-Connection 'ovs-port-port0' (5ae22bae-bba4-4815-9ade-7e635633e1f0) successfully added.
-$ nmcli conn add type ovs-interface port-type ovs-port conn.interface iface0 \
-  controller port0 ipv4.method manual ipv4.address 192.0.2.1/24
-Connection 'ovs-interface-iface0' (3640d2a1-a2fd-4718-92f1-cffadb5b6cdc) successfully added.
-
-

As said above, you need to create a Port even for a single interface. - Also, before you add the Interface, the Bridge and Port devices appear active, - but are not configured in OVSDB yet. You can inspect the results with - ovs-vsctl show.

-
-
-
-

Example 21. Adding a Linux interface to a Bridge

-
-
$ nmcli conn add type ovs-port conn.interface port1 controller bridge0
-Connection 'ovs-port-port1' (67d041eb-8e7b-4458-afee-a1d07c9c4552) successfully added.
-$ nmcli conn add type ethernet conn.interface eth0 controller port1
-Connection 'ovs-slave-eth0' (d459c45c-cf78-4c1c-b4b7-505e71379624) successfully added.
-
-

Again, you need a port.

-
-
-
-

Example 22. Creating a VLAN

-
-
$ nmcli conn add type ovs-port conn.interface port2 controller bridge0 ovs-port.tag 120
-Connection 'ovs-port-port2' (3994c093-4ef7-4549-a4fd-627b831c3cb8) successfully added.
-$ nmcli conn add type ethernet conn.interface eth1 controller port2
-Connection 'ovs-slave-eth1' (099be06e-71ad-484d-8d5a-fcadc5f207f5) successfully added.
-
-

It's just a port with a tag.

-
-
-
-

Example 23. Creating a Bond

-
-
$ nmcli conn add type ovs-port conn.interface bond0 controller bridge0
-Connection 'ovs-port-bond0' (d154ebf9-e999-4e1b-a084-a3de53d25d8a) successfully added.
-$ nmcli conn add type ethernet conn.interface eth2 controller bond0
-Connection 'ovs-slave-eth2' (475ac1bf-30b2-4534-a877-27f33f58b082) successfully added.
-$ nmcli conn add type ethernet conn.interface eth3 controller bond0
-Connection 'ovs-slave-eth3' (8dedeecb-ed12-482b-b77a-24a4fb835136) successfully added.
-
-

It's just a Port with multiple interfaces. See nm-settings-nmcli manual for - Bonding options you can use with "nmcli c add" or "nmcli c modify". You could - even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same - time.

-
-
-
-
-
-

Bugs

-
    -

  • Not all Open vSwitch capabilities are supported.

    • -

  • Open vSwitch devices don't expose many useful properties on D-Bus.

    • -
-

Probably many more.

-
-
-

See Also

-

- RFC 7047: The Open vSwitch Database Management Protocol, - ovs-vsctl(8), - ovs-vswitchd.conf.db(5), - nm-settings-nmcli(5), - nmcli(1) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html deleted file mode 100644 index 743d8447..00000000 --- a/docs/api/html/nm-settings-dbus.html +++ /dev/null @@ -1,5213 +0,0 @@ - - - - -nm-settings-dbus: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-settings-dbus

-

nm-settings-dbus — Description of settings and properties of NetworkManager connection profiles on the D-Bus API

-
-
-

Description

-

- NetworkManager is based on a concept of connection profiles, sometimes referred to as - connections only. These connection profiles contain a network configuration. When - NetworkManager activates a connection profile on a network device the configuration will - be applied and an active network connection will be established. Users are free to create - as many connection profiles as they see fit. Thus they are flexible in having various network - configurations for different networking needs. The connection profiles are handled by - NetworkManager via settings service and are exported on D-Bus - (/org/freedesktop/NetworkManager/Settings/<num> objects). - The conceptual objects can be described as follows: -

-
---- - - - - -

Connection (profile)

- A specific, encapsulated, independent group of settings describing - all the configuration required to connect to a specific network. - It is referred to by a unique identifier called the UUID. A connection - is tied to a one specific device type, but not necessarily a specific - hardware device. It is composed of one or more Settings - objects. -

-
---- - - - - -

Setting

- A group of related key/value pairs describing a specific piece of a - Connection (profile). Settings keys and allowed values are - described in the tables below. Keys are also referred to as properties. - Developers can find the setting objects and their properties in the libnm-core - sources. Look for the *_class_init functions near the bottom - of each setting source file. -

-
-

- The settings and properties shown in tables below list all available connection - configuration options. However, note that not all settings are applicable to all - connection types. NetworkManager provides a command-line tool nmcli - that allows direct configuration of the settings and properties according to a connection - profile type. nmcli connection editor has also a built-in - describe command that can display description of particular settings - and properties of this page. -

- ---- - -
-
-
-

connection setting

-

General Connection Profile Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-auth-retriesint32-1The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. - -Currently, this only applies to 802-1x authentication.
-autoconnectbooleanTRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. - -Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. - -Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. - -If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. - -Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.
-autoconnect-portsint32-1Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.
-autoconnect-priorityint320The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.
-autoconnect-retriesint32-1The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.
-autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32) Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0. - -Deprecated 1.46. Use "autoconnect-ports" instead, this is just an alias.
-controllerstring Interface name of the controller device or UUID of the controller connection.
-dns-over-tlsint32-1Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. - -The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. - -This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
-down-on-poweroffint32-1Whether the connection will be brought down before the system is powered off. The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as 0 (no).
-gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
-idstring A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
-interface-namestring The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). - -For software devices this specifies the name of the created device. - -For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
-lldpint32-1Whether LLDP is enabled for the connection.
-llmnrint32-1Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. - -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). - -This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
-masterstring Interface name of the controller device or UUID of the controller connection. - -Deprecated 1.46. Use "controller" instead, this is just an alias.
-mdnsint32-1Whether mDNS is enabled for the connection. - -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin. - -This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. Currently the only supported DNS plugin is systemd-resolved. For systemd-resolved, the default is configurable via MulticastDNS= setting in resolved.conf.
-meteredNMMetered (int32) Whether the connection is metered. - -When updating this property on a currently activated connection, the change takes effect immediately.
-mptcp-flagsuint320Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. - -If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. - -The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. - -Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. - -Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. - -When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. - -If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. - -NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. - -Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).
-mud-urlstring If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". - -The special value "none" is allowed to indicate that no MUD URL is used. - -If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".
-multi-connectint320Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.
-permissionsarray of string An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". - -At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.
-port-typestring Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.
-read-onlybooleanFALSEThis property is deprecated and has no meaning. - -This property is deprecated since version 1.44.This property is deprecated and has no meaning.
-secondariesarray of string List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.
-slave-typestring Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port. - -Deprecated 1.46. Use "port-type" instead, this is just an alias.
-stable-idstring This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. - -The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. - -Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. - -The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. - -If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.
-timestampuint640The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. - -NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
-typestring Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
-uuidstring A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. - -The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
-wait-activation-delayint32-1Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - -The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
-wait-device-timeoutint32-1Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. - -The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
-zonestring The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. - -When updating this property on a currently activated connection, the change takes effect immediately.
-
-
-
-

6lowpan setting

-

6LoWPAN Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-parentstring If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.
-
-
-
-

802-1x setting

-

IEEE 802.1x Authentication Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-altsubject-matchesarray of string List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.
-anonymous-identitystring Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.
-auth-timeoutint320A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.
-ca-certbyte array Contains the CA certificate if used by the EAP method specified in the "eap" property. - -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - -Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
-ca-cert-passwordstring The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
-ca-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "ca-cert-password" property.
-ca-pathstring UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. - -If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
-client-certbyte array Contains the client certificate if used by the EAP method specified in the "eap" property. - -Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.
-client-cert-passwordstring The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
-client-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "client-cert-password" property.
-domain-matchstring Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
-domain-suffix-matchstring Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
-eaparray of string The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.
-identitystring Identity string for EAP authentication methods. Often the user's user or login name.
-openssl-ciphersstring Define openssl_ciphers for wpa_supplicant. Openssl sometimes moves ciphers among SECLEVELs, thus compiled-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols.
-optionalbooleanFALSEWhether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.
-pac-filestring UTF-8 encoded file path containing PAC for EAP-FAST.
-passwordstring UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property.
-password-rawbyte array Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
-password-raw-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password-raw" property.
-phase1-auth-flagsuint320Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.
-phase1-fast-provisioningstring Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.
-phase1-peaplabelstring Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.
-phase1-peapverstring Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.
-phase2-altsubject-matchesarray of string List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.
-phase2-authstring Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.
-phase2-autheapstring Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
-phase2-ca-certbyte array Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - -Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
-phase2-ca-cert-passwordstring The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
-phase2-ca-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-ca-cert-password" property.
-phase2-ca-pathstring UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. - -If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
-phase2-client-certbyte array Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - -Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
-phase2-client-cert-passwordstring The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
-phase2-client-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-client-cert-password" property.
-phase2-domain-matchstring Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
-phase2-domain-suffix-matchstring Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
-phase2-private-keybyte array Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". - -Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
-phase2-private-key-passwordstring The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.
-phase2-private-key-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-private-key-password" property.
-phase2-subject-matchstring Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used. - -This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.
-pinstring PIN used for EAP authentication methods.
-pin-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "pin" property.
-private-keybyte array Contains the private key when the "eap" property is set to "tls". - -Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - -WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
-private-key-passwordstring The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.
-private-key-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "private-key-password" property.
-subject-matchstring Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used. - -This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.
-system-ca-certsbooleanFALSEWhen TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
-
-
-
-

adsl setting

-

ADSL Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-encapsulationstring Encapsulation of ADSL connection. Can be "vcmux" or "llc".
-passwordstring Password used to authenticate with the ADSL service.
-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property.
-protocolstring ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".
-usernamestring Username used to authenticate with the ADSL service.
-vciuint320VCI of ADSL connection
-vpiuint320VPI of ADSL connection
-
-
-
-

bluetooth setting

-

Bluetooth Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-bdaddrbyte array The Bluetooth address of the device.
-typestring Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
-
-
-
-

bond setting

-

Bonding Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.
-optionsdict of string to string{'mode': 'balance-rr'}Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
-
-
-
-

bridge setting

-

Bridging Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-ageing-timeuint32300The Ethernet MAC address aging time, in seconds.
-forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds.
-group-addressbyte array If specified, The MAC address of the multicast group this bridge uses for STP. - -The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.
-group-forward-maskuint320A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.
-hello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds.
-interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.
-mac-addressbyte array If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. - -If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. - -This property is deprecated since version 1.12.Use the "cloned-mac-address" property instead.
-max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds.
-multicast-hash-maxuint324096Set maximum size of multicast hash table (value must be a power of 2).
-multicast-last-member-countuint322Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.
-multicast-last-member-intervaluint64100Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.
-multicast-membership-intervaluint6426000Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.
-multicast-querierbooleanFALSEEnable or disable sending of multicast queries by the bridge. If not specified the option is disabled.
-multicast-querier-intervaluint6425500If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.
-multicast-query-intervaluint6412500Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.
-multicast-query-response-intervaluint641000Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.
-multicast-query-use-ifaddrbooleanFALSEIf enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.
-multicast-routerstring Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. - -Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).
-multicast-snoopingbooleanTRUEControls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
-multicast-startup-query-countuint322Set the number of IGMP queries to send during startup phase.
-multicast-startup-query-intervaluint643125Sets the time (in deciseconds) between queries sent out at startup to determine membership information.
-priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.
-stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.
-vlan-default-pviduint321The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.
-vlan-filteringbooleanFALSEControl whether VLAN filtering is enabled on the bridge.
-vlan-protocolstring If specified, the protocol used for VLAN filtering. - -Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.
-vlan-stats-enabledbooleanFALSEControls whether per-VLAN stats accounting is enabled.
-vlansarray of vardict Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
-
-
-
-

bridge-port setting

-

Bridge Port Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-hairpin-modebooleanFALSEEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.
-path-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port.
-priorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.
-vlansarray of vardict Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.
-
-
-
-

cdma setting

-

CDMA-based Mobile Broadband Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
-numberstring The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.
-passwordstring The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property.
-usernamestring The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
-
-
-
-

dcb setting

-

Data Center Bridging Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-app-fcoe-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
-app-fcoe-modestring The FCoE controller mode; either "fabric" or "vn2vn". - -Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".
-app-fcoe-priorityint32-1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the 0x1 (enable) flag.
-app-fip-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
-app-fip-priorityint32-1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the 0x1 (enable) flag.
-app-iscsi-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
-app-iscsi-priorityint32-1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the 0x1 (enable) flag.
-priority-bandwidtharray of uint32 An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.
-priority-flow-controlarray of uint32 An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.
-priority-flow-control-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
-priority-group-bandwidtharray of uint32 An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.
-priority-group-flagsNMSettingDcbFlags (uint32) Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
-priority-group-idarray of uint32 An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
-priority-strict-bandwidtharray of uint32 An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.
-priority-traffic-classarray of uint32 An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.
-
-
-
-

dummy setting

-

Dummy Link Settings.

-
------ - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-
-
-
-

ethtool setting

-

Ethtool Ethernet Settings.

-
------ - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-
-
-
-

generic setting

-

Generic Link Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-device-handlerstring Name of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'. - -See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler. - -By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler.
-
-
-
-

gsm setting

-

GSM-based Mobile Broadband Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-apnstring The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. - -If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.
-auto-configbooleanFALSEWhen TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.
-device-idstring The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.
-home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
-initial-eps-bearer-apnstring For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.
-initial-eps-bearer-configurebooleanFALSEFor LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
-network-idstring The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
-numberstring Legacy setting that used to help establishing PPP data sessions for GSM-based modems. - -This property is deprecated since version 1.16.User-provided values for this setting are no longer used.
-passwordstring The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.
-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property.
-pinstring If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.
-pin-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "pin" property.
-sim-idstring The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
-sim-operator-idstring A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.
-usernamestring The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.
-
-
-
-

hsr setting

-

HSR/PRP Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-multicast-specuint320The last byte of supervision address.
-port1string The port1 interface name of the HSR. This property is mandatory.
-port2string The port2 interface name of the HSR. This property is mandatory.
-prpbooleanFALSEThe protocol used by the interface, whether it is PRP or HSR.
-
-
-
-

infiniband setting

-

Infiniband Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-mac-addressbyte array If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
-p-keyint32-1The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed. - -With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported. - -Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.
-parentstring The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".
-transport-modestring The IP-over-InfiniBand transport mode. Either "datagram" or "connected".
-
-
-
-

ipv4 setting

-

IPv4 Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-address-dataarray of vardict Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
-addressesarray of array of uint32 Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. -Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.
-auto-route-ext-gwNMTernary (int32) VPN connections will default to add the route automatically unless this setting is set to FALSE. - -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
-dad-timeoutint32-1Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4. - -A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.
-dhcp-client-idstring A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. - -The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. - -The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. - -The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. - -The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. - -The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended. - -If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.
-dhcp-dscpstring Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6". - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.
-dhcp-fqdnstring If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.
-dhcp-hostnamestring If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
-dhcp-hostname-flagsuint320Flags for the DHCP hostname and FQDN. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.
-dhcp-iaidstring A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". - -For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. - -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address. - -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.
-dhcp-reject-serversarray of string Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - -For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - -This property is currently not implemented for DHCPv6.
-dhcp-send-hostnamebooleanTRUEIf TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
-dhcp-send-releaseNMTernary (int32) Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.
-dhcp-timeoutint320A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). - -Set to 2147483647 (MAXINT32) for infinity.
-dhcp-vendor-class-identifierstring The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.
-dnsarray of uint32 Array of IP addresses of DNS servers (as network-byte-order integers)
-dns-dataarray of strings Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.
-dns-optionsarray of string Array of DNS options to be added to resolv.conf. - -NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. - -The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. - -In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). - -The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.
-dns-priorityint320DNS servers priority. - -The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - -Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. - -Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. - -When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - -When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
-dns-searcharray of string List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. - -When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - -When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
-gatewaystring The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - -Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - -Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
-ignore-auto-dnsbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
-ignore-auto-routesbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
-link-localint320Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. - -When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".
-may-failbooleanTRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
-methodstring IP configuration method. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - -For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
-never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
-replace-local-ruleNMTernary (int32) Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
-required-timeoutint32-1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - -Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - -A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
-route-dataarray of vardict Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
-route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
-route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. - -This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - -If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - -Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
-routesarray of array of uint32 Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. -Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)
-routing-rulesarray of 'a{sv}' Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).
-
-
-
-

ipv6 setting

-

IPv6 Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-addr-gen-modeint323Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. - -The permitted values are: 0 (eui64), 1 (stable-privacy). 2 (default-or-eui64) or 3 (default). - -If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. - -If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced. - -The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. - -For libnm, the property defaults to "default" since 1.40. Previously it used to default to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. - -Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
-address-dataarray of vardict Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
-addressesarray of legacy IPv6 address struct (a(ayuay)) Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. -Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.
-auto-route-ext-gwNMTernary (int32) VPN connections will default to add the route automatically unless this setting is set to FALSE. - -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
-dad-timeoutint32-1Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4. - -A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.
-dhcp-dscpstring Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6". - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.
-dhcp-duidstring A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. - -The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. - -The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. - -The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). - -When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.
-dhcp-hostnamestring If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
-dhcp-hostname-flagsuint320Flags for the DHCP hostname and FQDN. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.
-dhcp-iaidstring A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". - -For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. - -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address. - -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.
-dhcp-pd-hintstring A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").
-dhcp-reject-serversarray of string Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - -For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - -This property is currently not implemented for DHCPv6.
-dhcp-send-hostnamebooleanTRUEIf TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
-dhcp-send-releaseNMTernary (int32) Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.
-dhcp-timeoutint320A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). - -Set to 2147483647 (MAXINT32) for infinity.
-dnsarray of byte array Array of IP addresses of DNS servers (in network byte order)
-dns-dataarray of strings Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.
-dns-optionsarray of string Array of DNS options to be added to resolv.conf. - -NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. - -The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. - -In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). - -The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.
-dns-priorityint320DNS servers priority. - -The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - -Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. - -Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. - -When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - -When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
-dns-searcharray of string List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. - -When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - -When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
-gatewaystring The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - -Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - -Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
-ignore-auto-dnsbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
-ignore-auto-routesbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
-ip6-privacyNMSettingIP6ConfigPrivacy (int32) Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). - -Having a per-connection setting set to "-1" (default) means fallback to global configuration "ipv6.ip6-privacy". If it's also unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". - -Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.
-may-failbooleanTRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
-methodstring IP configuration method. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - -For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
-mtuuint320Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.
-never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
-ra-timeoutint320A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. - -Set to 2147483647 (MAXINT32) for infinity.
-replace-local-ruleNMTernary (int32) Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
-required-timeoutint32-1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - -Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - -A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
-route-dataarray of vardict Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
-route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
-route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. - -This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - -If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - -Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
-routesarray of legacy IPv6 route struct (a(ayuayu)) Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. -Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.
-routing-rulesarray of 'a{sv}' Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).
-temp-preferred-lifetimeint320The preferred lifetime of autogenerated temporary addresses, in seconds. - -Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-preferred-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_prefered_lft".
-temp-valid-lifetimeint320The valid lifetime of autogenerated temporary addresses, in seconds. - -Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-valid-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_valid_lft".
-tokenstring Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. - -When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.
-
-
-
-

ip-tunnel setting

-

IP Tunneling Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-encapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.
-flagsuint320Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy), 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.
-flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
-fwmarkuint320The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.
-input-keystring The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
-localstring The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
-modeuint320The tunneling mode. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap)
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.
-output-keystring The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
-parentstring If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
-path-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel.
-remotestring The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
-tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
-ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
-
-
-
-

macsec setting

-

MACSec Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-encryptbooleanTRUEWhether the transmitted traffic must be encrypted.
-mka-cakstring The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.
-mka-cak-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "mka-cak" property.
-mka-cknstring The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.
-modeint320Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.
-offloadint32-1Specifies the MACsec offload mode. - -0 (off) disables MACsec offload. - -1 (phy) and 2 (mac) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail. - --1 (default) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is 0 (off).
-parentstring If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
-portint321The port component of the SCI (Secure Channel Identifier), between 1 and 65534.
-send-scibooleanTRUESpecifies whether the SCI (Secure Channel Identifier) is included in every packet.
-validationint322Specifies the validation mode for incoming frames.
-
-
-
-

macvlan setting

-

MAC VLAN Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-modeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
-parentstring If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
-promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode.
-tapbooleanFALSEWhether the interface should be a MACVTAP.
-
-
-
-

match setting

-

Match settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-driverarray of string A list of driver names to match. Each element is a shell wildcard pattern. - -See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
-interface-namearray of string A list of interface names to match. Each element is a shell wildcard pattern. - -An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".
-kernel-command-linearray of string A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. - -See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.
-patharray of string A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. - -For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". - -The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). - -Each element of the list is a shell wildcard pattern. - -See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
-
-
-
-

802-11-olpc-mesh setting

-

OLPC Wireless Mesh Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-channeluint320Channel on which the mesh network to join is located.
-dhcp-anycast-addressbyte array Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - -This is currently only implemented by dhclient DHCP plugin.
-ssidbyte array SSID of the mesh network to join.
-
-
-
-

ovs-bridge setting

-

OvsBridge Link Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-datapath-typestring The data path type. One of "system", "netdev" or empty.
-fail-modestring The bridge failure mode. One of "secure", "standalone" or empty.
-mcast-snooping-enablebooleanFALSEEnable or disable multicast snooping.
-rstp-enablebooleanFALSEEnable or disable RSTP.
-stp-enablebooleanFALSEEnable or disable STP.
-
-
-
-

ovs-dpdk setting

-

OvsDpdk Link Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-devargsstring Open vSwitch DPDK device arguments.
-n-rxquint320Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.
-n-rxq-descuint320The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.
-n-txq-descuint320The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.
-
-
-
-

ovs-interface setting

-

Open vSwitch Interface Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-ofport-requestuint320Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.
-typestring The interface type. Either "internal", "system", "patch", "dpdk", or empty.
-
-
-
-

ovs-patch setting

-

OvsPatch Link Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-peerstring Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.
-
-
-
-

ovs-port setting

-

OvsPort Link Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-bond-downdelayuint320The time port must be inactive in order to be considered down.
-bond-modestring Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".
-bond-updelayuint320The time port must be active before it starts forwarding traffic.
-lacpstring LACP mode. One of "active", "off", or "passive".
-taguint320The VLAN tag in the range 0-4095.
-trunksarray of vardict A list of VLAN ranges that this port trunks. - -The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.
-vlan-modestring The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.
-
-
-
-

ppp setting

-

Point-to-Point Protocol Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-bauduint320If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.
-crtsctsbooleanFALSEIf TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.
-lcp-echo-failureuint320If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.
-lcp-echo-intervaluint320If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.
-mppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.
-mruuint320If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.
-mtuuint320If non-zero, instruct pppd to send packets no larger than the specified size.
-no-vj-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested.
-noauthbooleanTRUEIf TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.
-nobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested.
-nodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested.
-refuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used.
-refuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used.
-refuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used.
-refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used.
-refuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used.
-require-mppebooleanFALSEIf TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.
-require-mppe-128booleanFALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.
-
-
-
-

pppoe setting

-

PPP-over-Ethernet Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-parentstring If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.
-passwordstring Password used to authenticate with the PPPoE service.
-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "password" property.
-servicestring If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.
-usernamestring Username used to authenticate with the PPPoE service.
-
-
-
-

proxy setting

-

WWW Proxy Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-browser-onlybooleanFALSEWhether the proxy configuration is for browser only.
-methodint320Method for proxy configuration, Default is 0 (none)
-pac-scriptstring PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.
-pac-urlstring PAC URL for obtaining PAC file.
-
-
-
-

serial setting

-

Serial Link Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-bauduint3257600Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.
-bitsuint328Byte-width of the serial communication. The 8 in "8n1" for example.
-paritybyte The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.
-send-delayuint640Time to delay between each byte sent to the modem, in microseconds.
-stopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.
-
-
-
-

sriov setting

-

SR-IOV settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-autoprobe-driversNMTernary (int32) Whether to autoprobe virtual functions by a compatible driver. - -If set to 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. - -If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them. - -When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true).
-eswitch-encap-modeint32-1Select the eswitch encapsulation support. - -Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch encap-mode won't be modified by NetworkManager.
-eswitch-inline-modeint32-1Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering. - -Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch inline-mode won't be modified by NetworkManager.
-eswitch-modeint32-1Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch mode won't be modified by NetworkManager.
-total-vfsuint320The total number of virtual functions to create. - -Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.
-vfsarray of vardict Array of virtual function descriptors. - -Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. - -When represented as string a VF is in the form: - -"INDEX [ATTR=VALUE[ ATTR=VALUE]...]". - -for example: - -"2 mac=00:11:22:33:44:55 spoof-check=true". - -Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. - -The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form - -"ID[.PRIORITY[.PROTO]]". - -PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.
-
-
-
-

tc setting

-

Linux Traffic Control Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-qdiscsarray of vardict Array of TC queueing disciplines. - -When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. - -If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.
-tfiltersarray of vardict Array of TC traffic filters. - -When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. - -If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.
-
-
-
-

team setting

-

Teaming Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-configstring The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
-interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.
-link-watchersarray of vardict Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
-mcast-rejoin-countint32-1Corresponds to the teamd mcast_rejoin.count.
-mcast-rejoin-intervalint32-1Corresponds to the teamd mcast_rejoin.interval.
-notify-peers-countint32-1Corresponds to the teamd notify_peers.count.
-notify-peers-intervalint32-1Corresponds to the teamd notify_peers.interval.
-runnerstring Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".
-runner-activebooleanTRUECorresponds to the teamd runner.active.
-runner-agg-select-policystring Corresponds to the teamd runner.agg_select_policy.
-runner-fast-ratebooleanFALSECorresponds to the teamd runner.fast_rate.
-runner-hwaddr-policystring Corresponds to the teamd runner.hwaddr_policy.
-runner-min-portsint32-1Corresponds to the teamd runner.min_ports.
-runner-sys-prioint32-1Corresponds to the teamd runner.sys_prio.
-runner-tx-balancerstring Corresponds to the teamd runner.tx_balancer.name.
-runner-tx-balancer-intervalint32-1Corresponds to the teamd runner.tx_balancer.interval.
-runner-tx-hasharray of string Corresponds to the teamd runner.tx_hash.
-
-
-
-

team-port setting

-

Team Port Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-configstring The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
-lacp-keyint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_key.
-lacp-prioint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_prio.
-link-watchersarray of vardict Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
-prioint320Corresponds to the teamd ports.PORTIFNAME.prio.
-queue-idint32-1Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.
-stickybooleanFALSECorresponds to the teamd ports.PORTIFNAME.sticky.
-
-
-
-

tun setting

-

Tunnel Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-groupstring The group ID which will own the device. If set to NULL everyone will be able to use the device.
-modeuint321The operating mode of the virtual device. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet-like layer 2 one.
-multi-queuebooleanFALSEIf the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
-ownerstring The user ID which will own the device. If set to NULL everyone will be able to use the device.
-pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
-vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
-
-
-
-

user setting

-

General User Profile Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-datadict of string to string{}A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.
-
-
-
-

vlan setting

-

VLAN Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-egress-priority-maparray of string For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
-flagsNMVlanFlags (uint32) One or more flags which control the behavior and features of the VLAN interface. Flags include 0x1 (reorder-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose-binding) (loose binding of the interface to its controller device's operating state). 0x8 (mvrp) (use of the MVRP protocol). - -The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
-iduint320The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.
-ingress-priority-maparray of string For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
-interface-namestring Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.
-parentstring If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
-protocolstring Specifies the VLAN protocol to use for encapsulation. - -Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.
-
-
-
-

vpn setting

-

VPN Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-datadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.
-persistentbooleanFALSEIf the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.
-secretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.
-service-typestring D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
-timeoutuint320Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
-user-namestring If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.
-
-
-
-

vrf setting

-

VRF settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-tableuint320The routing table for this VRF.
-
-
-
-

vxlan setting

-

VXLAN Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-ageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel.
-destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
-iduint320Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.
-l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated.
-l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated.
-learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
-limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
-localstring If given, specifies the source IP address to use in outgoing packets.
-parentstring If given, specifies the parent interface name or parent connection UUID.
-proxybooleanFALSESpecifies whether ARP proxy is turned on.
-remotestring Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
-rscbooleanFALSESpecifies whether route short circuit is turned on.
-source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
-source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
-tosuint320Specifies the TOS value to use in outgoing packets.
-ttluint320Specifies the time-to-live value to use in outgoing packets.
-
-
-
-

wifi-p2p setting

-

Wi-Fi P2P Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-peerstring The P2P device that should be connected to. Currently, this is the only way to create or join a group.
-wfd-iesbyte array The Wi-Fi Display (WFD) Information Elements (IEs) to set. - -Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.
-wps-methoduint320Flags indicating which mode of WPS is to be used. - -There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.
-
-
-
-

wimax setting

-

WiMax Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-mac-addressbyte array If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). - -This property is deprecated since version 1.2.WiMAX is no longer supported.
-network-namestring Network Service Provider (NSP) name of the WiMAX network this connection should use. - -This property is deprecated since version 1.2.WiMAX is no longer supported.
-
-
-
-

802-3-ethernet setting

-

Wired Ethernet Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-accept-all-mac-addressesNMTernary (int32) When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.
-assigned-mac-addressstring The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
-auto-negotiatebooleanFALSEWhen TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.
-cloned-mac-addressbyte array This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
-duplexstring When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.
-generate-mac-address-maskstring With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. - -If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. - -If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
-mac-addressbyte array If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
-mac-address-blacklistarray of string If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
-mac-address-denylistarray of string If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
-portstring Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.
-s390-nettypestring s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.
-s390-optionsdict of string to string{}Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). - -Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.
-s390-subchannelsarray of string Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.
-speeduint320When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.
-wake-on-lanuint321The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).
-wake-on-lan-passwordstring If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.
-
-
-
-

wireguard setting

-

WireGuard Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-fwmarkuint320The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. - -Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.
-ip4-auto-default-routeNMTernary (int32) Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". - -Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. - -Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.
-ip6-auto-default-routeNMTernary (int32) Like ip4-auto-default-route, but for the IPv6 default route.
-listen-portuint320The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - -If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.
-peer-routesbooleanTRUEWhether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. - -Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.
-peersarray of 'a{sv}' Array of dictionaries for the WireGuard peers.
-private-keystring The 256 bit private-key in base64 encoding.
-private-key-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "private-key" property.
-
-
-
-

802-11-wireless setting

-

Wi-Fi Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-ap-isolationNMTernary (int32) Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from -1 (default) only when the interface is configured in AP mode. - -If set to 1 (true), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. - -If set to 0 (false), devices can talk to each other. - -When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false).
-assigned-mac-addressstring The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
-bandstring 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.
-bssidbyte array If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. - -Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.
-channeluint320Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.
-channel-widthint320Specifies width of the wireless channel in Access Point (AP) mode. - -When set to 0 (auto) (the default), the channel width is automatically determined. At the moment, this means that the safest (smallest) width is chosen. - -If the value is not 0 (auto), then the 'channel' property must also be set. When using the 2.4GHz band, the width can be at most 40MHz. - -This property can be set to a value different from 0 (auto) only when the interface is configured in AP mode.
-cloned-mac-addressbyte array This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
-generate-mac-address-maskstring With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. - -If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. - -If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
-hiddenbooleanFALSEIf TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. - -In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. - -In AP mode, the created network does not broadcast its SSID. - -Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.
-mac-addressbyte array If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
-mac-address-blacklistarray of string A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
-mac-address-denylistarray of string A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
-mac-address-randomizationuint320One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address). - -This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.
-modestring Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
-powersaveuint320One of 2 (disable) (disable Wi-Fi power saving), 3 (enable) (enable Wi-Fi power saving), 1 (ignore) (don't touch currently configure setting) or 0 (default) (use the globally configured value). All other values are reserved.
-rateuint320This property is not implemented and has no effect. - -This property is deprecated since version 1.44.This property is not implemented and has no effect.
-security  This property is deprecated and has no effect. For backwards compatibility, it can be set to "802-11-wireless-security" if the profile has a wireless security setting.
-seen-bssidsarray of string A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved. - -This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.
-ssidbyte array SSID of the Wi-Fi network. Must be specified.
-tx-poweruint320This property is not implemented and has no effect. - -This property is deprecated since version 1.44.This property is not implemented and has no effect.
-wake-on-wlanuint321The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk-rekey-failure), 0x20 (eap-identity-request), 0x40 (4way-handshake), 0x80 (rfkill-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).
-
-
-
-

802-11-wireless-security setting

-

Wi-Fi Security Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-auth-algstring When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.
-filsint320Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported). When set to 0 (default) and no global default is set, FILS will be optionally enabled.
-grouparray of string A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".
-key-mgmtstring Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). - -This property must be set for any Wi-Fi connection that uses security.
-leap-passwordstring The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
-leap-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "leap-password" property.
-leap-usernamestring The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
-pairwisearray of string A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".
-pmfint320Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported). When set to 0 (default) and no global default is set, PMF will be optionally enabled.
-protoarray of string List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.
-pskstring Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.
-psk-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "psk" property.
-wep-key-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.
-wep-key-typeNMWepKeyType (uint32) Controls the interpretation of WEP keys. Allowed values are 1 (key), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or 2 (passphrase), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.
-wep-key0string Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.
-wep-key1string Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
-wep-key2string Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
-wep-key3string Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.
-wep-tx-keyidxuint320When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.
-wps-methoduint320Flags indicating which mode of WPS is to be used if any. - -There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. - -WPS can be disabled by setting this property to a value of 1.
-
-
-
-

wpan setting

-

IEEE 802.15.4 (WPAN) MAC Settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-channelint32-1IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
-mac-addressstring If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.
-pageint32-1IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
-pan-iduint3265535IEEE 802.15.4 Personal Area Network (PAN) identifier.
-short-addressuint3265535Short IEEE 802.15.4 address to be used within a restricted environment.
-
-
-
-

bond-port setting

-

Bond Port Settings.

-
------ - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-prioint320The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.
-queue-iduint320The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.
-
-
-
-

hostname setting

-

Hostname settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-from-dhcpNMTernary (int32) Whether the system hostname can be determined from DHCP on this connection. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).
-from-dns-lookupNMTernary (int32) Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).
-only-from-defaultNMTernary (int32) If set to 1 (true), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). - -If set to 0 (false), the hostname can be set from this device even if it doesn't have the default route. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 0 (false).
-priorityint320The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. - -If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. - -Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.
-
-
-
-

link setting

-

Link settings.

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-gro-max-sizeint64-1The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
-gso-max-segmentsint64-1The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
-gso-max-sizeint64-1The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
-tx-queue-lengthint64-1The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
-
-
-
-

loopback setting

-

Loopback Link Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
-
-
-
-

ovs-external-ids setting

-

OVS External IDs Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-datadict of string to string{}A dictionary of key/value pairs with external-ids for OVS.
-
-
-
-

ovs-other-config setting

-

OVS Other Config Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-datadict of string to string{}A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.
-
-
-
-

veth setting

-

Veth Settings.

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-peerstring This property specifies the peer interface name of the veth. This property is mandatory.
-
-
-
-

Secret flag types:

-

- Each password or secret property in a setting has an associated flags property - that describes how to handle that secret. The flags property is a bitfield - that contains zero or more of the following values logically OR-ed together. -

-
    -

  • 0x0 (none) - the system is responsible for providing and storing this secret. This - may be required so that secrets are already available before the user logs in. - It also commonly means that the secret will be stored in plain text on disk, accessible - to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section - in NetworkManager.conf(5). -

    • -

  • 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing - this secret; when it is required, agents will be asked to provide it.

    • -

  • 0x2 (not-saved) - this secret should not be saved but should be requested from the user - each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, - or if the user simply does not want to save the secret.

    • -

  • 0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.

    • -
-
-
-
-

Files

-

/etc/NetworkManager/system-connections or distro plugin-specific location

-
-
-

See Also

-

nm-settings-nmcli(5), - nm-settings-keyfile(5), - NetworkManager(8), - nmcli(1), - nmcli-examples(7), - NetworkManager.conf(5)

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html deleted file mode 100644 index bfdf1af0..00000000 --- a/docs/api/html/nm-settings-ifcfg-rh.html +++ /dev/null @@ -1,2743 +0,0 @@ - - - - -nm-settings-ifcfg-rh: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-settings-ifcfg-rh

-

nm-settings-ifcfg-rh — Description of ifcfg-rh settings plugin

-
-
-

Description

-

- NetworkManager is based on the concept of connection profiles that contain - network configuration (see nm-settings-nmcli(5) for details). The profiles can be - stored in various formats. NetworkManager uses plugins for reading and writing - the data. The plugins can be configured in NetworkManager.conf(5). -

-

- The ifcfg-rh plugin is used on the Fedora and Red Hat - Enterprise Linux distributions to read/write configuration from/to - the traditional /etc/sysconfig/network-scripts/ifcfg-* files. - Each NetworkManager connection maps to one ifcfg-* file, with - possible usage of keys-* for passwords, route-* - for static IPv4 routes and route6-* for static IPv6 routes. - The plugin currently supports reading and writing Ethernet, Wi-Fi, InfiniBand, - VLAN, Bond, Bridge, and Team connections. Unsupported connection types (such as - WWAN, PPPoE, VPN, or ADSL) are handled by keyfile plugin - (nm-settings-keyfile(5)). - The main reason for using ifcfg-rh plugin is the compatibility - with legacy configurations for ifup and ifdown - (initscripts). -

-
-
-

File Format

-

- The ifcfg-rh config format is a simple text file containing - VARIABLE="value" lines. The format is described in sysconfig.txt - of initscripts package. Note that the configuration files - may be sourced by initscripts, so they must be valid shell - scripts. That means, for instance, that # character can be used - for comments, strings with spaces must be quoted, special characters must be escaped, - etc. -

-

- Users can create or modify the ifcfg-rh connection files - manually, even if that is not the recommended way of managing the profiles. - However, if they choose to do that, they must inform NetworkManager about - their changes (for example via nmcli con (re)load). -

-

Some ifcfg-rh configuration examples: 

-
Simple DHCP ethernet configuration:
-NAME=ethernet
-UUID=1c4ddf70-01bf-46d6-b04f-47e842bd98da
-TYPE=Ethernet
-BOOTPROTO=dhcp
-DEFROUTE=yes
-PEERDNS=yes
-PEERROUTES=yes
-IPV4_FAILURE_FATAL=no
-ONBOOT=yes
-
-
Simple ethernet configuration with static IP:
-TYPE=Ethernet
-BOOTPROTO=none
-IPADDR=10.1.0.25
-PREFIX=24
-GATEWAY=10.1.0.1
-DEFROUTE=yes
-IPV4_FAILURE_FATAL=no
-IPV6INIT=yes
-IPV6_AUTOCONF=yes
-IPV6_DEFROUTE=yes
-IPV6_PEERDNS=yes
-IPV6_PEERROUTES=yes
-IPV6_FAILURE_FATAL=no
-NAME=ethernet-em2
-UUID=51bb3904-c0fc-4dfe-83b2-0a71e7928c13
-DEVICE=em2
-ONBOOT=yes
-
-
WPA2 Enterprise WLAN (TTLS with inner MSCHAPV2 authentication):
-ESSID="CompanyWLAN"
-MODE=Managed
-KEY_MGMT=WPA-EAP
-TYPE=Wireless
-IEEE_8021X_EAP_METHODS=TTLS
-IEEE_8021X_IDENTITY=joe
-IEEE_8021X_PASSWORD_FLAGS=ask
-IEEE_8021X_INNER_AUTH_METHODS=MSCHAPV2
-IEEE_8021X_CA_CERT=/home/joe/.cert/company.crt
-BOOTPROTO=dhcp
-DEFROUTE=yes
-PEERDNS=yes
-PEERROUTES=yes
-IPV4_FAILURE_FATAL=no
-IPV6INIT=no
-NAME=MyCompany
-UUID=f79848ff-11a6-4810-9e1a-99039dea84c4
-ONBOOT=yes
-
-
Bridge and bridge port configuration:
-ifcfg-bridge:                                ifcfg-bridge-port:
-NAME=bridge                                  NAME=bridge007-port-eth0
-UUID=4be99ce0-c5b2-4764-8b77-ec226e440125    UUID=3ad56c4a-47e1-419b-b0d4-8ad86eb967a3
-DEVICE=bridge007                             DEVICE=eth0
-STP=yes                                      ONBOOT=yes
-TYPE=Bridge                                  TYPE=Ethernet
-BRIDGING_OPTS=priority=32768                 BRIDGE=bridge007
-ONBOOT=yes
-BOOTPROTO=dhcp
-
-
-
Bonding configuration:
-ifcfg-BOND:                                  ifcfg-BOND-port:
-NAME=BOND                                    NAME=BOND-port
-UUID=b41888aa-924c-450c-b0f8-85a4f0a51b4a    UUID=9bb048e4-286a-4cc3-b104-007dbd20decb
-DEVICE=bond100                               DEVICE=eth0
-BONDING_OPTS="mode=balance-rr miimon=100"    ONBOOT=yes
-TYPE=Bond                                    TYPE=Ethernet
-BONDING_MASTER=yes                           MASTER=bond100
-ONBOOT=yes                                   SLAVE=yes
-BOOTPROTO=dhcp
-
-
-
Team and team port configuration:
-ifcfg-my_team0:
-DEVICE=team0
-TEAM_CONFIG="{ \"device\": \"team0\", \"runner\": {\"name\": \"roundrobin\"}, \"ports\": {\"eth1\": {}, \"eth2\": {}} }"
-DEVICETYPE=Team
-BOOTPROTO=dhcp
-NAME=team0-profile
-UUID=1d3460a0-7b37-457f-a300-fe8d92da4807
-ONBOOT=yes
-
-ifcfg-my_team0_port1:
-NAME=team0-port1
-UUID=d5aed298-c567-4cc1-b808-6d38ecef9e64
-DEVICE=eth1
-ONBOOT=yes
-TEAM_MASTER=team0
-DEVICETYPE=TeamPort
-
-ifcfg-my_team0_port2:
-NAME=team0-port2
-UUID=94e75f4e-e5ad-401c-8962-31e0ae5d2215
-DEVICE=eth2
-ONBOOT=yes
-TEAM_MASTER=team0
-DEVICETYPE=TeamPort
-
-

- The UUID values in the config files must be unique. You can use uuidgen - command line tool to generate such values. Alternatively, you can leave out UUID - entirely. In that case NetworkManager will generate a UUID based on the file name. -

-
-
-

Differences against initscripts

-

- The main differences of NetworkManager ifcfg-rh plugin and traditional - initscripts are: -

-
---- - - - - - - - - - - - - - - -

NM_CONTROLLED=yes|no

- NM_CONTROLLED is NetworkManager-specific variable used by NetworkManager - for determining whether the device of the ifcfg file - should be managed. NM_CONTROLLED=yes is supposed if the variable is not - present in the file. - Note that if you have more ifcfg files for a single - device, NM_CONTROLLED=no in one of the files will cause the device not - to be managed. The profile may not even be the active one. -

New variables

- NetworkManager has introduced some new variable, not present in initscripts, - to be able to store data for its new features. The variables are marked - as extensions in the tables below. -

Semantic change of variables and differences

 -

- NetworkManager changes the semantics for a few variables and there are other behavioral differences. -

-
    -

  • PEERDNS - - initscripts interpret PEERDNS=no to mean "never touch resolv.conf". - NetworkManager interprets it to say "never add automatic (DHCP, PPP, VPN, etc.) - nameservers to resolv.conf".

    • -

  • ONBOOT - - initscripts use ONBOOT=yes to mark the devices that are to be activated - during boot. NetworkManager extends this to also mean that this profile - can be used for auto-connecting at any time.

    • -

  • BOOTPROTO - - NetworkManager supports traditional values none (static), - dhcp. But it also allows additional values to - enable new addressing methods. They are autoip for IPv4 - link-local addressing using Avahi daemon and shared for - connection sharing. When shared is used, NetworkManager - assigns the interface 10.42.0.1, or it uses the first static address, - if configured.

    • -

  • HWADDR - - initscripts compare the currently set hardware address of a device, while - NetworkManager considers the permanent one.

    • -

  • NOZEROCONF - - initscripts add an on-link route to 169.254.0.0/16 for ethernet profiles that don't - explicitly opt-out by setting NOZEROCONF variable. NetworkManager does - not do that. Instead a static, manual route with scope=253 (link) should be added to get - that behavior.

    • -
-
-

- See the next section for detailed mapping of NetworkManager properties and - ifcfg-rh variables. Variable names, format and usage - differences in NetworkManager and initscripts are documented in the tables below. -

-
-
-

Details

-

ifcfg-rh plugin variables marked with (+) - are NetworkManager specific extensions not understood by traditional initscripts. -

-
-

Table 11. 802-11-wireless setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
ssidESSID SSID of Wi-Fi network. - -Example: ESSID="Quick Net"
modeMODE Wi-Fi network mode. - -Allowed values: Ad-Hoc, Managed (Auto) [case insensitive]
bandBAND(+) - BAND alone is honored, but CHANNEL overrides BAND since it implies a band. - -Example: BAND=bg - -Allowed values: a, bg
channelCHANNEL Channel used for the Wi-Fi communication. Channels greater than 14 mean "a" band, otherwise the band is "bg". - -Example: CHANNEL=6
bssidBSSID(+) - Restricts association only to a single AP. - -Example: BSSID=00:1E:BD:64:83:21
rate(none) This property is deprecated and not handled by ifcfg-rh plugin.
tx-power(none) This property is deprecated and not handled by ifcfg-rh plugin.
mac-addressHWADDR Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.
cloned-mac-addressMACADDR Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).
generate-mac-address-maskGENERATE_MAC_ADDRESS_MASK(+) - the MAC address mask for generating randomized and stable cloned-mac-address.
mac-address-blacklistHWADDR_BLACKLIST(+) - It denies usage of the connection for any device whose address is listed.
mac-address-denylistHWADDR_BLACKLIST(+) - It denies usage of the connection for any device whose address is listed.
seen-bssids(none) This is not a regular property that would be configured by the user. It is not handled by ifcfg-rh plugin.
mtuMTU MTU of the wireless interface.
hiddenSSID_HIDDEN(+) - Whether the network hides the SSID.
powersavePOWERSAVE(+) - Enables or disables Wi-Fi power saving. - -Example: POWERSAVE=enable - -Allowed values: default, ignore, enable, disable
mac-address-randomizationMAC_ADDRESS_RANDOMIZATION(+) - Enables or disables Wi-Fi MAC address randomization. - -Example: MAC_ADDRESS_RANDOMIZATION=always - -Allowed values: default, never, always
ap-isolationAP_ISOLATION(+) -missing variable means global defaultWhether AP isolation is enabled - -Allowed values: "yes", "no"
-
-
-

Table 12. 802-11-wireless-security setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
key-mgmtKEY_MGMT(+) - Key management method. - -Allowed values: none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192
wep-tx-keyidxDEFAULTKEY1Index of active WEP key. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based. - -Allowed values: 1, 2, 3, 4
auth-algSECURITYMODE(+) - Authentication algorithm for WEP. - -Allowed values: restricted, open, leap
protoWPA_ALLOW_WPA(+), WPA_ALLOW_WPA2(+) -noAllowed WPA protocols, WPA and WPA2 (RSN). - -Allowed values: yes, no
pairwiseCIPHER_PAIRWISE(+) - Restrict pairwise encryption algorithms, specified as a space separated list. - -Allowed values: CCMP, TKIP
groupCIPHER_GROUP(+) - Restrict group/broadcast encryption algorithms, specified as a space separated list. - -Allowed values: CCMP, TKIP, WEP40, WEP104
pmfPMF(+) - Enables or disables PMF (802.11w) - -Example: PMF=required - -Allowed values: default, disable, optional, required
leap-usernameIEEE_8021X_IDENTITY(+) - Login name for LEAP.
wep-key0KEY1, KEY_PASSPHRASE1(+) - The first WEP key (used in most networks). See also DEFAULTKEY for key index.
wep-key1KEY2, KEY_PASSPHRASE2(+) - WEP key with index 1. See also DEFAULTKEY for key index.
wep-key2KEY3, KEY_PASSPHRASE3(+) - WEP key with index 2. See also DEFAULTKEY for key index.
wep-key3KEY4, KEY_PASSPHRASE4(+) - WEP key with index 3. See also DEFAULTKEY for key index.
wep-key-flagsWEP_KEY_FLAGS(+) - Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see the section called “Secret flag types:” for _FLAGS values)
pskWPA_PSK Pre-Shared-Key for WPA networks.
psk-flagsWPA_PSK_FLAGS(+) - Password flags for WPA_PSK_FLAGS. (see the section called “Secret flag types:” for _FLAGS values) - -Example: WPA_PSK_FLAGS=user
leap-passwordIEEE_8021X_PASSWORD(+) - Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
leap-password-flagsIEEE_8021X_PASSWORD_FLAGS(+) - Password flags for IEEE_8021X_PASSWORD_FLAGS. (see the section called “Secret flag types:” for _FLAGS values)
wep-key-typeKEY<i> or KEY_PASSPHRASE<i>(+); KEY_TYPE(+) - KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. KEY_TYPE specifies the key type and can be either 'key' or 'passphrase'. KEY_TYPE is redundant and can be omitted. - -Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey
wps-methodWPS_METHOD Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used. - -Example: WPS_METHOD=disabled, WPS_METHOD="pin pbc"
filsFILS(+) - Enables or disables FILS (802.11ai) - -Example: FILS=required - -Allowed values: default, disable, optional, required
-
-
-

Table 13. 802-1x setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
eapIEEE_8021X_EAP_METHODS(+) - EAP method for 802.1X authentication. - -Example: IEEE_8021X_EAP_METHODS=PEAP - -Allowed values: "LEAP", "PWD", "TLS", "PEAP", "TTLS", "FAST"
identityIEEE_8021X_IDENTITY(+) - Identity for EAP authentication methods. - -Example: IEEE_8021X_IDENTITY=itsme
anonymous-identityIEEE_8021X_ANON_IDENTITY(+) - Anonymous identity for EAP authentication methods.
pac-fileIEEE_8021X_PAC_FILE(+) - File with PAC (Protected Access Credential) for EAP-FAST. - -Example: IEEE_8021X_PAC_FILE=/home/joe/my-fast.pac
ca-certIEEE_8021X_CA_CERT(+) - CA certificate for EAP. - -Example: IEEE_8021X_CA_CERT=/home/joe/cacert.crt
ca-pathIEEE_8021X_CA_PATH(+) - The search path for the certificate.
subject-matchIEEE_8021X_SUBJECT_MATCH(+) - Substring to match subject of server certificate against. - -Example: IEEE_8021X_SUBJECT_MATCH="Red Hat"
altsubject-matchesIEEE_8021X_ALTSUBJECT_MATCHES(+) - List of strings to be matched against the altSubjectName. - -Example: IEEE_8021X_ALTSUBJECT_MATCHES="s1.domain.cc"
domain-suffix-matchIEEE_8021X_DOMAIN_SUFFIX_MATCH(+) - Suffix to match domain of server certificate against.
domain-matchIEEE_8021X_DOMAIN_MATCH(+) - Value to match domain of server certificate against.
client-certIEEE_8021X_CLIENT_CERT(+) - Client certificate for EAP. - -Example: IEEE_8021X_CLIENT_CERT=/home/joe/mycert.crt
phase1-peapverIEEE_8021X_PEAP_VERSION(+) - Use to force a specific PEAP version. - -Allowed values: 0, 1
phase1-peaplabelIEEE_8021X_PEAP_FORCE_NEW_LABEL(+) -noUse to force the new PEAP label during key derivation. - -Allowed values: yes, no
phase1-fast-provisioningIEEE_8021X_FAST_PROVISIONING(+) - Enable in-line provisioning of EAP-FAST credentials. - -Example: IEEE_8021X_FAST_PROVISIONING="allow-auth allow-unauth" - -Allowed values: space-separated list of these values [allow-auth, allow-unauth]
phase1-auth-flagsIEEE_8021X_PHASE1_AUTH_FLAGS(+) - Authentication flags for the supplicant - -Example: IEEE_8021X_PHASE1_AUTH_FLAGS="tls-1-0-disable tls-1-1-disable" - -Allowed values: space-separated list of authentication flags names
phase2-authIEEE_8021X_INNER_AUTH_METHODS(+) - Inner non-EAP authentication methods for TTLS or the inner EAP authentication method for PEAP. IEEE_8021X_INNER_AUTH_METHODS can contain values both for 'phase2-auth' and 'phase2-autheap' properties. - -Example: IEEE_8021X_INNER_AUTH_METHODS=PAP - -Allowed values: "PAP", "CHAP", "MSCHAP", "MSCHAPV2", "GTC", "OTP", "MD5" and "TLS"
phase2-autheapIEEE_8021X_INNER_AUTH_METHODS(+) - Inner EAP-based authentication methods. Note that IEEE_8021X_INNER_AUTH_METHODS is also used for 'phase2-auth' values. - -Example: IEEE_8021X_INNER_AUTH_METHODS="MSCHAPV2 EAP-TLS" - -Allowed values: "EAP-MD5", "EAP-MSCHAPV2", "EAP-GTC", "EAP-OTP" and "EAP-TLS"
phase2-ca-pathIEEE_8021X_PHASE2_CA_PATH(+) - The search path for the certificate.
phase2-subject-matchIEEE_8021X_PHASE2_SUBJECT_MATCH(+) - Substring to match subject of server certificate against. - -Example: IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"
phase2-altsubject-matchesIEEE_8021X_PHASE2_ALTSUBJECT_MATCHES(+) -  
phase2-domain-suffix-matchIEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH(+) - Suffix to match domain of server certificate for phase 2 against.
phase2-domain-matchIEEE_8021X_PHASE2_DOMAIN_MATCH(+) - Value to match domain of server certificate for phase 2 against.
phase2-client-certIEEE_8021X_INNER_CLIENT_CERT(+) - Client certificate for inner EAP method. - -Example: IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crt
passwordIEEE_8021X_PASSWORD(+) - UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
password-flagsIEEE_8021X_PASSWORD_FLAGS(+) - Password flags for IEEE_8021X_PASSWORD password. (see the section called “Secret flag types:” for _FLAGS values)
password-rawIEEE_8021X_PASSWORD_RAW(+) - password used for EAP, encoded as a hexadecimal string. It can also go to "key-" lookaside file. - -Example: IEEE_8021X_PASSWORD_RAW=041c8320083aa4bf
password-raw-flagsIEEE_8021X_PASSWORD_RAW_FLAGS(+) - The secret flags for password-raw.
private-keyIEEE_8021X_PRIVATE_KEY(+) - Private key for EAP-TLS. - -Example: IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12
private-key-passwordIEEE_8021X_PRIVATE_KEY_PASSWORD(+) - Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
private-key-password-flagsIEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+) - Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see the section called “Secret flag types:” for _FLAGS values)
phase2-private-keyIEEE_8021X_INNER_PRIVATE_KEY(+) - Private key for inner authentication method for EAP-TLS.
phase2-private-key-passwordIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD(+) - Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.
phase2-private-key-password-flagsIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS(+) - Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see the section called “Secret flag types:” for _FLAGS values)
pinIEEE_8021X_PIN(+) - The pin secret used for EAP authentication methods.
pin-flagsIEEE_8021X_PIN_FLAGS(+) - The secret flags for the pin property.
system-ca-certsIEEE_8021X_SYSTEM_CA_CERTS(+) - a boolean value.
auth-timeoutIEEE_8021X_AUTH_TIMEOUT(+) -0Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.
optionalIEEE_8021X_OPTIONAL(+) default=no whether the 802.1X authentication is optional
openssl-ciphersIEEE_8021X_OPENSSL_CIPHERS(+) - Cipher string for tls setup of wpa_supplicant.
-
-
-

Table 14. 802-3-ethernet setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
port(none) The property is not saved by the plugin.
speedETHTOOL_OPTS Fixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.
duplexETHTOOL_OPTS Fixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.
auto-negotiateETHTOOL_OPTS Whether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).
mac-addressHWADDR Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.
cloned-mac-addressMACADDR Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).
generate-mac-address-maskGENERATE_MAC_ADDRESS_MASK(+) - the MAC address mask for generating randomized and stable cloned-mac-address.
mac-address-blacklistHWADDR_BLACKLIST(+) - It denies usage of the connection for any device whose address is listed. - -Example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"
mac-address-denylistHWADDR_BLACKLIST(+) - It denies usage of the connection for any device whose address is listed. - -Example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"
mtuMTU MTU of the interface.
s390-subchannelsSUBCHANNELS Subchannels for IBM S390 hosts. - -Example: SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00c
s390-nettypeNETTYPE Network type of the S390 host. - -Example: NETTYPE=qeth - -Allowed values: "qeth", "lcs" or "ctc"
s390-optionsOPTIONS and PORTNAME, CTCPROTO, S390 device options. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables.
wake-on-lanETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN Wake on Lan mode for ethernet. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore". Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page.
wake-on-lan-passwordETHTOOL_OPTS Password for secure-on based Wake-on-Lan. It is added as "sopass" parameter in the ETHTOOL_OPTS variable. - -Example: ETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55"
accept-all-mac-addressesACCEPT_ALL_MAC_ADDRESSES Enforce the interface to accept all the packets.
-
-
-

Table 15. bond setting

-
------ - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
optionsBONDING_OPTS Bonding options. - -Example: BONDING_OPTS="miimon=100 mode=broadcast"
-
-
-

Table 16. bond-port setting

-
------ - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
queue-idBOND_PORT_QUEUE_ID(+) -0Queue ID. - -Allowed values: 0 - 65535
prioBOND_PORT_PRIO(+) -0Port priority. - -Allowed values: -2147483648 - 2147483647
-
-
-

Table 17. bridge setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
mac-addressBRIDGE_MACADDR(+) - MAC address of the bridge. Note that this requires a recent kernel support, originally introduced in 3.15 upstream kernel) BRIDGE_MACADDR for bridges is an NM extension.
stpSTPnoSpan tree protocol participation.
priorityBRIDGING_OPTS: priority=32768STP priority. - -Allowed values: 0 - 32768
forward-delayDELAY15STP forwarding delay. - -Allowed values: 2 - 30
hello-timeBRIDGING_OPTS: hello_time=2STP hello time. - -Allowed values: 1 - 10
max-ageBRIDGING_OPTS: max_age=20STP maximum message age. - -Allowed values: 6 - 40
ageing-timeBRIDGING_OPTS: ageing_time=300Ethernet MAC ageing time. - -Allowed values: 0 - 1000000
multicast-snoopingBRIDGING_OPTS: multicast_snooping=1IGMP snooping support. - -Allowed values: 0 or 1
vlan-filteringBRIDGING_OPTS: vlan_filtering=0VLAN filtering support. - -Allowed values: 0 or 1
vlan-default-pvidBRIDGING_OPTS: default_pvid=1default VLAN PVID. - -Allowed values: 0 - 4094
vlansBRIDGE_VLANS List of VLANs on the bridge - -Example: BRIDGE_VLANS="1 pvid untagged,20,300-400 untagged"
group-addressBRIDGING_OPTS: group_address= STP group address. - -Example: BRIDGING_OPTS="group_address=01:80:C2:00:00:0A"
vlan-protocolBRIDGING_OPTS: vlan_protocol= VLAN filtering protocol. - -Example: BRIDGING_OPTS="vlan_protocol=802.1Q"
vlan-stats-enabledBRIDGING_OPTS: vlan_stats_enabled=0 - - -Example: BRIDGING_OPTS="vlan_stats_enabled=1"
multicast-routerBRIDGING_OPTS: multicast_router=auto - - -Example: BRIDGING_OPTS="multicast_router=enabled" - -Allowed values: auto, enabled, disabled
multicast-query-use-ifaddrBRIDGING_OPTS: multicast_query_use_ifaddr=0 - - -Example: BRIDGING_OPTS="multicast_query-use_ifaddr=1"
multicast-querierBRIDGING_OPTS: multicast_querier=0 - - -Example: BRIDGING_OPTS="multicast_querier=1"
multicast-hash-maxBRIDGING_OPTS: multicast_hash_max=4096 - - -Example: BRIDGING_OPTS="multicast_hash_max=8192"
multicast-last-member-countBRIDGING_OPTS: multicast_last_member_count=2 - - -Example: BRIDGING_OPTS="multicast_last_member_count=4"
multicast-last-member-intervalBRIDGING_OPTS: multicast_last_member_interval=100 - - -Example: BRIDGING_OPTS="multicast_last_member_interval=200"
multicast-membership-intervalBRIDGING_OPTS: multicast_membership_interval=26000 - - -Example: BRIDGING_OPTS="multicast_membership_interval=16000"
multicast-querier-intervalBRIDGING_OPTS: multicast_querier_interval=25500 - - -Example: BRIDGING_OPTS="multicast_querier_interval=20000"
multicast-query-intervalBRIDGING_OPTS: multicast_query_interval=12500 - - -Example: BRIDGING_OPTS="multicast_query_interval=22500"
multicast-query-response-intervalBRIDGING_OPTS: multicast_query_response_interval=1000 - - -Example: BRIDGING_OPTS="multicast_query_response_interval=2000"
multicast-startup-query-countBRIDGING_OPTS: multicast_startup_query_count=2 - - -Example: BRIDGING_OPTS="multicast_startup_query_count=4"
multicast-startup-query-intervalBRIDGING_OPTS: multicast_startup_query_interval=3125 - - -Example: BRIDGING_OPTS="multicast_startup_query_interval=4000"
-
-
-

Table 18. bridge-port setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
priorityBRIDGING_OPTS: priority=32STP priority. - -Allowed values: 0 - 63
path-costBRIDGING_OPTS: path_cost=100STP cost. - -Allowed values: 1 - 65535
hairpin-modeBRIDGING_OPTS: hairpin_mode=yesHairpin mode of the bridge port.
vlansBRIDGE_PORT_VLANS List of VLANs on the bridge port - -Example: BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged"
-
-
-

Table 19. connection setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
idNAME(+) - User friendly name for the connection profile.
uuidUUID(+) - UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the filename).
stable-idSTABLE_ID(+) - Token to generate stable IDs.
interface-nameDEVICE Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.
typeTYPE (DEVICETYPE, DEVICE) Base type of the connection. DEVICETYPE is used for teaming connections. - -Example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort - -Allowed values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort
permissionsUSERS(+) - Restrict to certain users the access to this connection, and allow the connection to be active only when at least one of the specified users is logged into an active session. - -Example: USERS="joe bob"
autoconnectONBOOTyesWhether the connection should be autoconnected (not only while booting).
autoconnect-priorityAUTOCONNECT_PRIORITY(+) -0Connection priority for automatic activation. Connections with higher numbers are preferred when selecting profiles for automatic activation. - -Example: AUTOCONNECT_PRIORITY=20 - -Allowed values: -999 to 999
autoconnect-retriesAUTOCONNECT_RETRIES(+) - The number of times a connection should be autoactivated before giving up and switching to the next one. - -Example: AUTOCONNECT_RETRIES=1 - -Allowed values: -1 (use global default), 0 (forever) or a positive value
multi-connectMULTI_CONNECT(+) - whether the profile can be active on multiple devices at a given moment. The values are numbers corresponding to #NMConnectionMultiConnect enum. - -Example: MULTI_CONNECT=3
zoneZONE(+) - Trust level of this connection. The string is usually used for a firewall. - -Example: ZONE=Work
masterMASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, BRIDGE, BRIDGE_UUID Reference to controller connection. The variable used depends on the connection type and the value. In general, if the *_UUID variant is present, the variant without *_UUID is ignored. NetworkManager attempts to write both for compatibility with legacy tooling.
slave-typeMASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, DEVICETYPE, BRIDGE, BRIDGE_UUID Slave type doesn't map directly to a variable, but it is recognized using different variables. MASTER and MASTER_UUID for bonding, TEAM_MASTER, TEAM_MASTER_UUID and DEVICETYPE for teaming, BRIDGE and BRIDGE_UUID for bridging.
autoconnect-slavesAUTOCONNECT_SLAVES(+) -missing variable means global defaultWhether slaves of this connection should be auto-connected when this connection is activated.
secondariesSECONDARY_UUIDS(+) - UUID of VPN connections that should be activated together with this connection.
gateway-ping-timeoutGATEWAY_PING_TIMEOUT(+) -0If greater than zero, the IP connectivity will be checked by pinging the gateway and waiting for the specified timeout (in seconds). - -Example: GATEWAY_PING_TIMEOUT=5
meteredCONNECTION_METERED(+) - Whether the device is metered - -Example: CONNECTION_METERED=yes - -Allowed values: yes,no,unknown
lldpLLDP(+) -missing variable means global defaultwhether LLDP is enabled for the connection - -Example: LLDP=no - -Allowed values: boolean value or 'rx'
auth-retriesAUTH_RETRIES(+) -0Number of retries for authentication.
mdnsMDNS(+) -missing variable means global defaultWhether or not mDNS is enabled for the connection - -Example: MDNS=yes - -Allowed values: yes,no,resolve
llmnrLLMNR(+) -missing variable means global defaultWhether or not LLMNR is enabled for the connection - -Example: LLMNR=yes - -Allowed values: yes,no,resolve
dns-over-tlsDNS_OVER_TLS(+) -missing variable means global defaultWhether or not DNSOverTls is enabled for the connection - -Allowed values: yes,no,opportunistic
mptcp-flagsMPTCP_FLAGS(+) -missing variable means global defaultThe MPTCP flags that indicate whether MPTCP is enabled and which flags to use for the address endpoints. - -Example: MPTCP_FLAGS="signal,subflow"
wait-device-timeoutDEVTIMEOUT(+) - for initscripts compatibility, this variable must be a whole integer. If necessary, NetworkManager stores also a fractional component for the milliseconds. - -Example: DEVTIMEOUT=5 - -Allowed values: timeout in seconds.
mud-urlMUD_URL MUD_URL to be sent by device (See RFC 8520). - -Example: https://yourdevice.example.com/model.json - -Allowed values: a valid URL that points to recommended policy for this device
wait-activation-delayWAIT_ACTIVATION_DELAY(+) - Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - -Example: WAIT_ACTIVATION_DELAY=5000 - -Allowed values: delay in milliseconds.
-
-
-

Table 20. dcb setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
app-fcoe-flagsDCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLINGnoFCOE flags. - -Example: DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes
app-fcoe-priorityDCB_APP_FCOE_PRIORITY Priority of FCoE frames. - -Allowed values: 0 - 7
app-fcoe-modeDCB_APP_FCOE_MODEfabricFCoE controller mode. - -Allowed values: fabric, vn2vn
app-iscsi-flagsDCB_APP_ISCSI_ENABLE, DCB_APP_ISCSI_ADVERTISE, DCB_APP_ISCSI_WILLINGnoiSCSI flags.
app-iscsi-priorityDCB_APP_ISCSI_PRIORITY Priority of iSCSI frames. - -Allowed values: 0 - 7
app-fip-flagsDCB_APP_FIP_ENABLE, DCB_APP_FIP_ADVERTISE, DCB_APP_FIP_WILLINGnoFIP flags.
app-fip-priorityDCB_APP_FIP_PRIORITY Priority of FIP frames. - -Allowed values: 0 - 7
priority-flow-control-flagsDCB_PFC_ENABLE, DCB_PFC_ADVERTISE, DCB_PFC_WILLINGnoPriority flow control flags.
priority-flow-controlDCB_PFC_UP Priority flow control values. String of 8 "0" and "1", where "0". means "do not transmit priority pause", "1" means "transmit pause". - -Example: DCB_PFC_UP=01101110
priority-group-flagsDCB_PG_ENABLE, DCB_PG_ADVERTISE, DCB_PG_WILLINGnoPriority groups flags.
priority-group-idDCB_PG_ID Priority groups values. String of eight priorities (0 - 7) or "f" (unrestricted). - -Example: DCB_PG_ID=1205f173
priority-group-bandwidthDCB_PG_PCT Priority groups values. Eight bandwidths (in percent), separated with commas. - -Example: DCB_PG_PCT=10,5,10,15,10,10,10,30
priority-bandwidthDCB_PG_UPPCT Priority values. Eight bandwidths (in percent), separated with commas. The sum of the numbers must be 100. - -Example: DCB_PG_UPPCT=7,13,10,10,15,15,10,20
priority-strict-bandwidthDCB_PG_STRICT Priority values. String of eight "0" or "1", where "0" means "may not utilize all bandwidth", "1" means "may utilize all bandwidth". - -Example: DCB_PG_STRICT=01101110
priority-traffic-classDCB_PG_UP2TC Priority values. String of eight traffic class values (0 - 7). - -Example: DCB_PG_UP2TC=01623701
-
-

- All DCB related configuration is a NetworkManager extension. DCB=yes must be - used explicitly to enable DCB so that the rest of the DCB_* variables can apply. -

-
-

Table 21. ethtool setting

-
------ - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
-
-
-

Table 22. hostname setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
priorityHOSTNAME_PRIORITY(+) -missing variable means global value or 100hostname priority - -Example: HOSTNAME_PRIORITY=50
from-dhcpHOSTNAME_FROM_DHCP(+) -missing variable means global default or 1whether the system hostname can be determined from DHCP - -Example: HOSTNAME_FROM_DHCP=0,1
from-dns-lookupHOSTNAME_FROM_DNS_LOOKUP(+) -missing variable means global default or 1whether the system hostname can be determined from reverse DNS lookup - -Example: HOSTNAME_FROM_DNS_LOOKUP=0,1
only-best-deviceHOSTNAME_ONLY_FROM_DEFAULT(+) -missing variable means global default or 1whether the hostname can be determined only from devices with the default route - -Example: HOSTNAME_ONLY_FROM_DEFAULT=0,1
-
-
-

Table 23. hsr setting

-
------ - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
-
-
-

Table 24. infiniband setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
mac-addressHWADDR IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device. - -Example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11
mtuMTU MTU of the interface.
transport-modeCONNECTED_MODECONNECTED_MODE=noCONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" mode
p-keyPKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes)PKEY=noInfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV must be specified. Note that ifcfg-rh format will always automatically set the full membership flag 0x8000 for the PKEY_ID variable. To express IDs without the full membership flag, use PKEY_ID_NM. Note that kernel internally treats the interface as having the full membership flag set, this mainly affects the interface name. For the ifcfg file to be supported by initscripts' ifup-ib, the DEVICE= must always be set. NetworkManager does not require that. - -Example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002
parentPHYSDEV (PKEY=yes)PKEY=noInfiniBand parent device. - -Example: PHYSDEV=ib0
-
-
-

Table 25. ipv4 setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
methodBOOTPROTOnoneMethod used for IPv4 protocol configuration. - -Allowed values: none, dhcp (bootp), static, ibft, autoip, shared
dnsDNS1, DNS2, ... List of DNS servers. Even if NetworkManager supports many DNS servers, initscripts and resolver only care about the first three, usually. - -Example: DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8
dns-searchDOMAIN List of DNS search domains.
addressesIPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), ... List of static IP addresses. - -Example: IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16
gatewayGATEWAY Gateway IP address. - -Example: GATEWAY=10.5.5.1
routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ... List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.
ignore-auto-routesPEERROUTES(+) -yesPEERROUTES has the opposite meaning as 'ignore-auto-routes' property.
ignore-auto-dnsPEERDNSyesPEERDNS has the opposite meaning as 'ignore-auto-dns' property.
dhcp-send-hostnameDHCP_SEND_HOSTNAME(+) -yesWhether DHCP_HOSTNAME should be sent to the DHCP server.
dhcp-hostnameDHCP_HOSTNAME Hostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.
never-defaultDEFROUTE (GATEWAYDEV in /etc/sysconfig/network)yesDEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.
may-failIPV4_FAILURE_FATAL(+) -noIPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.
route-metricIPV4_ROUTE_METRIC(+) --1IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.
route-tableIPV4_ROUTE_TABLE(+) -0IPV4_ROUTE_TABLE enables policy-routing and sets the default routing table.
dns-optionsRES_OPTIONS(+) - List of DNS options to be added to /etc/resolv.conf - -Example: RES_OPTIONS=ndots:2 timeout:3
dns-priorityIPV4_DNS_PRIORITY(+) -0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. - -Example: IPV4_DNS_PRIORITY=20
auto-route-ext-gwIPV4_AUTO_ROUTE_EXT_GW(+) -yesVPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
replace-local-ruleIPV4_REPLACE_LOCAL_RULE(+) -noConnections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
dhcp-client-idDHCP_CLIENT_ID(+) - A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc'). - -Example: DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44
dad-timeoutACD_TIMEOUT(+), ARPING_WAITmissing variable means global default (config override or zero)Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses. 0 turns off the ACD completely, -1 means default value. - -Example: ACD_TIMEOUT=2000 or ARPING_WAIT=2
dhcp-timeoutIPV4_DHCP_TIMEOUT(+) - A timeout after which the DHCP transaction fails in case of no response. - -Example: IPV4_DHCP_TIMEOUT=10
dhcp-hostname-flagsDHCP_HOSTNAME_FLAGS flags for the DHCP hostname and FQDN properties - -Example: DHCP_HOSTNAME_FLAGS=5
dhcp-fqdnDHCP_FQDN FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used. - -Example: DHCP_FQDN=foo.bar.com
dhcp-vendor-class-identifierDHCP_VENDOR_CLASS_IDENTIFIER(+) - The Vendor Class Identifier DHCP option (60). - -Example: DHCP_VENDOR_CLASS_IDENTIFIER=foo
link-localIPV4_LINK_LOCAL(+) - Configure link-local IP address in interaction with method - -Example: IPV4_LINK_LOCAL=auto
-
-
-

Table 26. ipv6 setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
methodIPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6C, IPV6_DISABLEDIPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=noMethod used for IPv6 protocol configuration. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes; disabled ~ IPV6_DISABLED=yes
dnsDNS1, DNS2, ... List of DNS servers. NetworkManager uses the variables both for IPv4 and IPv6.
dns-searchIPV6_DOMAIN(+) - List of DNS search domains.
addressesIPV6ADDR, IPV6ADDR_SECONDARIES List of static IP addresses. - -Example: IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"
gatewayIPV6_DEFAULTGW Gateway IP address. - -Example: IPV6_DEFAULTGW=abbe::1
routes(none) List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.
ignore-auto-routesIPV6_PEERROUTES(+) -yesIPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.
ignore-auto-dnsIPV6_PEERDNS(+) -yesIPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.
dhcp-hostnameDHCPV6_HOSTNAME Hostname to send the DHCP server.
dhcp-timeoutIPV6_DHCP_TIMEOUT(+) - A timeout after which the DHCP transaction fails in case of no response. - -Example: IPV6_DHCP_TIMEOUT=10
dhcp-hostname-flagsDHCPV6_HOSTNAME_FLAGS flags for the DHCP hostname property - -Example: DHCPV6_HOSTNAME_FLAGS=5
never-defaultIPV6_DEFROUTE(+), (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)IPV6_DEFROUTE=yes (when no variable specified)IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.
may-failIPV6_FAILURE_FATAL(+) -noIPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.
route-metricIPV6_ROUTE_METRIC(+) --1IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.
route-tableIPV6_ROUTE_TABLE(+) -0IPV6_ROUTE_TABLE enables policy-routing and sets the default routing table.
dns-priorityIPV6_DNS_PRIORITY(+) -0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. - -Example: IPV6_DNS_PRIORITY=20
dns-optionsIPV6_RES_OPTIONS(+) - List of DNS options to be added to /etc/resolv.conf - -Example: IPV6_RES_OPTIONS=ndots:2 timeout:3
auto-route-ext-gwIPV6_AUTO_ROUTE_EXT_GW(+) -yesVPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
replace-local-ruleIPV6_REPLACE_LOCAL_RULE(+) -noConnections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
ip6-privacyIPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP(+) -noConfigure IPv6 Privacy Extensions for SLAAC (RFC4941). - -Example: IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes - -Allowed values: IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no
addr-gen-modeIPV6_ADDR_GEN_MODE"default-or-eui64"Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217). - -Example: IPV6_ADDR_GEN_MODE=stable-privacy - -Allowed values: IPV6_ADDR_GEN_MODE: default, default-or-eui64, eui64, stable-privacy
tokenIPV6_TOKEN The IPv6 tokenized interface identifier token - -Example: IPV6_TOKEN=::53
ra-timeoutIPV6_RA_TIMEOUT(+) - A timeout for waiting Router Advertisements in seconds. - -Example: IPV6_RA_TIMEOUT=10
dhcp-duidDHCPV6_DUID(+) - A string sent to the DHCPv6 server to identify the local machine. Apart from the special values "lease", "stable-llt", "stable-ll", "stable-uuid", "llt" and "ll" a binary value in hex format is expected. An hex string where each octet is separated by a colon is also accepted. - -Example: DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01
dhcp-pd-hintDHCPV6_PD_HINT(+) - Hint for DHCPv6 prefix delegation - -Example: DHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60
-
-
-

Table 27. match setting

-
------ - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
pathMATCH_PATH space-separated list of paths to match against the udev property ID_PATHS of devices - -Example: MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"
-
-
-

Table 28. ovs-external-ids setting

-
------ - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
-
-
-

Table 29. ovs-other-config setting

-
------ - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
-
-
-

Table 30. proxy setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
methodPROXY_METHOD(+) -noneMethod for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT. - -Allowed values: none, auto
browser-onlyBROWSER_ONLY(+) -noWhether the proxy configuration is for browser only.
pac-urlPAC_URL(+) - URL for PAC file. - -Example: PAC_URL=http://wpad.mycompany.com/wpad.dat
pac-scriptPAC_SCRIPT(+) - The PAC script. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function. - -Example: PAC_SCRIPT="function FindProxyForURL (url, host) { return 'PROXY proxy.example.com:8080; DIRECT'; }"
-
-
-

Table 31. sriov setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
total-vfsSRIOV_TOTAL_VFS(+) - The total number of virtual functions to create - -Example: SRIOV_TOTAL_VFS=16
vfsSRIOV_VF1(+), SRIOV_VF2(+), ... SR-IOV virtual function descriptors - -Example: SRIOV_VF10="mac=00:11:22:33:44:55", ...
autoprobe-driversSRIOV_AUTOPROBE_DRIVERS(+) -missing variable means global defaultWhether to autoprobe virtual functions by a compatible driver - -Example: SRIOV_AUTOPROBE_DRIVERS=0,1
-
-
-

Table 32. tc setting

-
------ - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
qdiscsQDISC1(+), QDISC2(+), ..., TC_COMMIT(+) - Queueing disciplines to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'. - -Example: QDISC1=ingress, QDISC2="root handle 1234: fq_codel"
tfiltersFILTER1(+), FILTER2(+), ..., TC_COMMIT(+) - Traffic filters to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'. - -Example: FILTER1="parent ffff: matchall action simple sdata Input", ...
-
-
-

Table 33. team setting

-
------ - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
configTEAM_CONFIG Team configuration in JSON. See man teamd.conf for details.
-
-
-

Table 34. team-port setting

-
------ - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
configTEAM_PORT_CONFIG Team port configuration in JSON. See man teamd.conf for details.
-
-
-

Table 35. user setting

-
------ - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
dataNM_USER_* each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore. A dot is encoded as a double underscore. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character. - -Example: NM_USER_FOO__BAR=something
-
-
-

Table 36. vlan setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyIfcfg-rh VariableDefaultDescription
parentDEVICE or PHYSDEV Parent interface of the VLAN.
idVLAN_ID, DEVICE. VLAN identifier. If VLAN_ID is not set, it is attempted to be detected from the suffix of DEVICE=. Note that older versions of NetworkManager had a bug where they would prefer the detected ID from the DEVICE over VLAN_ID.
flagsGVRP, MVRP, VLAN_FLAGS VLAN flags. - -Allowed values: "yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS
protocolVLAN_PROTOCOL VLAN protocol. - -Example: VLAN_PROTOCOL="802.1ad"
ingress-priority-mapVLAN_INGRESS_PRIORITY_MAP Ingress priority mapping. - -Example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5
egress-priority-mapVLAN_EGRESS_PRIORITY_MAP Egress priority mapping. - -Example: VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7
interface-namePHYSDEV and VLAN_ID, or DEVICE VLAN interface name. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID. - -Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
-
-

The following settings are not supported by ifcfg-rh plugin:

-

6lowpan, 802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, link, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan

-
-

Secret flags

-

- Each secret property in a NetworkManager setting has an associated - flags property that describes how to handle that secret. - In the ifcfg-rh plugin variables for secret flags have a - _FLAGS suffix. The variables contain one or more of the - following values (space separated). Missing (or empty) *_FLAGS variable means - that the password is owned by NetworkManager. -

-
    -

  • user - a user-session secret agent is responsible for providing - and storing this secret; when it is required, agents will be asked to provide it.

    • -

  • ask - the associated password is not saved but it will be - requested from the user each time it is required.

    • -

  • unused - in some situations it cannot be automatically determined - that a secret is required or not. This flag hints that the secret is not required and should - not be requested from the user.

    • -
-
-
-
-

Files

-

/etc/sysconfig/network-scripts/ifcfg-*

-

/etc/sysconfig/network-scripts/keys-*

-

/etc/sysconfig/network-scripts/route-*

-

/etc/sysconfig/network-scripts/route6-*

-

/usr/share/doc/initscripts/sysconfig.txt

-
-
-

See Also

-

nm-settings-nmcli(5), - nm-settings-keyfile(5), - NetworkManager(8), - NetworkManager.conf(5), - nmcli(1), - nmcli-examples(7)

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-settings-keyfile.html b/docs/api/html/nm-settings-keyfile.html deleted file mode 100644 index 7b751164..00000000 --- a/docs/api/html/nm-settings-keyfile.html +++ /dev/null @@ -1,629 +0,0 @@ - - - - -nm-settings-keyfile: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-settings-keyfile

-

nm-settings-keyfile — Description of keyfile settings plugin

-
-
-

Description

-

- NetworkManager is based on the concept of connection profiles that contain - network configuration (see nm-settings-nmcli(5) for details). The profiles can be - stored in various formats. NetworkManager uses plugins for reading and writing - the data. The plugins can be configured in NetworkManager.conf(5). -

-

- The keyfile plugin is the generic plugin that supports all - the connection types and capabilities that NetworkManager has. The files are - in a .ini-style format and located in /etc/NetworkManager/system-connections/, - /usr/lib/NetworkManager/system-connections/ and - /run/NetworkManager/system-connections/. - This plugin is always enabled and will automatically be used to store - any connections that are not supported by any other active plugin. - For security, it will ignore files that are readable or writable by any user - other than 'root' since private keys and passphrases may be stored - in plaintext inside the file. -

-
-
-

File Format

-

- The keyfile config format is a simple .ini-style - format. It consists of sections (groups) of key-value pairs. - More information of the generic key file format can be found at - - GLib key file format (Lines beginning with a '#' are comments, - lists are separated by character ; etc.). -

-

- Each section corresponds to a setting name as described in the settings - specification (nm-settings-nmcli(5)). Each key/value pair in a - section is one of the properties from the specification. -

-

- The majority of properties are written in the same format as the - specification into the keyfile. However, some - values are inconvenient for people to use so they are stored in the - keyfile in more readable ways. These properties - that differ from the specification are described below. - An example could be IP addresses that are not written as integer arrays, - but more reasonably as "1.2.3.4/12 1.2.3.254". - Also, some lists of complex values (addresses, routes, routing-rules), - instead of using a semicolon separated list, use one key-value pair - per list element, with the key being the singular of the property name - followed by the numeric index (i.e address1, address2, ...). -

-

- Users can create or modify the keyfile connection files - manually, even if that is not the recommended way of managing the profiles. - However, if they choose to do that, they must inform NetworkManager about - their changes (for example via nmcli con (re)load). -

-

Examples of keyfile configuration. 

-
A sample configuration for an ethernet network:
-[connection]
-id=Main eth0
-uuid=27afa607-ee36-43f0-b8c3-9d245cdc4bb3
-type=802-3-ethernet
-autoconnect=true
-
-[ipv4]
-method=auto
-
-[802-3-ethernet]
-mac-address=00:23:5a:47:1f:71
-
-
A sample configuration for WPA-EAP (PEAP with MSCHAPv2) and always-ask secret:
-[connection]
-id=CompanyWIFI
-uuid=cdac6154-a33b-4b15-9904-666772cfa5ee
-type=wifi
-autoconnect=false
-
-[wifi]
-ssid=CorpWLAN
-mode=infrastructure
-security=802-11-wireless-security
-
-[wifi-security]
-key-mgmt=wpa-eap
-
-[ipv4]
-method=auto
-
-[ipv6]
-method=auto
-
-[802-1x]
-eap=peap;
-identity=joe
-ca-cert=/home/joe/.cert/corp.crt
-phase1-peapver=1
-phase2-auth=mschapv2
-password-flags=2
-
-
A sample configuration for openvpn:
-[connection]
-id=RedHat-openvpn
-uuid=7f9b3356-b210-4c0e-8123-bd116c9c280f
-type=vpn
-timestamp=1385401165
-
-[vpn]
-service-type=org.freedesktop.NetworkManager.openvpn
-connection-type=password
-password-flags=3
-remote=ovpn.my-company.com
-cipher=AES-256-CBC
-reneg-seconds=0
-port=443
-username=joe
-ca=/etc/openvpn/ISCA.pem
-tls-remote=ovpn.my-company.com
-
-[ipv6]
-method=auto
-
-[ipv4]
-method=auto
-ignore-auto-dns=true
-never-default=true
-
-
A sample configuration for a bridge and a bridge port:
-[connection]                                 [connection]
-id=MainBridge                                id=br-port-1
-uuid=171ae855-a0ab-42b6-bd0c-60f5812eea9d    uuid=d6e8ae98-71f8-4b3d-9d2d-2e26048fe794
-interface-name=MainBridge                    interface-name=em1
-type=bridge                                  type=ethernet
-                                             controller=MainBridge
-[bridge]                                     port-type=bridge
-interface-name=MainBridge
-
-
A sample configuration for a VLAN:
-[connection]
-id=VLAN for building 4A
-uuid=8ce1c9e0-ce7a-4d2c-aa28-077dda09dd7e
-interface-name=VLAN-4A
-type=vlan
-
-[vlan]
-interface-name=VLAN-4A
-parent=eth0
-id=4
-
-
-
-

Details

-

keyfile plugin variables for the majority of NetworkManager - properties have one-to-one mapping. It means a NetworkManager property is stored - in the keyfile as a variable of the same name and in the same format. - There are several exceptions to this rule, mainly for making keyfile syntax easier - for humans. The exceptions handled specially by keyfile - plugin are listed below. Refer to - nm-settings-nmcli(5) - for all available settings and properties and their description. -

-

Name aliases.  - Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore - keyfile introduces aliases that can be used instead of the names. -

- - - - - -
setting name keyfile alias
802-3-ethernet = ethernet
802-11-wireless = wifi
802-11-wireless-security = wifi-security
-
-

Table 1. 802-11-wireless setting (section)

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
ssid string (or decimal-byte list - obsolete)SSID of Wi-Fi network. - -Example: ssid=Quick Net
mac-address usual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).
cloned-mac-address usual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).
mac-address-blacklist list of MACs (separated with semicolons)MAC address blacklist. - -Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
mac-address-denylist list of MACs (separated with semicolons)MAC address denylist. - -Example: mac-address-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78
-
-
-

Table 2. 802-3-ethernet setting (section)

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
mac-address usual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)
cloned-mac-address usual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).
mac-address-blacklist list of MACs (separated with semicolons)MAC address blacklist. - -Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
mac-address-denylist list of MACs (separated with semicolons)MAC address denylist. - -Example: mac-address-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78
-
-
-

Table 3. bridge setting (section)

-
------ - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
mac-address usual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) - -Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;
-
-
-

Table 4. infiniband setting (section)

-
------ - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
mac-address usual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) - -Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
-
-
-

Table 5. ipv4 setting (section)

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
dns list of DNS IP addressesList of DNS servers. - -Example: dns=1.2.3.4;8.8.8.8;8.8.4.4;
addressesaddress1, address2, ...address/plenList of static IP addresses. - -Example: address1=192.168.100.100/24 address2=10.1.1.5/24
gatewaygatewaystringGateway IP addresses as a string. - -Example: gateway=192.168.100.1
routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. - -Example: route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16
routes (attributes)route1_options, route2_options, ...key=val[,key=val...]Attributes defined for the routes, if any. The supported attributes are explained in ipv4.routes entry in `man nm-settings-nmcli`. - -Example: route1_options=mtu=1000,onlink=true
routing-rulesrouting-rule1, routing-rule2, ...routing rule stringRouting rules as defined with `ip rule add`, but with mandatory fixed priority. - -Example: routing-rule1=priority 5 from 192.167.4.0/24 table 45
-
-
-

Table 6. ipv6 setting (section)

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
dns list of DNS IP addressesList of DNS servers. - -Example: dns=2001:4860:4860::8888;2001:4860:4860::8844;
addressesaddress1, address2, ...address/plenList of static IP addresses. - -Example: address1=abbe::cafe/96 address2=2001::1234
gatewaygatewaystringGateway IP addresses as a string. - -Example: gateway=abbe::1
routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. - -Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
routes (attributes)route1_options, route2_options, ...key=val[,key=val...]Attributes defined for the routes, if any. The supported attributes are explained in ipv6.routes entry in `man nm-settings-nmcli`. - -Example: route1_options=mtu=1000,onlink=true
routing-rulesrouting-rule1, routing-rule2, ...routing rule stringRouting rules as defined with `ip rule add`, but with mandatory fixed priority. - -Example: routing-rule1=priority 5 from 2001:4860:4860::/64 table 45
-
-
-

Table 7. serial setting (section)

-
------ - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
parity 'e', 'o', or 'n'The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none. - -Example: parity=n
-
-
-

Table 8. vpn setting (section)

-
------ - - - - - - - - - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
dataseparate variables named after keys of the dictionary The keys of the data dictionary are used as variable names directly under [vpn] section. - -Example: remote=ovpn.corp.com cipher=AES-256-CBC username=joe
secretsseparate variables named after keys of the dictionary The keys of the secrets dictionary are used as variable names directly under [vpn-secrets] section. - -Example: password=Popocatepetl
-
-
-

Table 9. wifi-p2p setting (section)

-
------ - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
peer usual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).
-
-
-

Table 10. wpan setting (section)

-
------ - - - - - - - - - - - - -
PropertyKeyfile VariableFormatDescription
mac-address usual hex-digits-and-colons notationMAC address in hex-digits-and-colons notation (e.g. 76:d8:9b:87:66:60:84:ee).
-
-
-

Secret flags

-

- Each secret property in a NetworkManager setting has an associated flags - property that describes how to handle that secret. In the keyfile plugin, - the value of -flags variable is a decimal number (0 - 7) defined as a sum - of the following values: -

-
    -

  • 0 - (NM owned) - the system is responsible for providing and storing this secret.

    • -

  • 1 - (agent-owned) - a user-session secret agent is responsible for providing - and storing this secret; when it is required, agents will be asked to provide it.

    • -

  • 2 - (not-saved) - this secret should not be saved but should be requested - from the user each time it is required.

    • -

  • 4 - (not-required) - in some situations it cannot be automatically determined - that a secret is required or not. This flag hints that the secret is not required - and should not be requested from the user.

    • -
-
-
-
-

Files

-

/etc/NetworkManager/system-connections/*

-
-
-

See Also

-

nm-settings-nmcli(5), - nm-settings-ifcfg-rh(5), - NetworkManager(8), - NetworkManager.conf(5), - nmcli(1), - nmcli-examples(7)

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html deleted file mode 100644 index 4e447a36..00000000 --- a/docs/api/html/nm-settings-nmcli.html +++ /dev/null @@ -1,7123 +0,0 @@ - - - - -nm-settings-nmcli: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nm-settings-nmcli

-

nm-settings-nmcli — Description of settings and properties of NetworkManager connection profiles for nmcli

-
-
-

Description

-

- NetworkManager is based on a concept of connection profiles, sometimes referred to as - connections only. These connection profiles contain a network configuration. When - NetworkManager activates a connection profile on a network device the configuration will - be applied and an active network connection will be established. Users are free to create - as many connection profiles as they see fit. Thus they are flexible in having various network - configurations for different networking needs. -

-

- NetworkManager provides an API for configuring connection profiles, for activating them - to configure the network, and inspecting the current network configuration. The command - line tool nmcli is a client application to NetworkManager that uses - this API. See nmcli(1) - for details. -

-

- With commands like nmcli connection add, nmcli connection modify - and nmcli connection show, connection profiles can be created, modified - and inspected. A profile consists of properties. On D-Bus this follows the format - as described by nm-settings-dbus(5), - while this manual page describes the settings format how they are expected by nmcli. -

-

- The settings and properties shown in tables below list all available connection - configuration options. However, note that not all settings are applicable to all - connection types. nmcli connection editor has also a built-in - describe command that can display description of particular settings - and properties of this page. -

-

- The setting and - property can be abbreviated provided they are unique. The list below - also shows aliases that can be used unqualified instead of the full name. For example - connection.interface-name and ifname refer to the same - property. -

-
-

connection setting

-

General Connection Profile Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

connection.auth-retries

 -

The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.

-

Currently, this only applies to 802-1x authentication.

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

connection.autoconnect

 -

- Alias: autoconnect

-

Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.

-

Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.

-

Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.

-

If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.

-

Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

connection.autoconnect-ports

 -

Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.

-

- Format: choice (NMTernary)

-

- Valid values: default (-1), false (0), true (1)

-

connection.autoconnect-priority

 -

The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.

-

- Format: integer

-

- Valid values: -999 - 999

-

connection.autoconnect-retries

 -

The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

- Special values: default (-1), forever (0)

-

connection.autoconnect-slaves

 -

Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.

-

Deprecated 1.46. Use "autoconnect-ports" instead, this is just an alias.

-

- Format: choice (NMSettingConnectionAutoconnectSlaves)

-

- Valid values: default (-1), no (0), yes (1)

-

connection.controller

 -

- Alias: controller

-

Interface name of the controller device or UUID of the controller connection.

-

- Format: string

-

connection.dns-over-tls

 -

Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.

-

The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.

-

This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

-

- Format: choice (NMSettingConnectionDnsOverTls)

-

- Valid values: default (-1), no (0), opportunistic (1), yes (2)

-

connection.down-on-poweroff

 -

Whether the connection will be brought down before the system is powered off. The default value is "default" (-1). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as "no" (0).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

connection.gateway-ping-timeout

 -

If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.

-

- Format: integer

-

- Valid values: 0 - 600

-

connection.id

 -

- Alias: con-name

-

A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

-

- Format: string

-

connection.interface-name

 -

- Alias: ifname

-

The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).

-

For software devices this specifies the name of the created device.

-

For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.

-

- Format: string

-

connection.lldp

 -

Whether LLDP is enabled for the connection.

-

- Format: choice (NMSettingConnectionLldp)

-

- Valid values: default (-1), disable (0), enable-rx/enable (1)

-

connection.llmnr

 -

Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.

-

The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").

-

This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

-

- Format: choice (NMSettingConnectionLlmnr)

-

- Valid values: default (-1), no (0), resolve (1), yes (2)

-

connection.master

 -

- Alias: master

-

Interface name of the controller device or UUID of the controller connection.

-

Deprecated 1.46. Use "controller" instead, this is just an alias.

-

- Format: string

-

connection.mdns

 -

Whether mDNS is enabled for the connection.

-

The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin.

-

This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. Currently the only supported DNS plugin is systemd-resolved. For systemd-resolved, the default is configurable via MulticastDNS= setting in resolved.conf.

-

- Format: choice (NMSettingConnectionMdns)

-

- Valid values: default (-1), no (0), resolve (1), yes (2)

-

connection.metered

 -

Whether the connection is metered.

-

When updating this property on a currently activated connection, the change takes effect immediately.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

connection.mptcp-flags

 -

Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.

-

If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.

-

The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.

-

Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.

-

Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.

-

When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.

-

If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.

-

NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.

-

Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).

-

- Format: flags (NMMptcpFlags)

-

- Valid values: none/default (0x0), disabled (0x1), enabled (0x2), also-without-sysctl (0x4), also-without-default-route (0x8), signal (0x10), subflow (0x20), backup (0x40), fullmesh (0x80)

-

connection.mud-url

 -

If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".

-

The special value "none" is allowed to indicate that no MUD URL is used.

-

If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".

-

- Format: string

-

connection.multi-connect

 -

Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.

-

- Format: choice (NMConnectionMultiConnect)

-

- Valid values: default (0), single (1), manual-multiple (2), multiple (3)

-

connection.permissions

 -

An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".

-

At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.

-

- Format: list of strings

-

connection.port-type

 -

- Alias: port-type

-

Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.

-

- Format: string

-

- Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf

-

connection.secondaries

 -

List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.

-

- Format: list of strings

-

connection.slave-type

 -

- Alias: slave-type

-

Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.

-

Deprecated 1.46. Use "port-type" instead, this is just an alias.

-

- Format: string

-

- Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf

-

connection.stable-id

 -

This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.

-

The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable.

-

Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.

-

The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.

-

If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.

-

- Format: string

-

connection.timestamp

 -

The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.

-

NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).

-

- Format: read only

-

connection.type

 -

- Alias: type

-

Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).

-

- Format: string

-

- Valid values: 6lowpan, 802-11-olpc-mesh, 802-11-wireless, 802-3-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip-tunnel, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, pppoe, team, tun, veth, vlan, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan

-

connection.uuid

 -

The connection.uuid is the real identifier of a profile. It cannot change and it must be unique. It is therefore often best to refer to a profile by UUID, for example with `nmcli connection up uuid $UUID`.

-

The UUID cannot be changed, except in offline mode. In that case, the special values "new", "generate" and "" are allowed to generate a new random UUID.

-

- Format: a valid RFC4122 universally unique identifier (UUID).

-

connection.wait-activation-delay

 -

Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.

-

The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

connection.wait-device-timeout

 -

Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.

-

The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

connection.zone

 -

The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.

-

When updating this property on a currently activated connection, the change takes effect immediately.

-

- Format: string

-
-
-
-
-

6lowpan setting

-

6LoWPAN Settings.

-

- Properties: -

-
---- - - - - -

6lowpan.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.

-

- Format: string

-
-
-
-
-

802-1x setting

-

IEEE 802.1x Authentication Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

802-1x.altsubject-matches

 -

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.

-

- Format: list of strings

-

802-1x.anonymous-identity

 -

Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.

-

- Format: string

-

802-1x.auth-timeout

 -

A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

802-1x.ca-cert

 -

Contains the path to the CA certificate if used by the EAP method specified in the 802-1x.eap property.

-

This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

-

Note that enabling 802-1x.system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

-

- Format: filesystem path

-

802-1x.ca-cert-password

 -

The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

-

- Format: string

-

802-1x.ca-cert-password-flags

 -

Flags indicating how to handle the "ca-cert-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.ca-path

 -

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.

-

If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

-

- Format: string

-

802-1x.client-cert

 -

Contains the path to the client certificate if used by the EAP method specified in the 802-1x.eap property.

-

- Format: filesystem path

-

802-1x.client-cert-password

 -

The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

-

- Format: string

-

802-1x.client-cert-password-flags

 -

Flags indicating how to handle the "client-cert-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.domain-match

 -

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

-

- Format: string

-

802-1x.domain-suffix-match

 -

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

-

- Format: string

-

802-1x.eap

 -

The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.

-

- Format: list of strings

-

- Valid values: leap, md5, tls, peap, ttls, sim, fast, pwd

-

802-1x.identity

 -

Identity string for EAP authentication methods. Often the user's user or login name.

-

- Format: string

-

802-1x.openssl-ciphers

 -

Define openssl_ciphers for wpa_supplicant. Openssl sometimes moves ciphers among SECLEVELs, thus compiled-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols.

-

- Format: string

-

802-1x.optional

 -

Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

802-1x.pac-file

 -

UTF-8 encoded file path containing PAC for EAP-FAST.

-

- Format: string

-

802-1x.password

 -

UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

-

- Format: string

-

802-1x.password-flags

 -

Flags indicating how to handle the "password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.password-raw

 -

Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.

-

- Format: bytes

-

802-1x.password-raw-flags

 -

Flags indicating how to handle the "password-raw" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.phase1-auth-flags

 -

Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.

-

- Format: flags (NMSetting8021xAuthFlags)

-

- Valid values: none (0x0), tls-1-0-disable (0x1), tls-1-1-disable (0x2), tls-1-2-disable (0x4), tls-disable-time-checks (0x8), tls-1-3-disable (0x10), tls-1-0-enable (0x20), tls-1-1-enable (0x40), tls-1-2-enable (0x80), tls-1-3-enable (0x100), all (0x1ff)

-

802-1x.phase1-fast-provisioning

 -

Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.

-

- Format: string

-

- Valid values: 0, 1, 2, 3

-

802-1x.phase1-peaplabel

 -

Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.

-

- Format: string

-

- Valid values: 0, 1

-

802-1x.phase1-peapver

 -

Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.

-

- Format: string

-

- Valid values: 0, 1

-

802-1x.phase2-altsubject-matches

 -

List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.

-

- Format: list of strings

-

802-1x.phase2-auth

 -

Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.

-

- Format: string

-

- Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tls

-

802-1x.phase2-autheap

 -

Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.

-

- Format: string

-

- Valid values: md5, mschapv2, otp, gtc, tls

-

802-1x.phase2-ca-cert

 -

Contains the path to the "phase 2" CA certificate if used by the EAP method specified in the 802-1x.phase2-auth or 802-1x.phase2-autheap properties.

-

This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.

-

Note that enabling 802-1x.system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.

-

- Format: filesystem path

-

802-1x.phase2-ca-cert-password

 -

The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

-

- Format: string

-

802-1x.phase2-ca-cert-password-flags

 -

Flags indicating how to handle the "phase2-ca-cert-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.phase2-ca-path

 -

UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.

-

If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.

-

- Format: filesystem path

-

802-1x.phase2-client-cert

 -

Contains the path to the "phase 2" client certificate if used by the EAP method specified in the 802-1x.phase2-auth or 802-1x.phase2-autheap properties.

-

- Format: filesystem path

-

802-1x.phase2-client-cert-password

 -

The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.

-

- Format: string

-

802-1x.phase2-client-cert-password-flags

 -

Flags indicating how to handle the "phase2-client-cert-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.phase2-domain-match

 -

Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.

-

- Format: string

-

802-1x.phase2-domain-suffix-match

 -

Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.

-

- Format: string

-

802-1x.phase2-private-key

 -

The path to the "phase 2" inner private key when the 802-1x.phase2-auth or 802-1x.phase2-autheap property is set to "tls".

-

- Format: filesystem path

-

802-1x.phase2-private-key-password

 -

The password used to decrypt the "phase 2" private key specified in the 802-1x.phase2-private-key property. This is normally used by secret agents, not directly by users.

-

- Format: string

-

802-1x.phase2-private-key-password-flags

 -

Flags indicating how to handle the "phase2-private-key-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.phase2-subject-match

 -

Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.

-

- This property is deprecated since version 1.2. - Use "phase2-domain-suffix-match" instead.

-

- Format: string

-

802-1x.pin

 -

PIN used for EAP authentication methods.

-

- Format: string

-

802-1x.pin-flags

 -

Flags indicating how to handle the "pin" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.private-key

 -

The path to the private key when the 802-1.eap property is set to "tls".

-

- Format: filesystem path

-

802-1x.private-key-password

 -

The password used to decrypt the private key specified in the 802-1x.private-key property. This is normally used by secret agents, not directly by users.

-

- Format: string

-

802-1x.private-key-password-flags

 -

Flags indicating how to handle the "private-key-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-1x.subject-match

 -

Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.

-

- This property is deprecated since version 1.2. - Use "phase2-domain-suffix-match" instead.

-

- Format: string

-

802-1x.system-ca-certs

 -

When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

adsl setting

-

ADSL Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

adsl.encapsulation

 -

- Alias: encapsulation

-

Encapsulation of ADSL connection. Can be "vcmux" or "llc".

-

- Format: string

-

- Valid values: vcmux, llc

-

adsl.password

 -

- Alias: password

-

Password used to authenticate with the ADSL service.

-

- Format: string

-

adsl.password-flags

 -

Flags indicating how to handle the "password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

adsl.protocol

 -

- Alias: protocol

-

ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".

-

- Format: string

-

- Valid values: pppoa, pppoe, ipoatm

-

adsl.username

 -

- Alias: username

-

Username used to authenticate with the ADSL service.

-

- Format: string

-

adsl.vci

 -

VCI of ADSL connection

-

- Format: integer

-

- Valid values: 0 - 65536

-

adsl.vpi

 -

VPI of ADSL connection

-

- Format: integer

-

- Valid values: 0 - 65536

-
-
-
-
-

bluetooth setting

-

Bluetooth Settings.

-

- Properties: -

-
---- - - - - - - - - - - -

bluetooth.bdaddr

 -

- Alias: addr

-

The Bluetooth address of the device.

-

- Format: MAC address

-

bluetooth.type

 -

- Alias: bt-type

-

Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.

-

- Format: string

-

- Valid values: dun, panu, nap

-
-
-
-
-

bond setting

-

Bonding Settings.

-

- Properties: -

-
---- - - - - -

bond.options

 -

Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

-

- Format: list of key/value options

-
-
-
-
-

bridge setting

-

Bridging Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

bridge.ageing-time

 -

- Alias: ageing-time

-

The Ethernet MAC address aging time, in seconds.

-

- Format: integer

-

- Valid values: 0 - 1000000

-

bridge.forward-delay

 -

- Alias: forward-delay

-

The Spanning Tree Protocol (STP) forwarding delay, in seconds.

-

- Format: integer

-

- Valid values: 0 - 30

-

bridge.group-address

 -

If specified, The MAC address of the multicast group this bridge uses for STP.

-

The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.

-

- Format: MAC address

-

bridge.group-forward-mask

 -

- Alias: group-forward-mask

-

A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.

-

- Format: integer

-

- Valid values: 0 - 65535

-

bridge.hello-time

 -

- Alias: hello-time

-

The Spanning Tree Protocol (STP) hello time, in seconds.

-

- Format: integer

-

- Valid values: 0 - 10

-

bridge.mac-address

 -

- Alias: mac

-

If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.

-

If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.

-

- This property is deprecated since version 1.12. - Use the "cloned-mac-address" property instead.

-

- Format: MAC address

-

bridge.max-age

 -

- Alias: max-age

-

The Spanning Tree Protocol (STP) maximum message age, in seconds.

-

- Format: integer

-

- Valid values: 0 - 40

-

bridge.multicast-hash-max

 -

Set maximum size of multicast hash table (value must be a power of 2).

-

- Format: integer

-

- Valid values: 1 - 4294967295

-

bridge.multicast-last-member-count

 -

Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

bridge.multicast-last-member-interval

 -

Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.multicast-membership-interval

 -

Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.multicast-querier

 -

Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.multicast-querier-interval

 -

If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.multicast-query-interval

 -

Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.multicast-query-response-interval

 -

Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.multicast-query-use-ifaddr

 -

If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.multicast-router

 -

Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.

-

Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).

-

- Format: string

-

- Valid values: auto, disabled, enabled

-

bridge.multicast-snooping

 -

- Alias: multicast-snooping

-

Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.multicast-startup-query-count

 -

Set the number of IGMP queries to send during startup phase.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

bridge.multicast-startup-query-interval

 -

Sets the time (in deciseconds) between queries sent out at startup to determine membership information.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

bridge.priority

 -

- Alias: priority

-

Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.

-

- Format: integer

-

- Valid values: 0 - 65535

-

bridge.stp

 -

- Alias: stp

-

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.vlan-default-pvid

 -

The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.

-

- Format: integer

-

- Valid values: 0 - 4094

-

bridge.vlan-filtering

 -

Control whether VLAN filtering is enabled on the bridge.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.vlan-protocol

 -

If specified, the protocol used for VLAN filtering.

-

Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

-

- Format: string

-

- Valid values: 802.1Q, 802.1ad

-

bridge.vlan-stats-enabled

 -

Controls whether per-VLAN stats accounting is enabled.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge.vlans

 -

Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.

-

In nmcli the VLAN list can be specified with the following syntax:

-

$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...

-

where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

-

- Format: list of bridge.vlans objects

-
-
-
-
-

bridge-port setting

-

Bridge Port Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

bridge-port.hairpin-mode

 -

- Alias: hairpin

-

Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

bridge-port.path-cost

 -

- Alias: path-cost

-

The Spanning Tree Protocol (STP) port cost for destinations via this port.

-

- Format: integer

-

- Valid values: 0 - 65535

-

bridge-port.priority

 -

- Alias: priority

-

The Spanning Tree Protocol (STP) priority of this bridge port.

-

- Format: integer

-

- Valid values: 0 - 63

-

bridge-port.vlans

 -

Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.

-

In nmcli the VLAN list can be specified with the following syntax:

-

$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...

-

where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

-

- Format: list of bridge-port.vlans objects

-
-
-
-
-

cdma setting

-

CDMA-based Mobile Broadband Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

cdma.mtu

 -

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

-

- Format: integer

-

- Special values: auto

-

cdma.number

 -

The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.

-

- Format: string

-

cdma.password

 -

- Alias: password

-

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

-

- Format: string

-

cdma.password-flags

 -

Flags indicating how to handle the "password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

cdma.username

 -

- Alias: user

-

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

-

- Format: string

-
-
-
-
-

dcb setting

-

Data Center Bridging Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

dcb.app-fcoe-flags

 -

Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).

-

- Format: flags (NMSettingDcbFlags)

-

- Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)

-

dcb.app-fcoe-mode

 -

The FCoE controller mode; either "fabric" or "vn2vn".

-

Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".

-

- Format: string

-

- Valid values: fabric, vn2vn

-

dcb.app-fcoe-priority

 -

The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the "enable" (0x1) flag.

-

- Format: integer

-

- Valid values: -1 - 7

-

- Special values: unset (-1)

-

dcb.app-fip-flags

 -

Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).

-

- Format: flags (NMSettingDcbFlags)

-

- Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)

-

dcb.app-fip-priority

 -

The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the "enable" (0x1) flag.

-

- Format: integer

-

- Valid values: -1 - 7

-

- Special values: unset (-1)

-

dcb.app-iscsi-flags

 -

Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).

-

- Format: flags (NMSettingDcbFlags)

-

- Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)

-

dcb.app-iscsi-priority

 -

The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the "enable" (0x1) flag.

-

- Format: integer

-

- Valid values: -1 - 7

-

- Special values: unset (-1)

-

dcb.priority-bandwidth

 -

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.

-

- Format: list of integers

-

- Valid values: 0 - 100

-

dcb.priority-flow-control

 -

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.

-

- Format: list of booleans

-

- Valid values: true/yes/on, false/no/off

-

dcb.priority-flow-control-flags

 -

Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).

-

- Format: flags (NMSettingDcbFlags)

-

- Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)

-

dcb.priority-group-bandwidth

 -

An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.

-

- Format: list of integers

-

- Valid values: 0 - 100

-

dcb.priority-group-flags

 -

Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).

-

- Format: flags (NMSettingDcbFlags)

-

- Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)

-

dcb.priority-group-id

 -

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.

-

- Format: list of integers

-

- Valid values: 0 - 7, 15

-

dcb.priority-strict-bandwidth

 -

An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.

-

- Format: list of booleans

-

- Valid values: true/yes/on, false/no/off

-

dcb.priority-traffic-class

 -

An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.

-

- Format: list of integers

-

- Valid values: 0 - 7

-
-
-
-
-

ethtool setting

-

Ethtool Ethernet Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ethtool.channels-combined

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.channels-other

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.channels-rx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.channels-tx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-adaptive-rx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-adaptive-tx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-pkt-rate-high

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-pkt-rate-low

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-frames

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-frames-high

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-frames-irq

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-frames-low

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-usecs

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-usecs-high

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-usecs-irq

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-rx-usecs-low

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-sample-interval

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-stats-block-usecs

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-frames

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-frames-high

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-frames-irq

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-frames-low

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-usecs

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-usecs-high

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-usecs-irq

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.coalesce-tx-usecs-low

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.eee-enabled

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-esp-hw-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-esp-tx-csum-hw-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-fcoe-mtu

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-gro

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-gso

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-highdma

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-hw-tc-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-l2-fwd-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-loopback

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-lro

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-macsec-hw-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-ntuple

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-all

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-fcs

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-gro-hw

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-gro-list

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-udp-gro-forwarding

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-udp_tunnel-port-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-vlan-filter

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-vlan-stag-filter

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rx-vlan-stag-hw-parse

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rxhash

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-rxvlan

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-sg

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tls-hw-record

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tls-hw-rx-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tls-hw-tx-offload

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tso

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-checksum-fcoe-crc

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-checksum-ip-generic

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-checksum-ipv4

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-checksum-ipv6

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-checksum-sctp

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-esp-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-fcoe-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-gre-csum-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-gre-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-gso-list

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-gso-partial

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-gso-robust

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-ipxip4-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-ipxip6-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-nocache-copy

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-scatter-gather

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-scatter-gather-fraglist

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-sctp-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-tcp-ecn-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-tcp-mangleid-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-tcp-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-tcp6-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-tunnel-remcsum-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-udp-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-udp_tnl-csum-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-udp_tnl-segmentation

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-tx-vlan-stag-hw-insert

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.feature-txvlan

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.pause-autoneg

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.pause-rx

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.pause-tx

 -

- Format: ternary

-

- Valid values: on, off, ignore

-

ethtool.ring-rx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.ring-rx-jumbo

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.ring-rx-mini

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-

ethtool.ring-tx

 -

- Format: integer

-

- Valid values: 0 - 4294967295

-
-
-
-
-

generic setting

-

Generic Link Settings.

-

- Properties: -

-
---- - - - - -

generic.device-handler

 -

Name of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'.

-

See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler.

-

By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler.

-

- Format: string

-
-
-
-
-

gsm setting

-

GSM-based Mobile Broadband Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

gsm.apn

 -

- Alias: apn

-

The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.

-

If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.

-

- Format: string

-

gsm.auto-config

 -

When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

gsm.device-id

 -

The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.

-

- Format: string

-

gsm.home-only

 -

When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

gsm.initial-eps-bearer-apn

 -

For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.

-

- Format: string

-

gsm.initial-eps-bearer-configure

 -

For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

gsm.mtu

 -

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

-

- Format: integer

-

- Special values: auto

-

gsm.network-id

 -

The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.

-

- Format: string

-

gsm.number

 -

Legacy setting that used to help establishing PPP data sessions for GSM-based modems.

-

- This property is deprecated since version 1.16. - User-provided values for this setting are no longer used.

-

- Format: string

-

gsm.password

 -

- Alias: password

-

The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.

-

- Format: string

-

gsm.password-flags

 -

Flags indicating how to handle the "password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

gsm.pin

 -

If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.

-

- Format: string

-

gsm.pin-flags

 -

Flags indicating how to handle the "pin" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

gsm.sim-id

 -

The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.

-

- Format: string

-

gsm.sim-operator-id

 -

A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.

-

- Format: string

-

gsm.username

 -

- Alias: user

-

The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

-

- Format: string

-
-
-
-
-

hsr setting

-

HSR/PRP Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

hsr.multicast-spec

 -

- Alias: multicast-spec

-

The last byte of supervision address.

-

- Format: integer

-

- Valid values: 0 - 255

-

hsr.port1

 -

- Alias: port1

-

The port1 interface name of the HSR. This property is mandatory.

-

- Format: string

-

hsr.port2

 -

- Alias: port2

-

The port2 interface name of the HSR. This property is mandatory.

-

- Format: string

-

hsr.prp

 -

The protocol used by the interface, whether it is PRP or HSR.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

infiniband setting

-

Infiniband Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

infiniband.mac-address

 -

- Alias: mac

-

If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

-

- Format: Infiniband MAC address

-

infiniband.mtu

 -

- Alias: mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.

-

- Format: integer

-

- Special values: auto

-

infiniband.p-key

 -

- Alias: p-key

-

The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.

-

With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.

-

Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.

-

- Format: integer

-

- Valid values: -1 - 65535

-

- Special values: default (-1)

-

infiniband.parent

 -

- Alias: parent

-

The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".

-

- Format: string

-

infiniband.transport-mode

 -

- Alias: transport-mode

-

The IP-over-InfiniBand transport mode. Either "datagram" or "connected".

-

- Format: string

-

- Valid values: datagram, connected

-
-
-
-
-

ipv4 setting

-

IPv4 Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ipv4.addresses

 -

- Alias: ip4

-

A list of IPv4 addresses and their prefix length. Multiple addresses can be separated by comma. For example "192.168.1.5/24, 10.1.0.5/24". The addresses are listed in decreasing priority, meaning the first address will be the primary address.

-

- Format: a comma separated list of addresses

-

ipv4.auto-route-ext-gw

 -

VPN connections will default to add the route automatically unless this setting is set to FALSE.

-

For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv4.dad-timeout

 -

Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4.

-

A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.

-

- Format: integer

-

- Valid values: -1 - 30000

-

- Special values: default (-1), off (0)

-

ipv4.dhcp-client-id

 -

A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.

-

The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.

-

The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.

-

The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.

-

The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.

-

The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.

-

If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.

-

- Format: string

-

- Special values: mac, perm-mac, duid, ipv6-duid, stable, none

-

ipv4.dhcp-dscp

 -

Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".

-

The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.

-

- Format: string

-

- Valid values: CS0, CS4, CS6

-

ipv4.dhcp-fqdn

 -

If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.

-

- Format: string

-

ipv4.dhcp-hostname

 -

If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

-

- Format: string

-

ipv4.dhcp-hostname-flags

 -

Flags for the DHCP hostname and FQDN.

-

Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.

-

When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

-

- Format: flags (NMDhcpHostnameFlags)

-

- Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)

-

ipv4.dhcp-iaid

 -

A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".

-

For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.

-

For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.

-

The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.

-

- Format: string

-

ipv4.dhcp-reject-servers

 -

Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.

-

For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").

-

This property is currently not implemented for DHCPv6.

-

- Format: list of IPv4 addresses

-

ipv4.dhcp-send-hostname

 -

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv4.dhcp-send-release

 -

Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is "default" (-1). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv4.dhcp-timeout

 -

A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).

-

Set to 2147483647 (MAXINT32) for infinity.

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

- Special values: default (0), infinity (2147483647)

-

ipv4.dhcp-vendor-class-identifier

 -

The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.

-

- Format: string

-

ipv4.dns

 -

Array of IP addresses of DNS servers.

-

For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.

-

- Format: list of IPv4 addresses

-

ipv4.dns-options

 -

DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.

-

The currently supported options are "attempts", "debug", "edns0", "ndots", "no-aaaa", "no-check-names", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) manual.

-

Note that there is a distinction between an unset (default) list and an empty list. In nmcli, to unset the list set the value to "". To set an empty list, set it to " ". Currently, an unset list has the same meaning as an empty list. That might change in the future.

-

The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.

-

When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

-

The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.

-

- Format: a comma separated list of DNS options

-

ipv4.dns-priority

 -

DNS servers priority.

-

The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).

-

Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.

-

Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.

-

Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.

-

When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.

-

When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.

-

When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

ipv4.dns-search

 -

List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.

-

When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

-

When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).

-

- Format: list of strings

-

ipv4.gateway

 -

- Alias: gw4

-

The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

-

Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.

-

Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".

-

- Format: IPv4 address

-

ipv4.ignore-auto-dns

 -

When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv4.ignore-auto-routes

 -

When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv4.link-local

 -

Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.

-

When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".

-

- Format: choice (NMSettingIP4LinkLocal)

-

- Valid values: default (0), auto (1), disabled (2), enabled (3)

-

ipv4.may-fail

 -

If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv4.method

 -

- Sets the IPv4 connection method. You can set one of the following values: -

-

-

-
    -

  • "auto" - Enables automatic IPv4 address assignment from DHCP, PPP, or similar services.

    • -

  • "manual" - Enables the configuration of static IPv4 addresses on the interface. Note that you must set at least one IP address and subnet mask in the "ipv4.addresses" property.

    • -

  • "disabled" - Disables the IPv4 protocol in this connection profile.

    • -

  • "shared" - Provides network access to other computers. If you do not specify an IP address and subnet mask in "ipv4.addresses", NetworkManager assigns 10.42.x.1/24 to the interface. Additionally, NetworkManager starts a DHCP server and DNS forwarder. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection.

    • -

  • "link-local" - Enables link-local addresses according to RFC 3927. NetworkManager assigns a random link-local address from the 169.254.0.0/16 subnet to the interface.

    • -
-

-

-

- Format: string

-

- Valid values: auto, link-local, manual, shared, disabled

-

ipv4.never-default

 -

If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv4.replace-local-rule

 -

Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv4.required-timeout

 -

The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.

-

This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.

-

Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.

-

A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

- Special values: default (-1), infinity (2147483647)

-

ipv4.route-metric

 -

The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

ipv4.route-table

 -

Enable policy routing (source routing) and set the routing table used when adding routes.

-

This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.

-

If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.

-

Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

- Special values: unspec (0), main (254)

-

ipv4.routes

 -

- A list of IPv4 destination addresses, prefix length, optional IPv4 - next hop addresses, optional route metric, optional attribute. The valid syntax is: - "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". - For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24". -

-

- Various attributes are supported: -

-
    -

  • "advmss" - an unsigned 32 bit integer.

    • -

  • "cwnd" - an unsigned 32 bit integer.

    • -

  • "initcwnd" - an unsigned 32 bit integer.

    • -

  • "initrwnd" - an unsigned 32 bit integer.

    • -

  • "lock-advmss" - a boolean value.

    • -

  • "lock-cwnd" - a boolean value.

    • -

  • "lock-initcwnd" - a boolean value.

    • -

  • "lock-initrwnd" - a boolean value.

    • -

  • "lock-mtu" - a boolean value.

    • -

  • "lock-window" - a boolean value.

    • -

  • "mtu" - an unsigned 32 bit integer.

    • -

  • "onlink" - a boolean value. The onlink flag - is ignored for IPv4 routes without a gateway. That also means, - with a positive "weight" the route cannot merge with ECMP routes - which are onlink and have a gateway. -

    • -

  • "quickack" - a boolean value.

    • -

  • "rto_min" - an unsigned 32 bit integer. - The value is in milliseconds.

    • -

  • "scope" - an unsigned 8 bit integer. IPv4 only.

    • -

  • "src" - an IPv4 address.

    • -

  • "table" - an unsigned 32 bit integer. The default depends on ipv4.route-table.

    • -

  • "tos" - an unsigned 8 bit integer. IPv4 only.

    • -

  • "type" - one of unicast, local, blackhole, - unreachable, prohibit, throw. - The default is unicast.

    • -
  • -

    "weight" - an unsigned 32 bit integer - ranging from 0 to 256. A non-zero weight indicates that the IPv4 - route is an ECMP IPv4 route. NetworkManager will automatically - merge compatible ECMP routes into multi-hop routes. Setting to - zero or omitting the attribute configures single hop routes that - won't get merged. If the route finds no merge partner, it is - configured as single hop route.

    -

    Note that in - NetworkManager, currently all nexthops of a ECMP route must share - the same "onlink" flag in order to be mergable.

    -
    • -

  • "window" - an unsigned 32 bit integer.

    • -
-

-

-

-For details see also `man ip-route`. -

-

- Format: a comma separated list of routes

-

ipv4.routing-rules

 -

-A comma separated list of routing rules for policy routing. The format -is based on ip rule add syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. -

-

-Example: priority 5 from 192.167.4.0/24 table 45 -

-

- Format: a comma separated list of routing rules

-
-
-
-
-

ipv6 setting

-

IPv6 Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ipv6.addr-gen-mode

 -

Configure method for creating the IPv6 interface identifier of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses.

-

The permitted values are: "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2).

-

If the property is set to "eui64", the addresses will be generated using the interface token derived from hardware address. This makes the host part of the address to stay constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is also no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration.

-

If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence and the address is stable when the network interface hardware is replaced.

-

The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.

-

If not specified, when creating a new profile the default is "default".

-

Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.

-

- Format: one of "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2)

-

- Valid values: eui64 (0), stable-privacy (1), default-or-eui64 (2), default (3)

-

ipv6.addresses

 -

- Alias: ip6

-

A list of IPv6 addresses and their prefix length. Multiple addresses can be separated by comma. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64". The addresses are listed in decreasing priority, meaning the first address will be the primary address. This can make a difference with IPv6 source address selection (RFC 6724, section 5).

-

- Format: a comma separated list of addresses

-

ipv6.auto-route-ext-gw

 -

VPN connections will default to add the route automatically unless this setting is set to FALSE.

-

For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv6.dhcp-duid

 -

A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.

-

The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.

-

The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.

-

The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").

-

When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.

-

- Format: string

-

ipv6.dhcp-hostname

 -

If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.

-

- Format: string

-

ipv6.dhcp-hostname-flags

 -

Flags for the DHCP hostname and FQDN.

-

Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.

-

When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.

-

- Format: flags (NMDhcpHostnameFlags)

-

- Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)

-

ipv6.dhcp-iaid

 -

A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".

-

For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.

-

For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.

-

The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.

-

- Format: string

-

ipv6.dhcp-pd-hint

 -

A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").

-

- Format: string

-

ipv6.dhcp-send-hostname

 -

If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv6.dhcp-send-release

 -

Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is "default" (-1). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv6.dhcp-timeout

 -

A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).

-

Set to 2147483647 (MAXINT32) for infinity.

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

- Special values: default (0), infinity (2147483647)

-

ipv6.dns

 -

Array of IP addresses of DNS servers.

-

For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.

-

- Format: list of IPv6 addresses

-

ipv6.dns-options

 -

DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.

-

The currently supported options are "attempts", "debug", "edns0", "ndots", "no-aaaa", "no-check-names", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc" and "inet6", "ip6-bytestring", "ip6-dotint", "no-ip6-dotint". See the resolv.conf(5) manual.

-

Note that there is a distinction between an unset (default) list and an empty list. In nmcli, to unset the list set the value to "". To set an empty list, set it to " ". Currently, an unset list has the same meaning as an empty list. That might change in the future.

-

The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.

-

When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.

-

The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.

-

- Format: a comma separated list of DNS options

-

ipv6.dns-priority

 -

DNS servers priority.

-

The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).

-

Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.

-

Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.

-

Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.

-

When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.

-

When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.

-

When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

ipv6.dns-search

 -

List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.

-

When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.

-

When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).

-

- Format: list of strings

-

ipv6.gateway

 -

- Alias: gw6

-

The gateway associated with this configuration. This is only meaningful if "addresses" is also set.

-

Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.

-

Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".

-

- Format: IPv6 address

-

ipv6.ignore-auto-dns

 -

When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv6.ignore-auto-routes

 -

When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv6.ip6-privacy

 -

Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).

-

Having a per-connection setting set to "-1" (default) means fallback to global configuration "ipv6.ip6-privacy". If it's also unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".

-

Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.

-

- Format: choice (NMSettingIP6ConfigPrivacy)

-

- Valid values: unknown/default (-1), disabled (0), prefer-public-addr (1), prefer-temp-addr (2)

-

ipv6.may-fail

 -

If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv6.method

 -

- Sets the IPv6 connection method. You can set one of the following values: -

-

-

-
    -

  • "auto" - Enables IPv6 auto-configuration. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server.

    • -

  • "dhcp" - Requests an IPv6 address and prefix from a DHCPv6 server. Note that DHCPv6 does not have options to provide routes and the default gateway. As a consequence, by using the "dhcp" method, connections are limited to their own subnet.

    • -

  • "manual" - Enables the configuration of static IPv6 addresses on the interface. Note that you must set at least one IP address and prefix in the "ipv6.addresses" property.

    • -

  • "disabled" - Disables the IPv6 protocol in this connection profile.

    • -

  • "ignore" - Configures NetworkManager to make no changes to the IPv6 configuration on the interface. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements.

    • -

  • "shared" - Provides network access to other computers. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface.

    • -

  • "link-local" - Assigns a random link-local address from the fe80::/64 subnet to the interface.

    • -
-

-

-

- If you set "auto", "dhcp", "manual", "ignore", or "shared", NetworkManager assigns, in addition to the global address, an IPv6 link-local address to the interface. This is compliant with RFC 4291. -

-

-

-

- Format: string

-

- Valid values: ignore, auto, dhcp, link-local, manual, shared, disabled

-

ipv6.mtu

 -

Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.

-

- Format: integer

-

- Special values: auto

-

ipv6.never-default

 -

If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ipv6.ra-timeout

 -

A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.

-

Set to 2147483647 (MAXINT32) for infinity.

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

- Special values: default (0), infinity (2147483647)

-

ipv6.replace-local-rule

 -

Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

ipv6.required-timeout

 -

The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.

-

This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.

-

Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.

-

A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).

-

- Format: integer

-

- Valid values: -1 - 2147483647

-

- Special values: default (-1), infinity (2147483647)

-

ipv6.route-metric

 -

The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

ipv6.route-table

 -

Enable policy routing (source routing) and set the routing table used when adding routes.

-

This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.

-

If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.

-

Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

- Special values: unspec (0), main (254)

-

ipv6.routes

 -

- A list of IPv6 destination addresses, prefix length, optional IPv6 - next hop addresses, optional route metric, optional attribute. The valid syntax is: - "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". -

-

- Various attributes are supported: -

-
    -

  • "advmss" - an unsigned 32 bit integer.

    • -

  • "cwnd" - an unsigned 32 bit integer.

    • -

  • "from" - an IPv6 address with optional prefix. IPv6 only.

    • -

  • "initcwnd" - an unsigned 32 bit integer.

    • -

  • "initrwnd" - an unsigned 32 bit integer.

    • -

  • "lock-advmss" - a boolean value.

    • -

  • "lock-cwnd" - a boolean value.

    • -

  • "lock-initcwnd" - a boolean value.

    • -

  • "lock-initrwnd" - a boolean value.

    • -

  • "lock-mtu" - a boolean value.

    • -

  • "lock-window" - a boolean value.

    • -

  • "mtu" - an unsigned 32 bit integer.

    • -

  • "onlink" - a boolean value.

    • -

  • "quickack" - a boolean value.

    • -

  • "rto_min" - an unsigned 32 bit integer. - The value is in milliseconds.

    • -

  • "src" - an IPv6 address.

    • -

  • "table" - an unsigned 32 bit integer. The default depends on ipv6.route-table.

    • -

  • "type" - one of unicast, local, blackhole, - unreachable, prohibit, throw. - The default is unicast.

    • -

  • "window" - an unsigned 32 bit integer.

    • -
-

-

-

-For details see also `man ip-route`. -

-

- Format: a comma separated list of routes

-

ipv6.routing-rules

 -

-A comma separated list of routing rules for policy routing. The format -is based on ip rule add syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. -

-

-Example: priority 5 from 1:2:3::5/128 table 45 -

-

- Format: a comma separated list of routing rules

-

ipv6.temp-preferred-lifetime

 -

The preferred lifetime of autogenerated temporary addresses, in seconds.

-

Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-preferred-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_prefered_lft".

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

- Special values: default (0)

-

ipv6.temp-valid-lifetime

 -

The valid lifetime of autogenerated temporary addresses, in seconds.

-

Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-valid-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_valid_lft".

-

- Format: integer

-

- Valid values: 0 - 2147483647

-

- Special values: default (0)

-

ipv6.token

 -

Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.

-

When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.

-

- Format: string

-
-
-
-
-

ip-tunnel setting

-

IP Tunneling Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ip-tunnel.encapsulation-limit

 -

How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.

-

- Format: integer

-

- Valid values: 0 - 255

-

ip-tunnel.flags

 -

Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy) and 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.

-

- Format: flags (NMIPTunnelFlags)

-

- Valid values: none (0x0), ip6-ign-encap-limit (0x1), ip6-use-orig-tclass (0x2), ip6-use-orig-flowlabel (0x4), ip6-mip6-dev (0x8), ip6-rcv-dscp-copy (0x10), ip6-use-orig-fwmark (0x20)

-

ip-tunnel.flow-label

 -

The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.

-

- Format: integer

-

- Valid values: 0 - 1048575

-

ip-tunnel.fwmark

 -

The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ip-tunnel.input-key

 -

The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

-

- Format: string

-

ip-tunnel.local

 -

- Alias: local

-

The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.

-

- Format: string

-

ip-tunnel.mode

 -

- Alias: mode

-

The tunneling mode. Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10) and ip6gretap (11)

-

- Format: choice (NMIPTunnelMode)

-

- Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11)

-

ip-tunnel.mtu

 -

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

-

- Format: integer

-

- Special values: auto

-

ip-tunnel.output-key

 -

The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.

-

- Format: string

-

ip-tunnel.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.

-

- Format: string

-

ip-tunnel.path-mtu-discovery

 -

Whether to enable Path MTU Discovery on this tunnel.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ip-tunnel.remote

 -

- Alias: remote

-

The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.

-

- Format: string

-

ip-tunnel.tos

 -

The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.

-

- Format: integer

-

- Valid values: 0 - 255

-

ip-tunnel.ttl

 -

The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

-

- Format: integer

-

- Valid values: 0 - 255

-
-
-
-
-

macsec setting

-

MACSec Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

macsec.encrypt

 -

- Alias: encrypt

-

Whether the transmitted traffic must be encrypted.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

macsec.mka-cak

 -

- Alias: cak

-

The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.

-

- Format: string

-

macsec.mka-cak-flags

 -

Flags indicating how to handle the "mka-cak" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

macsec.mka-ckn

 -

- Alias: ckn

-

The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.

-

- Format: string

-

macsec.mode

 -

- Alias: mode

-

Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.

-

- Format: choice (NMSettingMacsecMode)

-

- Valid values: psk (0), eap (1)

-

macsec.offload

 -

Specifies the MACsec offload mode.

-

"off" (0) disables MACsec offload.

-

"phy" (1) and "mac" (2) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail.

-

"default" (-1) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is "off" (0).

-

- Format: choice (NMSettingMacsecOffload)

-

- Valid values: default (-1), off (0), phy (1), mac (2)

-

macsec.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

-

- Format: string

-

macsec.port

 -

- Alias: port

-

The port component of the SCI (Secure Channel Identifier), between 1 and 65534.

-

- Format: integer

-

- Valid values: 1 - 65534

-

macsec.send-sci

 -

Specifies whether the SCI (Secure Channel Identifier) is included in every packet.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

macsec.validation

 -

Specifies the validation mode for incoming frames.

-

- Format: choice (NMSettingMacsecValidation)

-

- Valid values: disable (0), check (1), strict (2)

-
-
-
-
-

macvlan setting

-

MAC VLAN Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

macvlan.mode

 -

- Alias: mode

-

The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.

-

- Format: choice (NMSettingMacvlanMode)

-

- Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5)

-

macvlan.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

-

- Format: string

-

macvlan.promiscuous

 -

Whether the interface should be put in promiscuous mode.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

macvlan.tap

 -

- Alias: tap

-

Whether the interface should be a MACVTAP.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

match setting

-

Match settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

match.driver

 -

A list of driver names to match. Each element is a shell wildcard pattern.

-

See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.

-

- Format: list of strings

-

match.interface-name

 -

A list of interface names to match. Each element is a shell wildcard pattern.

-

An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".

-

- Format: list of strings

-

match.kernel-command-line

 -

A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.

-

See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.

-

- Format: list of strings

-

match.path

 -

A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.

-

For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".

-

The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").

-

Each element of the list is a shell wildcard pattern.

-

See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.

-

- Format: list of strings

-
-
-
-
-

802-11-olpc-mesh setting

-

- Alias: olpc-mesh

-

OLPC Wireless Mesh Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - -

802-11-olpc-mesh.channel

 -

- Alias: channel

-

Channel on which the mesh network to join is located.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

802-11-olpc-mesh.dhcp-anycast-address

 -

- Alias: dhcp-anycast

-

Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.

-

This is currently only implemented by dhclient DHCP plugin.

-

- Format: MAC address

-

802-11-olpc-mesh.ssid

 -

- Alias: ssid

-

SSID of the mesh network to join.

-

- Format: string

-
-
-
-
-

ovs-bridge setting

-

OvsBridge Link Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

ovs-bridge.datapath-type

 -

The data path type. One of "system", "netdev" or empty.

-

- Format: string

-

- Valid values: system, netdev

-

ovs-bridge.fail-mode

 -

The bridge failure mode. One of "secure", "standalone" or empty.

-

- Format: string

-

- Valid values: secure, standalone

-

ovs-bridge.mcast-snooping-enable

 -

Enable or disable multicast snooping.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ovs-bridge.rstp-enable

 -

Enable or disable RSTP.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ovs-bridge.stp-enable

 -

Enable or disable STP.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

ovs-dpdk setting

-

OvsDpdk Link Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

ovs-dpdk.devargs

 -

Open vSwitch DPDK device arguments.

-

- Format: string

-

ovs-dpdk.n-rxq

 -

Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ovs-dpdk.n-rxq-desc

 -

The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.

-

- Format: integer

-

- Valid values: 0 - 4096

-

ovs-dpdk.n-txq-desc

 -

The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.

-

- Format: integer

-

- Valid values: 0 - 4096

-
-
-
-
-

ovs-interface setting

-

Open vSwitch Interface Settings.

-

- Properties: -

-
---- - - - - - - - - - - -

ovs-interface.ofport-request

 -

Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.

-

- Format: integer

-

- Valid values: 0 - 65279

-

ovs-interface.type

 -

The interface type. Either "internal", "system", "patch", "dpdk", or empty.

-

- Format: string

-

- Valid values: internal, system, patch, dpdk

-
-
-
-
-

ovs-patch setting

-

OvsPatch Link Settings.

-

- Properties: -

-
---- - - - - -

ovs-patch.peer

 -

Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.

-

- Format: string

-
-
-
-
-

ovs-port setting

-

OvsPort Link Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ovs-port.bond-downdelay

 -

The time port must be inactive in order to be considered down.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ovs-port.bond-mode

 -

Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".

-

- Format: string

-

- Valid values: active-backup, balance-slb, balance-tcp

-

ovs-port.bond-updelay

 -

The time port must be active before it starts forwarding traffic.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ovs-port.lacp

 -

LACP mode. One of "active", "off", or "passive".

-

- Format: string

-

- Valid values: active, off, passive

-

ovs-port.tag

 -

The VLAN tag in the range 0-4095.

-

- Format: integer

-

- Valid values: 0 - 4095

-

ovs-port.trunks

 -

A list of VLAN ranges that this port trunks.

-

The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.

-

- Format: list of ovs-port.trunks objects

-

ovs-port.vlan-mode

 -

The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.

-

- Format: string

-

- Valid values: access, native-tagged, native-untagged, trunk, dot1q-tunnel

-
-
-
-
-

ppp setting

-

Point-to-Point Protocol Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

ppp.baud

 -

If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ppp.crtscts

 -

If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.lcp-echo-failure

 -

If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ppp.lcp-echo-interval

 -

If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

ppp.mppe-stateful

 -

If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.mru

 -

If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.

-

- Format: integer

-

- Valid values: 0 - 16384

-

ppp.mtu

 -

If non-zero, instruct pppd to send packets no larger than the specified size.

-

- Format: integer

-

- Special values: auto

-

ppp.no-vj-comp

 -

If TRUE, Van Jacobsen TCP header compression will not be requested.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.noauth

 -

If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.nobsdcomp

 -

If TRUE, BSD compression will not be requested.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.nodeflate

 -

If TRUE, "deflate" compression will not be requested.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.refuse-chap

 -

If TRUE, the CHAP authentication method will not be used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.refuse-eap

 -

If TRUE, the EAP authentication method will not be used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.refuse-mschap

 -

If TRUE, the MSCHAP authentication method will not be used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.refuse-mschapv2

 -

If TRUE, the MSCHAPv2 authentication method will not be used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.refuse-pap

 -

If TRUE, the PAP authentication method will not be used.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.require-mppe

 -

If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

ppp.require-mppe-128

 -

If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

pppoe setting

-

PPP-over-Ethernet Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

pppoe.parent

 -

- Alias: parent

-

If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.

-

- Format: string

-

pppoe.password

 -

- Alias: password

-

Password used to authenticate with the PPPoE service.

-

- Format: string

-

pppoe.password-flags

 -

Flags indicating how to handle the "password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

pppoe.service

 -

- Alias: service

-

If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.

-

- Format: string

-

pppoe.username

 -

- Alias: username

-

Username used to authenticate with the PPPoE service.

-

- Format: string

-
-
-
-
-

proxy setting

-

WWW Proxy Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

proxy.browser-only

 -

- Alias: browser-only

-

Whether the proxy configuration is for browser only.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

proxy.method

 -

- Alias: method

-

Method for proxy configuration, Default is "none" (0)

-

- Format: choice (NMSettingProxyMethod)

-

- Valid values: none (0), auto (1)

-

proxy.pac-script

 -

- Alias: pac-script

-

The PAC script. In the profile this must be an UTF-8 encoded javascript code that defines a FindProxyForURL() function. When setting the property in nmcli, a filename is accepted too. In that case, nmcli will read the content of the file and set the script. The prefixes "file://" and "js://" are supported to explicitly differentiate between the two.

-

- Format: string

-

proxy.pac-url

 -

- Alias: pac-url

-

PAC URL for obtaining PAC file.

-

- Format: string

-
-
-
-
-

serial setting

-

Serial Link Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

serial.baud

 -

Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

serial.bits

 -

Byte-width of the serial communication. The 8 in "8n1" for example.

-

- Format: integer

-

- Valid values: 5 - 8

-

serial.parity

 -

Parity setting of the serial port.

-

- Format: choice (NMSettingSerialParity)

-

- Valid values: none/N/n (0), even/E/e (1), odd/O/o (2)

-

serial.send-delay

 -

Time to delay between each byte sent to the modem, in microseconds.

-

- Format: integer

-

- Valid values: 0 - 18446744073709551615

-

serial.stopbits

 -

Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.

-

- Format: integer

-

- Valid values: 1 - 2

-
-
-
-
-

sriov setting

-

SR-IOV settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

sriov.autoprobe-drivers

 -

Whether to autoprobe virtual functions by a compatible driver.

-

If set to "true" (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.

-

If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them.

-

When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

sriov.eswitch-encap-mode

 -

Select the eswitch encapsulation support.

-

Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

-

If set to "preserve" (-1) (default) the eswitch encap-mode won't be modified by NetworkManager.

-

- Format: choice (NMSriovEswitchEncapMode)

-

- Valid values: preserve (-1), none (0), basic (1)

-

sriov.eswitch-inline-mode

 -

Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.

-

Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

-

If set to "preserve" (-1) (default) the eswitch inline-mode won't be modified by NetworkManager.

-

- Format: choice (NMSriovEswitchInlineMode)

-

- Valid values: preserve (-1), none (0), link (1), network (2), transport (3)

-

sriov.eswitch-mode

 -

Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.

-

If set to "preserve" (-1) (default) the eswitch mode won't be modified by NetworkManager.

-

- Format: choice (NMSriovEswitchMode)

-

- Valid values: preserve (-1), legacy (0), switchdev (1)

-

sriov.total-vfs

 -

The total number of virtual functions to create.

-

Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

sriov.vfs

 -

Array of virtual function descriptors.

-

Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.

-

When represented as string a VF is in the form:

-

"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".

-

for example:

-

"2 mac=00:11:22:33:44:55 spoof-check=true".

-

Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.

-

The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form

-

"ID[.PRIORITY[.PROTO]]".

-

PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.

-

- Format: list of sriov.vfs objects

-
-
-
-
-

tc setting

-

Linux Traffic Control Settings.

-

- Properties: -

-
---- - - - - - - - - - - -

tc.qdiscs

 -

-Array of TC queueing disciplines. qdisc is a basic block in the -Linux traffic control subsystem -

-

- Each qdisc can be specified by the following attributes: -

-
---- - - - - - - - - - - - - - - - - - - -

handle HANDLE

- specifies the qdisc handle. A qdisc, which potentially can have children, gets - assigned a major number, called a 'handle', leaving the minor number namespace - available for classes. The handle is expressed as '10:'. It is customary to - explicitly assign a handle to qdiscs expected to have children. -

parent HANDLE

- specifies the handle of the parent qdisc the current qdisc must be - attached to. -

root

- specifies that the qdisc is attached to the root of device. -

KIND

- this is the qdisc kind. NetworkManager currently supports the - following kinds: fq_codel, sfq, tbf. Each qdisc kind has a - different set of parameters, described below. There are also some - kinds like pfifo, pfifo_fast, prio supported by NetworkManager - but their parameters are not supported by NetworkManager. -

-

- Parameters for 'fq_codel': -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

limit U32

- the hard limit on the real queue size. When this limit is - reached, incoming packets are dropped. Default is 10240 packets. -

memory_limit U32

- sets a limit on the total number of bytes that can be queued in - this FQ-CoDel instance. The lower of the packet limit of the - limit parameter and the memory limit will be enforced. Default is - 32 MB. -

flows U32

- the number of flows into which the incoming packets are - classified. Due to the stochastic nature of hashing, multiple - flows may end up being hashed into the same slot. Newer flows - have priority over older ones. This parameter can be set only at - load time since memory has to be allocated for the hash table. - Default value is 1024. -

target U32

- the acceptable minimum standing/persistent queue delay. This minimum - delay is identified by tracking the local minimum queue delay that packets - experience. The unit of measurement is microsecond(us). Default value is 5ms. -

interval U32

- used to ensure that the measured minimum delay does not become too stale. - The minimum delay must be experienced in the last epoch of length .B - interval. It should be set on the order of the worst-case RTT - through the bottleneck to give endpoints sufficient time to - react. Default value is 100ms. -

quantum U32

- the number of bytes used as 'deficit' in the fair queuing - algorithm. Default is set to 1514 bytes which corresponds to the - Ethernet MTU plus the hardware header length of 14 bytes. -

ecn BOOL

- can be used to mark packets instead of dropping them. ecn is turned - on by default. -

ce_threshold U32

- sets a threshold above which all packets are marked with ECN - Congestion Experienced. This is useful for DCTCP-style congestion - control algorithms that require marking at very shallow queueing - thresholds. -

-

- Parameters for 'sfq': -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

divisor U32

- can be used to set a different hash table size, available - from kernel 2.6.39 onwards. The specified divisor must be - a power of two and cannot be larger than 65536. - Default value: 1024. -

limit U32

- Upper limit of the SFQ. Can be used to reduce the default - length of 127 packets. -

depth U32

- Limit of packets per flow. Default to - 127 and can be lowered. -

perturb_period U32

- Interval in seconds for queue algorithm perturbation. - Defaults to 0, which means that no perturbation occurs. Do - not set too low for each perturbation may cause some - packet reordering or losses. Advised value: 60 This value - has no effect when external flow classification is used. - Its better to increase divisor value to lower risk of hash - collisions. -

quantum U32

- Amount of bytes a flow is allowed to dequeue during a - round of the round robin process. Defaults to the MTU of - the interface which is also the advised value and the - minimum value. -

flows U32

- Default value is 127. -

-

- Parameters for 'tbf': -

-
---- - - - - - - - - - - - - - - - - - - -

rate U64

- Bandwidth or rate. These parameters accept a floating - point number, possibly followed by either a unit (both SI - and IEC units supported), or a float followed by a percent - character to specify the rate as a percentage of the - device's speed. -

burst U32

 -

- Also known as buffer or maxburst. Size of the bucket, in - bytes. This is the maximum amount of bytes that tokens can - be available for instantaneously. In general, larger - shaping rates require a larger buffer. For 10mbit/s on - Intel, you need at least 10kbyte buffer if you want to - reach your configured rate! -

-

- If your buffer is too small, packets may be dropped - because more tokens arrive per timer tick than fit in your - bucket. The minimum buffer size can be calculated by - dividing the rate by HZ. -

-

- Token usage calculations are performed using a table which - by default has a resolution of 8 packets. This resolution - can be changed by specifying the cell size with the burst. - For example, to specify a 6000 byte buffer with a 16 byte - cell size, set a burst of 6000/16. You will probably never - have to set this. Must be an integral power of 2. -

-

limit U32

- Limit is the number of bytes that can be queued waiting - for tokens to become available. -

latency U32

- specifies the maximum amount of time a packet can - sit in the TBF. The latency calculation takes into account - the size of the bucket, the rate and possibly the peakrate - (if set). The latency and limit are mutually exclusive. -

-

- Format: GPtrArray(NMTCQdisc)

-

tc.tfilters

 -

- Array of TC traffic filters. Traffic control can manage the packet content during - classification by using filters. -

-

- Each tfilters can be specified by the following attributes: -

-
---- - - - - - - - - - - - - - - - - - - -

handle HANDLE

- specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class - a packet will be enqueued. It is important to notice that filters reside within qdiscs. Therefore, - see qdiscs handle for detailed information. -

parent HANDLE

- specifies the handle of the parent qdisc the current qdisc must be - attached to. -

root

- specifies that the qdisc is attached to the root of device. -

KIND

- this is the tfilters kind. NetworkManager currently supports - following kinds: mirred, simple. Each filter kind has a - different set of actions, described below. There are also some - other kinds like matchall, basic, u32 supported by NetworkManager. -

-

- Actions for 'mirred': -

-
---- - - - - - - - - - - - - - - - - - - -

egress bool

- Define whether the packet should exit from the interface. -

ingress bool

- Define whether the packet should come into the interface. -

mirror bool

- Define whether the packet should be copied to the destination space. -

redirect bool

- Define whether the packet should be moved to the destination space. -

-

- Action for 'simple': -

-
---- - - - - -

sdata char[32]

- The actual string to print. -

-

- Format: GPtrArray(NMTCTfilter)

-
-
-
-
-

team setting

-

Teaming Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

team.config

 -

- Alias: config

-

The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

-

- Format: string

-

team.link-watchers

 -

Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

-

- Format: list of team.link-watchers objects

-

team.mcast-rejoin-count

 -

Corresponds to the teamd mcast_rejoin.count.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), disabled (0)

-

team.mcast-rejoin-interval

 -

Corresponds to the teamd mcast_rejoin.interval.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (0)

-

team.notify-peers-count

 -

Corresponds to the teamd notify_peers.count.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), disabled (0)

-

team.notify-peers-interval

 -

Corresponds to the teamd notify_peers.interval.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (0)

-

team.runner

 -

Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".

-

- Format: string

-

- Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacp

-

team.runner-active

 -

Corresponds to the teamd runner.active.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

team.runner-agg-select-policy

 -

Corresponds to the teamd runner.agg_select_policy.

-

- Format: string

-

- Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_config

-

team.runner-fast-rate

 -

Corresponds to the teamd runner.fast_rate.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

team.runner-hwaddr-policy

 -

Corresponds to the teamd runner.hwaddr_policy.

-

- Format: string

-

- Valid values: same_all, by_active, only_active

-

team.runner-min-ports

 -

Corresponds to the teamd runner.min_ports.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (1)

-

team.runner-sys-prio

 -

Corresponds to the teamd runner.sys_prio.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (65535)

-

team.runner-tx-balancer

 -

Corresponds to the teamd runner.tx_balancer.name.

-

- Format: string

-

- Valid values: basic

-

team.runner-tx-balancer-interval

 -

Corresponds to the teamd runner.tx_balancer.interval.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (50)

-

team.runner-tx-hash

 -

Corresponds to the teamd runner.tx_hash.

-

- Format: list of strings

-

- Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4

-
-
-
-
-

team-port setting

-

Team Port Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

team-port.config

 -

- Alias: config

-

The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

-

- Format: string

-

team-port.lacp-key

 -

Corresponds to the teamd ports.PORTIFNAME.lacp_key.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (0)

-

team-port.lacp-prio

 -

Corresponds to the teamd ports.PORTIFNAME.lacp_prio.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (255)

-

team-port.link-watchers

 -

Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.

-

- Format: list of team-port.link-watchers objects

-

team-port.prio

 -

Corresponds to the teamd ports.PORTIFNAME.prio.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (0), default (0)

-

team-port.queue-id

 -

Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

- Special values: unset (-1), default (0)

-

team-port.sticky

 -

Corresponds to the teamd ports.PORTIFNAME.sticky.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

tun setting

-

Tunnel Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

tun.group

 -

- Alias: group

-

The group ID which will own the device. If set to NULL everyone will be able to use the device.

-

- Format: string

-

tun.mode

 -

- Alias: mode

-

The operating mode of the virtual device. Allowed values are "tun" (1) to create a layer 3 device and "tap" (2) to create an Ethernet-like layer 2 one.

-

- Format: choice (NMSettingTunMode)

-

- Valid values: tun (1), tap (2)

-

tun.multi-queue

 -

- Alias: multi-queue

-

If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

tun.owner

 -

- Alias: owner

-

The user ID which will own the device. If set to NULL everyone will be able to use the device.

-

- Format: string

-

tun.pi

 -

- Alias: pi

-

If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

tun.vnet-hdr

 -

- Alias: vnet-hdr

-

If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-
-
-
-
-

vlan setting

-

VLAN Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

vlan.egress-priority-map

 -

- Alias: egress

-

For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

-

- Format: list of vlan.egress-priority-map objects

-

vlan.flags

 -

- Alias: flags

-

One or more flags which control the behavior and features of the VLAN interface. Flags include "reorder-headers" (0x1) (reordering of output packet headers), "gvrp" (0x2) (use of the GVRP protocol), and "loose-binding" (0x4) (loose binding of the interface to its controller device's operating state). "mvrp" (0x8) (use of the MVRP protocol).

-

The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.

-

- Format: flags (NMVlanFlags)

-

- Valid values: reorder-headers (0x1), gvrp (0x2), loose-binding (0x4), mvrp (0x8)

-

vlan.id

 -

- Alias: id

-

The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.

-

- Format: integer

-

- Valid values: 0 - 4095

-

vlan.ingress-priority-map

 -

- Alias: ingress

-

For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".

-

- Format: list of vlan.ingress-priority-map objects

-

vlan.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.

-

- Format: string

-

vlan.protocol

 -

Specifies the VLAN protocol to use for encapsulation.

-

Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

-

- Format: string

-

- Valid values: 802.1Q, 802.1ad

-
-
-
-
-

vpn setting

-

VPN Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

vpn.data

 -

Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

-

- Format: list of key/value options

-

vpn.persistent

 -

If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vpn.secrets

 -

Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

-

- Format: list of key/value options

-

vpn.service-type

 -

- Alias: vpn-type

-

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

-

- Format: string

-

vpn.timeout

 -

Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

vpn.user-name

 -

- Alias: user

-

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

-

- Format: string

-
-
-
-
-

vrf setting

-

VRF settings.

-

- Properties: -

-
---- - - - - -

vrf.table

 -

- Alias: table

-

The routing table for this VRF.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-
-
-
-
-

vxlan setting

-

VXLAN Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

vxlan.ageing

 -

Specifies the lifetime in seconds of FDB entries learnt by the kernel.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

vxlan.destination-port

 -

- Alias: destination-port

-

Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.

-

- Format: integer

-

- Valid values: 0 - 65535

-

vxlan.id

 -

- Alias: id

-

Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.

-

- Format: integer

-

- Valid values: 0 - 16777215

-

vxlan.l2-miss

 -

Specifies whether netlink LL ADDR miss notifications are generated.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vxlan.l3-miss

 -

Specifies whether netlink IP ADDR miss notifications are generated.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vxlan.learning

 -

Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vxlan.limit

 -

Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

vxlan.local

 -

- Alias: local

-

If given, specifies the source IP address to use in outgoing packets.

-

- Format: string

-

vxlan.parent

 -

- Alias: dev

-

If given, specifies the parent interface name or parent connection UUID.

-

- Format: string

-

vxlan.proxy

 -

Specifies whether ARP proxy is turned on.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vxlan.remote

 -

- Alias: remote

-

Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.

-

- Format: string

-

vxlan.rsc

 -

Specifies whether route short circuit is turned on.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

vxlan.source-port-max

 -

- Alias: source-port-max

-

Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.

-

- Format: integer

-

- Valid values: 0 - 65535

-

vxlan.source-port-min

 -

- Alias: source-port-min

-

Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.

-

- Format: integer

-

- Valid values: 0 - 65535

-

vxlan.tos

 -

Specifies the TOS value to use in outgoing packets.

-

- Format: integer

-

- Valid values: 0 - 255

-

vxlan.ttl

 -

Specifies the time-to-live value to use in outgoing packets.

-

- Format: integer

-

- Valid values: 0 - 255

-
-
-
-
-

wifi-p2p setting

-

Wi-Fi P2P Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - -

wifi-p2p.peer

 -

- Alias: peer

-

The P2P device that should be connected to. Currently, this is the only way to create or join a group.

-

- Format: MAC address

-

wifi-p2p.wfd-ies

 -

The Wi-Fi Display (WFD) Information Elements (IEs) to set.

-

Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.

-

- Format: bytes

-

wifi-p2p.wps-method

 -

Flags indicating which mode of WPS is to be used.

-

There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.

-

- Format: flags (NMSettingWirelessSecurityWpsMethod)

-

- Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)

-
-
-
-
-

wimax setting

-

WiMax Settings.

-

- Properties: -

-
---- - - - - - - - - - - -

wimax.mac-address

 -

- Alias: mac

-

If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).

-

- This property is deprecated since version 1.2. - WiMAX is no longer supported.

-

- Format: string

-

wimax.network-name

 -

- Alias: nsp

-

Network Service Provider (NSP) name of the WiMAX network this connection should use.

-

- This property is deprecated since version 1.2. - WiMAX is no longer supported.

-

- Format: MAC address

-
-
-
-
-

802-3-ethernet setting

-

- Alias: ethernet

-

Wired Ethernet Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

802-3-ethernet.accept-all-mac-addresses

 -

When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

802-3-ethernet.auto-negotiate

 -

When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

802-3-ethernet.cloned-mac-address

 -

- Alias: cloned-mac

-

If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

-

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.

-

If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

-

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

-

- Format: MAC address

-

- Special values: preserve, permanent, random, stable

-

802-3-ethernet.duplex

 -

When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.

-

- Format: string

-

- Valid values: half, full

-

802-3-ethernet.generate-mac-address-mask

 -

With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

-

If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

-

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

-

If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

-

If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

-

- Format: string

-

802-3-ethernet.mac-address

 -

- Alias: mac

-

If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

-

- Format: MAC address

-

802-3-ethernet.mac-address-blacklist

 -

If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

-

- Format: list of MAC addresses

-

802-3-ethernet.mac-address-denylist

 -

If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).

-

- Format: list of MAC addresses

-

802-3-ethernet.mtu

 -

- Alias: mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

-

- Format: integer

-

- Special values: auto

-

802-3-ethernet.port

 -

Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.

-

- Format: read only

-

802-3-ethernet.s390-nettype

 -

s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.

-

- Format: string

-

- Valid values: qeth, lcs, ctc

-

802-3-ethernet.s390-options

 -

Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

-

Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.

-

- Format: list of key/value options

-

802-3-ethernet.s390-subchannels

 -

Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.

-

- Format: list of 802-3-ethernet.s390-subchannels objects

-

802-3-ethernet.speed

 -

When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

802-3-ethernet.wake-on-lan

 -

The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of "phy" (0x2), "unicast" (0x4), "multicast" (0x8), "broadcast" (0x10), "arp" (0x20), "magic" (0x40) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

-

- Format: flags (NMSettingWiredWakeOnLan)

-

- Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000)

-

802-3-ethernet.wake-on-lan-password

 -

If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.

-

- Format: MAC address

-
-
-
-
-

wireguard setting

-

WireGuard Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

wireguard.fwmark

 -

The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.

-

Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

wireguard.ip4-auto-default-route

 -

Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".

-

Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.

-

Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

wireguard.ip6-auto-default-route

 -

Like ip4-auto-default-route, but for the IPv6 default route.

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

wireguard.listen-port

 -

The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.

-

- Format: integer

-

- Valid values: 0 - 65535

-

wireguard.mtu

 -

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.

-

If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.

-

- Format: integer

-

- Special values: auto

-

wireguard.peer-routes

 -

Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.

-

Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

wireguard.private-key

 -

The 256 bit private-key in base64 encoding.

-

- Format: string

-

wireguard.private-key-flags

 -

Flags indicating how to handle the "private-key" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-
-
-
-
-

802-11-wireless setting

-

- Alias: wifi

-

Wi-Fi Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

802-11-wireless.ap-isolation

 -

Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from "default" (-1) only when the interface is configured in AP mode.

-

If set to "true" (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.

-

If set to "false" (0), devices can talk to each other.

-

When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

802-11-wireless.band

 -

802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.

-

- Format: string

-

- Valid values: a, bg

-

802-11-wireless.bssid

 -

If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.

-

Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.

-

- Format: MAC address

-

802-11-wireless.channel

 -

Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.

-

- Format: integer

-

- Valid values: 0 - 4294967295

-

802-11-wireless.channel-width

 -

Specifies width of the wireless channel in Access Point (AP) mode.

-

When set to "auto" (0) (the default), the channel width is automatically determined. At the moment, this means that the safest (smallest) width is chosen.

-

If the value is not "auto" (0), then the 'channel' property must also be set. When using the 2.4GHz band, the width can be at most 40MHz.

-

This property can be set to a value different from "auto" (0) only when the interface is configured in AP mode.

-

- Format: choice (NMSettingWirelessChannelWidth)

-

- Valid values: auto (0), 20mhz (20), 40mhz (40), 80mhz (80)

-

802-11-wireless.cloned-mac-address

 -

- Alias: cloned-mac

-

If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.

-

Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable-ssid" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. "stable-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable-id to "${NETWORK_SSID}".

-

If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).

-

On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".

-

- Format: MAC address

-

- Special values: preserve, permanent, random, stable, stable-ssid

-

802-11-wireless.generate-mac-address-mask

 -

With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.

-

If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.

-

If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.

-

If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.

-

If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.

-

- Format: string

-

802-11-wireless.hidden

 -

If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.

-

In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.

-

In AP mode, the created network does not broadcast its SSID.

-

Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.

-

- Format: boolean

-

- Valid values: true/yes/on, false/no/off

-

802-11-wireless.mac-address

 -

- Alias: mac

-

If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).

-

- Format: MAC address

-

802-11-wireless.mac-address-blacklist

 -

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

-

- Format: list of MAC addresses

-

802-11-wireless.mac-address-denylist

 -

A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").

-

- Format: list of MAC addresses

-

802-11-wireless.mac-address-randomization

 -

One of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address).

-

- This property is deprecated since version 1.4. - Use the "cloned-mac-address" property instead.

-

- Format: choice (NMSettingMacRandomization)

-

- Valid values: default (0), never (1), always (2)

-

802-11-wireless.mode

 -

- Alias: mode

-

Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.

-

- Format: string

-

- Valid values: infrastructure, adhoc, ap, mesh

-

802-11-wireless.mtu

 -

- Alias: mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

-

- Format: integer

-

- Special values: auto

-

802-11-wireless.powersave

 -

One of "disable" (2) (disable Wi-Fi power saving), "enable" (3) (enable Wi-Fi power saving), "ignore" (1) (don't touch currently configure setting) or "default" (0) (use the globally configured value). All other values are reserved.

-

- Format: choice (NMSettingWirelessPowersave)

-

- Valid values: default (0), ignore (1), disable (2), enable (3)

-

802-11-wireless.seen-bssids

 -

A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.

-

This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.

-

- Format: read only

-

802-11-wireless.ssid

 -

- Alias: ssid

-

SSID of the Wi-Fi network. Must be specified.

-

- Format: string

-

802-11-wireless.wake-on-wlan

 -

The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of "any" (0x2), "disconnect" (0x4), "magic" (0x8), "gtk-rekey-failure" (0x10), "eap-identity-request" (0x20), "4way-handshake" (0x40), "rfkill-release" (0x80), "tcp" (0x100) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).

-

- Format: flags (NMSettingWirelessWakeOnWLan)

-

- Valid values: any (0x2), disconnect (0x4), magic (0x8), gtk-rekey-failure (0x10), eap-identity-request (0x20), 4way-handshake (0x40), rfkill-release (0x80), tcp (0x100), all (0x1fe), default (0x1), ignore (0x8000)

-
-
-
-
-

802-11-wireless-security setting

-

- Alias: wifi-sec

-

Wi-Fi Security Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

802-11-wireless-security.auth-alg

 -

When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.

-

- Format: string

-

- Valid values: open, shared, leap

-

802-11-wireless-security.fils

 -

Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable FILS), "optional" (2) (enable FILS if the supplicant and the access point support it) or "required" (3) (enable FILS and fail if not supported). When set to "default" (0) and no global default is set, FILS will be optionally enabled.

-

- Format: choice (NMSettingWirelessSecurityFils)

-

- Valid values: default (0), disable (1), optional (2), required (3)

-

802-11-wireless-security.group

 -

A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".

-

- Format: list of strings

-

- Valid values: wep40, wep104, tkip, ccmp

-

802-11-wireless-security.key-mgmt

 -

Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).

-

This property must be set for any Wi-Fi connection that uses security.

-

- Format: string

-

- Valid values: none, ieee8021x, wpa-psk, wpa-eap, wpa-eap-suite-b-192, sae, owe

-

802-11-wireless-security.leap-password

 -

The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

-

- Format: string

-

802-11-wireless-security.leap-password-flags

 -

Flags indicating how to handle the "leap-password" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-11-wireless-security.leap-username

 -

The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").

-

- Format: string

-

802-11-wireless-security.pairwise

 -

A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".

-

- Format: list of strings

-

- Valid values: tkip, ccmp

-

802-11-wireless-security.pmf

 -

Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable PMF), "optional" (2) (enable PMF if the supplicant and the access point support it) or "required" (3) (enable PMF and fail if not supported). When set to "default" (0) and no global default is set, PMF will be optionally enabled.

-

- Format: choice (NMSettingWirelessSecurityPmf)

-

- Valid values: default (0), disable (1), optional (2), required (3)

-

802-11-wireless-security.proto

 -

List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.

-

- Format: list of strings

-

- Valid values: wpa, rsn

-

802-11-wireless-security.psk

 -

Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.

-

- Format: string

-

802-11-wireless-security.psk-flags

 -

Flags indicating how to handle the "psk" property.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-11-wireless-security.wep-key-flags

 -

Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.

-

- Format: flags (NMSettingSecretFlags)

-

- Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)

-

802-11-wireless-security.wep-key-type

 -

Controls the interpretation of WEP keys. Allowed values are "key" (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or "passphrase" (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.

-

- Format: choice (NMWepKeyType)

-

- Valid values: unknown (0), key (1), passphrase (2)

-

802-11-wireless-security.wep-key0

 -

Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.

-

- Format: string

-

802-11-wireless-security.wep-key1

 -

Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

-

- Format: string

-

802-11-wireless-security.wep-key2

 -

Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

-

- Format: string

-

802-11-wireless-security.wep-key3

 -

Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.

-

- Format: string

-

802-11-wireless-security.wep-tx-keyidx

 -

When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.

-

- Format: integer

-

- Valid values: 0 - 3

-

802-11-wireless-security.wps-method

 -

Flags indicating which mode of WPS is to be used if any.

-

There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.

-

WPS can be disabled by setting this property to a value of 1.

-

- Format: flags (NMSettingWirelessSecurityWpsMethod)

-

- Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)

-
-
-
-
-

wpan setting

-

IEEE 802.15.4 (WPAN) MAC Settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - - - - - -

wpan.channel

 -

- Alias: channel

-

IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

-

- Format: integer

-

- Valid values: -32768 - 32767

-

- Special values: default (-1)

-

wpan.mac-address

 -

- Alias: mac

-

If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.

-

- Format: WPAN MAC address

-

wpan.page

 -

- Alias: page

-

IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

-

- Format: integer

-

- Valid values: -32768 - 32767

-

- Special values: default (-1)

-

wpan.pan-id

 -

- Alias: pan-id

-

IEEE 802.15.4 Personal Area Network (PAN) identifier.

-

- Format: integer

-

- Valid values: 0 - 65535

-

- Special values: unset (0xffff)

-

wpan.short-address

 -

- Alias: short-addr

-

Short IEEE 802.15.4 address to be used within a restricted environment.

-

- Format: integer

-

- Valid values: 0 - 65535

-

- Special values: unset (0xffff)

-
-
-
-
-

bond-port setting

-

Bond Port Settings.

-

- Properties: -

-
---- - - - - - - - - - - -

bond-port.prio

 -

- Alias: prio

-

The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-

bond-port.queue-id

 -

- Alias: queue-id

-

The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.

-

- Format: integer

-

- Valid values: 0 - 65535

-
-
-
-
-

hostname setting

-

Hostname settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

hostname.from-dhcp

 -

Whether the system hostname can be determined from DHCP on this connection.

-

When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

hostname.from-dns-lookup

 -

Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.

-

When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

hostname.only-from-default

 -

If set to "true" (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).

-

If set to "false" (0), the hostname can be set from this device even if it doesn't have the default route.

-

When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "false" (0).

-

- Format: ternary

-

- Valid values: true/yes/on, false/no/off, default/unknown

-

hostname.priority

 -

The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.

-

If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.

-

Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.

-

- Format: integer

-

- Valid values: -2147483648 - 2147483647

-
-
-
-
-

link setting

-

Link settings.

-

- Properties: -

-
---- - - - - - - - - - - - - - - - - - - -

link.gro-max-size

 -

The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

- Special values: default (-1)

-

link.gso-max-segments

 -

The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

- Special values: default (-1)

-

link.gso-max-size

 -

The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

- Special values: default (-1)

-

link.tx-queue-length

 -

The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.

-

- Format: integer

-

- Valid values: -1 - 4294967295

-

- Special values: default (-1)

-
-
-
-
-

loopback setting

-

Loopback Link Settings.

-

- Properties: -

-
---- - - - - -

loopback.mtu

 -

- Alias: mtu

-

If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

-

- Format: integer

-

- Special values: auto

-
-
-
-
-

veth setting

-

Veth Settings.

-

- Properties: -

-
---- - - - - -

veth.peer

 -

- Alias: peer

-

This property specifies the peer interface name of the veth. This property is mandatory.

-

- Format: string

-
-
-
-
-

Secret flag types:

-

- Each password or secret property in a setting has an associated flags property - that describes how to handle that secret. The flags property is a bitfield - that contains zero or more of the following values logically OR-ed together. -

-
    -

  • 0x0 (none) - the system is responsible for providing and storing this secret. This - may be required so that secrets are already available before the user logs in. - It also commonly means that the secret will be stored in plain text on disk, accessible - to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section - in NetworkManager.conf(5). -

    • -

  • 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing - this secret; when it is required, agents will be asked to provide it.

    • -

  • 0x2 (not-saved) - this secret should not be saved but should be requested from the user - each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, - or if the user simply does not want to save the secret.

    • -

  • 0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.

    • -
-
-
-
-

Files

-

/etc/NetworkManager/system-connections or distro plugin-specific location

-
-
-

See Also

-

nmcli(1), - nmcli-examples(7), - NetworkManager(8), - nm-settings-dbus(5), - nm-settings-keyfile(5), - NetworkManager.conf(5)

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nm-vpn-dbus-types.html b/docs/api/html/nm-vpn-dbus-types.html deleted file mode 100644 index 61ddd886..00000000 --- a/docs/api/html/nm-vpn-dbus-types.html +++ /dev/null @@ -1,560 +0,0 @@ - - - - -VPN Plugin D-Bus API Types: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

VPN Plugin D-Bus API Types

-

VPN Plugin D-Bus API Types

-
-
-

enum NMVpnServiceState

-

VPN daemon states

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_VPN_SERVICE_STATE_UNKNOWN

-

-		 -

= 0

-

-		 -

The state of the VPN plugin is unknown.

-

-		 
-

NM_VPN_SERVICE_STATE_INIT

-

-		 -

= 1

-

-		 -

The VPN plugin is initialized.

-

-		 
-

NM_VPN_SERVICE_STATE_SHUTDOWN

-

-		 -

= 2

-

-		 -

Not used.

-

-		 
-

NM_VPN_SERVICE_STATE_STARTING

-

-		 -

= 3

-

-		 -

The plugin is attempting to connect to a VPN server.

-

-		 
-

NM_VPN_SERVICE_STATE_STARTED

-

-		 -

= 4

-

-		 -

The plugin has connected to a VPN server.

-

-		 
-

NM_VPN_SERVICE_STATE_STOPPING

-

-		 -

= 5

-

-		 -

The plugin is disconnecting from the VPN server.

-

-		 
-

NM_VPN_SERVICE_STATE_STOPPED

-

-		 -

= 6

-

-		 -

The plugin has disconnected from the VPN server.

-

-		 
-
-
-
-
-

enum NMVpnConnectionState

-

VPN connection states

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_VPN_CONNECTION_STATE_UNKNOWN

-

-		 -

= 0

-

-		 -

The state of the VPN connection is unknown.

-

-		 
-

NM_VPN_CONNECTION_STATE_PREPARE

-

-		 -

= 1

-

-		 -

The VPN connection is preparing to connect.

-

-		 
-

NM_VPN_CONNECTION_STATE_NEED_AUTH

-

-		 -

= 2

-

-		 -

The VPN connection needs authorization credentials.

-

-		 
-

NM_VPN_CONNECTION_STATE_CONNECT

-

-		 -

= 3

-

-		 -

The VPN connection is being established.

-

-		 
-

NM_VPN_CONNECTION_STATE_IP_CONFIG_GET

-

-		 -

= 4

-

-		 -

The VPN connection is getting an IP address.

-

-		 
-

NM_VPN_CONNECTION_STATE_ACTIVATED

-

-		 -

= 5

-

-		 -

The VPN connection is active.

-

-		 
-

NM_VPN_CONNECTION_STATE_FAILED

-

-		 -

= 6

-

-		 -

The VPN connection failed.

-

-		 
-

NM_VPN_CONNECTION_STATE_DISCONNECTED

-

-		 -

= 7

-

-		 -

The VPN connection is disconnected.

-

-		 
-
-
-
-
-

enum NMVpnConnectionStateReason

-

VPN connection state reasons

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

NM_VPN_CONNECTION_STATE_REASON_UNKNOWN

-

-		 -

= 0

-

-		 -

The reason for the VPN connection state change is unknown.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_NONE

-

-		 -

= 1

-

-		 -

No reason was given for the VPN connection state change.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED

-

-		 -

= 2

-

-		 -

The VPN connection changed state because the user disconnected it.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED

-

-		 -

= 3

-

-		 -

The VPN connection changed state because the device it was using was disconnected.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED

-

-		 -

= 4

-

-		 -

The service providing the VPN connection was stopped.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID

-

-		 -

= 5

-

-		 -

The IP config of the VPN connection was invalid.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT

-

-		 -

= 6

-

-		 -

The connection attempt to the VPN service timed out.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT

-

-		 -

= 7

-

-		 -

A timeout occurred while starting the service providing the VPN connection.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED

-

-		 -

= 8

-

-		 -

Starting the service starting the service providing the VPN connection failed.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS

-

-		 -

= 9

-

-		 -

Necessary secrets for the VPN connection were not provided.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED

-

-		 -

= 10

-

-		 -

Authentication to the VPN server failed.

-

-		 
-

NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED

-

-		 -

= 11

-

-		 -

The connection was deleted from settings.

-

-		 
-
-
-
-
-

enum NMVpnPluginFailure

-

VPN plugin failure reasons

-

-
-

Values

-
------ - - - - - - - - - - - - - - - - - - - - -
-

NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED

-

-		 -

= 0

-

-		 -

Login failed.

-

-		 
-

NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED

-

-		 -

= 1

-

-		 -

Connect failed.

-

-		 
-

NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG

-

-		 -

= 2

-

-		 -

Invalid IP configuration returned from the VPN plugin.

-

-		 
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html deleted file mode 100644 index 1b4f30ed..00000000 --- a/docs/api/html/nmcli-examples.html +++ /dev/null @@ -1,710 +0,0 @@ - - - - -nmcli-examples: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nmcli-examples

-

nmcli-examples — usage examples of nmcli

-
-
-

Synopsis

-

nmcli [OPTIONS...]

-
-
-

Description

-

- nmcli is a command-line client for NetworkManager. It - allows controlling NetworkManager and reporting its status. For more information - please refer to nmcli(1) - manual page. -

-

- The purpose of this manual page is to provide you with various examples and - usage scenarios of nmcli. -

-
-
-

Examples

-
-

Example 1. Listing available Wi-Fi APs

-
-
$ nmcli device wifi list
-*  SSID               MODE    CHAN  RATE       SIGNAL  BARS  SECURITY
-   netdatacomm_local  Infra   6     54 Mbit/s  37      ▂▄__  WEP
-*  F1                 Infra   11    54 Mbit/s  98      ▂▄▆█  WPA1
-   LoremCorp          Infra   1     54 Mbit/s  62      ▂▄▆_  WPA2 802.1X
-   Internet           Infra   6     54 Mbit/s  29      ▂___  WPA1
-   HPB110a.F2672A     Ad-Hoc  6     54 Mbit/s  22      ▂___  --
-   Jozinet            Infra   1     54 Mbit/s  19      ▂___  WEP
-   VOIP               Infra   1     54 Mbit/s  20      ▂___  WEP
-   MARTINA            Infra   4     54 Mbit/s  32      ▂▄__  WPA2
-   N24PU1             Infra   7     11 Mbit/s  22      ▂___  --
-   alfa               Infra   1     54 Mbit/s  67      ▂▄▆_  WPA2
-   bertnet            Infra   5     54 Mbit/s  20      ▂___  WPA1 WPA2
-

- This command shows how to list available Wi-Fi networks (APs). You can also use - --fields option for displaying different columns. - nmcli -f all dev wifi list will show all of them. -

-
-
-
-

Example 2. Connect to a password-protected wifi network

-
-
$ nmcli device wifi connect "$SSID" password "$PASSWORD"
-
$ nmcli --ask device wifi connect "$SSID"
-
-
-
-

Example 3. Showing general information and properties for a Wi-Fi interface

-
-
$ nmcli -p -f general,wifi-properties device show wlan0
-===========================================================================
-                        Device details (wlan0)
-===========================================================================
-GENERAL.DEVICE:           wlan0
-GENERAL.TYPE:             wifi
-GENERAL.VENDOR:           Intel Corporation
-GENERAL.PRODUCT:          PRO/Wireless 5100 AGN [Shiloh] Network Connection
-GENERAL.DRIVER:           iwlwifi
-GENERAL.DRIVER-VERSION:   3.8.13-100.fc17.x86_64
-GENERAL.FIRMWARE-VERSION: 8.83.5.1 build 33692
-GENERAL.HWADDR:           00:1E:65:37:A1:D3
-GENERAL.MTU:              1500
-GENERAL.STATE:            100 (connected)
-GENERAL.REASON:           0 (No reason given)
-GENERAL.UDI:              /sys/devices/pci0000:00/0000:00:1c.1/net/wlan0
-GENERAL.IP-IFACE:         wlan0
-GENERAL.IS-SOFTWARE:      no
-GENERAL.NM-MANAGED:       yes
-GENERAL.AUTOCONNECT:      yes
-GENERAL.FIRMWARE-MISSING: no
-GENERAL.CONNECTION:       My Alfa WiFi
-GENERAL.CON-UUID:         85194f4c-d496-4eec-bae0-d880b4cbcf26
-GENERAL.CON-PATH:         /org/freedesktop/NetworkManager/ActiveConnection/
-10
----------------------------------------------------------------------------
-WIFI-PROPERTIES.WEP:      yes
-WIFI-PROPERTIES.WPA:      yes
-WIFI-PROPERTIES.WPA2:     yes
-WIFI-PROPERTIES.TKIP:     yes
-WIFI-PROPERTIES.CCMP:     yes
-WIFI-PROPERTIES.AP:       no
-WIFI-PROPERTIES.ADHOC:    yes
----------------------------------------------------------------------------
-

- This command shows information about a Wi-Fi device. -

-
-
-
-

Example 4. Listing NetworkManager polkit permissions

-
-
$ nmcli general permissions
-PERMISSION                                                VALUE
-org.freedesktop.NetworkManager.enable-disable-network     yes
-org.freedesktop.NetworkManager.enable-disable-wifi        yes
-org.freedesktop.NetworkManager.enable-disable-wwan        yes
-org.freedesktop.NetworkManager.enable-disable-wimax       yes
-org.freedesktop.NetworkManager.sleep-wake                 no
-org.freedesktop.NetworkManager.network-control            yes
-org.freedesktop.NetworkManager.wifi.share.protected       yes
-org.freedesktop.NetworkManager.wifi.share.open            yes
-org.freedesktop.NetworkManager.settings.modify.system     yes
-org.freedesktop.NetworkManager.settings.modify.own        yes
-org.freedesktop.NetworkManager.settings.modify.hostname   auth
-org.freedesktop.NetworkManager.settings.modify.global-dns auth
-org.freedesktop.NetworkManager.reload                     auth
-

- This command shows configured polkit permissions for various NetworkManager - operations. These permissions or actions (using polkit language) are configured - by a system administrator and are not meant to be changed by users. The usual - place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. - pkaction command can display description for polkit actions. -

-

-  pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose
-
-

- More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. -

-
-
-
-

Example 5. Listing NetworkManager log level and domains

-
-
$ nmcli general logging
-LEVEL  DOMAINS
-INFO   PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,A
-UTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC,
-WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DC
-B,DISPATCH
-

- This command shows current NetworkManager logging status. -

-
-
-
-

Example 6. Changing NetworkManager logging

-
-
$ nmcli g log level DEBUG domains CORE,ETHER,IP
-$ nmcli g log level INFO domains DEFAULT
-

- The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and - IP domains. The second command restores the default logging state. Please refer to the - NetworkManager.conf(5) manual page - for available logging levels and domains. -

-
-
-
-

Example 7. Activating a VPN connection profile requiring interactive password input

-
-
$ nmcli --ask con up my-vpn-con
-

- This command activates a VPN connection profile enabling nmcli to interact with the user - ('--ask'): this will allow nmcli to prompt for the VPN password on the command line when - the password-flags are set to '0x02' ('always ask', see - nm-settings-nmcli(5) - ). - This is particularly useful for OTP based VPNs, as the user needs to be prompted for the - password each time the connection is activated. -

-
-
-
-

Example 8. Adding a bonding controller and two port connection profiles

-
-
$ nmcli con add type bond ifname mybond0 mode active-backup
-$ nmcli con add type ethernet ifname eth1 controller mybond0
-$ nmcli con add type ethernet ifname eth2 controller mybond0
-

- This example demonstrates adding a bond controller connection and two ports. The - first command adds a controller bond connection, naming the bonding interface - mybond0 and using active-backup mode. - The next two commands add port connections, both attached as port to mybond0. - The first port will be bound to eth1 interface, the second to - eth2. -

-
-
-
-

Example 9. Adding a team controller and two port connection profiles

-
-
$ nmcli con add type team con-name Team1 ifname Team1 config team1-controller-json.conf
-$ nmcli con add type ethernet con-name Team1-port1 ifname em1 controller Team1
-$ nmcli con add type ethernet con-name Team1-port2 ifname em2 controller Team1
-

- This example demonstrates adding a team controller connection profile and two ports. It is - very similar to the bonding example. The first command adds a controller team profile, naming - the team interface and the profile Team1. The team configuration - for the controller is read from team1-controller-json.conf file. Later, you can - change the configuration with modify command - (nmcli con modify Team1 team.config team1-controller-another-json.conf). - The last two commands add port profiles, both attached as port to Team1. - The first port will be bound to the em1 interface, the second to - em2. The ports don't specify config and thus - teamd will use its default configuration. You will activate the whole setup - by activating both ports: -

-
  $ nmcli con up Team1-port1
-  $ nmcli con up Team1-port2
-

- By default, the created profiles are marked for auto-activation. But if another - connection has been activated on the device, the new profile won't activate - automatically and you need to activate it manually. -

-
-
-
-

Example 10. Adding a bridge and two port profiles

-
-
$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge
-$ nmcli con add type ethernet con-name br-port-1 ifname ens3 controller TowerBridge
-$ nmcli con add type ethernet con-name br-port-2 ifname ens4 controller TowerBridge
-$ nmcli con modify TowerBridge bridge.stp no
-

- This example demonstrates adding a bridge controller connection and two ports. The - first command adds a controller bridge connection, naming the bridge interface and - the profile as TowerBridge. - The next two commands add ports profiles, both will be attached as port to - TowerBridge. - The first port will be tied to ens3 interface, the second to - ens4. - The last command will disable 802.1D STP for the TowerBridge profile. -

-
-
-
-

Example 11. Adding an ethernet connection profile with manual IP configuration

-
-
$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \
-  ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe
-$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"
-$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4
-$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"
-$ nmcli -p con show my-con-em1
-

- The first command adds an Ethernet connection profile named my-con-em1 - that is bound to interface name em1. The profile is configured - with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. - The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). - Gateway entry will become the default route if this profile is activated on em1 interface - (and there is no connection with higher priority). The next two addresses do not - specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. - The second, third and fourth commands modify DNS parameters of the new connection profile. - The last con show command displays the profile so that all - parameters can be reviewed. -

-
-
-
-

Example 12. Convenient field values retrieval for scripting

-
-
$ nmcli -g ip4.address connection show my-con-eth0
-192.168.1.12/24
-
$ nmcli -g ip4.address,ip4.dns connection show my-con-eth0
-192.168.1.12/24
-192.168.1.1
-
$ nmcli -g ip4 connection show my-con-eth0
-IP4:192.168.1.12/24:192.168.1.1::192.168.1.1::
-

- This example shows retrieval of ip4 connection field values via the --get-values - option. Multiple comma separated fields can be provided: they will be printed one - per line. If a whole section is provided instead of a single field, the name of the - section will be printed followed by all the related field values on the same line. - See also --terse, --mode, --fields and --escape options in nmcli(1) - manual page for more customized output. -

-
-
-
-

Example 13. Adding an Ethernet connection and configuring SR-IOV VFs

-
-
$ nmcli con add type ethernet con-name EthernetPF ifname em1
-$ nmcli con modify EthernetPF sriov.total-vfs 3 sriov.autoprobe-drivers false
-$ nmcli con modify EthernetPF sriov.vfs '0 mac=00:11:22:33:44:55 vlans=10, 1 trust=true spoof-check=false'
-$ nmcli con modify EthernetPF +sriov.vfs '2 max-tx-rate=20'
-

- This example demonstrates adding an Ethernet connection for - physical function (PF) ens4 and - configuring 3 SR-IOV virtual functions (VFs) on it. The first - VF is configured with MAC address 00:11:22:33:44:55 and VLAN - 10, the second one has the trust and - spoof-check features respectively enabled - and disabled. VF number 2 has a maximum transmission rate of - 20Mbps. The kernel is instructed to not automatically - instantiate a network interface for the VFs. -

-
-
-
-

Example 14. Escaping colon characters in tabular mode

-
-
$ nmcli -t -f general -e yes -m tab dev show eth0
-GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:
-e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reas
-on given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no:
-ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkMa
-nager/ActiveConnection/9
-

- This example shows escaping colon characters in tabular mode. It may be - useful for script processing, because ':' is used as a field separator. -

-
-
-
-

Example 15. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive

-
-
-#!/bin/bash
-export LC_ALL=C
-
-enable_disable_wifi ()
-{
-    result=$(nmcli dev | grep "ethernet" | grep -w "connected")
-    if [ -n "$result" ]; then
-        nmcli radio wifi off
-    else
-        nmcli radio wifi on
-    fi
-}
-
-if [ "$2" = "up" ]; then
-    enable_disable_wifi
-fi
-
-if [ "$2" = "down" ]; then
-    enable_disable_wifi
-fi
-
-

- This dispatcher script makes Wi-Fi mutually exclusive with wired - networking. When a wired interface is connected, Wi-Fi will be set - to airplane mode (rfkilled). When the wired interface is disconnected, - Wi-Fi will be turned back on. - Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ - directory. - See NetworkManager(8) - manual page for more information about NetworkManager dispatcher scripts. -

-
-
-

Example sessions of interactive connection editor

-
-

Example 16. Adding an ethernet connection profile in interactive editor (a)

-
-
$ nmcli connection edit type ethernet
-
-===| nmcli interactive connection editor |===
-
-Adding a new '802-3-ethernet' connection
-
-Type 'help' or '?' for available commands.
-Type 'describe [<setting>.<prop>]' for detailed property description.
-
-You may edit the following settings: connection, 802-3-ethernet (ethernet),
-802-1x, ipv4, ipv6, dcb
-nmcli> print
-===========================================================================
-                          Connection details
-===========================================================================
-connection.id:                      ethernet-4
-connection.uuid:                    de89cdeb-a3e1-4d53-8fa0-c22546c775f4
-connection.interface-name:          --
-connection.type:                    802-3-ethernet
-connection.autoconnect:             yes
-connection.autoconnect-priority:    0
-connection.timestamp:               0
-connection.read-only:               no
-connection.permissions:
-connection.zone:                    --
-connection.controller:              --
-connection.port-type:               --
-connection.secondaries:
-connection.gateway-ping-timeout:    0
----------------------------------------------------------------------------
-802-3-ethernet.port:                --
-802-3-ethernet.speed:               0
-802-3-ethernet.duplex:              --
-802-3-ethernet.auto-negotiate:      yes
-802-3-ethernet.mac-address:         --
-802-3-ethernet.cloned-mac-address:  --
-802-3-ethernet.mac-address-blacklist:
-802-3-ethernet.mtu:                 auto
-802-3-ethernet.s390-subchannels:
-802-3-ethernet.s390-nettype:        --
-802-3-ethernet.s390-options:
----------------------------------------------------------------------------
-ipv4.method:                        auto
-ipv4.dns:
-ipv4.dns-search:
-ipv4.addresses:
-ipv4.gateway:                       --
-ipv4.routes:
-ipv4.route-metric:                  -1
-ipv4.ignore-auto-routes:            no
-ipv4.ignore-auto-dns:               no
-ipv4.dhcp-client-id:                --
-ipv4.dhcp-send-hostname:            yes
-ipv4.dhcp-hostname:                 --
-ipv4.never-default:                 no
-ipv4.may-fail:                      yes
----------------------------------------------------------------------------
-ipv6.method:                        auto
-ipv6.dns:
-ipv6.dns-search:
-ipv6.addresses:
-ipv6.gateway:                       --
-ipv6.routes:
-ipv6.route-metric:                  -1
-ipv6.ignore-auto-routes:            no
-ipv6.ignore-auto-dns:               no
-ipv6.never-default:                 no
-ipv6.may-fail:                      yes
-ipv6.ip6-privacy:                   -1 (unknown)
-ipv6.dhcp-hostname:                 --
----------------------------------------------------------------------------
-nmcli> goto ethernet
-You may edit the following properties: port, speed, duplex, auto-negotiate,
- mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchann
-els, s390-nettype, s390-options
-nmcli 802-3-ethernet> set mtu 1492
-nmcli 802-3-ethernet> b
-nmcli> goto ipv4.addresses
-nmcli ipv4.addresses> desc
-
-=== [addresses] ===
-[NM property description]
-Array of IP addresses.
-
-[nmcli specific description]
-Enter a list of IPv4 addresses formatted as:
-  ip[/prefix], ip[/prefix],...
-Missing prefix is regarded as prefix of 32.
-
-Example: 192.168.1.5/24, 10.0.0.11/24
-
-nmcli ipv4.addresses> set 192.168.1.100/24
-Do you also want to set 'ipv4.method' to 'manual'? [yes]: yes
-nmcli ipv4.addresses>
-nmcli ipv4.addresses> print
-addresses: 192.168.1.100/24
-nmcli ipv4.addresses> back
-nmcli ipv4> b
-nmcli> set ipv4.gateway 192.168.1.1
-nmcli> verify
-Verify connection: OK
-nmcli> print
-===========================================================================
-                          Connection details
-===========================================================================
-connection.id:                      ethernet-4
-connection.uuid:                    de89cdeb-a3e1-4d53-8fa0-c22546c775f4
-connection.interface-name:          --
-connection.type:                    802-3-ethernet
-connection.autoconnect:             yes
-connection.autoconnect-priority:    0
-connection.timestamp:               0
-connection.read-only:               no
-connection.permissions:
-connection.zone:                    --
-connection.controller:              --
-connection.port-type:               --
-connection.secondaries:
-connection.gateway-ping-timeout:    0
----------------------------------------------------------------------------
-802-3-ethernet.port:                --
-802-3-ethernet.speed:               0
-802-3-ethernet.duplex:              --
-802-3-ethernet.auto-negotiate:      yes
-802-3-ethernet.mac-address:         --
-802-3-ethernet.cloned-mac-address:  --
-802-3-ethernet.mac-address-blacklist:
-802-3-ethernet.mtu:                 1492
-802-3-ethernet.s390-subchannels:
-802-3-ethernet.s390-nettype:        --
-802-3-ethernet.s390-options:
----------------------------------------------------------------------------
-ipv4.method:                        manual
-ipv4.dns:
-ipv4.dns-search:
-ipv4.addresses:                     192.168.1.100/24
-ipv4.gateway:                       192.168.1.1
-ipv4.routes:
-ipv4.route-metric:                  -1
-ipv4.ignore-auto-routes:            no
-ipv4.ignore-auto-dns:               no
-ipv4.dhcp-client-id:                --
-ipv4.dhcp-send-hostname:            yes
-ipv4.dhcp-hostname:                 --
-ipv4.never-default:                 no
-ipv4.may-fail:                      yes
----------------------------------------------------------------------------
-ipv6.method:                        auto
-ipv6.dns:
-ipv6.dns-search:
-ipv6.addresses:
-ipv6.routes:
-ipv6.route-metric:                  -1
-ipv6.ignore-auto-routes:            no
-ipv6.ignore-auto-dns:               no
-ipv6.never-default:                 no
-ipv6.may-fail:                      yes
-ipv6.ip6-privacy:                   -1 (unknown)
-ipv6.dhcp-hostname:                 --
----------------------------------------------------------------------------
-nmcli> set ipv4.dns 8.8.8.8 8.8.4.4
-nmcli> print
-===========================================================================
-                          Connection details
-===========================================================================
-connection.id:                      ethernet-4
-connection.uuid:                    de89cdeb-a3e1-4d53-8fa0-c22546c775f4
-connection.interface-name:          --
-connection.type:                    802-3-ethernet
-connection.autoconnect:             yes
-connection.autoconnect-priority:    0
-connection.timestamp:               0
-connection.read-only:               no
-connection.permissions:
-connection.zone:                    --
-connection.controller:              --
-connection.port-type:               --
-connection.secondaries:
-connection.gateway-ping-timeout:    0
----------------------------------------------------------------------------
-802-3-ethernet.port:                --
-802-3-ethernet.speed:               0
-802-3-ethernet.duplex:              --
-802-3-ethernet.auto-negotiate:      yes
-802-3-ethernet.mac-address:         --
-802-3-ethernet.cloned-mac-address:  --
-802-3-ethernet.mac-address-blacklist:
-802-3-ethernet.mtu:                 1492
-802-3-ethernet.s390-subchannels:
-802-3-ethernet.s390-nettype:        --
-802-3-ethernet.s390-options:
----------------------------------------------------------------------------
-ipv4.method:                        manual
-ipv4.dns:                           8.8.8.8,8.8.4.4
-ipv4.dns-search:
-ipv4.addresses:                     192.168.1.100/24
-ipv4.gateway:                       192.168.1.1
-ipv4.routes:
-ipv4.route-metric:                  -1
-ipv4.ignore-auto-routes:            no
-ipv4.ignore-auto-dns:               no
-ipv4.dhcp-client-id:                --
-ipv4.dhcp-send-hostname:            yes
-ipv4.dhcp-hostname:                 --
-ipv4.never-default:                 no
-ipv4.may-fail:                      yes
----------------------------------------------------------------------------
-ipv6.method:                        auto
-ipv6.dns:
-ipv6.dns-search:
-ipv6.addresses:
-ipv6.gateway:                       --
-ipv6.routes:
-ipv6.route-metric:                  -1
-ipv6.ignore-auto-routes:            no
-ipv6.ignore-auto-dns:               no
-ipv6.never-default:                 no
-ipv6.may-fail:                      yes
-ipv6.ip6-privacy:                   -1 (unknown)
-ipv6.dhcp-hostname:                 --
----------------------------------------------------------------------------
-nmcli> verify
-Verify connection: OK
-nmcli> save
-Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully
- saved.
-nmcli> quit
-

- Example session in the nmcli interactive connection editor. - The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). -

-
-
-
-

Example 17. Bluetooth connection profiles

-
-

NetworkManger supports both connecting to NAP and DUN devices as a client. It also - supports sharing the network via a NAP server. -

-

For NAP client connections, NetworkManager automatically creates a suitable in-memory profile - for paired devices if none is available. You may use that generated profile directly, but you may also modify - and persist it, which will prevent to automatically re-create it. You may also create a profile from scratch. - For example, the following uses DHCP and IPv6 autoconf for address configuration: -

-
$ nmcli connection add type bluetooth con-name "Profile for My Bluetooth Device (NAP)" autoconnect no bluetooth.type panu bluetooth.bdaddr "$BDADDR"
-

For DUN connections, the user needs to configure modem settings and hence no profile - gets created automatically. The modem settings depend on your device and you either need - a "gsm" or a "csma" section. For example, -

-
$ nmcli connection add type bluetooth con-name "Profile for My Bluetooth Device (DUN)" autoconnect no bluetooth.type dun bluetooth.bdaddr "$BDADDR" gsm.apn apn.com
-

Finally, you can create a bluetooth hotspot. BlueZ implements those as a bridge device, - so such profiles also have a bridge section. Also, you probably want to set IP methods as "shared", - so that clients get automatic IP addressing. Note that the "shared" IPv4 method requires dnsmasq to be available. -

-
$ nmcli connection add type bluetooth con-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth.type nap ipv4.method shared ipv6.method shared
-
-
-
-

Example 18. Offline use

-
-
$ nmcli --offline con add type ethernet '
-  conn.id eth0 \
-  conn.interface-name eth0 \
-  >/sysroot/etc/NetworkManager/system-connections/eth0.nmconnection
-

- Creates a connection file in keyfile format without using the NetworkManager service. - This allows for use of familiar nmcli syntax in situations - where the service is not running, such as during system installation of image - provisioning and ensures the resulting file is correctly formatted. -

-
$ nmcli --offline con modify type ethernet '
-  conn.id eth0-ipv6 \
-  ipv4.method disabled \
-  </sysroot/etc/NetworkManager/system-connections/eth0.nmconnection \
-  >/sysroot/etc/NetworkManager/system-connections/eth0-ipv6.nmconnection
-

- Read and write a connection file without using the NetworkManager service, modifying - some properties along the way. -

-

- This allows templating of the connection profiles using familiar - nmcli syntax in situations where the service is not running. -

-
-
-
-

Example 19. Device Checkpoint and Restore

-
-
$ nmcli dev checkpoint eth0 -- nmcli dev dis eth0
-Device 'eth0' successfully disconnected.
-Type "Yes" to commit the changes: No
-Checkpoint was removed.
-

- In this example the device eth0 was disconnected with the eth0 checkpoint - taken. The user didn't confirm that the change is good, so the eth0 was - brought back to the state it was when the checkpoint was taken. -

-

- If the command being run unintentionaly brings down the remote connection - (such as a - ssh(1) - session) to the very machine it's being run on, the user wouldn't be able to - confirm the success and the connectivity would end up being restored - after a timeout. -

-

- If, on the other hand, the command results in a success, the user could just - confirm, causing the checkpoint to be abandoned without a rollback: -

-
$ nmcli dev checkpoint -- ip link del br0
-Type "Yes" to commit the changes: Yes
-
-
-
-
-
-

See Also

-

- nmcli(1), - NetworkManager(8), - NetworkManager.conf(5), - nm-settings-nmcli(5), - nm-online(1), - nm-applet(1), - nm-connection-editor(1) -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html deleted file mode 100644 index 0139ed6d..00000000 --- a/docs/api/html/nmcli.html +++ /dev/null @@ -1,1914 +0,0 @@ - - - - -nmcli: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nmcli

-

nmcli — command-line tool for controlling NetworkManager

-
-
-

Synopsis

-

nmcli [OPTIONS...] { help | general | networking | radio | connection | device | agent | monitor } [COMMAND] [ARGUMENTS...]

-
-
-

Description

-

nmcli is a command-line tool for controlling - NetworkManager and reporting network status. It can be utilized as a - replacement for nm-applet or other graphical clients. - nmcli is used to create, display, edit, delete, activate, - and deactivate network connections, as well as control and display network - device status. See - nmcli-examples(7) - for ready to run nmcli examples.

-

Typical uses include:

-
    -

  • Scripts: Utilize NetworkManager via nmcli instead of - managing network connections manually. nmcli supports a - terse output format which is better suited for script processing. Note that - NetworkManager can also execute scripts, called "dispatcher scripts", in - response to network events. See - NetworkManager(8) - for details about these dispatcher scripts.

    • -

  • Servers, headless machines, and terminals: nmcli can - be used to control NetworkManager without a GUI, including creating, editing, - starting and stopping network connections and viewing network status.

    • -
-
-
-

Options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-a | --ask

When using this option nmcli will stop and ask for any - missing required arguments, so do not use this option for non-interactive - purposes like scripts. This option controls, for example, whether you will be - prompted for a password if it is required for connecting to a network.

-c | --colors { yes | no | auto }

-

This option controls color output (using terminal escape sequences). - yes enables colors, no disables them, - auto only produces colors when standard output is directed - to a terminal. The default value is auto.

-

The actual colors used are configured as described in - terminal-colors.d(5). - Please refer to the Colors section for a - list of color names supported by nmcli.

-

If the environment variable NO_COLOR is set (to any non-empty value), - then coloring is disabled with mode "auto". If the environment variable CLICOLOR_FORCE - is set (to any non-empty value), then coloring is enabled with mode "auto". Explicitly enabling coloring overrides - the environment variable.

-

--complete-args

-

Instead of conducting the desired action, nmcli - will list possible completions for the last argument. This is useful to implement - argument completion in shell.

-

The exit status will indicate success - or return a code 65 to indicate the last argument is a file name.

-

NetworkManager ships with command completion support for GNU Bash.

-

-e | --escape { yes | no }

-

Whether to escape : and \ characters in terse tabular mode. The - escape character is \.

-

If omitted, default is yes.

-

-f | --fields { field1,field2... | all | common }

-

This option is used to specify what fields (column names) should be - printed. Valid field names differ for specific commands. List available fields - by providing an invalid value to the --fields option. - all is used to print all valid field values of the - command. common is used to print common field values of - the command.

-

If omitted, default is common.

-

-g | --get-values { field1,field2... | all | common }

-

This option is used to print values from specific fields. It is basically - a shortcut for --mode tabular --terse --fields and is a convenient - way to retrieve values for particular fields. The values are printed one per line - without headers.

-

If a section is specified instead of a field, the section name will be printed - followed by colon separated values of the fields belonging to that section, all on - the same line.

-

-h | --help

Print help information.

-m | --mode { tabular | multiline }

-

Switch between tabular and multiline output:

-
---- - - - - - - - - - - -

tabular

Output is a table where each line describes a single entry. - Columns define particular properties of the entry.

multiline

Each entry comprises multiple lines, each property on its - own line. The values are prefixed with the property name.

-

If omitted, default is tabular for most commands. - For the commands producing more structured information, that cannot be - displayed on a single line, default is multiline. - Currently, they are:

-
    -

  • nmcli connection show ID

    • -

  • nmcli device show

    • -
-

-p | --pretty

Output is pretty. This causes nmcli to produce easily - readable outputs for humans, i.e. values are aligned, headers are printed, - etc.

-s | --show-secrets

When using this option nmcli will display passwords - and secrets that might be present in an output of an operation. This option - also influences echoing passwords typed by user as an input.

-t | --terse

Output is terse. This mode is designed and suitable for computer (script) - processing.

--offline

-

Work without a daemon. Makes connection add and - connection modify commands accept and produce connection - data via standard input/output. Ordinarily, nmcli would communicate with - the NetworkManager service.

-

The connection data format (keyfile) is described in - nm-settings-keyfile(5) - manual.

-

-v | --version

Show nmcli version.

-w | --wait - seconds -

-

This option sets a timeout period for which nmcli will - wait for NetworkManager to finish operations. It is - especially useful for commands that may take a longer time to complete, e.g. - connection activation.

-

Specifying a value of 0 instructs - nmcli not to wait but to exit immediately with a status of - success. The default value depends on the executed command.

-
-
-
-

General Commands

-

nmcli general { status | hostname | permissions | logging | reload } [ARGUMENTS...]

-

Use this command to show NetworkManager status and permissions. You can also get - and change system hostname, as well as NetworkManager logging level and domains.

-
---- - - - - - - - - - - - - - - - - - - - - - - -

status

Show overall status of NetworkManager. This is the default action, when - no additional command is provided for nmcli general.

- hostname - [hostname] -

-

Get and change system hostname. With no arguments, this prints currently - configured hostname. When you pass a hostname, it will be handed over to - NetworkManager to be set as a new system hostname.

-

Note that the term "system" hostname may also be referred to as - "persistent" or "static" by other programs or tools. The hostname is stored - in /etc/hostname file in most distributions. For example, - systemd-hostnamed service uses the term "static" hostname and it only reads - the /etc/hostname file when it starts.

-

permissions

Show the permissions a caller has for various authenticated operations - that NetworkManager provides, like enable and disable networking, changing - Wi-Fi and WWAN state, modifying connections, etc.

- logging - [level level] - [domains domains...] -

Get and change NetworkManager logging level and - domains. Without any argument current logging level and domains are shown. In - order to change logging state, provide level and, or, - domain parameters. See - NetworkManager.conf(5) - for available level and domain values.

- reload - [flags...] -

-

- Reload NetworkManager's configuration and perform certain - updates, like flushing caches or rewriting external state to - disk. This is similar to sending SIGHUP to NetworkManager - but it allows for more fine-grained control over what to - reload through the flags argument. It also allows non-root - access via PolicyKit and contrary to signals it is - synchronous. Available flags are: -

-
---- - - - - - - - - - - - - - - -

conf

- Reload the NetworkManager.conf configuration from - disk. Note that this does not include connections, which - can be reloaded through nmcli connection - reload instead. -

dns-rc

- Update DNS configuration, which usually involves writing - /etc/resolv.conf anew. This is equivalent to sending the - SIGUSR1 signal to the NetworkManager process. -

dns-full

- Restart the DNS plugin. This is for example useful when - using dnsmasq plugin, which uses additional - configuration in - /etc/NetworkManager/dnsmasq.d. If - you edit those files, you can restart the DNS - plugin. This action shortly interrupts name resolution. -

-

- With no flags, everything that is supported is reloaded, - which is identical to sending a SIGHUP. See - NetworkManager(8) - for more details about signals. -

-
-
-
-

Networking Control Commands

-

nmcli networking { on | off | connectivity } [ARGUMENTS...]

-

Query NetworkManager networking status, enable and disable networking. -

-
---- - - - - - - - - - - -

on, off

Enable or disable networking control by NetworkManager. - All interfaces managed by NetworkManager are deactivated when networking - is disabled.

- connectivity - [check] -

-

Get network connectivity state. The optional check - argument tells NetworkManager to re-check the connectivity, else the most - recent known connectivity state is displayed without re-checking.

-

Possible states are:

-
---- - - - - - - - - - - - - - - - - - - - - - - -

none

the host is not connected to any network.

portal

the host is behind a captive portal and cannot reach the full Internet.

limited

the host is connected to a network, but it has no access to the Internet.

full

the host is connected to a network and has full access to the Internet.

unknown

the connectivity status cannot be found out.

-
-
-
-

Radio Transmission Control Commands

-

nmcli radio { all | wifi | wwan } [ARGUMENTS...]

-

Show radio switches status, or enable and disable the switches.

-
---- - - - - - - - - - - - - - - -

- wifi - [ on | off ] -

Show or set status of Wi-Fi in NetworkManager. If no arguments are - supplied, Wi-Fi status is printed; on enables Wi-Fi; - off disables Wi-Fi.

- wwan - [ on | off ] -

Show or set status of WWAN (mobile broadband) in NetworkManager. If no - arguments are supplied, mobile broadband status is printed; - on enables mobile broadband, off - disables it.

- all - [ on | off ] -

Show or set all previously mentioned radio switches at the same time.

-
-
-

Activity Monitor

-

nmcli monitor

-

Observe NetworkManager activity. Watches for changes - in connectivity state, devices or connection profiles.

-

See also nmcli connection monitor - and nmcli device monitor to watch - for changes in certain devices or connections.

-
-
-

Connection Management Commands

-

nmcli connection { show | up | down | modify | add | edit | clone | delete | monitor | reload | load | import | export | migrate } [ARGUMENTS...]

-

NetworkManager stores all network configuration as "connections", - which are collections of data (Layer2 details, IP addressing, etc.) that - describe how to create or connect to a network. A connection is "active" - when a device uses that connection's configuration to create or connect to - a network. There may be multiple connections that apply to a device, but only - one of them can be active on that device at any given time. The additional - connections can be used to allow quick switching between different networks - and configurations.

-

Consider a machine which is usually connected to a DHCP-enabled network, - but sometimes connected to a testing network which uses static IP addressing. - Instead of manually reconfiguring eth0 each time the network is changed, the - settings can be saved as two connections which both apply to eth0, one for DHCP - (called default) and one with the static addressing details (called - testing). When connected to the DHCP-enabled network the user would run - nmcli con up default , and when connected to the static network the user - would run nmcli con up testing.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- show - [--active] - [ - --order - [+-]category:... - ] -

-

List in-memory and on-disk connection profiles, some of which may also be - active if a device is using that connection profile. Without a parameter, all - profiles are listed. When --active option is specified, only - the active profiles are shown.

-

The --order option can be used to get custom - ordering of connections. The connections can be ordered by active status - (active), name (name), type - (type) or D-Bus path (path). If - connections are equal according to a sort order category, an additional - category can be specified. The default sorting order is equivalent to - --order active:name:path. + or no - prefix means sorting in ascending order (alphabetically or in numbers), - - means reverse (descending) order. The category names - can be abbreviated (e.g. --order -a:na).

-

- show - [--active] - [ id | uuid | path | apath ] - ID... -

-

Show details for specified connections. By default, both static - configuration and active connection data are displayed. When - --active option is specified, only the active profiles are - taken into account. Use global --show-secrets option to - display secrets associated with the profile.

-

id, uuid, - path and apath keywords can be used - if ID is ambiguous. Optional - ID-specifying keywords are:

-
---- - - - - - - - - - - - - - - - - - - -

id

the ID denotes a connection name.

uuid

the ID denotes a connection UUID.

path

the ID denotes a D-Bus - static connection path in the format of - /org/freedesktop/NetworkManager/Settings/num - or just num.

apath

the ID denotes a D-Bus active connection path in the format of - /org/freedesktop/NetworkManager/ActiveConnection/num or just - num.

-

It is possible to filter the output using the global - --fields option. Use the following values:

-
---- - - - - - - - - - - -

profile

only shows static profile configuration.

active

only shows active connection data (when the profile is active).

-

You can also specify particular fields. For static configuration, use - setting and property names as described in - nm-settings-nmcli(5) manual page. For active data use GENERAL, IP4, DHCP4, IP6, - DHCP6, VPN.

-

When no command is given to the nmcli connection, - the default action is nmcli connection show.

-

- up - [ id | uuid | path ] - ID - [ifname ifname] - [ap BSSID] - [passwd-file file] -

-

Activate a connection. The connection is identified by its name, UUID or - D-Bus path. If ID is ambiguous, a keyword id, - uuid or path can be used. When - requiring a particular device to activate the connection on, the - ifname option with interface name should be given. If the - ID is not given an ifname is required, and - NetworkManager will activate the best available connection for the given - ifname. In case of a VPN connection, the - ifname option specifies the device of the base connection. - The ap option specify what particular AP should be used in - case of a Wi-Fi connection.

-

If --wait option is not specified, the default timeout will be 90 - seconds.

-

See connection show above for the description of the - ID-specifying keywords.

-

Available options are:

-
---- - - - - - - - - - - - - - - -

ifname

interface that will be used for activation.

ap

BSSID of the AP which the command should connect to (for Wi-Fi connections).

passwd-file

 -

some networks may require credentials during activation. You can give - these credentials using this option. Each line of the file should contain one - password in the form: - -

-
setting_name.property_name:the password
-

- - For example, for WPA Wi-Fi with PSK, the line would be - -

-
802-11-wireless-security.psk:secret12345
-

- - For 802.1X password, the line would be - -

-
802-1x.password:my 1X password
-

- - nmcli also accepts wifi-sec and wifi strings instead of - 802-11-wireless-security. When NetworkManager requires a password and it is - not given, nmcli will ask for it when run with --ask. - If --ask was not passed, NetworkManager can ask another secret - agent that may be running (typically a GUI secret agent, such as nm-applet or - gnome-shell).

-
-

- down - [ id | uuid | path | apath ] - ID... -

-

Deactivate a connection from a device without preventing the device from - further auto-activation. Multiple connections can be passed to the - command.

-

Be aware that this command deactivates the specified active connection, - but the device on which the connection was active, is still ready to connect - and will perform auto-activation by looking for a suitable connection that has - the 'autoconnect' flag set. Note that the deactivating connection profile is - internally blocked from autoconnecting again. Hence it will not autoconnect - until reboot or until the user performs an action that unblocks autoconnect, - like modifying the profile or explicitly activating it.

-

In most cases you may want to use device down - command instead.

-

The connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword id, - uuid, path or - apath can be used.

-

See connection show above for the description of - the ID-specifying keywords.

-

If --wait option is not specified, the default timeout - will be 10 seconds.

-

- modify - [--temporary] - [ id | uuid | path ] - [ID] - - { option value | [+|-]setting.property value } - ... -

-

Add, modify or remove properties in the connection profile.

-

To set the property just specify the property name followed by the - value. An empty value ("") resets the property value to - the default.

-

See nm-settings-nmcli(5) for complete reference of setting and property names, their descriptions - and default values. The setting and - property can be abbreviated provided they are unique.

-

If you want to append an item or a flag to the existing value, use - + prefix for the property name or alias. If you want to - remove items from a container-type or flag property, use - prefix. - For certain properties you can also remove elements by specifying the zero-based - index(es). - The + and - modifiers - only have a real effect for properties that support them. - These are for example multi-value (container) properties or flags like ipv4.dns, - ip4, ipv4.addresses, bond.options, - 802-1x.phase1-auth-flags etc.

-

The connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword id, - uuid or path can be used. - The ID is not used with the global - --offline option.

-

When the global --offline is used, the - command reads the connection from the standard input and prints the - modified connection to standard output instead of making the - the NetworkManager daemon act upon specified connection.

-

- modify - [--temporary] - [ id | uuid | path ] - ID - remove setting -

Removes a setting from the connection profile.

- add - [save { yes | no }] - - { option value | [+|-]setting.property value } - ... -

-

Create a new connection using specified properties.

-

You need to describe the newly created connections with the property and value pairs. - See nm-settings-nmcli(5) for the complete reference. The syntax is - the same as of the nmcli connection modify command.

-

To construct a meaningful connection you at the very least need to set the - connection.type property (or use the type alias) - to one of known NetworkManager connection types:

-
    -

  • 6lowpan

    • -

  • 802-11-olpc-mesh (alias olpc-mesh)

    • -

  • 802-11-wireless (alias wifi)

    • -

  • 802-3-ethernet (alias ethernet)

    • -

  • adsl

    • -

  • bluetooth

    • -

  • bond

    • -

  • bond-slave (deprecated for ethernet with controller)

    • -

  • bridge

    • -

  • bridge-slave (deprecated for ethernet with controller)

    • -

  • cdma

    • -

  • dummy

    • -

  • generic

    • -

  • gsm

    • -

  • infiniband

    • -

  • ip-tunnel

    • -

  • macsec

    • -

  • macvlan

    • -

  • olpc-mesh

    • -

  • ovs-bridge

    • -

  • ovs-dpdk

    • -

  • ovs-interface

    • -

  • ovs-patch

    • -

  • ovs-port

    • -

  • pppoe

    • -

  • team

    • -

  • team-slave (deprecated for ethernet with controller)

    • -

  • tun

    • -

  • veth

    • -

  • vlan

    • -

  • vpn

    • -

  • vrf

    • -

  • vxlan

    • -

  • wifi-p2p

    • -

  • wimax

    • -

  • wireguard

    • -

  • wpan

    • -
-

The most typical uses are described in the Examples section.

-

Aside from the properties and values two special options are accepted:

-
---- - - - - - - - - - - -

save

Controls whether the connection should be persistent, i.e. NetworkManager should - store it on disk (default: yes).

--

If a single -- argument is encountered it is ignored. - This is for compatibility with older versions on nmcli.

-

When the global --offline is used, the - command prints the resulting connection to standard output instead of - actually adding the connection via the NetworkManager daemon.

-

- edit - { - [ id | uuid | path ] - ID - | - [type type] - [con-name name] - } -

-

Edit an existing connection or add a new one, using an interactive editor.

-

The existing connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword id, - uuid, or path can be used. See - connection show above for the description of the - ID-specifying keywords. Not providing an - ID means that a new connection will be added.

-

The interactive editor will guide you through the connection editing and - allow you to change connection parameters according to your needs by means of - a simple menu-driven interface. The editor indicates what settings and - properties can be modified and provides in-line help.

-

Available options:

-
---- - - - - - - - - - - -

type

type of the new connection; valid types are the same as for - connection add command.

con-name

name for the new connection. It can be changed later in the editor.

-

See also - nm-settings-nmcli(5) for all NetworkManager settings and property names, and their - descriptions; and - nmcli-examples(7) - for sample editor sessions.

-

- clone - [--temporary] - [ id | uuid | path ] - ID - new_name -

-

Clone a connection. The connection to be cloned is identified by its - name, UUID or D-Bus path. If ID is ambiguous, a keyword - id, uuid or path - can be used. See connection show above for the description - of the ID-specifying keywords. new_name is - the name of the new cloned connection. The new connection will be the exact - copy except the connection.id (new_name) and - connection.uuid (generated) properties.

-

The new connection profile will be saved as persistent unless - --temporary option is specified, in which case the new profile - won't exist after NetworkManager restart.

-

- delete - [ id | uuid | path ] - ID... -

-

Delete a configured connection. The connection to be deleted is - identified by its name, UUID or D-Bus path. If ID is ambiguous, a - keyword id, uuid or path can be used. - See connection show above for the description of - the ID-specifying keywords.

-

If --wait option is not specified, the default timeout will be 10 - seconds.

-

- monitor - [ id | uuid | path ] - ID... -

-

Monitor connection profile activity. This command prints a line whenever - the specified connection changes. The connection to be monitored is identified - by its name, UUID or D-Bus path. If ID is ambiguous, a keyword - id, uuid or path - can be used. See connection show above for the description of the - ID-specifying keywords.

-

Monitors all connection profiles in case none is specified. The command - terminates when all monitored connections disappear. If you want to monitor - connection creation consider using the global monitor with nmcli - monitor command.

-

- reload -

Reload all connection files from disk. - NetworkManager does not monitor changes to connection. - So you need to use this command in order to tell - NetworkManager to re-read the connection profiles from - disk when a change was made to them. -

- load - filename... -

Load/reload one or more connection files from disk. Use this after - manually editing a connection file to ensure that - NetworkManager is aware of its latest state.

- import - [--temporary] - type type - file file -

-

Import an external/foreign configuration as a NetworkManager connection - profile. The type of the input file is specified by type - option.

-

Only VPN configurations are supported at the moment. The configuration is - imported by NetworkManager VPN plugins. type values are - the same as for vpn-type option in nmcli - connection add. VPN configurations are imported by VPN plugins. - Therefore the proper VPN plugin has to be installed so that nmcli could import - the data.

-

The imported connection profile will be saved as persistent unless - --temporary option is specified, in which case the new profile - won't exist after NetworkManager restart.

-

- export - [ id | uuid | path ] - ID - [file] -

-

Export a connection.

-

Only VPN connections are supported at the moment. A proper VPN plugin has - to be installed so that nmcli could export a connection. If no - file is provided, the VPN configuration - data will be printed to standard output.

-

- migrate - [ - --plugin - plugin... - ] - [ id | uuid | path ] - [ID...] -

-

Migrate connection profiles to a different settings plugin, such - as keyfile (default) or ifcfg-rh.

-

The connection to be migrated is identified by its name, UUID or D-Bus path. - If ID is ambiguous, a keyword id, - uuid or path can be used. See connection - show above for the description of the - ID-specifying keywords.

-

If no connections are specified, the command acts on all available - connections. Therefore, with no arguments, the command migrates all connection - profiles to the keyfile plugin.

-

If --wait option is not specified, the default timeout will be 10 - seconds.

-
-
-
-

Device Management Commands

-

nmcli device { status | show | set | up | connect | reapply | modify | down | disconnect | delete | monitor | wifi | lldp | checkpoint } [ARGUMENTS...]

-

Show and manage network interfaces.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

status

 -

Print status of devices.

-

This is the default action if no command is specified to - nmcli device.

-

- show - [ifname] -

Show detailed information about devices. Without an argument, all - devices are examined. To get information for a specific device, the interface - name has to be provided.

- set - [ifname] - ifname - [ - autoconnect - { yes | no } - ] - [ - managed - { yes | no } - ] -

Set device properties.

- up - ifname -

-

Connect the device. NetworkManager will try to find a suitable connection - that will be activated. It will also consider connections that are not set to - auto connect.

-

If no compatible connection exists, a new profile with default - settings will be created and activated. This differentiates - nmcli connection up ifname "$DEVICE" from - nmcli device up "$DEVICE"

-

If --wait option is not specified, the default timeout will be 90 - seconds.

-

- connect - ifname -

Alias for command up. Before version 1.34.0 up - was not supported.

- reapply - ifname -

Attempt to update device with changes to the currently active connection - made since it was last applied.

- modify - ifname - - { option value | [+|-]setting.property value } - ... -

-

Modify the settings currently active on the device.

-

This command lets you do temporary changes to a configuration active on - a particular device. The changes are not preserved in the connection profile.

-

See nm-settings-nmcli(5) for the list of available properties. Please note that some - properties can't be changed on an already connected device.

-

- down - ifname... -

-

Disconnect a device and prevent the device from automatically activating - further connections without user/manual intervention. Note that disconnecting - software devices may mean that the devices will disappear.

-

If --wait option is not specified, the default timeout - will be 10 seconds.

-

- disconnect - ifname... -

Alias for command down. Before version 1.34.0 down - was not supported.

- delete - ifname... -

-

Delete a device. The command removes the interface from the system. Note - that this only works for software devices like bonds, bridges, teams, etc. - Hardware devices (like Ethernet) cannot be deleted by the command.

-

If --wait option is not specified, the default timeout will be 10 - seconds.

-

- monitor - [ifname...] -

-

Monitor device activity. This command prints a line whenever the - specified devices change state.

-

Monitors all devices in case no interface is specified. The monitor - terminates when all specified devices disappear. If you want to monitor device - addition consider using the global monitor with nmcli - monitor command.

-

- wifi - [ - list - [--rescan | auto | no | yes ] - [ifname ifname] - [bssid BSSID] - ] -

-

List available Wi-Fi access points. The ifname and - bssid options can be used to list APs for a particular - interface or with a specific BSSID, respectively.

-

By default, nmcli ensures that the access point list - is no older than 30 seconds and triggers a network scan if necessary. The - --rescan can be used to either force or disable the scan - regardless of how fresh the access point list is.

-

- wifi - connect - (B)SSID - [password password] - [ - wep-key-type - { key | phrase } - ] - [ifname ifname] - [bssid BSSID] - [name name] - [ - private - { yes | no } - ] - [ - hidden - { yes | no } - ] -

-

Connect to a Wi-Fi network specified by SSID or BSSID. The command - finds a matching connection or creates one and then activates it on a device. - This is a command-line counterpart of clicking an SSID in a GUI client. If - a connection for the network already exists, it is possible to bring up - (activate) the existing profile as follows: - nmcli con up id name. Note that - only open, WEP and WPA-PSK networks are supported if no previous connection - exists. It is also assumed that IP configuration is obtained via DHCP.

-

If --wait option is not specified, the default timeout will be 90 - seconds.

-

Available options are:

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

password

password for secured networks (WEP or WPA).

wep-key-type

type of WEP secret, either key for ASCII/HEX key or - phrase for passphrase.

ifname

interface that will be used for activation.

bssid

if specified, the created connection will be restricted just for the - BSSID.

name

if specified, the connection will use the name (else NM creates a name - itself).

private

if set to yes, the connection will only be visible - to the user who created it. Otherwise, the connection is system-wide, which is - the default.

hidden

set to yes when connecting for the first time to an - AP not broadcasting its SSID. Otherwise, the SSID would not be found and the - connection attempt would fail.

-

- wifi - hotspot - [ifname ifname] - [con-name name] - [ssid SSID] - [ - band - { a | bg } - ] - [channel channel] - [password password] -

-

Create a Wi-Fi hotspot. The command creates a hotspot connection profile - according to Wi-Fi device capabilities and activates it on the device. The - hotspot is secured with WPA if device/driver supports that, otherwise WEP is - used. Use connection down or device - down to stop the hotspot.

-

Parameters of the hotspot can be influenced by the optional - parameters:

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

ifname

what Wi-Fi device is used.

con-name

name of the created hotspot connection profile.

ssid

SSID of the hotspot.

band

Wi-Fi band to use.

channel

Wi-Fi channel to use.

password

 -

password to use for the created hotspot. If not provided, nmcli will - generate a password. The password is either WPA pre-shared key or WEP - key.

-

Note that --show-secrets global option can be used to - print the hotspot password. It is useful especially when the password was - generated.

-
-

- wifi - rescan - [ifname ifname] - [ssid SSID...] -

-

Request that NetworkManager immediately re-scan for - available access points. NetworkManager scans Wi-Fi networks periodically, but - in some cases it can be useful to start scanning manually (e.g. after resuming - the computer). By using ssid, it is possible to scan for a - specific SSID, which is useful for APs with hidden SSIDs. You can provide - multiple ssid parameters in order to scan more - SSIDs.

-

This command does not show the APs, use nmcli device wifi list - for that.

-

- wifi - show-password - [ifname ifname] -

Show the details of the active Wi-Fi networks, including the - secrets.

- lldp - [ - list - [ifname ifname] - ] -

Display information about neighboring devices learned through the Link - Layer Discovery Protocol (LLDP). The ifname option can be - used to list neighbors only for a given interface. The protocol must be enabled - in the connection settings.

- checkpoint - [--timeout seconds] - [ifname...] - -- - COMMAND... -

-

Runs the command with a configuration checkpoint taken and asks for a - confirmation when finished. When the confirmation is not given, the - checkpoint is automatically restored after timeout.

-

This allows doing disruptive configuration changes over remote - connections with an option of restoring the network configuration to a - known good state in case of an error.

-

If the a list of interface names is specified, the checkpoint is - taken, the checkpoint is takes only on the specified devices. Otherwise - a checkpoint is taken for all devices.

-

Currently the timeout defaults to 15 seconds. This may change in - a future version.

-
-
-
-

Secret Agent

-

nmcli agent { secret | polkit | all }

-

Run nmcli as a NetworkManager secret agent, or polkit agent.

-
---- - - - - - - - - - - - - - - -

secret

Register nmcli as a NetworkManager secret agent and listen for secret - requests. You usually do not need this command, because nmcli can handle - secrets when connecting to networks. However, you may find the command useful - when you use another tool for activating connections and you do not have a - secret agent available (like nm-applet).

- polkit -

Register nmcli as a polkit agent for the user session and listen for - authorization requests. You do not usually need this command, because nmcli can - handle polkit actions related to NetworkManager operations (when run with - --ask). However, you may find the command useful when you want - to run a simple text based polkit agent and you do not have an agent of a desktop - environment. Note that running this command makes nmcli handle all polkit requests, - not only NetworkManager related ones, because only one polkit agent can run for the - session.

- all -

Runs nmcli as both NetworkManager secret and a polkit agent.

-
-
-

Colors

-

Implicit coloring can be disabled by an empty file - /etc/terminal-colors.d/nmcli.disable.

-

See terminal-colors.d(5) - for more details about colorization configuration. - The logical color names supported by nmcli are:

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

connection-activated

A connection that is active.

connection-activating

Connection that is being activated.

connection-disconnecting

Connection that is being disconnected.

connection-external

Connection representing configuration created externally to NetworkManager.

connection-invisible

Connection whose details is the user not permitted to see.

connection-deprecated

Connection that uses deprecated settings. It might not be possible to activate it.

connectivity-full

Connectivity state when Internet is reachable.

connectivity-limited

Connectivity state when only a local network reachable.

connectivity-none

Connectivity state when the network is disconnected.

connectivity-portal

Connectivity state when a captive portal hijacked the connection.

connectivity-unknown

Connectivity state when a connectivity check didn't run.

device-activated

Device that is connected.

device-activating

Device that is being configured.

device-disconnected

Device that is not connected.

device-external

Device configured externally to NetworkManager.

device-firmware-missing

Warning of a missing device firmware.

device-plugin-missing

Warning of a missing device plugin.

device-unavailable

Device that is not available for activation.

device-disabled

Device is disabled by software or hardware kill switch.

manager-running

Notice that the NetworkManager daemon is available.

manager-starting

Notice that the NetworkManager daemon is being initially connected.

manager-stopped

Notice that the NetworkManager daemon is not available.

permission-auth

An action that requires user authentication to get permission.

permission-no

An action that is not permitted.

permission-yes

An action that is permitted.

prompt

Prompt in interactive mode.

state-asleep

Indication that NetworkManager in suspended state.

state-connected-global

Indication that NetworkManager in connected to Internet.

state-connected-local

Indication that NetworkManager in local network.

state-connected-site

Indication that NetworkManager in connected to networks other than Internet.

state-connecting

Indication that NetworkManager is establishing a network connection.

state-disconnected

Indication that NetworkManager is disconnected from a network.

state-disconnecting

Indication that NetworkManager is being disconnected from a network.

wifi-signal-excellent

Wi-Fi network with an excellent signal level.

wifi-signal-fair

Wi-Fi network with a fair signal level.

wifi-signal-good

Wi-Fi network with a good signal level.

wifi-signal-poor

Wi-Fi network with a poor signal level.

wifi-signal-unknown

Wi-Fi network that hasn't been actually seen (a hidden AP).

wifi-deprecated

Wi-Fi network that might be impossible to connect to due to use of deprecated functionality.

disabled

A property that is turned off.

enabled

A property that is turned on.

-
-
-

Environment Variables

-

nmcli's behavior is affected by the following - environment variables.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -

LC_ALL

If set to a non-empty string value, it overrides the values of all the - other internationalization variables.

LC_MESSAGES

Determines the locale to be used for internationalized messages.

LANG

Provides a default value for the internationalization variables that are - unset or null.

NO_COLOR

Default to not producing colored and paged output. The - --colors option, if used, takes precedence.

PAGER

 -

Filter to pipe the output through if it doesn't fit on a screen. - Can be a file name of an executable or a shell command. Empty string to - disable the functionality.

-

Note that the pager command is expected to handle wide characters - and ANSI escape sequences for changing colors (unless they're disabled). - nmcli sets up the environment variables - LESS and LESSCHARSET appropriately for the - less(1) - pager, other pagers may or may not need extra configuration.

-

If unspecified, - pager(1), - less(1) - and more(1) - will be tried (in that order).

-

TERM

 -

Terminal type. If dumb, nmcli - will not use a pager or produce ANSI escape sequences for coloring.

-

Terminal types other than dumb are assumed to - support ASCII escape sequences for setting the output color.

-
-
-
-

Internationalization notes

-

Be aware that nmcli is localized and that is why the - output depends on your environment. This is important to realize especially - when you parse the output.

-

Call nmcli as LC_ALL=C nmcli to - be sure the locale is set to C while executing in a script.

-

LC_ALL, LC_MESSAGES, LANG - variables specify the LC_MESSAGES locale category (in that - order), which determines the language that nmcli uses for - messages. The C locale is used if none of these variables are set, and this - locale uses English messages.

-
-
-

Exit Status

-

nmcli exits with status 0 if it succeeds, a value - greater than 0 is returned if an error occurs.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

0

Success – indicates the operation succeeded.

1

Unknown or unspecified error.

2

Invalid user input, wrong nmcli - invocation.

3

Timeout expired (see --wait option).

4

Connection activation failed.

5

Connection deactivation failed.

6

Disconnecting device failed.

7

Connection deletion failed.

8

NetworkManager is not running.

10

Connection, device, or access point does not exist.

65

When used with --complete-args option, a file name is expected to follow.

-
-
-

Examples

-

This section presents various examples of nmcli usage. If you want even - more, please refer to - nmcli-examples(7) - manual page.

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

nmcli -t -f RUNNING general

tells you whether NetworkManager is running or not.

nmcli -t -f STATE general

shows the overall status of NetworkManager.

nmcli radio wifi off

switches Wi-Fi off.

nmcli connection show

lists all connections NetworkManager has.

nmcli -p -m multiline -f all con show

shows all configured connections in multi-line mode.

nmcli connection show --active

lists all currently active connections.

nmcli -f name,autoconnect c s

shows all connection profile names and their auto-connect property.

nmcli -p connection show "My default em1"

shows details for "My default em1" connection profile.

nmcli --show-secrets connection show "My Home Wi-Fi"

shows details for "My Home Wi-Fi" connection profile with all passwords. - Without --show-secrets option, secrets would not be - displayed.

nmcli -f active connection show "My default em1"

shows details for "My default em1" active connection, like IP, DHCP - information, etc.

nmcli -f profile con s "My wired connection"

shows static configuration details of the connection profile with "My - wired connection" name.

nmcli -p con up "My wired connection" ifname eth0

activates the connection profile with name "My wired connection" on - interface eth0. The -p option makes nmcli show progress of the - activation.

nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3

connects the Wi-Fi connection with UUID - 6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID - 00:3A:98:7C:42:D3.

nmcli device status

shows the status for all devices.

nmcli dev down em2

disconnects a connection on interface em2 and marks the device as - unavailable for auto-connecting. As a result, no connection will automatically - be activated on the device until the device's 'autoconnect' is set to TRUE or - the user manually activates a connection.

nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0

shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES - sections will be shown.

nmcli -f CONNECTIONS device show wlp3s0

shows all available connection profiles for your Wi-Fi interface - wlp3s0.

nmcli dev wifi

lists available Wi-Fi access points known to NetworkManager.

nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"

creates a new connection named "My cafe" and then connects it to "Cafe - Hotspot 1" SSID using password "caffeine". This is mainly useful when - connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to - use nmcli con up id "My cafe" so that the - existing connection profile can be used and no additional is created.

nmcli -s dev wifi hotspot con-name QuickHotspot

creates a hotspot profile and connects it. Prints the hotspot password - the user should use to connect to the hotspot from other devices.

nmcli dev modify em1 ipv4.method shared

starts IPv4 connection sharing using em1 device. The sharing will be active - until the device is disconnected.

nmcli dev modify em1 ipv6.address 2001:db8::a:bad:c0de

temporarily adds an IP address to a device. The address will be removed - when the same connection is activated again.

nmcli connection add type ethernet autoconnect no ifname eth0

non-interactively adds an Ethernet connection tied to eth0 interface with - automatic IP configuration (DHCP), and disables the connection's autoconnect - flag.

nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55

non-interactively adds a VLAN connection with ID 55. The connection will - use eth0 and the VLAN interface will be named Maxipes-fik.

nmcli c a ifname eth0 type ethernet ipv4.method disabled ipv6.method link-local

non-interactively adds a connection that will use eth0 Ethernet interface - and only have an IPv6 link-local address configured.

nmcli connection edit ethernet-em1-2

edits existing "ethernet-em1-2" connection in the interactive - editor.

nmcli connection edit type ethernet con-name "yet another Ethernet connection"

adds a new Ethernet connection in the interactive editor.

nmcli con mod ethernet-2 connection.autoconnect no

modifies 'autoconnect' property in the 'connection' setting of - 'ethernet-2' connection.

nmcli con mod "Home Wi-Fi" wifi.mtu 1350

modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi' - connection.

nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11"

sets manual addressing and the addresses in em1-1 profile.

nmcli con modify ABC +ipv4.dns 8.8.8.8

appends a Google public DNS server to DNS servers in ABC profile.

nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1"

removes the specified IP address from (static) profile ABC.

nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn

imports an OpenVPN configuration to NetworkManager.

nmcli con export corp-vpnc /home/joe/corpvpn.conf

exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) - configuration.

-
-
-

Notes

-

nmcli accepts abbreviations, as long as they are a unique prefix in the set - of possible options. As new options get added, these abbreviations are not guaranteed - to stay unique. For scripting and long term compatibility it is therefore strongly - advised to spell out the full option names.

-
-
-

Bugs

-

There are probably some bugs. If you find a bug, please report it to your distribution - or upstream at https://gitlab.freedesktop.org/NetworkManager/NetworkManager.

-
-
-

See Also

-

- nmcli-examples(7), - nm-settings-nmcli(5), - nm-online(1), - NetworkManager(8), - NetworkManager.conf(5), - nm-applet(1), - nm-connection-editor(1), - terminal-colors.d(5). -

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/nmtui.html b/docs/api/html/nmtui.html deleted file mode 100644 index a7683548..00000000 --- a/docs/api/html/nmtui.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - -nmtui: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

nmtui

-

nmtui — Text User Interface for controlling NetworkManager

-
-
-

Synopsis

-

nmtui-edit | nmtui edit - { name | id } -

-

nmtui-connect | nmtui connect - { name | uuid | device | SSID } -

-

nmtui-hostname | nmtui hostname

-
-
-

Description

-

nmtui is a curses‐based TUI application for - interacting with NetworkManager. When starting nmtui, the - user is prompted to choose the activity to perform unless it was specified as - the first argument.

-

The supported activities are:

-
---- - - - - - - - - - - - - - - -

edit

Show a connection editor that supports adding, modifying, viewing and - deleting connections. It provides similar functionality as - nm-connection-editor.

connect

Show a list of available connections, with the option to activate or - deactivate them. It provides similar functionality as - nm-applet.

hostname

Set the system hostname.

-

Corresponding to above activities, nmtui also comes - with binaries named nmtui-edit, - nmtui-connect, and nmtui-hostname to skip - the selection of the activities.

-
-
-

See Also

-

nmcli(1), - nm-applet(1), - nm-connection-editor(1), - NetworkManager(8).

-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-access-points.html b/docs/api/html/ref-dbus-access-points.html deleted file mode 100644 index a4f19478..00000000 --- a/docs/api/html/ref-dbus-access-points.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/AccessPoint/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/AccessPoint/* objects

-
-org.freedesktop.NetworkManager.AccessPoint — Wi-Fi Access Point. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-active-connections.html b/docs/api/html/ref-dbus-active-connections.html deleted file mode 100644 index 346b4590..00000000 --- a/docs/api/html/ref-dbus-active-connections.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/ActiveConnection/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/ActiveConnection/* objects

-
-
-org.freedesktop.NetworkManager.Connection.Active — Active Connection. -
-
-org.freedesktop.NetworkManager.VPN.Connection — Active VPN Connection. -
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-agent-manager.html b/docs/api/html/ref-dbus-agent-manager.html deleted file mode 100644 index 5e41a683..00000000 --- a/docs/api/html/ref-dbus-agent-manager.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/AgentManager object: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/AgentManager object

-
-org.freedesktop.NetworkManager.AgentManager — Secret Agent Manager. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-checkpoint.html b/docs/api/html/ref-dbus-checkpoint.html deleted file mode 100644 index cf6c20e8..00000000 --- a/docs/api/html/ref-dbus-checkpoint.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/Checkpoint/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/Checkpoint/* objects

-
-org.freedesktop.NetworkManager.Checkpoint — Configuration and State Snapshot. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-devices.html b/docs/api/html/ref-dbus-devices.html deleted file mode 100644 index 504cba73..00000000 --- a/docs/api/html/ref-dbus-devices.html +++ /dev/null @@ -1,130 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/Devices/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/Devices/* objects

-
-
-org.freedesktop.NetworkManager.Device — Device. -
-
-org.freedesktop.NetworkManager.Device.Statistics — Device Statistic Counters. -
-
-org.freedesktop.NetworkManager.Device.Adsl — ADSL Device. -
-
-org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device. -
-
-org.freedesktop.NetworkManager.Device.Bond — Bonding Device. -
-
-org.freedesktop.NetworkManager.Device.Bridge — Bridging Device. -
-
-org.freedesktop.NetworkManager.Device.Dummy — Dummy Device. -
-
-org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device. -
-
-org.freedesktop.NetworkManager.Device.Hsr — HSR Device. -
-
-org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device. -
-
-org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device. -
-
-org.freedesktop.NetworkManager.Device.Loopback — Loopback Device. -
-
-org.freedesktop.NetworkManager.Device.Lowpan — 6LoWPAN Device. -
-
-org.freedesktop.NetworkManager.Device.Macsec — MACSec Device. -
-
-org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device. -
-
-org.freedesktop.NetworkManager.Device.Modem — Modem Device. -
-
-org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device. -
-
-org.freedesktop.NetworkManager.Device.OvsBridge — OvsBridge Device. -
-
-org.freedesktop.NetworkManager.Device.OvsInterface — OvsInterface Device. -
-
-org.freedesktop.NetworkManager.Device.OvsPort — OvsPort Device. -
-
-org.freedesktop.NetworkManager.Device.Ppp — PPP Device. -
-
-org.freedesktop.NetworkManager.Device.Team — Teaming Device. -
-
-org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device. -
-
-org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device. -
-
-org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device. -
-
-org.freedesktop.NetworkManager.Device.Vrf — VRF Device. -
-
-org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device. -
-
-org.freedesktop.NetworkManager.Device.WifiP2P — Wi-Fi P2P Device. -
-
-org.freedesktop.NetworkManager.Device.WireGuard — WireGuard Device. -
-
-org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device. -
-
-org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device. -
-
-org.freedesktop.NetworkManager.Device.Wpan — IEEE 802.15.4 (WPAN) MAC Layer Device. -
-
-org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin. -
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dhcp4-configs.html b/docs/api/html/ref-dbus-dhcp4-configs.html deleted file mode 100644 index 0110ec2c..00000000 --- a/docs/api/html/ref-dbus-dhcp4-configs.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/DHCP4Config/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/DHCP4Config/* objects

-
-org.freedesktop.NetworkManager.DHCP4Config — IPv4 DHCP Client State. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dhcp6-configs.html b/docs/api/html/ref-dbus-dhcp6-configs.html deleted file mode 100644 index ca957305..00000000 --- a/docs/api/html/ref-dbus-dhcp6-configs.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/DHCP4Config/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/DHCP4Config/* objects

-
-org.freedesktop.NetworkManager.DHCP6Config — IPv6 DHCP Client State. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-dns-manager.html b/docs/api/html/ref-dbus-dns-manager.html deleted file mode 100644 index 12cfbb6d..00000000 --- a/docs/api/html/ref-dbus-dns-manager.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/DnsManager object: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/DnsManager object

-
-org.freedesktop.NetworkManager.DnsManager — DNS Configuration State. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-ip4-configs.html b/docs/api/html/ref-dbus-ip4-configs.html deleted file mode 100644 index 79b03ff4..00000000 --- a/docs/api/html/ref-dbus-ip4-configs.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/IP4Config/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/IP4Config/* objects

-
-org.freedesktop.NetworkManager.IP4Config — IPv4 Configuration Set. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-ip6-configs.html b/docs/api/html/ref-dbus-ip6-configs.html deleted file mode 100644 index d70bf60a..00000000 --- a/docs/api/html/ref-dbus-ip6-configs.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/IP6Config/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/IP6Config/* objects

-
-org.freedesktop.NetworkManager.IP6Config — IPv6 Configuration Set. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-manager.html b/docs/api/html/ref-dbus-manager.html deleted file mode 100644 index d59e3ebd..00000000 --- a/docs/api/html/ref-dbus-manager.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager object: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager object

-
-org.freedesktop.NetworkManager — Connection Manager. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-settings-manager.html b/docs/api/html/ref-dbus-settings-manager.html deleted file mode 100644 index 6ba117b0..00000000 --- a/docs/api/html/ref-dbus-settings-manager.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/Settings object: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/Settings object

-
-org.freedesktop.NetworkManager.Settings — Connection Settings Profile Manager. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-settings.html b/docs/api/html/ref-dbus-settings.html deleted file mode 100644 index 302d5bd1..00000000 --- a/docs/api/html/ref-dbus-settings.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org/freedesktop/NetworkManager/Settings/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org/freedesktop/NetworkManager/Settings/* objects

-
-org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-dbus-wifi-p2p-peers.html b/docs/api/html/ref-dbus-wifi-p2p-peers.html deleted file mode 100644 index e764ba10..00000000 --- a/docs/api/html/ref-dbus-wifi-p2p-peers.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -The /org.freedesktop.NetworkManager.WifiP2PPeer/* objects: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-The /org.freedesktop.NetworkManager.WifiP2PPeer/* objects

-
-org.freedesktop.NetworkManager.WifiP2PPeer — Wi-Fi P2P Peer. -
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html deleted file mode 100644 index 90513d09..00000000 --- a/docs/api/html/ref-settings.html +++ /dev/null @@ -1,213 +0,0 @@ - - - - -Part II. Network Configuration Setting Specification: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Part II. Network Configuration Setting Specification

-
-

Table of Contents

-
-
Configuration Settings
-
-
-connection — General Connection Profile Settings -
-
-6lowpan — 6LoWPAN Settings -
-
-802-1x — IEEE 802.1x Authentication Settings -
-
-adsl — ADSL Settings -
-
-bluetooth — Bluetooth Settings -
-
-bond — Bonding Settings -
-
-bridge — Bridging Settings -
-
-bridge-port — Bridge Port Settings -
-
-cdma — CDMA-based Mobile Broadband Settings -
-
-dcb — Data Center Bridging Settings -
-
-dummy — Dummy Link Settings -
-
-ethtool — Ethtool Ethernet Settings -
-
-generic — Generic Link Settings -
-
-gsm — GSM-based Mobile Broadband Settings -
-
-hsr — HSR/PRP Settings -
-
-infiniband — Infiniband Settings -
-
-ipv4 — IPv4 Settings -
-
-ipv6 — IPv6 Settings -
-
-ip-tunnel — IP Tunneling Settings -
-
-macsec — MACSec Settings -
-
-macvlan — MAC VLAN Settings -
-
-match — Match settings -
-
-802-11-olpc-mesh — OLPC Wireless Mesh Settings -
-
-ovs-bridge — OvsBridge Link Settings -
-
-ovs-dpdk — OvsDpdk Link Settings -
-
-ovs-interface — Open vSwitch Interface Settings -
-
-ovs-patch — OvsPatch Link Settings -
-
-ovs-port — OvsPort Link Settings -
-
-ppp — Point-to-Point Protocol Settings -
-
-pppoe — PPP-over-Ethernet Settings -
-
-proxy — WWW Proxy Settings -
-
-serial — Serial Link Settings -
-
-sriov — SR-IOV settings -
-
-tc — Linux Traffic Control Settings -
-
-team — Teaming Settings -
-
-team-port — Team Port Settings -
-
-tun — Tunnel Settings -
-
-user — General User Profile Settings -
-
-vlan — VLAN Settings -
-
-vpn — VPN Settings -
-
-vrf — VRF settings -
-
-vxlan — VXLAN Settings -
-
-wifi-p2p — Wi-Fi P2P Settings -
-
-wimax — WiMax Settings -
-
-802-3-ethernet — Wired Ethernet Settings -
-
-wireguard — WireGuard Settings -
-
-802-11-wireless — Wi-Fi Settings -
-
-802-11-wireless-security — Wi-Fi Security Settings -
-
-wpan — IEEE 802.15.4 (WPAN) MAC Settings -
-
-bond-port — Bond Port Settings -
-
-hostname — Hostname settings -
-
-link — Link settings -
-
-loopback — Loopback Link Settings -
-
-ovs-external-ids — OVS External IDs Settings -
-
-ovs-other-config — OVS Other Config Settings -
-
-veth — Veth Settings -
-
-
Secret flag types
-
-
-

- This part documents the properties and value types of each "Setting" - object that composes the basic unit of NetworkManager configuration, - the "Connection". Each Connection object is simply a dictionary mapping - setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of - key/value pairs that represents each itself. -

-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/right-insensitive.png b/docs/api/html/right-insensitive.png deleted file mode 100644 index 4c95785b..00000000 Binary files a/docs/api/html/right-insensitive.png and /dev/null differ diff --git a/docs/api/html/right.png b/docs/api/html/right.png deleted file mode 100644 index 76260ec8..00000000 Binary files a/docs/api/html/right.png and /dev/null differ diff --git a/docs/api/html/secret-agents.html b/docs/api/html/secret-agents.html deleted file mode 100644 index 6a15b3bf..00000000 --- a/docs/api/html/secret-agents.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - -Part IV. Secret Agent D-Bus API Reference: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Part IV. Secret Agent D-Bus API Reference

-
-

Table of Contents

-
-
Secret agents
-
-org.freedesktop.NetworkManager.SecretAgent — User Secret Agent. -
-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/secrets-flags.html b/docs/api/html/secrets-flags.html deleted file mode 100644 index c6dc5bdd..00000000 --- a/docs/api/html/secrets-flags.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - -Secret flag types: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-

-Secret flag types

-

- Each secret property in a setting has an associated "flags" property - that describes how to handle that secret. The "flags" property is a - bitfield that contains zero or more of the following values logically - OR-ed together. -

-

-

-
    -
  • -0x0 (none) - the system is responsible for providing - and storing this secret. -
    • -
  • -0x1 (agent-owned) - a user-session secret agent - is responsible for providing and storing this secret; when it is - required, agents will be asked to provide it. -
    • -
  • -0x2 (not-saved) - this secret should not be saved - but should be requested from the user each time it is required. This - flag should be used for One-Time-Pad secrets, PIN codes from - hardware tokens, or if the user simply does not want to save the - secret. -
    • -
  • -0x4 (not-required) - in some situations it cannot - be automatically determined that a secret is required or not. This - flag hints that the secret is not required and should not be - requested from the user. -
    • -
-

-

-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file diff --git a/docs/api/html/settings-6lowpan.html b/docs/api/html/settings-6lowpan.html deleted file mode 100644 index 0a9111dd..00000000 --- a/docs/api/html/settings-6lowpan.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - -6lowpan: NetworkManager Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

6lowpan

-

6lowpan — 6LoWPAN Settings

-
-
-

- Properties -

-
-

Table 38. 

-
------ - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
parent
string
If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-802-11-olpc-mesh.html b/docs/api/html/settings-802-11-olpc-mesh.html
deleted file mode 100644
index 0a242ac4..00000000
--- a/docs/api/html/settings-802-11-olpc-mesh.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-802-11-olpc-mesh: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
802-11-olpc-mesh

-
802-11-olpc-mesh — OLPC Wireless Mesh Settings

-

-

-

-            Properties
-        

-

-
Table 59. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
channel
uint32
0
Channel on which the mesh network to join is located.
dhcp-anycast-address
byte array
Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.
-
-This is currently only implemented by dhclient DHCP plugin.
ssid
byte array
SSID of the mesh network to join.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-802-11-wireless-security.html b/docs/api/html/settings-802-11-wireless-security.html
deleted file mode 100644
index e7c37d7e..00000000
--- a/docs/api/html/settings-802-11-wireless-security.html
+++ /dev/null
@@ -1,191 +0,0 @@
-
-
-
-
-802-11-wireless-security: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
802-11-wireless-security

-
802-11-wireless-security — Wi-Fi Security Settings

-

-

-

-            Properties
-        

-

-
Table 84. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
auth-alg
string
When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here.  One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP.  When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.
fils
int32
0
Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.  One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported).  When set to 0 (default) and no global default is set, FILS will be optionally enabled.
group
array of string
A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list.  For maximum compatibility leave this property empty.  Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".
key-mgmt
string
Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).
-
-This property must be set for any Wi-Fi connection that uses security.
leap-password
string
The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
leap-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "leap-password" property.
leap-username
string
The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").
pairwise
array of string
A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty.  Each list element may be one of "tkip" or "ccmp".
pmf
int32
0
Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.  One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported).  When set to 0 (default) and no global default is set, PMF will be optionally enabled.
proto
array of string
List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN).  If not specified, both WPA and RSN connections are allowed.
psk
string
Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.
psk-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "psk" property.
wep-key-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.
wep-key-type
NMWepKeyType (uint32)
Controls the interpretation of WEP keys.  Allowed values are 1 (key), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or 2 (passphrase), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.
wep-key0
string
Index 0 WEP key.  This is the WEP key used in most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
wep-key1
string
Index 1 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
wep-key2
string
Index 2 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
wep-key3
string
Index 3 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.
wep-tx-keyidx
uint32
0
When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here.  Valid values are 0 (default key) through 3.  Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.
wps-method
uint32
0
Flags indicating which mode of WPS is to be used if any.
-
-There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.
-
-WPS can be disabled by setting this property to a value of 1.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-802-11-wireless.html b/docs/api/html/settings-802-11-wireless.html
deleted file mode 100644
index 07492527..00000000
--- a/docs/api/html/settings-802-11-wireless.html
+++ /dev/null
@@ -1,227 +0,0 @@
-
-
-
-
-802-11-wireless: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
802-11-wireless

-
802-11-wireless — Wi-Fi Settings

-

-

-

-            Properties
-        

-

-
Table 83. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
ap-isolation
NMTernary (int32)
Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from -1 (default) only when the interface is configured in AP mode.
-
-If set to 1 (true), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.
-
-If set to 0 (false), devices can talk to each other.
-
-When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false).
assigned-mac-address
string
The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
band
string
802.11 frequency band of the network.  One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11.  This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible.  This setting depends on specific driver capability and may not work with all drivers.
bssid
byte array
If specified, directs the device to only associate with the given access point.  This capability is highly driver dependent and not supported by all devices.  Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.
-
-Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.
channel
uint32
0
Wireless channel to use for the Wi-Fi connection.  The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.  Because channel numbers overlap between bands, this property also requires the "band" property to be set.
channel-width
int32
0
Specifies width of the wireless channel in Access Point (AP) mode.
-
-When set to 0 (auto) (the default), the channel width is automatically determined. At the moment, this means that the safest (smallest) width is chosen.
-
-If the value is not 0 (auto), then the 'channel' property must also be set. When using the 2.4GHz band, the width can be at most 40MHz.
-
-This property can be set to a value different from 0 (auto) only when the interface is configured in AP mode.
cloned-mac-address
byte array
This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
generate-mac-address-mask
string
With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.
-
-If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.
-
-If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.
-
-If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.
-
-If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
hidden
boolean
FALSE
If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.
-
-In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID.  However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.
-
-In AP mode, the created network does not broadcast its SSID.
-
-Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.
mac-address
byte array
If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mac-address-blacklist
array of string
A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.  Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
mac-address-denylist
array of string
A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.  Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").
mac-address-randomization
uint32
0
One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization),  1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address).
mode
string
Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap".  If blank, infrastructure is assumed.
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
powersave
uint32
0
One of 2 (disable) (disable Wi-Fi power saving), 3 (enable) (enable Wi-Fi power saving), 1 (ignore) (don't touch currently configure setting) or 0 (default) (use the globally configured value). All other values are reserved.
rate
uint32
0
This property is not implemented and has no effect.
security
This property is deprecated and has no effect. For backwards compatibility, it can be set to "802-11-wireless-security" if the profile has a wireless security setting.
seen-bssids
array of string
A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network.  NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.
-
-This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.
ssid
byte array
SSID of the Wi-Fi network. Must be specified.
tx-power
uint32
0
This property is not implemented and has no effect.
wake-on-wlan
uint32
1
The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk-rekey-failure), 0x20 (eap-identity-request), 0x40 (4way-handshake), 0x80 (rfkill-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-802-1x.html b/docs/api/html/settings-802-1x.html
deleted file mode 100644
index 14f047c5..00000000
--- a/docs/api/html/settings-802-1x.html
+++ /dev/null
@@ -1,375 +0,0 @@
-
-
-
-
-802-1x: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
802-1x

-
802-1x — IEEE 802.1x Authentication Settings

-

-

-

-            Properties
-        

-

-
Table 39. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
altsubject-matches
array of string
List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.
anonymous-identity
string
Anonymous identity string for EAP authentication methods.  Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.
auth-timeout
int32
0
A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.
ca-cert
byte array
Contains the CA certificate if used by the EAP method specified in the "eap" property.
-
-Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
-
-Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
ca-cert-password
string
The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
ca-cert-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "ca-cert-password" property.
ca-path
string
UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.
-
-If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
client-cert
byte array
Contains the client certificate if used by the EAP method specified in the "eap" property.
-
-Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.
client-cert-password
string
The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
client-cert-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "client-cert-password" property.
domain-match
string
Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
domain-suffix-match
string
Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
eap
array of string
The allowed EAP method to be used when authenticating to the network with 802.1x.  Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast".  Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.
identity
string
Identity string for EAP authentication methods.  Often the user's user or login name.
openssl-ciphers
string
Define openssl_ciphers for wpa_supplicant. Openssl sometimes moves ciphers among SECLEVELs, thus compiled-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols.
optional
boolean
FALSE
Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.
pac-file
string
UTF-8 encoded file path containing PAC for EAP-FAST.
password
string
UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password" property.
password-raw
byte array
Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.
password-raw-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password-raw" property.
phase1-auth-flags
uint32
0
Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.
phase1-fast-provisioning
string
Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning).  See the wpa_supplicant documentation for more details.
phase1-peaplabel
string
Forces use of the new PEAP label during key derivation.  Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1.  Set to "1" to force use of the new PEAP label.  See the wpa_supplicant documentation for more details.
phase1-peapver
string
Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property.  When unset, the version reported by the server will be used.  Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version.  To do so, this property may be set to "0" or "1" to force that specific PEAP version.
phase2-altsubject-matches
array of string
List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.
phase2-auth
string
Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property.  For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method.  For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.
phase2-autheap
string
Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property.  Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.
phase2-ca-cert
byte array
Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.
-
-Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
-
-Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.
phase2-ca-cert-password
string
The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
phase2-ca-cert-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "phase2-ca-cert-password" property.
phase2-ca-path
string
UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.
-
-If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.
phase2-client-cert
byte array
Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.
-
-Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.
phase2-client-cert-password
string
The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
phase2-client-cert-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "phase2-client-cert-password" property.
phase2-domain-match
string
Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.
phase2-domain-suffix-match
string
Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication.  If a matching dNSName is found, this constraint is met.  If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.
phase2-private-key
byte array
Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".
-
-Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
phase2-private-key-password
string
The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.
phase2-private-key-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "phase2-private-key-password" property.
phase2-subject-match
string
Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.
pin
string
PIN used for EAP authentication methods.
pin-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "pin" property.
private-key
byte array
Contains the private key when the "eap" property is set to "tls".
-
-Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
-
-WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users.  Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
private-key-password
string
The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.
private-key-password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "private-key-password" property.
subject-match
string
Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.
system-ca-certs
boolean
FALSE
When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch.  The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-802-3-ethernet.html b/docs/api/html/settings-802-3-ethernet.html
deleted file mode 100644
index ff20cdb0..00000000
--- a/docs/api/html/settings-802-3-ethernet.html
+++ /dev/null
@@ -1,177 +0,0 @@
-
-
-
-
-802-3-ethernet: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
802-3-ethernet

-
802-3-ethernet — Wired Ethernet Settings

-

-

-

-            Properties
-        

-

-
Table 81. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
accept-all-mac-addresses
NMTernary (int32)
When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.
assigned-mac-address
string
The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".
auto-negotiate
boolean
FALSE
When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.
cloned-mac-address
byte array
This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".
duplex
string
When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.
generate-mac-address-mask
string
With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.
-
-If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.
-
-If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.
-
-If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.
-
-If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.
mac-address
byte array
If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mac-address-blacklist
array of string
If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list.  Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
mac-address-denylist
array of string
If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list.  Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.
port
string
Specific port type to use if the device supports multiple attachment methods.  One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.
s390-nettype
string
s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.
s390-options
dict of string to string
{}
Dictionary of key/value pairs of s390-specific device options.  Both keys and values must be strings.  Allowed keys include "portno", "layer2", "portname", "protocol", among others.  Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
-
-Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.
s390-subchannels
array of string
Identifies specific subchannels that this network device uses for communication with z/VM or s390 host.  Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels.  The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.
speed
uint32
0
When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.
wake-on-lan
uint32
1
The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).
wake-on-lan-password
string
If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address.  If NULL, no password will be required.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-adsl.html b/docs/api/html/settings-adsl.html
deleted file mode 100644
index 1454e6e2..00000000
--- a/docs/api/html/settings-adsl.html
+++ /dev/null
@@ -1,107 +0,0 @@
-
-
-
-
-adsl: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
adsl

-
adsl — ADSL Settings

-

-

-

-            Properties
-        

-

-
Table 40. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
encapsulation
string
Encapsulation of ADSL connection.  Can be "vcmux" or "llc".
password
string
Password used to authenticate with the ADSL service.
password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password" property.
protocol
string
ADSL connection protocol.  Can be "pppoa", "pppoe" or "ipoatm".
username
string
Username used to authenticate with the ADSL service.
vci
uint32
0
VCI of ADSL connection
vpi
uint32
0
VPI of ADSL connection

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-bluetooth.html b/docs/api/html/settings-bluetooth.html
deleted file mode 100644
index 15e816e7..00000000
--- a/docs/api/html/settings-bluetooth.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-bluetooth: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
bluetooth

-
bluetooth — Bluetooth Settings

-

-

-

-            Properties
-        

-

-
Table 41. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
bdaddr
byte array
The Bluetooth address of the device.
type
string
Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-bond-port.html b/docs/api/html/settings-bond-port.html
deleted file mode 100644
index 946f267a..00000000
--- a/docs/api/html/settings-bond-port.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-bond-port: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
bond-port

-
bond-port — Bond Port Settings

-

-

-

-            Properties
-        

-

-
Table 86. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
prio
int32
0
The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.
queue-id
uint32
0
The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-bond.html b/docs/api/html/settings-bond.html
deleted file mode 100644
index 78831eb4..00000000
--- a/docs/api/html/settings-bond.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-bond: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
bond

-
bond — Bonding Settings

-

-

-

-            Properties
-        

-

-
Table 42. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
interface-name
string
Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.
options
dict of string to string
{'mode': 'balance-rr'}
Dictionary of key/value pairs of bonding options.  Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-bridge-port.html b/docs/api/html/settings-bridge-port.html
deleted file mode 100644
index 10d60a4c..00000000
--- a/docs/api/html/settings-bridge-port.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-bridge-port: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
bridge-port

-
bridge-port — Bridge Port Settings

-

-

-

-            Properties
-        

-

-
Table 44. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
hairpin-mode
boolean
FALSE
Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.
path-cost
uint32
100
The Spanning Tree Protocol (STP) port cost for destinations via this port.
priority
uint32
32
The Spanning Tree Protocol (STP) priority of this bridge port.
vlans
array of vardict
Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.
-
-In nmcli the VLAN list can be specified with the following syntax:
-
-$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...
-
-where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-bridge.html b/docs/api/html/settings-bridge.html
deleted file mode 100644
index 461e68f6..00000000
--- a/docs/api/html/settings-bridge.html
+++ /dev/null
@@ -1,247 +0,0 @@
-
-
-
-
-bridge: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
bridge

-
bridge — Bridging Settings

-

-

-

-            Properties
-        

-

-
Table 43. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
ageing-time
uint32
300
The Ethernet MAC address aging time, in seconds.
forward-delay
uint32
15
The Spanning Tree Protocol (STP) forwarding delay, in seconds.
group-address
byte array
If specified, The MAC address of the multicast group this bridge uses for STP.
-
-The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.
group-forward-mask
uint32
0
A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.
hello-time
uint32
2
The Spanning Tree Protocol (STP) hello time, in seconds.
interface-name
string
Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.
mac-address
byte array
If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.
-
-If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.
max-age
uint32
20
The Spanning Tree Protocol (STP) maximum message age, in seconds.
multicast-hash-max
uint32
4096
Set maximum size of multicast hash table (value must be a power of 2).
multicast-last-member-count
uint32
2
Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.
multicast-last-member-interval
uint64
100
Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.
multicast-membership-interval
uint64
26000
Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.
multicast-querier
boolean
FALSE
Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.
multicast-querier-interval
uint64
25500
If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.
multicast-query-interval
uint64
12500
Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.
multicast-query-response-interval
uint64
1000
Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.
multicast-query-use-ifaddr
boolean
FALSE
If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.
multicast-router
string
Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.
-
-Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).
multicast-snooping
boolean
TRUE
Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
multicast-startup-query-count
uint32
2
Set the number of IGMP queries to send during startup phase.
multicast-startup-query-interval
uint64
3125
Sets the time (in deciseconds) between queries sent out at startup to determine membership information.
priority
uint32
32768
Sets the Spanning Tree Protocol (STP) priority for this bridge.  Lower values are "better"; the lowest priority bridge will be elected the root bridge.
stp
boolean
TRUE
Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
vlan-default-pvid
uint32
1
The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.
vlan-filtering
boolean
FALSE
Control whether VLAN filtering is enabled on the bridge.
vlan-protocol
string
If specified, the protocol used for VLAN filtering.
-
-Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.
vlan-stats-enabled
boolean
FALSE
Controls whether per-VLAN stats accounting is enabled.
vlans
array of vardict
Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured  by the bridge.vlan-default-pvid property.
-
-In nmcli the VLAN list can be specified with the following syntax:
-
-$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...
-
-where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-cdma.html b/docs/api/html/settings-cdma.html
deleted file mode 100644
index 9874d10e..00000000
--- a/docs/api/html/settings-cdma.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-cdma: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
cdma

-
cdma — CDMA-based Mobile Broadband Settings

-

-

-

-            Properties
-        

-

-
Table 45. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
number
string
The number to dial to establish the connection to the CDMA-based mobile broadband network, if any.  If not specified, the default number (#777) is used when required.
password
string
The password used to authenticate with the network, if required.  Many providers do not require a password, or accept any password.  But if a password is required, it is specified here.
password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password" property.
username
string
The username used to authenticate with the network, if required.  Many providers do not require a username, or accept any username.  But if a username is required, it is specified here.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-connection.html b/docs/api/html/settings-connection.html
deleted file mode 100644
index 7ca59cc0..00000000
--- a/docs/api/html/settings-connection.html
+++ /dev/null
@@ -1,331 +0,0 @@
-
-
-
-
-connection: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
connection

-
connection — General Connection Profile Settings

-

-

-

-            Properties
-        

-

-
Table 37. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
auth-retries
int32
-1
The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.
-
-Currently, this only applies to 802-1x authentication.
autoconnect
boolean
TRUE
Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.
-
-Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.
-
-Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.
-
-If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.
-
-Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.
autoconnect-ports
int32
-1
Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.
autoconnect-priority
int32
0
The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.
autoconnect-retries
int32
-1
The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.
autoconnect-slaves
NMSettingConnectionAutoconnectSlaves (int32)
Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.
-
-Deprecated 1.46. Use "autoconnect-ports" instead, this is just an alias.
controller
string
Interface name of the controller device or UUID of the controller connection.
dns-over-tls
int32
-1
Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.
-
-The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.
-
-This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
down-on-poweroff
int32
-1
Whether the connection will be brought down before the system is powered off.  The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as 0 (no).
gateway-ping-timeout
uint32
0
If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
id
string
A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
interface-name
string
The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).
-
-For software devices this specifies the name of the created device.
-
-For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
lldp
int32
-1
Whether LLDP is enabled for the connection.
llmnr
int32
-1
Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.
-
-The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").
-
-This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.
master
string
Interface name of the controller device or UUID of the controller connection.
-
-Deprecated 1.46. Use "controller" instead, this is just an alias.
mdns
int32
-1
Whether mDNS is enabled for the connection.
-
-The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin.
-
-This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. Currently the only supported DNS plugin is systemd-resolved. For systemd-resolved, the default is configurable via MulticastDNS= setting in resolved.conf.
metered
NMMetered (int32)
Whether the connection is metered.
-
-When updating this property on a currently activated connection, the change takes effect immediately.
mptcp-flags
uint32
0
Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.
-
-If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.
-
-The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.
-
-Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.
-
-Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.
-
-When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.
-
-If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.
-
-NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.
-
-Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).
mud-url
string
If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".
-
-The special value "none" is allowed to indicate that no MUD URL is used.
-
-If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".
multi-connect
int32
0
Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.
permissions
array of string
An array of strings defining what access a given user has to this connection.  If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list.  When this is not empty, the connection can be active only when one of the specified users is logged into an active session.  Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".
-
-At this time only the "user" [type] is allowed.  Any other values are ignored and reserved for future use.  [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use.  All of [type], [id], and [reserved] must be valid UTF-8.
port-type
string
Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.
read-only
boolean
FALSE
This property is deprecated and has no meaning.
secondaries
array of string
List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.
slave-type
string
Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.
-
-Deprecated 1.46. Use "port-type" instead, this is just an alias.
stable-id
string
This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.
-
-The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable.
-
-Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.
-
-The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}".  These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time.  The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$".  For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.
-
-If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.
timestamp
uint64
0
The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.
-
-NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
type
string
Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
uuid
string
A universally unique identifier for the connection, for example generated with libuuid.  It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network.  For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes.
-
-The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
wait-activation-delay
int32
-1
Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.
-
-The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
wait-device-timeout
int32
-1
Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.
-
-The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.
zone
string
The trust level of a the connection.  Free form case-insensitive string (for example "Home", "Work", "Public").  NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.
-
-When updating this property on a currently activated connection, the change takes effect immediately.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-dcb.html b/docs/api/html/settings-dcb.html
deleted file mode 100644
index 5ff1de94..00000000
--- a/docs/api/html/settings-dcb.html
+++ /dev/null
@@ -1,157 +0,0 @@
-
-
-
-
-dcb: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
dcb

-
dcb — Data Center Bridging Settings

-

-

-

-            Properties
-        

-

-
Table 46. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
app-fcoe-flags
NMSettingDcbFlags (uint32)
Specifies the NMSettingDcbFlags for the DCB FCoE application.  Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
app-fcoe-mode
string
The FCoE controller mode; either "fabric" or "vn2vn".
-
-Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".
app-fcoe-priority
int32
-1
The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority.  Only used when the "app-fcoe-flags" property includes the 0x1 (enable) flag.
app-fip-flags
NMSettingDcbFlags (uint32)
Specifies the NMSettingDcbFlags for the DCB FIP application.  Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
app-fip-priority
int32
-1
The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority.  Only used when the "app-fip-flags" property includes the 0x1 (enable) flag.
app-iscsi-flags
NMSettingDcbFlags (uint32)
Specifies the NMSettingDcbFlags for the DCB iSCSI application.  Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
app-iscsi-priority
int32
-1
The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the 0x1 (enable) flag.
priority-bandwidth
array of uint32
An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use.  The sum of all percentages for priorities which belong to the same group must total 100 percents.
priority-flow-control
array of uint32
An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.
priority-flow-control-flags
NMSettingDcbFlags (uint32)
Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
priority-group-bandwidth
array of uint32
An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group.  Allowed values are 0 - 100, and the sum of all values must total 100 percents.
priority-group-flags
NMSettingDcbFlags (uint32)
Specifies the NMSettingDcbFlags for DCB Priority Groups.  Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).
priority-group-id
array of uint32
An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID.  Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
priority-strict-bandwidth
array of uint32
An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.
priority-traffic-class
array of uint32
An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-dummy.html b/docs/api/html/settings-dummy.html
deleted file mode 100644
index 97c96517..00000000
--- a/docs/api/html/settings-dummy.html
+++ /dev/null
@@ -1,64 +0,0 @@
-
-
-
-
-dummy: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
dummy

-
dummy — Dummy Link Settings

-

-

-

-            Properties
-        

-

-
Table 47. 

-

------
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ethtool.html b/docs/api/html/settings-ethtool.html
deleted file mode 100644
index 6d1a732a..00000000
--- a/docs/api/html/settings-ethtool.html
+++ /dev/null
@@ -1,64 +0,0 @@
-
-
-
-
-ethtool: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ethtool

-
ethtool — Ethtool Ethernet Settings

-

-

-

-            Properties
-        

-

-
Table 48. 

-

------
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-generic.html b/docs/api/html/settings-generic.html
deleted file mode 100644
index 178d2f60..00000000
--- a/docs/api/html/settings-generic.html
+++ /dev/null
@@ -1,73 +0,0 @@
-
-
-
-
-generic: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
generic

-
generic — Generic Link Settings

-

-

-

-            Properties
-        

-

-
Table 49. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
device-handler
string
Name of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'.
-
-See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler.
-
-By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-gsm.html b/docs/api/html/settings-gsm.html
deleted file mode 100644
index a352876a..00000000
--- a/docs/api/html/settings-gsm.html
+++ /dev/null
@@ -1,163 +0,0 @@
-
-
-
-
-gsm: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
gsm

-
gsm — GSM-based Mobile Broadband Settings

-

-

-

-            Properties
-        

-

-
Table 50. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
apn
string
The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network.  The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
-
-If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.
auto-config
boolean
FALSE
When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.
device-id
string
The device unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will only apply to the specified device.
home-only
boolean
FALSE
When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.
initial-eps-bearer-apn
string
For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network.  Setting this parameter implies initial-eps-bearer-configure to be TRUE.
initial-eps-bearer-configure
boolean
FALSE
For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection.  It is inferred TRUE if initial-eps-bearer-apn is set.
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
network-id
string
The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration.  If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.
number
string
Legacy setting that used to help establishing PPP data sessions for GSM-based modems.
password
string
The password used to authenticate with the network, if required.  Many providers do not require a password, or accept any password.  But if a password is required, it is specified here.
password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password" property.
pin
string
If the SIM is locked with a PIN it must be unlocked before any other operations are requested.  Specify the PIN here to allow operation of the device.
pin-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "pin" property.
sim-id
string
The SIM card unique identifier (as given by the WWAN management service) which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.
sim-operator-id
string
A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to.  If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.
username
string
The username used to authenticate with the network, if required.  Many providers do not require a username, or accept any username.  But if a username is required, it is specified here.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-hostname.html b/docs/api/html/settings-hostname.html
deleted file mode 100644
index a2fb95e8..00000000
--- a/docs/api/html/settings-hostname.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
-
-hostname: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
hostname

-
hostname — Hostname settings

-

-

-

-            Properties
-        

-

-
Table 87. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
from-dhcp
NMTernary (int32)
Whether the system hostname can be determined from DHCP on this connection.
-
-When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).
from-dns-lookup
NMTernary (int32)
Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.
-
-When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).
only-from-default
NMTernary (int32)
If set to 1 (true), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).
-
-If set to 0 (false), the hostname can be set from this device even if it doesn't have the default route.
-
-When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 0 (false).
priority
int32
0
The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority).  A connection with higher priority is considered before connections with lower priority.
-
-If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.
-
-Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-hsr.html b/docs/api/html/settings-hsr.html
deleted file mode 100644
index 6d3190ab..00000000
--- a/docs/api/html/settings-hsr.html
+++ /dev/null
@@ -1,89 +0,0 @@
-
-
-
-
-hsr: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
hsr

-
hsr — HSR/PRP Settings

-

-

-

-            Properties
-        

-

-
Table 51. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
multicast-spec
uint32
0
The last byte of supervision address.
port1
string
The port1 interface name of the HSR. This property is mandatory.
port2
string
The port2 interface name of the HSR. This property is mandatory.
prp
boolean
FALSE
The protocol used by the interface, whether it is PRP or HSR.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-infiniband.html b/docs/api/html/settings-infiniband.html
deleted file mode 100644
index 87ca0af5..00000000
--- a/docs/api/html/settings-infiniband.html
+++ /dev/null
@@ -1,99 +0,0 @@
-
-
-
-
-infiniband: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
infiniband

-
infiniband — Infiniband Settings

-

-

-

-            Properties
-        

-

-
Table 52. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
mac-address
byte array
If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
p-key
int32
-1
The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.
-
-With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.
-
-Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.
parent
string
The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".
transport-mode
string
The IP-over-InfiniBand transport mode. Either "datagram" or "connected".

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ip-tunnel.html b/docs/api/html/settings-ip-tunnel.html
deleted file mode 100644
index e0e50f35..00000000
--- a/docs/api/html/settings-ip-tunnel.html
+++ /dev/null
@@ -1,149 +0,0 @@
-
-
-
-
-ip-tunnel: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ip-tunnel

-
ip-tunnel — IP Tunneling Settings

-

-

-

-            Properties
-        

-

-
Table 55. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
encapsulation-limit
uint32
0
How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.
flags
uint32
0
Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy), 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.
flow-label
uint32
0
The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
fwmark
uint32
0
The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.
input-key
string
The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
local
string
The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
mode
uint32
0
The tunneling mode. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap)
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.
output-key
string
The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
parent
string
If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
path-mtu-discovery
boolean
TRUE
Whether to enable Path MTU Discovery on this tunnel.
remote
string
The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
tos
uint32
0
The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
ttl
uint32
0
The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ipv4.html b/docs/api/html/settings-ipv4.html
deleted file mode 100644
index b74760f1..00000000
--- a/docs/api/html/settings-ipv4.html
+++ /dev/null
@@ -1,359 +0,0 @@
-
-
-
-
-ipv4: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ipv4

-
ipv4 — IPv4 Settings

-

-

-

-            Properties
-        

-

-
Table 53. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
address-data
array of vardict
Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
addresses
array of array of uint32
Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'.
-Array of IPv4 address structures.  Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.
auto-route-ext-gw
NMTernary (int32)
VPN connections will default to add the route automatically unless this setting is set to FALSE.
-
-For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
dad-timeout
int32
-1
Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4.
-
-A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms).  A value greater than zero is a timeout in milliseconds.  Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.
dhcp-client-id
string
A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.
-
-The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.
-
-The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.
-
-The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.
-
-The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.
-
-The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.
-
-If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.
dhcp-dscp
string
Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".
-
-The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.
dhcp-fqdn
string
If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.
dhcp-hostname
string
If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
dhcp-hostname-flags
uint32
0
Flags for the DHCP hostname and FQDN.
-
-Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update).  When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6.
-
-When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.
dhcp-iaid
string
A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".
-
-For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.
-
-For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.
-
-The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.
dhcp-reject-servers
array of string
Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.
-
-For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").
-
-This property is currently not implemented for DHCPv6.
dhcp-send-hostname
boolean
TRUE
If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer.  If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
dhcp-send-release
NMTernary (int32)
Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.
dhcp-timeout
int32
0
A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).
-
-Set to 2147483647 (MAXINT32) for infinity.
dhcp-vendor-class-identifier
string
The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.
dns
array of uint32
Array of IP addresses of DNS servers (as network-byte-order integers)
dns-data
array of strings
Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.
dns-options
array of string
Array of DNS options to be added to resolv.conf.
-
-NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
-
-The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options.
-
-In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below).
-
-The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.
-
-When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.
dns-priority
int32
0
DNS servers priority.
-
-The relative priority for DNS servers specified by this setting.  A lower numerical value is better (higher priority).
-
-Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.
-
-Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.
-
-Note that the priority is to order DNS settings for multiple active connections.  It does not disambiguate multiple DNS servers within the same connection profile.
-
-When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.
-
-When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.
-
-When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain.  Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually).  When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins.  If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
dns-search
array of string
List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.
-
-When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.
-
-When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
gateway
string
The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
-
-Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.
-
-Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
ignore-auto-dns
boolean
FALSE
When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
ignore-auto-routes
boolean
FALSE
When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
link-local
int32
0
Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.
-
-When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".
may-fail
boolean
TRUE
If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out.  Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
method
string
IP configuration method.
-
-NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.
-
-In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration.  The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.
-
-For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.
-
-For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
never-default
boolean
FALSE
If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
replace-local-rule
NMTernary (int32)
Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
required-timeout
int32
-1
The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.
-
-This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.
-
-Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.
-
-A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
route-data
array of vardict
Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
route-metric
int64
-1
The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
route-table
uint32
0
Enable policy routing (source routing) and set the routing table used when adding routes.
-
-This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.
-
-If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.
-
-Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
routes
array of array of uint32
Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'.
-Array of IPv4 route structures.  Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)
routing-rules
array of 'a{sv}'
Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ipv6.html b/docs/api/html/settings-ipv6.html
deleted file mode 100644
index 4bc451e7..00000000
--- a/docs/api/html/settings-ipv6.html
+++ /dev/null
@@ -1,407 +0,0 @@
-
-
-
-
-ipv6: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ipv6

-
ipv6 — IPv6 Settings

-

-

-

-            Properties
-        

-

-
Table 54. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
addr-gen-mode
int32
3
Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local.
-
-The permitted values are: 0 (eui64), 1 (stable-privacy). 2 (default-or-eui64) or 3 (default).
-
-If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration.
-
-If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix.  This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced.
-
-The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.
-
-For libnm, the property defaults to "default" since 1.40.  Previously it used to default to "stable-privacy".  On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.
-
-Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.
address-data
array of vardict
Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.
addresses
array of legacy IPv6 address struct (a(ayuay))
Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'.
-Array of IPv6 address structures.  Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.
auto-route-ext-gw
NMTernary (int32)
VPN connections will default to add the route automatically unless this setting is set to FALSE.
-
-For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.
dad-timeout
int32
-1
Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network.  If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4.
-
-A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms).  A value greater than zero is a timeout in milliseconds.  Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.
dhcp-dscp
string
Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".
-
-The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.
dhcp-duid
string
A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.
-
-The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.
-
-The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.
-
-The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").
-
-When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.
dhcp-hostname
string
If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.
dhcp-hostname-flags
uint32
0
Flags for the DHCP hostname and FQDN.
-
-Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update).  When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6.
-
-When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.
dhcp-iaid
string
A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".
-
-For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.
-
-For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.
-
-The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.
dhcp-pd-hint
string
A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").
dhcp-reject-servers
array of string
Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.
-
-For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").
-
-This property is currently not implemented for DHCPv6.
dhcp-send-hostname
boolean
TRUE
If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer.  If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.
dhcp-send-release
NMTernary (int32)
Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is -1 (default). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE.
dhcp-timeout
int32
0
A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).
-
-Set to 2147483647 (MAXINT32) for infinity.
dns
array of byte array
Array of IP addresses of DNS servers (in network byte order)
dns-data
array of strings
Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.
dns-options
array of string
Array of DNS options to be added to resolv.conf.
-
-NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.
-
-The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options.
-
-In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below).
-
-The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.
-
-When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.
dns-priority
int32
0
DNS servers priority.
-
-The relative priority for DNS servers specified by this setting.  A lower numerical value is better (higher priority).
-
-Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.
-
-Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.
-
-Note that the priority is to order DNS settings for multiple active connections.  It does not disambiguate multiple DNS servers within the same connection profile.
-
-When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.
-
-When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.
-
-When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain.  Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually).  When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins.  If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.
dns-search
array of string
List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.
-
-When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.
-
-When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).
gateway
string
The gateway associated with this configuration. This is only meaningful if "addresses" is also set.
-
-Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.
-
-Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".
ignore-auto-dns
boolean
FALSE
When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.
ignore-auto-routes
boolean
FALSE
When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.
ip6-privacy
NMSettingIP6ConfigPrivacy (int32)
Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941.  If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64.  This enhances privacy, but could cause problems in some applications, on the other hand.  The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).
-
-Having a per-connection setting set to "-1" (default) means fallback to global configuration "ipv6.ip6-privacy". If it's also unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".
-
-Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.
may-fail
boolean
TRUE
If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out.  Note that at least one IP configuration must succeed or overall network configuration will still fail.  For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.
method
string
IP configuration method.
-
-NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.
-
-In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration.  The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.
-
-For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.
-
-For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.
mtu
uint32
0
Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.
never-default
boolean
FALSE
If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.
ra-timeout
int32
0
A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.
-
-Set to 2147483647 (MAXINT32) for infinity.
replace-local-rule
NMTernary (int32)
Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.
required-timeout
int32
-1
The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.
-
-This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.
-
-Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.
-
-A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).
route-data
array of vardict
Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.
route-metric
int64
-1
The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.
route-table
uint32
0
Enable policy routing (source routing) and set the routing table used when adding routes.
-
-This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.
-
-If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.
-
-Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.
routes
array of legacy IPv6 route struct (a(ayuayu))
Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'.
-Array of IPv6 route structures.  Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.
routing-rules
array of 'a{sv}'
Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).
temp-preferred-lifetime
int32
0
The preferred lifetime of autogenerated temporary addresses, in seconds.
-
-Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-preferred-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_prefered_lft".
temp-valid-lifetime
int32
0
The valid lifetime of autogenerated temporary addresses, in seconds.
-
-Having a per-connection setting set to "0" (default) means fallback to global configuration "ipv6.temp-valid-lifetime" setting". If it's also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_valid_lft".
token
string
Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.
-
-When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-link.html b/docs/api/html/settings-link.html
deleted file mode 100644
index d28b27f5..00000000
--- a/docs/api/html/settings-link.html
+++ /dev/null
@@ -1,89 +0,0 @@
-
-
-
-
-link: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
link

-
link — Link settings

-

-

-

-            Properties
-        

-

-
Table 88. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
gro-max-size
int64
-1
The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
gso-max-segments
int64
-1
The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
gso-max-size
int64
-1
The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.
tx-queue-length
int64
-1
The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-loopback.html b/docs/api/html/settings-loopback.html
deleted file mode 100644
index 54bbc8d4..00000000
--- a/docs/api/html/settings-loopback.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-loopback: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
loopback

-
loopback — Loopback Link Settings

-

-

-

-            Properties
-        

-

-
Table 89. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-macsec.html b/docs/api/html/settings-macsec.html
deleted file mode 100644
index d9efb8af..00000000
--- a/docs/api/html/settings-macsec.html
+++ /dev/null
@@ -1,131 +0,0 @@
-
-
-
-
-macsec: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
macsec

-
macsec — MACSec Settings

-

-

-

-            Properties
-        

-

-
Table 56. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
encrypt
boolean
TRUE
Whether the transmitted traffic must be encrypted.
mka-cak
string
The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.
mka-cak-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "mka-cak" property.
mka-ckn
string
The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.
mode
int32
0
Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.
offload
int32
-1
Specifies the MACsec offload mode.
-
-0 (off) disables MACsec offload.
-
-1 (phy) and 2 (mac) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail.
-
--1 (default) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is 0 (off).
parent
string
If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
port
int32
1
The port component of the SCI (Secure Channel Identifier), between 1 and 65534.
send-sci
boolean
TRUE
Specifies whether the SCI (Secure Channel Identifier) is included in every packet.
validation
int32
2
Specifies the validation mode for incoming frames.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-macvlan.html b/docs/api/html/settings-macvlan.html
deleted file mode 100644
index 70b7c963..00000000
--- a/docs/api/html/settings-macvlan.html
+++ /dev/null
@@ -1,89 +0,0 @@
-
-
-
-
-macvlan: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
macvlan

-
macvlan — MAC VLAN Settings

-

-

-

-            Properties
-        

-

-
Table 57. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
mode
uint32
0
The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
parent
string
If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
promiscuous
boolean
TRUE
Whether the interface should be put in promiscuous mode.
tap
boolean
FALSE
Whether the interface should be a MACVTAP.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-match.html b/docs/api/html/settings-match.html
deleted file mode 100644
index 79b18f1a..00000000
--- a/docs/api/html/settings-match.html
+++ /dev/null
@@ -1,103 +0,0 @@
-
-
-
-
-match: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
match

-
match — Match settings

-

-

-

-            Properties
-        

-

-
Table 58. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
driver
array of string
A list of driver names to match. Each element is a shell wildcard pattern.
-
-See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.
interface-name
array of string
A list of interface names to match. Each element is a shell wildcard pattern.
-
-An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".
kernel-command-line
array of string
A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.
-
-See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.
path
array of string
A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.
-
-For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".
-
-The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").
-
-Each element of the list is a shell wildcard pattern.
-
-See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-bridge.html b/docs/api/html/settings-ovs-bridge.html
deleted file mode 100644
index 437a719e..00000000
--- a/docs/api/html/settings-ovs-bridge.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-ovs-bridge: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-bridge

-
ovs-bridge — OvsBridge Link Settings

-

-

-

-            Properties
-        

-

-
Table 60. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
datapath-type
string
The data path type. One of "system", "netdev" or empty.
fail-mode
string
The bridge failure mode. One of "secure", "standalone" or empty.
mcast-snooping-enable
boolean
FALSE
Enable or disable multicast snooping.
rstp-enable
boolean
FALSE
Enable or disable RSTP.
stp-enable
boolean
FALSE
Enable or disable STP.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-dpdk.html b/docs/api/html/settings-ovs-dpdk.html
deleted file mode 100644
index a7f9a880..00000000
--- a/docs/api/html/settings-ovs-dpdk.html
+++ /dev/null
@@ -1,89 +0,0 @@
-
-
-
-
-ovs-dpdk: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-dpdk

-
ovs-dpdk — OvsDpdk Link Settings

-

-

-

-            Properties
-        

-

-
Table 61. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
devargs
string
Open vSwitch DPDK device arguments.
n-rxq
uint32
0
Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.
n-rxq-desc
uint32
0
The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.
n-txq-desc
uint32
0
The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-external-ids.html b/docs/api/html/settings-ovs-external-ids.html
deleted file mode 100644
index 5acaadfb..00000000
--- a/docs/api/html/settings-ovs-external-ids.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-ovs-external-ids: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-external-ids

-
ovs-external-ids — OVS External IDs Settings

-

-

-

-            Properties
-        

-

-
Table 90. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
data
dict of string to string
{}
A dictionary of key/value pairs with external-ids for OVS.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-interface.html b/docs/api/html/settings-ovs-interface.html
deleted file mode 100644
index 937bf965..00000000
--- a/docs/api/html/settings-ovs-interface.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-ovs-interface: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-interface

-
ovs-interface — Open vSwitch Interface Settings

-

-

-

-            Properties
-        

-

-
Table 62. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
ofport-request
uint32
0
Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.
type
string
The interface type. Either "internal", "system", "patch", "dpdk", or empty.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-other-config.html b/docs/api/html/settings-ovs-other-config.html
deleted file mode 100644
index 62e27c56..00000000
--- a/docs/api/html/settings-ovs-other-config.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-ovs-other-config: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-other-config

-
ovs-other-config — OVS Other Config Settings

-

-

-

-            Properties
-        

-

-
Table 91. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
data
dict of string to string
{}
A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-patch.html b/docs/api/html/settings-ovs-patch.html
deleted file mode 100644
index 6db3933e..00000000
--- a/docs/api/html/settings-ovs-patch.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-ovs-patch: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-patch

-
ovs-patch — OvsPatch Link Settings

-

-

-

-            Properties
-        

-

-
Table 63. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
peer
string
Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ovs-port.html b/docs/api/html/settings-ovs-port.html
deleted file mode 100644
index 4e3280ef..00000000
--- a/docs/api/html/settings-ovs-port.html
+++ /dev/null
@@ -1,109 +0,0 @@
-
-
-
-
-ovs-port: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ovs-port

-
ovs-port — OvsPort Link Settings

-

-

-

-            Properties
-        

-

-
Table 64. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
bond-downdelay
uint32
0
The time port must be inactive in order to be considered down.
bond-mode
string
Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".
bond-updelay
uint32
0
The time port must be active before it starts forwarding traffic.
lacp
string
LACP mode. One of "active", "off", or "passive".
tag
uint32
0
The VLAN tag in the range 0-4095.
trunks
array of vardict
A list of VLAN ranges that this port trunks.
-
-The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.
vlan-mode
string
The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-ppp.html b/docs/api/html/settings-ppp.html
deleted file mode 100644
index 442c513a..00000000
--- a/docs/api/html/settings-ppp.html
+++ /dev/null
@@ -1,173 +0,0 @@
-
-
-
-
-ppp: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
ppp

-
ppp — Point-to-Point Protocol Settings

-

-

-

-            Properties
-        

-

-
Table 65. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
baud
uint32
0
If non-zero, instruct pppd to set the serial port to the specified baudrate.  This value should normally be left as 0 to automatically choose the speed.
crtscts
boolean
FALSE
If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals.  This value should normally be set to FALSE.
lcp-echo-failure
uint32
0
If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer.  The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.
lcp-echo-interval
uint32
0
If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value).  Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.
mppe-stateful
boolean
FALSE
If TRUE, stateful MPPE is used.  See pppd documentation for more information on stateful MPPE.
mru
uint32
0
If non-zero, instruct pppd to request that the peer send packets no larger than the specified size.  If non-zero, the MRU should be between 128 and 16384.
mtu
uint32
0
If non-zero, instruct pppd to send packets no larger than the specified size.
no-vj-comp
boolean
FALSE
If TRUE, Van Jacobsen TCP header compression will not be requested.
noauth
boolean
TRUE
If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client.  If FALSE, require authentication from the remote side.  In almost all cases, this should be TRUE.
nobsdcomp
boolean
FALSE
If TRUE, BSD compression will not be requested.
nodeflate
boolean
FALSE
If TRUE, "deflate" compression will not be requested.
refuse-chap
boolean
FALSE
If TRUE, the CHAP authentication method will not be used.
refuse-eap
boolean
FALSE
If TRUE, the EAP authentication method will not be used.
refuse-mschap
boolean
FALSE
If TRUE, the MSCHAP authentication method will not be used.
refuse-mschapv2
boolean
FALSE
If TRUE, the MSCHAPv2 authentication method will not be used.
refuse-pap
boolean
FALSE
If TRUE, the PAP authentication method will not be used.
require-mppe
boolean
FALSE
If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session.  If either 64-bit or 128-bit MPPE is not available the session will fail.  Note that MPPE is not used on mobile broadband connections.
require-mppe-128
boolean
FALSE
If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE.  If 128-bit MPPE is not available the session will fail.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-pppoe.html b/docs/api/html/settings-pppoe.html
deleted file mode 100644
index 4bd15f0d..00000000
--- a/docs/api/html/settings-pppoe.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-pppoe: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
pppoe

-
pppoe — PPP-over-Ethernet Settings

-

-

-

-            Properties
-        

-

-
Table 66. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
parent
string
If given, specifies the parent interface name on which this PPPoE connection should be created.  If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.
password
string
Password used to authenticate with the PPPoE service.
password-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "password" property.
service
string
If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service.  For most providers, this should be left blank.  It is only required if there are multiple access concentrators or a specific service is known to be required.
username
string
Username used to authenticate with the PPPoE service.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-proxy.html b/docs/api/html/settings-proxy.html
deleted file mode 100644
index 0a64d155..00000000
--- a/docs/api/html/settings-proxy.html
+++ /dev/null
@@ -1,89 +0,0 @@
-
-
-
-
-proxy: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
proxy

-
proxy — WWW Proxy Settings

-

-

-

-            Properties
-        

-

-
Table 67. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
browser-only
boolean
FALSE
Whether the proxy configuration is for browser only.
method
int32
0
Method for proxy configuration, Default is 0 (none)
pac-script
string
PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.
pac-url
string
PAC URL for obtaining PAC file.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-serial.html b/docs/api/html/settings-serial.html
deleted file mode 100644
index 84830d56..00000000
--- a/docs/api/html/settings-serial.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-serial: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
serial

-
serial — Serial Link Settings

-

-

-

-            Properties
-        

-

-
Table 68. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
baud
uint32
57600
Speed to use for communication over the serial port.  Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.
bits
uint32
8
Byte-width of the serial communication. The 8 in "8n1" for example.
parity
byte
The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.
send-delay
uint64
0
Time to delay between each byte sent to the modem, in microseconds.
stopbits
uint32
1
Number of stop bits for communication on the serial port.  Either 1 or 2. The 1 in "8n1" for example.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-sriov.html b/docs/api/html/settings-sriov.html
deleted file mode 100644
index 7019f67e..00000000
--- a/docs/api/html/settings-sriov.html
+++ /dev/null
@@ -1,137 +0,0 @@
-
-
-
-
-sriov: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
sriov

-
sriov — SR-IOV settings

-

-

-

-            Properties
-        

-

-
Table 69. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
autoprobe-drivers
NMTernary (int32)
Whether to autoprobe virtual functions by a compatible driver.
-
-If set to 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.
-
-If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them.
-
-When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true).
eswitch-encap-mode
int32
-1
Select the eswitch encapsulation support.
-
-Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.
-
-If set to -1 (preserve) (default) the eswitch encap-mode won't be modified by NetworkManager.
eswitch-inline-mode
int32
-1
Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.
-
-Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.
-
-If set to -1 (preserve) (default) the eswitch inline-mode won't be modified by NetworkManager.
eswitch-mode
int32
-1
Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.
-
-If set to -1 (preserve) (default) the eswitch mode won't be modified by NetworkManager.
total-vfs
uint32
0
The total number of virtual functions to create.
-
-Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.
vfs
array of vardict
Array of virtual function descriptors.
-
-Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.
-
-When represented as string a VF is in the form:
-
-"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".
-
-for example:
-
-"2 mac=00:11:22:33:44:55 spoof-check=true".
-
-Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.
-
-The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form
-
-"ID[.PRIORITY[.PROTO]]".
-
-PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-tc.html b/docs/api/html/settings-tc.html
deleted file mode 100644
index 07ce3754..00000000
--- a/docs/api/html/settings-tc.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-tc: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
tc

-
tc — Linux Traffic Control Settings

-

-

-

-            Properties
-        

-

-
Table 70. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
qdiscs
array of vardict
Array of TC queueing disciplines.
-
-When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl.
-
-If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.
tfilters
array of vardict
Array of TC traffic filters.
-
-When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters.
-
-If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-team-port.html b/docs/api/html/settings-team-port.html
deleted file mode 100644
index b74520ca..00000000
--- a/docs/api/html/settings-team-port.html
+++ /dev/null
@@ -1,107 +0,0 @@
-
-
-
-
-team-port: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
team-port

-
team-port — Team Port Settings

-

-

-

-            Properties
-        

-

-
Table 72. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
config
string
The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.
lacp-key
int32
-1
Corresponds to the teamd ports.PORTIFNAME.lacp_key.
lacp-prio
int32
-1
Corresponds to the teamd ports.PORTIFNAME.lacp_prio.
link-watchers
array of vardict
Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are:   ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
prio
int32
0
Corresponds to the teamd ports.PORTIFNAME.prio.
queue-id
int32
-1
Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.
sticky
boolean
FALSE
Corresponds to the teamd ports.PORTIFNAME.sticky.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-team.html b/docs/api/html/settings-team.html
deleted file mode 100644
index 4a66c6ea..00000000
--- a/docs/api/html/settings-team.html
+++ /dev/null
@@ -1,167 +0,0 @@
-
-
-
-
-team: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
team

-
team — Teaming Settings

-

-

-

-            Properties
-        

-

-
Table 71. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
config
string
The JSON configuration for the team network interface.  The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used.  See man teamd.conf for the format details.
interface-name
string
Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.
link-watchers
array of vardict
Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are:   ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.
mcast-rejoin-count
int32
-1
Corresponds to the teamd mcast_rejoin.count.
mcast-rejoin-interval
int32
-1
Corresponds to the teamd mcast_rejoin.interval.
notify-peers-count
int32
-1
Corresponds to the teamd notify_peers.count.
notify-peers-interval
int32
-1
Corresponds to the teamd notify_peers.interval.
runner
string
Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".
runner-active
boolean
TRUE
Corresponds to the teamd runner.active.
runner-agg-select-policy
string
Corresponds to the teamd runner.agg_select_policy.
runner-fast-rate
boolean
FALSE
Corresponds to the teamd runner.fast_rate.
runner-hwaddr-policy
string
Corresponds to the teamd runner.hwaddr_policy.
runner-min-ports
int32
-1
Corresponds to the teamd runner.min_ports.
runner-sys-prio
int32
-1
Corresponds to the teamd runner.sys_prio.
runner-tx-balancer
string
Corresponds to the teamd runner.tx_balancer.name.
runner-tx-balancer-interval
int32
-1
Corresponds to the teamd runner.tx_balancer.interval.
runner-tx-hash
array of string
Corresponds to the teamd runner.tx_hash.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-tun.html b/docs/api/html/settings-tun.html
deleted file mode 100644
index 307688d0..00000000
--- a/docs/api/html/settings-tun.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
-
-tun: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
tun

-
tun — Tunnel Settings

-

-

-

-            Properties
-        

-

-
Table 73. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
group
string
The group ID which will own the device. If set to NULL everyone will be able to use the device.
mode
uint32
1
The operating mode of the virtual device. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet-like layer 2 one.
multi-queue
boolean
FALSE
If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
owner
string
The user ID which will own the device. If set to NULL everyone will be able to use the device.
pi
boolean
FALSE
If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
vnet-hdr
boolean
FALSE
If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-user.html b/docs/api/html/settings-user.html
deleted file mode 100644
index 4c2c5b29..00000000
--- a/docs/api/html/settings-user.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-user: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
user

-
user — General User Profile Settings

-

-

-

-            Properties
-        

-

-
Table 74. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
data
dict of string to string
{}
A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-veth.html b/docs/api/html/settings-veth.html
deleted file mode 100644
index 7b7f0d6b..00000000
--- a/docs/api/html/settings-veth.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-veth: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
veth

-
veth — Veth Settings

-

-

-

-            Properties
-        

-

-
Table 92. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
peer
string
This property specifies the peer interface name of the veth. This property is mandatory.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-vlan.html b/docs/api/html/settings-vlan.html
deleted file mode 100644
index 4b214be1..00000000
--- a/docs/api/html/settings-vlan.html
+++ /dev/null
@@ -1,111 +0,0 @@
-
-
-
-
-vlan: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
vlan

-
vlan — VLAN Settings

-

-

-

-            Properties
-        

-

-
Table 75. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
egress-priority-map
array of string
For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities.  The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
flags
NMVlanFlags (uint32)
One or more flags which control the behavior and features of the VLAN interface.  Flags include 0x1 (reorder-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose-binding) (loose binding of the interface to its controller device's operating state). 0x8 (mvrp) (use of the MVRP protocol).
-
-The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.
id
uint32
0
The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.
ingress-priority-map
array of string
For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities.  The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".
interface-name
string
Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.
parent
string
If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created.  If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
protocol
string
Specifies the VLAN protocol to use for encapsulation.
-
-Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-vpn.html b/docs/api/html/settings-vpn.html
deleted file mode 100644
index 64fc8c86..00000000
--- a/docs/api/html/settings-vpn.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
-
-vpn: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
vpn

-
vpn — VPN Settings

-

-

-

-            Properties
-        

-

-
Table 76. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
data
dict of string to string
{}
Dictionary of key/value pairs of VPN plugin specific data.  Both keys and values must be strings.
persistent
boolean
FALSE
If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.
secrets
dict of string to string
{}
Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys.  Both keys and values must be strings.
service-type
string
D-Bus service name of the VPN plugin that this setting uses to connect to its network.  i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
timeout
uint32
0
Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
user-name
string
If the VPN connection requires a user name for authentication, that name should be provided here.  If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty.  If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-vrf.html b/docs/api/html/settings-vrf.html
deleted file mode 100644
index 49835f63..00000000
--- a/docs/api/html/settings-vrf.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-vrf: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
vrf

-
vrf — VRF settings

-

-

-

-            Properties
-        

-

-
Table 77. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
table
uint32
0
The routing table for this VRF.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-vxlan.html b/docs/api/html/settings-vxlan.html
deleted file mode 100644
index b160b064..00000000
--- a/docs/api/html/settings-vxlan.html
+++ /dev/null
@@ -1,161 +0,0 @@
-
-
-
-
-vxlan: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
vxlan

-
vxlan — VXLAN Settings

-

-

-

-            Properties
-        

-

-
Table 78. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
ageing
uint32
300
Specifies the lifetime in seconds of FDB entries learnt by the kernel.
destination-port
uint32
8472
Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
id
uint32
0
Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.
l2-miss
boolean
FALSE
Specifies whether netlink LL ADDR miss notifications are generated.
l3-miss
boolean
FALSE
Specifies whether netlink IP ADDR miss notifications are generated.
learning
boolean
TRUE
Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
limit
uint32
0
Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
local
string
If given, specifies the source IP address to use in outgoing packets.
parent
string
If given, specifies the parent interface name or parent connection UUID.
proxy
boolean
FALSE
Specifies whether ARP proxy is turned on.
remote
string
Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
rsc
boolean
FALSE
Specifies whether route short circuit is turned on.
source-port-max
uint32
0
Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-min
uint32
0
Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
tos
uint32
0
Specifies the TOS value to use in outgoing packets.
ttl
uint32
0
Specifies the time-to-live value to use in outgoing packets.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-wifi-p2p.html b/docs/api/html/settings-wifi-p2p.html
deleted file mode 100644
index d63a1aca..00000000
--- a/docs/api/html/settings-wifi-p2p.html
+++ /dev/null
@@ -1,87 +0,0 @@
-
-
-
-
-wifi-p2p: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
wifi-p2p

-
wifi-p2p — Wi-Fi P2P Settings

-

-

-

-            Properties
-        

-

-
Table 79. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
peer
string
The P2P device that should be connected to. Currently, this is the only way to create or join a group.
wfd-ies
byte array
The Wi-Fi Display (WFD) Information Elements (IEs) to set.
-
-Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.
wps-method
uint32
0
Flags indicating which mode of WPS is to be used.
-
-There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-wimax.html b/docs/api/html/settings-wimax.html
deleted file mode 100644
index 184337ff..00000000
--- a/docs/api/html/settings-wimax.html
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
-
-
-wimax: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
wimax

-
wimax — WiMax Settings

-

-

-

-            Properties
-        

-

-
Table 80. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
mac-address
byte array
If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).
network-name
string
Network Service Provider (NSP) name of the WiMAX network this connection should use.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-wireguard.html b/docs/api/html/settings-wireguard.html
deleted file mode 100644
index 0db9b20b..00000000
--- a/docs/api/html/settings-wireguard.html
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
-
-
-wireguard: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
wireguard

-
wireguard — WireGuard Settings

-

-

-

-            Properties
-        

-

-
Table 82. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
fwmark
uint32
0
The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.
-
-Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.
ip4-auto-default-route
NMTernary (int32)
Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".
-
-Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.
-
-Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.
ip6-auto-default-route
NMTernary (int32)
Like ip4-auto-default-route, but for the IPv6 default route.
listen-port
uint32
0
The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.
mtu
uint32
0
If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.
-
-If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.
peer-routes
boolean
TRUE
Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.
-
-Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.
peers
array of 'a{sv}'
Array of dictionaries for the WireGuard peers.
private-key
string
The 256 bit private-key in base64 encoding.
private-key-flags
NMSettingSecretFlags (uint32)
Flags indicating how to handle the "private-key" property.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/settings-wpan.html b/docs/api/html/settings-wpan.html
deleted file mode 100644
index 4df13339..00000000
--- a/docs/api/html/settings-wpan.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-wpan: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-

-
-
-

-
wpan

-
wpan — IEEE 802.15.4 (WPAN) MAC Settings

-

-

-

-            Properties
-        

-

-
Table 85. 

-

------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-






Key NameValue TypeDefault ValueValue Description
channel
int32
-1
IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
mac-address
string
If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.
page
int32
-1
IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".
pan-id
uint32
65535
IEEE 802.15.4 Personal Area Network (PAN) identifier.
short-address
uint32
65535
Short IEEE 802.15.4 address to be used within a restricted environment.

-

-


-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html
deleted file mode 100644
index 1dfc5875..00000000
--- a/docs/api/html/spec.html
+++ /dev/null
@@ -1,201 +0,0 @@
-
-
-
-
-Part III. D-Bus API Reference: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-Part III. D-Bus API Reference

-

-
Table of Contents

-

-
The /org/freedesktop/NetworkManager object

-

-org.freedesktop.NetworkManager — Connection Manager.
-

-
The /org/freedesktop/NetworkManager/AgentManager object

-

-org.freedesktop.NetworkManager.AgentManager — Secret Agent Manager.
-

-
The /org/freedesktop/NetworkManager/DnsManager object

-

-org.freedesktop.NetworkManager.DnsManager — DNS Configuration State.
-

-
The /org/freedesktop/NetworkManager/Settings object

-

-org.freedesktop.NetworkManager.Settings — Connection Settings Profile Manager.
-

-
The /org/freedesktop/NetworkManager/Settings/* objects

-

-org.freedesktop.NetworkManager.Settings.Connection — Connection Settings Profile.
-

-
The /org/freedesktop/NetworkManager/Devices/* objects

-

-

-org.freedesktop.NetworkManager.Device — Device.
-

-

-org.freedesktop.NetworkManager.Device.Statistics — Device Statistic Counters.
-

-

-org.freedesktop.NetworkManager.Device.Adsl — ADSL Device.
-

-

-org.freedesktop.NetworkManager.Device.Bluetooth — Bluetooth Device.
-

-

-org.freedesktop.NetworkManager.Device.Bond — Bonding Device.
-

-

-org.freedesktop.NetworkManager.Device.Bridge — Bridging Device.
-

-

-org.freedesktop.NetworkManager.Device.Dummy — Dummy Device.
-

-

-org.freedesktop.NetworkManager.Device.Generic — Unrecognized Device.
-

-

-org.freedesktop.NetworkManager.Device.Hsr — HSR Device.
-

-

-org.freedesktop.NetworkManager.Device.IPTunnel — IP Tunneling Device.
-

-

-org.freedesktop.NetworkManager.Device.Infiniband — Infiniband Device.
-

-

-org.freedesktop.NetworkManager.Device.Loopback — Loopback Device.
-

-

-org.freedesktop.NetworkManager.Device.Lowpan — 6LoWPAN Device.
-

-

-org.freedesktop.NetworkManager.Device.Macsec — MACSec Device.
-

-

-org.freedesktop.NetworkManager.Device.Macvlan — MAC VLAN Device.
-

-

-org.freedesktop.NetworkManager.Device.Modem — Modem Device.
-

-

-org.freedesktop.NetworkManager.Device.OlpcMesh — OLPC Wireless Mesh Device.
-

-

-org.freedesktop.NetworkManager.Device.OvsBridge — OvsBridge Device.
-

-

-org.freedesktop.NetworkManager.Device.OvsInterface — OvsInterface Device.
-

-

-org.freedesktop.NetworkManager.Device.OvsPort — OvsPort Device.
-

-

-org.freedesktop.NetworkManager.Device.Ppp — PPP Device.
-

-

-org.freedesktop.NetworkManager.Device.Team — Teaming Device.
-

-

-org.freedesktop.NetworkManager.Device.Tun — Userspace Tunneling Device.
-

-

-org.freedesktop.NetworkManager.Device.Veth — Virtual Ethernet Device.
-

-

-org.freedesktop.NetworkManager.Device.Vlan — Virtual LAN Device.
-

-

-org.freedesktop.NetworkManager.Device.Vrf — VRF Device.
-

-

-org.freedesktop.NetworkManager.Device.Vxlan — VXLAN Device.
-

-

-org.freedesktop.NetworkManager.Device.WifiP2P — Wi-Fi P2P Device.
-

-

-org.freedesktop.NetworkManager.Device.WireGuard — WireGuard Device.
-

-

-org.freedesktop.NetworkManager.Device.Wired — Wired Ethernet Device.
-

-

-org.freedesktop.NetworkManager.Device.Wireless — Wi-Fi Device.
-

-

-org.freedesktop.NetworkManager.Device.Wpan — IEEE 802.15.4 (WPAN) MAC Layer Device.
-

-

-org.freedesktop.NetworkManager.PPP — Helper interface for a PPP plugin.
-

-

-
The /org/freedesktop/NetworkManager/ActiveConnection/* objects

-

-

-org.freedesktop.NetworkManager.Connection.Active — Active Connection.
-

-

-org.freedesktop.NetworkManager.VPN.Connection — Active VPN Connection.
-

-

-
The /org/freedesktop/NetworkManager/IP4Config/* objects

-

-org.freedesktop.NetworkManager.IP4Config — IPv4 Configuration Set.
-

-
The /org/freedesktop/NetworkManager/IP6Config/* objects

-

-org.freedesktop.NetworkManager.IP6Config — IPv6 Configuration Set.
-

-
The /org/freedesktop/NetworkManager/DHCP4Config/* objects

-

-org.freedesktop.NetworkManager.DHCP4Config — IPv4 DHCP Client State.
-

-
The /org/freedesktop/NetworkManager/DHCP4Config/* objects

-

-org.freedesktop.NetworkManager.DHCP6Config — IPv6 DHCP Client State.
-

-
The /org/freedesktop/NetworkManager/AccessPoint/* objects

-

-org.freedesktop.NetworkManager.AccessPoint — Wi-Fi Access Point.
-

-
The /org.freedesktop.NetworkManager.WifiP2PPeer/* objects

-

-org.freedesktop.NetworkManager.WifiP2PPeer — Wi-Fi P2P Peer.
-

-
The /org/freedesktop/NetworkManager/Checkpoint/* objects

-

-org.freedesktop.NetworkManager.Checkpoint — Configuration and State Snapshot.
-

-
Types

-

-NetworkManager D-Bus API Types
-

-

-

-

-      This part documents the D-Bus interface used to access the
-      NetworkManager daemon.
-    

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
diff --git a/docs/api/html/style.css b/docs/api/html/style.css
deleted file mode 100644
index 437e8601..00000000
--- a/docs/api/html/style.css
+++ /dev/null
@@ -1,531 +0,0 @@
-body
-{
-  font-family: cantarell, sans-serif;
-}
-.synopsis, .classsynopsis
-{
-  /* tango:aluminium 1/2 */
-  background: #eeeeec;
-  background: rgba(238, 238, 236, 0.5);
-  border: solid 1px rgb(238, 238, 236);
-  padding: 0.5em;
-}
-.programlisting
-{
-  /* tango:sky blue 0/1 */
-  /* fallback for no rgba support */
-  background: #e6f3ff;
-  border: solid 1px #729fcf;
-  background: rgba(114, 159, 207, 0.1);
-  border: solid 1px rgba(114, 159, 207, 0.2);
-  padding: 0.5em;
-}
-.variablelist
-{
-  padding: 4px;
-  margin-left: 3em;
-}
-.variablelist td:first-child
-{
-  vertical-align: top;
-}
-
-span.nowrap {
-  white-space: nowrap;
-}
-
-div.gallery-float
-{
-  float: left;
-  padding: 10px;
-}
-div.gallery-float img
-{
-  border-style: none;
-}
-div.gallery-spacer
-{
-  clear: both;
-}
-
-a, a:visited
-{
-  text-decoration: none;
-  /* tango:sky blue 2 */
-  color: #3465a4;
-}
-a:hover
-{
-  text-decoration: underline;
-  /* tango:sky blue 1 */
-  color: #729fcf;
-}
-
-.function_type,
-.variable_type,
-.property_type,
-.signal_type,
-.parameter_name,
-.struct_member_name,
-.union_member_name,
-.define_keyword,
-.datatype_keyword,
-.typedef_keyword
-{
-  text-align: right;
-}
-
-/* dim non-primary columns */
-.c_punctuation,
-.function_type,
-.variable_type,
-.property_type,
-.signal_type,
-.define_keyword,
-.datatype_keyword,
-.typedef_keyword,
-.property_flags,
-.signal_flags,
-.parameter_annotations,
-.enum_member_annotations,
-.struct_member_annotations,
-.union_member_annotations
-{
-  color: #888a85;
-}
-
-.function_type a,
-.function_type a:visited,
-.function_type a:hover,
-.property_type a,
-.property_type a:visited,
-.property_type a:hover,
-.signal_type a,
-.signal_type a:visited,
-.signal_type a:hover,
-.signal_flags a,
-.signal_flags a:visited,
-.signal_flags a:hover
-{
- color: #729fcf;
-}
-
-td p
-{
-  margin: 0.25em;
-}
-
-div.informaltable table[border="1"],
-div.table table
-{
-  border-collapse: collapse;
-  border-spacing: 0px;
-  /* tango:aluminium 3 */
-  border: solid 1px #babdb6;
-}
-
-div.informaltable table[border="1"] td,
-div.informaltable table th,
-div.table table td, div.table table th
-{
-  /* tango:aluminium 3 */
-  border: solid 1px #babdb6;
-  padding: 3px;
-  vertical-align: top;
-}
-
-div.informaltable table[border="1"] th,
-div.table table th
-{
-  /* tango:aluminium 2 */
-  background-color: #d3d7cf;
-}
-
-h4
-{
-  color: #555753;
-  margin-top: 1em;
-  margin-bottom: 1em;
-}
-
-hr
-{
-  /* tango:aluminium 1 */
-  color: #d3d7cf;
-  background: #d3d7cf;
-  border: none 0px;
-  height: 1px;
-  clear: both;
-  margin: 2.0em 0em 2.0em 0em;
-}
-
-dl.toc dt
-{
-  padding-bottom: 0.25em;
-}
-
-dl.toc > dt
-{
-  padding-top: 0.25em;
-  padding-bottom: 0.25em;
-  font-weight: bold;
-}
-
-dl.toc > dl
-{
-  padding-bottom: 0.5em;
-}
-
-.parameter
-{
-  font-style: normal;
-}
-
-.footer
-{
-  padding-top: 3.5em;
-  /* tango:aluminium 3 */
-  color: #babdb6;
-  text-align: center;
-  font-size: 80%;
-}
-
-.informalfigure,
-.figure
-{
-  margin: 1em;
-}
-
-.informalexample,
-.example
-{
-  margin-top: 1em;
-  margin-bottom: 1em;
-}
-
-.warning
-{
-  /* tango:orange 0/1 */
-  background: #ffeed9;
-  background: rgba(252, 175, 62, 0.1);
-  border-color: #ffb04f;
-  border-color: rgba(252, 175, 62, 0.2);
-}
-.note
-{
-  /* tango:chameleon 0/0.5 */
-  background: #d8ffb2;
-  background: rgba(138, 226, 52, 0.1);
-  border-color: #abf562;
-  border-color: rgba(138, 226, 52, 0.2);
-}
-div.blockquote
-{
-  border-color: #eeeeec;
-}
-.note, .warning, div.blockquote
-{
-  padding: 0.5em;
-  border-width: 1px;
-  border-style: solid;
-  margin: 2em;
-}
-.note p, .warning p
-{
-  margin: 0;
-}
-
-div.warning h3.title,
-div.note h3.title
-{
-  display: none;
-}
-
-p + div.section
-{
-  margin-top: 1em;
-}
-
-div.refnamediv,
-div.refsynopsisdiv,
-div.refsect1,
-div.refsect2,
-div.toc,
-div.section
-{
-  margin-bottom: 1em;
-}
-
-/* blob links */
-h2 .extralinks, h3 .extralinks
-{
-  float: right;
-  /* tango:aluminium 3 */
-  color: #babdb6;
-  font-size: 80%;
-  font-weight: normal;
-}
-
-.lineart
-{
-  color: #d3d7cf;
-  font-weight: normal;
-}
-
-.annotation
-{
-  /* tango:aluminium 5 */
-  color: #555753;
-  font-weight: normal;
-}
-
-.structfield
-{
-  font-style: normal;
-  font-weight: normal;
-}
-
-acronym,abbr
-{
-  border-bottom: 1px dotted gray;
-}
-
-.listing_frame {
-  /* tango:sky blue 1 */
-  border: solid 1px #729fcf;
-  border: solid 1px rgba(114, 159, 207, 0.2);
-  padding: 0px;
-}
-
-.listing_lines, .listing_code {
-  margin-top: 0px;
-  margin-bottom: 0px;
-  padding: 0.5em;
-}
-.listing_lines {
-  /* tango:sky blue 0.5 */
-  background: #a6c5e3;
-  background: rgba(114, 159, 207, 0.2);
-  /* tango:aluminium 6 */
-  color: #2e3436;
-}
-.listing_code {
-  /* tango:sky blue 0 */
-  background: #e6f3ff;
-  background: rgba(114, 159, 207, 0.1);
-}
-.listing_code .programlisting {
-  /* override from previous */
-  border: none 0px;
-  padding: 0px;
-  background: none;
-}
-.listing_lines pre, .listing_code pre {
-  margin: 0px;
-}
-
-@media screen {
-  /* these have a  as a first child, but since there are no parent selectors
-   * we can't use that. */
-  a.footnote
-  {
-    position: relative;
-    top: 0em ! important;
-  }
-  /* this is needed so that the local anchors are displayed below the naviagtion */
-  div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name]
-  {
-    display: inline-block;
-    position: relative;
-    top:-5em;
-  }
-  /* this seems to be a bug in the xsl style sheets when generating indexes */
-  div.index div.index
-  {
-    top: 0em;
-  }
-  /* make space for the fixed navigation bar and add space at the bottom so that
-   * link targets appear somewhat close to top
-   */
-  body
-  {
-    padding-top: 2.5em;
-    padding-bottom: 500px;
-    max-width: 60em;
-  }
-  p
-  {
-    max-width: 60em;
-  }
-  /* style and size the navigation bar */
-  table.navigation#top
-  {
-    position: fixed;
-    background: #e2e2e2;
-    border-bottom: solid 1px #babdb6;
-    border-spacing: 5px;
-    margin-top: 0;
-    margin-bottom: 0;
-    top: 0;
-    left: 0;
-    z-index: 10;
-  }
-  table.navigation#top td
-  {
-    padding-left: 6px;
-    padding-right: 6px;
-  }
-  .navigation a, .navigation a:visited
-  {
-    /* tango:sky blue 3 */
-    color: #204a87;
-  }
-  .navigation a:hover
-  {
-    /* tango:sky blue 2 */
-    color: #3465a4;
-  }
-  td.shortcuts
-  {
-    /* tango:sky blue 2 */
-    color: #3465a4;
-    font-size: 80%;
-    white-space: nowrap;
-  }
-  td.shortcuts .dim
-  {
-    color: #babdb6;
-  }
-  .navigation .title
-  {
-    font-size: 80%;
-    max-width: none;
-    margin: 0px;
-    font-weight: normal;
-  }
-}
-@media screen and (min-width: 60em) {
-  /* screen larger than 60em */
-  body { margin: auto; }
-}
-@media screen and (max-width: 60em) {
-  /* screen less than 60em */
-  #nav_hierarchy { display: none; }
-  #nav_interfaces { display: none; }
-  #nav_prerequisites { display: none; }
-  #nav_derived_interfaces { display: none; }
-  #nav_implementations { display: none; }
-  #nav_child_properties { display: none; }
-  #nav_style_properties { display: none; }
-  #nav_index { display: none; }
-  #nav_glossary { display: none; }
-  .gallery_image { display: none; }
-  .property_flags { display: none; }
-  .signal_flags { display: none; }
-  .parameter_annotations { display: none; }
-  .enum_member_annotations { display: none; }
-  .struct_member_annotations { display: none; }
-  .union_member_annotations { display: none; }
-  /* now that a column is hidden, optimize space */
-  col.parameters_name { width: auto; }
-  col.parameters_description { width: auto; }
-  col.struct_members_name { width: auto; }
-  col.struct_members_description { width: auto; }
-  col.enum_members_name { width: auto; }
-  col.enum_members_description { width: auto; }
-  col.union_members_name { width: auto; }
-  col.union_members_description { width: auto; }
-  .listing_lines { display: none; }
-}
-@media print {
-  table.navigation {
-    visibility: collapse;
-    display: none;
-  }
-  div.titlepage table.navigation {
-    visibility: visible;
-    display: table;
-    background: #e2e2e2;
-    border: solid 1px #babdb6;
-    margin-top: 0;
-    margin-bottom: 0;
-    top: 0;
-    left: 0;
-    height: 3em;
-  }
-}
-
-pre { line-height: 125%; }
-td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
-span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
-td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
-span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
-.hll { background-color: #ffffcc }
-.c { color: #3D7B7B; font-style: italic } /* Comment */
-.err { border: 1px solid #FF0000 } /* Error */
-.k { color: #008000; font-weight: bold } /* Keyword */
-.o { color: #666666 } /* Operator */
-.ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
-.cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
-.cp { color: #9C6500 } /* Comment.Preproc */
-.cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
-.c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
-.cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
-.gd { color: #A00000 } /* Generic.Deleted */
-.ge { font-style: italic } /* Generic.Emph */
-.ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
-.gr { color: #E40000 } /* Generic.Error */
-.gh { color: #000080; font-weight: bold } /* Generic.Heading */
-.gi { color: #008400 } /* Generic.Inserted */
-.go { color: #717171 } /* Generic.Output */
-.gp { color: #000080; font-weight: bold } /* Generic.Prompt */
-.gs { font-weight: bold } /* Generic.Strong */
-.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.gt { color: #0044DD } /* Generic.Traceback */
-.kc { color: #008000; font-weight: bold } /* Keyword.Constant */
-.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
-.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
-.kp { color: #008000 } /* Keyword.Pseudo */
-.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
-.kt { color: #B00040 } /* Keyword.Type */
-.m { color: #666666 } /* Literal.Number */
-.s { color: #BA2121 } /* Literal.String */
-.na { color: #687822 } /* Name.Attribute */
-.nb { color: #008000 } /* Name.Builtin */
-.nc { color: #0000FF; font-weight: bold } /* Name.Class */
-.no { color: #880000 } /* Name.Constant */
-.nd { color: #AA22FF } /* Name.Decorator */
-.ni { color: #717171; font-weight: bold } /* Name.Entity */
-.ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
-.nf { color: #0000FF } /* Name.Function */
-.nl { color: #767600 } /* Name.Label */
-.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
-.nt { color: #008000; font-weight: bold } /* Name.Tag */
-.nv { color: #19177C } /* Name.Variable */
-.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
-.w { color: #bbbbbb } /* Text.Whitespace */
-.mb { color: #666666 } /* Literal.Number.Bin */
-.mf { color: #666666 } /* Literal.Number.Float */
-.mh { color: #666666 } /* Literal.Number.Hex */
-.mi { color: #666666 } /* Literal.Number.Integer */
-.mo { color: #666666 } /* Literal.Number.Oct */
-.sa { color: #BA2121 } /* Literal.String.Affix */
-.sb { color: #BA2121 } /* Literal.String.Backtick */
-.sc { color: #BA2121 } /* Literal.String.Char */
-.dl { color: #BA2121 } /* Literal.String.Delimiter */
-.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
-.s2 { color: #BA2121 } /* Literal.String.Double */
-.se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
-.sh { color: #BA2121 } /* Literal.String.Heredoc */
-.si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
-.sx { color: #008000 } /* Literal.String.Other */
-.sr { color: #A45A77 } /* Literal.String.Regex */
-.s1 { color: #BA2121 } /* Literal.String.Single */
-.ss { color: #19177C } /* Literal.String.Symbol */
-.bp { color: #008000 } /* Name.Builtin.Pseudo */
-.fm { color: #0000FF } /* Name.Function.Magic */
-.vc { color: #19177C } /* Name.Variable.Class */
-.vg { color: #19177C } /* Name.Variable.Global */
-.vi { color: #19177C } /* Name.Variable.Instance */
-.vm { color: #19177C } /* Name.Variable.Magic */
-.il { color: #666666 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/api/html/up-insensitive.png b/docs/api/html/up-insensitive.png
deleted file mode 100644
index f4049860..00000000
Binary files a/docs/api/html/up-insensitive.png and /dev/null differ
diff --git a/docs/api/html/up.png b/docs/api/html/up.png
deleted file mode 100644
index 80b4b37e..00000000
Binary files a/docs/api/html/up.png and /dev/null differ
diff --git a/docs/api/html/vpn-plugins.html b/docs/api/html/vpn-plugins.html
deleted file mode 100644
index 08409a8a..00000000
--- a/docs/api/html/vpn-plugins.html
+++ /dev/null
@@ -1,42 +0,0 @@
-
-
-
-
-Part V. VPN Plugin D-Bus API Reference: NetworkManager Reference Manual
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-Part V. VPN Plugin D-Bus API Reference

-

-
Table of Contents

-

-
VPN services

-

-org.freedesktop.NetworkManager.VPN.Plugin — VPN Service.
-

-
Types

-

-VPN Plugin D-Bus API Types
-

-

-

-

-

-
Generated by GTK-Doc V1.34.0

-
-
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5