From 6518e361171f64bcaaa4bf868139362ed95cc2e0 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 20 Oct 2018 01:30:31 +0200 Subject: New upstream version 1.14.2 --- docs/api/html/nm-settings.html | 551 +++++++++++++++++------------------------ 1 file changed, 222 insertions(+), 329 deletions(-) (limited to 'docs/api/html/nm-settings.html') diff --git a/docs/api/html/nm-settings.html b/docs/api/html/nm-settings.html index 2b9aa0ca..2f317601 100644 --- a/docs/api/html/nm-settings.html +++ b/docs/api/html/nm-settings.html @@ -8,7 +8,7 @@ - + @@ -175,6 +175,13 @@ +llmnr +int32 +-1 +Whether 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. + + + master string   @@ -185,7 +192,7 @@ mdns int32 -1 -Whether 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. +Whether 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. @@ -196,10 +203,10 @@ -name -string -connection -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". +multi-connect +int32 +0 +Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect. @@ -269,7 +276,33 @@
-

802-1x setting

+

6lowpan setting

+

6LoWPAN Settings.

+
++++++ + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+parentstring If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.
+
+
+
+

802-1x setting

IEEE 802.1x Authentication Settings.

@@ -378,13 +411,6 @@ - - - - - - @@ -605,7 +631,7 @@
-

adsl setting

+

adsl setting

ADSL Settings.

-namestring802-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-file string  
@@ -630,13 +656,6 @@ - - - - - - @@ -682,7 +701,7 @@
-

bluetooth setting

+

bluetooth setting

Bluetooth Settings.

-namestringadslThe 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".
password string  
@@ -707,13 +726,6 @@ - - - - - - @@ -724,7 +736,7 @@
-

bond setting

+

bond setting

Bonding Settings.

-namestringbluetoothThe 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".
type string  
@@ -749,13 +761,6 @@ - - - - - - @@ -766,7 +771,7 @@
-

bridge setting

+

bridge setting

Bridging Settings.

-namestringbondThe 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".
options dict of string to string {'mode': 'balance-rr'}
@@ -840,13 +845,6 @@ - - - - - - @@ -864,7 +862,7 @@
-

bridge-port setting

+

bridge-port setting

Bridge Port Settings.

-namestringbridgeThe 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 uint32 32768
@@ -889,13 +887,6 @@ - - - - - - @@ -913,7 +904,7 @@
-

cdma setting

+

cdma setting

CDMA-based Mobile Broadband Settings.

-namestringbridge-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-cost uint32 100
@@ -938,13 +929,6 @@ - - - - - - @@ -976,7 +960,7 @@
-

dcb setting

+

dcb setting

Data Center Bridging Settings.

-namestringcdmaThe 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".
number string  
@@ -1043,16 +1027,9 @@ - - - - - - - + @@ -1073,7 +1050,7 @@ - + @@ -1087,7 +1064,7 @@ - + @@ -1101,7 +1078,7 @@ - + @@ -1109,7 +1086,7 @@
-

dummy setting

+

dummy setting

Dummy Link Settings.

-namestringdcbThe 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-bandwidth array of uint32[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L][0, 0, 0, 0, 0, 0, 0, 0] 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-group-bandwidth array of uint32[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L][0, 0, 0, 0, 0, 0, 0, 0] An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.
priority-group-id array of uint32[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L][0, 0, 0, 0, 0, 0, 0, 0] An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.
priority-traffic-class array of uint32[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L][0, 0, 0, 0, 0, 0, 0, 0] An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.
@@ -1124,18 +1101,32 @@ - - - - - - +
Default Value Value Description
-namestringdummyThe 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".
-

generic setting

+

ethtool setting

+

Ethtool Ethernet Settings.

+
++++++ + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+
+
+
+

generic setting

Generic Link Settings.

@@ -1150,18 +1141,12 @@ - - - - - - +
Default Value Value Description
-namestringgenericThe 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".
-

gsm setting

+

gsm setting

GSM-based Mobile Broadband Settings.

@@ -1207,13 +1192,6 @@ - - - - - - @@ -1280,7 +1258,7 @@
-

infiniband setting

+

infiniband setting

Infiniband Settings.

-namestringgsmThe 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-id string  
@@ -1312,13 +1290,6 @@ - - - - - - @@ -1343,7 +1314,7 @@
-

ipv4 setting

+

ipv4 setting

IPv4 Settings.

-namestringinfinibandThe 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-key int32 -1
@@ -1476,14 +1447,7 @@ method - - - - - - - +
string  IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. 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.
-namestringipv4The 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".IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. 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.
@@ -1525,7 +1489,7 @@
-

ipv6 setting

+

ipv6 setting

IPv6 Settings.

@@ -1665,14 +1629,7 @@ method - - - - - - - +
string  IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. 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.
-namestringipv6The 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".IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. 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.
@@ -1721,7 +1678,7 @@
-

ip-tunnel setting

+

ip-tunnel setting

IP Tunneling Settings.

@@ -1788,13 +1745,6 @@ - - - - - - @@ -1840,7 +1790,7 @@
-

macsec setting

+

macsec setting

MACSec Settings.

-namestringip-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-key string  
@@ -1893,13 +1843,6 @@ - - - - - - @@ -1931,7 +1874,7 @@
-

macvlan setting

+

macvlan setting

MAC VLAN Settings.

-namestringmacsecThe 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".
parent string  
@@ -1956,13 +1899,6 @@ - - - - - - @@ -1987,7 +1923,33 @@
-

802-11-olpc-mesh setting

+

match setting

+

Match settings..

+
-namestringmacvlanThe 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".
parent string  
++++++ + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+interface-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-mesh setting

OLPC Wireless Mesh Settings.

@@ -2019,13 +1981,6 @@ - - - - - - @@ -2036,7 +1991,7 @@
-

ovs-bridge setting

+

ovs-bridge setting

OvsBridge Link Settings.

-namestring802-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".
ssid byte array  
@@ -2068,13 +2023,6 @@ - - - - - - @@ -2092,7 +2040,7 @@
-

ovs-interface setting

+

ovs-interface setting

Open vSwitch Interface Settings.

-namestringovs-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-enable boolean FALSE
@@ -2107,27 +2055,18 @@ - - - - - - - - + - - +
Default Value Value Description
-namestringovs-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".
type string   The interface type. Either "internal", or empty.
-

ovs-patch setting

+

ovs-patch setting

OvsPatch Link Settings.

@@ -2142,27 +2081,18 @@ - - - - - - - - + - - +
Default Value Value Description
-namestringovs-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".
peer string   Specifies the unicast destination IP address of a remote Open vSwitch bridge port to connect to.
-

ovs-port setting

+

ovs-port setting

OvsPort Link Settings.

@@ -2208,13 +2138,6 @@ - - - - - - @@ -2232,7 +2155,7 @@
-

ppp setting

+

ppp setting

Point-to-Point Protocol Settings.

-namestringovs-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".
tag uint32 0
@@ -2299,13 +2222,6 @@ - - - - - - @@ -2386,7 +2302,7 @@
-

pppoe setting

+

pppoe setting

PPP-over-Ethernet Settings.

-namestringpppThe 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".
no-vj-comp boolean FALSE
@@ -2404,13 +2320,6 @@ - - - - - - @@ -2449,7 +2358,7 @@
-

proxy setting

+

proxy setting

WWW Proxy Settings.

-namestringpppoeThe 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".
parent string  
@@ -2481,13 +2390,6 @@ - - - - - - @@ -2505,7 +2407,7 @@
-

serial setting

+

serial setting

Serial Link Settings.

-namestringproxyThe 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-script string  
@@ -2537,13 +2439,6 @@ - - - - - - @@ -2568,8 +2463,8 @@
-

tc setting

-

Linux Traffic Contril Settings..

+

sriov setting

+

SR-IOV settings..

-namestringserialThe 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".
parity byte  
@@ -2586,17 +2481,52 @@ - - - +autoprobe-drivers + + + + + + + + + + + + + + +
-namestringtcThe 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".NMTernary (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-vfsuint320The total number of virtual functions to create.
+vfsarray 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.
+
+
+
+

tc setting

+

Linux Traffic Control Settings..

+
++++++ + + + + + + + + + - +
Key NameValue TypeDefault ValueValue Description
qdiscs array of vardict []Array of TC queuening disciplines.Array of TC queueing disciplines.
@@ -2610,7 +2540,7 @@
-

team setting

+

team setting

Teaming Settings.

@@ -2663,13 +2593,6 @@ - - - - - - @@ -2757,7 +2680,7 @@
-

team-port setting

+

team-port setting

Team Port Settings.

-namestringteamThe 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".
notify-peers-count int32 0
@@ -2803,13 +2726,6 @@ - - - - - - @@ -2834,7 +2750,7 @@
-

tun setting

+

tun setting

Tunnel Settings.

-namestringteam-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".
prio int32 0
@@ -2873,13 +2789,6 @@ - - - - - - @@ -2904,7 +2813,7 @@
-

user setting

+

user setting

General User Profile Settings.

-namestringtunThe 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".
owner string  
@@ -2919,27 +2828,18 @@ - - + - - - - - - - - +
Default Value Value Description
data dict 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.
-namestringuserThe 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".
-

vlan setting

+

vlan setting

VLAN Settings.

@@ -2992,13 +2892,6 @@ - - - - - - @@ -3009,7 +2902,7 @@
-

vpn setting

+

vpn setting

VPN Settings.

-namestringvlanThe 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".
parent string  
@@ -3034,13 +2927,6 @@ - - - - - - @@ -3079,7 +2965,7 @@
-

vxlan setting

+

vxlan setting

VXLAN Settings.

-namestringvpnThe 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".
persistent boolean FALSE
@@ -3153,13 +3039,6 @@ - - - - - - @@ -3219,7 +3098,7 @@
-

wimax setting

+

wimax setting

WiMax Settings.

-namestringvxlanThe 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".
parent string  
@@ -3244,13 +3123,6 @@ - - - - - - @@ -3261,7 +3133,7 @@
-

802-3-ethernet setting

+

802-3-ethernet setting

Wired Ethernet Settings.

-namestringwimaxThe 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-name string  
@@ -3335,13 +3207,6 @@ - - - - - - @@ -3394,7 +3259,7 @@
-

802-11-wireless setting

+

802-11-wireless setting

Wi-Fi Settings.

-namestring802-3-ethernetThe 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".
port string  
@@ -3457,7 +3322,7 @@ hidden - + - - - - - - @@ -3555,7 +3413,7 @@
-

802-11-wireless-security setting

+

802-11-wireless-security setting

Wi-Fi Security Settings.

boolean FALSEIf TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. Note that marking the network as hidden may be a privacy issue for you, as the explicit probe-scans may be distinctly recognizable on the air.If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.
@@ -3496,13 +3361,6 @@
-namestring802-11-wirelessThe 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".
powersave uint32 0
@@ -3622,13 +3480,6 @@ - - - - - - @@ -3723,6 +3574,48 @@
+

wpan setting

+

IEEE 802.15.4 (WPAN) MAC Settings.

+
-namestring802-11-wireless-securityThe 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".
pairwise array of string []
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+mac-addressstring If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.
+pan-iduint3265535IEEE 802.15.4 Personal Area Network (PAN) identifier.
+short-addressuint3265535Short IEEE 802.15.4 address to be used within a restricted environment.
+
+
+

Secret flag types:

Each password or secret property in a setting has an associated flags property @@ -3759,6 +3652,6 @@

-
Generated by GTK-Doc V1.28
+
Generated by GTK-Doc V1.29.1 \ No newline at end of file -- cgit 1.3.0-6-gf8a5