From 8f7a3cbbdd0c0a48277c341dd3a8ec8743ae9735 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 8 Sep 2018 17:44:06 +0200 Subject: New upstream version 1.13.90 --- docs/api/settings-spec.xml | 81 +++++++++++++++++++++------------------------- 1 file changed, 36 insertions(+), 45 deletions(-) (limited to 'docs/api/settings-spec.xml') diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 703871e2..67c9bebb 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -13,10 +13,11 @@ ididstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". interface-nameinterface-namestringThe 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. lldplldpint32-1Whether LLDP is enabled for the connection. + llmnrllmnrint32-1Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: yes: register hostname and resolving for the connection, no: disable LLMNR for the interface, resolve: do not register hostname but allow resolving of LLMNR host names. This feature requires a plugin which supports LLMNR. One such plugin is dns-systemd-resolved. mastermasterstringInterface name of the master device or UUID of the master connection. - mdnsmdnsint32-1Whether mDNS is enabled for the connection. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names. When updating this property on a currently activated connection, the change takes effect immediately. This feature requires a plugin which supports mDNS. One such plugin is dns-systemd-resolved. + mdnsmdnsint32-1Whether mDNS is enabled for the connection. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names. This feature requires a plugin which supports mDNS. One such plugin is dns-systemd-resolved. meteredmeteredNMMetered (int32)Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately. - namenamestringconnectionThe 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". + multi-connectmulti-connectint320Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect. permissionspermissionsarray of string[]An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8. read-onlyread-onlybooleanFALSEFALSE 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. secondariessecondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported. @@ -27,6 +28,11 @@ uuiduuidstringA 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 "-"). zonezonestringThe trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately. + 6lowpan6LoWPAN Settings + Properties + Key NameValue TypeDefault ValueValue Description + parentparentstringIf given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created. +
802-1xIEEE 802.1x Authentication Settings Properties Key NameValue TypeDefault ValueValue Description @@ -43,7 +49,6 @@ domain-suffix-matchdomain-suffix-matchstringConstraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison.eapeaparray of string[]The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.identityidentitystringIdentity string for EAP authentication methods. Often the user's user or login name. - namenamestring802-1xThe 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".pac-filepac-filestringUTF-8 encoded file path containing PAC for EAP-FAST.passwordpasswordstringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. @@ -80,7 +85,6 @@ Properties
Key NameValue TypeDefault ValueValue DescriptionencapsulationencapsulationstringEncapsulation of ADSL connection. Can be "vcmux" or "llc". - namenamestringadslThe 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".passwordpasswordstringPassword used to authenticate with the ADSL service.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.protocolprotocolstringADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". @@ -92,14 +96,12 @@ Properties
Key NameValue TypeDefault ValueValue Descriptionbdaddrbdaddrbyte arrayThe Bluetooth address of the device. - namenamestringbluetoothThe 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".typetypestringEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
 bondBonding Settings Properties Key NameValue TypeDefault ValueValue Descriptioninterface-nameinterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name. - namenamestringbondThe 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".optionsoptionsdict of string to string{'mode': 'balance-rr'}Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
 bridgeBridging Settings @@ -113,7 +115,6 @@ <row><entry><screen>mac-address<indexterm zone="settings-bridge"><primary sortas="mac-address">mac-address</primary></indexterm></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. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1</entry></row> <row><entry><screen>max-age<indexterm zone="settings-bridge"><primary sortas="max-age">max-age</primary></indexterm></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>multicast-snooping<indexterm zone="settings-bridge"><primary sortas="multicast-snooping">multicast-snooping</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</entry></row> - <row><entry><screen>name<indexterm zone="settings-bridge"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-bridge"><primary sortas="priority">priority</primary></indexterm></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<indexterm zone="settings-bridge"><primary sortas="stp">stp</primary></indexterm></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></refsect1></refentry> @@ -121,7 +122,6 @@ Properties Key NameValue TypeDefault ValueValue Descriptionhairpin-modehairpin-modebooleanFALSEEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on. - namenamestringbridge-portThe 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".path-costpath-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port.prioritypriorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.
 @@ -129,7 +129,6 @@ Properties Key NameValue TypeDefault ValueValue Descriptionmtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - namenamestringcdmaThe 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".numbernumberstringThe 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.passwordpasswordstringThe password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. @@ -145,7 +144,6 @@ app-fip-priorityapp-fip-priorityint32-1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.app-iscsi-flagsapp-iscsi-flagsNMSettingDcbFlags (uint32)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).app-iscsi-priorityapp-iscsi-priorityint32-1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. - namenamestringdcbThe 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".priority-bandwidthpriority-bandwidtharray of uint32[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.priority-flow-controlpriority-flow-controlarray of uint32[False, False, False, False, False, False, False, False]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.priority-flow-control-flagspriority-flow-control-flagsNMSettingDcbFlags (uint32)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). @@ -158,12 +156,14 @@ dummyDummy Link Settings Properties
Key NameValue TypeDefault ValueValue Description - namenamestringdummyThe 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". +
+ ethtoolEthtool Ethernet Settings + Properties + Key NameValue TypeDefault ValueValue Description
 genericGeneric Link Settings Properties Key NameValue TypeDefault ValueValue Description - namenamestringgenericThe 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".
 gsmGSM-based Mobile Broadband Settings Properties @@ -172,7 +172,6 @@ <row><entry><screen>device-id<indexterm zone="settings-gsm"><primary sortas="device-id">device-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row> <row><entry><screen>home-only<indexterm zone="settings-gsm"><primary sortas="home-only">home-only</primary></indexterm></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>mtu<indexterm zone="settings-gsm"><primary sortas="mtu">mtu</primary></indexterm></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<indexterm zone="settings-gsm"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-gsm"><primary sortas="network-id">network-id</primary></indexterm></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<indexterm zone="settings-gsm"><primary sortas="number">number</primary></indexterm></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<indexterm zone="settings-gsm"><primary sortas="password">password</primary></indexterm></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> @@ -188,7 +187,6 @@ Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arrayIf 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).mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - namenamestringinfinibandThe 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".p-keyp-keyint32-1The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.parentparentstringThe interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".transport-modetransport-modestringThe IP-over-InfiniBand transport mode. Either "datagram" or "connected". @@ -199,7 +197,7 @@ address-dataaddress-dataarray of vardictArray 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.addressesaddressesarray of array of uint32[]Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.dad-timeoutdad-timeoutint32-1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4. - dhcp-client-iddhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet type (01). Currently, these options only work for ethernet type of links. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If unset, a globally configured default is used. If still unset, the client-id from the last lease is reused. + dhcp-client-iddhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If unset, a globally configured default is used. If still unset, the client-id from the last lease is reused.dhcp-fqdndhcp-fqdnstringIf the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.dhcp-hostnamedhcp-hostnamestringIf the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.dhcp-send-hostnamedhcp-send-hostnamebooleanTRUEIf TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent. @@ -212,8 +210,7 @@ ignore-auto-dnsignore-auto-dnsbooleanFALSEWhen "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.ignore-auto-routesignore-auto-routesbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.may-failmay-failbooleanTRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully. - methodmethodstringIP 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. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. - namenamestringipv4The 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". + methodmethodstringIP 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. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.never-defaultnever-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.route-dataroute-dataarray of vardictArray 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.route-metricroute-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric. @@ -240,8 +237,7 @@ ignore-auto-routesignore-auto-routesbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.ip6-privacyip6-privacyNMSettingIP6ConfigPrivacy (int32)Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.may-failmay-failbooleanTRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully. - methodmethodstringIP 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. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. - namenamestringipv6The 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". + methodmethodstringIP 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. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.never-defaultnever-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.route-dataroute-dataarray of vardictArray of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.route-metricroute-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric. @@ -259,7 +255,6 @@ locallocalstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.modemodeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).mtumtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - namenamestringip-tunnelThe 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".output-keyoutput-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.parentparentstringIf given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.path-mtu-discoverypath-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel. @@ -275,7 +270,6 @@ mka-cak-flagsmka-cak-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "mka-cak" property.mka-cknmka-cknstringThe pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.modemodeint320Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained. - namenamestringmacsecThe 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".parentparentstringIf given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.portportint321The port component of the SCI (Secure Channel Identifier), between 1 and 65534.send-scisend-scibooleanTRUESpecifies whether the SCI (Secure Channel Identifier) is included in every packet. @@ -285,17 +279,20 @@ Properties
Key NameValue TypeDefault ValueValue Descriptionmodemodeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. - namenamestringmacvlanThe 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".parentparentstringIf given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.promiscuouspromiscuousbooleanTRUEWhether the interface should be put in promiscuous mode.taptapbooleanFALSEWhether the interface should be a MACVTAP.
 + matchMatch settings. + Properties + Key NameValue TypeDefault ValueValue Description + interface-nameinterface-namearray of string[]A list of interface names to match. Each element is a shell wildcard pattern. When an element is prefixed with exclamation mark (!) the condition is inverted. A candidate interface name is considered matching when both these conditions are satisfied: (a) any of the elements not prefixed with '!' matches or there aren't such elements; (b) none of the elements prefixed with '!' match. +
802-11-olpc-meshOLPC Wireless Mesh Settings Properties Key NameValue TypeDefault ValueValue Descriptionchannelchanneluint320Channel on which the mesh network to join is located.dhcp-anycast-addressdhcp-anycast-addressbyte arrayAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - namenamestring802-11-olpc-meshThe 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".ssidssidbyte arraySSID of the mesh network to join.
 ovs-bridgeOvsBridge Link Settings @@ -303,20 +300,17 @@ Key NameValue TypeDefault ValueValue Descriptionfail-modefail-modestringThe bridge failure mode. One of "secure", "standalone" or empty.mcast-snooping-enablemcast-snooping-enablebooleanFALSEEnable or disable multicast snooping. - namenamestringovs-bridgeThe 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".rstp-enablerstp-enablebooleanFALSEEnable or disable RSTP.stp-enablestp-enablebooleanFALSEEnable or disable STP.
 ovs-interfaceOpen vSwitch Interface Settings Properties Key NameValue TypeDefault ValueValue Description - namenamestringovs-interfaceThe 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".typetypestringThe interface type. Either "internal", or empty.
 ovs-patchOvsPatch Link Settings Properties Key NameValue TypeDefault ValueValue Description - namenamestringovs-patchThe 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".peerpeerstringSpecifies the unicast destination IP address of a remote Open vSwitch bridge port to connect to.
 ovs-portOvsPort Link Settings @@ -326,7 +320,6 @@ <row><entry><screen>bond-mode<indexterm zone="settings-ovs-port"><primary sortas="bond-mode">bond-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</entry></row> <row><entry><screen>bond-updelay<indexterm zone="settings-ovs-port"><primary sortas="bond-updelay">bond-updelay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The time port must be active before it starts forwarding traffic.</entry></row> <row><entry><screen>lacp<indexterm zone="settings-ovs-port"><primary sortas="lacp">lacp</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>LACP mode. One of "active", "off", or "passive".</entry></row> - <row><entry><screen>name<indexterm zone="settings-ovs-port"><primary sortas="name">name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>ovs-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>tag<indexterm zone="settings-ovs-port"><primary sortas="tag">tag</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The VLAN tag in the range 0-4095.</entry></row> <row><entry><screen>vlan-mode<indexterm zone="settings-ovs-port"><primary sortas="vlan-mode">vlan-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> @@ -340,7 +333,6 @@ <row><entry><screen>mppe-stateful<indexterm zone="settings-ppp"><primary sortas="mppe-stateful">mppe-stateful</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="mru">mru</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="mtu">mtu</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="no-vj-comp">no-vj-comp</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="noauth">noauth</primary></indexterm></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<indexterm zone="settings-ppp"><primary sortas="nobsdcomp">nobsdcomp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, BSD compression will not be requested.</entry></row> @@ -356,7 +348,6 @@ <refentry id="settings-pppoe"><refnamediv><refname>pppoe</refname><refpurpose>PPP-over-Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-pppoe.properties"> Properties Key NameValue TypeDefault ValueValue Description - namenamestringpppoeThe 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".parentparentstringIf given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.passwordpasswordstringPassword used to authenticate with the PPPoE service.password-flagspassword-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. @@ -368,7 +359,6 @@
Key NameValue TypeDefault ValueValue Descriptionbrowser-onlybrowser-onlybooleanFALSEWhether the proxy configuration is for browser only.methodmethodint320Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) - namenamestringproxyThe 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".pac-scriptpac-scriptstringPAC script for the connection.pac-urlpac-urlstringPAC URL for obtaining PAC file.
 @@ -377,16 +367,21 @@ Key NameValue TypeDefault ValueValue Descriptionbaudbauduint3257600Speed 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.bitsbitsuint328Byte-width of the serial communication. The 8 in "8n1" for example. - namenamestringserialThe 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".parityparitybyteThe connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.send-delaysend-delayuint640Time to delay between each byte sent to the modem, in microseconds.stopbitsstopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.
 - tcLinux Traffic Contril Settings. + <refentry id="settings-sriov"><refnamediv><refname>sriov</refname><refpurpose>SR-IOV settings.</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-sriov.properties"> + Properties + Key NameValue TypeDefault ValueValue Description + autoprobe-driversautoprobe-driversNMTernary (int32)Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1). + total-vfstotal-vfsuint320The total number of virtual functions to create. + vfsvfsarray of vardict[]Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". The "vlans" attribute is represented as a semicolor-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad. +
+ tcLinux Traffic Control Settings. Properties Key NameValue TypeDefault ValueValue Description - namenamestringtcThe 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". - qdiscsqdiscsarray of vardict[]Array of TC queuening disciplines. + qdiscsqdiscsarray of vardict[]Array of TC queueing disciplines.tfilterstfiltersarray of vardict[]Array of TC traffic filters.
 teamTeaming Settings @@ -397,7 +392,6 @@ <row><entry><screen>link-watchers<indexterm zone="settings-team"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-incative', 'send-always'. See teamd.conf man for more details.</entry></row> <row><entry><screen>mcast-rejoin-count<indexterm zone="settings-team"><primary sortas="mcast-rejoin-count">mcast-rejoin-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row> <row><entry><screen>mcast-rejoin-interval<indexterm zone="settings-team"><primary sortas="mcast-rejoin-interval">mcast-rejoin-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row> - <row><entry><screen>name<indexterm zone="settings-team"><primary sortas="name">name</primary></indexterm></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> <row><entry><screen>notify-peers-count<indexterm zone="settings-team"><primary sortas="notify-peers-count">notify-peers-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd notify_peers.count.</entry></row> <row><entry><screen>notify-peers-interval<indexterm zone="settings-team"><primary sortas="notify-peers-interval">notify-peers-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row> <row><entry><screen>runner<indexterm zone="settings-team"><primary sortas="runner">runner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>"roundrobin"</screen></entry><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random". When setting the runner, all the properties specific to the runner will be reset to the default value; all the properties specific to other runners will be set to an empty value (or if not possible to a default value).</entry></row> @@ -418,7 +412,6 @@ <row><entry><screen>lacp-key<indexterm zone="settings-team-port"><primary sortas="lacp-key">lacp-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row> <row><entry><screen>lacp-prio<indexterm zone="settings-team-port"><primary sortas="lacp-prio">lacp-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>255</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row> <row><entry><screen>link-watchers<indexterm zone="settings-team-port"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-incative', 'send-always'. See teamd.conf man for more details.</entry></row> - <row><entry><screen>name<indexterm zone="settings-team-port"><primary sortas="name">name</primary></indexterm></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> <row><entry><screen>prio<indexterm zone="settings-team-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row> <row><entry><screen>queue-id<indexterm zone="settings-team-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row> <row><entry><screen>sticky<indexterm zone="settings-team-port"><primary sortas="sticky">sticky</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row> @@ -429,7 +422,6 @@ <row><entry><screen>group<indexterm zone="settings-tun"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> <row><entry><screen>mode<indexterm zone="settings-tun"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row> <row><entry><screen>multi-queue<indexterm zone="settings-tun"><primary sortas="multi-queue">multi-queue</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row> - <row><entry><screen>name<indexterm zone="settings-tun"><primary sortas="name">name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>tun</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>owner<indexterm zone="settings-tun"><primary sortas="owner">owner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> <row><entry><screen>pi<indexterm zone="settings-tun"><primary sortas="pi">pi</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row> <row><entry><screen>vnet-hdr<indexterm zone="settings-tun"><primary sortas="vnet-hdr">vnet-hdr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row> @@ -438,7 +430,6 @@ Properties Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length. - namenamestringuserThe 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".
 vlanVLAN Settings Properties @@ -448,14 +439,12 @@ <row><entry><screen>id<indexterm zone="settings-vlan"><primary sortas="id">id</primary></indexterm></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. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row> <row><entry><screen>ingress-priority-map<indexterm zone="settings-vlan"><primary sortas="ingress-priority-map">ingress-priority-map</primary></indexterm></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<indexterm zone="settings-vlan"><primary sortas="interface-name">interface-name</primary></indexterm></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<indexterm zone="settings-vlan"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-vlan"><primary sortas="parent">parent</primary></indexterm></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></refsect1></refentry> <refentry id="settings-vpn"><refnamediv><refname>vpn</refname><refpurpose>VPN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vpn.properties"> Properties Key NameValue TypeDefault ValueValue Descriptiondatadatadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings. - namenamestringvpnThe 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".persistentpersistentbooleanFALSEIf 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.secretssecretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.service-typeservice-typestringD-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. @@ -473,7 +462,6 @@ learninglearningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.limitlimituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.locallocalstringIf given, specifies the source IP address to use in outgoing packets. - namenamestringvxlanThe 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".parentparentstringIf given, specifies the parent interface name or parent connection UUID.proxyproxybooleanFALSESpecifies whether ARP proxy is turned on.remoteremotestringSpecifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join. @@ -487,7 +475,6 @@ Properties
Key NameValue TypeDefault ValueValue Descriptionmac-addressmac-addressbyte arrayIf 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). Deprecated: 1 - namenamestringwimaxThe 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".network-namenetwork-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
 802-3-ethernetWired Ethernet Settings @@ -501,7 +488,6 @@ <row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></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<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></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<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></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<indexterm zone="settings-802-3-ethernet"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</entry></row> <row><entry><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></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<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to 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. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row> @@ -525,7 +511,6 @@ <row><entry><screen>mac-address-randomization<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-randomization">mac-address-randomization</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</entry></row> <row><entry><screen>mode<indexterm zone="settings-802-11-wireless"><primary sortas="mode">mode</primary></indexterm></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<indexterm zone="settings-802-11-wireless"><primary sortas="mtu">mtu</primary></indexterm></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<indexterm zone="settings-802-11-wireless"><primary sortas="name">name</primary></indexterm></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>powersave<indexterm zone="settings-802-11-wireless"><primary sortas="powersave">powersave</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row> <row><entry><screen>rate<indexterm zone="settings-802-11-wireless"><primary sortas="rate">rate</primary></indexterm></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<indexterm zone="settings-802-11-wireless"><primary sortas="security">security</primary></indexterm></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> @@ -544,7 +529,6 @@ <row><entry><screen>leap-password<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password">leap-password</primary></indexterm></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<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password-flags">leap-password-flags</primary></indexterm></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<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-username">leap-username</primary></indexterm></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<indexterm zone="settings-802-11-wireless-security"><primary sortas="name">name</primary></indexterm></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<indexterm zone="settings-802-11-wireless-security"><primary sortas="pairwise">pairwise</primary></indexterm></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>pmf<indexterm zone="settings-802-11-wireless-security"><primary sortas="pmf">pmf</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</entry></row> <row><entry><screen>proto<indexterm zone="settings-802-11-wireless-security"><primary sortas="proto">proto</primary></indexterm></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> @@ -559,4 +543,11 @@ <row><entry><screen>wep-tx-keyidx<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-tx-keyidx">wep-tx-keyidx</primary></indexterm></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>wps-method<indexterm zone="settings-802-11-wireless-security"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> + <refentry id="settings-wpan"><refnamediv><refname>wpan</refname><refpurpose>IEEE 802.15.4 (WPAN) MAC Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wpan.properties"> + Properties + Key NameValue TypeDefault ValueValue Description + mac-addressmac-addressstringIf specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches. + pan-idpan-iduint3265535IEEE 802.15.4 Personal Area Network (PAN) identifier. + short-addressshort-addressuint3265535Short IEEE 802.15.4 address to be used within a restricted environment. +
-- cgit 1.3.0-6-gf8a5