From 70e18d99b8e3e77bb37e218d7ac582130156f8ef Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 25 Jan 2024 09:46:18 +0100 Subject: New upstream version 1.45.90 --- man/nm-settings-keyfile.xml | 47 ++++++++++++++++++++++++++++++--------------- 1 file changed, 31 insertions(+), 16 deletions(-) (limited to 'man/nm-settings-keyfile.xml') diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 8a249541..3f61aef1 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,8 +1,8 @@ -nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.44.2nm-settings-keyfileDescription of keyfile settings pluginDescription +nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.45.90nm-settings-keyfileDescription of keyfile settings pluginDescription NetworkManager is based on the concept of connection profiles that contain - network configuration (see nm-settings5 for details). The profiles can be + network configuration (see nm-settings-nmcli5 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.conf5. @@ -18,20 +18,27 @@ 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. Each section - corresponds to a setting name as described in the settings specification - (nm-settings5). Each configuration key/value - pair in the section is one of the properties listed in the settings - specification. The majority of properties of the specification is written - in the same format into the keyfile too. However - some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties 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". + 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-nmcli5). 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. @@ -129,7 +136,7 @@ id=4 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-settings5 + nm-settings-nmcli5 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 @@ -152,7 +159,11 @@ Example: address1=192.168.100.100/24 address2=10.1.1.5/24gateway=192.168.100.1routesroute1, 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/16ipv6 setting (section)PropertyKeyfile VariableFormatDescriptiondnslist of DNS IP addressesList of DNS servers. +Example: route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16routes (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=truerouting-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
ipv6 setting (section)PropertyKeyfile VariableFormatDescriptiondnslist 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. @@ -160,7 +171,11 @@ Example: address1=abbe::cafe/96 address2=2001::1234gateway=abbe::1routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. -Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403
serial setting (section)PropertyKeyfile VariableFormatDescriptionparity'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: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403routes (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=truerouting-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
serial setting (section)PropertyKeyfile VariableFormatDescriptionparity'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
vpn setting (section)PropertyKeyfile VariableFormatDescriptiondataseparate variables named after keys of the dictionaryThe keys of the data dictionary are used as variable names directly under [vpn] section. @@ -175,7 +190,7 @@ Example: password=Popocatepetl
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 Alsonm-settings5, + and should not be requested from the user.Files/etc/NetworkManager/system-connections/*See Alsonm-settings-nmcli5, nm-settings-ifcfg-rh5, NetworkManager8, NetworkManager.conf5, -- cgit 1.3.0-6-gf8a5