diff options
| author | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
| commit | 2c032d8f1c6292c1338a615e6ec40252889ba85c (patch) | |
| tree | 1f77182220b2b0264288ba4a476ab47e5bc48716 /docs/api | |
| parent | 33491bc4279481db8ae47213e34a6d695a0e8830 (diff) | |
Imported Upstream version 1.0.0 upstream/1.0.0
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/Makefile.am | 36 | ||||
| -rw-r--r-- | docs/api/Makefile.in | 31 | ||||
| -rw-r--r-- | docs/api/html/index.html | 2 | ||||
| -rw-r--r-- | docs/api/html/ref-migrating.html | 6 | ||||
| -rw-r--r-- | docs/api/html/ref-settings.html | 1561 | ||||
| -rw-r--r-- | docs/api/html/spec.html | 140 | ||||
| -rw-r--r-- | docs/api/network-manager-docs.xml | 12 | ||||
| -rw-r--r-- | docs/api/settings-spec.xml | 2110 | ||||
| -rw-r--r-- | docs/api/settings-spec.xsl | 49 | ||||
| -rw-r--r-- | docs/api/spec.html | 140 | ||||
| -rw-r--r-- | docs/api/version.xml | 2 |
11 files changed, 1424 insertions, 2665 deletions
diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am index 3ca46033..5283f73f 100644 --- a/docs/api/Makefile.am +++ b/docs/api/Makefile.am @@ -11,7 +11,19 @@ OTHER_FILES= \ $(top_srcdir)/tools/doc-generator.xsl \ $(top_srcdir)/introspection/generic-types.xml -GENERATED_FILES = spec.html settings-spec.xml +GENERATED_FILES = spec.html + +if SETTING_DOCS_AVAILABLE + +settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm/nm-setting-docs.xml + $(AM_V_GEN) xsltproc --output $@ $^ + +# Top-level SGML file includes (depends on) settings-spec.xml +$(DOC_MAIN_SGML_FILE): settings-spec.xml + +GENERATED_FILES += settings-spec.xml + +endif if ENABLE_GTK_DOC @@ -20,17 +32,10 @@ spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp mkdir -p $(builddir)/html/ cp spec.html $(builddir)/html/ -settings-spec.xml: $(top_builddir)/tools/generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la - rm -f $(builddir)/settings-spec.xml - $(top_builddir)/tools/generate-settings-spec book $(builddir)/settings-spec.xml - all: $(GENERATED_FILES) endif -# Top-level SGML file includes (depends on) settings-spec.xml -$(DOC_MAIN_SGML_FILE): settings-spec.xml - #################################### # The name of the module. @@ -47,6 +52,9 @@ MKDB_OPTIONS=--sgml-mode --output-format=xml # Extra options to supply to gtkdoc-mktmpl MKTMPL_OPTIONS= +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS=--path="$(abs_srcdir)" + # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ version.xml \ @@ -57,9 +65,15 @@ include $(top_srcdir)/gtk-doc.make #################################### -EXTRA_DIST += version.xml.in $(GENERATED_FILES) +EXTRA_DIST += version.xml.in settings-spec.xsl $(GENERATED_FILES) CLEANFILES += html/* tmpl/* xml/* \ NetworkManager-sections.txt \ - NetworkManager-overrides.txt \ - $(GENERATED_FILES) + NetworkManager-overrides.txt +if BUILD_SETTING_DOCS +CLEANFILES += settings-spec.xml +endif + +if ENABLE_GTK_DOC +CLEANFILES += spec.html +endif diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in index ed0643e3..fb97c833 100644 --- a/docs/api/Makefile.in +++ b/docs/api/Makefile.in @@ -83,8 +83,11 @@ PRE_UNINSTALL = : POST_UNINSTALL = : build_triplet = @build@ host_triplet = @host@ +@SETTING_DOCS_AVAILABLE_TRUE@am__append_1 = settings-spec.xml DIST_COMMON = $(top_srcdir)/gtk-doc.make $(srcdir)/Makefile.in \ $(srcdir)/Makefile.am $(srcdir)/version.xml.in +@BUILD_SETTING_DOCS_TRUE@am__append_2 = settings-spec.xml +@ENABLE_GTK_DOC_TRUE@am__append_3 = spec.html subdir = docs/api ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 am__aclocal_m4_deps = $(top_srcdir)/m4/ax_lib_readline.m4 \ @@ -136,6 +139,8 @@ AUTOCONF = @AUTOCONF@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ AWK = @AWK@ +BLUEZ5_CFLAGS = @BLUEZ5_CFLAGS@ +BLUEZ5_LIBS = @BLUEZ5_LIBS@ CC = @CC@ CCDEPMODE = @CCDEPMODE@ CFLAGS = @CFLAGS@ @@ -259,6 +264,7 @@ NEWT_CFLAGS = @NEWT_CFLAGS@ NEWT_LIBS = @NEWT_LIBS@ NM = @NM@ NMEDIT = @NMEDIT@ +NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT = @NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT@ NM_MAJOR_VERSION = @NM_MAJOR_VERSION@ NM_MICRO_VERSION = @NM_MICRO_VERSION@ NM_MINOR_VERSION = @NM_MINOR_VERSION@ @@ -278,6 +284,7 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@ PACKAGE_URL = @PACKAGE_URL@ PACKAGE_VERSION = @PACKAGE_VERSION@ PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ PKG_CONFIG = @PKG_CONFIG@ PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ @@ -304,7 +311,7 @@ SYSTEMD_INHIBIT_LIBS = @SYSTEMD_INHIBIT_LIBS@ SYSTEMD_LOGIN_CFLAGS = @SYSTEMD_LOGIN_CFLAGS@ SYSTEMD_LOGIN_LIBS = @SYSTEMD_LOGIN_LIBS@ SYSTEM_CA_PATH = @SYSTEM_CA_PATH@ -UDEV_BASE_DIR = @UDEV_BASE_DIR@ +UDEV_DIR = @UDEV_DIR@ USE_NLS = @USE_NLS@ UUID_CFLAGS = @UUID_CFLAGS@ UUID_LIBS = @UUID_LIBS@ @@ -394,7 +401,7 @@ OTHER_FILES = \ $(top_srcdir)/tools/doc-generator.xsl \ $(top_srcdir)/introspection/generic-types.xml -GENERATED_FILES = spec.html settings-spec.xml +GENERATED_FILES = spec.html $(am__append_1) #################################### @@ -411,6 +418,9 @@ MKDB_OPTIONS = --sgml-mode --output-format=xml # Extra options to supply to gtkdoc-mktmpl MKTMPL_OPTIONS = +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS = --path="$(abs_srcdir)" + # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ version.xml \ @@ -440,7 +450,7 @@ SETUP_FILES = \ #################################### EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in \ - $(GENERATED_FILES) + settings-spec.xsl $(GENERATED_FILES) DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ html-build.stamp pdf-build.stamp \ tmpl.stamp sgml.stamp html.stamp pdf.stamp @@ -459,7 +469,7 @@ REPORT_FILES = \ CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) html/* \ tmpl/* xml/* NetworkManager-sections.txt \ - NetworkManager-overrides.txt $(GENERATED_FILES) + NetworkManager-overrides.txt $(am__append_2) $(am__append_3) @ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = @ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp @ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = @@ -701,20 +711,19 @@ uninstall-am: uninstall-local uninstall-am uninstall-local +@SETTING_DOCS_AVAILABLE_TRUE@settings-spec.xml: settings-spec.xsl $(top_builddir)/libnm/nm-setting-docs.xml +@SETTING_DOCS_AVAILABLE_TRUE@ $(AM_V_GEN) xsltproc --output $@ $^ + +# Top-level SGML file includes (depends on) settings-spec.xml +@SETTING_DOCS_AVAILABLE_TRUE@$(DOC_MAIN_SGML_FILE): settings-spec.xml + @ENABLE_GTK_DOC_TRUE@spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp @ENABLE_GTK_DOC_TRUE@ $(XSLTPROC) --path "$(top_builddir)/introspection:$(top_srcdir)/introspection" $(top_srcdir)/tools/doc-generator.xsl $(top_builddir)/introspection/all.xml > spec.html @ENABLE_GTK_DOC_TRUE@ mkdir -p $(builddir)/html/ @ENABLE_GTK_DOC_TRUE@ cp spec.html $(builddir)/html/ -@ENABLE_GTK_DOC_TRUE@settings-spec.xml: $(top_builddir)/tools/generate-settings-spec $(top_builddir)/libnm-util/libnm-util.la -@ENABLE_GTK_DOC_TRUE@ rm -f $(builddir)/settings-spec.xml -@ENABLE_GTK_DOC_TRUE@ $(top_builddir)/tools/generate-settings-spec book $(builddir)/settings-spec.xml - @ENABLE_GTK_DOC_TRUE@all: $(GENERATED_FILES) -# Top-level SGML file includes (depends on) settings-spec.xml -$(DOC_MAIN_SGML_FILE): settings-spec.xml - @ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) @ENABLE_GTK_DOC_FALSE@all-local: diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 08c517de..be7c56f5 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -14,7 +14,7 @@ <div class="titlepage"> <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager D-Bus Reference Manual</p></th></tr></table></div> -<div><p class="releaseinfo">Version 0.9.10.0 +<div><p class="releaseinfo">Version 1.0.0 </p></div> <div><p class="copyright">Copyright © 2012 The NetworkManager Authors</p></div> <div><div class="legalnotice"> diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html index 00545851..e5730a67 100644 --- a/docs/api/html/ref-migrating.html +++ b/docs/api/html/ref-migrating.html @@ -256,7 +256,7 @@ are now string-based permissions. The mapping is as follows: </p> <div class="table"> -<a name="id-1.4.3.7.3.2"></a><p class="title"><b>Table 26. </b></p> +<a name="id-1.4.3.7.3.2"></a><p class="title"><b>Table 27. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> @@ -424,7 +424,7 @@ following values: </p> <div class="table"> -<a name="id-1.4.3.13.2.1"></a><p class="title"><b>Table 27. </b></p> +<a name="id-1.4.3.13.2.1"></a><p class="title"><b>Table 28. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> @@ -496,7 +496,7 @@ their replacements: </p> <div class="table"> -<a name="id-1.4.3.14.2.2"></a><p class="title"><b>Table 28. </b></p> +<a name="id-1.4.3.14.2.2"></a><p class="title"><b>Table 29. </b></p> <div class="table-contents"><table border="1"> <colgroup> <col> diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index dbaf10d2..d8fa0906 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -36,8 +36,6 @@ <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> <a name="id-1.3.3"></a>Configuration Settings</h2></div></div></div> -<p> -</p> <div class="table"> <a name="id-1.3.3.2.1"></a><p class="title"><b>Table 1. 802-1x setting</b></p> <div class="table-contents"><table summary="802-1x setting" border="1"> @@ -55,16 +53,40 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">altsubject-matches</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">anonymous-identity</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">802-1x</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td> +</tr> +<tr> +<td><pre class="screen">ca-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>Contains the CA 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. 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.</td> +</tr> +<tr> +<td><pre class="screen">ca-path</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">client-cert</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">eap</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>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.</td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">identity</pre></td> @@ -73,10 +95,10 @@ <td>Identity string for EAP authentication methods. Often the user's user or login name.</td> </tr> <tr> -<td><pre class="screen">anonymous-identity</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td> +<td><pre class="screen">802-1x</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">pac-file</pre></td> @@ -85,180 +107,155 @@ <td>UTF-8 encoded file path containing PAC for EAP-FAST.</td> </tr> <tr> -<td><pre class="screen">ca-cert</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>Contains the CA 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 NULL 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.</td> -</tr> -<tr> -<td><pre class="screen">ca-path</pre></td> +<td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</td> </tr> <tr> -<td><pre class="screen">subject-match</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> -<td><pre class="screen">altsubject-matches</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">password-raw</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">client-cert</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 NULL byte.</td> +<td><pre class="screen">password-raw-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Flags indicating how to handle the "password-raw" property.</td> </tr> <tr> -<td><pre class="screen">phase1-peapver</pre></td> +<td><pre class="screen">phase1-fast-provisioning</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Forces which PEAP version is used when PEAP is set as the EAP method in '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.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase1-peaplabel</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">phase1-fast-provisioning</pre></td> +<td><pre class="screen">phase1-peapver</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed 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.</td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">phase2-altsubject-matches</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-auth</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td> +<td>Specifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td> </tr> <tr> <td><pre class="screen">phase2-autheap</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel 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.</td> +<td>Specifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel 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.</td> </tr> <tr> <td><pre class="screen">phase2-ca-cert</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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'; two are currentlysupported: 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 NULL 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.</td> +<td><pre class="screen"></pre></td> +<td>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"; 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.</td> </tr> <tr> <td><pre class="screen">phase2-ca-path</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">phase2-subject-match</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">phase2-client-cert</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>Substring to be matched against the subject of the certificate presented by the authentication server during the inner 'phase2' authentication. When unset, no verification of the authentication server certificate's subject is performed.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">phase2-altsubject-matches</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">phase2-private-key</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>List of strings to be matched against 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.</td> +<td>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 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.</td> </tr> <tr> -<td><pre class="screen">phase2-client-cert</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 NULL byte.</td> +<td><pre class="screen">phase2-private-key-password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">password</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">phase2-private-key-password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>UTF-8 encoded password used for EAP authentication methods.</td> +<td>Flags indicating how to handle the "phase2-private-key-password" property.</td> </tr> <tr> -<td><pre class="screen">password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the 802.1x password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">phase2-subject-match</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">password-raw</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 'password' and 'password-raw' are given, 'password' is preferred.</td> +<td><pre class="screen">pin</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>PIN used for EAP authentication methods.</td> </tr> <tr> -<td><pre class="screen">password-raw-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the 802.1x password byte array. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">pin-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Flags indicating how to handle the "pin" property.</td> </tr> <tr> <td><pre class="screen">private-key</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 NULL 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 and ending with a terminating NULL 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.</td> +<td><pre class="screen"></pre></td> +<td>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 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.</td> </tr> <tr> <td><pre class="screen">private-key-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">private-key-password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the 802.1x private key password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> -</tr> -<tr> -<td><pre class="screen">phase2-private-key</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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 NULL 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 and ending with a terminating NULL 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.</td> -</tr> -<tr> -<td><pre class="screen">phase2-private-key-password</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.</td> -</tr> -<tr> -<td><pre class="screen">phase2-private-key-password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the 802.1x phase2 private key password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td>Flags indicating how to handle the "private-key-password" property.</td> </tr> <tr> -<td><pre class="screen">pin</pre></td> +<td><pre class="screen">subject-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>PIN used for EAP authentication methods.</td> -</tr> -<tr> -<td><pre class="screen">pin-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the 802.1x PIN. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">system-ca-certs</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>When TRUE, overrides '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.</td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.2"></a><p class="title"><b>Table 2. adsl setting</b></p> +<a name="id-1.3.3.3.1"></a><p class="title"><b>Table 2. adsl setting</b></p> <div class="table-contents"><table summary="adsl setting" border="1"> <colgroup> <col> @@ -274,60 +271,59 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">encapsulation</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">adsl</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</td> </tr> <tr> -<td><pre class="screen">username</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>Username used to authenticate with the pppoa service.</td> +<td><pre class="screen">adsl</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Password used to authenticate with the pppoa service.</td> +<td>Password used to authenticate with the ADSL service.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the ADSL password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">protocol</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>ADSL connection protocol.</td> +<td>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</td> </tr> <tr> -<td><pre class="screen">encapsulation</pre></td> +<td><pre class="screen">username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Encapsulation of ADSL connection</td> +<td>Username used to authenticate with the ADSL service.</td> </tr> <tr> -<td><pre class="screen">vpi</pre></td> +<td><pre class="screen">vci</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>VPI of ADSL connection</td> +<td>VCI of ADSL connection</td> </tr> <tr> -<td><pre class="screen">vci</pre></td> +<td><pre class="screen">vpi</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>VCI of ADSL connection</td> +<td>VPI of ADSL connection</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.3"></a><p class="title"><b>Table 3. bluetooth setting</b></p> +<a name="id-1.3.3.4.1"></a><p class="title"><b>Table 3. bluetooth setting</b></p> <div class="table-contents"><table summary="bluetooth setting" border="1"> <colgroup> <col> @@ -343,30 +339,29 @@ </tr></thead> <tbody> <tr> +<td><pre class="screen">bdaddr</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>The Bluetooth address of the device.</td> +</tr> +<tr> <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">bluetooth</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">bdaddr</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>The Bluetooth address of the device</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</td> +<td>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.4"></a><p class="title"><b>Table 4. bond setting</b></p> +<a name="id-1.3.3.5.1"></a><p class="title"><b>Table 4. bond setting</b></p> <div class="table-contents"><table summary="bond setting" border="1"> <colgroup> <col> @@ -382,30 +377,29 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">bond</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</td> </tr> <tr> -<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>The name of the virtual in-kernel bonding network interface</td> +<td><pre class="screen">bond</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">options</pre></td> -<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen"></pre></td> -<td>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]).</td> +<td>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]).</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.5"></a><p class="title"><b>Table 5. bridge setting</b></p> +<a name="id-1.3.3.6.1"></a><p class="title"><b>Table 5. bridge setting</b></p> <div class="table-contents"><table summary="bridge setting" border="1"> <colgroup> <col> @@ -421,34 +415,10 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">bridge</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">interface-name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>The name of the virtual in-kernel bridging network interface</td> -</tr> -<tr> -<td><pre class="screen">mac-address</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>The MAC address of the bridge</td> -</tr> -<tr> -<td><pre class="screen">stp</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</td> -</tr> -<tr> -<td><pre class="screen">priority</pre></td> +<td><pre class="screen">ageing-time</pre></td> <td><pre class="screen">uint32</pre></td> -<td><pre class="screen">32768</pre></td> -<td>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.</td> +<td><pre class="screen">300</pre></td> +<td>The Ethernet MAC address aging time, in seconds.</td> </tr> <tr> <td><pre class="screen">forward-delay</pre></td> @@ -463,24 +433,47 @@ <td>The Spanning Tree Protocol (STP) hello time, in seconds.</td> </tr> <tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</td> +</tr> +<tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match.</td> +</tr> +<tr> <td><pre class="screen">max-age</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">20</pre></td> <td>The Spanning Tree Protocol (STP) maximum message age, in seconds.</td> </tr> <tr> -<td><pre class="screen">ageing-time</pre></td> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">bridge</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">priority</pre></td> <td><pre class="screen">uint32</pre></td> -<td><pre class="screen">300</pre></td> -<td>The Ethernet MAC address aging time, in seconds.</td> +<td><pre class="screen">32768</pre></td> +<td>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</td> +</tr> +<tr> +<td><pre class="screen">stp</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.6"></a><p class="title"><b>Table 6. bridge-port setting</b></p> +<a name="id-1.3.3.7.1"></a><p class="title"><b>Table 6. bridge-port setting</b></p> <div class="table-contents"><table summary="bridge-port setting" border="1"> <colgroup> <col> @@ -496,16 +489,16 @@ </tr></thead> <tbody> <tr> +<td><pre class="screen">hairpin-mode</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>Enables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</td> +</tr> +<tr> <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">bridge-port</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">priority</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">32</pre></td> -<td>The Spanning Tree Protocol (STP) priority of this bridge port</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">path-cost</pre></td> @@ -514,18 +507,17 @@ <td>The Spanning Tree Protocol (STP) port cost for destinations via this port.</td> </tr> <tr> -<td><pre class="screen">hairpin-mode</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.</td> +<td><pre class="screen">priority</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">32</pre></td> +<td>The Spanning Tree Protocol (STP) priority of this bridge port.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.7"></a><p class="title"><b>Table 7. cdma setting</b></p> +<a name="id-1.3.3.8.1"></a><p class="title"><b>Table 7. cdma setting</b></p> <div class="table-contents"><table summary="cdma setting" border="1"> <colgroup> <col> @@ -544,39 +536,38 @@ <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">cdma</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">number</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">username</pre></td> +<td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">password</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> -<td><pre class="screen">password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the CDMA password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.8"></a><p class="title"><b>Table 8. connection setting</b></p> +<a name="id-1.3.3.9.1"></a><p class="title"><b>Table 8. connection setting</b></p> <div class="table-contents"><table summary="connection setting" border="1"> <colgroup> <col> @@ -592,96 +583,101 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">connection</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">autoconnect</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">autoconnect-priority</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">0</pre></td> +<td>The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority.</td> +</tr> +<tr> +<td><pre class="screen">gateway-ping-timeout</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</td> </tr> <tr> <td><pre class="screen">id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>User-readable connection identifier/name. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it.</td> +<td>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</td> </tr> <tr> -<td><pre class="screen">uuid</pre></td> +<td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID 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 user changes the connection's 'id', but should be recreated when the Wi-Fi SSID, mobile broadband network provider, or the connection type changes.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">master</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Interface name 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 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.</td> +<td>Interface name of the master device or UUID of the master connection.</td> </tr> <tr> -<td><pre class="screen">type</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>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).</td> +<td><pre class="screen">connection</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">permissions</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>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 a user is allowed to access this connection if and only if they are in this array. 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 (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</td> -</tr> -<tr> -<td><pre class="screen">autoconnect</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>If TRUE, NetworkManager will activate this connection when its network resources are available. If FALSE, the connection must be manually activated by the user or some other mechanism.</td> -</tr> -<tr> -<td><pre class="screen">timestamp</pre></td> -<td><pre class="screen">uint64</pre></td> -<td><pre class="screen">0</pre></td> -<td>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully 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).</td> +<td><pre class="screen">[]</pre></td> +<td>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 a user is allowed to access this connection if and only if they are in this list. 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.</td> </tr> <tr> <td><pre class="screen">read-only</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</td> +<td>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</td> </tr> <tr> -<td><pre class="screen">zone</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>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.</td> +<td><pre class="screen">secondaries</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</td> </tr> <tr> -<td><pre class="screen">master</pre></td> +<td><pre class="screen">slave-type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Interface name of the master device or UUID of the master connection</td> +<td>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</td> </tr> <tr> -<td><pre class="screen">slave-type</pre></td> +<td><pre class="screen">timestamp</pre></td> +<td><pre class="screen">uint64</pre></td> +<td><pre class="screen">0</pre></td> +<td>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).</td> +</tr> +<tr> +<td><pre class="screen">type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</td> +<td>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).</td> </tr> <tr> -<td><pre class="screen">secondaries</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">uuid</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</td> +<td>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 "-").</td> </tr> <tr> -<td><pre class="screen">gateway-ping-timeout</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</td> +<td><pre class="screen">zone</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.9"></a><p class="title"><b>Table 9. dcb setting</b></p> +<a name="id-1.3.3.10.1"></a><p class="title"><b>Table 9. dcb setting</b></p> <div class="table-contents"><table summary="dcb setting" border="1"> <colgroup> <col> @@ -697,76 +693,70 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">dcb</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">app-fcoe-flags</pre></td> +<td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> </tr> <tr> -<td><pre class="screen">app-fcoe-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Specifies the flags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">app-fcoe-mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">"fabric"</pre></td> +<td>The FCoE controller mode; either "fabric" (default) or "vn2vn".</td> </tr> <tr> <td><pre class="screen">app-fcoe-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td>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 'enabled' flag.</td> -</tr> -<tr> -<td><pre class="screen">app-fcoe-mode</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">"fabric"</pre></td> -<td>The FCoe controller mode; either 'fabric' (default) or 'vn2vn'.</td> +<td>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> </tr> <tr> -<td><pre class="screen">app-iscsi-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Specifies the flags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">app-fip-flags</pre></td> +<td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> </tr> <tr> -<td><pre class="screen">app-iscsi-priority</pre></td> +<td><pre class="screen">app-fip-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td>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 'enabled' flag.</td> +<td>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> </tr> <tr> -<td><pre class="screen">app-fip-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Specifies the flags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">app-iscsi-flags</pre></td> +<td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> </tr> <tr> -<td><pre class="screen">app-fip-priority</pre></td> +<td><pre class="screen">app-iscsi-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td>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 'enabled' flag.</td> +<td>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</td> </tr> <tr> -<td><pre class="screen">priority-flow-control-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Specifies the flags for DCB Priority Flow Control. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">dcb</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> -<td><pre class="screen">priority-flow-control</pre></td> +<td><pre class="screen">priority-bandwidth</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td>An array of 8 uint 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. Allowed values are 0 (do not transmit pause) and 1 (transmit pause).</td> +<td>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 percent.</td> </tr> <tr> -<td><pre class="screen">priority-group-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Specifies the flags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">priority-flow-control</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">priority-group-id</pre></td> -<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen">priority-flow-control-flags</pre></td> +<td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> </tr> <tr> <td><pre class="screen">priority-group-bandwidth</pre></td> @@ -775,16 +765,22 @@ <td>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 percent.</td> </tr> <tr> -<td><pre class="screen">priority-bandwidth</pre></td> +<td><pre class="screen">priority-group-flags</pre></td> +<td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</td> +</tr> +<tr> +<td><pre class="screen">priority-group-id</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td>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 percent.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-strict-bandwidth</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td>An array of 8 uint 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. Allowed values are 0 (the priority may not utilize all bandwidth) or 1 (the priority may utilize all bandwidth).</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-traffic-class</pre></td> @@ -795,10 +791,33 @@ </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> +<div class="table"> +<a name="id-1.3.3.11.1"></a><p class="title"><b>Table 10. generic setting</b></p> +<div class="table-contents"><table summary="generic setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody><tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">generic</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr></tbody> +</table></div> +</div> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.10"></a><p class="title"><b>Table 10. gsm setting</b></p> +<a name="id-1.3.3.12.1"></a><p class="title"><b>Table 11. gsm setting</b></p> <div class="table-contents"><table summary="gsm setting" border="1"> <colgroup> <col> @@ -814,52 +833,46 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">apn</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">gsm</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">number</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</td> +<td><pre class="screen">home-only</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</td> </tr> <tr> -<td><pre class="screen">username</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td> +<td><pre class="screen">gsm</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> -<td><pre class="screen">password</pre></td> +<td><pre class="screen">network-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td> -</tr> -<tr> -<td><pre class="screen">password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the GSM password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">apn</pre></td> +<td><pre class="screen">number</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</td> </tr> <tr> -<td><pre class="screen">network-id</pre></td> +<td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">network-type</pre></td> -<td><pre class="screen">int32</pre></td> -<td><pre class="screen">-1</pre></td> -<td>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow network preference control.</td> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">pin</pre></td> @@ -869,29 +882,22 @@ </tr> <tr> <td><pre class="screen">pin-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the GSM SIM PIN. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> -</tr> -<tr> -<td><pre class="screen">allowed-bands</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">1</pre></td> -<td>Bitfield of allowed frequency bands.Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow frequency band control.</td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> +<td><pre class="screen"></pre></td> +<td>Flags indicating how to handle the "pin" property.</td> </tr> <tr> -<td><pre class="screen">home-only</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</td> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.11"></a><p class="title"><b>Table 11. infiniband setting</b></p> +<a name="id-1.3.3.13.1"></a><p class="title"><b>Table 12. infiniband setting</b></p> <div class="table-contents"><table summary="infiniband setting" border="1"> <colgroup> <col> @@ -907,16 +913,10 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">infiniband</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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).</td> +<td><pre class="screen"></pre></td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> @@ -925,30 +925,35 @@ <td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</td> </tr> <tr> -<td><pre class="screen">transport-mode</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>The IPoIB transport mode. Either 'datagram' or 'connected'.</td> +<td><pre class="screen">infiniband</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">p-key</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td>The InfiniBand P_Key. Either -1 for the default, or a 16-bit unsigned integer.</td> +<td>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 is set if it is a "full membership" P_Key.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>The interface name of the parent device, or NULL</td> +<td>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".</td> +</tr> +<tr> +<td><pre class="screen">transport-mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.12"></a><p class="title"><b>Table 12. ipv4 setting</b></p> +<a name="id-1.3.3.14.1"></a><p class="title"><b>Table 13. ipv4 setting</b></p> <div class="table-contents"><table summary="ipv4 setting" border="1"> <colgroup> <col> @@ -964,96 +969,113 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">ipv4</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">address-data</pre></td> +<td><pre class="screen">array of vardict</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">method</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">addresses</pre></td> +<td><pre class="screen">array of array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td>IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">dns</pre></td> -<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen">dhcp-client-id</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">dns-search</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">dhcp-hostname</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> +<td>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</td> </tr> <tr> -<td><pre class="screen">addresses</pre></td> -<td><pre class="screen">array of array of uint32</pre></td> -<td><pre class="screen"></pre></td> -<td>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. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</td> +<td><pre class="screen">dhcp-send-hostname</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">dns</pre></td> +<td><pre class="screen">array of uint32</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Array of IP addresses of DNS servers (as network-byte-order integers)</td> </tr> <tr> -<td><pre class="screen">address-labels</pre></td> +<td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>Internal use only</td> +<td><pre class="screen">[]</pre></td> +<td>Array of DNS search domains.</td> </tr> <tr> -<td><pre class="screen">routes</pre></td> -<td><pre class="screen">array of array of uint32</pre></td> +<td><pre class="screen">gateway</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</td> +<td>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</td> </tr> <tr> -<td><pre class="screen">ignore-auto-routes</pre></td> +<td><pre class="screen">ignore-auto-dns</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>When the 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.</td> +<td>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</td> </tr> <tr> -<td><pre class="screen">ignore-auto-dns</pre></td> +<td><pre class="screen">ignore-auto-routes</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</td> -</tr> -<tr> -<td><pre class="screen">dhcp-client-id</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">dhcp-send-hostname</pre></td> +<td><pre class="screen">may-fail</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td>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 empty and this property is TRUE, the current persistent hostname of the computer is sent.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">dhcp-hostname</pre></td> +<td><pre class="screen">method</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</td> +<td>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</td> +</tr> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ipv4</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">never-default</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">may-fail</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>If TRUE, allow overall network configuration to proceed even if IPv4 configuration 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 allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</td> +<td><pre class="screen">route-data</pre></td> +<td><pre class="screen">array of vardict</pre></td> +<td><pre class="screen"></pre></td> +<td>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 'gateway' entry, containing the gateway 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.</td> +</tr> +<tr> +<td><pre class="screen">route-metric</pre></td> +<td><pre class="screen">int64</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen 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.</td> +</tr> +<tr> +<td><pre class="screen">routes</pre></td> +<td><pre class="screen">array of array of uint32</pre></td> +<td><pre class="screen"></pre></td> +<td>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.)</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.13"></a><p class="title"><b>Table 13. ipv6 setting</b></p> +<a name="id-1.3.3.15.1"></a><p class="title"><b>Table 14. ipv6 setting</b></p> <div class="table-contents"><table summary="ipv6 setting" border="1"> <colgroup> <col> @@ -1069,84 +1091,113 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">ipv6</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">address-data</pre></td> +<td><pre class="screen">array of vardict</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">method</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">addresses</pre></td> +<td><pre class="screen">array of legacy IPv6 address struct (a(ayuay))</pre></td> <td><pre class="screen"></pre></td> -<td>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for Ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. Note: the 'shared' method is not yet supported.</td> +<td>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 (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>The specified name will be sent to the DHCP server when acquiring a lease.</td> +<td>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-send-hostname</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns</pre></td> <td><pre class="screen">array of byte array</pre></td> -<td><pre class="screen"></pre></td> -<td>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td> +<td><pre class="screen">[]</pre></td> +<td>Array of IP addresses of DNS servers (in network byte order)</td> </tr> <tr> <td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td> +<td><pre class="screen">[]</pre></td> +<td>Array of DNS search domains.</td> </tr> <tr> -<td><pre class="screen">addresses</pre></td> -<td><pre class="screen">array of (byte array, uint32, byte array)</pre></td> +<td><pre class="screen">gateway</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</td> +<td>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</td> </tr> <tr> -<td><pre class="screen">routes</pre></td> -<td><pre class="screen">array of (byte array, uint32, byte array, uint32)</pre></td> -<td><pre class="screen"></pre></td> -<td>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</td> +<td><pre class="screen">ignore-auto-dns</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</td> </tr> <tr> <td><pre class="screen">ignore-auto-routes</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">ignore-auto-dns</pre></td> +<td><pre class="screen">ip6-privacy</pre></td> +<td><pre class="screen">NMSettingIP6ConfigPrivacy (int32)</pre></td> +<td><pre class="screen"></pre></td> +<td>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: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</td> +</tr> +<tr> +<td><pre class="screen">may-fail</pre></td> <td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</td> +<td><pre class="screen">TRUE</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">method</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</td> +</tr> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ipv6</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">never-default</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">may-fail</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</td> +<td><pre class="screen">route-data</pre></td> +<td><pre class="screen">array of vardict</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">ip6-privacy</pre></td> -<td><pre class="screen">int32</pre></td> +<td><pre class="screen">route-metric</pre></td> +<td><pre class="screen">int64</pre></td> <td><pre class="screen">-1</pre></td> -<td>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: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</td> +<td>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen 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.</td> +</tr> +<tr> +<td><pre class="screen">routes</pre></td> +<td><pre class="screen">array of legacy IPv6 route struct (a(ayuayu))</pre></td> +<td><pre class="screen"></pre></td> +<td>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 (1 - 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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.14"></a><p class="title"><b>Table 14. 802-11-olpc-mesh setting</b></p> +<a name="id-1.3.3.16.1"></a><p class="title"><b>Table 15. 802-11-olpc-mesh setting</b></p> <div class="table-contents"><table summary="802-11-olpc-mesh setting" border="1"> <colgroup> <col> @@ -1162,18 +1213,6 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">802-11-olpc-mesh</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">ssid</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>SSID of the mesh network to join.</td> -</tr> -<tr> <td><pre class="screen">channel</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> @@ -1182,16 +1221,27 @@ <tr> <td><pre class="screen">dhcp-anycast-address</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the the request.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-olpc-mesh</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">ssid</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>SSID of the mesh network to join.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.15"></a><p class="title"><b>Table 15. ppp setting</b></p> +<a name="id-1.3.3.17.1"></a><p class="title"><b>Table 16. ppp setting</b></p> <div class="table-contents"><table summary="ppp setting" border="1"> <colgroup> <col> @@ -1207,46 +1257,64 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">ppp</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">baud</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">noauth</pre></td> +<td><pre class="screen">crtscts</pre></td> <td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>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.</td> +<td><pre class="screen">FALSE</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">refuse-eap</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the EAP authentication method will not be used.</td> +<td><pre class="screen">lcp-echo-failure</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">refuse-pap</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the PAP authentication method will not be used.</td> +<td><pre class="screen">lcp-echo-interval</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">refuse-chap</pre></td> +<td><pre class="screen">mppe-stateful</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the CHAP authentication method will not be used.</td> +<td>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td> </tr> <tr> -<td><pre class="screen">refuse-mschap</pre></td> +<td><pre class="screen">mru</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td> +</tr> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">ppp</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">no-vj-comp</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the MSCHAP authentication method will not be used.</td> +<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td> </tr> <tr> -<td><pre class="screen">refuse-mschapv2</pre></td> +<td><pre class="screen">noauth</pre></td> <td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td> +<td><pre class="screen">TRUE</pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">nobsdcomp</pre></td> @@ -1258,75 +1326,56 @@ <td><pre class="screen">nodeflate</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, 'deflate' compression will not be requested.</td> +<td>If TRUE, "deflate" compression will not be requested.</td> </tr> <tr> -<td><pre class="screen">no-vj-comp</pre></td> +<td><pre class="screen">refuse-chap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td> +<td>If TRUE, the CHAP authentication method will not be used.</td> </tr> <tr> -<td><pre class="screen">require-mppe</pre></td> +<td><pre class="screen">refuse-eap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) 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.</td> +<td>If TRUE, the EAP authentication method will not be used.</td> </tr> <tr> -<td><pre class="screen">require-mppe-128</pre></td> +<td><pre class="screen">refuse-mschap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) 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.</td> +<td>If TRUE, the MSCHAP authentication method will not be used.</td> </tr> <tr> -<td><pre class="screen">mppe-stateful</pre></td> +<td><pre class="screen">refuse-mschapv2</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td> +<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td> </tr> <tr> -<td><pre class="screen">crtscts</pre></td> +<td><pre class="screen">refuse-pap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td>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.</td> -</tr> -<tr> -<td><pre class="screen">baud</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>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.</td> -</tr> -<tr> -<td><pre class="screen">mru</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>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.</td> -</tr> -<tr> -<td><pre class="screen">mtu</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td> +<td>If TRUE, the PAP authentication method will not be used.</td> </tr> <tr> -<td><pre class="screen">lcp-echo-failure</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>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.</td> +<td><pre class="screen">require-mppe</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) 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.</td> </tr> <tr> -<td><pre class="screen">lcp-echo-interval</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>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.</td> +<td><pre class="screen">require-mppe-128</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) 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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.16"></a><p class="title"><b>Table 16. pppoe setting</b></p> +<a name="id-1.3.3.18.1"></a><p class="title"><b>Table 17. pppoe setting</b></p> <div class="table-contents"><table summary="pppoe setting" border="1"> <colgroup> <col> @@ -1345,39 +1394,38 @@ <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">pppoe</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> -<td><pre class="screen">service</pre></td> +<td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Password used to authenticate with the PPPoE service.</td> </tr> <tr> -<td><pre class="screen">username</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>Username used to authenticate with the PPPoE service.</td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> -<td><pre class="screen">password</pre></td> +<td><pre class="screen">service</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Password used to authenticate with the PPPoE service.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">password-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the PPPoE password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">username</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Username used to authenticate with the PPPoE service.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.17"></a><p class="title"><b>Table 17. serial setting</b></p> +<a name="id-1.3.3.19.1"></a><p class="title"><b>Table 18. serial setting</b></p> <div class="table-contents"><table summary="serial setting" border="1"> <colgroup> <col> @@ -1393,12 +1441,6 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">serial</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> <td><pre class="screen">baud</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">57600</pre></td> @@ -1408,19 +1450,19 @@ <td><pre class="screen">bits</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">8</pre></td> -<td>Byte-width of the serial communication. The 8 in '8n1' for example.</td> +<td>Byte-width of the serial communication. The 8 in "8n1" for example.</td> </tr> <tr> -<td><pre class="screen">parity</pre></td> -<td><pre class="screen">gchar</pre></td> -<td><pre class="screen">110</pre></td> -<td>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</td> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">serial</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> -<td><pre class="screen">stopbits</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">1</pre></td> -<td>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</td> +<td><pre class="screen">parity</pre></td> +<td><pre class="screen">byte</pre></td> +<td><pre class="screen"></pre></td> +<td>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</td> </tr> <tr> <td><pre class="screen">send-delay</pre></td> @@ -1428,13 +1470,18 @@ <td><pre class="screen">0</pre></td> <td>Time to delay between each byte sent to the modem, in microseconds.</td> </tr> +<tr> +<td><pre class="screen">stopbits</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">1</pre></td> +<td>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</td> +</tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.18"></a><p class="title"><b>Table 18. team setting</b></p> +<a name="id-1.3.3.20.1"></a><p class="title"><b>Table 19. team setting</b></p> <div class="table-contents"><table summary="team setting" border="1"> <colgroup> <col> @@ -1450,30 +1497,29 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">config</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">team</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>The name of the virtual in-kernel team network interface</td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</td> </tr> <tr> -<td><pre class="screen">config</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>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.</td> +<td><pre class="screen">team</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.19"></a><p class="title"><b>Table 19. team-port setting</b></p> +<a name="id-1.3.3.21.1"></a><p class="title"><b>Table 20. team-port setting</b></p> <div class="table-contents"><table summary="team-port setting" border="1"> <colgroup> <col> @@ -1489,24 +1535,23 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">config</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">team-port</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">config</pre></td> +<td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>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 dafault configuration is used. See man teamd.conf for the format details.</td> +<td><pre class="screen">team-port</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.20"></a><p class="title"><b>Table 20. vlan setting</b></p> +<a name="id-1.3.3.22.1"></a><p class="title"><b>Table 21. vlan setting</b></p> <div class="table-contents"><table summary="vlan setting" border="1"> <colgroup> <col> @@ -1522,54 +1567,53 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">vlan</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">interface-name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen"></pre></td> -<td>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by the 'mac-address' property of a 'wired' setting.</td> +<td><pre class="screen">egress-priority-map</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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".</td> </tr> <tr> -<td><pre class="screen">parent</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">flags</pre></td> +<td><pre class="screen">NMVlanFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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 a 'wired' setting with a 'mac-address' property.</td> +<td>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state).</td> </tr> <tr> <td><pre class="screen">id</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>The VLAN indentifier the interface created by this connection should be assigned.</td> -</tr> -<tr> -<td><pre class="screen">flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).</td> +<td>The VLAN identifier that the interface created by this connection should be assigned.</td> </tr> <tr> <td><pre class="screen">ingress-priority-map</pre></td> <td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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".</td> +</tr> +<tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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'.</td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</td> </tr> <tr> -<td><pre class="screen">egress-priority-map</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">vlan</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">parent</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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'.</td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.21"></a><p class="title"><b>Table 21. vpn setting</b></p> +<a name="id-1.3.3.23.1"></a><p class="title"><b>Table 22. vpn setting</b></p> <div class="table-contents"><table summary="vpn setting" border="1"> <colgroup> <col> @@ -1585,10 +1629,28 @@ </tr></thead> <tbody> <tr> +<td><pre class="screen">data</pre></td> +<td><pre class="screen">dict of string to string</pre></td> +<td><pre class="screen"></pre></td> +<td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td> +</tr> +<tr> <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">vpn</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">persistent</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">secrets</pre></td> +<td><pre class="screen">dict of string to string</pre></td> +<td><pre class="screen"></pre></td> +<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td> </tr> <tr> <td><pre class="screen">service-type</pre></td> @@ -1602,25 +1664,12 @@ <td><pre class="screen"></pre></td> <td>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.</td> </tr> -<tr> -<td><pre class="screen">data</pre></td> -<td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen"></pre></td> -<td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td> -</tr> -<tr> -<td><pre class="screen">secrets</pre></td> -<td><pre class="screen">dict of (string::string)</pre></td> -<td><pre class="screen"></pre></td> -<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td> -</tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.22"></a><p class="title"><b>Table 22. wimax setting</b></p> +<a name="id-1.3.3.24.1"></a><p class="title"><b>Table 23. wimax setting</b></p> <div class="table-contents"><table summary="wimax setting" border="1"> <colgroup> <col> @@ -1636,10 +1685,16 @@ </tr></thead> <tbody> <tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen"></pre></td> +<td>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).</td> +</tr> +<tr> <td><pre class="screen">name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen">wimax</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">network-name</pre></td> @@ -1647,19 +1702,12 @@ <td><pre class="screen"></pre></td> <td>Network Service Provider (NSP) name of the WiMAX network this connection should use.</td> </tr> -<tr> -<td><pre class="screen">mac-address</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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).</td> -</tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.23"></a><p class="title"><b>Table 23. 802-3-ethernet setting</b></p> +<a name="id-1.3.3.25.1"></a><p class="title"><b>Table 24. 802-3-ethernet setting</b></p> <div class="table-contents"><table summary="802-3-ethernet setting" border="1"> <colgroup> <col> @@ -1675,51 +1723,33 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">802-3-ethernet</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen">auto-negotiate</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">TRUE</pre></td> +<td>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set.</td> </tr> <tr> -<td><pre class="screen">port</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">cloned-mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>Specific port type to use if multiple 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.</td> -</tr> -<tr> -<td><pre class="screen">speed</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</td> +<td>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> </tr> <tr> <td><pre class="screen">duplex</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</td> -</tr> -<tr> -<td><pre class="screen">auto-negotiate</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">TRUE</pre></td> -<td>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</td> +<td>If specified, request that the device only use the specified duplex mode. Either "half" or "full".</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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).</td> -</tr> -<tr> -<td><pre class="screen">cloned-mac-address</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> +<td><pre class="screen"></pre></td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mac-address-blacklist</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> +<td><pre class="screen">[]</pre></td> <td>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).</td> </tr> <tr> @@ -1729,30 +1759,47 @@ <td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> </tr> <tr> -<td><pre class="screen">s390-subchannels</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-3-ethernet</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">port</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Identifies specific subchannels that this network device uses for communcation 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.</td> +<td>Specific port type to use if multiple 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.</td> </tr> <tr> <td><pre class="screen">s390-nettype</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</td> +<td>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</td> </tr> <tr> <td><pre class="screen">s390-options</pre></td> -<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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]).</td> +</tr> +<tr> +<td><pre class="screen">s390-subchannels</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">speed</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.24"></a><p class="title"><b>Table 24. 802-11-wireless setting</b></p> +<a name="id-1.3.3.26.1"></a><p class="title"><b>Table 25. 802-11-wireless setting</b></p> <div class="table-contents"><table summary="802-11-wireless setting" border="1"> <colgroup> <col> @@ -1768,70 +1815,52 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> -<td><pre class="screen">string</pre></td> -<td><pre class="screen">802-11-wireless</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> -</tr> -<tr> -<td><pre class="screen">ssid</pre></td> -<td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>SSID of the Wi-Fi network. Must be specified.</td> -</tr> -<tr> -<td><pre class="screen">mode</pre></td> +<td><pre class="screen">band</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Wi-Fi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">band</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">bssid</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> <td><pre class="screen">channel</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">bssid</pre></td> +<td><pre class="screen">cloned-mac-address</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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.</td> -</tr> -<tr> -<td><pre class="screen">rate</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</td> +<td><pre class="screen"></pre></td> +<td>If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> </tr> <tr> -<td><pre class="screen">tx-power</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</td> +<td><pre class="screen">hidden</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> -<td><pre class="screen">[]</pre></td> -<td>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).</td> +<td><pre class="screen"></pre></td> +<td>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).</td> </tr> <tr> -<td><pre class="screen">cloned-mac-address</pre></td> -<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">mac-address-blacklist</pre></td> +<td><pre class="screen">array of string</pre></td> <td><pre class="screen">[]</pre></td> -<td>If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</td> +<td>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").</td> </tr> <tr> -<td><pre class="screen">mac-address-blacklist</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">mode</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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').</td> +<td>Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> @@ -1840,30 +1869,47 @@ <td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> </tr> <tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-wireless</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> +</tr> +<tr> +<td><pre class="screen">rate</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</td> +</tr> +<tr> +<td><pre class="screen">security</pre></td> +<td><pre class="screen">None</pre></td> +<td><pre class="screen"></pre></td> +<td>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</td> +</tr> +<tr> <td><pre class="screen">seen-bssids</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>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.</td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">security</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">ssid</pre></td> +<td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</td> +<td>SSID of the Wi-Fi network. Must be specified.</td> </tr> <tr> -<td><pre class="screen">hidden</pre></td> -<td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> -<td>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</td> +<td><pre class="screen">tx-power</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> -</p> +<p><br class="table-break"></p> <div class="table"> -<a name="id-1.3.3.2.25"></a><p class="title"><b>Table 25. 802-11-wireless-security setting</b></p> +<a name="id-1.3.3.27.1"></a><p class="title"><b>Table 26. 802-11-wireless-security setting</b></p> <div class="table-contents"><table summary="802-11-wireless-security setting" border="1"> <colgroup> <col> @@ -1879,118 +1925,117 @@ </tr></thead> <tbody> <tr> -<td><pre class="screen">name</pre></td> +<td><pre class="screen">auth-alg</pre></td> <td><pre class="screen">string</pre></td> -<td><pre class="screen">802-11-wireless-security</pre></td> -<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +<td><pre class="screen"></pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">group</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>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".</td> </tr> <tr> <td><pre class="screen">key-mgmt</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</td> +<td>Key management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</td> </tr> <tr> -<td><pre class="screen">wep-tx-keyidx</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>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.</td> +<td><pre class="screen">leap-password</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</td> </tr> <tr> -<td><pre class="screen">auth-alg</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">leap-password-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Flags indicating how to handle the "leap-password" property.</td> </tr> <tr> -<td><pre class="screen">proto</pre></td> -<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">leap-username</pre></td> +<td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</td> +</tr> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">802-11-wireless-security</pre></td> +<td>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</td> </tr> <tr> <td><pre class="screen">pairwise</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>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'.</td> +<td><pre class="screen">[]</pre></td> +<td>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".</td> </tr> <tr> -<td><pre class="screen">group</pre></td> +<td><pre class="screen">proto</pre></td> <td><pre class="screen">array of string</pre></td> -<td><pre class="screen"></pre></td> -<td>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'.</td> +<td><pre class="screen">[]</pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">leap-username</pre></td> +<td><pre class="screen">psk</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td> +<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</td> </tr> <tr> -<td><pre class="screen">wep-key0</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">psk-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Flags indicating how to handle the "psk" property.</td> </tr> <tr> -<td><pre class="screen">wep-key1</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">wep-key-flags</pre></td> +<td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</td> </tr> <tr> -<td><pre class="screen">wep-key2</pre></td> -<td><pre class="screen">string</pre></td> +<td><pre class="screen">wep-key-type</pre></td> +<td><pre class="screen">NMWepKeyType (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_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 NM_WEP_KEY_TYPE_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.</td> </tr> <tr> -<td><pre class="screen">wep-key3</pre></td> +<td><pre class="screen">wep-key0</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>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.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">wep-key-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the WEP keys. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> -</tr> -<tr> -<td><pre class="screen">wep-key-type</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.</td> -</tr> -<tr> -<td><pre class="screen">psk</pre></td> +<td><pre class="screen">wep-key1</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">psk-flags</pre></td> -<td><pre class="screen">uint32</pre></td> -<td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the WPA PSK key. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td><pre class="screen">wep-key2</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">leap-password</pre></td> +<td><pre class="screen">wep-key3</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td> +<td>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.</td> </tr> <tr> -<td><pre class="screen">leap-password-flags</pre></td> +<td><pre class="screen">wep-tx-keyidx</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td>Flags indicating how to handle the LEAP password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +<td>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.</td> </tr> </tbody> </table></div> </div> -<p><br class="table-break"> - </p> +<p><br class="table-break"></p> </div> </div> <div class="footer"> diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index 84819cab..cf717b59 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -1,4 +1,4 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9.10.0</title><style type="text/css"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 1.0.0</title><style type="text/css"> body { font-family: sans-serif; @@ -97,7 +97,7 @@ margin-right: 4em; } - </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9.10.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> + </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 1.0.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> <p>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 @@ -162,11 +162,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div><div><h4>Returns</h4><dl><dt><code>active_connection</code> - <code>o</code></dt><dd> The path of the active connection object representing this active connection. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> - Connection was not provided by the settings service. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> - Unknown device. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionActivating</code></dt><dd>Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?</dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> ( a{sa{sv}}: connection, o: device, o: specific_object ) → o, o</h3><div class="docstring"> @@ -195,11 +191,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd><dt><code>active_connection</code> - <code>o</code></dt><dd> The path of the active connection object representing this active connection. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> - Connection was not provided by the settings service. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> - Unknown device. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> ( o: active_connection ) → nothing</h3><div class="docstring"> @@ -254,7 +246,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Set logging verbosity and which operations are logged. </div><div><h4>Parameters</h4><dl><dt><code>level</code> - <code>s</code></dt><dd> - One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE]. </dd><dt><code>domains</code> - <code>s</code></dt><dd> A combination of logging domains separated by commas (','), or "NONE" @@ -277,7 +269,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Get current logging verbosity level and operations domains. </div><div><h4>Returns</h4><dl><dt><code>level</code> - <code>s</code></dt><dd> - One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE]. </dd><dt><code>domains</code> - <code>s</code></dt><dd> For available domains see SetLogging() call. @@ -383,6 +375,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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. + </dd><dt><code>PrimaryConnectionType</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + 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. </dd><dt><code>ActivatingConnection</code> - <code>o</code> - <code>(read)</code></dt><dd> @@ -491,6 +489,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ ) → nothing</h3><div class="docstring"> Disconnects a device and prevents the device from automatically activating further connections without user intervention. + </div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Delete" id="org.freedesktop.NetworkManager.Device.Delete">Delete</a> ( + + ) → + nothing</h3><div class="docstring"> + Deletes a software device from NetworkManager and removes the interface from the system. + The method returns an error when called for a hardware device. </div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.StateChanged" id="org.freedesktop.NetworkManager.Device.StateChanged">StateChanged</a> ( u: new_state, u: old_state, u: reason )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>new_state</code> - @@ -603,7 +607,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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. + device, or setting this property to TRUE. This property cannot be + set to TRUE for default-unmanaged devices, since they never autoconnect. </dd><dt><code>FirmwareMissing</code> - <code>b</code> - <code>(read)</code></dt><dd> @@ -1212,6 +1217,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>b</code> - <code>(read)</code></dt><dd> Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). + </dd><dt><code>Parent</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the parent device of this VLAN device. </dd><dt><code>VlanId</code> - <code>u</code> - <code>(read)</code></dt><dd> @@ -1257,19 +1266,39 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) </dt><dd> A dictionary mapping property names to variant boxed values - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - - <code>s</code> - - <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Addresses</code> - <code>aau</code> - - <code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3 - elements of each tuple are in network byte order. Essentially: - [(addr, prefix, gateway), (addr, prefix, gateway), ...] - </dd><dt><code>Routes</code> - + <code>(read)</code></dt><dd> + 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 + </dd><dt><code>AddressData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Routes</code> - <code>aau</code> - - <code>(read)</code></dt><dd>Tuples 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), ...] + <code>(read)</code></dt><dd> + 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 + </dd><dt><code>RouteData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. </dd><dt><code>Nameservers</code> - <code>au</code> - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - @@ -1287,13 +1316,34 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) </dt><dd> A dictionary mapping property names to variant boxed values - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - - <code>s</code> - - <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Addresses</code> - <code>a(ayuay)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Routes</code> - + <code>(read)</code></dt><dd> + Array of tuples of IPv6 address/prefix/gateway. + + Deprecated: use AddressData and Gateway. + </dd><dt><code>AddressData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Routes</code> - <code>a(ayuayu)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd><dt><code>Nameservers</code> - + <code>(read)</code></dt><dd> + Tuples of IPv6 route/prefix/next-hop/metric. + + Deprecated: use RouteData + </dd><dt><code>RouteData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Nameservers</code> - <code>aay</code> - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - <code>as</code> - @@ -1539,7 +1589,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) </dt><dd> Nested settings maps containing secrets. - </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets" id="org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets">ClearSecrets</a> ( + + ) → + nothing</h3><div class="docstring"> + Clear the secrets belonging to this network connection profile. + </div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> ( ) → nothing</h3><div class="docstring"> @@ -2117,7 +2172,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Emitted when the plugin state changes. </div><div><h4>Parameters</h4><dl><dt><code>state</code> - <code>u</code> - (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + (<a xmlns="" href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a>) </dt><dd> The new state of the plugin. </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired" id="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired">SecretsRequired</a> ( @@ -2183,10 +2238,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>State</code> - <code>u</code> - <code>(read)</code> - (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + (<a xmlns="" href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a>) </dt><dd> The state of the plugin. - </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd> + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_SERVICE_STATE" id="type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a></h3><dl><dt><code>NM_VPN_SERVICE_STATE_UNKNOWN = 0</code></dt><dd> + The state of the VPN plugin is unknown. + </dd><dt><code>NM_VPN_SERVICE_STATE_INIT = 1</code></dt><dd> + The VPN plugin is initialized. + </dd><dt><code>NM_VPN_SERVICE_STATE_SHUTDOWN = 2</code></dt><dd> + (Not used.) + </dd><dt><code>NM_VPN_SERVICE_STATE_STARTING = 3</code></dt><dd> + The plugin is attempting to connect to a VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STARTED = 4</code></dt><dd> + The plugin has connected to a VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STOPPING = 5</code></dt><dd> + The plugin is disconnecting from the VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STOPPED = 6</code></dt><dd> + The plugin has disconnected from the VPN server. + </dd></dl><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd> Login failed. </dd><dt><code>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1</code></dt><dd> Connect failed. @@ -2295,6 +2364,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code> - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></code> - u</li><li><code><a href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></code> + - u</li><li><code><a href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a></code> - u</li><li><code><a href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></code> - u</li><li><code><a href="#type-String_String_Map">String_String_Map</a></code> - a{ s → s } diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index fadc8862..0f9c7dbb 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -54,7 +54,17 @@ setting names (like "wimax" or "bluetooth") to a dictionary of key/value pairs that represents each itself. </para> - <xi:include href="settings-spec.xml" /> + <xi:include href="settings-spec.xml"> + <xi:fallback> + <section> + <title>Configuration Settings</title> + <note><para> + (NetworkManager was built without full introspection support. Setting + documentation is not available.) + </para></note> + </section> + </xi:fallback> + </xi:include> <section id="secrets-flags"> <title>Secret flag types</title> <para> diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index a0c54945..24a413ae 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -1,1811 +1,303 @@ <?xml version="1.0"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">]><section> - <title>Configuration Settings</title> - <para> -<table> - <title>802-1x setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>802-1x</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>eap</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>identity</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry> - </row> - <row> - <entry><screen>anonymous-identity</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry> - </row> - <row> - <entry><screen>pac-file</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry> - </row> - <row> - <entry><screen>ca-cert</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>Contains the CA 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 NULL 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.</entry> - </row> - <row> - <entry><screen>ca-path</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>subject-match</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>altsubject-matches</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>client-cert</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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 NULL byte.</entry> - </row> - <row> - <entry><screen>phase1-peapver</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Forces which PEAP version is used when PEAP is set as the EAP method in '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.</entry> - </row> - <row> - <entry><screen>phase1-peaplabel</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>phase1-fast-provisioning</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed 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.</entry> - </row> - <row> - <entry><screen>phase2-auth</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry> - </row> - <row> - <entry><screen>phase2-autheap</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel 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.</entry> - </row> - <row> - <entry><screen>phase2-ca-cert</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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'; two are currentlysupported: 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 NULL 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.</entry> - </row> - <row> - <entry><screen>phase2-ca-path</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>phase2-subject-match</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Substring to be matched against the subject of the certificate presented by the authentication server during the inner 'phase2' authentication. When unset, no verification of the authentication server certificate's subject is performed.</entry> - </row> - <row> - <entry><screen>phase2-altsubject-matches</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>List of strings to be matched against 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.</entry> - </row> - <row> - <entry><screen>phase2-client-cert</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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 NULL byte.</entry> - </row> - <row> - <entry><screen>password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>UTF-8 encoded password used for EAP authentication methods.</entry> - </row> - <row> - <entry><screen>password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the 802.1x password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>password-raw</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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 'password' and 'password-raw' are given, 'password' is preferred.</entry> - </row> - <row> - <entry><screen>password-raw-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the 802.1x password byte array. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>private-key</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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 NULL 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 and ending with a terminating NULL 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.</entry> - </row> - <row> - <entry><screen>private-key-password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>private-key-password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the 802.1x private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>phase2-private-key</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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 NULL 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 and ending with a terminating NULL 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.</entry> - </row> - <row> - <entry><screen>phase2-private-key-password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.</entry> - </row> - <row> - <entry><screen>phase2-private-key-password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the 802.1x phase2 private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>pin</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>PIN used for EAP authentication methods.</entry> - </row> - <row> - <entry><screen>pin-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the 802.1x PIN. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>system-ca-certs</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When TRUE, overrides '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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>adsl setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>adsl</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>username</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Username used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry><screen>password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Password used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry><screen>password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the ADSL password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>protocol</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>ADSL connection protocol.</entry> - </row> - <row> - <entry><screen>encapsulation</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Encapsulation of ADSL connection</entry> - </row> - <row> - <entry><screen>vpi</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>VPI of ADSL connection</entry> - </row> - <row> - <entry><screen>vci</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>VCI of ADSL connection</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bluetooth setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>bluetooth</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>bdaddr</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>The Bluetooth address of the device</entry> - </row> - <row> - <entry><screen>type</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bond setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>bond</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>interface-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The name of the virtual in-kernel bonding network interface</entry> - </row> - <row> - <entry><screen>options</screen></entry> - <entry><screen>dict of (string::string)</screen></entry> - <entry><screen></screen></entry> - <entry>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]).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>bridge</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>interface-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The name of the virtual in-kernel bridging network interface</entry> - </row> - <row> - <entry><screen>mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>The MAC address of the bridge</entry> - </row> - <row> - <entry><screen>stp</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry> - </row> - <row> - <entry><screen>priority</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>32768</screen></entry> - <entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.</entry> - </row> - <row> - <entry><screen>forward-delay</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>15</screen></entry> - <entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry> - </row> - <row> - <entry><screen>hello-time</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>2</screen></entry> - <entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry> - </row> - <row> - <entry><screen>max-age</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>20</screen></entry> - <entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry> - </row> - <row> - <entry><screen>ageing-time</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>300</screen></entry> - <entry>The Ethernet MAC address aging time, in seconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge-port setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>bridge-port</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>priority</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>32</screen></entry> - <entry>The Spanning Tree Protocol (STP) priority of this bridge port</entry> - </row> - <row> - <entry><screen>path-cost</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>100</screen></entry> - <entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry> - </row> - <row> - <entry><screen>hairpin-mode</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>cdma setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>cdma</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>number</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</entry> - </row> - <row> - <entry><screen>username</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry><screen>password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry><screen>password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the CDMA password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>connection setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>connection</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>id</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>User-readable connection identifier/name. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it.</entry> - </row> - <row> - <entry><screen>uuid</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID 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 user changes the connection's 'id', but should be recreated when the Wi-Fi SSID, mobile broadband network provider, or the connection type changes.</entry> - </row> - <row> - <entry><screen>interface-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Interface name 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 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.</entry> - </row> - <row> - <entry><screen>type</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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).</entry> - </row> - <row> - <entry><screen>permissions</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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 a user is allowed to access this connection if and only if they are in this array. 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 (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry> - </row> - <row> - <entry><screen>autoconnect</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>If TRUE, NetworkManager will activate this connection when its network resources are available. If FALSE, the connection must be manually activated by the user or some other mechanism.</entry> - </row> - <row> - <entry><screen>timestamp</screen></entry> - <entry><screen>uint64</screen></entry> - <entry><screen>0</screen></entry> - <entry>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully 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).</entry> - </row> - <row> - <entry><screen>read-only</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</entry> - </row> - <row> - <entry><screen>zone</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>master</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Interface name of the master device or UUID of the master connection</entry> - </row> - <row> - <entry><screen>slave-type</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</entry> - </row> - <row> - <entry><screen>secondaries</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</entry> - </row> - <row> - <entry><screen>gateway-ping-timeout</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>dcb setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>dcb</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>app-fcoe-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Specifies the flags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>app-fcoe-priority</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>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 'enabled' flag.</entry> - </row> - <row> - <entry><screen>app-fcoe-mode</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>"fabric"</screen></entry> - <entry>The FCoe controller mode; either 'fabric' (default) or 'vn2vn'.</entry> - </row> - <row> - <entry><screen>app-iscsi-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Specifies the flags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>app-iscsi-priority</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>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 'enabled' flag.</entry> - </row> - <row> - <entry><screen>app-fip-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Specifies the flags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>app-fip-priority</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>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 'enabled' flag.</entry> - </row> - <row> - <entry><screen>priority-flow-control-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Specifies the flags for DCB Priority Flow Control. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>priority-flow-control</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>An array of 8 uint 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. Allowed values are 0 (do not transmit pause) and 1 (transmit pause).</entry> - </row> - <row> - <entry><screen>priority-group-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Specifies the flags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>priority-group-id</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>priority-group-bandwidth</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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 percent.</entry> - </row> - <row> - <entry><screen>priority-bandwidth</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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 percent.</entry> - </row> - <row> - <entry><screen>priority-strict-bandwidth</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>An array of 8 uint 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. Allowed values are 0 (the priority may not utilize all bandwidth) or 1 (the priority may utilize all bandwidth).</entry> - </row> - <row> - <entry><screen>priority-traffic-class</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>gsm setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>gsm</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>number</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</entry> - </row> - <row> - <entry><screen>username</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry><screen>password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry><screen>password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the GSM password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>apn</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>network-id</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>network-type</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow network preference control.</entry> - </row> - <row> - <entry><screen>pin</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>pin-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the GSM SIM PIN. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>allowed-bands</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>1</screen></entry> - <entry>Bitfield of allowed frequency bands.Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow frequency band control.</entry> - </row> - <row> - <entry><screen>home-only</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>infiniband setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>infiniband</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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).</entry> - </row> - <row> - <entry><screen>mtu</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry> - </row> - <row> - <entry><screen>transport-mode</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The IPoIB transport mode. Either 'datagram' or 'connected'.</entry> - </row> - <row> - <entry><screen>p-key</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>The InfiniBand P_Key. Either -1 for the default, or a 16-bit unsigned integer.</entry> - </row> - <row> - <entry><screen>parent</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The interface name of the parent device, or NULL</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv4 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>ipv4</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>method</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.</entry> - </row> - <row> - <entry><screen>dns</screen></entry> - <entry><screen>array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> - </row> - <row> - <entry><screen>dns-search</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> - </row> - <row> - <entry><screen>addresses</screen></entry> - <entry><screen>array of array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</entry> - </row> - <row> - <entry><screen>address-labels</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>Internal use only</entry> - </row> - <row> - <entry><screen>routes</screen></entry> - <entry><screen>array of array of uint32</screen></entry> - <entry><screen></screen></entry> - <entry>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. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</entry> - </row> - <row> - <entry><screen>ignore-auto-routes</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When the 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.</entry> - </row> - <row> - <entry><screen>ignore-auto-dns</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</entry> - </row> - <row> - <entry><screen>dhcp-client-id</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>dhcp-send-hostname</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>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 empty and this property is TRUE, the current persistent hostname of the computer is sent.</entry> - </row> - <row> - <entry><screen>dhcp-hostname</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry><screen>never-default</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</entry> - </row> - <row> - <entry><screen>may-fail</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>If TRUE, allow overall network configuration to proceed even if IPv4 configuration 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 allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv6 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>ipv6</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>method</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for Ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. Note: the 'shared' method is not yet supported.</entry> - </row> - <row> - <entry><screen>dhcp-hostname</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry><screen>dns</screen></entry> - <entry><screen>array of byte array</screen></entry> - <entry><screen></screen></entry> - <entry>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> - </row> - <row> - <entry><screen>dns-search</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> - </row> - <row> - <entry><screen>addresses</screen></entry> - <entry><screen>array of (byte array, uint32, byte array)</screen></entry> - <entry><screen></screen></entry> - <entry>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</entry> - </row> - <row> - <entry><screen>routes</screen></entry> - <entry><screen>array of (byte array, uint32, byte array, uint32)</screen></entry> - <entry><screen></screen></entry> - <entry>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</entry> - </row> - <row> - <entry><screen>ignore-auto-routes</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</entry> - </row> - <row> - <entry><screen>ignore-auto-dns</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</entry> - </row> - <row> - <entry><screen>never-default</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</entry> - </row> - <row> - <entry><screen>may-fail</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</entry> - </row> - <row> - <entry><screen>ip6-privacy</screen></entry> - <entry><screen>int32</screen></entry> - <entry><screen>-1</screen></entry> - <entry>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: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-olpc-mesh setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>802-11-olpc-mesh</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>ssid</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>SSID of the mesh network to join.</entry> - </row> - <row> - <entry><screen>channel</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Channel on which the mesh network to join is located.</entry> - </row> - <row> - <entry><screen>dhcp-anycast-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the the request.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ppp setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>ppp</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>noauth</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>refuse-eap</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the EAP authentication method will not be used.</entry> - </row> - <row> - <entry><screen>refuse-pap</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the PAP authentication method will not be used.</entry> - </row> - <row> - <entry><screen>refuse-chap</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the CHAP authentication method will not be used.</entry> - </row> - <row> - <entry><screen>refuse-mschap</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the MSCHAP authentication method will not be used.</entry> - </row> - <row> - <entry><screen>refuse-mschapv2</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry> - </row> - <row> - <entry><screen>nobsdcomp</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, BSD compression will not be requested.</entry> - </row> - <row> - <entry><screen>nodeflate</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, 'deflate' compression will not be requested.</entry> - </row> - <row> - <entry><screen>no-vj-comp</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry> - </row> - <row> - <entry><screen>require-mppe</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) 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.</entry> - </row> - <row> - <entry><screen>require-mppe-128</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) 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.</entry> - </row> - <row> - <entry><screen>mppe-stateful</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry> - </row> - <row> - <entry><screen>crtscts</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>baud</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>mru</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>mtu</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry> - </row> - <row> - <entry><screen>lcp-echo-failure</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>lcp-echo-interval</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>pppoe setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>pppoe</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>service</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>username</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Username used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry><screen>password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Password used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry><screen>password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the PPPoE password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>serial setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>serial</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>baud</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>57600</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>bits</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>8</screen></entry> - <entry>Byte-width of the serial communication. The 8 in '8n1' for example.</entry> - </row> - <row> - <entry><screen>parity</screen></entry> - <entry><screen>gchar</screen></entry> - <entry><screen>110</screen></entry> - <entry>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</entry> - </row> - <row> - <entry><screen>stopbits</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>1</screen></entry> - <entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</entry> - </row> - <row> - <entry><screen>send-delay</screen></entry> - <entry><screen>uint64</screen></entry> - <entry><screen>0</screen></entry> - <entry>Time to delay between each byte sent to the modem, in microseconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>team setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>team</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>interface-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The name of the virtual in-kernel team network interface</entry> - </row> - <row> - <entry><screen>config</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>team-port setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>team-port</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>config</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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 dafault configuration is used. See man teamd.conf for the format details.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vlan setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>vlan</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>interface-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by the 'mac-address' property of a 'wired' setting.</entry> - </row> - <row> - <entry><screen>parent</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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 a 'wired' setting with a 'mac-address' property.</entry> - </row> - <row> - <entry><screen>id</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>The VLAN indentifier the interface created by this connection should be assigned.</entry> - </row> - <row> - <entry><screen>flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).</entry> - </row> - <row> - <entry><screen>ingress-priority-map</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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'.</entry> - </row> - <row> - <entry><screen>egress-priority-map</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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'.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vpn setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>vpn</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>service-type</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>user-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>data</screen></entry> - <entry><screen>dict of (string::string)</screen></entry> - <entry><screen></screen></entry> - <entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry> - </row> - <row> - <entry><screen>secrets</screen></entry> - <entry><screen>dict of (string::string)</screen></entry> - <entry><screen></screen></entry> - <entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>wimax setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>wimax</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>network-name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry> - </row> - <row> - <entry><screen>mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-3-ethernet setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>802-3-ethernet</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>port</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Specific port type to use if multiple 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.</entry> - </row> - <row> - <entry><screen>speed</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</entry> - </row> - <row> - <entry><screen>duplex</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</entry> - </row> - <row> - <entry><screen>auto-negotiate</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>TRUE</screen></entry> - <entry>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</entry> - </row> - <row> - <entry><screen>mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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).</entry> - </row> - <row> - <entry><screen>cloned-mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> - </row> - <row> - <entry><screen>mac-address-blacklist</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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).</entry> - </row> - <row> - <entry><screen>mtu</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry><screen>s390-subchannels</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>Identifies specific subchannels that this network device uses for communcation 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.</entry> - </row> - <row> - <entry><screen>s390-nettype</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</entry> - </row> - <row> - <entry><screen>s390-options</screen></entry> - <entry><screen>dict of (string::string)</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>802-11-wireless</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>ssid</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>SSID of the Wi-Fi network. Must be specified.</entry> - </row> - <row> - <entry><screen>mode</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Wi-Fi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry> - </row> - <row> - <entry><screen>band</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>channel</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>bssid</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>rate</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry> - </row> - <row> - <entry><screen>tx-power</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry> - </row> - <row> - <entry><screen>mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>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).</entry> - </row> - <row> - <entry><screen>cloned-mac-address</screen></entry> - <entry><screen>byte array</screen></entry> - <entry><screen>[]</screen></entry> - <entry>If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> - </row> - <row> - <entry><screen>mac-address-blacklist</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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').</entry> - </row> - <row> - <entry><screen>mtu</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry><screen>seen-bssids</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>security</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</entry> - </row> - <row> - <entry><screen>hidden</screen></entry> - <entry><screen>boolean</screen></entry> - <entry><screen>FALSE</screen></entry> - <entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless-security setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><screen>name</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen>802-11-wireless-security</screen></entry> - <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> - </row> - <row> - <entry><screen>key-mgmt</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</entry> - </row> - <row> - <entry><screen>wep-tx-keyidx</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>auth-alg</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>proto</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>pairwise</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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'.</entry> - </row> - <row> - <entry><screen>group</screen></entry> - <entry><screen>array of string</screen></entry> - <entry><screen></screen></entry> - <entry>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'.</entry> - </row> - <row> - <entry><screen>leap-username</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry><screen>wep-key0</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>wep-key1</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>wep-key2</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>wep-key3</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>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.</entry> - </row> - <row> - <entry><screen>wep-key-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the WEP keys. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>wep-key-type</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.</entry> - </row> - <row> - <entry><screen>psk</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</entry> - </row> - <row> - <entry><screen>psk-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the WPA PSK key. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry><screen>leap-password</screen></entry> - <entry><screen>string</screen></entry> - <entry><screen></screen></entry> - <entry>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry><screen>leap-password-flags</screen></entry> - <entry><screen>uint32</screen></entry> - <entry><screen>0</screen></entry> - <entry>Flags indicating how to handle the LEAP password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> - </para> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<section><title>Configuration Settings</title> + <para><table><title>802-1x setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>altsubject-matches</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>anonymous-identity</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry></row> + <row><entry><screen>ca-cert</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the CA 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. 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.</entry></row> + <row><entry><screen>ca-path</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>client-cert</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>eap</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>identity</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-1x</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>pac-file</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry></row> + <row><entry><screen>password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</entry></row> + <row><entry><screen>password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row> + <row><entry><screen>password-raw</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>password-raw-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password-raw" property.</entry></row> + <row><entry><screen>phase1-fast-provisioning</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase1-peaplabel</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase1-peapver</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase2-altsubject-matches</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>phase2-auth</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> + <row><entry><screen>phase2-autheap</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel 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.</entry></row> + <row><entry><screen>phase2-ca-cert</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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"; 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.</entry></row> + <row><entry><screen>phase2-ca-path</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase2-client-cert</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase2-private-key</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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 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.</entry></row> + <row><entry><screen>phase2-private-key-password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>phase2-private-key-password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-private-key-password" property.</entry></row> + <row><entry><screen>phase2-subject-match</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>pin</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>PIN used for EAP authentication methods.</entry></row> + <row><entry><screen>pin-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "pin" property.</entry></row> + <row><entry><screen>private-key</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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 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.</entry></row> + <row><entry><screen>private-key-password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>private-key-password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "private-key-password" property.</entry></row> + <row><entry><screen>subject-match</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>system-ca-certs</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>adsl setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>encapsulation</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>adsl</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Password used to authenticate with the ADSL service.</entry></row> + <row><entry><screen>password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row> + <row><entry><screen>protocol</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</entry></row> + <row><entry><screen>username</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Username used to authenticate with the ADSL service.</entry></row> + <row><entry><screen>vci</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>VCI of ADSL connection</entry></row> + <row><entry><screen>vpi</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>VPI of ADSL connection</entry></row> + </tbody></tgroup></table></para> + <para><table><title>bluetooth setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>bdaddr</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>The Bluetooth address of the device.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>bluetooth</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>type</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>bond</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>options</screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen/></entry><entry>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]).</entry></row> + </tbody></tgroup></table></para> + <para><table><title>bridge setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>ageing-time</screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry>The Ethernet MAC address aging time, in seconds.</entry></row> + <row><entry><screen>forward-delay</screen></entry><entry><screen>uint32</screen></entry><entry><screen>15</screen></entry><entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row> + <row><entry><screen>hello-time</screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row> + <row><entry><screen>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</entry></row> + <row><entry><screen>mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match.</entry></row> + <row><entry><screen>max-age</screen></entry><entry><screen>uint32</screen></entry><entry><screen>20</screen></entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>bridge</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>priority</screen></entry><entry><screen>uint32</screen></entry><entry><screen>32768</screen></entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row> + <row><entry><screen>stp</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>bridge-port setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>hairpin-mode</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>bridge-port</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>path-cost</screen></entry><entry><screen>uint32</screen></entry><entry><screen>100</screen></entry><entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry></row> + <row><entry><screen>priority</screen></entry><entry><screen>uint32</screen></entry><entry><screen>32</screen></entry><entry>The Spanning Tree Protocol (STP) priority of this bridge port.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>cdma setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>cdma</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>number</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row> + <row><entry><screen>username</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>autoconnect</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>autoconnect-priority</screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority.</entry></row> + <row><entry><screen>gateway-ping-timeout</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row> + <row><entry><screen>id</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row> + <row><entry><screen>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>master</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Interface name of the master device or UUID of the master connection.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>connection</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>permissions</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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 a user is allowed to access this connection if and only if they are in this list. 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.</entry></row> + <row><entry><screen>read-only</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row> + <row><entry><screen>secondaries</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</entry></row> + <row><entry><screen>slave-type</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row> + <row><entry><screen>timestamp</screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>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).</entry></row> + <row><entry><screen>type</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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).</entry></row> + <row><entry><screen>uuid</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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 "-").</entry></row> + <row><entry><screen>zone</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>app-fcoe-flags</screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> + <row><entry><screen>app-fcoe-mode</screen></entry><entry><screen>string</screen></entry><entry><screen>"fabric"</screen></entry><entry>The FCoE controller mode; either "fabric" (default) or "vn2vn".</entry></row> + <row><entry><screen>app-fcoe-priority</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row> + <row><entry><screen>app-fip-flags</screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> + <row><entry><screen>app-fip-priority</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row> + <row><entry><screen>app-iscsi-flags</screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> + <row><entry><screen>app-iscsi-priority</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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 NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>dcb</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>priority-bandwidth</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percent.</entry></row> + <row><entry><screen>priority-flow-control</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>priority-flow-control-flags</screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> + <row><entry><screen>priority-group-bandwidth</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percent.</entry></row> + <row><entry><screen>priority-group-flags</screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> + <row><entry><screen>priority-group-id</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>priority-strict-bandwidth</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>priority-traffic-class</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>generic setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>generic</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + </tbody></tgroup></table></para> + <para><table><title>gsm setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>apn</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>home-only</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>gsm</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>network-id</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>number</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</entry></row> + <row><entry><screen>password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row> + <row><entry><screen>pin</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>pin-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "pin" property.</entry></row> + <row><entry><screen>username</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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).</entry></row> + <row><entry><screen>mtu</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>infiniband</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>p-key</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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 is set if it is a "full membership" P_Key.</entry></row> + <row><entry><screen>parent</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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".</entry></row> + <row><entry><screen>transport-mode</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row> + </tbody></tgroup></table></para> + <para><table><title>ipv4 setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>address-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>addresses</screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>dhcp-client-id</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>dhcp-hostname</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry></row> + <row><entry><screen>dhcp-send-hostname</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>dns</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[]</screen></entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> + <row><entry><screen>dns-search</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS search domains.</entry></row> + <row><entry><screen>gateway</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> + <row><entry><screen>ignore-auto-dns</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> + <row><entry><screen>ignore-auto-routes</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>may-fail</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>method</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>ipv4</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>never-default</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>route-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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 'gateway' entry, containing the gateway 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.</entry></row> + <row><entry><screen>route-metric</screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen 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.</entry></row> + <row><entry><screen>routes</screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><entry>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.)</entry></row> + </tbody></tgroup></table></para> + <para><table><title>ipv6 setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>address-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>addresses</screen></entry><entry><screen>array of legacy IPv6 address struct (a(ayuay))</screen></entry><entry><screen/></entry><entry>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 (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row> + <row><entry><screen>dhcp-hostname</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry></row> + <row><entry><screen>dhcp-send-hostname</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>dns</screen></entry><entry><screen>array of byte array</screen></entry><entry><screen>[]</screen></entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row> + <row><entry><screen>dns-search</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS search domains.</entry></row> + <row><entry><screen>gateway</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> + <row><entry><screen>ignore-auto-dns</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> + <row><entry><screen>ignore-auto-routes</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>ip6-privacy</screen></entry><entry><screen>NMSettingIP6ConfigPrivacy (int32)</screen></entry><entry><screen/></entry><entry>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: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</entry></row> + <row><entry><screen>may-fail</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>method</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>ipv6</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>never-default</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>route-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>route-metric</screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen 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.</entry></row> + <row><entry><screen>routes</screen></entry><entry><screen>array of legacy IPv6 route struct (a(ayuayu))</screen></entry><entry><screen/></entry><entry>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 (1 - 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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>802-11-olpc-mesh setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>channel</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Channel on which the mesh network to join is located.</entry></row> + <row><entry><screen>dhcp-anycast-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-11-olpc-mesh</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>ssid</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>SSID of the mesh network to join.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>ppp setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>baud</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + <row><entry><screen>crtscts</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>lcp-echo-failure</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + <row><entry><screen>lcp-echo-interval</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + <row><entry><screen>mppe-stateful</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row> + <row><entry><screen>mru</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + <row><entry><screen>mtu</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>ppp</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>no-vj-comp</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row> + <row><entry><screen>noauth</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>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.</entry></row> + <row><entry><screen>nobsdcomp</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, BSD compression will not be requested.</entry></row> + <row><entry><screen>nodeflate</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, "deflate" compression will not be requested.</entry></row> + <row><entry><screen>refuse-chap</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the CHAP authentication method will not be used.</entry></row> + <row><entry><screen>refuse-eap</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the EAP authentication method will not be used.</entry></row> + <row><entry><screen>refuse-mschap</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the MSCHAP authentication method will not be used.</entry></row> + <row><entry><screen>refuse-mschapv2</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row> + <row><entry><screen>refuse-pap</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row> + <row><entry><screen>require-mppe</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) 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.</entry></row> + <row><entry><screen>require-mppe-128</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) 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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>pppoe setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>pppoe</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Password used to authenticate with the PPPoE service.</entry></row> + <row><entry><screen>password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row> + <row><entry><screen>service</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>username</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Username used to authenticate with the PPPoE service.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>serial setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>baud</screen></entry><entry><screen>uint32</screen></entry><entry><screen>57600</screen></entry><entry>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.</entry></row> + <row><entry><screen>bits</screen></entry><entry><screen>uint32</screen></entry><entry><screen>8</screen></entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>serial</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>parity</screen></entry><entry><screen>byte</screen></entry><entry><screen/></entry><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row> + <row><entry><screen>send-delay</screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row> + <row><entry><screen>stopbits</screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>config</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>team</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + </tbody></tgroup></table></para> + <para><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>config</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>team-port</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + </tbody></tgroup></table></para> + <para><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>egress-priority-map</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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".</entry></row> + <row><entry><screen>flags</screen></entry><entry><screen>NMVlanFlags (uint32)</screen></entry><entry><screen/></entry><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state).</entry></row> + <row><entry><screen>id</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The VLAN identifier that the interface created by this connection should be assigned.</entry></row> + <row><entry><screen>ingress-priority-map</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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".</entry></row> + <row><entry><screen>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>vlan</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>parent</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>vpn setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>data</screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen/></entry><entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>vpn</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>persistent</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>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.</entry></row> + <row><entry><screen>secrets</screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen/></entry><entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry></row> + <row><entry><screen>service-type</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>user-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>wimax setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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).</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>wimax</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>network-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>auto-negotiate</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set.</entry></row> + <row><entry><screen>cloned-mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry></row> + <row><entry><screen>duplex</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, request that the device only use the specified duplex mode. Either "half" or "full".</entry></row> + <row><entry><screen>mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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).</entry></row> + <row><entry><screen>mac-address-blacklist</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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).</entry></row> + <row><entry><screen>mtu</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-3-ethernet</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>port</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if multiple 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.</entry></row> + <row><entry><screen>s390-nettype</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row> + <row><entry><screen>s390-options</screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen/></entry><entry>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]).</entry></row> + <row><entry><screen>s390-subchannels</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>speed</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>band</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>bssid</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>channel</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + <row><entry><screen>cloned-mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry></row> + <row><entry><screen>hidden</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry></row> + <row><entry><screen>mac-address</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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).</entry></row> + <row><entry><screen>mac-address-blacklist</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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").</entry></row> + <row><entry><screen>mode</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row> + <row><entry><screen>mtu</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-11-wireless</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>rate</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row> + <row><entry><screen>security</screen></entry><entry><screen>None</screen></entry><entry><screen/></entry><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row> + <row><entry><screen>seen-bssids</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>ssid</screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>SSID of the Wi-Fi network. Must be specified.</entry></row> + <row><entry><screen>tx-power</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row> + </tbody></tgroup></table></para> + <para><table><title>802-11-wireless-security setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry><screen>auth-alg</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>group</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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".</entry></row> + <row><entry><screen>key-mgmt</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Key management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</entry></row> + <row><entry><screen>leap-password</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row> + <row><entry><screen>leap-password-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "leap-password" property.</entry></row> + <row><entry><screen>leap-username</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row> + <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-11-wireless-security</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>pairwise</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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".</entry></row> + <row><entry><screen>proto</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>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.</entry></row> + <row><entry><screen>psk</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</entry></row> + <row><entry><screen>psk-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "psk" property.</entry></row> + <row><entry><screen>wep-key-flags</screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row> + <row><entry><screen>wep-key-type</screen></entry><entry><screen>NMWepKeyType (uint32)</screen></entry><entry><screen/></entry><entry>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_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 NM_WEP_KEY_TYPE_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.</entry></row> + <row><entry><screen>wep-key0</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>wep-key1</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>wep-key2</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>wep-key3</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row> + <row><entry><screen>wep-tx-keyidx</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row> + </tbody></tgroup></table></para> </section> diff --git a/docs/api/settings-spec.xsl b/docs/api/settings-spec.xsl new file mode 100644 index 00000000..04feb398 --- /dev/null +++ b/docs/api/settings-spec.xsl @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + + <xsl:output + method="xml" + doctype-public="-//OASIS//DTD DocBook XML V4.3//EN" + doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" + /> + + <xsl:template match="nm-setting-docs"> + <section> + <title>Configuration Settings</title> + <xsl:apply-templates/> + </section> + </xsl:template> + + <xsl:template match="setting"> + <para> + <table> + <title><xsl:value-of select="@name"/> setting</title> + <tgroup cols="4"> + <thead> + <row> + <entry>Key Name</entry> + <entry>Value Type</entry> + <entry>Default Value</entry> + <entry>Value Description</entry> + </row> + </thead> + <tbody> + <xsl:apply-templates/> + </tbody> + </tgroup> + </table> + </para> + </xsl:template> + + <xsl:template match="property"> + <xsl:variable name="setting_name" select="../@name"/> + <row> + <entry><screen><xsl:value-of select="@name"/></screen></entry> + <entry><screen><xsl:value-of select="@type"/></screen></entry> + <entry><screen><xsl:value-of select="@default"/></screen></entry> + <entry><xsl:value-of select="@description"/><xsl:if test="@type = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry> + </row> + </xsl:template> + +</xsl:stylesheet> diff --git a/docs/api/spec.html b/docs/api/spec.html index 84819cab..cf717b59 100644 --- a/docs/api/spec.html +++ b/docs/api/spec.html @@ -1,4 +1,4 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9.10.0</title><style type="text/css"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 1.0.0</title><style type="text/css"> body { font-family: sans-serif; @@ -97,7 +97,7 @@ margin-right: 4em; } - </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9.10.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> + </style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 1.0.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license"> <p>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 @@ -162,11 +162,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div><div><h4>Returns</h4><dl><dt><code>active_connection</code> - <code>o</code></dt><dd> The path of the active connection object representing this active connection. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> - Connection was not provided by the settings service. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> - Unknown device. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionActivating</code></dt><dd>Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?</dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> ( a{sa{sv}}: connection, o: device, o: specific_object ) → o, o</h3><div class="docstring"> @@ -195,11 +191,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd><dt><code>active_connection</code> - <code>o</code></dt><dd> The path of the active connection object representing this active connection. - </dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd> - Connection was not provided by the settings service. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd> - Unknown device. - <em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> ( o: active_connection ) → nothing</h3><div class="docstring"> @@ -254,7 +246,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Set logging verbosity and which operations are logged. </div><div><h4>Parameters</h4><dl><dt><code>level</code> - <code>s</code></dt><dd> - One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE]. </dd><dt><code>domains</code> - <code>s</code></dt><dd> A combination of logging domains separated by commas (','), or "NONE" @@ -277,7 +269,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Get current logging verbosity level and operations domains. </div><div><h4>Returns</h4><dl><dt><code>level</code> - <code>s</code></dt><dd> - One of [ERR, WARN, INFO, DEBUG]. + One of [ERR, WARN, INFO, DEBUG, TRACE]. </dd><dt><code>domains</code> - <code>s</code></dt><dd> For available domains see SetLogging() call. @@ -383,6 +375,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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. + </dd><dt><code>PrimaryConnectionType</code> - + <code>s</code> - + <code>(read)</code></dt><dd> + 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. </dd><dt><code>ActivatingConnection</code> - <code>o</code> - <code>(read)</code></dt><dd> @@ -491,6 +489,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ ) → nothing</h3><div class="docstring"> Disconnects a device and prevents the device from automatically activating further connections without user intervention. + </div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Delete" id="org.freedesktop.NetworkManager.Device.Delete">Delete</a> ( + + ) → + nothing</h3><div class="docstring"> + Deletes a software device from NetworkManager and removes the interface from the system. + The method returns an error when called for a hardware device. </div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.StateChanged" id="org.freedesktop.NetworkManager.Device.StateChanged">StateChanged</a> ( u: new_state, u: old_state, u: reason )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>new_state</code> - @@ -603,7 +607,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ 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. + device, or setting this property to TRUE. This property cannot be + set to TRUE for default-unmanaged devices, since they never autoconnect. </dd><dt><code>FirmwareMissing</code> - <code>b</code> - <code>(read)</code></dt><dd> @@ -1212,6 +1217,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ <code>b</code> - <code>(read)</code></dt><dd> Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). + </dd><dt><code>Parent</code> - + <code>o</code> - + <code>(read)</code></dt><dd> + Object path of the parent device of this VLAN device. </dd><dt><code>VlanId</code> - <code>u</code> - <code>(read)</code></dt><dd> @@ -1257,19 +1266,39 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) </dt><dd> A dictionary mapping property names to variant boxed values - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - - <code>s</code> - - <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Addresses</code> - <code>aau</code> - - <code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3 - elements of each tuple are in network byte order. Essentially: - [(addr, prefix, gateway), (addr, prefix, gateway), ...] - </dd><dt><code>Routes</code> - + <code>(read)</code></dt><dd> + 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 + </dd><dt><code>AddressData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Routes</code> - <code>aau</code> - - <code>(read)</code></dt><dd>Tuples 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), ...] + <code>(read)</code></dt><dd> + 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 + </dd><dt><code>RouteData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. </dd><dt><code>Nameservers</code> - <code>au</code> - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - @@ -1287,13 +1316,34 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>) </dt><dd> A dictionary mapping property names to variant boxed values - </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> - - <code>s</code> - - <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> - + </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Addresses</code> - <code>a(ayuay)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Routes</code> - + <code>(read)</code></dt><dd> + Array of tuples of IPv6 address/prefix/gateway. + + Deprecated: use AddressData and Gateway. + </dd><dt><code>AddressData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Gateway</code> - + <code>s</code> - + <code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Routes</code> - <code>a(ayuayu)</code> - - <code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd><dt><code>Nameservers</code> - + <code>(read)</code></dt><dd> + Tuples of IPv6 route/prefix/next-hop/metric. + + Deprecated: use RouteData + </dd><dt><code>RouteData</code> - + <code>aa{sv}</code> - + <code>(read)</code></dt><dd> + 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. + </dd><dt><code>Nameservers</code> - <code>aay</code> - <code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> - <code>as</code> - @@ -1539,7 +1589,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ (<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>) </dt><dd> Nested settings maps containing secrets. - </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> ( + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets" id="org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets">ClearSecrets</a> ( + + ) → + nothing</h3><div class="docstring"> + Clear the secrets belonging to this network connection profile. + </div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> ( ) → nothing</h3><div class="docstring"> @@ -2117,7 +2172,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ Emitted when the plugin state changes. </div><div><h4>Parameters</h4><dl><dt><code>state</code> - <code>u</code> - (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + (<a xmlns="" href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a>) </dt><dd> The new state of the plugin. </dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired" id="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired">SecretsRequired</a> ( @@ -2183,10 +2238,24 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ </dd></dl></div></div><h2>Properties:</h2><dl><dt><code>State</code> - <code>u</code> - <code>(read)</code> - (<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>) + (<a xmlns="" href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a>) </dt><dd> The state of the plugin. - </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd> + </dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_SERVICE_STATE" id="type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a></h3><dl><dt><code>NM_VPN_SERVICE_STATE_UNKNOWN = 0</code></dt><dd> + The state of the VPN plugin is unknown. + </dd><dt><code>NM_VPN_SERVICE_STATE_INIT = 1</code></dt><dd> + The VPN plugin is initialized. + </dd><dt><code>NM_VPN_SERVICE_STATE_SHUTDOWN = 2</code></dt><dd> + (Not used.) + </dd><dt><code>NM_VPN_SERVICE_STATE_STARTING = 3</code></dt><dd> + The plugin is attempting to connect to a VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STARTED = 4</code></dt><dd> + The plugin has connected to a VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STOPPING = 5</code></dt><dd> + The plugin is disconnecting from the VPN server. + </dd><dt><code>NM_VPN_SERVICE_STATE_STOPPED = 6</code></dt><dd> + The plugin has disconnected from the VPN server. + </dd></dl><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd> Login failed. </dd><dt><code>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1</code></dt><dd> Connect failed. @@ -2295,6 +2364,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</ - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code> - u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></code> - u</li><li><code><a href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></code> + - u</li><li><code><a href="#type-NM_VPN_SERVICE_STATE">NM_VPN_SERVICE_STATE</a></code> - u</li><li><code><a href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></code> - u</li><li><code><a href="#type-String_String_Map">String_String_Map</a></code> - a{ s → s } diff --git a/docs/api/version.xml b/docs/api/version.xml index 82e28fcb..3eefcb9d 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -0.9.10.0 +1.0.0 |