diff options
Diffstat (limited to 'docs/api/html/ref-settings.html')
| -rw-r--r-- | docs/api/html/ref-settings.html | 1337 |
1 files changed, 1337 insertions, 0 deletions
diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html new file mode 100644 index 000000000..7924bbce4 --- /dev/null +++ b/docs/api/html/ref-settings.html @@ -0,0 +1,1337 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Network Configuration Setting Specification</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="up" href="index.html" title="NetworkManager D-Bus Reference Manual"> +<link rel="prev" href="ref-dbus.html" title="D-Bus API Reference"> +<link rel="next" href="secrets-flags.html" title="Secret flag types"> +<meta name="generator" content="GTK-Doc V1.17 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">NetworkManager D-Bus Reference Manual</th> +<td><a accesskey="n" href="secrets-flags.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="ref-settings"></a>Network Configuration Setting Specification</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="ref-settings.html#id642206">Configuration Settings</a></span></dt> +<dt><span class="section"><a href="secrets-flags.html">Secret flag types</a></span></dt> +</dl></div> +<p> + This part documents the properties and value types of each "Setting" + object that composes the basic unit of NetworkManager configuration, + the "Connection". Each Connection object is simply a dictionary mapping + setting names (like "wimax" or "bluetooth") to a dictionary of + key/value pairs that represents each itself. + </p> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="id642206"></a>Configuration Settings</h2></div></div></div> +<p> +</p> +<div class="table"> +<a name="id642214"></a><p class="title"><b>Table 1. 802-1x setting</b></p> +<div class="table-contents"><table summary="802-1x 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">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> +</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', 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> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<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">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> +</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">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 NULL byte.</td> +</tr> +<tr> +<td><pre class="screen">phase1-peapver</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> +</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> +</tr> +<tr> +<td><pre class="screen">phase1-fast-provisioning</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> +</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> +</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> +</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> +</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> +</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-eap' 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> +</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 for EAP authentication methods.</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> +</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> +</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> +</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-eap' 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"></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> +</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id629228"></a><p class="title"><b>Table 2. bluetooth setting</b></p> +<div class="table-contents"><table summary="bluetooth 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">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> +</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id629361"></a><p class="title"><b>Table 3. cdma setting</b></p> +<div class="table-contents"><table summary="cdma 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">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> +</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> +</tr> +<tr> +<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 network, if required. Note that many providers do not require a username or accept any username.</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 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 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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id629559"></a><p class="title"><b>Table 4. connection setting</b></p> +<div class="table-contents"><table summary="connection 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">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> +</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> +</tr> +<tr> +<td><pre class="screen">uuid</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 WiFi SSID, mobile broadband network provider, or the connection type changes.</td> +</tr> +<tr> +<td><pre class="screen">type</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> +</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. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id629860"></a><p class="title"><b>Table 5. gsm setting</b></p> +<div class="table-contents"><table summary="gsm 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">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> +</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. In most cases, leave the number blank and a number selecting the APN specified in the 'apn' property will be used automatically when required.</td> +</tr> +<tr> +<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 network, if required. Note that many providers do not require a username or accept any username.</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 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> +</tr> +<tr> +<td><pre class="screen">apn</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> +</tr> +<tr> +<td><pre class="screen">network-id</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> +</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, and 3: prefer 2G. Note that not all devices allow network preference control.</td> +</tr> +<tr> +<td><pre class="screen">pin</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</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 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. Note that not all devices allow frequency band control.</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id630285"></a><p class="title"><b>Table 6. ipv4 setting</b></p> +<div class="table-contents"><table summary="ipv4 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">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> +</tr> +<tr> +<td><pre class="screen">method</pre></td> +<td><pre class="screen">string</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> +</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>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 usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</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', '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> +</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> +</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>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> +</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' 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">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 cusomize the DHCP lease and options.</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 empty and this property is TRUE, the current persistent hostname of the computer is sent.</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>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">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> +</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>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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id659187"></a><p class="title"><b>Table 7. ipv6 setting</b></p> +<div class="table-contents"><table summary="ipv6 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">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> +</tr> +<tr> +<td><pre class="screen">method</pre></td> +<td><pre class="screen">string</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 'ignored' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</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> +</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> +</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">[]</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> +</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> +</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> +</tr> +<tr> +<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' 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> +</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> +</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>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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id659505"></a><p class="title"><b>Table 8. 802-11-olpc-mesh setting</b></p> +<div class="table-contents"><table summary="802-11-olpc-mesh 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">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> +<td>Channel on which the mesh network to join is located.</td> +</tr> +<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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id659643"></a><p class="title"><b>Table 9. ppp setting</b></p> +<div class="table-contents"><table summary="ppp 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">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> +</tr> +<tr> +<td><pre class="screen">noauth</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> +</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> +</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> +</tr> +<tr> +<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, the CHAP authentication method will not be used.</td> +</tr> +<tr> +<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, the MSCHAP authentication method will not be used.</td> +</tr> +<tr> +<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, the MSCHAPv2 authentication method will not be used.</td> +</tr> +<tr> +<td><pre class="screen">nobsdcomp</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>If TRUE, BSD compression will not be requested.</td> +</tr> +<tr> +<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> +</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, Van Jacobsen TCP header compression will not be requested.</td> +</tr> +<tr> +<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">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> +<tr> +<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, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td> +</tr> +<tr> +<td><pre class="screen">crtscts</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> +</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> +</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id660173"></a><p class="title"><b>Table 10. pppoe setting</b></p> +<div class="table-contents"><table summary="pppoe 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">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> +</tr> +<tr> +<td><pre class="screen">service</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 serivce. 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">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> +<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 PPPoE 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 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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id660338"></a><p class="title"><b>Table 11. serial setting</b></p> +<div class="table-contents"><table summary="serial 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">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> +<td>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.</td> +</tr> +<tr> +<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> +</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> +</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> +<tr> +<td><pre class="screen">send-delay</pre></td> +<td><pre class="screen">uint64</pre></td> +<td><pre class="screen">0</pre></td> +<td>Time to delay between each byte sent to the modem, in microseconds.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id660529"></a><p class="title"><b>Table 12. vpn setting</b></p> +<div class="table-contents"><table summary="vpn 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">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> +</tr> +<tr> +<td><pre class="screen">service-type</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>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.</td> +</tr> +<tr> +<td><pre class="screen">user-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>User name of the currently logged in user for connections provided by the user settings service. This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration. The VPN plugin itself decides which user name to use.</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> +<div class="table"> +<a name="id660695"></a><p class="title"><b>Table 13. wimax setting</b></p> +<div class="table-contents"><table summary="wimax 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">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> +</tr> +<tr> +<td><pre class="screen">network-name</pre></td> +<td><pre class="screen">string</pre></td> +<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> +<div class="table"> +<a name="id660819"></a><p class="title"><b>Table 14. 802-3-ethernet setting</b></p> +<div class="table-contents"><table summary="802-3-ethernet 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">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> +</tr> +<tr> +<td><pre class="screen">port</pre></td> +<td><pre class="screen">string</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> +</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> +</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> +</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, 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">GPtrArray_gchararray_</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> +</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> +</tr> +<tr> +<td><pre class="screen">s390-options</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 s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id661226"></a><p class="title"><b>Table 15. 802-11-wireless setting</b></p> +<div class="table-contents"><table summary="802-11-wireless 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">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 WiFi network. Must be specified.</td> +</tr> +<tr> +<td><pre class="screen">mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>WiFi network mode; one of 'infrastructure' or 'adhoc'. If blank, infrastructure is assumed.</td> +</tr> +<tr> +<td><pre class="screen">band</pre></td> +<td><pre class="screen">string</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 WiFi 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">channel</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi 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">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> +</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> +</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 WiFi 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 WiFi 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">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<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">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 WiFI network. The settings service will usually populate this property by periodically asking NetworkManager what the device's current AP is while connected to the network (or monitoring the device's 'active-ap' property) and adding the current AP's BSSID to this list. This list helps NetworkManager find hidden APs by matching up scan results with the BSSIDs in this list.</td> +</tr> +<tr> +<td><pre class="screen">security</pre></td> +<td><pre class="screen">string</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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id661703"></a><p class="title"><b>Table 16. 802-11-wireless-security setting</b></p> +<div class="table-contents"><table summary="802-11-wireless-security 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">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> +</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 WiFi 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> +</tr> +<tr> +<td><pre class="screen">auth-alg</pre></td> +<td><pre class="screen">string</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> +</tr> +<tr> +<td><pre class="screen">proto</pre></td> +<td><pre class="screen">array of 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> +</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>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</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>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td> +</tr> +<tr> +<td><pre class="screen">leap-username</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> +</tr> +<tr> +<td><pre class="screen">wep-key0</pre></td> +<td><pre class="screen">string</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> +</tr> +<tr> +<td><pre class="screen">wep-key1</pre></td> +<td><pre class="screen">string</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> +</tr> +<tr> +<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">wep-key3</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> +</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">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 WiFi network.</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> +</tr> +<tr> +<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">leap-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 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> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> + </p> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.17</div> +</body> +</html>
\ No newline at end of file |