{"id":4651,"date":"2022-12-20T18:09:27","date_gmt":"2022-12-20T21:09:27","guid":{"rendered":"http:\/\/lode.uno\/linux-man\/index.php\/2022\/12\/20\/nmsettingskeyfile-man5\/"},"modified":"2022-12-20T18:09:27","modified_gmt":"2022-12-20T21:09:27","slug":"nmsettingskeyfile-man5","status":"publish","type":"post","link":"https:\/\/lode.uno\/linux-man\/2022\/12\/20\/nmsettingskeyfile-man5\/","title":{"rendered":"NM−SETTINGS−KEYFILE (man5)"},"content":{"rendered":"

NM\u2212SETTINGS\u2212KEYFILE<\/h1>\n

NAME<\/a>
DESCRIPTION<\/a>
FILE FORMAT<\/a>
DETAILS<\/a>
FILES<\/a>
SEE ALSO<\/a>
NOTES<\/a> <\/p>\n

\n

NAME <\/a> <\/h2>\n

nm-settings-keyfile \u2212 Description of keyfile<\/i> settings plugin<\/p>\n

DESCRIPTION <\/a> <\/h2>\n

NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings<\/b>(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<\/b>(5).<\/p>\n

The keyfile<\/i> plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has. The files are in a .ini\u2212style format and located in \/etc\/NetworkManager\/system\u2212connections\/, \/usr\/lib\/NetworkManager\/system\u2212connections\/ and \/run\/NetworkManager\/system\u2212connections\/. 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.<\/p>\n

FILE FORMAT <\/a> <\/h2>\n

The keyfile<\/i> config format is a simple .ini\u2212style format. It consists of sections (groups) of key\u2212value pairs. Each section corresponds to a setting name as described in the settings specification (nm-settings<\/b>(5)). 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<\/i> 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”. More information of the generic key file format can be found at GLib key file format<\/font><\/b> [1]<\/font><\/small> (Lines beginning with a ‘#’ are comments, lists are separated by character ; etc.).<\/font><\/p>\n

Users can create or modify the keyfile<\/i> 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<\/i>).<\/font><\/p>\n

Examples of keyfile configuration<\/b>.<\/font><\/p>\n

A sample configuration for an ethernet network:<\/b>
[connection]
id=Main eth0
uuid=27afa607\u2212ee36\u221243f0\u2212b8c3\u22129d245cdc4bb3
type=802\u22123\u2212ethernet
autoconnect=true<\/font><\/p>\n

[ipv4]
method=auto<\/font><\/p>\n

[802\u22123\u2212ethernet]
mac\u2212address=00:23:5a:47:1f:71<\/font><\/p>\n

A sample configuration for WPA\u2212EAP (PEAP with MSCHAPv2) and always\u2212ask secret:<\/b>
[connection]
id=CompanyWIFI
uuid=cdac6154\u2212a33b\u22124b15\u22129904\u2212666772cfa5ee
type=wifi
autoconnect=false<\/font><\/p>\n

[wifi]
ssid=CorpWLAN
mode=infrastructure
security=802\u221211\u2212wireless\u2212security<\/font><\/p>\n

[wifi\u2212security]
key\u2212mgmt=wpa\u2212eap<\/font><\/p>\n

[ipv4]
method=auto<\/font><\/p>\n

[ipv6]
method=auto<\/font><\/p>\n

[802\u22121x]
eap=peap;
identity=joe
ca\u2212cert=\/home\/joe\/.cert\/corp.crt
phase1\u2212peapver=1
phase2\u2212auth=mschapv2
password\u2212flags=2<\/font><\/p>\n

A sample configuration for openvpn:<\/b>
[connection]
id=RedHat\u2212openvpn
uuid=7f9b3356\u2212b210\u22124c0e\u22128123\u2212bd116c9c280f
type=vpn
timestamp=1385401165<\/font><\/p>\n

[vpn]
service\u2212type=org.freedesktop.NetworkManager.openvpn
connection\u2212type=password
password\u2212flags=3
remote=ovpn.my\u2212company.com
cipher=AES\u2212256\u2212CBC
reneg\u2212seconds=0
port=443
username=joe
ca=\/etc\/openvpn\/ISCA.pem
tls\u2212remote=ovpn.my\u2212company.com<\/font><\/p>\n

[ipv6]
method=auto<\/font><\/p>\n

[ipv4]
method=auto
ignore\u2212auto\u2212dns=true
never\u2212default=true<\/font><\/p>\n

A sample configuration for a bridge and a bridge port:<\/b>
[connection] [connection]
id=MainBridge id=br\u2212port\u22121
uuid=171ae855\u2212a0ab\u221242b6\u2212bd0c\u221260f5812eea9d uuid=d6e8ae98\u221271f8\u22124b3d\u22129d2d\u22122e26048fe794
interface\u2212name=MainBridge interface\u2212name=em1
type=bridge type=ethernet
master=MainBridge
[bridge] slave\u2212type=bridge
interface\u2212name=MainBridge<\/font><\/p>\n

A sample configuration for a VLAN:<\/b>
[connection]
id=VLAN for building 4A
uuid=8ce1c9e0\u2212ce7a\u22124d2c\u2212aa28\u2212077dda09dd7e
interface\u2212name=VLAN\u22124A
type=vlan<\/font><\/p>\n

[vlan]
interface\u2212name=VLAN\u22124A
parent=eth0
id=4<\/font><\/p>\n

DETAILS <\/a> <\/h2>\n

keyfile<\/i> plugin variables for the majority of NetworkManager properties have one\u2212to\u2212one 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<\/i> plugin are listed below. Refer to nm-settings<\/b>(5) for all available settings and properties and their description.<\/font><\/p>\n

Name aliases<\/b>. Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore keyfile<\/i> introduces aliases that can be used instead of the names.<\/font><\/p>\n

setting name keyfile alias<\/i>
802\u22123\u2212ethernet = ethernet
802\u221211\u2212wireless = wifi
802\u221211\u2212wireless\u2212security = wifi\u2212security<\/font><\/p>\n

Table\u00a01.\u00a0bridge setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a02.\u00a0infiniband setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a03.\u00a0ipv4 setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a04.\u00a0ipv6 setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a05.\u00a0serial setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a06.\u00a0vpn setting (section)
\u00a0 \u00a0<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a07.\u00a0wifi\u2212p2p setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a08.\u00a0802\u22123\u2212ethernet setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a09.\u00a0802\u221211\u2212wireless setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Table\u00a010.\u00a0wpan setting (section)<\/b><\/font><\/p>\n

\"Image<\/b><\/font><\/p>\n

Secret flags<\/b>
Each secret property in a NetworkManager setting has an associated flags<\/i> property that describes how to handle that secret. In the keyfile<\/i> plugin, the value of \u2212flags<\/i> variable is a decimal number (0 \u2212 7) defined as a sum of the following values:<\/font><\/p>\n

\u2022 0 \u2212 (NM owned) \u2212 the system is responsible for providing and storing this secret.<\/font><\/p>\n

\u2022 1 \u2212 (agent\u2212owned) \u2212 a user\u2212session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it.<\/font><\/p>\n

\u2022 2 \u2212 (not\u2212saved) \u2212 this secret should not be saved but should be requested from the user each time it is required.<\/font><\/p>\n

\u2022 4 \u2212 (not\u2212required) \u2212 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.<\/font><\/p>\n

FILES <\/a> <\/h2>\n

\/etc\/NetworkManager\/system\u2212connections\/*<\/font><\/p>\n

SEE ALSO <\/a> <\/h2>\n

nm-settings<\/b>(5), nm-settings-ifcfg-rh<\/b>(5), NetworkManager<\/b>(8), NetworkManager.conf<\/b>(5), nmcli<\/b>(1), nmcli-examples<\/b>(7)<\/font><\/p>\n

NOTES <\/a> <\/h2>\n\n\n
<\/td>\n\n

1.<\/font><\/p>\n<\/td>\n

<\/td>\n\n

GLib key file format<\/font><\/p>\n<\/td>\n

 <\/td>\n<\/tr>\n<\/table>\n

https:\/\/developer.gnome.org\/glib\/stable\/glib-Key-value-file-parser.html#glib-Key-value-file-parser.description<\/font><\/p>\n

\n","protected":false},"excerpt":{"rendered":"

nm-settings-keyfile \u2212 Description of keyfile settings plugin <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[959],"tags":[961,1291,1586],"class_list":["post-4651","post","type-post","status-publish","format-standard","hentry","category-5-formatos-de-ficheros","tag-961","tag-man5","tag-nm-settings-keyfile"],"gutentor_comment":0,"_links":{"self":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/4651","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/comments?post=4651"}],"version-history":[{"count":0,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/posts\/4651\/revisions"}],"wp:attachment":[{"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/media?parent=4651"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/categories?post=4651"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lode.uno\/linux-man\/wp-json\/wp\/v2\/tags?post=4651"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}